@browserless.io/browserless 2.12.0-beta-2 → 2.12.0-beta-3

package/build/routes/chromium/http/scrape.post.body.json

@@ -441,14 +441,14 @@
                 "length": {
                   "type": "number"
                 },
-                "__@toStringTag@240522": {
+                "__@toStringTag@219427": {
                   "type": "string",
                   "const": "Uint8Array"
                 }
               },
               "required": [
                 "BYTES_PER_ELEMENT",
-                "__@toStringTag@240522",
+                "__@toStringTag@219427",
                 "buffer",
                 "byteLength",
                 "byteOffset",
@@ -483,13 +483,13 @@
         "byteLength": {
           "type": "number"
         },
-        "__@toStringTag@240522": {
+        "__@toStringTag@219427": {
           "type": "string"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@toStringTag@240522",
+        "__@toStringTag@219427",
         "byteLength"
       ]
     },
@@ -499,18 +499,18 @@
         "byteLength": {
           "type": "number"
         },
-        "__@species@240623": {
+        "__@species@219528": {
           "$ref": "#/definitions/SharedArrayBuffer"
         },
-        "__@toStringTag@240522": {
+        "__@toStringTag@219427": {
           "type": "string",
           "const": "SharedArrayBuffer"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@species@240623",
-        "__@toStringTag@240522",
+        "__@species@219528",
+        "__@toStringTag@219427",
         "byteLength"
       ]
     },

package/build/routes/chromium/http/screenshot.post.body.json

@@ -484,14 +484,14 @@
                 "length": {
                   "type": "number"
                 },
-                "__@toStringTag@229416": {
+                "__@toStringTag@241842": {
                   "type": "string",
                   "const": "Uint8Array"
                 }
               },
               "required": [
                 "BYTES_PER_ELEMENT",
-                "__@toStringTag@229416",
+                "__@toStringTag@241842",
                 "buffer",
                 "byteLength",
                 "byteOffset",
@@ -526,13 +526,13 @@
         "byteLength": {
           "type": "number"
         },
-        "__@toStringTag@229416": {
+        "__@toStringTag@241842": {
           "type": "string"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@toStringTag@229416",
+        "__@toStringTag@241842",
         "byteLength"
       ]
     },
@@ -542,18 +542,18 @@
         "byteLength": {
           "type": "number"
         },
-        "__@species@229517": {
+        "__@species@241943": {
           "$ref": "#/definitions/SharedArrayBuffer"
         },
-        "__@toStringTag@229416": {
+        "__@toStringTag@241842": {
           "type": "string",
           "const": "SharedArrayBuffer"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@species@229517",
-        "__@toStringTag@229416",
+        "__@species@241943",
+        "__@toStringTag@241842",
         "byteLength"
       ]
     },

package/build/routes/chromium/tests/websocket.spec.js

@@ -345,6 +345,24 @@ describe('Chromium WebSocket API', function () {
         expect(results.rejected).to.equal(0);
         expect(results.queued).to.equal(0);
     });
+    it('runs multiple versions of playwright', async () => {
+        const config = new Config();
+        config.setToken('browserless');
+        const metrics = new Metrics();
+        await start({ config, metrics });
+        const pwVersions = Object.keys(config.getPwVersions());
+        for (const version of pwVersions) {
+            const pw = await import(config.getPwVersions()[version]);
+            const browser = await pw.chromium.connect(`ws://localhost:3000/playwright/chromium?token=browserless`);
+            await browser.close();
+            await sleep(100);
+        }
+        const results = metrics.get();
+        expect(results.timedout).to.equal(0);
+        expect(results.successful).to.equal(pwVersions.length);
+        expect(results.rejected).to.equal(0);
+        expect(results.queued).to.equal(0);
+    });
     it('rejects playwright without tokens', async () => {
         const config = new Config();
         config.setToken('browserless');

package/build/routes/firefox/tests/websocket.spec.js

@@ -4,7 +4,6 @@ import { firefox } from 'playwright-core';
 describe('Firefox Websocket API', function () {
     // Server shutdown can take a few seconds
     // and so can these tests :/
-    this.timeout(5000);
     let browserless;
     const start = ({ config = new Config(), metrics = new Metrics(), } = {}) => {
         browserless = new Browserless({ config, metrics });
@@ -21,6 +20,24 @@ describe('Firefox Websocket API', function () {
         const browser = await firefox.connect(`ws://localhost:3000/playwright/firefox?token=browserless`);
         await browser.close();
     });
+    it('runs multiple versions of playwright', async () => {
+        const config = new Config();
+        config.setToken('browserless');
+        const metrics = new Metrics();
+        await start({ config, metrics });
+        const pwVersions = Object.keys(config.getPwVersions());
+        for (const version of pwVersions) {
+            const pw = await import(config.getPwVersions()[version]);
+            const browser = await pw.firefox.connect(`ws://localhost:3000/playwright/firefox?token=browserless`);
+            await browser.close();
+            await sleep(100);
+        }
+        const results = metrics.get();
+        expect(results.timedout).to.equal(0);
+        expect(results.successful).to.equal(pwVersions.length);
+        expect(results.rejected).to.equal(0);
+        expect(results.queued).to.equal(0);
+    });
     it('rejects playwright requests', async () => {
         const config = new Config();
         config.setToken('browserless');

package/build/routes/webkit/tests/websocket.spec.js

@@ -21,6 +21,24 @@ describe('Webkit Websocket API', function () {
         const browser = await webkit.connect(`ws://localhost:3000/playwright/webkit?token=browserless`);
         await browser.close();
     });
+    it('runs multiple versions of playwright', async () => {
+        const config = new Config();
+        config.setToken('browserless');
+        const metrics = new Metrics();
+        await start({ config, metrics });
+        const pwVersions = Object.keys(config.getPwVersions());
+        for (const version of pwVersions) {
+            const pw = await import(config.getPwVersions()[version]);
+            const browser = await pw.webkit.connect(`ws://localhost:3000/playwright/webkit?token=browserless`);
+            await browser.close();
+            await sleep(100);
+        }
+        const results = metrics.get();
+        expect(results.timedout).to.equal(0);
+        expect(results.successful).to.equal(pwVersions.length);
+        expect(results.rejected).to.equal(0);
+        expect(results.queued).to.equal(0);
+    });
     it('rejects playwright requests', async () => {
         const config = new Config();
         config.setToken('browserless');

package/build/utils.d.ts

@@ -7,6 +7,15 @@ import { Duplex } from 'stream';
 import { Page } from 'puppeteer-core';
 import { ServerResponse } from 'http';
 import debug from 'debug';
+/**
+ * RegEx to match the Playwright version from the innitial request header.
+ *
+ * @example
+ * const userAgent = "Playwright/1.43.1 (x64; windows 10.0) node/20.11";
+ * userAgent.match(pwVersionRegex);
+ * // ["Playwright/1.43", "1.43"]
+ */
+export declare const pwVersionRegex: RegExp;
 export declare const buildDir: string;
 export declare const tsExtension = ".d.ts";
 export declare const jsonExtension = ".json";

package/build/utils.js

@@ -21,6 +21,15 @@ const getAuthHeaderToken = (header) => {
     }
     return null;
 };
+/**
+ * RegEx to match the Playwright version from the innitial request header.
+ *
+ * @example
+ * const userAgent = "Playwright/1.43.1 (x64; windows 10.0) node/20.11";
+ * userAgent.match(pwVersionRegex);
+ * // ["Playwright/1.43", "1.43"]
+ */
+export const pwVersionRegex = /Playwright\/(\d+\.\d+)/;
 export const buildDir = path.join(path.resolve(), 'build');
 export const tsExtension = '.d.ts';
 export const jsonExtension = '.json';

package/docker/chromium/Dockerfile

@@ -26,7 +26,8 @@ RUN echo "ttf-mscorefonts-installer msttcorefonts/accepted-mscorefonts-eula sele
     fonts-ubuntu \
     fonts-wqy-zenhei
 
-RUN ./node_modules/.bin/playwright-core install --with-deps chromium &&\
+RUN npx --yes playwright install chromium &&\
+  npx --yes playwright install-deps chromium &&\
   npm run build &&\
   npm run build:function &&\
   npm prune production &&\

package/docker/firefox/Dockerfile

@@ -26,7 +26,8 @@ RUN echo "ttf-mscorefonts-installer msttcorefonts/accepted-mscorefonts-eula sele
     fonts-ubuntu \
     fonts-wqy-zenhei
 
-RUN ./node_modules/.bin/playwright-core install --with-deps firefox &&\
+RUN npx --yes playwright install firefox &&\
+  npx --yes playwright install-deps firefox &&\
   npm run build &&\
   npm prune production &&\
   chown -R blessuser:blessuser $APP_DIR &&\

package/docker/multi/Dockerfile

@@ -34,7 +34,7 @@ RUN if [ "$TARGETPLATFORM" = "linux/amd64" ]; then \
     rm -rf ./src/routes/chrome; \
   fi
 
-RUN ./node_modules/.bin/playwright-core install --with-deps chromium firefox webkit &&\
+RUN npx --yes playwright install --with-deps chromium firefox webkit &&\
   npm run build &&\
   npm run build:function &&\
   npm prune production &&\

package/docker/webkit/Dockerfile

@@ -27,7 +27,8 @@ RUN echo "ttf-mscorefonts-installer msttcorefonts/accepted-mscorefonts-eula sele
     fonts-ubuntu \
     fonts-wqy-zenhei
 
-RUN ./node_modules/.bin/playwright-core install --with-deps webkit &&\
+RUN npx --yes playwright install webkit &&\
+  npx --yes playwright install-deps webkit &&\
   npm run build &&\
   npm prune production &&\
   chown -R blessuser:blessuser $APP_DIR &&\

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@browserless.io/browserless",
-  "version": "2.12.0-beta-2",
+  "version": "2.12.0-beta-3",
   "license": "SSPL",
   "description": "The browserless platform",
   "author": "browserless.io",
@@ -58,8 +58,12 @@
     "http-proxy": "^1.18.1",
     "lighthouse": "^12.0.0",
     "micromatch": "^4.0.4",
-    "playwright-core": "^1.43.0",
-    "puppeteer-core": "^22.8.1",
+    "playwright-1.40": "npm:playwright-core@1.40.1",
+    "playwright-1.41": "npm:playwright-core@1.41.2",
+    "playwright-1.42": "npm:playwright-core@1.42.1",
+    "playwright-1.43": "npm:playwright-core@1.43.1",
+    "playwright-core": "^1.44.0",
+    "puppeteer-core": "^22.9.0",
     "puppeteer-extra": "^3.3.6",
     "puppeteer-extra-plugin-stealth": "^2.11.2",
     "queue": "^7.0.0",
@@ -81,7 +85,7 @@
     "chai": "^5.1.1",
     "cross-env": "^7.0.3",
     "env-cmd": "^10.1.0",
-    "esbuild": "^0.21.2",
+    "esbuild": "^0.21.3",
     "esbuild-plugin-polyfill-node": "^0.3.0",
     "eslint": "^8.57.0",
     "eslint-plugin-typescript-sort-keys": "^3.2.0",
@@ -91,11 +95,19 @@
     "mocha": "^10.4.0",
     "move-file": "^3.1.0",
     "prettier": "^3.2.5",
-    "sinon": "^17.0.2",
+    "sinon": "^18.0.0",
     "ts-node": "^10.9.2",
     "typescript": "^5.4.5",
     "typescript-json-schema": "^0.63.0"
   },
+  "playwrightVersions": {
+    "default": "playwright-core",
+    "1.44": "playwright-core",
+    "1.43": "playwright-1.43",
+    "1.42": "playwright-1.42",
+    "1.41": "playwright-1.41",
+    "1.40": "playwright-1.40"
+  },
   "eslintConfig": {
     "root": true,
     "parser": "@typescript-eslint/parser",

package/src/browserless.ts

@@ -1,4 +1,6 @@
+import * as fs from 'fs/promises';
 import * as path from 'path';
+
 import {
   Logger as BlessLogger,
   BrowserHTTPRoute,
@@ -117,6 +119,14 @@ export class Browserless extends EventEmitter {
       new Router(this.config, this.browserManager, this.limiter, this.Logger);
   }
 
+  protected loadPwVersions = async (): Promise<void> => {
+    const { playwrightVersions } = JSON.parse(
+      (await fs.readFile('package.json')).toString(),
+    );
+
+    this.config.setPwVersions(playwrightVersions);
+  };
+
   protected saveMetrics = async (): Promise<void> => {
     const metricsPath = this.config.getMetricsJSONPath();
     const { cpu, memory } = await this.monitoring.getMachineStats();
@@ -382,6 +392,7 @@ export class Browserless extends EventEmitter {
       this.Logger,
     );
 
+    await this.loadPwVersions();
     await this.server.start();
     this.logger.info(`Starting metrics collection.`);
     this.metricsSaveIntervalID = setInterval(

package/src/browsers/chromium.playwright.ts

@@ -89,10 +89,11 @@ export class ChromiumPlaywright extends EventEmitter {
 
   public launch = async (
     options: BrowserServerOptions = {},
+    version?: string,
   ): Promise<playwright.BrowserServer> => {
     this.logger.info(`Launching ${this.constructor.name} Handler`);
 
-    this.browser = await playwright.chromium.launchServer({
+    const opts = {
       ...options,
       args: [
         `--no-sandbox`,
@@ -100,8 +101,11 @@ export class ChromiumPlaywright extends EventEmitter {
         this.userDataDir ? `--user-data-dir=${this.userDataDir}` : '',
       ],
       executablePath: this.executablePath,
-    });
+    };
+
+    const versionedPw = await this.config.loadPwVersion(version!);
 
+    this.browser = await versionedPw.chromium.launchServer(opts);
     const browserWSEndpoint = this.browser.wsEndpoint();
 
     this.logger.info(

package/src/browsers/firefox.playwright.ts

@@ -84,18 +84,22 @@ export class FirefoxPlaywright extends EventEmitter {
 
   public launch = async (
     options: BrowserServerOptions = {},
+    version?: string,
   ): Promise<playwright.BrowserServer> => {
-    this.logger.info(`Launching ${this.constructor.name} Handler`);
 
-    this.browser = await playwright.firefox.launchServer({
+    this.logger.info(`Launching ${this.constructor.name} Handler`);
+    const opts = {
       ...options,
       args: [
         ...(options.args || []),
         this.userDataDir ? `-profile=${this.userDataDir}` : '',
       ],
       executablePath: playwright.firefox.executablePath(),
-    });
+    };
+
+    const versionedPw = await this.config.loadPwVersion(version!);
 
+    this.browser = await versionedPw.firefox.launchServer(opts);
     const browserWSEndpoint = this.browser.wsEndpoint();
 
     this.logger.info(

package/src/browsers/index.ts

@@ -29,6 +29,7 @@ import {
   makeExternalURL,
   noop,
   parseBooleanParam,
+  pwVersionRegex,
 } from '@browserless.io/browserless';
 import { Page } from 'puppeteer-core';
 import { deleteAsync } from 'del';
@@ -436,6 +437,9 @@ export class BrowserManager {
       arg.includes('--proxy-server='),
     );
 
+    /**
+     * If it is a playwright request
+     */
     if (
       launchOptions.args &&
       proxyServerArg &&
@@ -471,7 +475,10 @@ export class BrowserManager {
 
     this.browsers.set(browser, session);
 
-    await browser.launch(launchOptions as object);
+    const match = (req.headers['user-agent'] || '').match(pwVersionRegex);
+    const pwVersion = match ? match[1] : 'default';
+
+    await browser.launch(launchOptions as object, pwVersion);
     await this.hooks.browser({ browser, meta: req.parsed });
 
     browser.on('newPage', async (page) => {

package/src/browsers/webkit.playwright.ts

@@ -84,10 +84,11 @@ export class WebkitPlaywright extends EventEmitter {
 
   public launch = async (
     options: BrowserServerOptions = {},
+    version?: string,
   ): Promise<playwright.BrowserServer> => {
     this.logger.info(`Launching ${this.constructor.name} Handler`);
 
-    this.browser = await playwright.webkit.launchServer({
+    const opts = ({
       ...options,
       args: [
         ...(options.args || []),
@@ -96,6 +97,9 @@ export class WebkitPlaywright extends EventEmitter {
       executablePath: playwright.webkit.executablePath(),
     });
 
+    const versionedPw = await this.config.loadPwVersion(version!);
+
+    this.browser = await versionedPw.webkit.launchServer(opts);
     const browserWSEndpoint = this.browser.wsEndpoint();
 
     this.logger.info(

package/src/config.ts

@@ -4,6 +4,7 @@ import debug from 'debug';
 import { fileURLToPath } from 'url';
 import { mkdir } from 'fs/promises';
 import path from 'path';
+import playwright from 'playwright-core';
 import { tmpdir } from 'os';
 
 const __dirname = path.dirname(fileURLToPath(import.meta.url));
@@ -165,6 +166,7 @@ export class Config extends EventEmitter {
   protected rejectAlertURL = process.env.REJECT_ALERT_URL ?? null;
   protected timeoutAlertURL = process.env.TIMEOUT_ALERT_URL ?? null;
   protected errorAlertURL = process.env.ERROR_ALERT_URL ?? null;
+  protected pwVersions: { [key: string]: string } = {};
 
   public getRoutes = (): string => this.routes;
   public getHost = (): string => this.host;
@@ -172,6 +174,7 @@ export class Config extends EventEmitter {
   public getIsWin = (): boolean => this.isWin;
   public getToken = (): string | null => this.token;
   public getDebug = (): string => this.debug;
+  public getPwVersions = () => this.pwVersions;
 
   /**
    * The maximum number of concurrent sessions allowed. Set
@@ -261,6 +264,23 @@ export class Config extends EventEmitter {
 
   public getMetricsJSONPath = () => this.metricsJSONPath;
 
+  public setPwVersions = (versions: { [key: string]: string }) => {
+    this.pwVersions = versions;
+  };
+
+  public loadPwVersion = async (
+    version: string,
+  ): Promise<typeof playwright> => {
+    const versions = this.getPwVersions();
+
+    try {
+      return await import(versions[version] || versions['default']);
+    } catch (err) {
+      debug.log('Error importing Playwright. Using default version', err);
+      return playwright;
+    }
+  };
+
   public setDataDir = async (newDataDir: string): Promise<string> => {
     if (!(await exists(newDataDir))) {
       throw new Error(

package/src/routes/chrome/tests/websocket.spec.ts

@@ -13,10 +13,6 @@ import { expect } from 'chai';
 import puppeteer from 'puppeteer-core';
 
 describe('Chrome WebSocket API', function () {
-  // Server shutdown can take a few seconds
-  // and so can these tests :/
-  this.timeout(10000);
-
   let browserless: Browserless;
 
   const start = ({
@@ -461,6 +457,31 @@ describe('Chrome WebSocket API', function () {
     expect(results.queued).to.equal(0);
   });
 
+  it('runs multiple versions of playwright', async () => {
+    const config = new Config();
+    config.setToken('browserless');
+    const metrics = new Metrics();
+    await start({ config, metrics });
+
+    const pwVersions = Object.keys(config.getPwVersions());
+
+    for (const version of pwVersions) {
+      const pw = await import(config.getPwVersions()[version]);
+      const browser = await pw.chromium.connect(
+        `ws://localhost:3000/chrome/playwright?token=browserless`,
+      );
+  
+      await browser.close();
+      await sleep(100);  
+    }
+
+    const results = metrics.get();
+    expect(results.timedout).to.equal(0);
+    expect(results.successful).to.equal(pwVersions.length);
+    expect(results.rejected).to.equal(0);
+    expect(results.queued).to.equal(0);
+  });
+
   it('rejects playwright without tokens', async () => {
     const config = new Config();
     config.setToken('browserless');

package/src/routes/chromium/tests/websocket.spec.ts

@@ -461,6 +461,31 @@ describe('Chromium WebSocket API', function () {
     expect(results.queued).to.equal(0);
   });
 
+  it('runs multiple versions of playwright', async () => {
+    const config = new Config();
+    config.setToken('browserless');
+    const metrics = new Metrics();
+    await start({ config, metrics });
+
+    const pwVersions = Object.keys(config.getPwVersions());
+
+    for (const version of pwVersions) {
+      const pw = await import(config.getPwVersions()[version]);
+      const browser = await pw.chromium.connect(
+        `ws://localhost:3000/playwright/chromium?token=browserless`,
+      );
+  
+      await browser.close();
+      await sleep(100);  
+    }
+
+    const results = metrics.get();
+    expect(results.timedout).to.equal(0);
+    expect(results.successful).to.equal(pwVersions.length);
+    expect(results.rejected).to.equal(0);
+    expect(results.queued).to.equal(0);
+  });
+
   it('rejects playwright without tokens', async () => {
     const config = new Config();
     config.setToken('browserless');

package/src/routes/firefox/tests/websocket.spec.ts

@@ -10,7 +10,6 @@ import { firefox } from 'playwright-core';
 describe('Firefox Websocket API', function () {
   // Server shutdown can take a few seconds
   // and so can these tests :/
-  this.timeout(5000);
 
   let browserless: Browserless;
 
@@ -39,6 +38,33 @@ describe('Firefox Websocket API', function () {
     await browser.close();
   });
 
+  
+  it('runs multiple versions of playwright', async () => {
+
+    const config = new Config();
+    config.setToken('browserless');
+    const metrics = new Metrics();
+    await start({ config, metrics });
+
+    const pwVersions = Object.keys(config.getPwVersions());
+
+    for (const version of pwVersions) {
+      const pw = await import(config.getPwVersions()[version]);
+      const browser = await pw.firefox.connect(
+        `ws://localhost:3000/playwright/firefox?token=browserless`,
+      );
+  
+      await browser.close();
+      await sleep(100);  
+    }
+
+    const results = metrics.get();
+    expect(results.timedout).to.equal(0);
+    expect(results.successful).to.equal(pwVersions.length);
+    expect(results.rejected).to.equal(0);
+    expect(results.queued).to.equal(0);
+  });
+
   it('rejects playwright requests', async () => {
     const config = new Config();
     config.setToken('browserless');

package/src/routes/webkit/tests/websocket.spec.ts

@@ -39,6 +39,32 @@ describe('Webkit Websocket API', function () {
     await browser.close();
   });
 
+    
+  it('runs multiple versions of playwright', async () => {
+    const config = new Config();
+    config.setToken('browserless');
+    const metrics = new Metrics();
+    await start({ config, metrics });
+
+    const pwVersions = Object.keys(config.getPwVersions());
+
+    for (const version of pwVersions) {
+      const pw = await import(config.getPwVersions()[version]);
+      const browser = await pw.webkit.connect(
+        `ws://localhost:3000/playwright/webkit?token=browserless`,
+      );
+  
+      await browser.close();
+      await sleep(100);  
+    }
+
+    const results = metrics.get();
+    expect(results.timedout).to.equal(0);
+    expect(results.successful).to.equal(pwVersions.length);
+    expect(results.rejected).to.equal(0);
+    expect(results.queued).to.equal(0);
+  });
+
   it('rejects playwright requests', async () => {
     const config = new Config();
     config.setToken('browserless');