sitespeed.io 36.2.3 → 36.2.4

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # CHANGELOG - sitespeed.io  (we use [semantic versioning](https://semver.org))
 
+## 36.2.4 - 2025-02-02
+### Fixed
+* The GitHub actions tests on Windows was broken. I think GitHub changed their setup: Suddenly the path to plugins was broken. Rerunning old test that used to work, failed with the same code on our side. It's fixed by [#4426](https://github.com/sitespeedio/sitespeed.io/pull/4426).
+
+* We have had issues with parsing Android configuration because of the `--android` flag to enable Android tests. The problem was that in some cases the internal configuration object become an Array (instead of an object) and that made some objects to do not work. The PR [#4422](https://github.com/sitespeedio/sitespeed.io/pull/4422) removes `--android` from the cli help, however it will still work as before.
+
+* Fix so API calls also looks for `--android.enabled` to know if you want to test on Android [#4427](https://github.com/sitespeedio/sitespeed.io/pull/4427).
+
 ## 36.2.3 - 2025-01-30
 ### Fixed
 * Even better handling of missing runtime settings [#4420](https://github.com/sitespeedio/sitespeed.io/pull/4420).

package/bin/sitespeed.js

@@ -46,7 +46,10 @@ async function api(options) {
 
   if (apiOptions.mobile) {
     apiOptions.api.testType = 'emulatedMobile';
-  } else if (apiOptions.android) {
+  } else if (
+    apiOptions.android === true ||
+    apiOptions.android.enabled === true
+  ) {
     apiOptions.api.testType = 'android';
   } else if (apiOptions.safari && apiOptions.safari.ios) {
     apiOptions.api.testType = 'ios';

package/lib/cli/cli.js

@@ -25,6 +25,10 @@ const version = require('../../package.json').version;
 
 const configFiles = ['.sitespeed.io.json'];
 
+function fixAndroidArgs(args) {
+  return args.map(arg => (arg === '--android' ? '--android.enabled' : arg));
+}
+
 if (process.argv.includes('--config')) {
   const index = process.argv.indexOf('--config');
   configFiles.unshift(process.argv[index + 1]);
@@ -214,11 +218,8 @@ function validateInput(argv) {
 }
 
 export async function parseCommandLine() {
-  let argvFix = process.argv.map(arg =>
-    arg === '--android' ? '--android.enabled' : arg
-  );
-
-  let yargsInstance = yargs(hideBin(argvFix));
+  const fixedArgs = fixAndroidArgs(hideBin(process.argv));
+  const yargsInstance = yargs(fixedArgs);
   let parsed = yargsInstance
     .parserConfiguration({
       'camel-case-expansion': false,
@@ -860,8 +861,8 @@ export async function parseCommandLine() {
         'Process name of the Activity hosting the WebView. If not given, the process name is assumed to be the same as chrome.android.package.',
       group: 'Chrome'
     })
-    .option('browsertime.android', {
-      alias: 'android',
+    .option('browsertime.android.enabled', {
+      alias: ['android.enabled'],
       type: 'boolean',
       default: false,
       describe:
@@ -2194,7 +2195,7 @@ export async function parseCommandLine() {
 
   if (argv.ios) {
     set(argv, 'safari.ios', true);
-  } else if (argv.android && argv.browser === 'chrome') {
+  } else if (argv.android.enabled === true && argv.browser === 'chrome') {
     // Default to Chrome Android.
     set(
       argv,

package/lib/core/pluginLoader.js

@@ -1,10 +1,12 @@
 import path from 'node:path';
 import { readdir as _readdir } from 'node:fs';
 import { promisify } from 'node:util';
+import { fileURLToPath, pathToFileURL } from 'node:url';
 
 import { importGlobalSilent } from 'import-global';
 const readdir = promisify(_readdir);
-const __dirname = path.dirname(import.meta.url);
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
 
 const defaultPlugins = new Set([
   'browsertime',
@@ -49,7 +51,7 @@ export async function parsePluginNames(options) {
     return pluginNames;
   };
 
-  const files = await readdir(new URL(pluginsDir));
+  const files = await readdir(pluginsDir);
 
   const builtins = files.map(name => path.basename(name, '.js'));
   // eslint-disable-next-line unicorn/no-array-callback-reference
@@ -60,9 +62,9 @@ export async function loadPlugins(pluginNames, options, context, queue) {
   const plugins = [];
   for (let name of pluginNames) {
     try {
-      let { default: plugin } = await import(
-        path.join(pluginsDir, name, 'index.js')
-      );
+      const pluginPath = path.join(pluginsDir, name, 'index.js');
+      const pluginUrl = pathToFileURL(pluginPath).href;
+      let { default: plugin } = await import(pluginUrl);
       let p = new plugin(options, context, queue);
       plugins.push(p);
     } catch (error_) {

package/lib/sitespeed.js

@@ -51,92 +51,98 @@ function runOptionalFunction(objects, fN) {
 }
 
 export async function run(options) {
-  const url = options.urls[0];
-  const timestamp = options.utc ? dayjs.utc() : dayjs();
-  const { storageManager, resultUrls } = resultsStorage(
-    url,
-    timestamp,
-    options
-  );
-
-  if (
-    options.browsertime &&
-    options.browsertime.tcpdump &&
-    !env.SSLKEYLOGFILE
-  ) {
-    env.SSLKEYLOGFILE = path.join(
-      storageManager.getBaseDir(),
-      'SSLKEYLOGFILE.txt'
+  try {
+    const url = options.urls[0];
+    const timestamp = options.utc ? dayjs.utc() : dayjs();
+    const { storageManager, resultUrls } = resultsStorage(
+      url,
+      timestamp,
+      options
     );
-  }
-  configure(options);
-
-  // Tell the world what we are using
-  log.info(
-    'Versions OS: %s nodejs: %s sitespeed.io: %s browsertime: %s coach: %s',
-    platform() + ' ' + release(),
-    version,
-    packageJson.version,
-    packageJson.dependencies.browsertime,
-    packageJson.dependencies['coach-core']
-  );
-
-  log.debug('Running with options: %:2j', options);
 
-  let pluginNames = await parsePluginNames(options);
-
-  const plugins = options.plugins;
-
-  // Deprecated setup
-  if (plugins) {
-    if (plugins.disable) {
-      log.warn('--plugins.disable is deprecated, use plugins.remove instead.');
-      plugins.remove = plugins.disable;
-    }
-    if (plugins.load) {
-      log.warn('--plugins.load is deprecated, use plugins.add instead.');
-      plugins.add = plugins.load;
+    if (
+      options.browsertime &&
+      options.browsertime.tcpdump &&
+      !env.SSLKEYLOGFILE
+    ) {
+      env.SSLKEYLOGFILE = path.join(
+        storageManager.getBaseDir(),
+        'SSLKEYLOGFILE.txt'
+      );
     }
+    configure(options);
+
+    // Tell the world what we are using
+    log.info(
+      'Versions OS: %s nodejs: %s sitespeed.io: %s browsertime: %s coach: %s',
+      platform() + ' ' + release(),
+      version,
+      packageJson.version,
+      packageJson.dependencies.browsertime,
+      packageJson.dependencies['coach-core']
+    );
 
-    // Finalize the plugins that we wanna run
-    // First we add the new ones and then remove, that means remove
-    // always wins
-    pluginNames = [...new Set([...pluginNames, ...toArray(plugins.add)])];
+    log.debug('Running with options: %:2j', options);
+
+    let pluginNames = await parsePluginNames(options);
+
+    const plugins = options.plugins;
+
+    // Deprecated setup
+    if (plugins) {
+      if (plugins.disable) {
+        log.warn(
+          '--plugins.disable is deprecated, use plugins.remove instead.'
+        );
+        plugins.remove = plugins.disable;
+      }
+      if (plugins.load) {
+        log.warn('--plugins.load is deprecated, use plugins.add instead.');
+        plugins.add = plugins.load;
+      }
+
+      // Finalize the plugins that we wanna run
+      // First we add the new ones and then remove, that means remove
+      // always wins
+      pluginNames = [...new Set([...pluginNames, ...toArray(plugins.add)])];
+
+      const removeSet = new Set(toArray(plugins.remove));
+      pluginNames = pluginNames.filter(name => !removeSet.has(name));
+
+      if (plugins.list) {
+        log.info(
+          'The following plugins are enabled: %s',
+          pluginNames.join(', ')
+        );
+      }
+    }
 
-    const removeSet = new Set(toArray(plugins.remove));
-    pluginNames = pluginNames.filter(name => !removeSet.has(name));
+    // This is the contect where we wanna run our tests
+    const context = {
+      storageManager,
+      resultUrls,
+      timestamp,
+      budget: budgetResult,
+      name: url,
+      log,
+      getLogger,
+      messageMaker,
+      statsHelpers,
+      filterRegistry
+    };
+    const queueHandler = new QueueHandler(options);
+    const runningPlugins = await loadPlugins(
+      pluginNames,
+      options,
+      context,
+      queueHandler
+    );
+    const urlSources = [options.multi ? scriptSource : urlSource];
+    const allPlugins = [...runningPlugins];
+    queueHandler.setup(runningPlugins);
 
-    if (plugins.list) {
-      log.info('The following plugins are enabled: %s', pluginNames.join(', '));
-    }
-  }
+    // Open/start each and every plugin
 
-  // This is the contect where we wanna run our tests
-  const context = {
-    storageManager,
-    resultUrls,
-    timestamp,
-    budget: budgetResult,
-    name: url,
-    log,
-    getLogger,
-    messageMaker,
-    statsHelpers,
-    filterRegistry
-  };
-  const queueHandler = new QueueHandler(options);
-  const runningPlugins = await loadPlugins(
-    pluginNames,
-    options,
-    context,
-    queueHandler
-  );
-  const urlSources = [options.multi ? scriptSource : urlSource];
-  const allPlugins = [...runningPlugins];
-  queueHandler.setup(runningPlugins);
-
-  // Open/start each and every plugin
-  try {
     await Promise.all(
       runOptionalFunction(allPlugins, 'open', context, options)
     );
@@ -180,7 +186,7 @@ export async function run(options) {
       timestamp: timestamp.format()
     };
   } catch (error) {
-    log.error(error);
+    log.error(error.stack);
     throw error;
   }
 }

package/npm-shrinkwrap.json

@@ -1,12 +1,12 @@
 {
   "name": "sitespeed.io",
-  "version": "36.2.3",
+  "version": "36.2.4",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "sitespeed.io",
-      "version": "36.2.3",
+      "version": "36.2.4",
       "hasInstallScript": true,
       "license": "MIT",
       "dependencies": {

package/package.json

@@ -5,7 +5,7 @@
     "sitespeed.io": "./bin/sitespeed.js",
     "sitespeed.io-wpr": "./bin/browsertimeWebPageReplay.js"
   },
-  "version": "36.2.3",
+  "version": "36.2.4",
   "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",

package/docs/README.md

@@ -1,10 +0,0 @@
-Documentation for sitespeed.io
-================
-
-First make sure you have Bundler: <code>gem install bundler</code>
-
-If you run on a Mac OS make sure you have xcode-select installed: <code>xcode-select --install</code>
-
-To run it locally: <code>bundle install && bundle exec jekyll serve --baseurl ''</code>
-
-Checkout http://localhost:4000/