sitespeed.io 29.3.0 → 29.4.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # CHANGELOG - sitespeed.io  (we use [semantic versioning](https://semver.org))
 
+## 29.4.0 - 2023-08-31
+### Added
+* Display axe-core version on the summary page (before it was only showed on each run page) [#3950](https://github.com/sitespeedio/sitespeed.io/pull/3950).
+* Display third-party-web and wappalyzer version in the HTML output (by upgrading to [Coach 8.0.0](https://github.com/sitespeedio/coach-core/blob/main/CHANGELOG.md#800---2023-08-30)) [#3953](https://github.com/sitespeedio/sitespeed.io/pull/3953).
+* Display co2 version in the HTML output [#3953](https://github.com/sitespeedio/sitespeed.io/pull/3954).
+
 ## 29.3.0 - 2023-08-16
 ### Added
 * Chrome and Chromedriver 116.

package/lib/plugins/axe/index.js

@@ -2,6 +2,8 @@ import { resolve } from 'node:path';
 import { readFileSync } from 'node:fs';
 import { fileURLToPath } from 'node:url';
 import intel from 'intel';
+import axe from 'axe-core';
+const { version: axeVersion } = axe;
 import { SitespeedioPlugin } from '@sitespeed.io/plugin';
 const log = intel.getLogger('sitespeedio.plugin.axe');
 const __dirname = fileURLToPath(new URL('.', import.meta.url));
@@ -15,7 +17,7 @@ export default class AxePlugin extends SitespeedioPlugin {
     this.options = options;
     this.make = context.messageMaker('axe').make;
     this.pug = readFileSync(resolve(__dirname, 'pug', 'index.pug'), 'utf8');
-    log.info('Axe plugin activated');
+    log.info(`Axe version %s plugin activated`, axeVersion);
   }
 
   processMessage(message, queue) {
@@ -35,7 +37,7 @@ export default class AxePlugin extends SitespeedioPlugin {
 
       case 'sitespeedio.setup': {
         // Tell other plugins that axe will run
-        queue.postMessage(make('axe.setup'));
+        queue.postMessage(make('axe.setup', { version: axeVersion }));
 
         // Add the HTML pugs
         queue.postMessage(

package/lib/plugins/axe/pug/index.pug

@@ -1,13 +1,11 @@
 
 - const axe = pageInfo.data.axe.run ? pageInfo.data.axe.run : pageInfo.data.axe.pageSummary
 
-
 a
 h2 Axe
-p  Axe is an accessibility testing engine for websites and other HTML-based user interfaces. Read more about 
-    a(href='https://github.com/dequelabs/axe-core') axe-core
-    | . #{axe.testEngine ? 'Tested using ' + axe.testEngine.name + ' ' +  axe.testEngine.version + '.' : ''}
-
+p  Axe is an accessibility testing engine for websites and other HTML-based user interfaces. Tested using #{axe.testEngine.name} version #{axe.testEngine.version}. Read more about 
+    a(href='https://github.com/dequelabs/axe-core') axe-core 
+    | .
 
 if pageInfo.data.axe.run
     h3 Violations

package/lib/plugins/browsertime/index.js

@@ -10,7 +10,13 @@ import isEmpty from 'lodash.isempty';
 import get from 'lodash.get';
 import { Stats } from 'fast-stats';
 import coach from 'coach-core';
-const { pickAPage, analyseHar, merge } = coach;
+const {
+  pickAPage,
+  analyseHar,
+  merge,
+  getThirdPartyWebVersion,
+  getWappalyzerCoreVersion
+} = coach;
 import { SitespeedioPlugin } from '@sitespeed.io/plugin';
 
 import { summarizeStats } from '../../support/statsHelpers.js';
@@ -123,6 +129,11 @@ export default class BrowsertimePlugin extends SitespeedioPlugin {
         _merge(options, message.data);
         break;
       }
+
+      case 'axe.setup': {
+        this.axeVersion = message.data.version;
+        break;
+      }
       // Andother plugin got JavaScript that they want to run in Browsertime
       case 'browsertime.scripts': {
         if (message.data.category && message.data.scripts) {
@@ -500,6 +511,11 @@ export default class BrowsertimePlugin extends SitespeedioPlugin {
                   );
                   advice = merge(coachAdvice, harResult);
                 }
+                const thirdPartyWebVersion = getThirdPartyWebVersion();
+                const wappalyzerVersion = getWappalyzerCoreVersion();
+                advice.thirdPartyWebVersion = thirdPartyWebVersion;
+                advice.wappalyzerVersion = wappalyzerVersion;
+
                 super.sendMessage('coach.run', advice, {
                   url,
                   group,
@@ -540,14 +556,12 @@ export default class BrowsertimePlugin extends SitespeedioPlugin {
 
             // Post the result on the queue so other plugins can use it
             if (this.useAxe) {
-              super.sendMessage(
-                'axe.pageSummary',
-                axeAggregatorPerURL.summarizeStats(),
-                {
-                  url,
-                  group
-                }
-              );
+              let stats = axeAggregatorPerURL.summarizeStats();
+              stats.testEngine = { version: this.axeVersion, name: 'axe-core' };
+              super.sendMessage('axe.pageSummary', stats, {
+                url,
+                group
+              });
             }
 
             // Check for errors. Browsertime errors is an array of all iterations

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

@@ -54,6 +54,7 @@ mixin adviceInfo(name, id, perfectScore, node)
     p #{perfectScore}
 
 - const advice = pageInfo.data.coach.run ? pageInfo.data.coach.run.advice : pageInfo.data.coach.pageSummary.advice;
+- const coachVersion = pageInfo.data.coach.run ? pageInfo.data.coach.run.version : pageInfo.data.coach.pageSummary.version;
 
 small 
     if advice
@@ -73,7 +74,7 @@ small
 h2 Coach
 p.small
   a(href='https://github.com/sitespeedio/coach') The coach
-  |  helps you find performance problems on your web page using web performance best practice rules. And gives you advice on privacy and best practices.
+  |  helps you find performance problems on your web page using web performance best practice rules. And gives you advice on privacy and best practices. Tested using Coach-core version #{coachVersion}.
 
 script(type='text/javascript').
   function toggleRow(toggleElement) {

package/lib/plugins/html/templates/url/coach/technology.pug

@@ -1,7 +1,11 @@
+- const wappalyserVersion = pageInfo.data.coach.run ? pageInfo.data.coach.run.wappalyzerVersion : pageInfo.data.coach.pageSummary.wappalyzerVersion;
+- const thirdPartyWebVersion = pageInfo.data.coach.run ? pageInfo.data.coach.run.thirdPartyWebVersion : pageInfo.data.coach.pageSummary.thirdPartyWebVersion;
+
 a#technology
 h2 Technologies used to build the page.
 p Data collected using 
-    a(href='https://github.com/AliasIO/wappalyzer') Wappalyzer. 
+    a(href='https://github.com/dochne/wappalyzer') Wappalyzer
+    | version #{wappalyserVersion}.
     | Use 
     code --browsertime.firefox.includeResponseBodies html
     | or 
@@ -27,7 +31,7 @@ else
 
 if (advice.info.thirdparty && Object.keys(advice.info.thirdparty.toolsByCategory).length > 0)
     p Data collected using 
-        a(href='https://github.com/patrickhulce/third-party-web') Third Party Web.
+        a(href='https://github.com/patrickhulce/third-party-web') Third Party Web #{thirdPartyWebVersion} 
 
     table 
         each data, category in advice.info.thirdparty.toolsByCategory

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

@@ -21,9 +21,10 @@ a#third-party
 a#third-party-categories
 h2 Third party
 
+- const thirdPartyWebVersion = pageInfo.data.coach.run ? pageInfo.data.coach.run.thirdPartyWebVersion : pageInfo.data.coach.pageSummary.thirdPartyWebVersion; 
 p Third party requests categorised by 
     a(href='https://github.com/patrickhulce/third-party-web') Third party web
-    | .
+    |  version #{thirdPartyWebVersion}.
 
 if thirdparty.category && Object.keys(thirdparty.category).length > 0
     .row

package/lib/plugins/sustainable/index.js

@@ -1,5 +1,4 @@
 import { resolve, join } from 'node:path';
-import { readFileSync } from 'node:fs';
 import { fileURLToPath } from 'node:url';
 import fs from 'node:fs';
 import zlib from 'node:zlib';
@@ -10,9 +9,15 @@ import { co2, hosting } from '@tgwf/co2';
 import { SitespeedioPlugin } from '@sitespeed.io/plugin';
 import { Aggregator } from './aggregator.js';
 
-const readFile = promisify(fs.readFile);
-const gunzip = promisify(zlib.gunzip);
+const fsp = fs.promises;
 const __dirname = fileURLToPath(new URL('.', import.meta.url));
+
+const packageJson = JSON.parse(
+  await fsp.readFile(resolve(join(__dirname, '..', '..', '..', 'package.json')))
+);
+const co2Version = packageJson.dependencies['@tgwf/co2'];
+
+const gunzip = promisify(zlib.gunzip);
 const log = intel.getLogger('sitespeedio.plugin.sustainable');
 
 const DEFAULT_METRICS_PAGE_SUMMARY = [
@@ -41,7 +46,7 @@ async function getGzippedFileAsJson(jsonPath) {
 async function loadJSON(jsonPath) {
   const jsonBuffer = jsonPath.endsWith('.gz')
     ? await getGzippedFileAsJson(jsonPath)
-    : await readFile(jsonPath);
+    : await fsp.readFile(jsonPath);
   return JSON.parse(jsonBuffer);
 }
 
@@ -50,12 +55,15 @@ export default class SustainablePlugin extends SitespeedioPlugin {
     super({ name: 'sustainable', options, context, queue });
   }
 
-  open(context, options) {
+  async open(context, options) {
     this.storageManager = context.storageManager;
     this.options = options;
     this.sustainableOptions = options.sustainable || {};
     this.make = context.messageMaker('sustainable').make;
-    this.pug = readFileSync(resolve(__dirname, 'pug', 'index.pug'), 'utf8');
+    this.pug = await fsp.readFile(
+      resolve(__dirname, 'pug', 'index.pug'),
+      'utf8'
+    );
     this.aggregator = new Aggregator(options);
     this.firstRunsData = {};
     context.filterRegistry.registerFilterForType(
@@ -204,7 +212,8 @@ export default class SustainablePlugin extends SitespeedioPlugin {
               co2ThirdParty: co2PerParty.thirdParty,
               hostingGreenCheck,
               dirtiestResources,
-              co2PerContentType
+              co2PerContentType,
+              co2Version
             },
             {
               url: message.url,
@@ -226,6 +235,8 @@ export default class SustainablePlugin extends SitespeedioPlugin {
           const extras = this.firstRunsData[url];
           // Attach first run so we can show that extra data that we don't collect stats for
           summaries.urls[url].firstRun = extras;
+
+          summaries.urls[url].co2Version = co2Version;
           queue.postMessage(
             make('sustainable.pageSummary', summaries.urls[url], {
               url: url,

package/lib/plugins/sustainable/pug/index.pug

@@ -11,6 +11,10 @@ h1 Sustainable Web
 
 - let sustainable = pageInfo.data.sustainable.run ? pageInfo.data.sustainable.run : pageInfo.data.sustainable.pageSummary
 
+p The sustainable metrics is calculated using 
+    a(href='https://github.com/thegreenwebfoundation/co2.js') @tgwf/co2
+    |  version #{sustainable.co2Version}.
+
 p We know that using the internet means using electricity, and because most of that electricity comes from fossil fuels, it means that more data we send, the more fossil fuels we end up burning.
 
 p This is terrible news for the climate, and  
@@ -27,7 +31,8 @@ if !options.sustainable.pageViews
 if (sustainable.hostingInfo)
     p #{sustainable.hostingInfo.url} #{sustainable.hostingInfo.green === true ? 'is hosted green! This means the servers running the site use green energy' : 'does not appear to be running on green energy.'}
 
-    p This information comes from The Green Web Foundation's datasets, which are published as open data. If you have questions, corrections or want to use this data yourself, please visit (href='https://www.thegreenwebfoundation.org') The Green Web Foundation website.
+    p This information comes from The Green Web Foundation's datasets, which are published as open data. If you have questions, corrections or want to use this data yourself, please visit 
+    a(href='https://www.thegreenwebfoundation.org') The Green Web Foundation website.
 
 - const co2FirstParty = sustainable.co2FirstParty.median || sustainable.co2FirstParty
 - const co2ThirdParty = sustainable.co2ThirdParty.median === 0 ? 0 : sustainable.co2ThirdParty.median || sustainable.co2ThirdParty

package/npm-shrinkwrap.json

@@ -1,12 +1,12 @@
 {
   "name": "sitespeed.io",
-  "version": "29.3.0",
+  "version": "29.4.0",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "sitespeed.io",
-      "version": "29.3.0",
+      "version": "29.4.0",
       "license": "MIT",
       "dependencies": {
         "@google-cloud/storage": "6.9.5",
@@ -17,7 +17,7 @@
         "axe-core": "4.7.2",
         "browsertime": "17.15.0",
         "cli-color": "2.0.3",
-        "coach-core": "7.2.1",
+        "coach-core": "8.0.2",
         "concurrent-queue": "7.0.2",
         "dayjs": "1.11.9",
         "fast-crc32c": "2.0.0",
@@ -2425,18 +2425,18 @@
       }
     },
     "node_modules/coach-core": {
-      "version": "7.2.1",
-      "resolved": "https://registry.npmjs.org/coach-core/-/coach-core-7.2.1.tgz",
-      "integrity": "sha512-Mci7Pwf+jmUmpAuao07v1n1yyHs3rQJQwLfRh7xs8ixzl7i0t1XfYWWKF2rdM7UeVmkJUadTdw24N3QotYBWSQ==",
+      "version": "8.0.2",
+      "resolved": "https://registry.npmjs.org/coach-core/-/coach-core-8.0.2.tgz",
+      "integrity": "sha512-iszL8uyaP0KrcFXMYs2nGp1GEPggFAPZyClj6oiZBsXGB/aTdpZs1wmreSAs3bdx7amV9zHEN5Nm53FgWWraFQ==",
       "dependencies": {
         "filter-files": "0.4.0",
         "json-stable-stringify": "1.0.2",
         "lodash.groupby": "4.6.0",
         "lodash.merge": "4.6.2",
         "lodash.sortby": "4.7.0",
-        "pagexray": "4.4.2",
-        "third-party-web": "0.23.0",
-        "wappalyzer-core": "6.10.62"
+        "pagexray": "4.4.4",
+        "third-party-web": "0.24.0",
+        "wappalyzer-core": "6.10.66"
       },
       "engines": {
         "node": ">=14.0.0"
@@ -6825,11 +6825,11 @@
       }
     },
     "node_modules/pagexray": {
-      "version": "4.4.2",
-      "resolved": "https://registry.npmjs.org/pagexray/-/pagexray-4.4.2.tgz",
-      "integrity": "sha512-Cw1WhyuqEy4nACgUMzTfuZn7EcQrsq4ozpTnkVlsGjm4eMbdGXKN8QwflFi1g7p2FpgSq1ElKgTGFrzVNdbEyQ==",
+      "version": "4.4.4",
+      "resolved": "https://registry.npmjs.org/pagexray/-/pagexray-4.4.4.tgz",
+      "integrity": "sha512-eMeJzhtEUBDq8mI3DWD8n1iMFYt90lWE7gP5WfNoXFqFoTQZyj5DAg2O/W7VdRYqZYGpwswC7c0mFToeJfMwDg==",
       "dependencies": {
-        "minimist": "1.2.6"
+        "minimist": "1.2.8"
       },
       "bin": {
         "pagexray": "bin/index.js"
@@ -6838,6 +6838,14 @@
         "node": ">=8.9.0"
       }
     },
+    "node_modules/pagexray/node_modules/minimist": {
+      "version": "1.2.8",
+      "resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.8.tgz",
+      "integrity": "sha512-2yyAR8qBkN3YuheJanUpWC5U3bb5osDywNB8RzDVlDwDHbocAJveqqj1u8+SVD7jkWT4yvsHCpWqqWqAxb0zCA==",
+      "funding": {
+        "url": "https://github.com/sponsors/ljharb"
+      }
+    },
     "node_modules/pako": {
       "version": "1.0.11",
       "resolved": "https://registry.npmjs.org/pako/-/pako-1.0.11.tgz",
@@ -8781,9 +8789,9 @@
       "integrity": "sha1-f17oI66AUgfACvLfSoTsP8+lcLQ="
     },
     "node_modules/third-party-web": {
-      "version": "0.23.0",
-      "resolved": "https://registry.npmjs.org/third-party-web/-/third-party-web-0.23.0.tgz",
-      "integrity": "sha512-JMN1CYDnalQKs4Iyp2/HH1bhy4Euw5Tt1SSAANxmIQCXHrsMiD0c46KNDiRteuKkghXNEOzFlGoXAp3ewXdCXQ=="
+      "version": "0.24.0",
+      "resolved": "https://registry.npmjs.org/third-party-web/-/third-party-web-0.24.0.tgz",
+      "integrity": "sha512-mMkV7LE857QCG9DM/mkZoqsEEbJmtimnWBgm/bAmJuRlfVM29OLhPFse1ayrW1xmtJqg7bVU6ZBtjz8vVQGq2g=="
     },
     "node_modules/through": {
       "version": "2.3.8",
@@ -9125,9 +9133,10 @@
       }
     },
     "node_modules/wappalyzer-core": {
-      "version": "6.10.62",
-      "resolved": "https://registry.npmjs.org/wappalyzer-core/-/wappalyzer-core-6.10.62.tgz",
-      "integrity": "sha512-cCRWcH1L5E6UhCgnPw3w09bBfqH35OL87RjQri7QtQRqxjBlHr+BWKRObphAG0nBo1N01VZe/1EE/zRtEaUBHw==",
+      "version": "6.10.66",
+      "resolved": "https://registry.npmjs.org/wappalyzer-core/-/wappalyzer-core-6.10.66.tgz",
+      "integrity": "sha512-7EOYy4DpdRcfoW00SfCwKjJE3//AAbyl2dzuG6DgICKPoRf60ero/1fBHOB2ipVTmIxpnnlsJ8jY0r5McwRwtA==",
+      "deprecated": "Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.",
       "funding": [
         {
           "url": "https://github.com/sponsors/aliasio"
@@ -11239,18 +11248,18 @@
       }
     },
     "coach-core": {
-      "version": "7.2.1",
-      "resolved": "https://registry.npmjs.org/coach-core/-/coach-core-7.2.1.tgz",
-      "integrity": "sha512-Mci7Pwf+jmUmpAuao07v1n1yyHs3rQJQwLfRh7xs8ixzl7i0t1XfYWWKF2rdM7UeVmkJUadTdw24N3QotYBWSQ==",
+      "version": "8.0.2",
+      "resolved": "https://registry.npmjs.org/coach-core/-/coach-core-8.0.2.tgz",
+      "integrity": "sha512-iszL8uyaP0KrcFXMYs2nGp1GEPggFAPZyClj6oiZBsXGB/aTdpZs1wmreSAs3bdx7amV9zHEN5Nm53FgWWraFQ==",
       "requires": {
         "filter-files": "0.4.0",
         "json-stable-stringify": "1.0.2",
         "lodash.groupby": "4.6.0",
         "lodash.merge": "4.6.2",
         "lodash.sortby": "4.7.0",
-        "pagexray": "4.4.2",
-        "third-party-web": "0.23.0",
-        "wappalyzer-core": "6.10.62"
+        "pagexray": "4.4.4",
+        "third-party-web": "0.24.0",
+        "wappalyzer-core": "6.10.66"
       }
     },
     "code-excerpt": {
@@ -14572,11 +14581,18 @@
       "dev": true
     },
     "pagexray": {
-      "version": "4.4.2",
-      "resolved": "https://registry.npmjs.org/pagexray/-/pagexray-4.4.2.tgz",
-      "integrity": "sha512-Cw1WhyuqEy4nACgUMzTfuZn7EcQrsq4ozpTnkVlsGjm4eMbdGXKN8QwflFi1g7p2FpgSq1ElKgTGFrzVNdbEyQ==",
+      "version": "4.4.4",
+      "resolved": "https://registry.npmjs.org/pagexray/-/pagexray-4.4.4.tgz",
+      "integrity": "sha512-eMeJzhtEUBDq8mI3DWD8n1iMFYt90lWE7gP5WfNoXFqFoTQZyj5DAg2O/W7VdRYqZYGpwswC7c0mFToeJfMwDg==",
       "requires": {
-        "minimist": "1.2.6"
+        "minimist": "1.2.8"
+      },
+      "dependencies": {
+        "minimist": {
+          "version": "1.2.8",
+          "resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.8.tgz",
+          "integrity": "sha512-2yyAR8qBkN3YuheJanUpWC5U3bb5osDywNB8RzDVlDwDHbocAJveqqj1u8+SVD7jkWT4yvsHCpWqqWqAxb0zCA=="
+        }
       }
     },
     "pako": {
@@ -16073,9 +16089,9 @@
       "integrity": "sha1-f17oI66AUgfACvLfSoTsP8+lcLQ="
     },
     "third-party-web": {
-      "version": "0.23.0",
-      "resolved": "https://registry.npmjs.org/third-party-web/-/third-party-web-0.23.0.tgz",
-      "integrity": "sha512-JMN1CYDnalQKs4Iyp2/HH1bhy4Euw5Tt1SSAANxmIQCXHrsMiD0c46KNDiRteuKkghXNEOzFlGoXAp3ewXdCXQ=="
+      "version": "0.24.0",
+      "resolved": "https://registry.npmjs.org/third-party-web/-/third-party-web-0.24.0.tgz",
+      "integrity": "sha512-mMkV7LE857QCG9DM/mkZoqsEEbJmtimnWBgm/bAmJuRlfVM29OLhPFse1ayrW1xmtJqg7bVU6ZBtjz8vVQGq2g=="
     },
     "through": {
       "version": "2.3.8",
@@ -16351,9 +16367,9 @@
       "dev": true
     },
     "wappalyzer-core": {
-      "version": "6.10.62",
-      "resolved": "https://registry.npmjs.org/wappalyzer-core/-/wappalyzer-core-6.10.62.tgz",
-      "integrity": "sha512-cCRWcH1L5E6UhCgnPw3w09bBfqH35OL87RjQri7QtQRqxjBlHr+BWKRObphAG0nBo1N01VZe/1EE/zRtEaUBHw=="
+      "version": "6.10.66",
+      "resolved": "https://registry.npmjs.org/wappalyzer-core/-/wappalyzer-core-6.10.66.tgz",
+      "integrity": "sha512-7EOYy4DpdRcfoW00SfCwKjJE3//AAbyl2dzuG6DgICKPoRf60ero/1fBHOB2ipVTmIxpnnlsJ8jY0r5McwRwtA=="
     },
     "webidl-conversions": {
       "version": "3.0.1",

package/package.json

@@ -5,7 +5,7 @@
     "sitespeed.io": "./bin/sitespeed.js",
     "sitespeed.io-wpr": "./bin/browsertimeWebPageReplay.js"
   },
-  "version": "29.3.0",
+  "version": "29.4.0",
   "description": "Analyze the web performance of your site",
   "keywords": [
     "performance",
@@ -84,7 +84,7 @@
     "aws-sdk": "2.1327.0",
     "axe-core": "4.7.2",
     "browsertime": "17.15.0",
-    "coach-core": "7.2.1",
+    "coach-core": "8.0.2",
     "cli-color": "2.0.3",
     "concurrent-queue": "7.0.2",
     "dayjs": "1.11.9",