browsertime 16.17.0 → 17.0.0-beta.0

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

@@ -1,8 +1,8 @@
-'use strict';
-const log = require('intel').getLogger('browsertime.command.devtoolsprotocol');
+import intel from 'intel';
+const log = intel.getLogger('browsertime.command.devtoolsprotocol');
 
 // https://chromedevtools.github.io/devtools-protocol/
-class DevToolsProtocol {
+class DevelopmentToolsProtocol {
   constructor(engineDelegate, browserName) {
     this.engineDelegate = engineDelegate;
     this.browserName = browserName;
@@ -13,14 +13,14 @@ class DevToolsProtocol {
       try {
         const client = this.engineDelegate.getCDPClient();
         await client.on(event, f);
-      } catch (e) {
+      } catch (error) {
         log.error(
           'Could not listen to DevToolsProtocol event %s with args %j',
           event,
           f
         );
-        log.verbose(e);
-        throw Error(
+        log.verbose(error);
+        throw new Error(
           `Could not listen to DevToolsProtocol event ${event} with args ${f}`
         );
       }
@@ -29,21 +29,21 @@ class DevToolsProtocol {
     }
   }
 
-  async sendAndGet(command, args) {
+  async sendAndGet(command, arguments_) {
     if (this.browserName === 'chrome' || this.browserName === 'edge') {
       try {
         const client = this.engineDelegate.getCDPClient();
-        const result = await client.send(command, args);
+        const result = await client.send(command, arguments_);
         return result;
-      } catch (e) {
+      } catch (error) {
         log.error(
           'Could not sendAndGet to DevToolsProtocol command %s with args %j',
           command,
-          args
+          arguments_
         );
-        log.verbose(e);
-        throw Error(
-          `Could not sendAndGet to DevToolsProtocol command ${command} with args ${args}`
+        log.verbose(error);
+        throw new Error(
+          `Could not sendAndGet to DevToolsProtocol command ${command} with args ${arguments_}`
         );
       }
     } else {
@@ -51,23 +51,23 @@ class DevToolsProtocol {
     }
   }
 
-  async send(command, args) {
+  async send(command, arguments_) {
     if (this.browserName === 'chrome' || this.browserName === 'edge') {
       try {
         const client = this.engineDelegate.getCDPClient();
-        return client.send(command, args);
-      } catch (e) {
+        return client.send(command, arguments_);
+      } catch (error) {
         log.error(
           'Could not send to DevToolsProtocol command %s with args %j',
           command,
-          args
+          arguments_
         );
-        log.verbose(e);
-        `Could not send to DevToolsProtocol command ${command} with args ${args}`;
+        log.verbose(error);
+        `Could not send to DevToolsProtocol command ${command} with args ${arguments_}`;
       }
     } else {
       throw new Error('DevToolsProtocol only supported in Chrome and Edge');
     }
   }
 }
-module.exports = DevToolsProtocol;
+export default DevelopmentToolsProtocol;

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

@@ -1,6 +1,5 @@
-'use strict';
-
-const log = require('intel').getLogger('browsertime.command.click');
+import intel from 'intel';
+const log = intel.getLogger('browsertime.command.click');
 
 function addClick(js) {
   const trimmed = js.trim();
@@ -29,10 +28,10 @@ class Click {
     try {
       const script = `document.getElementsByClassName('${className}')[0].click();`;
       await this.browser.runScript(script, 'CUSTOM');
-    } catch (e) {
+    } catch (error) {
       log.error('Could not find element by class name %s', className);
-      log.verbose(e);
-      throw Error('Could not find element by class name ' + className);
+      log.verbose(error);
+      throw new Error('Could not find element by class name ' + className);
     }
   }
 
@@ -47,10 +46,10 @@ class Click {
       const script = `document.getElementsByClassName('${className}')[0].click();`;
       await this.browser.runScript(script, 'CUSTOM');
       return this.browser.extraWait(this.pageCompleteCheck);
-    } catch (e) {
+    } catch (error) {
       log.error('Could not find element by class name %s', className);
-      log.verbose(e);
-      throw Error('Could not find element by class name ' + className);
+      log.verbose(error);
+      throw new Error('Could not find element by class name ' + className);
     }
   }
 
@@ -64,10 +63,10 @@ class Click {
     try {
       const xpath = `//a[text()='${text}']`;
       return this.byXpath(xpath);
-    } catch (e) {
+    } catch (error) {
       log.error('Could not find link by text %s', text);
-      log.verbose(e);
-      throw Error('Could not find link by text ' + text);
+      log.verbose(error);
+      throw new Error('Could not find link by text ' + text);
     }
   }
 
@@ -81,10 +80,10 @@ class Click {
     try {
       const xpath = `//a[text()='${text}']`;
       return this.byXpathAndWait(xpath);
-    } catch (e) {
+    } catch (error) {
       log.error('Could not find link with text %s', text);
-      log.verbose(e);
-      throw Error('Could not find link by text ' + text);
+      log.verbose(error);
+      throw new Error('Could not find link by text ' + text);
     }
   }
 
@@ -98,10 +97,10 @@ class Click {
     try {
       const xpath = `//a[contains(text(),'${text}')]`;
       return this.byXpath(xpath);
-    } catch (e) {
+    } catch (error) {
       log.error('Could not find link by partial text %s', text);
-      log.verbose(e);
-      throw Error('Could not find link by partial text ' + text);
+      log.verbose(error);
+      throw new Error('Could not find link by partial text ' + text);
     }
   }
 
@@ -115,10 +114,10 @@ class Click {
     try {
       const xpath = `//a[contains(text(),'${text}')]`;
       return this.byXpathAndWait(xpath);
-    } catch (e) {
+    } catch (error) {
       log.error('Could not find link by partial text %s', text);
-      log.verbose(e);
-      throw Error('Could not find link by partial text ' + text);
+      log.verbose(error);
+      throw new Error('Could not find link by partial text ' + text);
     }
   }
   /**
@@ -133,10 +132,10 @@ class Click {
       const replaced = xpath.replace(/"/g, "'");
       const script = `document.evaluate("${replaced}", document, null, XPathResult.FIRST_ORDERED_NODE_TYPE, null).singleNodeValue.click();`;
       return this.browser.runScript(script, 'CUSTOM');
-    } catch (e) {
+    } catch (error) {
       log.error('Could not find element by xpath %s', xpath);
-      log.verbose(e);
-      throw Error('Could not find element by xpath ' + xpath);
+      log.verbose(error);
+      throw new Error('Could not find element by xpath ' + xpath);
     }
   }
   /**.
@@ -153,10 +152,10 @@ class Click {
       const script = `document.evaluate("${replaced}", document, null, XPathResult.FIRST_ORDERED_NODE_TYPE, null).singleNodeValue.click();`;
       await this.browser.runScript(script, 'CUSTOM');
       return this.browser.extraWait(this.pageCompleteCheck);
-    } catch (e) {
+    } catch (error) {
       log.error('Could not find element by xpath %s', xpath);
-      log.verbose(e);
-      throw Error('Could not find element by xpath ' + xpath);
+      log.verbose(error);
+      throw new Error('Could not find element by xpath ' + xpath);
     }
   }
 
@@ -170,10 +169,10 @@ class Click {
     try {
       const script = addClick(js);
       await this.browser.runScript(script, 'CUSTOM');
-    } catch (e) {
+    } catch (error) {
       log.error('Could not find element by JavaScript %s', js);
-      log.verbose(e);
-      throw Error('Could not find element by JavaScript ' + js);
+      log.verbose(error);
+      throw new Error('Could not find element by JavaScript ' + js);
     }
   }
 
@@ -188,10 +187,10 @@ class Click {
       const script = addClick(js);
       await this.browser.runScript(script, 'CUSTOM');
       return this.browser.extraWait(this.pageCompleteCheck);
-    } catch (e) {
+    } catch (error) {
       log.error('Could not find element by JavaScript %s', js);
-      log.verbose(e);
-      throw Error('Could not find element by JavaScript ' + js);
+      log.verbose(error);
+      throw new Error('Could not find element by JavaScript ' + js);
     }
   }
 
@@ -205,10 +204,10 @@ class Click {
     try {
       const script = `document.getElementById('${id}').click();`;
       await this.browser.runScript(script, 'CUSTOM');
-    } catch (e) {
+    } catch (error) {
       log.error('Could not find element by id %s', id);
-      log.verbose(e);
-      throw Error('Could not find element by id ' + id);
+      log.verbose(error);
+      throw new Error('Could not find element by id ' + id);
     }
   }
 
@@ -222,10 +221,10 @@ class Click {
     try {
       const script = `document.querySelector("[name='${name}']").click()`;
       await this.browser.runScript(script, 'CUSTOM');
-    } catch (e) {
+    } catch (error) {
       log.error('Could not find element by name %s', name);
-      log.verbose(e);
-      throw Error('Could not find element by name ' + name);
+      log.verbose(error);
+      throw new Error('Could not find element by name ' + name);
     }
   }
 
@@ -240,10 +239,10 @@ class Click {
       const script = `document.getElementById('${id}').click();`;
       await this.browser.runScript(script, 'CUSTOM');
       return this.browser.extraWait(this.pageCompleteCheck);
-    } catch (e) {
+    } catch (error) {
       log.error('Could not find element by id %s', id);
-      log.verbose(e);
-      throw Error('Could not find element by id ' + id);
+      log.verbose(error);
+      throw new Error('Could not find element by id ' + id);
     }
   }
 
@@ -251,10 +250,10 @@ class Click {
     try {
       const script = `document.querySelector('${selector}').click();`;
       await this.browser.runScript(script, 'CUSTOM');
-    } catch (e) {
+    } catch (error) {
       log.error('Could not click using selector %s', selector);
-      log.verbose(e);
-      throw Error('Could not click using selector ' + selector);
+      log.verbose(error);
+      throw new Error('Could not click using selector ' + selector);
     }
   }
 
@@ -263,11 +262,11 @@ class Click {
       const script = `document.querySelector('${selector}').click();`;
       await this.browser.runScript(script, 'CUSTOM');
       return this.browser.extraWait(this.pageCompleteCheck);
-    } catch (e) {
+    } catch (error) {
       log.error('Could not click using selector %s', selector);
-      log.verbose(e);
-      throw Error('Could not click using selector ' + selector);
+      log.verbose(error);
+      throw new Error('Could not click using selector ' + selector);
     }
   }
 }
-module.exports = Click;
+export default Click;

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

@@ -1,6 +1,5 @@
-'use strict';
-
-const log = require('intel').getLogger('browsertime.command.debug');
+import intel from 'intel';
+const log = intel.getLogger('browsertime.command.debug');
 const delay = ms => new Promise(res => setTimeout(res, ms));
 
 class Debug {
@@ -45,4 +44,4 @@ class Debug {
   }
 }
 
-module.exports = Debug;
+export default Debug;

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

@@ -1,6 +1,5 @@
-'use strict';
-
-const log = require('intel').getLogger('browsertime.command.javascript');
+import intel from 'intel';
+const log = intel.getLogger('browsertime.command.javascript');
 class JavaScript {
   constructor(browser, pageCompleteCheck) {
     this.browser = browser;
@@ -17,10 +16,10 @@ class JavaScript {
     try {
       const value = await this.browser.runScript(js, 'CUSTOM');
       return value;
-    } catch (e) {
+    } catch (error) {
       log.error('Could not run JavaScript %s ', js);
-      log.verbose(e);
-      throw Error(`Could not run JavaScript ${js}`);
+      log.verbose(error);
+      throw new Error(`Could not run JavaScript ${js}`);
     }
   }
 
@@ -34,10 +33,10 @@ class JavaScript {
     try {
       await this.browser.runScript(js, 'CUSTOM');
       return this.browser.extraWait(this.pageCompleteCheck);
-    } catch (e) {
+    } catch (error) {
       log.error('Could not run JavaScript %s ', js);
-      log.verbose(e);
-      throw Error(`Could not run JavaScript ${js}`);
+      log.verbose(error);
+      throw new Error(`Could not run JavaScript ${js}`);
     }
   }
 
@@ -54,10 +53,10 @@ class JavaScript {
         'CUSTOM PRIVILEGED'
       );
       return value;
-    } catch (e) {
+    } catch (error) {
       log.error('Could not run privileged JavaScript %s ', js);
-      log.verbose(e);
-      throw e;
+      log.verbose(error);
+      throw error;
     }
   }
 
@@ -71,10 +70,10 @@ class JavaScript {
     try {
       await this.browser.runPrivilegedScript(js, 'CUSTOM PRIVILEGED');
       return this.browser.extraWait(this.pageCompleteCheck);
-    } catch (e) {
+    } catch (error) {
       log.error('Could not run privileged JavaScript %s ', js);
-      log.verbose(e);
-      throw e;
+      log.verbose(error);
+      throw error;
     }
   }
 
@@ -91,11 +90,11 @@ class JavaScript {
         'CUSTOM ASYNC PRIVILEGED'
       );
       return value;
-    } catch (e) {
+    } catch (error) {
       log.error('Could not run async privileged JavaScript %s ', js);
-      log.verbose(e);
-      throw e;
+      log.verbose(error);
+      throw error;
     }
   }
 }
-module.exports = JavaScript;
+export default JavaScript;

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

@@ -1,19 +1,18 @@
-'use strict';
-
-const log = require('intel').getLogger('browsertime.command.measure');
-const get = require('lodash.get');
-const engineUtils = require('../../../support/engineUtils');
-const Video = require('../../../video/video');
-const merge = require('lodash.merge');
-const pathToFolder = require('../../../support/pathToFolder');
-const path = require('path');
-const setOrangeBackground = require('../../../video/screenRecording/setOrangeBackground');
-const { filterWhitelisted } = require('../../../support/userTiming');
-const { isAndroidConfigured, Android } = require('../../../android');
-const TCPDump = require('../../../support/tcpdump');
+import { join } from 'node:path';
+import intel from 'intel';
+import get from 'lodash.get';
+import merge from 'lodash.merge';
+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 { isAndroidConfigured, Android } from '../../../android/index.js';
+import TCPDump from '../../../support/tcpdump.js';
+import highlightLargestContentfulPaint from './util/lcpHighlightScript.js';
+import highlightLS from './util/lsHighlightScript.js';
 const delay = ms => new Promise(res => setTimeout(res, ms));
-const highlightLargestContentfulPaint = require('./util/lcpHighlightScript.js');
-const highlightLS = require('./util/lsHighlightScript.js');
+const log = intel.getLogger('browsertime.command.measure');
 
 // In some cases we could have one alias mapped to multiple URLs
 // we've seen it for login etc where the user get different query parameter
@@ -23,7 +22,7 @@ const aliasAndUrl = {};
 function getNewResult() {
   return {
     extraJson: {},
-    timestamp: engineUtils.timestamp(),
+    timestamp: _timestamp(),
     extras: {}
   };
 }
@@ -191,7 +190,7 @@ class Measure {
     }
 
     this.result.push(getNewResult());
-    this.result[this.numberOfMeasuredPages].timestamp = engineUtils.timestamp();
+    this.result[this.numberOfMeasuredPages].timestamp = _timestamp();
 
     if (alias || optionalAlias) {
       this.result[this.numberOfMeasuredPages].alias = alias || optionalAlias;
@@ -232,8 +231,8 @@ class Measure {
         await this.engineDelegate.beforeEachURL(this.browser, url);
         await this.browser.loadAndWait(url, this.pageCompleteCheck);
         return this.stop(url);
-      } catch (e) {
-        this.result[this.numberOfMeasuredPages].error = [e.name];
+      } catch (error) {
+        this.result[this.numberOfMeasuredPages].error = [error.name];
         // The page failed loading but make sure we keep track of
         // how many pages we tried to measure
         this.numberOfMeasuredPages++;
@@ -242,7 +241,7 @@ class Measure {
         // If we got an error we still should stop the video to make sure we can use it to
         // try to understand what went wrong
         await this._stopVideo(url);
-        throw e;
+        throw error;
       }
     } else {
       this.areWeMeasuring = true;
@@ -267,11 +266,9 @@ class Measure {
         url
       );
       this.testedURLs[url] = this.testedURLs[url] + 1;
-      if (url.indexOf('?') > -1) {
-        url = url + '&browsertime_run=' + this.testedURLs[url];
-      } else {
-        url = url + '?browsertime_run=' + this.testedURLs[url];
-      }
+      url = url.includes('?')
+        ? url + '&browsertime_run=' + this.testedURLs[url]
+        : url + '?browsertime_run=' + this.testedURLs[url];
     } else {
       this.testedURLs[url] = 1;
     }
@@ -291,7 +288,7 @@ class Measure {
 
     // We have the URL, create the data dir
     await this.storageManager.createSubDataDir(
-      path.join(pathToFolder(url, this.options))
+      join(pathToFolder(url, this.options))
     );
     await this._stopVideo(url);
 
@@ -378,13 +375,10 @@ class Measure {
       !this.options.videoParams.debug &&
       this.video.getRecordingStartTime()
     ) {
-      this.result[this.numberOfMeasuredPages].recordingStartTime = parseFloat(
-        this.video.getRecordingStartTime()
-      );
-      this.result[this.numberOfMeasuredPages].timeToFirstFrame = parseInt(
-        this.video.getTimeToFirstFrame(),
-        10
-      );
+      this.result[this.numberOfMeasuredPages].recordingStartTime =
+        Number.parseFloat(this.video.getRecordingStartTime());
+      this.result[this.numberOfMeasuredPages].timeToFirstFrame =
+        Number.parseInt(this.video.getTimeToFirstFrame(), 10);
     }
 
     if (this.options.screenshot) {
@@ -397,7 +391,7 @@ class Measure {
           url,
           this.index
         );
-      } catch (e) {
+      } catch {
         // not getting screenshots shouldn't result in a failed test.
       }
     }
@@ -465,8 +459,8 @@ class Measure {
           this.index
         );
         await this.browser.runScript(lcpScriptClean, 'CLEAN_LCP');
-      } catch (e) {
-        log.error('Could not get LCP screenshot', e);
+      } catch (error) {
+        log.error('Could not get LCP screenshot', error);
       }
     }
 
@@ -529,4 +523,4 @@ class Measure {
   }
 }
 
-module.exports = Measure;
+export default Measure;

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

@@ -1,6 +1,4 @@
-'use strict';
-
-class Meta {
+export default class Meta {
   constructor() {}
 
   setDescription(text) {
@@ -10,4 +8,3 @@ class Meta {
     this.title = text;
   }
 }
-module.exports = Meta;