browsertime 22.5.4 → 22.6.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Browsertime changelog (we do [semantic versioning](https://semver.org))
 
+## 22.6.0 - 2024-07-15
+### Added
+* Updated to Firefox 128 and Edge 126 in the Docker container [#2158](https://github.com/sitespeedio/browsertime/pull/2158).
+* Add request header using Bidi for Firefox (needs Firefox 128 or later) [#2108](https://github.com/sitespeedio/browsertime/pull/2108).
+
+### Fixed
+* Updated to Chrome HAR 0.13.5 [#2157](https://github.com/sitespeedio/browsertime/pull/2157)
+
+## 22.5.5 - 2024-07-07
+### Fixed
+* Fix stopping --tcpdump [#2155](https://github.com/sitespeedio/browsertime/pull/2155).
+
 ## 22.5.4 - 2024-07-06
 ### Fixed
 * Update to Chrome-HAR 0.13.3 [#2148](https://github.com/sitespeedio/browsertime/pull/2148).

package/lib/firefox/firefoxBidi.js

@@ -78,6 +78,7 @@ export class FirefoxBidi {
       }
     });
   }
+
   async setBasicAuth(basicAuth) {
     const parts = basicAuth.split('@');
     const bidi = new Bidi(this.driver, this.options.browser);
@@ -146,4 +147,52 @@ export class FirefoxBidi {
       }
     }
   }
+
+  async setRequestHeaders(requestHeaders) {
+    const headersArray = toArray(requestHeaders);
+    const headers = [];
+    for (let header of headersArray) {
+      if (header.indexOf && header.includes(':')) {
+        const parts = header.split(':');
+        headers.push({
+          name: parts[0],
+          value: {
+            type: 'string',
+            value: parts[1]
+          }
+        });
+      } else {
+        log.error(
+          'Request headers need to be of the format key:value not ' + header
+        );
+      }
+    }
+
+    const command = {
+      method: 'network.addIntercept',
+      params: {
+        phases: ['beforeRequestSent']
+      }
+    };
+    const bidi = new Bidi(this.driver, this.options.browser);
+
+    await bidi.send(command);
+    await bidi.subscribe('network.beforeRequestSent');
+    await bidi.onMessage(async function (event) {
+      const parsedEvent = JSON.parse(Buffer.from(event.toString()));
+      if (parsedEvent.method === 'network.beforeRequestSent') {
+        const continueRequest = {
+          method: 'network.continueRequest',
+          params: {
+            request: parsedEvent.params.request.request,
+            headers: [...parsedEvent.params.request.headers, ...headers]
+          }
+        };
+        const result = await bidi.send(continueRequest);
+        if (result.type != 'success') {
+          log.error(result);
+        }
+      }
+    });
+  }
 }

package/lib/firefox/webdriver/firefox.js

@@ -102,22 +102,25 @@ export class Firefox {
       await this.browsertimeBidi.setBasicAuth(this.options.basicAuth);
     }
 
-    if (this.options.block) {
-      await this.browsertimeBidi.blockUrls(this.options.block);
-    }
+    if (this.options.requestheader) {
+      await this.browsertimeBidi.setRequestHeaders(this.options.requestheader);
+      if (this.options.block) {
+        await this.browsertimeBidi.blockUrls(this.options.block);
+      }
 
-    if (
-      this.firefoxConfig.appendToUserAgent ||
-      this.options.appendToUserAgent
-    ) {
-      const currentUserAgent = await runner.runScript(
-        'return navigator.userAgent;',
-        'GET_USER_AGENT'
-      );
-      let script = `Services.prefs.setStringPref('general.useragent.override', '${currentUserAgent} ${
-        this.firefoxConfig.appendToUserAgent || this.options.appendToUserAgent
-      }');`;
-      return runner.runPrivilegedScript(script, 'SET_USER_AGENT');
+      if (
+        this.firefoxConfig.appendToUserAgent ||
+        this.options.appendToUserAgent
+      ) {
+        const currentUserAgent = await runner.runScript(
+          'return navigator.userAgent;',
+          'GET_USER_AGENT'
+        );
+        let script = `Services.prefs.setStringPref('general.useragent.override', '${currentUserAgent} ${
+          this.firefoxConfig.appendToUserAgent || this.options.appendToUserAgent
+        }');`;
+        return runner.runPrivilegedScript(script, 'SET_USER_AGENT');
+      }
     }
   }
 

package/lib/support/tcpdump.js

@@ -32,7 +32,10 @@ export class TCPDump {
     this.tcpdumpProcess = execa('sudo', parameters);
   }
   async stop() {
-    return execa('sudo', ['pkill', '-9', 'tcpdump'], { reject: false });
+    if (this.tcpdumpProcess) {
+      await this.tcpdumpProcess.kill('SIGINT');
+      this.tcpdumpProcess = undefined;
+    }
   }
 
   async mv(url, iteration) {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "browsertime",
   "description": "Get performance metrics from your web page using Browsertime.",
-  "version": "22.5.4",
+  "version": "22.6.0",
   "bin": "./bin/browsertime.js",
   "type": "module",
   "types": "./types/scripting.d.ts",
@@ -14,7 +14,7 @@
     "@sitespeed.io/throttle": "5.0.0",
     "@sitespeed.io/tracium": "0.3.3",
     "btoa": "1.2.1",
-    "chrome-har": "0.13.3",
+    "chrome-har": "0.13.5",
     "chrome-remote-interface": "0.33.2",
     "dayjs": "1.11.11",
     "execa": "9.3.0",

package/types/support/tcpdump.d.ts

@@ -4,9 +4,7 @@ export class TCPDump {
     options: any;
     start(iteration: any): Promise<void>;
     tcpdumpProcess: import("execa").ResultPromise<{}>;
-    stop(): Promise<import("execa").Result<{
-        reject: false;
-    }>>;
+    stop(): Promise<void>;
     mv(url: any, iteration: any): Promise<void>;
 }
 //# sourceMappingURL=tcpdump.d.ts.map

package/types/support/tcpdump.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"tcpdump.d.ts","sourceRoot":"","sources":["../../lib/support/tcpdump.js"],"names":[],"mappings":"AAKA;IACE,0CAGC;IAFC,aAAwB;IACxB,aAAsB;IAExB,qCAsBC;IADC,kDAA+C;IAEjD;;QAEC;IAED,4CAQC;CACF"}
+{"version":3,"file":"tcpdump.d.ts","sourceRoot":"","sources":["../../lib/support/tcpdump.js"],"names":[],"mappings":"AAKA;IACE,0CAGC;IAFC,aAAwB;IACxB,aAAsB;IAExB,qCAsBC;IADC,kDAA+C;IAEjD,sBAKC;IAED,4CAQC;CACF"}