@browserless.io/browserless 2.24.0-beta-4 → 2.24.0

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

@@ -253,7 +253,7 @@
       ]
     },
     "CookieParam": {
-      "description": "Cookie parameter object",
+      "description": "Cookie parameter object used to set cookies in the page-level cookies\nAPI.",
       "type": "object",
       "properties": {
         "name": {
@@ -321,7 +321,14 @@
         },
         "partitionKey": {
           "description": "Cookie partition key. In Chrome, it matches the top-level site the\npartitioned cookie is available in. In Firefox, it matches the\nsource origin\n(https://w3c.github.io/webdriver-bidi/#type-storage-PartitionKey).",
-          "type": "string"
+          "anyOf": [
+            {
+              "$ref": "#/definitions/CookiePartitionKey"
+            },
+            {
+              "type": "string"
+            }
+          ]
         }
       },
       "additionalProperties": false,
@@ -330,6 +337,24 @@
         "value"
       ]
     },
+    "CookiePartitionKey": {
+      "description": "Represents a cookie partition key in Chrome.",
+      "type": "object",
+      "properties": {
+        "sourceOrigin": {
+          "description": "The site of the top-level URL the browser was visiting at the start of the request\nto the endpoint that set the cookie.\n\nIn Chrome, maps to the CDP's `topLevelSite` partition key.",
+          "type": "string"
+        },
+        "hasCrossSiteAncestor": {
+          "description": "Indicates if the cookie has any ancestors that are cross-site to\nthe topLevelSite.\n\nSupported only in Chrome.",
+          "type": "boolean"
+        }
+      },
+      "additionalProperties": false,
+      "required": [
+        "sourceOrigin"
+      ]
+    },
     "GoToOptions": {
       "type": "object",
       "properties": {
@@ -528,14 +553,14 @@
                 "length": {
                   "type": "number"
                 },
-                "__@toStringTag@304210": {
+                "__@toStringTag@304014": {
                   "type": "string",
                   "const": "Uint8Array"
                 }
               },
               "required": [
                 "BYTES_PER_ELEMENT",
-                "__@toStringTag@304210",
+                "__@toStringTag@304014",
                 "buffer",
                 "byteLength",
                 "byteOffset",
@@ -570,13 +595,13 @@
         "byteLength": {
           "type": "number"
         },
-        "__@toStringTag@304210": {
+        "__@toStringTag@304014": {
           "type": "string"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@toStringTag@304210",
+        "__@toStringTag@304014",
         "byteLength"
       ]
     },
@@ -586,18 +611,18 @@
         "byteLength": {
           "type": "number"
         },
-        "__@species@304248": {
+        "__@species@304052": {
           "$ref": "#/definitions/SharedArrayBuffer"
         },
-        "__@toStringTag@304210": {
+        "__@toStringTag@304014": {
           "type": "string",
           "const": "SharedArrayBuffer"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@species@304248",
-        "__@toStringTag@304210",
+        "__@species@304052",
+        "__@toStringTag@304014",
         "byteLength"
       ]
     },

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

@@ -23,6 +23,10 @@
     "token": {
       "description": "The authorization token",
       "type": "string"
+    },
+    "trackingId": {
+      "description": "Custom session identifier",
+      "type": "string"
     }
   },
   "additionalProperties": false,

package/build/routes/chromium/tests/kill-sessions.spec.d.ts

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,80 @@
+import { Browserless, Config, Metrics } from '@browserless.io/browserless';
+import { expect } from 'chai';
+import puppeteer from 'puppeteer-core';
+describe('/kill API', function () {
+    let browserless;
+    const start = ({ config = new Config(), metrics = new Metrics(), } = {}) => {
+        config.setToken('6R0W53R135510');
+        browserless = new Browserless({ config, metrics });
+        return browserless.start();
+    };
+    afterEach(async () => {
+        await browserless.stop();
+    });
+    it('Kill all sessions', async () => {
+        await start();
+        const browser1 = await puppeteer.connect({
+            browserWSEndpoint: `ws://localhost:3000/chromium?token=6R0W53R135510`,
+        });
+        const browser2 = await puppeteer.connect({
+            browserWSEndpoint: `ws://localhost:3000/chromium?token=6R0W53R135510`,
+        });
+        await fetch('http://localhost:3000/kill/all?token=6R0W53R135510').then(async (res) => {
+            expect(res.status).to.equal(204);
+        });
+        let errorThrown1;
+        try {
+            await browser1.newPage();
+        }
+        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();
+        const browser = await puppeteer.connect({
+            browserWSEndpoint: `ws://localhost:3000/chromium?token=6R0W53R135510`,
+        });
+        await fetch('http://localhost:3000/sessions?token=6R0W53R135510').then(async (res) => {
+            const sessions = await res.json();
+            const browserId = sessions[0].browserId;
+            await fetch(`http://localhost:3000/kill/${browserId}?token=6R0W53R135510`).then(async (res) => {
+                expect(res.status).to.equal(204);
+            });
+        });
+        let errorThrown;
+        try {
+            await browser.newPage();
+        }
+        catch (e) {
+            errorThrown = e;
+        }
+        expect(errorThrown.message).contains('closed');
+    });
+    it('Kill session by trackingId', async () => {
+        await start();
+        const browser = await puppeteer.connect({
+            browserWSEndpoint: `ws://localhost:3000/chromium?token=6R0W53R135510&trackingId=session-1`,
+        });
+        await fetch('http://localhost:3000/kill/session-1?token=6R0W53R135510').then(async (res) => {
+            expect(res.status).to.equal(204);
+        });
+        let errorThrown;
+        try {
+            await browser.newPage();
+        }
+        catch (e) {
+            errorThrown = e;
+        }
+        expect(errorThrown.message).contains('closed');
+    });
+});

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

@@ -386,4 +386,27 @@ describe('Chromium WebSocket API', function () {
         });
         await browser.disconnect();
     });
+    it('Throws an error while creating a session with invalid trackingId', async () => {
+        await start();
+        const didError = await puppeteer
+            .connect({
+            browserWSEndpoint: `ws://localhost:3000/chromium?trackingId=all`,
+        })
+            .then(() => false)
+            .catch(() => true);
+        expect(didError).to.be.true;
+    });
+    it('Throws an error while creating a session with duplicated trackingId', async () => {
+        await start();
+        await puppeteer.connect({
+            browserWSEndpoint: `ws://localhost:3000/chromium?trackingId=duplicated`,
+        });
+        const didError = await puppeteer
+            .connect({
+            browserWSEndpoint: `ws://localhost:3000/chromium?trackingId=duplicated`,
+        })
+            .then(() => false)
+            .catch(() => true);
+        expect(didError).to.be.true;
+    });
 });

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

@@ -23,6 +23,10 @@
     "token": {
       "description": "The authorization token",
       "type": "string"
+    },
+    "trackingId": {
+      "description": "Custom session identifier",
+      "type": "string"
     }
   },
   "additionalProperties": false,

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

@@ -23,6 +23,10 @@
     "token": {
       "description": "The authorization token",
       "type": "string"
+    },
+    "trackingId": {
+      "description": "Custom session identifier",
+      "type": "string"
     }
   },
   "additionalProperties": false,

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

@@ -23,6 +23,10 @@
     "token": {
       "description": "The authorization token",
       "type": "string"
+    },
+    "trackingId": {
+      "description": "Custom session identifier",
+      "type": "string"
     }
   },
   "additionalProperties": false,

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

@@ -23,6 +23,10 @@
     "token": {
       "description": "The authorization token",
       "type": "string"
+    },
+    "trackingId": {
+      "description": "Custom session identifier",
+      "type": "string"
     }
   },
   "additionalProperties": false,

package/build/routes/firefox/tests/kill-sessions.spec.d.ts

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,72 @@
+import { Browserless, Config, Metrics } from '@browserless.io/browserless';
+import { expect } from 'chai';
+import { firefox } from 'playwright-core';
+describe('/kill API firefox', function () {
+    let browserless;
+    const start = ({ config = new Config(), metrics = new Metrics(), } = {}) => {
+        config.setToken('browserless');
+        browserless = new Browserless({ config, metrics });
+        return browserless.start();
+    };
+    afterEach(async () => {
+        await browserless.stop();
+    });
+    it('Kill all sessions', async () => {
+        await start();
+        const browser1 = await firefox.connect(`ws://localhost:3000/playwright/firefox?token=browserless`);
+        const browser2 = await firefox.connect(`ws://localhost:3000/playwright/firefox?token=browserless`);
+        await fetch('http://localhost:3000/kill/all?token=browserless').then(async (res) => {
+            expect(res.status).to.equal(204);
+        });
+        let errorThrown1;
+        try {
+            await browser1.newPage();
+        }
+        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();
+        const browser = await firefox.connect(`ws://localhost:3000/playwright/firefox?token=browserless`);
+        await fetch('http://localhost:3000/sessions?token=browserless').then(async (res) => {
+            const sessions = await res.json();
+            const browserId = sessions[0].browserId;
+            await fetch(`http://localhost:3000/kill/${browserId}?token=browserless`).then(async (res) => {
+                expect(res.status).to.equal(204);
+            });
+        });
+        let errorThrown;
+        try {
+            await browser.newPage();
+        }
+        catch (e) {
+            errorThrown = e;
+        }
+        expect(errorThrown.message).contains('closed');
+    });
+    it('Kill session by trackingId', async () => {
+        await start();
+        const browser = await firefox.connect(`ws://localhost:3000/playwright/firefox?token=browserless&trackingId=session-1`);
+        await fetch('http://localhost:3000/kill/session-1?token=browserless').then(async (res) => {
+            expect(res.status).to.equal(204);
+        });
+        let errorThrown;
+        try {
+            await browser.newPage();
+        }
+        catch (e) {
+            errorThrown = e;
+        }
+        expect(errorThrown.message).contains('closed');
+    });
+});

package/build/routes/firefox/ws/playwright.query.json

@@ -87,6 +87,10 @@
     "token": {
       "description": "The authorization token",
       "type": "string"
+    },
+    "trackingId": {
+      "description": "Custom session identifier",
+      "type": "string"
     }
   },
   "additionalProperties": false,

package/build/routes/management/http/kill.get.d.ts

@@ -0,0 +1,21 @@
+import { APITags, HTTPManagementRoutes, HTTPRoute, Methods, Request, SystemQueryParameters, contentTypes } from '@browserless.io/browserless';
+import { ServerResponse } from 'http';
+export type ResponseSchema = string;
+export interface QuerySchema extends SystemQueryParameters {
+    token: string;
+    browserId?: string;
+    trackingId?: string;
+}
+export default class KillGetRoute extends HTTPRoute {
+    name: string;
+    accepts: contentTypes[];
+    auth: boolean;
+    browser: null;
+    concurrency: boolean;
+    contentTypes: contentTypes[];
+    description: string;
+    method: Methods;
+    path: HTTPManagementRoutes;
+    tags: APITags[];
+    handler(req: Request, res: ServerResponse): Promise<void>;
+}

package/build/routes/management/http/kill.get.js

@@ -0,0 +1,19 @@
+import { APITags, BrowserlessRoutes, HTTPManagementRoutes, HTTPRoute, Methods, contentTypes, writeResponse, } from '@browserless.io/browserless';
+export default class KillGetRoute extends HTTPRoute {
+    name = BrowserlessRoutes.KillGetRoute;
+    accepts = [contentTypes.any];
+    auth = true;
+    browser = null;
+    concurrency = false;
+    contentTypes = [contentTypes.json];
+    description = `Kill running sessions based on BrowserId or TrackingId.`;
+    method = Methods.get;
+    path = HTTPManagementRoutes.kill;
+    tags = [APITags.management];
+    async handler(req, res) {
+        const target = req.parsed.pathname.split('/')[2];
+        const browserManager = this.browserManager();
+        await browserManager.killSessions(target);
+        return writeResponse(res, 204, '');
+    }
+}

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

@@ -0,0 +1,193 @@
+{
+  "type": "object",
+  "properties": {
+    "token": {
+      "description": "The authorization token",
+      "type": "string"
+    },
+    "browserId": {
+      "type": "string"
+    },
+    "trackingId": {
+      "description": "Custom session identifier",
+      "type": "string"
+    },
+    "blockAds": {
+      "description": "Whether or nor to load ad-blocking extensions for the session.\nThis currently uses uBlock Origin and may cause certain sites\nto not load properly.",
+      "type": "boolean"
+    },
+    "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"
+        },
+        {
+          "$ref": "#/definitions/BrowserServerOptions"
+        },
+        {
+          "type": "string"
+        }
+      ]
+    },
+    "timeout": {
+      "description": "Override the system-level timeout for this request.\nAccepts a value in milliseconds.",
+      "type": "number"
+    }
+  },
+  "additionalProperties": false,
+  "required": [
+    "token"
+  ],
+  "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
+    },
+    "BrowserServerOptions": {
+      "type": "object",
+      "properties": {
+        "args": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "chromiumSandbox": {
+          "type": "boolean"
+        },
+        "devtools": {
+          "type": "boolean"
+        },
+        "downloadsPath": {
+          "type": "string"
+        },
+        "headless": {
+          "type": "boolean"
+        },
+        "ignoreDefaultArgs": {
+          "anyOf": [
+            {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            },
+            {
+              "type": "boolean"
+            }
+          ]
+        },
+        "proxy": {
+          "type": "object",
+          "properties": {
+            "bypass": {
+              "type": "string"
+            },
+            "password": {
+              "type": "string"
+            },
+            "server": {
+              "type": "string"
+            },
+            "username": {
+              "type": "string"
+            }
+          },
+          "additionalProperties": false,
+          "required": [
+            "server"
+          ]
+        },
+        "timeout": {
+          "type": "number"
+        },
+        "tracesDir": {
+          "type": "string"
+        }
+      },
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/build/routes/management/http/meta.get.js

@@ -1,9 +1,10 @@
 import { APITags, BrowserlessRoutes, ChromiumCDP, FirefoxPlaywright, HTTPManagementRoutes, HTTPRoute, Methods, WebKitPlaywright, availableBrowsers, contentTypes, jsonResponse, } from '@browserless.io/browserless';
 import { createRequire } from 'module';
+import path from 'path';
 const semverReg = /(\*|\^|>|=|<|~)/gi;
 const require = createRequire(import.meta.url);
-const blessPackageJSON = require('../../../../package.json');
-const { browsers } = require('../../../../node_modules/playwright-core/browsers.json');
+const blessPackageJSON = require(path.join(process.cwd(), 'package.json'));
+const { browsers } = require(path.join(process.cwd(), 'node_modules', 'playwright-core', 'browsers.json'));
 const chromium = browsers.find((b) => b.name === 'chromium').browserVersion;
 const firefox = browsers.find((b) => b.name === 'firefox').browserVersion;
 const webkit = browsers.find((b) => b.name === 'webkit').browserVersion;

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

@@ -6,6 +6,7 @@
       "type": "string"
     },
     "trackingId": {
+      "description": "Custom session identifier",
       "type": "string"
     },
     "blockAds": {

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

@@ -68,4 +68,16 @@ describe('Management APIs', function () {
             expect(res.status).to.equal(204);
         });
     });
+    it('allows requests to /kill', async () => {
+        await start();
+        await fetch('http://localhost:3000/kill/all?token=6R0W53R135510').then(async (res) => {
+            expect(res.status).to.equal(204);
+        });
+    });
+    it('Throws an error trying to kill invalid session', async () => {
+        await start();
+        await fetch(`http://localhost:3000/kill/invalid-session?token=6R0W53R135510`).then(async (res) => {
+            expect(res.status).to.equal(404);
+        });
+    });
 });

package/build/routes/webkit/tests/kill-sessions.spec.d.ts

@@ -0,0 +1 @@
+export {};