@browserless.io/browserless 2.36.0 → 2.37.1

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;
@@ -353,6 +354,12 @@ export class BrowserManager {
             ...routerOptions,
             ...parsedLaunchOptions,
         };
+        const proxyServerParam = req.parsed.searchParams.get('--proxy-server');
+        if (proxyServerParam) {
+            const existingArgs = launchOptions.args || [];
+            const filteredArgs = existingArgs.filter((arg) => !arg.includes('--proxy-server='));
+            launchOptions.args = [...filteredArgs, `--proxy-server=${proxyServerParam}`];
+        }
         const manualUserDataDir = launchOptions.args
             ?.find((arg) => arg.includes('--user-data-dir='))
             ?.split('=')[1] || launchOptions.userDataDir;
@@ -366,6 +373,15 @@ export class BrowserManager {
                 ? await generateDataDir(undefined, this.config)
                 : null);
         const proxyServerArg = launchOptions.args?.find((arg) => arg.includes('--proxy-server='));
+        /**
+         * Handle deprecated launch options
+         */
+        if (Object.hasOwn(launchOptions, 'ignoreHTTPSErrors')) {
+            if (!Object.hasOwn(launchOptions, 'acceptInsecureCerts')) {
+                launchOptions.acceptInsecureCerts = launchOptions.ignoreHTTPSErrors;
+            }
+            delete launchOptions.ignoreHTTPSErrors;
+        }
         /**
          * If it is a playwright request
          */

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/http/content.post.query.json

@@ -96,6 +96,9 @@
         "ignoreHTTPSErrors": {
           "type": "boolean"
         },
+        "acceptInsecureCerts": {
+          "type": "boolean"
+        },
         "slowMo": {
           "type": "number"
         },

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

@@ -97,6 +97,9 @@
         "ignoreHTTPSErrors": {
           "type": "boolean"
         },
+        "acceptInsecureCerts": {
+          "type": "boolean"
+        },
         "slowMo": {
           "type": "number"
         },

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

@@ -97,6 +97,9 @@
         "ignoreHTTPSErrors": {
           "type": "boolean"
         },
+        "acceptInsecureCerts": {
+          "type": "boolean"
+        },
         "slowMo": {
           "type": "number"
         },

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

@@ -97,6 +97,9 @@
         "ignoreHTTPSErrors": {
           "type": "boolean"
         },
+        "acceptInsecureCerts": {
+          "type": "boolean"
+        },
         "slowMo": {
           "type": "number"
         },

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

@@ -97,6 +97,9 @@
         "ignoreHTTPSErrors": {
           "type": "boolean"
         },
+        "acceptInsecureCerts": {
+          "type": "boolean"
+        },
         "slowMo": {
           "type": "number"
         },

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

@@ -96,6 +96,9 @@
         "ignoreHTTPSErrors": {
           "type": "boolean"
         },
+        "acceptInsecureCerts": {
+          "type": "boolean"
+        },
         "slowMo": {
           "type": "number"
         },

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

@@ -97,6 +97,9 @@
         "ignoreHTTPSErrors": {
           "type": "boolean"
         },
+        "acceptInsecureCerts": {
+          "type": "boolean"
+        },
         "slowMo": {
           "type": "number"
         },

package/build/routes/chrome/tests/content.spec.js

@@ -309,4 +309,25 @@ describe('/chrome/content API', function () {
             expect(res.status).to.equal(200);
         });
     });
+    it('can accept insecure certs', async () => {
+        const config = new Config();
+        config.setToken('browserless');
+        const metrics = new Metrics();
+        await start({ config, metrics });
+        const body = {
+            gotoOptions: {
+                waitUntil: `networkidle2`,
+            },
+            url: 'https://self-signed.badssl.com',
+        };
+        await fetch('http://localhost:3000/chrome/content?token=browserless&launch={"acceptInsecureCerts":true}', {
+            body: JSON.stringify(body),
+            headers: {
+                'content-type': 'application/json',
+            },
+            method: 'POST',
+        }).then(async (res) => {
+            expect(res.status).to.equal(200);
+        });
+    });
 });

package/build/routes/chrome/tests/json.spec.js

@@ -0,0 +1,100 @@
+import { Browserless, Config, Metrics } from '@browserless.io/browserless';
+import { expect } from 'chai';
+describe('/json/ API', function () {
+    let browserless;
+    const start = ({ config = new Config(), metrics = new Metrics(), } = {}) => {
+        browserless = new Browserless({ config, metrics });
+        return browserless.start();
+    };
+    afterEach(async () => {
+        await browserless.stop();
+    });
+    it('allows requests to /json/version', async () => {
+        const config = new Config();
+        config.setToken('browserless');
+        const metrics = new Metrics();
+        await start({ config, metrics });
+        const res = await fetch('http://localhost:3000/json/version?token=browserless');
+        const resJSON = await res.json();
+        [
+            'Browser',
+            'Protocol-Version',
+            'User-Agent',
+            'V8-Version',
+            'WebKit-Version',
+            'webSocketDebuggerUrl',
+            'Debugger-Version',
+        ].forEach((k) => expect(resJSON).to.haveOwnProperty(k));
+    });
+    it('rejects unauthorized requests to /json/version', async () => {
+        const config = new Config();
+        config.setToken('browserless');
+        const metrics = new Metrics();
+        await start({ config, metrics });
+        const res = await fetch('http://localhost:3000/json/version?token=imabadboi');
+        expect(res.status).to.equal(401);
+    });
+    it('rejects unauthorized requests to /json/list', async () => {
+        const config = new Config();
+        config.setToken('browserless');
+        const metrics = new Metrics();
+        await start({ config, metrics });
+        const res = await fetch('http://localhost:3000/json/list?token=imabadboi');
+        expect(res.status).to.equal(401);
+    });
+    it('allows requests to /json/protocol', async () => {
+        const config = new Config();
+        config.setToken('browserless');
+        const metrics = new Metrics();
+        await start({ config, metrics });
+        const res = await fetch('http://localhost:3000/json/protocol?token=browserless');
+        expect(res.status).to.equal(200);
+        const resJSON = await res.json();
+        expect(resJSON).to.be.an('object');
+        expect(resJSON).to.haveOwnProperty('version');
+        expect(resJSON).to.haveOwnProperty('domains');
+    });
+    it('rejects unauthorized requests to /json/protocol', async () => {
+        const config = new Config();
+        config.setToken('browserless');
+        const metrics = new Metrics();
+        await start({ config, metrics });
+        const res = await fetch('http://localhost:3000/json/protocol?token=imabadboi');
+        expect(res.status).to.equal(401);
+    });
+    it('allows requests to PUT /json/new', async () => {
+        const config = new Config();
+        config.setToken('browserless');
+        const metrics = new Metrics();
+        await start({ config, metrics });
+        const res = await fetch('http://localhost:3000/json/new?token=browserless', {
+            method: 'PUT',
+        });
+        expect(res.status).to.equal(200);
+        const resJSON = await res.json();
+        const keys = [
+            'description',
+            'devtoolsFrontendUrl',
+            'id',
+            'title',
+            'type',
+            'url',
+            'webSocketDebuggerUrl',
+        ];
+        keys.forEach((k) => expect(resJSON).to.haveOwnProperty(k));
+        expect(resJSON.type).to.equal('page');
+        expect(resJSON.title).to.equal('New Tab');
+        expect(resJSON.url).to.equal('about:blank');
+        expect(resJSON.description).to.equal('');
+    });
+    it('rejects unauthorized requests to PUT /json/new', async () => {
+        const config = new Config();
+        config.setToken('browserless');
+        const metrics = new Metrics();
+        await start({ config, metrics });
+        const res = await fetch('http://localhost:3000/json/new?token=imabadboi', {
+            method: 'PUT',
+        });
+        expect(res.status).to.equal(401);
+    });
+});

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/browser.query.json

@@ -97,6 +97,9 @@
         "ignoreHTTPSErrors": {
           "type": "boolean"
         },
+        "acceptInsecureCerts": {
+          "type": "boolean"
+        },
         "slowMo": {
           "type": "number"
         },

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

@@ -97,6 +97,9 @@
         "ignoreHTTPSErrors": {
           "type": "boolean"
         },
+        "acceptInsecureCerts": {
+          "type": "boolean"
+        },
         "slowMo": {
           "type": "number"
         },

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,123 @@
+{
+  "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"
+        },
+        "acceptInsecureCerts": {
+          "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/chrome/ws/page.query.json

@@ -97,6 +97,9 @@
         "ignoreHTTPSErrors": {
           "type": "boolean"
         },
+        "acceptInsecureCerts": {
+          "type": "boolean"
+        },
         "slowMo": {
           "type": "number"
         },

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

@@ -96,6 +96,9 @@
         "ignoreHTTPSErrors": {
           "type": "boolean"
         },
+        "acceptInsecureCerts": {
+          "type": "boolean"
+        },
         "slowMo": {
           "type": "number"
         },

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

@@ -97,6 +97,9 @@
         "ignoreHTTPSErrors": {
           "type": "boolean"
         },
+        "acceptInsecureCerts": {
+          "type": "boolean"
+        },
         "slowMo": {
           "type": "number"
         },

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

@@ -97,6 +97,9 @@
         "ignoreHTTPSErrors": {
           "type": "boolean"
         },
+        "acceptInsecureCerts": {
+          "type": "boolean"
+        },
         "slowMo": {
           "type": "number"
         },

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

@@ -97,6 +97,9 @@
         "ignoreHTTPSErrors": {
           "type": "boolean"
         },
+        "acceptInsecureCerts": {
+          "type": "boolean"
+        },
         "slowMo": {
           "type": "number"
         },

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

@@ -97,6 +97,9 @@
         "ignoreHTTPSErrors": {
           "type": "boolean"
         },
+        "acceptInsecureCerts": {
+          "type": "boolean"
+        },
         "slowMo": {
           "type": "number"
         },

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

@@ -96,6 +96,9 @@
         "ignoreHTTPSErrors": {
           "type": "boolean"
         },
+        "acceptInsecureCerts": {
+          "type": "boolean"
+        },
         "slowMo": {
           "type": "number"
         },

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

@@ -97,6 +97,9 @@
         "ignoreHTTPSErrors": {
           "type": "boolean"
         },
+        "acceptInsecureCerts": {
+          "type": "boolean"
+        },
         "slowMo": {
           "type": "number"
         },

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

@@ -331,4 +331,25 @@ describe('/chromium/content API', function () {
             expect(res.status).to.equal(200);
         });
     });
+    it('can accept insecure certs', async () => {
+        const config = new Config();
+        config.setToken('browserless');
+        const metrics = new Metrics();
+        await start({ config, metrics });
+        const body = {
+            gotoOptions: {
+                waitUntil: `networkidle2`,
+            },
+            url: 'https://self-signed.badssl.com',
+        };
+        await fetch('http://localhost:3000/chromium/content?token=browserless&launch={"acceptInsecureCerts":true}', {
+            body: JSON.stringify(body),
+            headers: {
+                'content-type': 'application/json',
+            },
+            method: 'POST',
+        }).then(async (res) => {
+            expect(res.status).to.equal(200);
+        });
+    });
 });

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

@@ -242,4 +242,31 @@ describe('/chromium/function API', function () {
             expect(res.status).to.equal(200);
         });
     });
+    it('allows --proxy-server query parameter', async () => {
+        const config = new Config();
+        config.setToken('browserless');
+        const metrics = new Metrics();
+        await start({ config, metrics });
+        const body = {
+            code: `export default async function ({ page }) {
+        return Promise.resolve({
+          data: "ok",
+          type: "application/text",
+        });
+      }`,
+            context: {},
+        };
+        await fetch('http://localhost:3000/chromium/function?--proxy-server=test.proxy.com:8080&token=browserless', {
+            body: JSON.stringify(body),
+            headers: {
+                'content-type': 'application/json',
+            },
+            method: 'POST',
+        }).then(async (res) => {
+            const json = await res.json();
+            expect(json).to.have.property('data');
+            expect(json.data).to.equal('ok');
+            expect(res.status).to.equal(200);
+        });
+    });
 });