@browserless.io/browserless 2.36.0 → 2.37.0

package/CHANGELOG.md

@@ -1,8 +1,22 @@
-# [Latest](https://github.com/browserless/chrome/compare/v2.35.0...main)
+# [Latest](https://github.com/browserless/chrome/compare/v2.37.0...main)
 
 - Dependency updates.
 
-# [v2.35.0](https://github.com/browserless/chrome/compare/v2.34.1...v2.35.0)
+# [v2.37.0](https://github.com/browserless/chrome/compare/v2.36.0...v2.37.0)
+
+- Dependency updates.
+- Adds a new `/function/connect` route to distinguish function API calls and not have them add to concurrency.
+- Fix installs in SDK projects not working.
+- Supports the following libraries and browsers:
+  - puppeteer-core: `24.22.3`
+  - playwright-core: `1.55.1`, `1.54.2`, `1.53.2`, `1.52.0`, and `1.51.1`.
+  - Chromium: `140.0.7339.16`
+  - Chrome: `140.0.7339.214` (amd64 only)
+  - Firefox: `141.0`
+  - Webkit: `26.0`
+  - Edge: `140.0.3485.94` (amd64 only)
+
+# [v2.36.0](https://github.com/browserless/chrome/compare/v2.34.1...v2.36.0)
 
 - Dependency updates.
 - Updates base image to Ubuntu `24.04`.

package/build/browsers/index.d.ts

@@ -4,6 +4,7 @@ export declare class BrowserManager {
     protected config: Config;
     protected hooks: Hooks;
     protected fileSystem: FileSystem;
+    protected reconnectionPatterns: string[];
     protected browsers: Map<BrowserInstance, BrowserlessSession>;
     protected timers: Map<string, NodeJS.Timeout>;
     protected log: Logger;

package/build/browsers/index.js

@@ -6,6 +6,7 @@ export class BrowserManager {
     config;
     hooks;
     fileSystem;
+    reconnectionPatterns = ['/devtools/browser', '/function/connect'];
     browsers = new Map();
     timers = new Map();
     log = new Logger('browser-manager');
@@ -296,10 +297,10 @@ export class BrowserManager {
         const decodedLaunchOptions = convertIfBase64(req.parsed.searchParams.get('launch') || '{}');
         let parsedLaunchOptions;
         // Handle browser re-connects here
-        if (req.parsed.pathname.includes('/devtools/browser')) {
+        if (this.reconnectionPatterns.some((p) => req.parsed.pathname.includes(p))) {
             const sessions = Array.from(this.browsers);
             const id = req.parsed.pathname.split('/').pop();
-            const found = sessions.find(([b]) => b.wsEndpoint()?.includes(req.parsed.pathname));
+            const found = sessions.find(([b]) => b.wsEndpoint()?.includes(id));
             if (found) {
                 const [browser, session] = found;
                 ++session.numbConnected;

package/build/http.d.ts

@@ -120,12 +120,13 @@ export declare enum WebsocketRoutes {
     '/' = "?(/)",
     browser = "/devtools/browser/*",
     chrome = "/chrome?(/)",
-    edge = "/edge?(/)",
     chromePlaywright = "/chrome/playwright?(/)",
-    edgePlaywright = "/edge/playwright?(/)",
     chromium = "/chromium?(/)",
     chromiumPlaywright = "/chromium/playwright?(/)",
+    edge = "/edge?(/)",
+    edgePlaywright = "/edge/playwright?(/)",
     firefoxPlaywright = "/firefox/playwright?(/)",
+    functionClientConnect = "/function/connect/*",
     page = "/devtools/page/*",
     playwrightChrome = "/playwright/chrome?(/)",
     playwrightChromium = "/playwright/chromium?(/)",

package/build/http.js

@@ -79,12 +79,13 @@ export var WebsocketRoutes;
     WebsocketRoutes["/"] = "?(/)";
     WebsocketRoutes["browser"] = "/devtools/browser/*";
     WebsocketRoutes["chrome"] = "/chrome?(/)";
-    WebsocketRoutes["edge"] = "/edge?(/)";
     WebsocketRoutes["chromePlaywright"] = "/chrome/playwright?(/)";
-    WebsocketRoutes["edgePlaywright"] = "/edge/playwright?(/)";
     WebsocketRoutes["chromium"] = "/chromium?(/)";
     WebsocketRoutes["chromiumPlaywright"] = "/chromium/playwright?(/)";
+    WebsocketRoutes["edge"] = "/edge?(/)";
+    WebsocketRoutes["edgePlaywright"] = "/edge/playwright?(/)";
     WebsocketRoutes["firefoxPlaywright"] = "/firefox/playwright?(/)";
+    WebsocketRoutes["functionClientConnect"] = "/function/connect/*";
     WebsocketRoutes["page"] = "/devtools/page/*";
     WebsocketRoutes["playwrightChrome"] = "/playwright/chrome?(/)";
     WebsocketRoutes["playwrightChromium"] = "/playwright/chromium?(/)";

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

@@ -16,9 +16,6 @@ describe('/kill API', function () {
         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);
         });
@@ -29,15 +26,7 @@ describe('/kill API', function () {
         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();

package/build/routes/chrome/ws/function-connect.d.ts

@@ -0,0 +1,7 @@
+import { ChromeCDP } from '@browserless.io/browserless';
+import { default as FunctionConnect, QuerySchema } from '../../../shared/function-connect.ws.js';
+export default class ChromeFunctionConnectWebSocketRoute extends FunctionConnect {
+    name: string;
+    browser: typeof ChromeCDP;
+}
+export { QuerySchema };

package/build/routes/chrome/ws/function-connect.js

@@ -0,0 +1,6 @@
+import { BrowserlessRoutes, ChromeCDP } from '@browserless.io/browserless';
+import { default as FunctionConnect, } from '../../../shared/function-connect.ws.js';
+export default class ChromeFunctionConnectWebSocketRoute extends FunctionConnect {
+    name = BrowserlessRoutes.ChromeFunctionConnectWebSocketRoute;
+    browser = ChromeCDP;
+}

package/build/routes/chrome/ws/function-connect.query.json

@@ -0,0 +1,120 @@
+{
+  "type": "object",
+  "properties": {
+    "launch": {
+      "description": "Launch options, which can be either an object\nof puppeteer.launch options or playwright.launchServer\noptions, depending on the API. Must be either JSON\nobject, or a base64-encoded JSON object.",
+      "anyOf": [
+        {
+          "$ref": "#/definitions/CDPLaunchOptions"
+        },
+        {
+          "type": "string"
+        }
+      ]
+    },
+    "blockAds": {
+      "description": "Whether or nor to load ad-blocking extensions for the session.\nThis currently uses uBlock-Lite and may cause certain sites\nto not load properly.",
+      "type": "boolean"
+    },
+    "timeout": {
+      "description": "Override the system-level timeout for this request.\nAccepts a value in milliseconds.",
+      "type": "number"
+    },
+    "token": {
+      "description": "The authorization token",
+      "type": "string"
+    },
+    "trackingId": {
+      "description": "Custom session identifier",
+      "type": "string"
+    }
+  },
+  "additionalProperties": false,
+  "definitions": {
+    "CDPLaunchOptions": {
+      "type": "object",
+      "properties": {
+        "args": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "defaultViewport": {
+          "type": "object",
+          "properties": {
+            "deviceScaleFactor": {
+              "type": "number"
+            },
+            "hasTouch": {
+              "type": "boolean"
+            },
+            "height": {
+              "type": "number"
+            },
+            "isLandscape": {
+              "type": "boolean"
+            },
+            "isMobile": {
+              "type": "boolean"
+            },
+            "width": {
+              "type": "number"
+            }
+          },
+          "additionalProperties": false,
+          "required": [
+            "height",
+            "width"
+          ]
+        },
+        "devtools": {
+          "type": "boolean"
+        },
+        "dumpio": {
+          "type": "boolean"
+        },
+        "headless": {
+          "enum": [
+            false,
+            "shell",
+            true
+          ]
+        },
+        "ignoreDefaultArgs": {
+          "anyOf": [
+            {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            },
+            {
+              "type": "boolean"
+            }
+          ]
+        },
+        "ignoreHTTPSErrors": {
+          "type": "boolean"
+        },
+        "slowMo": {
+          "type": "number"
+        },
+        "stealth": {
+          "type": "boolean"
+        },
+        "timeout": {
+          "type": "number"
+        },
+        "userDataDir": {
+          "type": "string"
+        },
+        "waitForInitialPage": {
+          "type": "boolean"
+        }
+      },
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/build/routes/chromium/ws/function-connect.d.ts

@@ -0,0 +1 @@
+export { default, QuerySchema } from '../../../shared/function-connect.ws.js';

package/build/routes/chromium/ws/function-connect.js

@@ -0,0 +1 @@
+export { default } from '../../../shared/function-connect.ws.js';

package/build/routes/chromium/ws/function-connect.query.json

@@ -0,0 +1,120 @@
+{
+  "type": "object",
+  "properties": {
+    "launch": {
+      "description": "Launch options, which can be either an object\nof puppeteer.launch options or playwright.launchServer\noptions, depending on the API. Must be either JSON\nobject, or a base64-encoded JSON object.",
+      "anyOf": [
+        {
+          "$ref": "#/definitions/CDPLaunchOptions"
+        },
+        {
+          "type": "string"
+        }
+      ]
+    },
+    "blockAds": {
+      "description": "Whether or nor to load ad-blocking extensions for the session.\nThis currently uses uBlock-Lite and may cause certain sites\nto not load properly.",
+      "type": "boolean"
+    },
+    "timeout": {
+      "description": "Override the system-level timeout for this request.\nAccepts a value in milliseconds.",
+      "type": "number"
+    },
+    "token": {
+      "description": "The authorization token",
+      "type": "string"
+    },
+    "trackingId": {
+      "description": "Custom session identifier",
+      "type": "string"
+    }
+  },
+  "additionalProperties": false,
+  "definitions": {
+    "CDPLaunchOptions": {
+      "type": "object",
+      "properties": {
+        "args": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "defaultViewport": {
+          "type": "object",
+          "properties": {
+            "deviceScaleFactor": {
+              "type": "number"
+            },
+            "hasTouch": {
+              "type": "boolean"
+            },
+            "height": {
+              "type": "number"
+            },
+            "isLandscape": {
+              "type": "boolean"
+            },
+            "isMobile": {
+              "type": "boolean"
+            },
+            "width": {
+              "type": "number"
+            }
+          },
+          "additionalProperties": false,
+          "required": [
+            "height",
+            "width"
+          ]
+        },
+        "devtools": {
+          "type": "boolean"
+        },
+        "dumpio": {
+          "type": "boolean"
+        },
+        "headless": {
+          "enum": [
+            false,
+            "shell",
+            true
+          ]
+        },
+        "ignoreDefaultArgs": {
+          "anyOf": [
+            {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            },
+            {
+              "type": "boolean"
+            }
+          ]
+        },
+        "ignoreHTTPSErrors": {
+          "type": "boolean"
+        },
+        "slowMo": {
+          "type": "number"
+        },
+        "stealth": {
+          "type": "boolean"
+        },
+        "timeout": {
+          "type": "number"
+        },
+        "userDataDir": {
+          "type": "string"
+        },
+        "waitForInitialPage": {
+          "type": "boolean"
+        }
+      },
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/build/routes/edge/ws/function-connect.d.ts

@@ -0,0 +1,7 @@
+import { EdgeCDP } from '@browserless.io/browserless';
+import { default as FunctionConnect, QuerySchema } from '../../../shared/function-connect.ws.js';
+export default class EdgeFunctionConnectWebSocketRoute extends FunctionConnect {
+    name: string;
+    browser: typeof EdgeCDP;
+}
+export { QuerySchema };

package/build/routes/edge/ws/function-connect.js

@@ -0,0 +1,6 @@
+import { BrowserlessRoutes, EdgeCDP } from '@browserless.io/browserless';
+import { default as FunctionConnect, } from '../../../shared/function-connect.ws.js';
+export default class EdgeFunctionConnectWebSocketRoute extends FunctionConnect {
+    name = BrowserlessRoutes.EdgeFunctionConnectWebSocketRoute;
+    browser = EdgeCDP;
+}

package/build/routes/edge/ws/function-connect.query.json

@@ -0,0 +1,120 @@
+{
+  "type": "object",
+  "properties": {
+    "launch": {
+      "description": "Launch options, which can be either an object\nof puppeteer.launch options or playwright.launchServer\noptions, depending on the API. Must be either JSON\nobject, or a base64-encoded JSON object.",
+      "anyOf": [
+        {
+          "$ref": "#/definitions/CDPLaunchOptions"
+        },
+        {
+          "type": "string"
+        }
+      ]
+    },
+    "blockAds": {
+      "description": "Whether or nor to load ad-blocking extensions for the session.\nThis currently uses uBlock-Lite and may cause certain sites\nto not load properly.",
+      "type": "boolean"
+    },
+    "timeout": {
+      "description": "Override the system-level timeout for this request.\nAccepts a value in milliseconds.",
+      "type": "number"
+    },
+    "token": {
+      "description": "The authorization token",
+      "type": "string"
+    },
+    "trackingId": {
+      "description": "Custom session identifier",
+      "type": "string"
+    }
+  },
+  "additionalProperties": false,
+  "definitions": {
+    "CDPLaunchOptions": {
+      "type": "object",
+      "properties": {
+        "args": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "defaultViewport": {
+          "type": "object",
+          "properties": {
+            "deviceScaleFactor": {
+              "type": "number"
+            },
+            "hasTouch": {
+              "type": "boolean"
+            },
+            "height": {
+              "type": "number"
+            },
+            "isLandscape": {
+              "type": "boolean"
+            },
+            "isMobile": {
+              "type": "boolean"
+            },
+            "width": {
+              "type": "number"
+            }
+          },
+          "additionalProperties": false,
+          "required": [
+            "height",
+            "width"
+          ]
+        },
+        "devtools": {
+          "type": "boolean"
+        },
+        "dumpio": {
+          "type": "boolean"
+        },
+        "headless": {
+          "enum": [
+            false,
+            "shell",
+            true
+          ]
+        },
+        "ignoreDefaultArgs": {
+          "anyOf": [
+            {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            },
+            {
+              "type": "boolean"
+            }
+          ]
+        },
+        "ignoreHTTPSErrors": {
+          "type": "boolean"
+        },
+        "slowMo": {
+          "type": "number"
+        },
+        "stealth": {
+          "type": "boolean"
+        },
+        "timeout": {
+          "type": "number"
+        },
+        "userDataDir": {
+          "type": "string"
+        },
+        "waitForInitialPage": {
+          "type": "boolean"
+        }
+      },
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/build/sdk-utils.js

@@ -81,7 +81,7 @@ export const prompt = async (question) => {
 };
 // Exceptions are not caught, since any error would result in a crash regardless
 export const installDependencies = async (workingDirectory) => {
-    await waitForCommand('npm clean-install', workingDirectory);
+    await waitForCommand('npm install', workingDirectory);
     await installBrowsers(workingDirectory);
 };
 export const installBrowsers = async (workingDirectory) => {

package/build/shared/function-connect.ws.d.ts

@@ -0,0 +1,15 @@
+import { APITags, BrowserWebsocketRoute, CDPLaunchOptions, ChromiumCDP, Logger, Request, SystemQueryParameters, WebsocketRoutes } from '@browserless.io/browserless';
+import { Duplex } from 'stream';
+export interface QuerySchema extends SystemQueryParameters {
+    launch?: CDPLaunchOptions | string;
+}
+export default class ChromiumFunctionConnectWebSocketRoute extends BrowserWebsocketRoute {
+    name: string;
+    auth: boolean;
+    concurrency: boolean;
+    browser: typeof ChromiumCDP;
+    description: string;
+    path: WebsocketRoutes;
+    tags: APITags[];
+    handler(req: Request, socket: Duplex, head: Buffer, _logger: Logger, browser: ChromiumCDP): Promise<void>;
+}

package/build/shared/function-connect.ws.js

@@ -0,0 +1,13 @@
+import { APITags, BrowserWebsocketRoute, BrowserlessRoutes, ChromiumCDP, WebsocketRoutes, dedent, } from '@browserless.io/browserless';
+export default class ChromiumFunctionConnectWebSocketRoute extends BrowserWebsocketRoute {
+    name = BrowserlessRoutes.ChromiumFunctionConnectWebSocketRoute;
+    auth = true;
+    concurrency = false;
+    browser = ChromiumCDP;
+    description = dedent(`Internally used by the POST /function API to connect the underlying client-side code to. Not intended for direct use but documented for completeness and to distinguish between other reconnect style calls.`);
+    path = WebsocketRoutes.functionClientConnect;
+    tags = [APITags.browserWS];
+    async handler(req, socket, head, _logger, browser) {
+        return browser.proxyWebSocket(req, socket, head);
+    }
+}

package/build/shared/utils/function/handler.js

@@ -1,4 +1,4 @@
-import { BadRequest, HTTPRoutes, ServerError, contentTypes, convertIfBase64, exists, getTokenFromRequest, id, makeExternalURL, mimeTypes, } from '@browserless.io/browserless';
+import { BadRequest, HTTPRoutes, ServerError, contentTypes, convertIfBase64, exists, getTokenFromRequest, makeExternalURL, mimeTypes, } from '@browserless.io/browserless';
 import fs from 'fs';
 import path from 'path';
 export default (config, logger, options = {}) => async (req, browser) => {
@@ -15,11 +15,13 @@ export default (config, logger, options = {}) => async (req, browser) => {
         };
     const context = JSON.stringify(rawContext);
     const code = convertIfBase64(rawCode);
-    const browserWSEndpoint = browser.publicWSEndpoint(getTokenFromRequest(req) ?? '');
-    if (!browserWSEndpoint) {
+    const privateWSEndpoint = browser.wsEndpoint();
+    if (!privateWSEndpoint) {
         throw new ServerError(`No browser endpoint was found, is the browser running?`);
     }
-    const functionCodeJS = `browserless-function-${id()}.js`;
+    const browserID = privateWSEndpoint.split('/').pop();
+    const browserWSEndpoint = makeExternalURL(config.getExternalWebSocketAddress(), 'function', 'connect', browserID, '?token=' + getTokenFromRequest(req));
+    const functionCodeJS = `browserless-function-${browserID}.js`;
     const page = (await browser.newPage());
     await page.setRequestInterception(true);
     /**

package/build/types.d.ts

@@ -503,6 +503,7 @@ export declare const BrowserlessChromeRoutes: {
     ChromeCDPWebSocketRoute: string;
     ChromeContentPostRoute: string;
     ChromeDownloadPostRoute: string;
+    ChromeFunctionConnectWebSocketRoute: string;
     ChromeFunctionPostRoute: string;
     ChromeJSONListGetRoute: string;
     ChromeJSONNewPutRoute: string;
@@ -520,6 +521,7 @@ export declare const BrowserlessEdgeRoutes: {
     EdgeCDPWebSocketRoute: string;
     EdgeContentPostRoute: string;
     EdgeDownloadPostRoute: string;
+    EdgeFunctionConnectWebSocketRoute: string;
     EdgeFunctionPostRoute: string;
     EdgeJSONListGetRoute: string;
     EdgeJSONNewPutRoute: string;
@@ -537,6 +539,7 @@ export declare const BrowserlessChromiumRoutes: {
     ChromiumCDPWebSocketRoute: string;
     ChromiumContentPostRoute: string;
     ChromiumDownloadPostRoute: string;
+    ChromiumFunctionConnectWebSocketRoute: string;
     ChromiumFunctionPostRoute: string;
     ChromiumJSONListGetRoute: string;
     ChromiumJSONNewPutRoute: string;
@@ -582,6 +585,7 @@ export declare const BrowserlessRoutes: {
     EdgeCDPWebSocketRoute: string;
     EdgeContentPostRoute: string;
     EdgeDownloadPostRoute: string;
+    EdgeFunctionConnectWebSocketRoute: string;
     EdgeFunctionPostRoute: string;
     EdgeJSONListGetRoute: string;
     EdgeJSONNewPutRoute: string;
@@ -597,6 +601,7 @@ export declare const BrowserlessRoutes: {
     ChromiumCDPWebSocketRoute: string;
     ChromiumContentPostRoute: string;
     ChromiumDownloadPostRoute: string;
+    ChromiumFunctionConnectWebSocketRoute: string;
     ChromiumFunctionPostRoute: string;
     ChromiumJSONListGetRoute: string;
     ChromiumJSONNewPutRoute: string;
@@ -612,6 +617,7 @@ export declare const BrowserlessRoutes: {
     ChromeCDPWebSocketRoute: string;
     ChromeContentPostRoute: string;
     ChromeDownloadPostRoute: string;
+    ChromeFunctionConnectWebSocketRoute: string;
     ChromeFunctionPostRoute: string;
     ChromeJSONListGetRoute: string;
     ChromeJSONNewPutRoute: string;

package/build/types.js

@@ -166,6 +166,7 @@ export const BrowserlessChromeRoutes = {
     ChromeCDPWebSocketRoute: 'ChromeCDPWebSocketRoute',
     ChromeContentPostRoute: 'ChromeContentPostRoute',
     ChromeDownloadPostRoute: 'ChromeDownloadPostRoute',
+    ChromeFunctionConnectWebSocketRoute: 'ChromeFunctionConnectWebSocketRoute',
     ChromeFunctionPostRoute: 'ChromeFunctionPostRoute',
     ChromeJSONListGetRoute: 'ChromeJSONListGetRoute',
     ChromeJSONNewPutRoute: 'ChromeJSONNewPutRoute',
@@ -183,6 +184,7 @@ export const BrowserlessEdgeRoutes = {
     EdgeCDPWebSocketRoute: 'EdgeCDPWebSocketRoute',
     EdgeContentPostRoute: 'EdgeContentPostRoute',
     EdgeDownloadPostRoute: 'EdgeDownloadPostRoute',
+    EdgeFunctionConnectWebSocketRoute: 'EdgeFunctionConnectWebSocketRoute',
     EdgeFunctionPostRoute: 'EdgeFunctionPostRoute',
     EdgeJSONListGetRoute: 'EdgeJSONListGetRoute',
     EdgeJSONNewPutRoute: 'EdgeJSONNewPutRoute',
@@ -200,6 +202,7 @@ export const BrowserlessChromiumRoutes = {
     ChromiumCDPWebSocketRoute: 'ChromiumCDPWebSocketRoute',
     ChromiumContentPostRoute: 'ChromiumContentPostRoute',
     ChromiumDownloadPostRoute: 'ChromiumDownloadPostRoute',
+    ChromiumFunctionConnectWebSocketRoute: 'ChromiumFunctionConnectWebSocketRoute',
     ChromiumFunctionPostRoute: 'ChromiumFunctionPostRoute',
     ChromiumJSONListGetRoute: 'ChromiumJSONListGetRoute',
     ChromiumJSONNewPutRoute: 'ChromiumJSONNewPutRoute',