sitespeed.io 30.4.0 → 30.5.0

package/CHANGELOG.md

@@ -1,10 +1,20 @@
 # CHANGELOG - sitespeed.io  (we use [semantic versioning](https://semver.org))
 
+## 30.5.0 - 2023-11-28
+### Added
+* The new compare plugin can now run without an id. The id will then be generated from the URL. If you don't give it an id, yoiu can only compare pages with the exact same URL [#4013](https://github.com/sitespeedio/sitespeed.io/pull/4013).
+
+## 30.4.1 - 2023-11-28
+### Fixed
+* Fix for Firefox when generating the result HTML. It was broken since we where missing CPU data.
+
 ## 30.4.0 - 2023-11-27
 ### Fixed
 * Upgrade to Browsretime 19.1.0 with a fix for Geckodriver so that the correct ARM version is installed on Mac Arm machines.
 ### Added
-* The new compare plugin makes it easy to use Mann Whitney U/Wilcox for support to find performance egressions. Read all about the plugin in the [documentation](https://www.sitespeed.io/documentation/sitespeed.io/compare/).
+* The new compare plugin [PR 4009](https://github.com/sitespeedio/sitespeed.io/pull/4009) makes it easy to use Mann Whitney U/Wilcox for support to find performance egressions. Read all about the plugin in the [documentation](https://www.sitespeed.io/documentation/sitespeed.io/compare/).
+* Firefox 120 in the Docker container [#4010](https://github.com/sitespeedio/sitespeed.io/pull/4010).
+* Button to download the console logs, thank you [bairov pavel](https://github.com/Amerousful) for PR [#4007](https://github.com/sitespeedio/sitespeed.io/pull/4007).
 
 ## 30.3.0 - 2023-11-09
 

package/CONTRIBUTORS.md

@@ -45,3 +45,4 @@ Many many many thanks to:
 * [Devrim Tufan](https://github.com/tufandevrim)
 * [Keith Cirkel](https://github.com/keithamus)
 * [Jonathan Lee](https://github.com/beenanner)
+* [Pavel Bairov](https://github.com/Amerousful)

package/lib/cli/cli.js

@@ -1874,7 +1874,7 @@ export async function parseCommandLine() {
     .option('compare.id', {
       type: 'string',
       describe:
-        'The id of the test. Will be used to find the baseline test, that is using the id as a part of the name.',
+        'The id of the test. Will be used to find the baseline test, that is using the id as a part of the name. If you do not add an id, an id will be generated using the URL and that will only work if you baseline against the exact same URL.',
       group: 'compare'
     })
     .option('compare.baselinePath', {

package/lib/plugins/compare/index.js

@@ -7,7 +7,6 @@ import intel from 'intel';
 import merge from 'lodash.merge';
 import dayjs from 'dayjs';
 
-import { throwIfMissing } from '../../support/util.js';
 import { getStatistics, runStatisticalTests, getMetrics } from './helper.js';
 import { getBaseline, saveBaseline } from './baseline.js';
 
@@ -16,6 +15,14 @@ const __dirname = fileURLToPath(new URL('.', import.meta.url));
 const log = intel.getLogger('sitespeedio.plugin.compare');
 const defaultConfig = {};
 
+function urlToId(url) {
+  return url
+    .replace(/^https?:\/\//, '')
+    .replaceAll(/[^\d.A-Za-z]/g, '_')
+    .replaceAll(/__+/g, '_')
+    .replaceAll(/^_|_$/g, '');
+}
+
 const TIME_FORMAT = 'YYYY-MM-DD HH:mm:ss';
 
 const DEFAULT_METRICS_PAGESUMMARY = [
@@ -40,7 +47,6 @@ export default class ComparePlugin extends SitespeedioPlugin {
     this.make = context.messageMaker('compare').make;
     this.compareOptions = merge({}, defaultConfig, options.compare);
     this.options = options;
-    throwIfMissing(options.compare, ['id'], 'compare');
     this.pug = readFileSync(resolve(__dirname, 'pug', 'index.pug'), 'utf8');
     log.info(
       'Starting the compare plugin.' +
@@ -73,10 +79,16 @@ export default class ComparePlugin extends SitespeedioPlugin {
       }
       case 'browsertime.pageSummary': {
         this.page++;
+        const id = this.options.compare.id || urlToId(message.data.info.url);
         const baseline = await getBaseline(
-          this.options.compare.id + '-' + this.page,
+          id + '-' + this.page,
           this.compareOptions
         );
+        if (this.options.compare.id) {
+          log.info('Using id %s for page baseline', id);
+        } else {
+          log.info('Using auto generated id for the baseline: %s ', id);
+        }
 
         if (baseline) {
           if (
@@ -88,9 +100,7 @@ export default class ComparePlugin extends SitespeedioPlugin {
               baseline.timestamps.length,
               this.options.browsertime.iterations
             );
-          log.info(
-            'Got a baseline:' + this.options.compare.id + '-' + this.page
-          );
+          log.info('Got a baseline:' + id + '-' + this.page);
           const newMetrics = getMetrics(message.data);
           const baselineMetrics = getMetrics(baseline);
           const metricsInputData = {
@@ -196,7 +206,7 @@ export default class ComparePlugin extends SitespeedioPlugin {
               message.data,
               join(
                 this.compareOptions.baselinePath || process.cwd(),
-                `${this.options.compare.id}-${this.page}.json`
+                `${id}-${this.page}.json`
               )
             );
           }
@@ -216,7 +226,7 @@ export default class ComparePlugin extends SitespeedioPlugin {
               message.data,
               join(
                 this.compareOptions.baselinePath || process.cwd(),
-                `${this.options.compare.id}-${this.page}.json`
+                `${id}-${this.page}.json`
               )
             );
           }

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

@@ -178,7 +178,7 @@ if browsertime
               td
                 a(href=baseHelpURL + 'firstInputDelay')  First Input Delay (FID)
               td.number #{h.time.ms(timings.firstInput.delay)}
-          else 
+          else if (cpu && cpu.longTasks)
             tr 
               td
                 a(href=baseHelpURL + 'totalBlockingTime') Total Blocking Time (TBT)

package/npm-shrinkwrap.json

@@ -1,12 +1,12 @@
 {
   "name": "sitespeed.io",
-  "version": "30.4.0",
+  "version": "30.5.0",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "sitespeed.io",
-      "version": "30.4.0",
+      "version": "30.5.0",
       "license": "MIT",
       "dependencies": {
         "@google-cloud/storage": "6.9.5",

package/package.json

@@ -5,7 +5,7 @@
     "sitespeed.io": "./bin/sitespeed.js",
     "sitespeed.io-wpr": "./bin/browsertimeWebPageReplay.js"
   },
-  "version": "30.4.0",
+  "version": "30.5.0",
   "description": "Analyze the web performance of your site",
   "keywords": [
     "performance",