browsertime 19.3.1 → 20.0.0

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Browsertime changelog (we do [semantic versioning](https://semver.org))
 
+## 20.0.0 - 2023-12-22
+
+### Breaking
+* Changed `--userTimingWhitelist` to `--userTimingAllowList` in [#2023](https://github.com/sitespeedio/browsertime/pull/2023).
+* Reading pageCompleteCheck JavaScript from file now works as intended. It should be a plain JavaScript file named .js [#2034](https://github.com/sitespeedio/browsertime/pull/2034) see [#912](https://github.com/sitespeedio/browsertime/issues/912)
+
+### Fixed
+* Group page load parameters as PageLoad to make them easier to find using `--help` [#2035](https://github.com/sitespeedio/browsertime/pull/2035).
+* Fix starting Firefox 121 on Mac [#2043](https://github.com/sitespeedio/browsertime/pull/2043).
+
+### Added
+* Firefox 121 in the Docker container.g
+
 ## 19.3.1 - 2023-12-18
 ### Fixed 
 * Ensure that visual metrics python script is included in the release.

package/README.md

@@ -168,13 +168,14 @@ To get the HAR from Firefox we use the [HAR Export Trigger](https://github.com/f
 
 We welcome contributions from the community! Whether you're fixing a bug, adding a feature, or improving documentation, your help is valuable. Here’s how you can contribute:
 
-1. **Fork and Clone**: Fork the repository and clone it locally.
-2. **Create a Branch**: Create a new branch for your feature or bug fix.
-3. **Develop**: Make your changes. Ensure you adhere to the coding standards and write tests if applicable.
-4. **Test**: Run tests to ensure everything works as expected.
-5. **Submit a Pull Request**: Push your changes to your fork and submit a pull request to the main repository.
-
-Before contributing, please read our [CONTRIBUTING.md](CONTRIBUTING.md) for more detailed information on how to contribute.
+1. **Create an Issue**: Create an issue and discuss with us how to implement the issue.
+2. **Fork and Clone**: Fork the repository and clone it locally.
+3. **Create a Branch**: Create a new branch for your feature or bug fix.
+4. **Develop**: Make your changes. Ensure you adhere to the coding standards and write tests if applicable.
+5. **Test**: Run tests to ensure everything works as expected.
+6. **Submit a Pull Request**: Push your changes to your fork and submit a pull request to the main repository.
+
+Before contributing, please read our [CONTRIBUTING.md](.github/CONTRIBUTING.md) for more detailed information on how to contribute.
 
 ### Reporting Issues
 Found a bug or have a feature request? Please use the [GitHub Issues](https://github.com/sitespeedio/browsertime/issues) to report them. Be sure to check existing issues to avoid duplicates.

package/lib/core/engine/command/measure.js

@@ -6,7 +6,7 @@ import { timestamp as _timestamp } from '../../../support/engineUtils.js';
 import { Video } from '../../../video/video.js';
 import { pathToFolder } from '../../../support/pathToFolder.js';
 import { setOrangeBackground } from '../../../video/screenRecording/setOrangeBackground.js';
-import { filterWhitelisted } from '../../../support/userTiming.js';
+import { filterAllowlisted } from '../../../support/userTiming.js';
 import { isAndroidConfigured, Android } from '../../../android/index.js';
 import { TCPDump } from '../../../support/tcpdump.js';
 import { lcpHighlightScript as highlightLargestContentfulPaint } from './util/lcpHighlightScript.js';
@@ -487,11 +487,11 @@ export class Measure {
 
     // Some sites has crazy amount of user timings:
     // strip them if you want
-    if (this.options.userTimingWhitelist) {
-      filterWhitelisted(
+    if (this.options.userTimingAllowList) {
+      filterAllowlisted(
         this.result[this.numberOfMeasuredPages].browserScripts.timings
           .userTimings,
-        this.options.userTimingWhitelist
+        this.options.userTimingAllowList
       );
     }
 

package/lib/core/engine/index.js

@@ -26,7 +26,11 @@ import { Android, isAndroidConfigured } from '../../android/index.js';
 import { RootedDevice } from '../../android/root.js';
 import { run } from './run.js';
 import { IOSRecorder } from '../../video/screenRecording/ios/iosRecorder.js';
-import { loadPrePostScripts, loadScript } from '../../support/engineUtils.js';
+import {
+  loadPrePostScripts,
+  loadScript,
+  loadPageCompleteScript
+} from '../../support/engineUtils.js';
 const log = intel.getLogger('browsertime');
 const defaults = {
   scripts: [],
@@ -260,7 +264,7 @@ export class Engine {
       postScripts = await loadPrePostScripts(options.postScript, options);
       postURLScripts = await loadPrePostScripts(options.postURLScript, options);
       pageCompleteCheck = options.pageCompleteCheck
-        ? await loadScript(options.pageCompleteCheck, options)
+        ? await loadPageCompleteScript(options.pageCompleteCheck)
         : undefined;
     } catch (error) {
       log.error(error.message);

package/lib/firefox/webdriver/builder.js

@@ -1,6 +1,7 @@
 import { resolve } from 'node:path';
 import { fileURLToPath } from 'node:url';
 import path from 'node:path';
+import { platform } from 'node:os';
 import {
   ServiceBuilder,
   Options,
@@ -168,9 +169,36 @@ export async function configureBuilder(builder, baseDir, options) {
   // https://bugzilla.mozilla.org/show_bug.cgi?id=1751196
 
   if (!isAndroidConfigured(options)) {
-    ffOptions.setBinary(
-      firefoxTypes.length > 0 ? firefoxTypes[0] : Channel.RELEASE
-    );
+    // Fix for https://github.com/sitespeedio/browsertime/issues/2041
+    if (platform() === 'darwin') {
+      if (
+        !firefoxConfig.binaryPath &&
+        !firefoxConfig.nightly &&
+        !firefoxConfig.beta &&
+        !firefoxConfig.developer
+      ) {
+        ffOptions.setBinary('/Applications/Firefox.app/Contents/MacOS/firefox');
+      } else if (firefoxConfig.nightly) {
+        ffOptions.setBinary(
+          '/Applications/Firefox Nightly.app/Contents/MacOS/firefox'
+        );
+      } else if (firefoxConfig.beta) {
+        ffOptions.setBinary(
+          '/Applications/Firefox Nightly.app/Contents/MacOS/firefox'
+        );
+      } else if (firefoxConfig.developer) {
+        ffOptions.setBinary(
+          '/Applications/FirefoxDeveloperEdition.app/Contents/MacOS/firefox'
+        );
+      } else if (firefoxConfig.binaryPath) {
+        ffOptions.setBinary(firefoxConfig.binaryPath);
+      }
+    } else {
+      // See https://github.com/sitespeedio/browsertime/issues/2041
+      ffOptions.setBinary(
+        firefoxTypes.length > 0 ? firefoxTypes[0] : Channel.RELEASE
+      );
+    }
   }
 
   ffOptions.addArguments('-no-remote');

package/lib/support/cli.js

@@ -905,43 +905,50 @@ export function parseCommandLine() {
     })
     .option('pageCompleteCheck', {
       describe:
-        'Supply a JavaScript (inline or JavaScript file) that decides when the browser is finished loading the page and can start to collect metrics. The JavaScript snippet is repeatedly queried to see if page has completed loading (indicated by the script returning true). Use it to fetch timings happening after the loadEventEnd. By default the tests ends 2 seconds after loadEventEnd. Also checkout --pageCompleteCheckInactivity and --pageCompleteCheckPollTimeout'
+        'Supply a JavaScript (inline or JavaScript file) that decides when the browser is finished loading the page and can start to collect metrics. The JavaScript snippet is repeatedly queried to see if page has completed loading (indicated by the script returning true). Use it to fetch timings happening after the loadEventEnd. By default the tests ends 2 seconds after loadEventEnd. Also checkout --pageCompleteCheckInactivity and --pageCompleteCheckPollTimeout',
+      group: 'PageLoad'
     })
     .option('pageCompleteWaitTime', {
       describe:
         'How long time you want to wait for your pageComplteteCheck to finish, after it is signaled to closed. Extra parameter passed on to your pageCompleteCheck.',
-      default: 8000
+      default: 8000,
+      group: 'PageLoad'
     })
     .option('pageCompleteCheckInactivity', {
       describe:
         'Alternative way to choose when to end your test. This will wait for 2 seconds of inactivity that happens after loadEventEnd.',
       type: 'boolean',
-      default: false
+      default: false,
+      group: 'PageLoad'
     })
     .option('pageCompleteCheckNetworkIdle', {
       describe:
         'Alternative way to choose when to end your test that works in Chrome and Firefox. Uses CDP or WebDriver Bidi to look at network traffic instead of running JavaScript in the browser to know when to end the test. By default this will wait 5 seconds of inactivity in the network log (no requets/responses in 5 seconds). Use --timeouts.networkIdle to change the 5 seconds. The test will end after 2 minutes if there is still activity on the network. You can change that timout using --timeouts.pageCompleteCheck ',
       type: 'boolean',
-      default: false
+      default: false,
+      group: 'PageLoad'
     })
     .option('pageCompleteCheckPollTimeout', {
       type: 'number',
       default: 1500,
       describe:
-        'The time in ms to wait for running the page complete check the next time.'
+        'The time in ms to wait for running the page complete check the next time.',
+      group: 'PageLoad'
     })
     .option('pageCompleteCheckStartWait', {
       type: 'number',
       default: 5000,
       describe:
-        'The time in ms to wait for running the page complete check for the first time. Use this when you have a pageLoadStrategy set to none'
+        'The time in ms to wait for running the page complete check for the first time. Use this when you have a pageLoadStrategy set to none',
+      group: 'PageLoad'
     })
     .option('pageLoadStrategy', {
       type: 'string',
       default: 'none',
       choices: ['eager', 'none', 'normal'],
       describe:
-        'Set the strategy to waiting for document readiness after a navigation event. After the strategy is ready, your pageCompleteCheck will start runninhg.'
+        'Set the strategy to waiting for document readiness after a navigation event. After the strategy is ready, your pageCompleteCheck will start running.',
+      group: 'PageLoad'
     })
     .option('iterations', {
       alias: 'n',
@@ -965,13 +972,15 @@ export function parseCommandLine() {
       type: 'number',
       default: 0,
       describe:
-        'Extra time added for the browser to settle before starting to test a URL. This delay happens after the browser was opened and before the navigation to the URL'
+        'Extra time added for the browser to settle before starting to test a URL. This delay happens after the browser was opened and before the navigation to the URL',
+      group: 'PageLoad'
     })
     .option('webdriverPageload', {
       type: 'boolean',
       describe:
         'Use webdriver.get to initialize the page load instead of window.location.',
-      default: false
+      default: false,
+      group: 'PageLoad'
     })
     .option('proxy.pac', {
       type: 'string',
@@ -1106,7 +1115,8 @@ export function parseCommandLine() {
       describe:
         'Use internal browser functionality to clear browser cache between runs instead of only using Selenium.',
       type: 'boolean',
-      default: false
+      default: false,
+      group: 'PageLoad'
     })
     .option('basicAuth', {
       describe:
@@ -1211,9 +1221,9 @@ export function parseCommandLine() {
       type: 'integer',
       default: 1500
     })
-    .option('userTimingWhitelist', {
+    .option('userTimingAllowList', {
       describe:
-        'All userTimings are captured by default this option takes a regex that will whitelist which userTimings to capture in the results.'
+        'All userTimings are captured by default this option takes a regex that will allow which userTimings to capture in the results.'
     })
     .option('headless', {
       type: 'boolean',
@@ -1233,7 +1243,8 @@ export function parseCommandLine() {
       type: 'boolean',
       default: false,
       describe:
-        'Flush DNS between runs, works on Mac OS and Linux. Your user needs sudo rights to be able to flush the DNS.'
+        'Flush DNS between runs, works on Mac OS and Linux. Your user needs sudo rights to be able to flush the DNS.',
+      group: 'PageLoad'
     })
     .option('extension', {
       describe:
@@ -1243,7 +1254,8 @@ export function parseCommandLine() {
       describe:
         'Convenient parameter to use if you test a SPA application: will automatically wait for X seconds after last network activity and use hash in file names. Read more: https://www.sitespeed.io/documentation/sitespeed.io/spa/',
       type: 'boolean',
-      default: false
+      default: false,
+      group: 'PageLoad'
     })
     .option('cjs', {
       describe:
@@ -1255,7 +1267,8 @@ export function parseCommandLine() {
       type: 'number',
       default: 3,
       describe:
-        'If the browser fails to start, you can retry to start it this amount of times.'
+        'If the browser fails to start, you can retry to start it this amount of times.',
+      group: 'PageLoad'
     })
     .option('preWarmServer', {
       type: 'boolean',

package/lib/support/engineUtils.js

@@ -1,12 +1,17 @@
 import { resolve, dirname, join } from 'node:path';
 import { promisify } from 'node:util';
-import { writeFile as _writeFile, unlink as _unlink } from 'node:fs';
+import {
+  writeFile as _writeFile,
+  unlink as _unlink,
+  readFile as _readFile
+} from 'node:fs';
 import { pathToFileURL } from 'node:url';
 import dayjs from 'dayjs';
 import intel from 'intel';
 import { toArray } from '../support/util.js';
 const log = intel.getLogger('browsertime');
 const writeFile = promisify(_writeFile);
+const readFile = promisify(_readFile);
 const unlink = promisify(_unlink);
 
 const AsyncFunction = Object.getPrototypeOf(async function () {}).constructor;
@@ -82,6 +87,13 @@ export async function loadPrePostScripts(scripts, options) {
   return readScripts;
 }
 
+export async function loadPageCompleteScript(script) {
+  if (script && script.endsWith('js')) {
+    return readFile(resolve(script), 'utf8');
+  }
+  return script;
+}
+
 export async function loadScript(script, options, throwError) {
   if (script) {
     return loadFile(script, options, throwError);

package/lib/support/userTiming.js

@@ -1,5 +1,5 @@
-export function filterWhitelisted(userTimings, whitelistRegex) {
-  const allowed = new RegExp(whitelistRegex);
+export function filterAllowlisted(userTimings, allowlistRegex) {
+  const allowed = new RegExp(allowlistRegex);
   userTimings.marks = userTimings.marks.filter(mark => allowed.test(mark.name));
   userTimings.measures = userTimings.measures.filter(measure =>
     allowed.test(measure.name)

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "browsertime",
   "description": "Get performance metrics from your web page using Browsertime.",
-  "version": "19.3.1",
+  "version": "20.0.0",
   "bin": "./bin/browsertime.js",
   "type": "module",
   "dependencies": {
@@ -58,7 +58,6 @@
     "browsersupport",
     "visualmetrics",
     "browsertime.png",
-    "docs",
     "index.js",
     "lib",
     "package.json",

package/CONTRIBUTING.md

@@ -1,24 +0,0 @@
-# How to contribute
-Browser Time (it's browser time!) needs help from the users so please contribute!
-
-## Making changes
-If you want help out, that's great! Check the issue list and see if there's something there you want to do and drop Peter a note so we know and we can help you get into the project.
- - Create a new branch for your change
- - Make commits of logical units and write an informative message
- - Make sure you have added the tests needed for your change
- - Run all the tests to make sure you haven't broken anything else (it happens to the best!)
-
-## Add a defect
-First, check the defect/bug list https://github.com/sitespeedio/browsertime/issues?q=is%3Aissue+is%3Aopen+label%3Abug to make sure that it hasn't been filed yet.
-
-If you find a defect, please file a bug report and follow the instructions in https://www.sitespeed.io/documentation/sitespeed.io/bug-report/
-
-If you have the skills & the time, it is perfect if you send a pull request with a fix, that helps me alot!
-
-## Add a change request/new functionality request
-If you have an idea or something that you want Browser Time to handle, add an issue and lets discuss it there. Ideas/changes/requests are very very welcome!
-
-
-Thanks for your support & time!
-
-Peter

package/docs/examples/README.md

@@ -1,9 +0,0 @@
-Examples
-========
-All examples are under the assumption that the tool was installed via npm. If you have cloned the git repository you will need to substitute "browsertime" with the path to the JS file "bin/browsertime.js" relative to the checked out repository.
-
-- [Basic](basic.md)
-- [Advance](advance.md)
-- [Firefox](firefox.md)
-- [Chrome](chrome.md)
-- [Android](android.md)

package/docs/examples/advance.md

@@ -1,12 +0,0 @@
-Advance Examples
-================
-
-This page shows a few of the more advance examples of browsertime
-
-browsertime https://www.sitespeed.io --script ~/browserscripts/scripts.js
-
-- The script option allows for a single file or a directory to be passed to gather custom values that will be available in the JSON output. An additional page will be created to cover this option in the future.
-
-bin/browsertime.js https://www.sitespeed.io --pageCompleteCheck 'return window.performance.timing.loadEventEnd>0'
-
-- You can pass in a javascript snippet that is repeatedly queried to see if page has completed loading (indicated by the script returning true). Default script is 'return window.performance.timing.loadEventEnd>0'.

package/docs/examples/android.md

@@ -1,54 +0,0 @@
-Android Examples
-================
-
-This page will give a few example to get you up and running with
-browsertime on Android devices.  Generally, add `--android` and then
-configure the browser vehicle.
-
-`browsertime --android https://www.sitespeed.io`
-
-- The `--android` flag targets Chrome for Android by
-  default.
-- Chrome for Android means the `com.android.chrome` package (and the
-  `com.google.android.apps.chrome.Main` activity).
-
-`browsertime --android --browser chrome --chrome.android.deviceSerial SERIAL https://www.sitespeed.io`
-
-- Use `chrome.android.deviceSerial` to target a specific device (by
-  serial or by ADB-over-TCP/IP address.
-
-`browsertime --android --browser firefox https://www.sitespeed.io`
-
-- The `firefox` browser means GeckoView example by default.
-- GeckoView example means the `org.mozilla.geckoview_example` package
-  and the `org.mozilla.geckoview_example.GeckoViewActivity` activity.
-
-`browsertime --android --browser firefox --firefox.android.deviceSerial '127.0.0.1:555' https://www.sitespeed.io`
-
-- Use `firefox.android.deviceSerial` to target a specific device (by
-  serial or by ADB-over-TCP/IP address.
-
-`browsertime --android --browser firefox --firefox.android.package org.mozilla.fenix.debug --firefox.android.activity org.mozilla.fenix.IntentReceiverActivity https://www.sitespeed.io`
-
-- Use `firefox.android.{package,activity}` to configure which Android
-  package and activity is invoked for GeckoView (`--browser firefox`)
-  Apps.
-
-`browsertime --android --browser firefox --firefox.android.package org.mozilla.firefox --firefox.android.activity org.mozilla.gecko.BrowserApp --firefox.android.intentArgument=--ez --firefox.android.intentArgument=skipstartpane --firefox.android.intentArgument=true https://www.sitespeed.io`
-
-- Use `firefox.android.intentArgument` to configure how the Android
-  intent is launched.
-- Prefer `firefox.android.intentArgument=...`, especially with
-  arguments starting with hyphens, to avoid a browsertime parsing
-  issue where the `--...` will be interpreted as an argument to
-  browsertime itself.
-- Passed through to `adb shell am start ...` follow the format at
-  [https://developer.android.com/studio/command-line/adb#IntentSpec](https://developer.android.com/studio/command-line/adb#IntentSpec).
-- To add multiple arguments, repeat `--firefox.android.intentArgument`
-  arguments.
-
-`browsertime --android --browser chrome --chrome.android.package org.mozilla.tv.firefox.debug --firefox.android.activity .MainActivity https://www.sitespeed.io`
-
-- Use `chrome.android.{package,activity}` to configure which Android
-  package and activity is invoked for WebView (`--browser chrome`)
-  Apps.

package/docs/examples/basic.md

@@ -1,36 +0,0 @@
-Basic Examples
-==============
-
-This page will give a few example to get you up and running with browsertime.
-
-browsertime --help
-
-- Use the help option if you would like to know what options are available.
-
-browsertime https://www.sitespeed.io
-
-- The only required option when running browsertime is the URL you want to test.
-
-browsertime https://www.sitespeed.io -n 5
-
-- If you would like to override the default number of runs. It defaults to 3.
-
-browsertime https://www.sitespeed.io --screenshot
-
-- If you would like to capture screenshots during your run(s). It will capture a screenshot for each run.
-
-browsertime https://www.sitespeed.io -b chrome
-
-- If you would like to override the default browser used. Defaults to Firefox.
-
-browsertime https://www.sitespeed.io --prettyPrint
-
-- If you would like to output the HAR in a more human readable format.
-
-browsertime https://www.sitespeed.io --delay 5000
-
-- If you would like to deploy the time in between test runs. This option takes milliseconds and defaults no delay(0).
-
-browsertime https://www.sitespeed.io --userAgent 'Googlebot/2.1 (+http://www.googlebot.com/bot.html)'
-
-- If you want to customize the user agent passed to the test runs you can do so with the user agent option.

package/docs/examples/chrome.md

@@ -1,28 +0,0 @@
-Chrome Examples
-===============
-
-This page shows a few of the options specific to Chrome.
-
-browsertime https://www.sitespeed.io -b chrome
-
-- Will use chrome's native performance logs to generate a HAR file.
-
-browsertime https://www.sitespeed.io --chrome.collectPerfLog -b chrome
-
-- Used for debugging  chrome's native HAR export you can have it additionally output the Chrome performance logs.
-
-browsertime https://www.sitespeed.io --chrome.args -b chrome                        
-
-- Extra command line args to pass directly to the chrome process. (e.g. --no-sandbox)
-
-browsertime https://www.sitespeed.io --chrome.binaryPath -b chrome                  
-
-- Path to custom Chrome binary (e.g. Chrome Canary). On OS X, the path should be to the binary inside the app bundle. (e.g. /Applications/Google Chrome Canary.app/Contents/MacOS/Google Chrome Canary)
-
-browsertime https://www.sitespeed.io --chrome.mobileEmulation.deviceName 'Apple iPad' -b chrome
-
-- Name of device to emulate (see list in Chrome DevTools)
-
-browsertime https://www.sitespeed.io --chrome.mobileEmulation.width 360 --chrome.mobileEmulation.height 640 --chrome.mobileEmulation.pixelRatio 2.0 -b chrome
-
-- Width in pixels of emulated mobile screen (e.g. 360), Height in pixels of emulated mobile screen (e.g. 640), Pixel ration of emulated mobile screen (e.g. 2.0)

package/docs/examples/firefox.md

@@ -1,10 +0,0 @@
-Firefox Examples
-================
-
-This page shows a few of the options specific to Firefox.
-
-```
-browsertime https://www.sitespeed.io -b firefox --firefox.binaryPath '/Applications/Firefox.app/Contents/MacOS/firefox-bin'
-```
-
-- Path to custom Firefox binary (e.g. Firefox Nightly). On OS X, the path should be to the binary inside the app bundle. (e.g. /Applications/Firefox.app/Contents/MacOS/firefox-bin)

package/docs/issues.md

@@ -1,18 +0,0 @@
-Running one of the example from the example docs produces the following error:
-
-``` shellsession
-browsertime https://www.sitespeed.io/             
-[2016-04-06 22:40:03] Running chrome for url: https://www.sitespeed.io/
-events.js:141
-      throw er; // Unhandled 'error' event
-      ^
-
-Error: spawn java ENOENT
-    at exports._errnoException (util.js:870:11)
-    at Process.ChildProcess._handle.onexit (internal/child_process.js:178:32)
-    at onErrorNT (internal/child_process.js:344:16)
-    at nextTickCallbackWith2Args (node.js:442:9)
-    at process._tickCallback (node.js:356:17)
-```
-
-Solution: Java is missing from your system and you will need install it.

package/docs/new-style-script-objects.md

@@ -1,38 +0,0 @@
-# New-style script objects:
-
-A new-style object allows the user to write a script that executes in an environment that meets certain requirements. The script writer specifies the requirements for their script and the browser will meet those requirements before executing the script's functionality. If the requirements cannot be met, then the script's functionality will not be executed.
-
-A new-style script object is defined in a script file by a single object that is assigned to `module.exports`. A new-style script object has the following keys:
-
-  * *requires*: An object whose keys define the requirements for executing this script object's functionality.
-  * *function*: A possibly asynchronous function that actually performs the script object's actions. The function will be invoked with no parameters. If the function is asynchronous, it must return a `Promise`. The value `resolve`d by that promise is serialized into browsertime's result output. If the function is not asynchronous, any value returned by this function is written into browsertime's result output.
-
-At the moment, browsertime only supports one requirement in new-style script objects, the `privilege` requirement. If the `privilege` requirement is set to `true`, the new-style script object's functionality will execute with access to the browser's privileged APIs (which is currently only available in Firefox). If the browser cannot guarantee that the script can execute with access to the browser's privileged API (for whatever reason), it will not be executed.
-
-For example,
-
-    module.exports = {
-        requires: { privilege: true },
-        function: function() {
-            const { AppConstants } = ChromeUtils.import(
-                'resource://gre/modules/AppConstants.jsm'
-            );
-            return AppConstants;
-        }
-    };
-
-defines a new-style script object that requires access to the browser's privileged API in order to fetch its constants.
-
-The equivalent functionality can be accomplished asynchronously:
-
-    module.exports = {
-        requires: { privilege: true },
-        function: async function() {
-                return new Promise(resolve => {
-                        const { AppConstants } = ChromeUtils.import(
-                                'resource://gre/modules/AppConstants.jsm'
-                        );
-                        resolve(AppConstants);
-                });
-        }
-    };

package/docs/sequence-diagrams/loadAndWait.wsd

@@ -1,24 +0,0 @@
-title Load a url and wait for load to complete
-
-caller -> SeleniumRunner: loadAndWait
-SeleniumRunner -> Browser: set page load timeout
-SeleniumRunner -> Browser: set script timeout
-SeleniumRunner -> Browser: Load url
-
-note right of Browser
-Wait at most "page load timeout"
-milliseconds
-end note
-
-Browser -> SeleniumRunner :
-SeleniumRunner -> Browser: executeScript "pageCompleteCheck"
-
-note right of Browser
-Keep testing script
-at most "wait script timeout"
-milliseconds
-end note
-
-Browser -> SeleniumRunner :
-
-SeleniumRunner -> caller :

package/docs/sequence-diagrams/run.wsd

@@ -1,24 +0,0 @@
-title Run one url via Engine
-
-caller -> Engine: run
-Engine -> EngineDelegate: onStartRun (BmpRunner - start proxy)
-
-loop n times
-  Engine -> SeleniumRunner: start
-  SeleniumRunner -> Browser: launch browser
-  Engine -> EngineDelegate: onStartIteration (createHAR OR startNewPage)
-  Engine -> SeleniumRunner: loadAndWait
-  SeleniumRunner -> Browser: get url and execute pageCompleteCheck
-  loop for each script
-    Engine -> SeleniumRunner: runScript
-    SeleniumRunner -> Browser: executeScript
-  end
-  Engine -> EngineDelegate: onStopIteration
-  Engine -> SeleniumRunner: stop
-  SeleniumRunner -> Browser: quit browser
-  Engine -> Engine: optionally wait for short delay
-end
-
-Engine -> EngineDelegate: onStopRun (BmpRunner - getHAR, stop proxy)
-
-Engine -> caller : [return HAR and script results]