sitespeed.io 21.5.0 → 22.1.0

package/.github/ISSUE_TEMPLATE/BUG_REPORT.yml

@@ -0,0 +1,65 @@
+name: Bug Report
+description: File a bug report
+labels: [bug]
+body:
+  - type: markdown
+    attributes:
+      value: Thanks for reporting issues back to sitespeed.io!
+  - type: checkboxes
+    id: Reproducable
+    attributes:
+      label: Have you read the documentation?
+      description: Please double check that this question hasn't already answered in the [documentation](https://www.sitespeed.io/documentation/sitespeed.io/) (use the `Search`). Also please read [how to make a good bug report](https://www.sitespeed.io/documentation/sitespeed.io/bug-report/) and check [how to debug your script](https://www.sitespeed.io/documentation/sitespeed.io/scripting/#debug).
+      options:
+        - label: Yes, I've read the [how to make a reproducable bug guide](https://www.sitespeed.io/documentation/sitespeed.io/bug-report/)
+          required: true
+        - label: Yes, I've read the [how to debug my script guide](https://www.sitespeed.io/documentation/sitespeed.io/scripting/#debug)
+          required: false
+  - type: input
+    id: url
+    attributes:
+      label: URL
+      description: What URL did you run sitespeed.io on? If you can't share your URL please make a minimial repro to a public location (e.g. https://glitch.com/, http://jsbin.com/, etc)
+      placeholder: https://example.com
+    validations:
+      required: true
+  - type: textarea
+    id: whaw
+    attributes:
+      label: What are you trying to accomplish
+      description: A brief description of what you tried to do and what went wrong.
+    validations:
+      required: true
+  - type: dropdown
+    id: browser
+    attributes:
+      label: What browser did you use? 
+      description: Extra bonus if you try the issue in multiple browsers
+      multiple: true
+      options:
+        - Chrome
+        - Firefox
+        - Edge
+        - Safari Mac OS
+        - Safari iOS
+        - Chrome Android
+        - Firefox Android
+        - Other
+    validations:
+      required: true
+  - type: textarea
+    id: how-to-reproduce
+    attributes:
+      label: How to reproduce
+      description: Please copy and paste how you run so we can reproduce. This will be automatically formatted into code, so no need for backticks. Remember to follow the [how to make a good bug report guide](https://www.sitespeed.io/documentation/sitespeed.io/bug-report/)!
+      render: shell
+    validations:
+      required: true
+  - type: textarea
+    id: logs
+    attributes:
+      label: Relevant log output
+      description: Please copy and paste any relevant log output (please DO NOT take a screenshot of the log output). This will be automatically formatted into code, so no need for backticks.
+      render: shell
+    validations:
+      required: false

package/.github/ISSUE_TEMPLATE/QUESTION.yml

@@ -0,0 +1,15 @@
+name: Question
+description: Ask a question about sitespeed.io
+labels: [question]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Ask a question about sitespeed.io
+  - type: textarea
+    id: your-question
+    attributes:
+      label: Your question
+      description: Please double check that this question hasn't already answered in the [documentation](https://www.sitespeed.io/documentation/sitespeed.io/) (use the `Search`) or [old GitHub issues](https://github.com/sitespeedio/sitespeed.io/issues?q=is%3Aissue+is%3Aclosed). You can also ask questions in the [sitespeed.io Slack channel](https://sitespeedio.herokuapp.com/). And if your question is more like a bug, please [use the bug report form](https://github.com/sitespeedio/sitespeed.io/issues/new?assignees=&labels=bug&template=BUG_REPORT.yml)
+    validations:
+      required: true

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

@@ -0,0 +1,28 @@
+name: Build autobuild container that runs tests on dashboard.sitespeed.io
+on:
+  push:
+    branches:
+    - main
+jobs:
+  docker:
+    runs-on: ubuntu-latest
+    steps:
+      -
+        name: Set up QEMU
+        uses: docker/setup-qemu-action@v1
+      -
+        name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v1
+      -
+        name: Login to DockerHub
+        uses: docker/login-action@v1 
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+      -
+        name: Build and push sitespeed.io
+        uses: docker/build-push-action@v2
+        with:
+          platforms: linux/amd64
+          push: true
+          tags: sitespeedio/sitespeed.io-autobuild:main

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

@@ -0,0 +1,61 @@
+name: Build Docker containers on new tag
+on:
+  push:
+    tags:
+      - 'v*.*.*'
+jobs:
+  docker:
+    runs-on: ubuntu-latest
+    steps:
+      -
+        name: Set up QEMU
+        uses: docker/setup-qemu-action@v1
+      -
+        name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v1
+      -
+        name: Login to DockerHub
+        uses: docker/login-action@v1 
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+      -
+        name: Get the tag
+        id: tag
+        uses: dawidd6/action-get-tag@v1
+        with:
+          strip_v: true
+      -
+        name: Build and push sitespeed.io
+        uses: docker/build-push-action@v2
+        with:
+          platforms: linux/amd64,linux/arm64
+          push: true
+          tags: sitespeedio/sitespeed.io:${{steps.tag.outputs.tag}},sitespeedio/sitespeed.io:latest
+      -
+        name: Build and push sitespeed.io-slim
+        uses: docker/build-push-action@v2
+        with:
+          platforms: linux/amd64,linux/arm64
+          file: ./Dockerfile-slim
+          build-args: version=${{steps.tag.outputs.tag}} 
+          push: true
+          tags: sitespeedio/sitespeed.io:${{steps.tag.outputs.tag}}-slim
+      -
+        name: Build and push sitespeed.io+1
+        uses: docker/build-push-action@v2
+        with:
+          platforms: linux/amd64,linux/arm64
+          file: ./docker/Dockerfile-plus1
+          build-args: version=${{steps.tag.outputs.tag}} 
+          push: true
+          tags: sitespeedio/sitespeed.io:${{steps.tag.outputs.tag}}-plus1
+      -
+        name: Build and push sitespeed.io+wpt
+        uses: docker/build-push-action@v2
+        with:
+          platforms: linux/amd64,linux/arm64
+          file: ./docker/Dockerfile-webpagetest
+          build-args: version=${{steps.tag.outputs.tag}} 
+          push: true
+          tags: sitespeedio/sitespeed.io:${{steps.tag.outputs.tag}}-webpagetest

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

@@ -14,7 +14,8 @@ jobs:
       
       - name: Build an image from Dockerfile
         run: |
-          docker build -t docker.io/sitespeedio/sitespeed.io:${{ github.sha }} .
+          docker buildx install
+          docker buildx build --load --platform linux/amd64 -t docker.io/sitespeedio/sitespeed.io:${{ github.sha }} .
       
       - name: Run Trivy vulnerability scanner
         uses: aquasecurity/trivy-action@master
@@ -24,4 +25,4 @@ jobs:
           exit-code: '1'
           ignore-unfixed: true
           vuln-type: 'os,library'
-          severity: 'CRITICAL,HIGH'
+          severity: 'CRITICAL'

package/.github/workflows/docker.yml

@@ -13,8 +13,9 @@ jobs:
     - uses: actions/checkout@v2
     - name: Build Docker containers
       run: |
-        docker build -t sitespeedio/sitespeed.io .
-        docker build -t sitespeedio/sitespeed.io:slim --file Dockerfile-slim .
+        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: Run test on default container for Chrome 
       run: docker run --rm sitespeedio/sitespeed.io https://www.sitespeed.io -n 1 -b chrome
     - name: Run test on default container for Firefox 

package/.github/workflows/linux.yml

@@ -14,7 +14,7 @@ jobs:
     - name: Use Node.js
       uses: actions/setup-node@v1
       with:
-        node-version: '14.x'
+        node-version: '16.x'
     - name: Install sitespeed.io
       run: npm ci
     - name: Install Chrome

package/.github/workflows/safari.yml

@@ -14,7 +14,7 @@ jobs:
     - name: Use Node.js
       uses: actions/setup-node@v1
       with:
-        node-version: '14.x'
+        node-version: '16.x'
     - name: Install dependencies 
       run: |
         sudo safaridriver --enable 

package/.github/workflows/unittests.yml

@@ -11,7 +11,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node-version: [12.x, 14.x, 16.x]
+        node-version: [14.x, 16.x]
     steps:
     - uses: actions/checkout@v2
     - name: Use Node.js ${{ matrix.node-version }}

package/.github/workflows/windows.yml

@@ -14,7 +14,7 @@ jobs:
     - name: Use Node.js
       uses: actions/setup-node@v1
       with:
-        node-version: '14.x'
+        node-version: '16.x'
     - name: Install sitespeed.io
       run: npm ci
       env:

package/CHANGELOG.md

@@ -1,8 +1,53 @@
 # CHANGELOG - sitespeed.io  (we use [semantic versioning](https://semver.org))
 
+## 22.1.0 - 2022-02-08
+### Added
+* Upgraded to latest Browsertime with Egdedriver 98.
+* Upgraded to Edge 98 and Firefox 97 in the (amd64) Docker containers.
+## 22.0.0 - 2022-02-07
+
+### Breaking changes
+* If you use the Lightouse plugin there's breaking changes:
+
+In the new version we drop support for the following:
+  * Running multiple runs with Lighthouse. 
+  * Using scripts to login the user (or whatever you need before you run your tests)
+It's a couple of reasons why I remove those features:
+* I been looking for a maintainer of the Lighthouse plugin for +1 year and I haven't found one. For me to be able to maintain it I want the plugin to be as simple as possible.
+* I deeply regret merging the PR for adding multiple runs for Lighthouse. That PR goes against everything I know about measuring performance. Lighthouse is not built for getting correct performance metrics, it's built to help (Chrome) developers to get insights how they make the page "faster". Lets stick to the basics and keep it possible to get those recommendations from Lighthouse.
+* Maybe someday Lighthouse will have support for user journeys, lets wait until that is officially supported and then I can check if it could be used in the plugin.
+
+With the new release we also break how you configure Lighthouse. People has had problem with that since day 1. With the new version we support two new ways to configure Lighthouse:
+- By configuration JSON file. `--lighthouse.config config.js`
+- By Lightouse flags file. `--lighthouse.flags flag.json`
+
+If you don't need to configure Lightouse you can use the default settings both for desktop and mobile. If you run without any settings, the plugin will use desktop settings. If you run with `--mobile`, `--android` or `--ios` the mobile settings will be used. 
+
+### Added
+* Build Docker containers for both amd64 and arm64 to make containers work on Mac M1. The arm container contains Firefox and Chromium. Thank you [whichfinder](https://github.com/whichfinder) and [Radu Micu](https://github.com/radum) for the help! Fixed in PR [#3554](https://github.com/sitespeedio/sitespeed.io/pull/3554).
+* When plugins is loaded, there's a new extra last step where we try to load the plugin as a globally installed npm module [#3546](https://github.com/sitespeedio/sitespeed.io/pull/3546).
+
+### Fixed
+* Fix so that we do not display the same 3rd party cookie multiple times [#3545](https://github.com/sitespeedio/sitespeed.io/pull/3545).
+* Updated Coach Core that includes the latest version of third party web and PageXray that find more fonts without mime type.
+
+## 21.6.1 - 2022-01-24
+### Fixed
+* Updated to [Browsertime 14.18.1](https://github.com/sitespeedio/browsertime/blob/main/CHANGELOG.md#14181---2022-01-24) that makes the summary metric log message use median (instead of mean) and change a log message level to debug.
+## 21.6.0 - 2022-01-24
+### Added
+* Updated to Edge stable release in the Docker container.
+* Remove Crux distribution table and use pie charts instead [#3537](https://github.com/sitespeedio/sitespeed.io/pull/3537)
+* Add extra sleep time between Crux calls to make sure to not overload the API limit [#3536](https://github.com/sitespeedio/sitespeed.io/pull/3536).
+* Added extra Crux enable command line `--crux.enable` to enable Crux [#3538](https://github.com/sitespeedio/sitespeed.io/pull/3538). Its default value is `true` and you also need to supply the Crux key to run Crux. The reason for the new parameter is that you can now configure the key in your configuration JSON and set the enable to false and then you enable it with the CLI parameter when you actually need to run Crux.
+* Show Crux-metrics on the Summary page [#3540](https://github.com/sitespeedio/sitespeed.io/pull/3540).
+* Updated summary metrics tables with headings to make it easier to read [#3541](https://github.com/sitespeedio/sitespeed.io/pull/3541).
+* Added [Browsertime 14.17.0](https://github.com/sitespeedio/browsertime/blob/main/CHANGELOG.md#14170---2022-01-23) with new Select and click.byName commands. With that Browsertime version you also need to have ffprobe installed when you run Visual Metrics but that should already be installed.
+* Added [Browsertime 14.18.0](https://github.com/sitespeedio/browsertime/blob/main/CHANGELOG.md#14180---2022-01-24) with a fix for Firefox [#1698](https://github.com/sitespeedio/browsertime/issues/1698)
+
 ## 21.5.0 - 2022-01-14
 ### Added
-* Upgraded to [Browsertime 14.15.0](https://github.com/sitespeedio/browsertime/blob/main/CHANGELOG.md#14150---2022-01-12) that adds support for `--appendToUserAgent` for Chrome/Edge/Firefox. Amd then Browsertime 14.16.0 that supports Geckodriver for Raspberry Pi.
+* Upgraded to [Browsertime 14.15.0](https://github.com/sitespeedio/browsertime/blob/main/CHANGELOG.md#14150---2022-01-12) that adds support for `--appendToUserAgent` for Chrome/Edge/Firefox. And then Browsertime 14.16.0 that supports Geckodriver for Raspberry Pi.
 ## 21.4.0 - 2022-01-12
 ### Added
 * Updated to a new build of WebPageReplay in the Docker container

package/Dockerfile

@@ -1,9 +1,11 @@
-FROM sitespeedio/webbrowsers:chrome-97.0-firefox-94.0-edge-97.0-dev-2
+FROM sitespeedio/webbrowsers:chrome-98.0-firefox-97.0-edge-98.0
+
+ARG TARGETPLATFORM=linux/amd64
 
 ENV SITESPEED_IO_BROWSERTIME__XVFB true
 ENV SITESPEED_IO_BROWSERTIME__DOCKER true
 
-COPY docker/webpagereplay/wpr /usr/local/bin/
+COPY docker/webpagereplay/$TARGETPLATFORM/wpr /usr/local/bin/
 COPY docker/webpagereplay/wpr_cert.pem /webpagereplay/certs/
 COPY docker/webpagereplay/wpr_key.pem /webpagereplay/certs/
 COPY docker/webpagereplay/deterministic.js /webpagereplay/scripts/deterministic.js

package/Dockerfile-slim

@@ -1,4 +1,6 @@
-FROM node:14.17.6-buster-slim
+FROM node:16.13.2-bullseye-slim
+
+ARG TARGETPLATFORM=linux/amd64
 
 ENV SITESPEED_IO_BROWSERTIME__DOCKER true
 ENV SITESPEED_IO_BROWSERTIME__VIDEO false
@@ -6,22 +8,30 @@ ENV SITESPEED_IO_BROWSERTIME__BROWSER firefox
 ENV SITESPEED_IO_BROWSERTIME__VISUAL_METRICS false
 ENV SITESPEED_IO_BROWSERTIME__HEADLESS true
 
-ENV FIREFOX_VERSION 94.0
+ENV FIREFOX_VERSION 97.0
 
 ENV PATH="/usr/local/bin:${PATH}"
 
 RUN buildDeps='wget bzip2' && apt-get update && apt -y install $buildDeps && \
     # Download and unpack the correct Firefox version
-    wget https://ftp.mozilla.org/pub/firefox/releases/${FIREFOX_VERSION}/linux-x86_64/en-US/firefox-${FIREFOX_VERSION}.tar.bz2 && \
-    tar -xjf firefox-${FIREFOX_VERSION}.tar.bz2 && \
-    rm firefox-${FIREFOX_VERSION}.tar.bz2 && \
-    mv firefox /opt/ && \
-    ln -s /opt/firefox/firefox /usr/local/bin/firefox && \
-    # Install dependencies for Firefox
-    apt-get install -y --no-install-recommends --no-install-suggests libxt6 \
-        `apt-cache depends firefox-esr | awk '/Depends:/{print$2}'` && \
+    if [ "$TARGETPLATFORM" = "linux/amd64" ] ; \
+      then \
+        wget https://ftp.mozilla.org/pub/firefox/releases/${FIREFOX_VERSION}/linux-x86_64/en-US/firefox-${FIREFOX_VERSION}.tar.bz2 && \
+        tar -xjf firefox-${FIREFOX_VERSION}.tar.bz2 && \
+        rm firefox-${FIREFOX_VERSION}.tar.bz2 && \
+        mv firefox /opt/ && \
+        ln -s /opt/firefox/firefox /usr/local/bin/firefox && \
+        # Install dependencies for Firefox
+        apt-get install -y --no-install-recommends --no-install-suggests libxt6 \
+            `apt-cache depends firefox-esr | awk '/Depends:/{print$2}'`; \
+    elif [ "$TARGETPLATFORM" = "linux/arm64" ] ; \
+        then \
+          apt-get update && \
+          apt-get install -y firefox-esr; \
+    fi
+
     # iproute2 = tc
-    apt -y install tcpdump iproute2 ca-certificates sudo --no-install-recommends --no-install-suggests && \
+RUN apt -y install tcpdump iproute2 ca-certificates sudo --no-install-recommends --no-install-suggests && \
     # Cleanup
     apt-get purge -y --auto-remove -o APT::AutoRemove::RecommendsImportant=false $toolDeps \
     && rm -rf /var/lib/apt/lists/* /tmp/* 

package/README.md

@@ -21,13 +21,13 @@
 Before we start telling you all about sitespeed.io you should just try it out:
 
  ```bash
- $ docker run --rm -v "$(pwd)":/sitespeed.io sitespeedio/sitespeed.io https://www.sitespeed.io/
+ docker run --rm -v "$(pwd)":/sitespeed.io sitespeedio/sitespeed.io https://www.sitespeed.io/
  ```
 
  Or using npm (you need Chrome, Firefox, Edge or Safari installed or Chrome/Firefox on Android)
 
  ```bash
- $ npm i -g sitespeed.io && sitespeed.io https://www.sitespeed.io/
+ npm i -g sitespeed.io && sitespeed.io https://www.sitespeed.io/
  ```
 
 Ok, now you have tried it, let us tell you more about sitespeed.io. We think of a complete web performance tool as having three key capabilities:
@@ -74,23 +74,23 @@ When you as user choose to test a URL, this is what happens on a high level:
  Using Docker (use latest Docker):
 
  ```bash
- $ docker run --rm -v "$(pwd)":/sitespeed.io sitespeedio/sitespeed.io https://www.sitespeed.io/
+ docker run --rm -v "$(pwd)":/sitespeed.io sitespeedio/sitespeed.io https://www.sitespeed.io/
  ```
 
  Or install using npm:
 
  ```bash
- $ npm i -g sitespeed.io
+ npm i -g sitespeed.io
  ```
 
  Or clone the repo and test the latest changes:
 
  ```bash
- $ git clone https://github.com/sitespeedio/sitespeed.io.git
- $ cd sitespeed.io
- $ npm install
- $ bin/sitespeed.js --help
- $ bin/sitespeed.js https://www.sitespeed.io/
+ git clone https://github.com/sitespeedio/sitespeed.io.git
+ cd sitespeed.io
+ npm install
+ bin/sitespeed.js --help
+ bin/sitespeed.js https://www.sitespeed.io/
 ```
 
 ## More details

package/lib/core/pluginLoader.js

@@ -66,9 +66,13 @@ module.exports = {
         try {
           plugins.push(require(path.resolve(process.cwd(), name)));
         } catch (error) {
-          console.error("Couldn't load plugin %s: %s", name, err); // eslint-disable-line no-console
-          // if it fails here, let it fail hard
-          throw error;
+          try {
+            plugins.push(require(name));
+          } catch (error) {
+            console.error("Couldn't load plugin %s: %s", name, err); // eslint-disable-line no-console
+            // if it fails here, let it fail hard
+            throw error;
+          }
         }
       }
     }

package/lib/plugins/crux/cli.js

@@ -4,6 +4,12 @@ module.exports = {
       'You need to use a key to get data from CrUx. Get the key from https://developers.google.com/web/tools/chrome-user-experience-report/api/guides/getting-started#APIKey',
     group: 'CrUx'
   },
+  enable: {
+    default: true,
+    describe:
+      'Enable the CrUx plugin. This is on by defauly but you also need the Crux key. If you chose to disable it with this key, set this to false and you can still use the CrUx key in your configuration.',
+    group: 'CrUx'
+  },
   formFactor: {
     default: 'ALL',
     type: 'string',