browsertime 16.16.0 → 17.0.0-beta.0

package/lib/core/engine/iteration.js

@@ -1,46 +1,51 @@
-'use strict';
-const os = require('os');
-const webdriver = require('selenium-webdriver');
-const log = require('intel').getLogger('browsertime');
-const SeleniumRunner = require('../seleniumRunner');
-const preURL = require('../../support/preURL');
-const setResourceTimingBufferSize = require('../../support/setResourceTimingBufferSize');
-const ScreenshotManager = require('../../screenshot/');
-const ExtensionServer = require('../../extensionserver/');
-const engineUtils = require('../../support/engineUtils');
-const Video = require('../../video/video');
-const stop = require('../../support/stop');
-const AddText = require('./command/addText.js');
-const Click = require('./command/click.js');
-const Wait = require('./command/wait.js');
-const Measure = require('./command/measure.js');
-const JavaScript = require('./command/javaScript.js');
-const Switch = require('./command/switch.js');
-const Screenshot = require('./command/screenshot.js');
-const Set = require('./command/set.js');
-const Cache = require('./command/cache.js');
-const Meta = require('./command/meta.js');
-const StopWatch = require('./command/stopWatch.js');
-const Select = require('./command/select.js');
-const Debug = require('./command/debug.js');
-const AndroidCommand = require('./command/android.js');
-const ChromeDevToolsProtocol = require('./command/chromeDevToolsProtocol.js');
-const { addConnectivity, removeConnectivity } = require('../../connectivity');
-const util = require('../../support/util.js');
-const flushDNS = require('../../support/dns.js');
-const {
+import { platform } from 'node:os';
+import webdriver from 'selenium-webdriver';
+import intel from 'intel';
+
+import SeleniumRunner from '../seleniumRunner.js';
+import preURL from '../../support/preURL.js';
+import setResourceTimingBufferSize from '../../support/setResourceTimingBufferSize.js';
+import ScreenshotManager from '../../screenshot/index.js';
+import ExtensionServer from '../../extensionserver/index.js';
+import {
+  loadPrePostScriptsSync,
+  loadScriptSync
+} from '../../support/engineUtils.js';
+import Video from '../../video/video.js';
+import stop from '../../support/stop.js';
+import AddText from './command/addText.js';
+import Click from './command/click.js';
+import Wait from './command/wait.js';
+import Measure from './command/measure.js';
+import JavaScript from './command/javaScript.js';
+import Switch from './command/switch.js';
+import Screenshot from './command/screenshot.js';
+import Set from './command/set.js';
+import Cache from './command/cache.js';
+import Meta from './command/meta.js';
+import StopWatch from './command/stopWatch.js';
+import Select from './command/select.js';
+import Debug from './command/debug.js';
+import AndroidCommand from './command/android.js';
+import ChromeDevelopmentToolsProtocol from './command/chromeDevToolsProtocol.js';
+import {
+  addConnectivity,
+  removeConnectivity
+} from '../../connectivity/index.js';
+import { jsonifyVisualProgress } from '../../support/util.js';
+import flushDNS from '../../support/dns.js';
+import {
   SingleClick,
   DoubleClick,
   ClickAndHold,
   ContextClick,
   MouseMove
-} = require('./command/mouse/');
-const getNumberOfRunningProcesses = require('../../support/processes');
-
-const { isAndroidConfigured, Android } = require('../../android');
-const Scroll = require('./command/scroll');
-const Navigation = require('./command/navigation');
-
+} from './command/mouse/index.js';
+import getNumberOfRunningProcesses from '../../support/processes.js';
+import { isAndroidConfigured, Android } from '../../android/index.js';
+import Scroll from './command/scroll.js';
+import Navigation from './command/navigation.js';
+const log = intel.getLogger('browsertime');
 const delay = ms => new Promise(res => setTimeout(res, ms));
 
 // Make this configurable
@@ -50,7 +55,7 @@ const ANDROID_DELAY_TIME = 2000;
  * Browsertime will do through one iteration of testing a URL.
  * @class
  */
-class Iteration {
+export default class Iteration {
   constructor(
     storageManager,
     engineDelegate,
@@ -59,17 +64,15 @@ class Iteration {
     options
   ) {
     try {
-      this.preScripts = engineUtils.loadPrePostScripts(options.preScript);
-      this.postScripts = engineUtils.loadPrePostScripts(options.postScript);
-      this.postURLScripts = engineUtils.loadPrePostScripts(
-        options.postURLScript
-      );
-      this.pageCompleteCheck = engineUtils.loadScript(
-        options.pageCompleteCheck
-      );
-    } catch (e) {
-      log.error(e.message);
-      throw e;
+      this.preScripts = loadPrePostScriptsSync(options.preScript);
+      this.postScripts = loadPrePostScriptsSync(options.postScript);
+      this.postURLScripts = loadPrePostScriptsSync(options.postURLScript);
+      this.pageCompleteCheck = options.pageCompleteCheck
+        ? loadScriptSync(options.pageCompleteCheck)
+        : undefined;
+    } catch (error) {
+      log.error(error.message);
+      throw error;
     }
     this.options = options;
     this.storageManager = storageManager;
@@ -85,8 +88,8 @@ class Iteration {
    * @param {*} index - Which iteration it is
    */
   async run(navigationScript, index) {
-    if (os.platform() === 'darwin' || os.platform() === 'linux') {
-      this.processesAtStart = new Number(await getNumberOfRunningProcesses());
+    if (platform() === 'darwin' || platform() === 'linux') {
+      this.processesAtStart = Number(await getNumberOfRunningProcesses());
     }
     const screenshotManager = new ScreenshotManager(
       this.storageManager,
@@ -151,7 +154,10 @@ class Iteration {
         options
       );
 
-      const cdp = new ChromeDevToolsProtocol(engineDelegate, options.browser);
+      const cdp = new ChromeDevelopmentToolsProtocol(
+        engineDelegate,
+        options.browser
+      );
       const android = new Android(options);
       const debug = new Debug(browser, options);
       const commands = {
@@ -225,10 +231,10 @@ class Iteration {
 
       try {
         await navigationScript(context, commands, this.postURLScripts);
-      } catch (e) {
-        commands.error(e.message);
-        commands.markAsFailure(e.message);
-        throw e;
+      } catch (error) {
+        commands.error(error.message);
+        commands.markAsFailure(error.message);
+        throw error;
       }
       if (commands.measure.areWeMeasuring === true) {
         // someone forgot to call stop();
@@ -259,7 +265,17 @@ class Iteration {
       if (options.browser === 'firefox' && options.debug) {
         log.info('Firefox is kept open in debug mode');
       } else {
-        await browser.stop();
+        if (isAndroidConfigured(options) && options.ignoreShutdownFailures) {
+          try {
+            log.info('Ignoring shutdown failures on android...');
+            await browser.stop();
+          } catch {
+            // Ignore shutdown failures on android
+            log.info('Shutdown problem hit, ignoring...');
+          }
+        } else {
+          await browser.stop();
+        }
       }
       // Give the browsers some time to stop
       await delay(2000);
@@ -271,12 +287,12 @@ class Iteration {
       }
 
       if (options.visualMetrics && !options.videoParams.debug) {
-        let i = 0;
+        let index_ = 0;
         for (let myVideo of videos) {
           try {
             const videoMetrics = await myVideo.postProcessing(
-              result[i].browserScripts.timings.pageTimings,
-              result[i].browserScripts.pageinfo.visualElements
+              result[index_].browserScripts.timings.pageTimings,
+              result[index_].browserScripts.pageinfo.visualElements
             );
 
             for (let progress of [
@@ -285,20 +301,20 @@ class Iteration {
               'PerceptualSpeedIndexProgress'
             ]) {
               if (videoMetrics.visualMetrics[progress]) {
-                videoMetrics.visualMetrics[progress] =
-                  util.jsonifyVisualProgress(
-                    videoMetrics.visualMetrics[progress]
-                  );
+                videoMetrics.visualMetrics[progress] = jsonifyVisualProgress(
+                  videoMetrics.visualMetrics[progress]
+                );
               }
             }
-            result[i].videoRecordingStart = videoMetrics.videoRecordingStart;
-            result[i].visualMetrics = videoMetrics.visualMetrics;
-            i++;
-          } catch (e) {
+            result[index_].videoRecordingStart =
+              videoMetrics.videoRecordingStart;
+            result[index_].visualMetrics = videoMetrics.visualMetrics;
+            index_++;
+          } catch (error) {
             // If one of the Visual Metrics runs fail, try the next one
-            log.error('Visual Metrics failed to analyse the video', e);
-            if (result[i]) {
-              result[i].error.push(e.message);
+            log.error('Visual Metrics failed to analyse the video', error);
+            if (result[index_]) {
+              result[index_].error.push(error.message);
             }
           }
         }
@@ -323,8 +339,8 @@ class Iteration {
 
       result.processesAtStart = this.processesAtStart;
       return result;
-    } catch (e) {
-      log.error(e);
+    } catch (error) {
+      log.error(error);
       if (recordVideo && options.videoParams.debug) {
         // Just use the first URL
         const url =
@@ -336,9 +352,9 @@ class Iteration {
       if (options.docker && recordVideo && !isAndroidConfigured(options)) {
         await stop('ffmpeg');
       }
-      result.error = [e.name];
+      result.error = [error.name];
       result.markedAsFailure = 1;
-      result.failureMessages = [e.message];
+      result.failureMessages = [error.message];
       return result;
     } finally {
       // Here we should also make sure FFMPEG is really killed/stopped
@@ -352,11 +368,9 @@ class Iteration {
         } else {
           await browser.stop();
         }
-      } catch (e) {
+      } catch {
         // Most cases the browser been stopped already
       }
     }
   }
 }
-
-module.exports = Iteration;

package/lib/core/engine/run.js

@@ -1,13 +1,9 @@
-'use strict';
-
-module.exports = function (urlOrFunctions) {
+export default function (urlOrFunctions) {
   return async function (context, commands) {
     for (let urlOrFunction of urlOrFunctions) {
-      if (typeof urlOrFunction === 'function') {
-        await urlOrFunction(context, commands);
-      } else {
-        await commands.measure.start(urlOrFunction);
-      }
+      await (typeof urlOrFunction === 'function'
+        ? urlOrFunction(context, commands)
+        : commands.measure.start(urlOrFunction));
     }
   };
-};
+}

package/lib/core/pageCompleteChecks/defaultPageCompleteCheck.js

@@ -1,5 +1,4 @@
-'use strict';
-module.exports = `
+export default `
 return (function(waitTime) {
     try { 
             var end = window.performance.timing.loadEventEnd;

package/lib/core/pageCompleteChecks/pageCompleteCheckByInactivity.js

@@ -1,6 +1,4 @@
-'use strict';
-
-module.exports = `
+export default `
 return (function(waitTime) {
   const timing = window.performance.timing;
   const p = window.performance;

package/lib/core/pageCompleteChecks/spaInactivity.js

@@ -1,6 +1,4 @@
-'use strict';
-
-module.exports = `
+export default `
 return (function(waitTime) {
   const timing = window.performance.timing;
   const p = window.performance;