sitespeed.io 31.0.1 → 31.1.1

package/.github/workflows/windows.yml

@@ -21,8 +21,11 @@ jobs:
         CHROMEDRIVER_SKIP_DOWNLOAD: true
         GECKODRIVER_SKIP_DOWNLOAD: true
     - run: choco outdated
-    - name: Install dependencies
-      run: choco install microsoft-edge --force
+    - name: Show versions
+      run: powershell "Get-AppxPackage -Name *MicrosoftEdge.* | Foreach Version"
+      shell: cmd
+    #- name: Install dependencies
+    #  run: choco install microsoft-edge
     - name: Run Edge test
       run: node bin/sitespeed.js -b edge https://www.sitespeed.io/
       shell: cmd

package/CHANGELOG.md

@@ -1,5 +1,46 @@
 # CHANGELOG - sitespeed.io  (we use [semantic versioning](https://semver.org))
 
+## 31.1.1 - 2024-01-08
+### Fixed
+* When displaying interaction to next paint, there where some copy/paste from largest contentful paint that sometimes broke the HTML (my fault). Fixed in [#4042](https://github.com/sitespeedio/sitespeed.io/pull/4052).
+
+## 31.1.0 - 2024-01-07
+
+We updated the [scripting documentation](https://www.sitespeed.io/documentation/sitespeed.io/scripting/) to be generated directly from Browsertime (using JSDoc). This makes the documentation so much easier to navigate. It's not 100% perfect yet so please feel free to send PRs with updates :)
+
+The new version of Browsertime also adds code completion/IntelliSense support. Read [here](https://www.sitespeed.io/documentation/sitespeed.io/scripting/tutorial-08-Setting-Up-IntelliSense.html) on how to set it up. Make sure to start your scripting like this:
+
+```JavaScript
+/**
+ * @param {import('browsertime').BrowsertimeContext} context
+ * @param {import('browsertime').BrowsertimeCommands} commands
+ */
+export default async function (context, commands) { 
+ 
+};
+```
+
+### Added
+* Update to [Browsertime 21.0.0](https://github.com/sitespeedio/browsertime/blob/main/CHANGELOG.md#2100---2024-01-07):
+  * Upgraded to [Geckodriver 0.34.0](https://github.com/mozilla/geckodriver/releases/tag/v0.34.0) [#2049](https://github.com/sitespeedio/browsertime/pull/2049).
+  * Collect CPU consumption for Firefox. Turn that on with `--firefox.powerConsumption true` and including `power` as a geckoProfilerParams.features [#2046](https://github.com/sitespeedio/browsertime/pull/2046).
+  * Added more commands for mouse click on text [#2054](https://github.com/sitespeedio/browsertime/pull/2054).
+  * Updated AndroidCommand so you can run shell on your Android device as root [#2055](https://github.com/sitespeedio/browsertime/pull/2055).
+  * If you mark a test as failure, the exit code from Browsertime will be 1. If the exitCode is set in scripting, we use that and will not change that [#2057](https://github.com/sitespeedio/browsertime/pull/2057).
+  * Generate documentation for scripting using JSDoc [#2059](https://github.com/sitespeedio/browsertime/pull/2059).
+  * Make it easy to use Seleniums action API. Get access to the new command using commands.action.getActions() and chain the action. [#2061](https://github.com/sitespeedio/browsertime/pull/2061)
+  * Make sure the visual metrics files are inlcuded in the Docker file [#2053](https://github.com/sitespeedio/browsertime/pull/2053).
+  * Removing QVH from the npm package (used for iPhone video recording but not working) [#2051](https://github.com/sitespeedio/browsertime/pull/2051)
+  * Removing visual metrics test images from the npm package [#2050](https://github.com/sitespeedio/browsertime/pull/2050).
+  * Removed the Chromedriver fix that was needed when Chrome for testing broke testing on Chrome :D [#2045](https://github.com/sitespeedio/browsertime/pull/2045).
+  * Refactor of commands/context object to prepare for supporting JSDoc and a little TypeScript to add code completion/IntelliSense in editors [#2047](https://github.com/sitespeedio/browsertime/pull/2047).
+  * Updated documentation for scripting with better JSDoc [#204](https://github.com/sitespeedio/browsertime/pull/2048).
+  * The code for getting Interaction to next paint was broken. This PR fixes it, make the code cleaner and gives more attribution [#2060](https://github.com/sitespeedio/browsertime/pull/2060).
+* If you use `process.exitCode` in your scripting, it will be respected by sitespeed.io and exit with that exit code [#4044](https://github.com/sitespeedio/sitespeed.io/pull/4044).
+
+### Fixed
+* If a run is markedAsFailure in your Browsertime script, sitespeed.io exits with an error code [#4047](https://github.com/sitespeedio/sitespeed.io/pull/4047).
+
 ## 31.0.1 - 2023-12-28
 ### Fixed
 * Hopefully removing "rsd" metrics in InfluxDB see [#4039](https://github.com/sitespeedio/sitespeed.io/pull/4039).

package/bin/sitespeed.js

@@ -148,6 +148,14 @@ async function start() {
         execSync('xdg-open ' + result.localPath + '/index.html');
       }
 
+      // If one of the URLs is marked as a failure in Browsertime
+      // then set the exit code
+      for (let bt of result.browsertime) {
+        if (bt.markedAsFailure === 1) {
+          process.exitCode = 1;
+        }
+      }
+
       if (
         parsed.options.budget &&
         Object.keys(result.budgetResult.failing).length > 0
@@ -157,8 +165,9 @@ async function start() {
       }
 
       if (
-        !budgetFailing ||
-        (parsed.options.budget && parsed.options.budget.suppressExitCode)
+        (!budgetFailing ||
+          (parsed.options.budget && parsed.options.budget.suppressExitCode)) &&
+        process.exitCode === undefined
       ) {
         process.exitCode = 0;
       }

package/lib/cli/cli.js

@@ -724,6 +724,14 @@ export async function parseCommandLine() {
       type: 'number',
       group: 'Firefox'
     })
+    .option('browsertime.firefox.powerConsumption', {
+      alias: 'firefox.powerConsumption',
+      type: 'boolean',
+      default: false,
+      describe:
+        'Enable power consumption collection (in Wh). To get the consumption you also need to set firefox.geckoProfilerParams.features to include power.',
+      group: 'Firefox'
+    })
     .option('browsertime.firefox.geckodriverArgs', {
       alias: 'firefox.geckodriverArgs',
       describe:

package/lib/plugins/browsertime/index.js

@@ -360,10 +360,17 @@ export default class BrowsertimePlugin extends SitespeedioPlugin {
                 run.memory = result[resultIndex].memory[runIndex];
               }
 
+              if (result[resultIndex].powerConsumption) {
+                run.powerConsumption =
+                  result[resultIndex].powerConsumption[runIndex];
+              }
+
               if (result[resultIndex].extras) {
                 run.extras = result[resultIndex].extras[runIndex];
               }
 
+              run.markedAsFailure = result[resultIndex].markedAsFailure;
+
               if (
                 result[resultIndex].cdp &&
                 result[resultIndex].cdp.performance

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

@@ -1,11 +1,29 @@
 if browsertime.pageinfo && browsertime.pageinfo.interactionToNextPaintInfo!== undefined
   a#interactionToNextPaint
   h3 Interaction to Next Paint
-  p Interaction to Next Paint (INP) is a metric that try to measure responsiveness. It's useful if you are testing user journeys Read more about 
+  p Interaction to Next Paint (INP) is a metric that try to measure responsiveness. It's useful if you are testing user journeys. Read more about 
     a(href='https://web.dev/inp/') Interaction to Next Paint
     | .
   .row
-    p The measured latency was #{h.time.ms(browsertime.pageinfo.interactionToNextPaintInfo.latency)}. And the events that contributed to the latency was:
-      ul
-        each entry in browsertime.pageinfo.interactionToNextPaintInfo.entries
-          li #{entry.name} - #{h.time.ms(entry.duration)}
+    p The measured latency was #{h.time.ms(browsertime.pageinfo.interactionToNextPaintInfo.latency)}.
+    table
+      tr
+        td 
+          b Event type
+        td #{browsertime.pageinfo.interactionToNextPaintInfo.eventType}
+      tr
+        td 
+          b Element type
+        td #{browsertime.pageinfo.interactionToNextPaintInfo.tagName}
+      tr
+        td 
+          b Element class name
+        td #{browsertime.pageinfo.interactionToNextPaintInfo.className}
+      tr
+        td 
+          b Event target
+        td #{browsertime.pageinfo.interactionToNextPaintInfo.eventTarget}
+      tr
+        td 
+          b Load state when the event happened
+        td #{browsertime.pageinfo.interactionToNextPaintInfo.loadState}

package/npm-shrinkwrap.json

@@ -1,12 +1,12 @@
 {
   "name": "sitespeed.io",
-  "version": "31.0.1",
+  "version": "31.1.1",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "sitespeed.io",
-      "version": "31.0.1",
+      "version": "31.1.1",
       "license": "MIT",
       "dependencies": {
         "@google-cloud/storage": "6.9.5",
@@ -15,7 +15,7 @@
         "@tgwf/co2": "0.13.10",
         "aws-sdk": "2.1327.0",
         "axe-core": "4.8.2",
-        "browsertime": "20.0.0",
+        "browsertime": "21.0.0",
         "cli-color": "2.0.3",
         "coach-core": "8.0.2",
         "concurrent-queue": "7.0.2",
@@ -985,9 +985,9 @@
       }
     },
     "node_modules/@sitespeed.io/geckodriver": {
-      "version": "0.33.0-c",
-      "resolved": "https://registry.npmjs.org/@sitespeed.io/geckodriver/-/geckodriver-0.33.0-c.tgz",
-      "integrity": "sha512-HRZubf9VOvPcMl9gjOjsom1vVGPZhc53n+BVdXh9uVloT603rO/1W6ny12WcR1EDVctPXfPoneFguqHdT5W5rQ==",
+      "version": "0.34.0",
+      "resolved": "https://registry.npmjs.org/@sitespeed.io/geckodriver/-/geckodriver-0.34.0.tgz",
+      "integrity": "sha512-/AT910tNizgPVey9sSeYpJWt85GwkllGwGGCbnaB6VId/BJNeHfjst1mIIUr628UfUVQDOPJ1z6x0lcCjh6unw==",
       "hasInstallScript": true,
       "dependencies": {
         "node-downloader-helper": "2.1.5",
@@ -1759,15 +1759,15 @@
       }
     },
     "node_modules/browsertime": {
-      "version": "20.0.0",
-      "resolved": "https://registry.npmjs.org/browsertime/-/browsertime-20.0.0.tgz",
-      "integrity": "sha512-gAN3rrkH5oa1SygymrcgwmwHOEtGDVevo4eXfRkX7mVAVPKlW5+qHdoeVXIGqj2SmzlkbPVnKLsnqs5nQGgx5Q==",
+      "version": "21.0.0",
+      "resolved": "https://registry.npmjs.org/browsertime/-/browsertime-21.0.0.tgz",
+      "integrity": "sha512-DRc3Zlz0VlhRH9Vq+7x8KTR6KO9slZ6CisC2Qt63LnR/NjZgR9IXBhxUi/5ncbvwq/pNgplwgFEa8T2hJbHCbw==",
       "dependencies": {
         "@cypress/xvfb": "1.2.4",
         "@devicefarmer/adbkit": "3.2.5",
         "@sitespeed.io/chromedriver": "120.0.6099-71",
         "@sitespeed.io/edgedriver": "120.0.2210-77",
-        "@sitespeed.io/geckodriver": "0.33.0-c",
+        "@sitespeed.io/geckodriver": "0.34.0",
         "@sitespeed.io/throttle": "5.0.0",
         "@sitespeed.io/tracium": "0.3.3",
         "btoa": "1.2.1",
@@ -10017,9 +10017,9 @@
       }
     },
     "@sitespeed.io/geckodriver": {
-      "version": "0.33.0-c",
-      "resolved": "https://registry.npmjs.org/@sitespeed.io/geckodriver/-/geckodriver-0.33.0-c.tgz",
-      "integrity": "sha512-HRZubf9VOvPcMl9gjOjsom1vVGPZhc53n+BVdXh9uVloT603rO/1W6ny12WcR1EDVctPXfPoneFguqHdT5W5rQ==",
+      "version": "0.34.0",
+      "resolved": "https://registry.npmjs.org/@sitespeed.io/geckodriver/-/geckodriver-0.34.0.tgz",
+      "integrity": "sha512-/AT910tNizgPVey9sSeYpJWt85GwkllGwGGCbnaB6VId/BJNeHfjst1mIIUr628UfUVQDOPJ1z6x0lcCjh6unw==",
       "requires": {
         "node-downloader-helper": "2.1.5",
         "node-stream-zip": "1.15.0",
@@ -10601,15 +10601,15 @@
       }
     },
     "browsertime": {
-      "version": "20.0.0",
-      "resolved": "https://registry.npmjs.org/browsertime/-/browsertime-20.0.0.tgz",
-      "integrity": "sha512-gAN3rrkH5oa1SygymrcgwmwHOEtGDVevo4eXfRkX7mVAVPKlW5+qHdoeVXIGqj2SmzlkbPVnKLsnqs5nQGgx5Q==",
+      "version": "21.0.0",
+      "resolved": "https://registry.npmjs.org/browsertime/-/browsertime-21.0.0.tgz",
+      "integrity": "sha512-DRc3Zlz0VlhRH9Vq+7x8KTR6KO9slZ6CisC2Qt63LnR/NjZgR9IXBhxUi/5ncbvwq/pNgplwgFEa8T2hJbHCbw==",
       "requires": {
         "@cypress/xvfb": "1.2.4",
         "@devicefarmer/adbkit": "3.2.5",
         "@sitespeed.io/chromedriver": "120.0.6099-71",
         "@sitespeed.io/edgedriver": "120.0.2210-77",
-        "@sitespeed.io/geckodriver": "0.33.0-c",
+        "@sitespeed.io/geckodriver": "0.34.0",
         "@sitespeed.io/throttle": "5.0.0",
         "@sitespeed.io/tracium": "0.3.3",
         "btoa": "1.2.1",

package/package.json

@@ -5,7 +5,7 @@
     "sitespeed.io": "./bin/sitespeed.js",
     "sitespeed.io-wpr": "./bin/browsertimeWebPageReplay.js"
   },
-  "version": "31.0.1",
+  "version": "31.1.1",
   "description": "sitespeed.io is an open-source tool for comprehensive web performance analysis, enabling you to test, monitor, and optimize your website’s speed using real browsers in various environments.",
   "keywords": [
     "performance",
@@ -83,7 +83,7 @@
     "@tgwf/co2": "0.13.10",
     "aws-sdk": "2.1327.0",
     "axe-core": "4.8.2",
-    "browsertime": "20.0.0",
+    "browsertime": "21.0.0",
     "coach-core": "8.0.2",
     "cli-color": "2.0.3",
     "concurrent-queue": "7.0.2",