@browserless.io/browserless 2.24.0-beta-5 → 2.24.1

package/CHANGELOG.md

@@ -1,7 +1,28 @@
-# [Latest](https://github.com/browserless/chrome/compare/v2.23.0...main)
+# [Latest](https://github.com/browserless/chrome/compare/v2.24.1...main)
 
 - Dependency updates.
 
+# [v2.24.1](https://github.com/browserless/chrome/compare/v2.24.1...v2.24.0)
+
+- Dependency updates.
+- Fixes for /performance API in SDK projects.
+
+# [v2.24.0](https://github.com/browserless/chrome/compare/v2.24.0...v2.23.0)
+
+- Dependency updates.
+- Supports:
+  - puppeteer-core: 23.10.1.
+  - playwright-core: 1.49.0, 1.48.2, 1.47.2, 1.46.1, 1.45.3 and 1.44.1.
+  - Chromium: 131.0.6778.33.
+  - Chrome: 131.0.6778.109.
+  - Firefox: 132.0.
+  - Webkit: 18.2.
+- New `/meta` API route for getting details about the container (versions, etc).
+- Bump NodeJS to `v22.11.0`.
+- Add `libwebp-dev` for Webkit.
+- Add support for `trackingId` and `/kill/{id}` and `/kill/all`.
+- Prettier, internal fixes and improvements.
+
 # [v2.23.0](https://github.com/browserless/chrome/compare/v2.23.0...v2.22.0)
 
 - Dependency updates.

package/bin/browserless.js

@@ -367,7 +367,7 @@ const buildDocker = async () => {
   }
 };
 
-const installBrowser = async() => {
+const installBrowser = async () => {
   await installBrowsers(projectDir);
 };
 

package/build/browsers/browsers.playwright.d.ts

@@ -13,6 +13,7 @@ declare class BasePlaywright extends EventEmitter {
     protected userDataDir: string | null;
     protected running: boolean;
     protected logger: Logger;
+    protected socket: Duplex | null;
     protected proxy: httpProxy<import("http").IncomingMessage, import("http").ServerResponse<import("http").IncomingMessage>>;
     protected browser: playwright.BrowserServer | null;
     protected browserWSEndpoint: string | null;

package/build/browsers/browsers.playwright.js

@@ -14,6 +14,7 @@ class BasePlaywright extends EventEmitter {
     userDataDir;
     running = false;
     logger;
+    socket = null;
     proxy = httpProxy.createProxyServer();
     browser = null;
     browserWSEndpoint = null;
@@ -48,6 +49,7 @@ class BasePlaywright extends EventEmitter {
     async close() {
         if (this.browser) {
             this.logger.info(`Closing ${this.constructor.name} process and all listeners`);
+            this.socket?.destroy();
             this.emit('close');
             this.cleanListeners();
             this.browser.close();
@@ -104,6 +106,7 @@ class BasePlaywright extends EventEmitter {
         this.logger.error(`Not yet implemented in ${this.constructor.name}`);
     }
     async proxyWebSocket(req, socket, head) {
+        this.socket = socket;
         return new Promise((resolve, reject) => {
             if (!this.browserWSEndpoint) {
                 throw new ServerError(`No browserWSEndpoint found, did you launch first?`);

package/build/browsers/index.d.ts

@@ -50,7 +50,8 @@ export declare class BrowserManager {
         ttl: number;
         userDataDir: string | null;
     }[]>;
-    close(browser: BrowserInstance, session: BrowserlessSession): Promise<void>;
+    close(browser: BrowserInstance, session: BrowserlessSession, force?: boolean): Promise<void>;
+    killSessions(target: string): Promise<void>;
     getAllSessions(trackingId?: string): Promise<BrowserlessSessionJSON[]>;
     complete(browser: BrowserInstance): Promise<void>;
     getBrowserForRequest(req: Request, router: BrowserHTTPRoute | BrowserWebsocketRoute, logger: Logger): Promise<BrowserInstance>;

package/build/browsers/index.js

@@ -1,5 +1,6 @@
-import { BLESS_PAGE_IDENTIFIER, BadRequest, ChromeCDP, ChromePlaywright, ChromiumCDP, ChromiumPlaywright, FirefoxPlaywright, HTTPManagementRoutes, Logger, NotFound, ServerError, WebKitPlaywright, availableBrowsers, convertIfBase64, exists, generateDataDir, makeExternalURL, noop, parseBooleanParam, parseStringParam, pwVersionRegex, } from '@browserless.io/browserless';
+import { BLESS_PAGE_IDENTIFIER, BadRequest, ChromeCDP, ChromePlaywright, ChromiumCDP, ChromiumPlaywright, FirefoxPlaywright, Logger, NotFound, ServerError, WebKitPlaywright, availableBrowsers, convertIfBase64, exists, generateDataDir, makeExternalURL, noop, parseBooleanParam, parseStringParam, pwVersionRegex, } from '@browserless.io/browserless';
 import { deleteAsync } from 'del';
+import micromatch from 'micromatch';
 import path from 'path';
 export class BrowserManager {
     config;
@@ -153,7 +154,7 @@ export class BrowserManager {
                 initialConnectURL: new URL(session.initialConnectURL, serverAddress)
                     .href,
                 killURL: session.id
-                    ? makeExternalURL(serverAddress, HTTPManagementRoutes.sessions, session.id)
+                    ? makeExternalURL(serverAddress, '/kill/', session.id)
                     : null,
                 running: browser.isRunning(),
                 timeAliveMs: Date.now() - session.startedOn,
@@ -185,20 +186,20 @@ export class BrowserManager {
         }
         return sessions;
     }
-    async close(browser, session) {
+    async close(browser, session, force = false) {
         const now = Date.now();
         const keepUntil = browser.keepUntil();
         const connected = session.numbConnected;
         const hasKeepUntil = keepUntil > now;
-        const keepOpen = connected > 0 || hasKeepUntil;
+        const keepOpen = (connected > 0 || hasKeepUntil) && !force;
         const cleanupACtions = [];
         const priorTimer = this.timers.get(session.id);
         if (priorTimer) {
             this.log.info(`Deleting prior keep-until timer for "${session.id}"`);
             global.clearTimeout(priorTimer);
         }
-        this.log.info(`${session.numbConnected} Client(s) are currently connected, Keep-until: ${keepUntil}`);
-        if (hasKeepUntil) {
+        this.log.info(`${session.numbConnected} Client(s) are currently connected, Keep-until: ${keepUntil}, force: ${force}`);
+        if (!force && hasKeepUntil) {
             const timeout = keepUntil - now;
             this.log.trace(`Setting timer ${timeout.toLocaleString()} for "${session.id}"`);
             this.timers.set(session.id, global.setTimeout(() => {
@@ -220,6 +221,23 @@ export class BrowserManager {
             await Promise.all(cleanupACtions.map((a) => a()));
         }
     }
+    async killSessions(target) {
+        this.log.info(`killSessions invoked target: "${target}"`);
+        const sessions = Array.from(this.browsers);
+        let closed = 0;
+        for (const [browser, session] of sessions) {
+            if (session.trackingId === target ||
+                session.id === target ||
+                target === 'all') {
+                this.log.info(`Closing browser via killSessions BrowserId: "${session.id}", trackingId: "${session.trackingId}"`);
+                this.close(browser, session, true);
+                closed++;
+            }
+        }
+        if (closed === 0 && target !== 'all') {
+            throw new NotFound(`Couldn't locate session for id: "${target}"`);
+        }
+    }
     async getAllSessions(trackingId) {
         const sessions = Array.from(this.browsers);
         let formattedSessions = [];
@@ -259,9 +277,12 @@ export class BrowserManager {
             if (trackingId.length > 32) {
                 throw new BadRequest(`TrackingId "${trackingId}" must be less than 32 characters`);
             }
-            if (['/', '.', '\\'].some((routeLike) => trackingId.includes(routeLike))) {
+            if (!micromatch.isMatch(trackingId, '+([0-9a-zA-Z-_])')) {
                 throw new BadRequest(`trackingId contains invalid characters`);
             }
+            if (trackingId === 'all') {
+                throw new BadRequest(`trackingId cannot be the reserved word "all"`);
+            }
             this.log.info(`Assigning session trackingId "${trackingId}"`);
         }
         const decodedLaunchOptions = convertIfBase64(req.parsed.searchParams.get('launch') || '{}');

package/build/http.d.ts

@@ -151,6 +151,7 @@ export declare enum HTTPRoutes {
 export declare enum HTTPManagementRoutes {
     active = "/active?(/)",
     config = "/config?(/)",
+    kill = "/kill/+([0-9a-zA-Z-_])?(/)",
     meta = "/meta?(/)",
     metrics = "/metrics?(/)",
     metricsTotal = "/metrics/total?(/)",
@@ -192,4 +193,8 @@ export interface SystemQueryParameters {
      * The authorization token
      */
     token?: string;
+    /**
+     * Custom session identifier
+     */
+    trackingId?: string;
 }

package/build/http.js

@@ -117,6 +117,7 @@ export var HTTPManagementRoutes;
 (function (HTTPManagementRoutes) {
     HTTPManagementRoutes["active"] = "/active?(/)";
     HTTPManagementRoutes["config"] = "/config?(/)";
+    HTTPManagementRoutes["kill"] = "/kill/+([0-9a-zA-Z-_])?(/)";
     HTTPManagementRoutes["meta"] = "/meta?(/)";
     HTTPManagementRoutes["metrics"] = "/metrics?(/)";
     HTTPManagementRoutes["metricsTotal"] = "/metrics/total?(/)";

package/build/routes/chrome/http/content.post.body.json

@@ -463,14 +463,14 @@
                 "length": {
                   "type": "number"
                 },
-                "__@toStringTag@43326": {
+                "__@toStringTag@14591": {
                   "type": "string",
                   "const": "Uint8Array"
                 }
               },
               "required": [
                 "BYTES_PER_ELEMENT",
-                "__@toStringTag@43326",
+                "__@toStringTag@14591",
                 "buffer",
                 "byteLength",
                 "byteOffset",
@@ -505,13 +505,13 @@
         "byteLength": {
           "type": "number"
         },
-        "__@toStringTag@43326": {
+        "__@toStringTag@14591": {
           "type": "string"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@toStringTag@43326",
+        "__@toStringTag@14591",
         "byteLength"
       ]
     },
@@ -521,18 +521,18 @@
         "byteLength": {
           "type": "number"
         },
-        "__@species@43364": {
+        "__@species@14629": {
           "$ref": "#/definitions/SharedArrayBuffer"
         },
-        "__@toStringTag@43326": {
+        "__@toStringTag@14591": {
           "type": "string",
           "const": "SharedArrayBuffer"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@species@43364",
-        "__@toStringTag@43326",
+        "__@species@14629",
+        "__@toStringTag@14591",
         "byteLength"
       ]
     },

package/build/routes/chrome/http/content.post.query.json

@@ -23,6 +23,10 @@
     "token": {
       "description": "The authorization token",
       "type": "string"
+    },
+    "trackingId": {
+      "description": "Custom session identifier",
+      "type": "string"
     }
   },
   "definitions": {

package/build/routes/chrome/http/download.post.query.json

@@ -23,6 +23,10 @@
     "token": {
       "description": "The authorization token",
       "type": "string"
+    },
+    "trackingId": {
+      "description": "Custom session identifier",
+      "type": "string"
     }
   },
   "additionalProperties": false,

package/build/routes/chrome/http/function.post.query.json

@@ -23,6 +23,10 @@
     "token": {
       "description": "The authorization token",
       "type": "string"
+    },
+    "trackingId": {
+      "description": "Custom session identifier",
+      "type": "string"
     }
   },
   "additionalProperties": false,

package/build/routes/chrome/http/pdf.post.body.json

@@ -608,14 +608,14 @@
                 "length": {
                   "type": "number"
                 },
-                "__@toStringTag@101147": {
+                "__@toStringTag@101692": {
                   "type": "string",
                   "const": "Uint8Array"
                 }
               },
               "required": [
                 "BYTES_PER_ELEMENT",
-                "__@toStringTag@101147",
+                "__@toStringTag@101692",
                 "buffer",
                 "byteLength",
                 "byteOffset",
@@ -650,13 +650,13 @@
         "byteLength": {
           "type": "number"
         },
-        "__@toStringTag@101147": {
+        "__@toStringTag@101692": {
           "type": "string"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@toStringTag@101147",
+        "__@toStringTag@101692",
         "byteLength"
       ]
     },
@@ -666,18 +666,18 @@
         "byteLength": {
           "type": "number"
         },
-        "__@species@101185": {
+        "__@species@101730": {
           "$ref": "#/definitions/SharedArrayBuffer"
         },
-        "__@toStringTag@101147": {
+        "__@toStringTag@101692": {
           "type": "string",
           "const": "SharedArrayBuffer"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@species@101185",
-        "__@toStringTag@101147",
+        "__@species@101730",
+        "__@toStringTag@101692",
         "byteLength"
       ]
     },

package/build/routes/chrome/http/pdf.post.query.json

@@ -23,6 +23,10 @@
     "token": {
       "description": "The authorization token",
       "type": "string"
+    },
+    "trackingId": {
+      "description": "Custom session identifier",
+      "type": "string"
     }
   },
   "additionalProperties": false,

package/build/routes/chrome/http/performance.post.query.json

@@ -23,6 +23,10 @@
     "token": {
       "description": "The authorization token",
       "type": "string"
+    },
+    "trackingId": {
+      "description": "Custom session identifier",
+      "type": "string"
     }
   },
   "additionalProperties": false,

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

@@ -510,14 +510,14 @@
                 "length": {
                   "type": "number"
                 },
-                "__@toStringTag@144826": {
+                "__@toStringTag@174465": {
                   "type": "string",
                   "const": "Uint8Array"
                 }
               },
               "required": [
                 "BYTES_PER_ELEMENT",
-                "__@toStringTag@144826",
+                "__@toStringTag@174465",
                 "buffer",
                 "byteLength",
                 "byteOffset",
@@ -552,13 +552,13 @@
         "byteLength": {
           "type": "number"
         },
-        "__@toStringTag@144826": {
+        "__@toStringTag@174465": {
           "type": "string"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@toStringTag@144826",
+        "__@toStringTag@174465",
         "byteLength"
       ]
     },
@@ -568,18 +568,18 @@
         "byteLength": {
           "type": "number"
         },
-        "__@species@144864": {
+        "__@species@174503": {
           "$ref": "#/definitions/SharedArrayBuffer"
         },
-        "__@toStringTag@144826": {
+        "__@toStringTag@174465": {
           "type": "string",
           "const": "SharedArrayBuffer"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@species@144864",
-        "__@toStringTag@144826",
+        "__@species@174503",
+        "__@toStringTag@174465",
         "byteLength"
       ]
     },

package/build/routes/chrome/http/scrape.post.query.json

@@ -23,6 +23,10 @@
     "token": {
       "description": "The authorization token",
       "type": "string"
+    },
+    "trackingId": {
+      "description": "Custom session identifier",
+      "type": "string"
     }
   },
   "definitions": {

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

@@ -553,14 +553,14 @@
                 "length": {
                   "type": "number"
                 },
-                "__@toStringTag@130212": {
+                "__@toStringTag@189225": {
                   "type": "string",
                   "const": "Uint8Array"
                 }
               },
               "required": [
                 "BYTES_PER_ELEMENT",
-                "__@toStringTag@130212",
+                "__@toStringTag@189225",
                 "buffer",
                 "byteLength",
                 "byteOffset",
@@ -595,13 +595,13 @@
         "byteLength": {
           "type": "number"
         },
-        "__@toStringTag@130212": {
+        "__@toStringTag@189225": {
           "type": "string"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@toStringTag@130212",
+        "__@toStringTag@189225",
         "byteLength"
       ]
     },
@@ -611,18 +611,18 @@
         "byteLength": {
           "type": "number"
         },
-        "__@species@130250": {
+        "__@species@189263": {
           "$ref": "#/definitions/SharedArrayBuffer"
         },
-        "__@toStringTag@130212": {
+        "__@toStringTag@189225": {
           "type": "string",
           "const": "SharedArrayBuffer"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@species@130250",
-        "__@toStringTag@130212",
+        "__@species@189263",
+        "__@toStringTag@189225",
         "byteLength"
       ]
     },

package/build/routes/chrome/http/screenshot.post.query.json

@@ -23,6 +23,10 @@
     "token": {
       "description": "The authorization token",
       "type": "string"
+    },
+    "trackingId": {
+      "description": "Custom session identifier",
+      "type": "string"
     }
   },
   "additionalProperties": false,

package/build/routes/chrome/tests/kill-sessions.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/build/routes/chrome/tests/kill-sessions.spec.js

@@ -0,0 +1,80 @@
+import { Browserless, Config, Metrics } from '@browserless.io/browserless';
+import { expect } from 'chai';
+import puppeteer from 'puppeteer-core';
+describe('/kill API', function () {
+    let browserless;
+    const start = ({ config = new Config(), metrics = new Metrics(), } = {}) => {
+        config.setToken('6R0W53R135510');
+        browserless = new Browserless({ config, metrics });
+        return browserless.start();
+    };
+    afterEach(async () => {
+        await browserless.stop();
+    });
+    it('Kill all sessions', async () => {
+        await start();
+        const browser1 = await puppeteer.connect({
+            browserWSEndpoint: `ws://localhost:3000/chrome?token=6R0W53R135510`,
+        });
+        const browser2 = await puppeteer.connect({
+            browserWSEndpoint: `ws://localhost:3000/chrome?token=6R0W53R135510`,
+        });
+        await fetch('http://localhost:3000/kill/all?token=6R0W53R135510').then(async (res) => {
+            expect(res.status).to.equal(204);
+        });
+        let errorThrown1;
+        try {
+            await browser1.newPage();
+        }
+        catch (e) {
+            errorThrown1 = e;
+        }
+        let errorThrown2;
+        try {
+            await browser2.newPage();
+        }
+        catch (e) {
+            errorThrown2 = e;
+        }
+        expect(errorThrown1.message).contains('closed');
+        expect(errorThrown2.message).contains('closed');
+    });
+    it('Kill session by browserId', async () => {
+        await start();
+        const browser = await puppeteer.connect({
+            browserWSEndpoint: `ws://localhost:3000/chrome?token=6R0W53R135510`,
+        });
+        await fetch('http://localhost:3000/sessions?token=6R0W53R135510').then(async (res) => {
+            const sessions = await res.json();
+            const browserId = sessions[0].browserId;
+            await fetch(`http://localhost:3000/kill/${browserId}?token=6R0W53R135510`).then(async (res) => {
+                expect(res.status).to.equal(204);
+            });
+        });
+        let errorThrown;
+        try {
+            await browser.newPage();
+        }
+        catch (e) {
+            errorThrown = e;
+        }
+        expect(errorThrown.message).contains('closed');
+    });
+    it('Kill session by trackingId', async () => {
+        await start();
+        const browser = await puppeteer.connect({
+            browserWSEndpoint: `ws://localhost:3000/chrome?token=6R0W53R135510&trackingId=session-1`,
+        });
+        await fetch('http://localhost:3000/kill/session-1?token=6R0W53R135510').then(async (res) => {
+            expect(res.status).to.equal(204);
+        });
+        let errorThrown;
+        try {
+            await browser.newPage();
+        }
+        catch (e) {
+            errorThrown = e;
+        }
+        expect(errorThrown.message).contains('closed');
+    });
+});

package/build/routes/chrome/ws/browser.query.json

@@ -23,6 +23,10 @@
     "token": {
       "description": "The authorization token",
       "type": "string"
+    },
+    "trackingId": {
+      "description": "Custom session identifier",
+      "type": "string"
     }
   },
   "additionalProperties": false,

package/build/routes/chrome/ws/cdp.query.json

@@ -23,6 +23,10 @@
     "token": {
       "description": "The authorization token",
       "type": "string"
+    },
+    "trackingId": {
+      "description": "Custom session identifier",
+      "type": "string"
     }
   },
   "additionalProperties": false,

package/build/routes/chrome/ws/page.query.json

@@ -23,6 +23,10 @@
     "token": {
       "description": "The authorization token",
       "type": "string"
+    },
+    "trackingId": {
+      "description": "Custom session identifier",
+      "type": "string"
     }
   },
   "additionalProperties": false,

package/build/routes/chrome/ws/playwright.query.json

@@ -23,6 +23,10 @@
     "token": {
       "description": "The authorization token",
       "type": "string"
+    },
+    "trackingId": {
+      "description": "Custom session identifier",
+      "type": "string"
     }
   },
   "additionalProperties": false,