@browserless.io/browserless 2.24.0-beta-4 → 2.24.0

package/CHANGELOG.md

@@ -1,7 +1,23 @@
-# [Latest](https://github.com/browserless/chrome/compare/v2.23.0...main)
+# [Latest](https://github.com/browserless/chrome/compare/v2.24.0...main)
 
 - Dependency updates.
 
+# [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

@@ -245,7 +245,7 @@
       ]
     },
     "CookieParam": {
-      "description": "Cookie parameter object",
+      "description": "Cookie parameter object used to set cookies in the page-level cookies\nAPI.",
       "type": "object",
       "properties": {
         "name": {
@@ -313,7 +313,14 @@
         },
         "partitionKey": {
           "description": "Cookie partition key. In Chrome, it matches the top-level site the\npartitioned cookie is available in. In Firefox, it matches the\nsource origin\n(https://w3c.github.io/webdriver-bidi/#type-storage-PartitionKey).",
-          "type": "string"
+          "anyOf": [
+            {
+              "$ref": "#/definitions/CookiePartitionKey"
+            },
+            {
+              "type": "string"
+            }
+          ]
         }
       },
       "additionalProperties": false,
@@ -322,6 +329,24 @@
         "value"
       ]
     },
+    "CookiePartitionKey": {
+      "description": "Represents a cookie partition key in Chrome.",
+      "type": "object",
+      "properties": {
+        "sourceOrigin": {
+          "description": "The site of the top-level URL the browser was visiting at the start of the request\nto the endpoint that set the cookie.\n\nIn Chrome, maps to the CDP's `topLevelSite` partition key.",
+          "type": "string"
+        },
+        "hasCrossSiteAncestor": {
+          "description": "Indicates if the cookie has any ancestors that are cross-site to\nthe topLevelSite.\n\nSupported only in Chrome.",
+          "type": "boolean"
+        }
+      },
+      "additionalProperties": false,
+      "required": [
+        "sourceOrigin"
+      ]
+    },
     "GoToOptions": {
       "type": "object",
       "properties": {
@@ -438,14 +463,14 @@
                 "length": {
                   "type": "number"
                 },
-                "__@toStringTag@14520": {
+                "__@toStringTag@14524": {
                   "type": "string",
                   "const": "Uint8Array"
                 }
               },
               "required": [
                 "BYTES_PER_ELEMENT",
-                "__@toStringTag@14520",
+                "__@toStringTag@14524",
                 "buffer",
                 "byteLength",
                 "byteOffset",
@@ -480,13 +505,13 @@
         "byteLength": {
           "type": "number"
         },
-        "__@toStringTag@14520": {
+        "__@toStringTag@14524": {
           "type": "string"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@toStringTag@14520",
+        "__@toStringTag@14524",
         "byteLength"
       ]
     },
@@ -496,18 +521,18 @@
         "byteLength": {
           "type": "number"
         },
-        "__@species@14558": {
+        "__@species@14562": {
           "$ref": "#/definitions/SharedArrayBuffer"
         },
-        "__@toStringTag@14520": {
+        "__@toStringTag@14524": {
           "type": "string",
           "const": "SharedArrayBuffer"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@species@14558",
-        "__@toStringTag@14520",
+        "__@species@14562",
+        "__@toStringTag@14524",
         "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

@@ -247,7 +247,7 @@
       ]
     },
     "CookieParam": {
-      "description": "Cookie parameter object",
+      "description": "Cookie parameter object used to set cookies in the page-level cookies\nAPI.",
       "type": "object",
       "properties": {
         "name": {
@@ -315,7 +315,14 @@
         },
         "partitionKey": {
           "description": "Cookie partition key. In Chrome, it matches the top-level site the\npartitioned cookie is available in. In Firefox, it matches the\nsource origin\n(https://w3c.github.io/webdriver-bidi/#type-storage-PartitionKey).",
-          "type": "string"
+          "anyOf": [
+            {
+              "$ref": "#/definitions/CookiePartitionKey"
+            },
+            {
+              "type": "string"
+            }
+          ]
         }
       },
       "additionalProperties": false,
@@ -324,6 +331,24 @@
         "value"
       ]
     },
+    "CookiePartitionKey": {
+      "description": "Represents a cookie partition key in Chrome.",
+      "type": "object",
+      "properties": {
+        "sourceOrigin": {
+          "description": "The site of the top-level URL the browser was visiting at the start of the request\nto the endpoint that set the cookie.\n\nIn Chrome, maps to the CDP's `topLevelSite` partition key.",
+          "type": "string"
+        },
+        "hasCrossSiteAncestor": {
+          "description": "Indicates if the cookie has any ancestors that are cross-site to\nthe topLevelSite.\n\nSupported only in Chrome.",
+          "type": "boolean"
+        }
+      },
+      "additionalProperties": false,
+      "required": [
+        "sourceOrigin"
+      ]
+    },
     "GoToOptions": {
       "type": "object",
       "properties": {
@@ -583,14 +608,14 @@
                 "length": {
                   "type": "number"
                 },
-                "__@toStringTag@115575": {
+                "__@toStringTag@115599": {
                   "type": "string",
                   "const": "Uint8Array"
                 }
               },
               "required": [
                 "BYTES_PER_ELEMENT",
-                "__@toStringTag@115575",
+                "__@toStringTag@115599",
                 "buffer",
                 "byteLength",
                 "byteOffset",
@@ -625,13 +650,13 @@
         "byteLength": {
           "type": "number"
         },
-        "__@toStringTag@115575": {
+        "__@toStringTag@115599": {
           "type": "string"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@toStringTag@115575",
+        "__@toStringTag@115599",
         "byteLength"
       ]
     },
@@ -641,18 +666,18 @@
         "byteLength": {
           "type": "number"
         },
-        "__@species@115613": {
+        "__@species@115637": {
           "$ref": "#/definitions/SharedArrayBuffer"
         },
-        "__@toStringTag@115575": {
+        "__@toStringTag@115599": {
           "type": "string",
           "const": "SharedArrayBuffer"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@species@115613",
-        "__@toStringTag@115575",
+        "__@species@115637",
+        "__@toStringTag@115599",
         "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

@@ -256,7 +256,7 @@
       ]
     },
     "CookieParam": {
-      "description": "Cookie parameter object",
+      "description": "Cookie parameter object used to set cookies in the page-level cookies\nAPI.",
       "type": "object",
       "properties": {
         "name": {
@@ -324,7 +324,14 @@
         },
         "partitionKey": {
           "description": "Cookie partition key. In Chrome, it matches the top-level site the\npartitioned cookie is available in. In Firefox, it matches the\nsource origin\n(https://w3c.github.io/webdriver-bidi/#type-storage-PartitionKey).",
-          "type": "string"
+          "anyOf": [
+            {
+              "$ref": "#/definitions/CookiePartitionKey"
+            },
+            {
+              "type": "string"
+            }
+          ]
         }
       },
       "additionalProperties": false,
@@ -333,6 +340,24 @@
         "value"
       ]
     },
+    "CookiePartitionKey": {
+      "description": "Represents a cookie partition key in Chrome.",
+      "type": "object",
+      "properties": {
+        "sourceOrigin": {
+          "description": "The site of the top-level URL the browser was visiting at the start of the request\nto the endpoint that set the cookie.\n\nIn Chrome, maps to the CDP's `topLevelSite` partition key.",
+          "type": "string"
+        },
+        "hasCrossSiteAncestor": {
+          "description": "Indicates if the cookie has any ancestors that are cross-site to\nthe topLevelSite.\n\nSupported only in Chrome.",
+          "type": "boolean"
+        }
+      },
+      "additionalProperties": false,
+      "required": [
+        "sourceOrigin"
+      ]
+    },
     "ScrapeDebugOptions": {
       "type": "object",
       "properties": {
@@ -485,14 +510,14 @@
                 "length": {
                   "type": "number"
                 },
-                "__@toStringTag@144808": {
+                "__@toStringTag@144629": {
                   "type": "string",
                   "const": "Uint8Array"
                 }
               },
               "required": [
                 "BYTES_PER_ELEMENT",
-                "__@toStringTag@144808",
+                "__@toStringTag@144629",
                 "buffer",
                 "byteLength",
                 "byteOffset",
@@ -527,13 +552,13 @@
         "byteLength": {
           "type": "number"
         },
-        "__@toStringTag@144808": {
+        "__@toStringTag@144629": {
           "type": "string"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@toStringTag@144808",
+        "__@toStringTag@144629",
         "byteLength"
       ]
     },
@@ -543,18 +568,18 @@
         "byteLength": {
           "type": "number"
         },
-        "__@species@144846": {
+        "__@species@144667": {
           "$ref": "#/definitions/SharedArrayBuffer"
         },
-        "__@toStringTag@144808": {
+        "__@toStringTag@144629": {
           "type": "string",
           "const": "SharedArrayBuffer"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@species@144846",
-        "__@toStringTag@144808",
+        "__@species@144667",
+        "__@toStringTag@144629",
         "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/scrape.post.response.json

@@ -248,7 +248,14 @@
         },
         "partitionKey": {
           "description": "Cookie partition key. In Chrome, it is the top-level site the\npartitioned cookie is available in. In Firefox, it matches the\nsource origin\n(https://w3c.github.io/webdriver-bidi/#type-storage-PartitionKey).",
-          "type": "string"
+          "anyOf": [
+            {
+              "$ref": "#/definitions/CookiePartitionKey"
+            },
+            {
+              "type": "string"
+            }
+          ]
         },
         "partitionKeyOpaque": {
           "description": "True if cookie partition key is opaque. Supported only in Chrome.",
@@ -268,6 +275,24 @@
         "value"
       ]
     },
+    "CookiePartitionKey": {
+      "description": "Represents a cookie partition key in Chrome.",
+      "type": "object",
+      "properties": {
+        "sourceOrigin": {
+          "description": "The site of the top-level URL the browser was visiting at the start of the request\nto the endpoint that set the cookie.\n\nIn Chrome, maps to the CDP's `topLevelSite` partition key.",
+          "type": "string"
+        },
+        "hasCrossSiteAncestor": {
+          "description": "Indicates if the cookie has any ancestors that are cross-site to\nthe topLevelSite.\n\nSupported only in Chrome.",
+          "type": "boolean"
+        }
+      },
+      "additionalProperties": false,
+      "required": [
+        "sourceOrigin"
+      ]
+    },
     "InBoundRequest": {
       "type": "object",
       "properties": {