browsertime 22.3.0 → 22.4.1

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Browsertime changelog (we do [semantic versioning](https://semver.org))
 
+## 22.3.1 - 2024-06-07
+### Fixed
+* Make sure the engine is stopped before the extra video/profile run [#2140](https://github.com/sitespeedio/browsertime/pull/2140).
+
+## 22.3.0 - 2024-06-06
+### Added
+* Use `--enableVideoRun` to get one extra run with a video and visual metrics [#2139](https://github.com/sitespeedio/browsertime/pull/2139)
+
 ## 22.3.0 - 2024-06-04
 ### Added
 * Add the ability to gather power usage measurements on Android from USB power meters, thank you [Gregory Mierzwinski](https://github.com/gmierz) for PR [#2134](https://github.com/sitespeedio/browsertime/pull/2134).

package/bin/browsertime.js

@@ -123,27 +123,6 @@ async function run(urls, options) {
         );
       }
 
-      if (options.enableProfileRun) {
-        log.info('Make one extra run to collect trace information');
-        options.iterations = 1;
-        if (options.browser === 'firefox') {
-          options.firefox.geckoProfiler = true;
-        } else if (options.browser === 'chrome') {
-          options.chrome.timeline = true;
-          options.cpu = true;
-          options.chrome.enableTraceScreenshots = true;
-          options.chrome.traceCategory = [
-            'disabled-by-default-v8.cpu_profiler'
-          ];
-        }
-        options.video = false;
-        options.visualMetrics = false;
-        const traceEngine = new Engine(options);
-        await traceEngine.start();
-        await traceEngine.runMultiple(urls, scriptsByCategory);
-        await traceEngine.stop();
-      }
-
       await Promise.all(saveOperations);
 
       const resultDirectory = relative(process.cwd(), storageManager.directory);
@@ -173,6 +152,41 @@ async function run(urls, options) {
         process.exitCode = 1;
       }
     }
+
+    if (options.enableProfileRun || options.enableVideoRun) {
+      log.info('Make one extra run to collect trace/video information');
+      options.iterations = 1;
+      if (options.enableProfileRun) {
+        if (options.browser === 'firefox') {
+          options.firefox.geckoProfiler = true;
+        } else if (options.browser === 'chrome') {
+          options.chrome.timeline = true;
+          options.cpu = true;
+          options.chrome.enableTraceScreenshots = true;
+          options.chrome.traceCategory = [
+            'disabled-by-default-v8.cpu_profiler'
+          ];
+        }
+      }
+      if (options.enableVideoRun) {
+        if (options.video === true) {
+          log.error(
+            'You can only configure video run if you do not collect any video'
+          );
+          // This is a hack to not get an error
+          options.video = false;
+          options.visualMetrics = false;
+        } else {
+          options.video = true;
+          options.visualMetrics = true;
+        }
+      }
+      const traceEngine = new Engine(options);
+      await traceEngine.start();
+      await traceEngine.runMultiple(urls, scriptsByCategory);
+      await traceEngine.stop();
+      log.info('Extra run finished');
+    }
   } catch (error) {
     log.error('Error running browsertime', error);
     process.exitCode = 1;

package/lib/support/cli.js

@@ -614,6 +614,11 @@ export function parseCommandLine() {
       describe:
         'Make one extra run that collects the profiling trace log (no other metrics is collected). For Chrome it will collect the timeline trace, for Firefox it will get the Geckoprofiler trace. This means you do not need to get the trace for all runs and can skip the overhead it produces.'
     })
+    .option('enableVideoRun', {
+      type: 'boolean',
+      describe:
+        'Make one extra run that collects video and visual metrics. This means you can do your runs with --visualMetrics true --video false --enableVideoRun true to collect visual metrics from all runs and save a video from the profile/video run. If you run it together with --enableProfileRun it will also collect profiling trace.'
+    })
     .option('video', {
       type: 'boolean',
       describe:

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "browsertime",
   "description": "Get performance metrics from your web page using Browsertime.",
-  "version": "22.3.0",
+  "version": "22.4.1",
   "bin": "./bin/browsertime.js",
   "type": "module",
   "types": "./types/scripting.d.ts",