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

package/src/browsers/chromium.playwright.ts

@@ -43,8 +43,8 @@ export class ChromiumPlaywright extends EventEmitter {
     this.removeAllListeners();
   }
 
-  public keepAlive() {
-    return false;
+  public keepUntil() {
+    return 0;
   }
 
   public isRunning = (): boolean => this.running;
@@ -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

@@ -42,8 +42,8 @@ export class FirefoxPlaywright extends EventEmitter {
     this.removeAllListeners();
   }
 
-  public keepAlive() {
-    return false;
+  public keepUntil() {
+    return 0;
   }
 
   public isRunning = (): boolean => this.running;
@@ -84,18 +84,21 @@ 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({
+    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';
@@ -36,7 +37,7 @@ import path from 'path';
 
 export class BrowserManager {
   protected browsers: Map<BrowserInstance, BrowserlessSession> = new Map();
-  protected timers: Map<string, number> = new Map();
+  protected timers: Map<string, NodeJS.Timeout> = new Map();
   protected log = new Logger('browser-manager');
   protected chromeBrowsers = [ChromiumCDP, ChromeCDP];
   protected playwrightBrowserNames = [
@@ -225,7 +226,7 @@ export class BrowserManager {
       {
         ...session,
         browser: browser.constructor.name,
-        browserId: browser.wsEndpoint()?.split('/').pop() as string,
+        browserId: session.id,
         initialConnectURL: new URL(session.initialConnectURL, serverAddress)
           .href,
         killURL: session.id
@@ -267,26 +268,54 @@ export class BrowserManager {
     browser: BrowserInstance,
     session: BrowserlessSession,
   ): Promise<void> => {
+    const now = Date.now();
+    const keepUntil = browser.keepUntil();
+    const connected = session.numbConnected;
+    const hasKeepUntil = keepUntil > now;
+    const keepOpen = connected > 0 || hasKeepUntil;
     const cleanupACtions: Array<() => Promise<void>> = [];
-    this.log.info(`${session.numbConnected} Client(s) are currently connected`);
+    const priorTimer = this.timers.get(session.id);
 
-    // Don't close if there's clients still connected
-    if (session.numbConnected > 0 || browser.keepAlive()) {
-      return;
+    if (priorTimer) {
+      this.log.info(`Deleting prior keep-until timer for "${session.id}"`);
+      global.clearTimeout(priorTimer);
     }
 
-    this.log.info(`Closing browser session`);
-    cleanupACtions.push(() => browser.close());
+    this.log.info(
+      `${session.numbConnected} Client(s) are currently connected, Keep-until: ${keepUntil}`,
+    );
 
-    if (session.isTempDataDir) {
-      this.log.info(
-        `Deleting "${session.userDataDir}" user-data-dir and session from memory`,
+    if (hasKeepUntil) {
+      const timeout = keepUntil - now;
+      this.log.trace(
+        `Setting timer ${timeout.toLocaleString()} for "${session.id}"`,
+      );
+      this.timers.set(
+        session.id,
+        global.setTimeout(() => {
+          const session = this.browsers.get(browser);
+          if (session) {
+            this.log.trace(`Timer hit for "${session.id}"`),
+              this.close(browser, session);
+          }
+        }, timeout),
       );
-      this.browsers.delete(browser);
-      cleanupACtions.push(() => this.removeUserDataDir(session.userDataDir));
     }
 
-    await Promise.all(cleanupACtions.map((a) => a()));
+    if (!keepOpen) {
+      this.log.info(`Closing browser session`);
+      cleanupACtions.push(() => browser.close());
+
+      if (session.isTempDataDir) {
+        this.log.info(
+          `Deleting "${session.userDataDir}" user-data-dir and session from memory`,
+        );
+        this.browsers.delete(browser);
+        cleanupACtions.push(() => this.removeUserDataDir(session.userDataDir));
+      }
+
+      await Promise.all(cleanupACtions.map((a) => a()));
+    }
   };
 
   public getAllSessions = async (): Promise<BrowserlessSessionJSON[]> => {
@@ -436,6 +465,9 @@ export class BrowserManager {
       arg.includes('--proxy-server='),
     );
 
+    /**
+     * If it is a playwright request
+     */
     if (
       launchOptions.args &&
       proxyServerArg &&
@@ -455,8 +487,14 @@ export class BrowserManager {
       userDataDir,
     });
 
+    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 });
+
     const session: BrowserlessSession = {
-      id: null,
+      id: browser.wsEndpoint()?.split('/').pop() as string,
       initialConnectURL:
         path.join(req.parsed.pathname, req.parsed.search) || '',
       isTempDataDir: !manualUserDataDir,
@@ -471,9 +509,6 @@ export class BrowserManager {
 
     this.browsers.set(browser, session);
 
-    await browser.launch(launchOptions as object);
-    await this.hooks.browser({ browser, meta: req.parsed });
-
     browser.on('newPage', async (page) => {
       await this.onNewPage(req, page);
       (router.onNewPage || noop)(req.parsed || '', page);

package/src/browsers/webkit.playwright.ts

@@ -42,8 +42,8 @@ export class WebkitPlaywright extends EventEmitter {
     this.removeAllListeners();
   }
 
-  public keepAlive() {
-    return false;
+  public keepUntil() {
+    return 0;
   }
 
   public isRunning = (): boolean => this.running;
@@ -84,18 +84,22 @@ 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 || []),
         this.userDataDir ? `-profile=${this.userDataDir}` : '',
       ],
       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,31 @@ 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,31 @@ 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');

package/src/types.ts

@@ -377,7 +377,7 @@ export interface BrowserServerOptions {
 }
 
 export interface BrowserlessSession {
-  id: string | null;
+  id: string;
   initialConnectURL: string;
   isTempDataDir: boolean;
   launchOptions: CDPLaunchOptions | BrowserServerOptions;

package/src/utils.ts

@@ -48,6 +48,15 @@ const getAuthHeaderToken = (header: string) => {
   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: string = path.join(path.resolve(), 'build');
 export const tsExtension = '.d.ts';
 export const jsonExtension = '.json';

package/static/docs/swagger.json

@@ -225,14 +225,14 @@
                 "length": {
                   "type": "number"
                 },
-                "__@toStringTag@10952": {
+                "__@toStringTag@11009": {
                   "type": "string",
                   "const": "Uint8Array"
                 }
               },
               "required": [
                 "BYTES_PER_ELEMENT",
-                "__@toStringTag@10952",
+                "__@toStringTag@11009",
                 "buffer",
                 "byteLength",
                 "byteOffset",
@@ -267,13 +267,13 @@
         "byteLength": {
           "type": "number"
         },
-        "__@toStringTag@10952": {
+        "__@toStringTag@11009": {
           "type": "string"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@toStringTag@10952",
+        "__@toStringTag@11009",
         "byteLength"
       ]
     },
@@ -283,18 +283,18 @@
         "byteLength": {
           "type": "number"
         },
-        "__@species@11053": {
+        "__@species@11110": {
           "$ref": "#/definitions/SharedArrayBuffer"
         },
-        "__@toStringTag@10952": {
+        "__@toStringTag@11009": {
           "type": "string",
           "const": "SharedArrayBuffer"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@species@11053",
-        "__@toStringTag@10952",
+        "__@species@11110",
+        "__@toStringTag@11009",
         "byteLength"
       ]
     },
@@ -1098,7 +1098,7 @@
   },
   "info": {
     "title": "Browserless",
-    "version": "2.12.0-beta-2",
+    "version": "2.12.0-beta-4",
     "x-logo": {
       "altText": "browserless logo",
       "url": "./docs/browserless-logo-inline.svg"

package/static/docs/swagger.min.json

@@ -225,14 +225,14 @@
                 "length": {
                   "type": "number"
                 },
-                "__@toStringTag@10952": {
+                "__@toStringTag@11009": {
                   "type": "string",
                   "const": "Uint8Array"
                 }
               },
               "required": [
                 "BYTES_PER_ELEMENT",
-                "__@toStringTag@10952",
+                "__@toStringTag@11009",
                 "buffer",
                 "byteLength",
                 "byteOffset",
@@ -267,13 +267,13 @@
         "byteLength": {
           "type": "number"
         },
-        "__@toStringTag@10952": {
+        "__@toStringTag@11009": {
           "type": "string"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@toStringTag@10952",
+        "__@toStringTag@11009",
         "byteLength"
       ]
     },
@@ -283,18 +283,18 @@
         "byteLength": {
           "type": "number"
         },
-        "__@species@11053": {
+        "__@species@11110": {
           "$ref": "#/definitions/SharedArrayBuffer"
         },
-        "__@toStringTag@10952": {
+        "__@toStringTag@11009": {
           "type": "string",
           "const": "SharedArrayBuffer"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@species@11053",
-        "__@toStringTag@10952",
+        "__@species@11110",
+        "__@toStringTag@11009",
         "byteLength"
       ]
     },
@@ -1098,7 +1098,7 @@
   },
   "info": {
     "title": "Browserless",
-    "version": "2.12.0-beta-2",
+    "version": "2.12.0-beta-4",
     "x-logo": {
       "altText": "browserless logo",
       "url": "./docs/browserless-logo-inline.svg"