@browserless.io/browserless 2.37.0 → 2.37.1

package/build/browsers/index.js

@@ -354,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;
@@ -367,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/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/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.query.json

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

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);
+        });
+    });
 });

package/build/routes/chromium/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/chromium/ws/browser.query.json

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

@@ -309,4 +309,25 @@ describe('/edge/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/edge/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);
+        });
+    });
 });