@browserless.io/browserless 2.36.0 → 2.37.1

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

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.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,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/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"
         },