sitespeed.io 23.7.0 → 24.2.0

package/.eslintignore

@@ -4,3 +4,4 @@ assets/*
 sitespeed-result/*
 lib/plugins/yslow/scripts/*
 lib/plugins/html/assets/js/*
+test/data/*

package/.github/workflows/building-docker-release.yml

@@ -9,7 +9,7 @@ jobs:
     steps:
       -
           name: Checkout
-          uses: actions/checkout@v2
+          uses: actions/checkout@v3
       -
         name: Set up QEMU
         uses: docker/setup-qemu-action@v1

package/.github/workflows/crux-test.yml

@@ -10,9 +10,9 @@ jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
     - name: Use Node.js
-      uses: actions/setup-node@v1
+      uses: actions/setup-node@v3
       with:
         node-version: '16.x'
     - name: Install sitespeed.io

package/.github/workflows/docker-scan.yml

@@ -10,7 +10,7 @@ jobs:
     runs-on: ubuntu-18.04
     steps:
       - name: Checkout code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
       
       - name: Build an image from Dockerfile
         run: |

package/.github/workflows/docker.yml

@@ -10,21 +10,25 @@ jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
     - name: Build Docker containers
       run: |
         docker buildx install
         docker buildx build --load --platform linux/amd64 -t sitespeedio/sitespeed.io .
         docker buildx build --load --platform linux/amd64 -t sitespeedio/sitespeed.io:slim --file Dockerfile-slim .
+    - name: Install local HTTP server
+      run: npm install serve -g
+    - name: Start local HTTP server
+      run: (serve test/data/html/ -l 3001&)
     - name: Run test on default container for Chrome 
-      run: docker run --rm sitespeedio/sitespeed.io https://www.sitespeed.io -n 1 -b chrome
+      run: docker run --rm --network=host  sitespeedio/sitespeed.io http://127.0.0.1:3001 -n 1 -b chrome
     - name: Run test on default container for Firefox 
-      run: docker run --rm sitespeedio/sitespeed.io https://www.sitespeed.io -n 1 -b firefox
+      run: docker run --rm --network=host sitespeedio/sitespeed.io http://127.0.0.1:3001 -n 1 -b firefox
     - name: Run test on default container for Edge 
-      run: docker run --rm sitespeedio/sitespeed.io https://www.sitespeed.io -n 1 -b edge
+      run: docker run --rm --network=host sitespeedio/sitespeed.io http://127.0.0.1:3001  -n 1 -b edge
     - name: Run test on slim container  
-      run: docker run --rm sitespeedio/sitespeed.io:slim https://www.sitespeed.io -n 1 --browsertime.firefox.preference "devtools.netmonitor.persistlog:true"
+      run: docker run --rm --network=host sitespeedio/sitespeed.io:slim http://127.0.0.1:3001 -n 1 --browsertime.firefox.preference "devtools.netmonitor.persistlog:true"
     - name: Test WebPageReplay with Chrome  
-      run: docker run --cap-add=NET_ADMIN --rm  -e REPLAY=true -e LATENCY=100 sitespeedio/sitespeed.io https://www.sitespeed.io -n 3 -b chrome 
+      run: docker run --cap-add=NET_ADMIN --rm -e REPLAY=true -e LATENCY=100 sitespeedio/sitespeed.io https://www.sitespeed.io -n 3 -b chrome 
     - name: Test WebPageReplay with Firefox  
-      run: docker run --cap-add=NET_ADMIN --rm  -e REPLAY=true -e LATENCY=100 sitespeedio/sitespeed.io https://www.sitespeed.io -n 3 -b firefox --browsertime.firefox.acceptInsecureCerts true
+      run: docker run --cap-add=NET_ADMIN --rm --network=host -e REPLAY=true -e LATENCY=100 sitespeedio/sitespeed.io https://www.sitespeed.io -n 3 -b firefox --browsertime.firefox.acceptInsecureCerts true

package/.github/workflows/linux.yml

@@ -10,9 +10,9 @@ jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
     - name: Use Node.js
-      uses: actions/setup-node@v1
+      uses: actions/setup-node@v3
       with:
         node-version: '16.x'
     - name: Install sitespeed.io
@@ -34,25 +34,33 @@ jobs:
       run: |
         google-chrome --version
         firefox --version
+    - name: Install local HTTP server
+      run: npm install serve -g
+    - name: Start local HTTP server
+      run: (serve test/data/html/ -l 3001&)
     - name: Test old budget
-      run: bin/sitespeed.js -b firefox -n 2 --budget.configPath test/oldBudget.json --summary --xvfb https://www.sitespeed.io/
-    - name: Test new budget file  
-      run: bin/sitespeed.js --useHash -n 1 --budget.configPath test/budget.json --xvfb  https://www.sitespeed.io/#heybaberia
+      run: bin/sitespeed.js -b firefox -n 2 --budget.configPath test/oldBudget.json --summary --xvfb http://127.0.0.1:3001/simple/
+    - name: Test new budget file with junit 
+      run: bin/sitespeed.js --useHash -n 1 --budget.configPath test/budget.json --xvfb --budget.output junit http://127.0.0.1:3001/simple/#heybaberia
+    - name: Test new budget file with tap 
+      run: bin/sitespeed.js --useHash -n 1 --budget.configPath test/budget.json --xvfb --budget.output tap http://127.0.0.1:3001/simple/#heybaberia
+    - name: Test new budget file with json 
+      run: bin/sitespeed.js --useHash -n 1 --budget.configPath test/budget.json --xvfb --budget.output json http://127.0.0.1:3001/simple/#heybaberia
     - name: Use AXE
-      run: bin/sitespeed.js --useAlias start --mobile -n 1 --utc --axe.enable --xvfb https://www.sitespeed.io/
+      run: bin/sitespeed.js --useAlias start --mobile -n 1 --utc --axe.enable --xvfb http://127.0.0.1:3001/simple/
     - name: Use Fireefox with --mobile
-      run: bin/sitespeed.js -b firefox  --metrics.list --mobile -n 1 https://www.sitespeed.io/ --sustainable.enable --xvfb
+      run: bin/sitespeed.js -b firefox  --metrics.list --mobile -n 1 http://127.0.0.1:3001/simple/ --sustainable.enable --xvfb
     - name: Test --multi  
-      run: bin/sitespeed.js --multi -b chrome -n 1 test/prepostscripts/preSample.js https://www.sitespeed.io/documentation/ test/prepostscripts/postSample.js --xvfb
+      run: bin/sitespeed.js --multi -b chrome -n 1 test/prepostscripts/preSample.js http://127.0.0.1:3001/simple/ test/prepostscripts/postSample.js --xvfb
     - name: Test --multi and --tcpdump  
-      run: bin/sitespeed.js --multi -n 1 https://www.sitespeed.io/ https://www.sitespeed.io/documentation/ --tcpdump --xvfb
+      run: bin/sitespeed.js --multi -n 1 http://127.0.0.1:3001/simple/ http://127.0.0.1:3001/dimple/ --tcpdump --xvfb
     - name: Test --multi with one file 
       run: bin/sitespeed.js --multi -n 3 test/prepostscripts/multi.js --xvfb
     - name: Test setting HTML output pageSummaries
-      run: bin/sitespeed.js https://www.sitespeed.io/ https://www.google.com -v -n 1 --html.pageSummaryMetrics transferSize.css --html.pageSummaryMetrics requests.httpErrors --html.pageSummaryMetrics score.performance --xvfb
+      run: bin/sitespeed.js http://127.0.0.1:3001/simple/ http://127.0.0.1:3001/dimple/ -v -n 1 --html.pageSummaryMetrics transferSize.css --html.pageSummaryMetrics requests.httpErrors --html.pageSummaryMetrics score.performance --xvfb
     - name: Test setting HTML output summary boxes 
-      run: bin/sitespeed.js https://www.sitespeed.io/ -v -n 1 --html.summaryBoxes score.performance --html.summaryBoxes timings.firstPaint --xvfb
+      run: bin/sitespeed.js http://127.0.0.1:3001/simple/ -v -n 1 --html.summaryBoxes score.performance --html.summaryBoxes timings.firstPaint --xvfb
     - name: Run test with Graphite
-      run: bin/sitespeed.js https://www.sitespeed.io/ -n 1 --graphite.host 127.0.0.1 --xvfb
+      run: bin/sitespeed.js http://127.0.0.1:3001/simple/ -n 1 --graphite.host 127.0.0.1 --xvfb
     - name: Run test without a CLI
       run: xvfb-run node test/runWithoutCli.js

package/.github/workflows/safari.yml

@@ -10,14 +10,18 @@ jobs:
   build:
     runs-on: macos-latest
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
     - name: Use Node.js
-      uses: actions/setup-node@v1
+      uses: actions/setup-node@v3
       with:
         node-version: '16.x'
     - name: Install dependencies 
       run: |
         sudo safaridriver --enable 
         npm ci
+    - name: Install local HTTP server
+      run: npm install serve -g
+    - name: Start local HTTP server
+      run: (serve test/data/html/ -l 3001&)
     - name: Run test
-      run: bin/sitespeed.js -b safari https://www.sitespeed.io/
+      run: bin/sitespeed.js -b safari http://127.0.0.1:3001/

package/.github/workflows/sitespeed-io-action-example.yml

@@ -9,7 +9,7 @@ jobs:
     name: running sitespeed.io
     steps:
       - name: code checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
       # Here we build our own container to make sure we test against our latest code
       # but YOU can just used the latest version by specifying 
       # sitespeedio/sitespeed.io:VERSION

package/.github/workflows/unittests.yml

@@ -13,9 +13,9 @@ jobs:
       matrix:
         node-version: [14.x, 16.x]
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
     - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v1
+      uses: actions/setup-node@v3
       with:
         node-version: ${{ matrix.node-version }}
     - name: Install dependencies and Chrome

package/.github/workflows/windows.yml

@@ -10,9 +10,9 @@ jobs:
   build:
     runs-on: windows-latest
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
     - name: Use Node.js
-      uses: actions/setup-node@v1
+      uses: actions/setup-node@v3
       with:
         node-version: '16.x'
     - name: Install sitespeed.io
@@ -24,6 +24,6 @@ jobs:
     - name: Install dependencies
       run: choco install microsoft-edge --force
     - name: Run Edge test
-      run: node bin/sitespeed.js -b edge https://www.sitespeed.io/ 
+      run: node bin/sitespeed.js -b edge https://www.sitespeed.io/
       shell: cmd
       

package/CHANGELOG.md

@@ -1,5 +1,40 @@
 # CHANGELOG - sitespeed.io  (we use [semantic versioning](https://semver.org))
 
+##  24.2.0 - 2022-04-26
+
+### Added
+* Updated base Docker image to use Ubuntu 22.04 [#3636](https://github.com/sitespeedio/sitespeed.io/pull/3636).
+
+### Fixed
+* Updated dependencies: aws-sdk, cli-color, fs-extra, influx, junit-report-builder and tape [#3640](https://github.com/sitespeedio/sitespeed.io/pull/3640) 
+
+### Tech
+* Use Ava for unit testing [#3637](https://github.com/sitespeedio/sitespeed.io/pull/3637)
+* Use local HTTP server to speed up GitHub Action tests [#3638](https://github.com/sitespeedio/sitespeed.io/pull/3638).
+* Updated dev dependencies [#3639](https://github.com/sitespeedio/sitespeed.io/pull/3639).
+
+## 24.1.0 - 2022-04-22
+### Added
+* Update Grafana auth settings to allow api token or basic auth, thank you [Vladimir Stepanov](https://github.com/vs-odessa) for PR [#3627](https://github.com/sitespeedio/sitespeed.io/pull/3627).
+* Add TTFB to the metrics page [#3630](https://github.com/sitespeedio/sitespeed.io/pull/3630).
+* Use latest Coach core with updated PageXray and Third party web [#3629](https://github.com/sitespeedio/sitespeed.io/pull/3629).
+* Make it possible to disable annotations for Graphite. Set `--graphite.sendAnnotation false` to disable sending annotations [#3625](https://github.com/sitespeedio/sitespeed.io/pull/3625).
+* Show which run that is used in the metrics tab [#3631](https://github.com/sitespeedio/sitespeed.io/pull/3631).
+* Updated to [Browsertime 16.1.0](https://github.com/sitespeedio/browsertime/blob/main/CHANGELOG.md#1610---2022-04-20).
+### Updated
+* Update dependencies: google-cloud/storage, aws-sdk, dayjs, yargs [#3635](https://github.com/sitespeedio/sitespeed.io/pull/3635).
+
+## 24.0.0 - 2022-04-06
+
+### Changed 
+* Upgraded to [Browsertime 16.0.0](https://github.com/sitespeedio/browsertime/blob/main/CHANGELOG.md#1600---2022-04-05) that changed how the DNS is flushed. You need to add `--flushDNS` to your conifguration to flush the DNS between runs.
+
+### Added
+* Use Firefox 99 and Edge/Edgedriver 100 in the Dockker container.
+
+### Fixed
+* Better catch if Visual Metrics fails [#3619](https://github.com/sitespeedio/sitespeed.io/pull/3619)
+* Fixed JUnit/alias bug [#3620](https://github.com/sitespeedio/sitespeed.io/pull/3620)
 ## 23.7.0 - 2022-03-31
 ### Added
 * Updated to Chrome/Chromedriver 100 and [Browsertime 15.4.0](https://github.com/sitespeedio/browsertime/blob/main/CHANGELOG.md#1540---2022-03-30).

package/Dockerfile

@@ -1,4 +1,4 @@
-FROM sitespeedio/webbrowsers:chrome-100.0-firefox-98.0-edge-99.0
+FROM sitespeedio/webbrowsers:chrome-100.0-firefox-99.0-edge-100.0-b
 
 ARG TARGETPLATFORM=linux/amd64
 

package/lib/cli/cli.js

@@ -991,6 +991,12 @@ module.exports.parseCommandLine = function parseCommandLine() {
       describe: 'Https proxy (host:port)',
       group: 'proxy'
     })
+    .option('browsertime.flushDNS', {
+      alias: 'flushDNS',
+      describe:
+        'Flush the DNS between runs (works on Mac OS and Linux). The user needs sudo rights to flush the DNS.',
+      group: 'Browser'
+    })
     .option('browsertime.headless', {
       alias: 'headless',
       type: 'boolean',

package/lib/plugins/budget/junit.js

@@ -11,24 +11,29 @@ exports.writeJunit = function (results, dir, options) {
   const urls = Object.keys(merge({}, results.failing, results.working));
 
   for (const url of urls) {
-    const parsedUrl = urlParser.parse(url);
-    const fineUrl =
+    // The URL can be an alias
+    let name = url;
+    if (url.startsWith('http')) {
+      const parsedUrl = urlParser.parse(url);
+      name = url.startsWith('http') ? url : url;
       parsedUrl.hostname.replace(/\./g, '_') +
-      '.' +
-      parsedUrl.path.replace(/\./g, '_').replace(/\//g, '_');
+        '.' +
+        parsedUrl.path.replace(/\./g, '_').replace(/\//g, '_');
+    }
+
     const suite = builder
       .testSuite()
       .name(
         options.budget.friendlyName
           ? options.budget.friendlyName
-          : 'sitespeed.io' + '.' + fineUrl
+          : 'sitespeed.io' + '.' + name
       );
 
     if (results.failing[url]) {
       for (const result of results.failing[url]) {
         suite
           .testCase()
-          .className(fineUrl)
+          .className(name)
           .name(result.type + '.' + result.metric)
           .failure(
             result.metric + ' is ' + result.friendlyValue ||
@@ -46,7 +51,7 @@ exports.writeJunit = function (results, dir, options) {
       for (const result of results.working[url]) {
         suite
           .testCase()
-          .className(fineUrl)
+          .className(name)
           .name(result.type + '.' + result.metric)
           .standardOutput(
             result.metric + ' is ' + result.friendlyValue ||

package/lib/plugins/grafana/cli.js

@@ -10,7 +10,7 @@ module.exports = {
   },
   auth: {
     describe:
-      'The Grafana auth/bearer value used when sending annotations to Grafana. See http://docs.grafana.org/http_api/auth/#authentication-api',
+      'The Grafana auth/bearer value used when sending annotations to Grafana. If you do not set Bearer/Auth, Bearer is automatically set. See http://docs.grafana.org/http_api/auth/#authentication-api',
     group: 'Grafana'
   },
   annotationTitle: {

package/lib/plugins/grafana/send-annotation.js

@@ -98,7 +98,14 @@ module.exports = {
     // If Grafana is behind auth, use it!
     if (options.grafana.auth) {
       log.debug('Using auth for Grafana');
-      postOptions.headers.Authorization = 'Bearer ' + options.grafana.auth;
+      if (
+        options.grafana.auth.startsWith('Bearer') ||
+        options.grafana.auth.startsWith('Basic')
+      ) {
+        postOptions.headers.Authorization = options.grafana.auth;
+      } else {
+        postOptions.headers.Authorization = 'Bearer ' + options.grafana.auth;
+      }
     }
     log.verbose('Send annotation to Grafana: %j', postData);
     return new Promise((resolve, reject) => {

package/lib/plugins/graphite/cli.js

@@ -59,6 +59,13 @@ module.exports = {
       'Include screenshot (from Browsertime/WebPageTest) in the annotation. You need to specify a --resultBaseURL for this to work.',
     group: 'Graphite'
   },
+  sendAnnotation: {
+    default: true,
+    type: 'boolean',
+    describe:
+      'Send annotations when a run is finished. You need to specify a --resultBaseURL for this to work. However if you for example use a Prometheus exporter, you may want to make sure annotations are not sent, then set it to false.',
+    group: 'Graphite'
+  },
   annotationRetentionMinutes: {
     type: 'number',
     describe:

package/lib/plugins/graphite/index.js

@@ -60,7 +60,7 @@ module.exports = {
     this.messageTypesToFireAnnotations = [];
     this.receivedTypesThatFireAnnotations = {};
     this.make = context.messageMaker('graphite').make;
-    this.sendAnnotation = true;
+    this.sendAnnotation = opts.sendAnnotation || true;
     this.alias = {};
     this.wptExtras = {};
     this.usingBrowsertime = false;

package/lib/plugins/html/metricHelper.js

@@ -4,7 +4,7 @@ module.exports = {
   pickMedianRun(runs, pageInfo) {
     // Choose the median run. Early first version, in the future we can make
     // this configurable through the CLI
-    // If we have SpeedIndex use that else backup with RUM SpeedIndex
+    // If we have SpeedIndex use that else backup with loadEventEnd
 
     const speedIndexMedian = get(
       pageInfo,
@@ -17,6 +17,8 @@ module.exports = {
     if (speedIndexMedian) {
       for (let run of runs) {
         if (
+          // https://github.com/sitespeedio/sitespeed.io/issues/3618
+          run.data.browsertime.run.visualMetrics &&
           speedIndexMedian === run.data.browsertime.run.visualMetrics.SpeedIndex
         ) {
           return {

package/lib/plugins/html/templates/url/metrics/index.pug

@@ -38,6 +38,9 @@ if browsertime
       a(href='#server-timings') Server timings
       |  | 
 
+  p
+    small #{ medianRun ? 'Data from run ' + medianRun.runIndex : ''}
+
   - baseHelpURL = rootPath + 'help.html#';
 
   - const defaultVisualMetrics = ['SpeedIndex','FirstVisualChange','LastVisualChange','VisualProgress', 'PerceptualSpeedIndexProgress', 'ContentfulSpeedIndexProgress', 'videoRecordingStart', 'PerceptualSpeedIndex', 'ContentfulSpeedIndex', 'LastMeaningfulPaint', 'LargestImage', 'Heading' ,'VisualReadiness','VisualComplete85', 'VisualComplete95','VisualComplete99'];
@@ -156,6 +159,10 @@ if browsertime
       table
         tr
           th(colspan='2') Extra timings
+        tr
+          td
+            a(href=baseHelpURL + 'ttfb') TTFB
+          td.number #{h.time.ms(timings.ttfb.toFixed(0))}
         if (timings.paintTiming && Object.keys(timings.paintTiming).length > 0)
           - const paintTimingHelper = { "first-contentful-paint": {"name": 'First Contentful Paint (FCP)', "friendly": "first-contentful-paint"},  "first-paint": {"name": 'First Paint', "friendly": "firstPaint" }};
           each value, name in timings.paintTiming
@@ -289,7 +296,10 @@ if browsertime
         td  #{element.name}
          if (element.filename)
           | (#{element.filename})
-        td #{visualMetrics[element.name] ? h.time.ms(visualMetrics[element.name].toFixed(0)): ''}
+        if element && visualMetrics && visualMetrics[element.name]
+          td #{visualMetrics[element.name] ? h.time.ms(visualMetrics[element.name].toFixed(0)): ''}
+        else 
+          td
         td  #{element.x}
         td  #{element.y}
         td  #{element.width}