chore: Add pr comment for build size

Adding CI process and scripts to create a comment on PRs that provide details around the file size increase or decrease for minified loaders.

Author: patrickhousley

.github/workflows/ci.yml

@@ -7,6 +7,36 @@ on:
   pull_request:
 
 jobs:
+  size-check:
+    if: github.event_name == 'pull_request'
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    container:
+      image: ubuntu:latest
+    defaults:
+      run:
+        shell: bash
+    steps:
+      - name: Setup Container
+        run: apt update && apt install -y git
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: lts/*
+      - name: Install Dependencies
+        run: npm ci
+      - name: Running Prod Build
+        run: npm run cdn:build:dev
+      - name: Generating Asset Size Report
+        run: node ./tools/scripts/diff-sizes.mjs -o build
+      - name: Creating PR Comment
+        run: |
+          node ./tools/scripts/comment-pr.mjs \
+            --pull-request=${{ github.event.pull_request.number }} \
+            --token=${{ secrets.GITHUB_TOKEN }} \
+            --input=./build/size_report.md \
+            --tag='<!-- browser_agent asset size report -->'
+
   lint:
     runs-on: ubuntu-latest
     timeout-minutes: 30

package-lock.json

@@ -112,6 +112,8 @@
     "eslint-plugin-promise": "^6.1.1",
     "fastify": "^4.13.0",
     "fastify-plugin": "^4.4.0",
+    "filesize": "^10.0.6",
+    "fs-extra": "^11.1.0",
     "function-bind": "^1.1.1",
     "glob": "^7.0.5",
     "husky": "^8.0.0",
@@ -126,9 +128,10 @@
     "minimatch": "^3.0.3",
     "multiparty": "^4.1.2",
     "newrelic": "^4.11.0",
-    "node-fetch": "^3.2.10",
+    "node-fetch": "^3.3.1",
     "npm-run-all": "^4.1.5",
     "object-inspect": "^1.5.0",
+    "octokit": "^2.0.14",
     "preprocessify": "0.0.6",
     "request": "2.74.0",
     "sauce-connect-launcher": "^1.2.4",

package.json

@@ -9,10 +9,10 @@
     },
     {
       "browserName": "chrome",
-      "platform": "Windows 10",
-      "platformName": "Windows 10",
-      "version": "108",
-      "browserVersion": "108"
+      "platform": "Windows 11",
+      "platformName": "Windows 11",
+      "version": "107",
+      "browserVersion": "107"
     },
     {
       "browserName": "chrome",
@@ -23,19 +23,19 @@
     },
     {
       "browserName": "chrome",
-      "platform": "Windows 10",
-      "platformName": "Windows 10",
-      "version": "101",
-      "browserVersion": "101"
+      "platform": "Windows 11",
+      "platformName": "Windows 11",
+      "version": "100",
+      "browserVersion": "100"
     }
   ],
   "edge": [
     {
       "browserName": "MicrosoftEdge",
       "platform": "Windows 11",
       "platformName": "Windows 11",
-      "version": "110",
-      "browserVersion": "110"
+      "version": "111",
+      "browserVersion": "111"
     },
     {
       "browserName": "MicrosoftEdge",
@@ -55,8 +55,8 @@
       "browserName": "MicrosoftEdge",
       "platform": "Windows 10",
       "platformName": "Windows 10",
-      "version": "101",
-      "browserVersion": "101"
+      "version": "100",
+      "browserVersion": "100"
     }
   ],
   "safari": [
@@ -77,7 +77,7 @@
     {
       "browserName": "firefox",
       "platform": "Windows 10",
-      "version": "110"
+      "version": "111"
     },
     {
       "browserName": "firefox",
@@ -92,7 +92,7 @@
     {
       "browserName": "firefox",
       "platform": "Windows 10",
-      "version": "101"
+      "version": "100"
     }
   ],
   "android": [

tools/jil/util/browsers-supported.json

@@ -0,0 +1,73 @@
+#!/usr/bin/env node
+
+/*
+ * Copyright 2020 New Relic Corporation. All rights reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+/**
+ * @file Adds the provided input text as a comment to a specified Github pull request, or if an optional tag string is
+ * provided, updates an existing comment containing that tag.
+ */
+
+import yargs from 'yargs'
+import { hideBin } from 'yargs/helpers'
+import fs from 'fs-extra'
+import { Octokit } from 'octokit'
+
+const config = yargs(hideBin(process.argv))
+  .usage('$0 [options]')
+
+  .number('p')
+  .alias('p', 'pull-request')
+  .describe('p', 'Numeric ID of the pull request to post a comment to')
+
+  .string('t')
+  .alias('t', 'token')
+  .describe('t', 'Github authentication token')
+
+  .string('i')
+  .alias('i', 'input')
+  .describe('i', 'Input file containing the comment contents.')
+
+  .string('tag')
+  .describe('tag', 'Tag to place in the comment to support updating of comment')
+
+  .argv
+
+;(async () => {
+  const client = new Octokit({
+    auth: config.token
+  })
+
+  let comment
+  // If a tag argument is passed, the script will look for an existing PR comment containing the text of the tag and
+  // update that existing comment rather than creating a new one.
+  if (config.tag) {
+    for await (const { data: comments } of client.paginate.iterator(client.rest.issues.listComments, {
+      owner: 'newrelic',
+      repo: 'newrelic-browser-agent',
+      issue_number: config.pullRequest
+    })) {
+      comment = comments.find((comment) => comment?.body?.includes(config.tag))
+      if (comment) break
+    }
+  }
+
+  if (comment) {
+    await client.rest.issues.updateComment({
+      owner: 'newrelic',
+      repo: 'newrelic-browser-agent',
+      issue_number: config.pullRequest,
+      comment_id: comment.id,
+      body: (await fs.readFile(config.input)) + `\n${config.tag}`
+    })
+  } else {
+    await client.rest.issues.createComment({
+      owner: 'newrelic',
+      repo: 'newrelic-browser-agent',
+      issue_number: config.pullRequest,
+      body: (await fs.readFile(config.input)) + `\n${config.tag}`
+    })
+  }
+})()