@browserless.io/browserless 2.37.0 → 2.38.0

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

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

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

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

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

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

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

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

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

package/build/routes/management/http/kill.get.query.json

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

package/build/routes/management/http/sessions.get.query.json

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

package/build/routes/management/tests/management.spec.js

@@ -95,6 +95,50 @@ describe('Management APIs', function () {
             expect(r.status).to.equal(404);
         });
     });
+    describe('Static Files Serving', () => {
+        it('serves docs pages', async () => {
+            await start();
+            await fetch('http://localhost:3000/docs/index.html?token=6R0W53R135510').then(async (res) => {
+                expect(res.status).to.equal(200);
+                expect(res.headers.get('content-type')).to.equal('text/html');
+                const content = await res.text();
+                expect(content).to.include('<title>Browserless Docs</title>');
+            });
+            await fetch('http://localhost:3000/docs/docs.js?token=6R0W53R135510').then(async (res) => {
+                expect(res.status).to.equal(200);
+                expect(res.headers.get('content-type')).to.equal('application/javascript');
+                const content = await res.text();
+                expect(content).to.be.an('string');
+            });
+        });
+        it('serves swagger.json', async () => {
+            await start();
+            await fetch('http://localhost:3000/docs/swagger.json?token=6R0W53R135510').then(async (res) => {
+                expect(res.status).to.equal(200);
+                expect(res.headers.get('content-type')).to.equal('application/json');
+                const content = await res.json();
+                expect(content).to.be.an('object');
+            });
+        });
+        it('returns 404 if debugger is disabled', async () => {
+            process.env.ENABLE_DEBUGGER = 'false';
+            const config = new Config();
+            config.setToken('6R0W53R135510');
+            // Ensure debugger is not available
+            await start({ config });
+            await fetch('http://localhost:3000/debugger/some-file.html?token=6R0W53R135510').then(async (res) => {
+                expect(res.status).to.equal(404);
+                expect(res.headers.get('content-type')).to.equal('text/plain; charset=UTF-8');
+            });
+        });
+        it('handles requests without authentication token for static files', async () => {
+            await start();
+            await fetch('http://localhost:3000/docs/index.html').then(async (res) => {
+                expect(res.status).to.equal(200);
+                expect(res.headers.get('content-type')).to.equal('text/html');
+            });
+        });
+    });
     it('allows requests to /config', async () => {
         await start();
         await fetch('http://localhost:3000/config?token=6R0W53R135510').then(async (res) => {

package/build/server.js

@@ -242,7 +242,7 @@ export class HTTPServer extends EventEmitter {
     }
     async shutdown() {
         this.logger.info(`HTTP Server is shutting down`);
-        await new Promise((r) => this.server.close(r));
+        await new Promise((r) => this.server?.close(r));
         if (this.server) {
             this.server.removeAllListeners();
         }

package/build/shim.js

@@ -1,5 +1,5 @@
 import { convertIfBase64, safeParse, } from '@browserless.io/browserless';
-const shimParam = ['headless', 'stealth', 'ignoreDefaultArgs', 'slowMo'];
+const shimParam = ['headless', 'stealth', 'ignoreDefaultArgs', 'slowMo', 'ignoreHTTPSErrors'];
 /**
  * Obfuscates the ?token parameter by shifting it to a header instead of a query-parameter.
  */
@@ -49,6 +49,16 @@ export function shimLegacyRequests(url) {
             launchParams.ignoreHTTPSErrors === undefined) {
             launchParams.ignoreHTTPSErrors = ignoreHTTPSErrors !== 'false';
         }
+        // When acceptInsecureCerts is set, ignoreHTTPSErrors is ignored
+        if (launchParams.acceptInsecureCerts !== undefined) {
+            launchParams.ignoreHTTPSErrors = undefined;
+        }
+        // When ignoreHTTPSErrors sent, convert it to acceptInsecureCerts
+        if (typeof ignoreHTTPSErrors !== 'undefined' &&
+            launchParams.acceptInsecureCerts === undefined) {
+            launchParams.acceptInsecureCerts = ignoreHTTPSErrors !== 'false';
+            launchParams.ignoreHTTPSErrors = undefined;
+        }
         if (typeof ignoreDefaultArgs !== 'undefined' &&
             launchParams.ignoreDefaultArgs === undefined) {
             const parsed = typeof ignoreDefaultArgs === 'string' && ignoreDefaultArgs.includes(',')

package/build/shim.spec.js

@@ -125,6 +125,20 @@ describe('Request Shimming', () => {
             expect(decodeURIComponent(shimmed.href)).to.equal(final);
         });
     });
+    describe('insecure certs', () => {
+        it('converts ignoreHTTPSErrors to acceptInsecureCerts', () => {
+            const url = 'wss://localhost?ignoreHTTPSErrors';
+            const final = 'wss://localhost/?launch={"acceptInsecureCerts":true}';
+            const shimmed = shimLegacyRequests(new URL(url));
+            expect(decodeURIComponent(shimmed.href)).to.equal(final);
+        });
+        it('acceptInsecureCerts takes precedence over ignoreHTTPSErrors', () => {
+            const url = 'wss://localhost?ignoreHTTPSErrors&launch={"acceptInsecureCerts":false}';
+            const final = 'wss://localhost/?launch={"acceptInsecureCerts":false}';
+            const shimmed = shimLegacyRequests(new URL(url));
+            expect(decodeURIComponent(shimmed.href)).to.equal(final);
+        });
+    });
     describe('token shimming', () => {
         it('converts token query parameters to an authorization header', () => {
             const url = 'wss://localhost?token=12345';

package/build/types.d.ts

@@ -262,7 +262,9 @@ export interface CDPLaunchOptions extends BrowserlessLaunch {
     dumpio?: boolean;
     headless?: boolean | 'shell';
     ignoreDefaultArgs?: boolean | string[];
+    /** @deprecated use acceptInsecureCerts field instead */
     ignoreHTTPSErrors?: boolean;
+    acceptInsecureCerts?: boolean;
     slowMo?: number;
     stealth?: boolean;
     timeout?: number;

package/extensions/ublocklite/_locales/ar/messages.json

@@ -264,15 +264,15 @@
     "description": "Short description for a checkbox in the options page"
   },
   "settingsBackupRestoreLabel": {
-    "message": "Backup",
+    "message": "النسخ الاحتياطي",
     "description": "The header text for the back up/restore section"
   },
   "settingsBackupRestoreSummary": {
-    "message": "Back up your custom settings to a file, or restore your custom settings from a file.",
+    "message": "قم بنسخ الإعدادات المخصصة احتياطيًا إلى ملف، أو استعادة الإعدادات المخصصة من ملف.",
     "description": "A summary description of the back up/restore section."
   },
   "settingsBackupRestoreLegend": {
-    "message": "Restoring will overwrite all your current custom settings.",
+    "message": "ستؤدي عملية الاستعادة إلى استبدال جميع إعداداتك المخصصة الحالية.",
     "description": "Important information about the back up/restore section."
   },
   "findListsPlaceholder": {
@@ -376,11 +376,11 @@
     "description": "Text for buttons used to export content"
   },
   "backupButton": {
-    "message": "Back up…",
+    "message": "نسخ احتياطي…",
     "description": "Text for buttons used to back up content"
   },
   "restoreButton": {
-    "message": "Restore…",
+    "message": "استعادة…",
     "description": "Text for buttons used to restore content"
   },
   "dnrRulesWarning": {

package/extensions/ublocklite/_locales/br_FR/messages.json

@@ -264,7 +264,7 @@
     "description": "Short description for a checkbox in the options page"
   },
   "settingsBackupRestoreLabel": {
-    "message": "Backup",
+    "message": "Gwared",
     "description": "The header text for the back up/restore section"
   },
   "settingsBackupRestoreSummary": {
@@ -376,7 +376,7 @@
     "description": "Text for buttons used to export content"
   },
   "backupButton": {
-    "message": "Back up…",
+    "message": "Gwarediñ…",
     "description": "Text for buttons used to back up content"
   },
   "restoreButton": {

package/extensions/ublocklite/_locales/cs/messages.json

@@ -20,7 +20,7 @@
     "description": "appears as tab name in dashboard"
   },
   "customFiltersPageName": {
-    "message": "Custom filters",
+    "message": "Vlastní filtry",
     "description": "appears as tab name in dashboard"
   },
   "developPageName": {
@@ -92,7 +92,7 @@
     "description": "Text label heading the import/export area of custom filters"
   },
   "customFiltersImportTextareaPlaceholder": {
-    "message": "Paste here specific cosmetic filters to add",
+    "message": "Vložte sem konkrétní kosmetické filtry, které chcete přidat",
     "description": "Placeholder text which describes the purpose of the textarea widget"
   },
   "aboutChangelog": {
@@ -264,15 +264,15 @@
     "description": "Short description for a checkbox in the options page"
   },
   "settingsBackupRestoreLabel": {
-    "message": "Backup",
+    "message": "Záloha",
     "description": "The header text for the back up/restore section"
   },
   "settingsBackupRestoreSummary": {
-    "message": "Back up your custom settings to a file, or restore your custom settings from a file.",
+    "message": "Zálohování vlastních nastavení do souboru nebo obnovení vlastních nastavení ze souboru.",
     "description": "A summary description of the back up/restore section."
   },
   "settingsBackupRestoreLegend": {
-    "message": "Restoring will overwrite all your current custom settings.",
+    "message": "Obnovení přepíše všechna vaše aktuální vlastní nastavení.",
     "description": "Important information about the back up/restore section."
   },
   "findListsPlaceholder": {
@@ -364,7 +364,7 @@
     "description": "Text for buttons used to revert changes"
   },
   "addButton": {
-    "message": "Add",
+    "message": "Přidat",
     "description": "Text for buttons used to add content"
   },
   "importAndAppendButton": {
@@ -376,11 +376,11 @@
     "description": "Text for buttons used to export content"
   },
   "backupButton": {
-    "message": "Back up…",
+    "message": "Zálohovat…",
     "description": "Text for buttons used to back up content"
   },
   "restoreButton": {
-    "message": "Restore…",
+    "message": "Obnovit…",
     "description": "Text for buttons used to restore content"
   },
   "dnrRulesWarning": {

package/extensions/ublocklite/_locales/da/messages.json

@@ -264,15 +264,15 @@
     "description": "Short description for a checkbox in the options page"
   },
   "settingsBackupRestoreLabel": {
-    "message": "Backup",
+    "message": "Sikkerhedskopiér",
     "description": "The header text for the back up/restore section"
   },
   "settingsBackupRestoreSummary": {
-    "message": "Back up your custom settings to a file, or restore your custom settings from a file.",
+    "message": "Sikkerhedskopiér tilpassede indstillinger til en fil, eller gendan tilpassede indstillinger fra en fil.",
     "description": "A summary description of the back up/restore section."
   },
   "settingsBackupRestoreLegend": {
-    "message": "Restoring will overwrite all your current custom settings.",
+    "message": "Gendannelse overskriver alle nuværende tilpassede indstillinger.",
     "description": "Important information about the back up/restore section."
   },
   "findListsPlaceholder": {
@@ -376,11 +376,11 @@
     "description": "Text for buttons used to export content"
   },
   "backupButton": {
-    "message": "Back up…",
+    "message": "Sikkerhedskopiér…",
     "description": "Text for buttons used to back up content"
   },
   "restoreButton": {
-    "message": "Restore…",
+    "message": "Gendan…",
     "description": "Text for buttons used to restore content"
   },
   "dnrRulesWarning": {

package/extensions/ublocklite/_locales/de/messages.json

@@ -264,7 +264,7 @@
     "description": "Short description for a checkbox in the options page"
   },
   "settingsBackupRestoreLabel": {
-    "message": "Sichern und wiederherstellen",
+    "message": "Sicherung",
     "description": "The header text for the back up/restore section"
   },
   "settingsBackupRestoreSummary": {

package/extensions/ublocklite/_locales/es/messages.json

@@ -264,15 +264,15 @@
     "description": "Short description for a checkbox in the options page"
   },
   "settingsBackupRestoreLabel": {
-    "message": "Copia de seg.",
+    "message": "Respaldar",
     "description": "The header text for the back up/restore section"
   },
   "settingsBackupRestoreSummary": {
-    "message": "Haz una copia de seguridad de tus ajustes personalizados en un archivo o restaura tus ajustes personalizados desde uno.",
+    "message": "Haz un respaldo de tu configuración personalizada en un archivo o restaura tu configuración personalizada desde uno.",
     "description": "A summary description of the back up/restore section."
   },
   "settingsBackupRestoreLegend": {
-    "message": "Al restaurar se sobrescribirán todos tus ajustes personalizados actuales.",
+    "message": "La restauración sobrescribirá toda tu configuración personalizada actual.",
     "description": "Important information about the back up/restore section."
   },
   "findListsPlaceholder": {
@@ -376,7 +376,7 @@
     "description": "Text for buttons used to export content"
   },
   "backupButton": {
-    "message": "Hacer copia…",
+    "message": "Respaldar…",
     "description": "Text for buttons used to back up content"
   },
   "restoreButton": {

package/extensions/ublocklite/_locales/fa/messages.json

@@ -132,7 +132,7 @@
     "description": "First paragraph of 'Filter issues' section in Support pane"
   },
   "supportS5H": {
-    "message": "Troubleshooting information",
+    "message": "اطلاعات مشکل‌گشایی",
     "description": "Label of 'Troubleshooting information' section in 'Report a filter issue' page"
   },
   "supportS6P1S1": {
@@ -144,7 +144,7 @@
     "description": "A clickable link in the filter issue reporter section"
   },
   "supportS6URL": {
-    "message": "Address of the webpage:",
+    "message": "آدرس صفحه‌ی وب:",
     "description": "Label for the URL of the page"
   },
   "supportS6Select1": {
@@ -152,15 +152,15 @@
     "description": "Label for widget to select type of issue"
   },
   "supportS6Select1Option0": {
-    "message": "-- Pick an entry --",
+    "message": "-- یک گزینه را انتخاب کنید --",
     "description": "An entry in the widget used to select the type of issue"
   },
   "supportS6Select1Option1": {
-    "message": "Shows ads or ad leftovers",
+    "message": "تبلیغات یا باقی‌مانده‌هایی از آن نشان می‌دهد",
     "description": "An entry in the widget used to select the type of issue"
   },
   "supportS6Select1Option2": {
-    "message": "Has overlays or other nuisances",
+    "message": "دارای لایه‌های اضافی یا مشکلات مزاحم دیگر",
     "description": "An entry in the widget used to select the type of issue"
   },
   "supportS6Select1Option3": {
@@ -168,7 +168,7 @@
     "description": "An entry in the widget used to select the type of issue"
   },
   "supportS6Select1Option4": {
-    "message": "Has privacy-related issues",
+    "message": "دارای ایراد مربوط به حریم خصوصی است",
     "description": "An entry in the widget used to select the type of issue"
   },
   "supportS6Select1Option5": {
@@ -176,11 +176,11 @@
     "description": "An entry in the widget used to select the type of issue"
   },
   "supportS6Select1Option6": {
-    "message": "Opens unwanted tabs or windows",
+    "message": "تب یا پنجره‌ی ناخواسته باز می‌کند",
     "description": "An entry in the widget used to select the type of issue"
   },
   "supportS6Select1Option7": {
-    "message": "Leads to badware, phishing",
+    "message": "منجر به بدافزار یا فیشینگ می‌شود",
     "description": "An entry in the widget used to select the type of issue"
   },
   "supportS6Checkbox1": {

package/extensions/ublocklite/_locales/gl/messages.json

@@ -264,15 +264,15 @@
     "description": "Short description for a checkbox in the options page"
   },
   "settingsBackupRestoreLabel": {
-    "message": "Backup",
+    "message": "Copia de apoio",
     "description": "The header text for the back up/restore section"
   },
   "settingsBackupRestoreSummary": {
-    "message": "Back up your custom settings to a file, or restore your custom settings from a file.",
+    "message": "Garda nun ficheiro a túa configuración ou restablece os axustes desde un ficheiro.",
     "description": "A summary description of the back up/restore section."
   },
   "settingsBackupRestoreLegend": {
-    "message": "Restoring will overwrite all your current custom settings.",
+    "message": "Ao restablecer vas sobrescribir a configuración actual.",
     "description": "Important information about the back up/restore section."
   },
   "findListsPlaceholder": {
@@ -376,11 +376,11 @@
     "description": "Text for buttons used to export content"
   },
   "backupButton": {
-    "message": "Back up…",
+    "message": "Gardar axustes…",
     "description": "Text for buttons used to back up content"
   },
   "restoreButton": {
-    "message": "Restore…",
+    "message": "Restablecer…",
     "description": "Text for buttons used to restore content"
   },
   "dnrRulesWarning": {

package/extensions/ublocklite/_locales/hu/messages.json

@@ -264,15 +264,15 @@
     "description": "Short description for a checkbox in the options page"
   },
   "settingsBackupRestoreLabel": {
-    "message": "Backup",
+    "message": "Biztonsági mentés",
     "description": "The header text for the back up/restore section"
   },
   "settingsBackupRestoreSummary": {
-    "message": "Back up your custom settings to a file, or restore your custom settings from a file.",
+    "message": "Egyéni beállítások fájlbamentése, vagy az egyéni beállítások helyreállítása egy fájlból.",
     "description": "A summary description of the back up/restore section."
   },
   "settingsBackupRestoreLegend": {
-    "message": "Restoring will overwrite all your current custom settings.",
+    "message": "A helyreállítás felülírja a jelenlegi egyéni beállításokat.",
     "description": "Important information about the back up/restore section."
   },
   "findListsPlaceholder": {
@@ -376,11 +376,11 @@
     "description": "Text for buttons used to export content"
   },
   "backupButton": {
-    "message": "Back up…",
+    "message": "Biztonsági mentés…",
     "description": "Text for buttons used to back up content"
   },
   "restoreButton": {
-    "message": "Restore…",
+    "message": "Helyreállítás…",
     "description": "Text for buttons used to restore content"
   },
   "dnrRulesWarning": {