@browserless.io/browserless 2.9.0 → 2.11.0

package/CHANGELOG.md

@@ -1,4 +1,13 @@
-# [Latest](https://github.com/browserless/chrome/compare/v2.9.0...main)
+# [Latest](https://github.com/browserless/chrome/compare/v2.11.0...main)
+- Dependency updates.
+
+# [v2.11.0](https://github.com/browserless/chrome/compare/v2.10.0...v2.11.0)
+- Wrap the pressure response in a pressure key.
+- New `keepAlive` property on browser objects for downstream SDK projects to flag.
+- Dependency updates.
+
+# [v2.10.0](https://github.com/browserless/chrome/compare/v2.9.0...v2.10.0)
+- Adds back in the `/pressure` API from V1.
 - Dependency updates.
 
 # [v2.9.0](https://github.com/browserless/chrome/compare/v2.8.0...v2.9.0)

package/build/browserless.js

@@ -147,11 +147,12 @@ export class Browserless extends EventEmitter {
                 }));
                 const routeImport = `${this.config.getIsWin() ? 'file:///' : ''}${httpRoute}`;
                 const { default: Route, } = await import(routeImport + `?cb=${Date.now()}`);
-                const route = new Route(this.browserManager, this.config, this.fileSystem, this.metrics, this.monitoring, this.staticSDKDir);
+                const route = new Route(this.browserManager, this.config, this.fileSystem, this.metrics, this.monitoring, this.staticSDKDir, this.limiter);
                 if (!this.routeIsDisabled(route)) {
                     route.bodySchema = safeParse(bodySchema);
                     route.querySchema = safeParse(querySchema);
                     route.config = () => this.config;
+                    route.limiter = () => this.limiter;
                     route.metrics = () => this.metrics;
                     route.monitoring = () => this.monitoring;
                     route.fileSystem = () => this.fileSystem;
@@ -173,10 +174,11 @@ export class Browserless extends EventEmitter {
                 }));
                 const wsImport = `${this.config.getIsWin() ? 'file:///' : ''}${wsRoute}`;
                 const { default: Route, } = await import(wsImport + `?cb=${Date.now()}`);
-                const route = new Route(this.browserManager, this.config, this.fileSystem, this.metrics, this.monitoring, this.staticSDKDir);
+                const route = new Route(this.browserManager, this.config, this.fileSystem, this.metrics, this.monitoring, this.staticSDKDir, this.limiter);
                 if (!this.routeIsDisabled(route)) {
                     route.querySchema = safeParse(querySchema);
                     route.config = () => this.config;
+                    route.limiter = () => this.limiter;
                     route.metrics = () => this.metrics;
                     route.monitoring = () => this.monitoring;
                     route.fileSystem = () => this.fileSystem;

package/build/browsers/chromium.cdp.d.ts

@@ -26,6 +26,7 @@ export declare class ChromiumCDP extends EventEmitter {
         userDataDir: ChromiumCDP['userDataDir'];
     });
     protected cleanListeners(): void;
+    keepAlive(): boolean;
     getPageId: (page: Page) => string;
     protected onTargetCreated: (target: Target) => Promise<void>;
     isRunning: () => boolean;

package/build/browsers/chromium.cdp.js

@@ -32,6 +32,9 @@ export class ChromiumCDP extends EventEmitter {
         this.browser?.removeAllListeners();
         this.removeAllListeners();
     }
+    keepAlive() {
+        return false;
+    }
     getPageId = (page) => {
         // @ts-ignore
         return page.target()._targetId;

package/build/browsers/chromium.playwright.d.ts

@@ -22,6 +22,7 @@ export declare class ChromiumPlaywright extends EventEmitter {
         userDataDir: ChromiumPlaywright['userDataDir'];
     });
     protected cleanListeners(): void;
+    keepAlive(): boolean;
     isRunning: () => boolean;
     close: () => Promise<void>;
     pages: () => Promise<[]>;

package/build/browsers/chromium.playwright.js

@@ -22,6 +22,9 @@ export class ChromiumPlaywright extends EventEmitter {
     cleanListeners() {
         this.removeAllListeners();
     }
+    keepAlive() {
+        return false;
+    }
     isRunning = () => this.running;
     close = async () => {
         if (this.browser) {

package/build/browsers/firefox.playwright.d.ts

@@ -21,6 +21,7 @@ export declare class FirefoxPlaywright extends EventEmitter {
         userDataDir: FirefoxPlaywright['userDataDir'];
     });
     protected cleanListeners(): void;
+    keepAlive(): boolean;
     isRunning: () => boolean;
     close: () => Promise<void>;
     pages: () => Promise<[]>;

package/build/browsers/firefox.playwright.js

@@ -21,6 +21,9 @@ export class FirefoxPlaywright extends EventEmitter {
     cleanListeners() {
         this.removeAllListeners();
     }
+    keepAlive() {
+        return false;
+    }
     isRunning = () => this.running;
     close = async () => {
         if (this.browser) {

package/build/browsers/index.d.ts

@@ -4,7 +4,6 @@ export declare class BrowserManager {
     protected config: Config;
     protected hooks: Hooks;
     protected browsers: Map<BrowserInstance, BrowserlessSession>;
-    protected launching: Map<string, Promise<unknown>>;
     protected timers: Map<string, number>;
     protected log: Logger;
     protected chromeBrowsers: (typeof ChromiumCDP)[];

package/build/browsers/index.js

@@ -5,7 +5,6 @@ export class BrowserManager {
     config;
     hooks;
     browsers = new Map();
-    launching = new Map();
     timers = new Map();
     log = new Logger('browser-manager');
     chromeBrowsers = [ChromiumCDP, ChromeCDP];
@@ -182,7 +181,7 @@ export class BrowserManager {
         const cleanupACtions = [];
         this.log.info(`${session.numbConnected} Client(s) are currently connected`);
         // Don't close if there's clients still connected
-        if (session.numbConnected > 0) {
+        if (session.numbConnected > 0 || browser.keepAlive()) {
             return;
         }
         this.log.info(`Closing browser session`);
@@ -212,7 +211,6 @@ export class BrowserManager {
         const { id, resolver } = session;
         if (id && resolver) {
             resolver(null);
-            this.launching.delete(id);
         }
         --session.numbConnected;
         this.close(browser, session);
@@ -306,7 +304,7 @@ export class BrowserManager {
             logger,
             userDataDir,
         });
-        const connectionMeta = {
+        const session = {
             id: null,
             initialConnectURL: path.join(req.parsed.pathname, req.parsed.search) || '',
             isTempDataDir: !manualUserDataDir,
@@ -318,7 +316,7 @@ export class BrowserManager {
             ttl: 0,
             userDataDir,
         };
-        this.browsers.set(browser, connectionMeta);
+        this.browsers.set(browser, session);
         await browser.launch(launchOptions);
         await this.hooks.browser({ browser, meta: req.parsed });
         browser.on('newPage', async (page) => {

package/build/browsers/webkit.playwright.d.ts

@@ -21,6 +21,7 @@ export declare class WebkitPlaywright extends EventEmitter {
         userDataDir: WebkitPlaywright['userDataDir'];
     });
     protected cleanListeners(): void;
+    keepAlive(): boolean;
     isRunning: () => boolean;
     close: () => Promise<void>;
     pages: () => Promise<[]>;

package/build/browsers/webkit.playwright.js

@@ -21,6 +21,9 @@ export class WebkitPlaywright extends EventEmitter {
     cleanListeners() {
         this.removeAllListeners();
     }
+    keepAlive() {
+        return false;
+    }
     isRunning = () => this.running;
     close = async () => {
         if (this.browser) {

package/build/http.d.ts

@@ -154,6 +154,7 @@ export declare enum HTTPManagementRoutes {
     config = "/config",
     metrics = "/metrics",
     metricsTotal = "/metrics/total",
+    pressure = "/pressure",
     sessions = "/sessions",
     static = "/"
 }

package/build/http.js

@@ -119,6 +119,7 @@ export var HTTPManagementRoutes;
     HTTPManagementRoutes["config"] = "/config";
     HTTPManagementRoutes["metrics"] = "/metrics";
     HTTPManagementRoutes["metricsTotal"] = "/metrics/total";
+    HTTPManagementRoutes["pressure"] = "/pressure";
     HTTPManagementRoutes["sessions"] = "/sessions";
     HTTPManagementRoutes["static"] = "/";
 })(HTTPManagementRoutes || (HTTPManagementRoutes = {}));

package/build/routes/chrome/http/content.post.body.json

@@ -394,14 +394,14 @@
                 "length": {
                   "type": "number"
                 },
-                "__@toStringTag@21862": {
+                "__@toStringTag@10986": {
                   "type": "string",
                   "const": "Uint8Array"
                 }
               },
               "required": [
                 "BYTES_PER_ELEMENT",
-                "__@toStringTag@21862",
+                "__@toStringTag@10986",
                 "buffer",
                 "byteLength",
                 "byteOffset",
@@ -436,13 +436,13 @@
         "byteLength": {
           "type": "number"
         },
-        "__@toStringTag@21862": {
+        "__@toStringTag@10986": {
           "type": "string"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@toStringTag@21862",
+        "__@toStringTag@10986",
         "byteLength"
       ]
     },
@@ -452,18 +452,18 @@
         "byteLength": {
           "type": "number"
         },
-        "__@species@21963": {
+        "__@species@11087": {
           "$ref": "#/definitions/SharedArrayBuffer"
         },
-        "__@toStringTag@21862": {
+        "__@toStringTag@10986": {
           "type": "string",
           "const": "SharedArrayBuffer"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@species@21963",
-        "__@toStringTag@21862",
+        "__@species@11087",
+        "__@toStringTag@10986",
         "byteLength"
       ]
     },

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

@@ -535,14 +535,14 @@
                 "length": {
                   "type": "number"
                 },
-                "__@toStringTag@76527": {
+                "__@toStringTag@98248": {
                   "type": "string",
                   "const": "Uint8Array"
                 }
               },
               "required": [
                 "BYTES_PER_ELEMENT",
-                "__@toStringTag@76527",
+                "__@toStringTag@98248",
                 "buffer",
                 "byteLength",
                 "byteOffset",
@@ -577,13 +577,13 @@
         "byteLength": {
           "type": "number"
         },
-        "__@toStringTag@76527": {
+        "__@toStringTag@98248": {
           "type": "string"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@toStringTag@76527",
+        "__@toStringTag@98248",
         "byteLength"
       ]
     },
@@ -593,18 +593,18 @@
         "byteLength": {
           "type": "number"
         },
-        "__@species@76628": {
+        "__@species@98349": {
           "$ref": "#/definitions/SharedArrayBuffer"
         },
-        "__@toStringTag@76527": {
+        "__@toStringTag@98248": {
           "type": "string",
           "const": "SharedArrayBuffer"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@species@76628",
-        "__@toStringTag@76527",
+        "__@species@98349",
+        "__@toStringTag@98248",
         "byteLength"
       ]
     },

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

@@ -441,14 +441,14 @@
                 "length": {
                   "type": "number"
                 },
-                "__@toStringTag@98505": {
+                "__@toStringTag@109391": {
                   "type": "string",
                   "const": "Uint8Array"
                 }
               },
               "required": [
                 "BYTES_PER_ELEMENT",
-                "__@toStringTag@98505",
+                "__@toStringTag@109391",
                 "buffer",
                 "byteLength",
                 "byteOffset",
@@ -483,13 +483,13 @@
         "byteLength": {
           "type": "number"
         },
-        "__@toStringTag@98505": {
+        "__@toStringTag@109391": {
           "type": "string"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@toStringTag@98505",
+        "__@toStringTag@109391",
         "byteLength"
       ]
     },
@@ -499,18 +499,18 @@
         "byteLength": {
           "type": "number"
         },
-        "__@species@98606": {
+        "__@species@109492": {
           "$ref": "#/definitions/SharedArrayBuffer"
         },
-        "__@toStringTag@98505": {
+        "__@toStringTag@109391": {
           "type": "string",
           "const": "SharedArrayBuffer"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@species@98606",
-        "__@toStringTag@98505",
+        "__@species@109492",
+        "__@toStringTag@109391",
         "byteLength"
       ]
     },

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

@@ -484,14 +484,14 @@
                 "length": {
                   "type": "number"
                 },
-                "__@toStringTag@109724": {
+                "__@toStringTag@120611": {
                   "type": "string",
                   "const": "Uint8Array"
                 }
               },
               "required": [
                 "BYTES_PER_ELEMENT",
-                "__@toStringTag@109724",
+                "__@toStringTag@120611",
                 "buffer",
                 "byteLength",
                 "byteOffset",
@@ -526,13 +526,13 @@
         "byteLength": {
           "type": "number"
         },
-        "__@toStringTag@109724": {
+        "__@toStringTag@120611": {
           "type": "string"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@toStringTag@109724",
+        "__@toStringTag@120611",
         "byteLength"
       ]
     },
@@ -542,18 +542,18 @@
         "byteLength": {
           "type": "number"
         },
-        "__@species@109825": {
+        "__@species@120712": {
           "$ref": "#/definitions/SharedArrayBuffer"
         },
-        "__@toStringTag@109724": {
+        "__@toStringTag@120611": {
           "type": "string",
           "const": "SharedArrayBuffer"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@species@109825",
-        "__@toStringTag@109724",
+        "__@species@120712",
+        "__@toStringTag@120611",
         "byteLength"
       ]
     },

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

@@ -394,14 +394,14 @@
                 "length": {
                   "type": "number"
                 },
-                "__@toStringTag@120853": {
+                "__@toStringTag@131741": {
                   "type": "string",
                   "const": "Uint8Array"
                 }
               },
               "required": [
                 "BYTES_PER_ELEMENT",
-                "__@toStringTag@120853",
+                "__@toStringTag@131741",
                 "buffer",
                 "byteLength",
                 "byteOffset",
@@ -436,13 +436,13 @@
         "byteLength": {
           "type": "number"
         },
-        "__@toStringTag@120853": {
+        "__@toStringTag@131741": {
           "type": "string"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@toStringTag@120853",
+        "__@toStringTag@131741",
         "byteLength"
       ]
     },
@@ -452,18 +452,18 @@
         "byteLength": {
           "type": "number"
         },
-        "__@species@120954": {
+        "__@species@131842": {
           "$ref": "#/definitions/SharedArrayBuffer"
         },
-        "__@toStringTag@120853": {
+        "__@toStringTag@131741": {
           "type": "string",
           "const": "SharedArrayBuffer"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@species@120954",
-        "__@toStringTag@120853",
+        "__@species@131842",
+        "__@toStringTag@131741",
         "byteLength"
       ]
     },

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

@@ -535,14 +535,14 @@
                 "length": {
                   "type": "number"
                 },
-                "__@toStringTag@208086": {
+                "__@toStringTag@208105": {
                   "type": "string",
                   "const": "Uint8Array"
                 }
               },
               "required": [
                 "BYTES_PER_ELEMENT",
-                "__@toStringTag@208086",
+                "__@toStringTag@208105",
                 "buffer",
                 "byteLength",
                 "byteOffset",
@@ -577,13 +577,13 @@
         "byteLength": {
           "type": "number"
         },
-        "__@toStringTag@208086": {
+        "__@toStringTag@208105": {
           "type": "string"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@toStringTag@208086",
+        "__@toStringTag@208105",
         "byteLength"
       ]
     },
@@ -593,18 +593,18 @@
         "byteLength": {
           "type": "number"
         },
-        "__@species@208187": {
+        "__@species@208206": {
           "$ref": "#/definitions/SharedArrayBuffer"
         },
-        "__@toStringTag@208086": {
+        "__@toStringTag@208105": {
           "type": "string",
           "const": "SharedArrayBuffer"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@species@208187",
-        "__@toStringTag@208086",
+        "__@species@208206",
+        "__@toStringTag@208105",
         "byteLength"
       ]
     },

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

@@ -441,14 +441,14 @@
                 "length": {
                   "type": "number"
                 },
-                "__@toStringTag@230098": {
+                "__@toStringTag@230119": {
                   "type": "string",
                   "const": "Uint8Array"
                 }
               },
               "required": [
                 "BYTES_PER_ELEMENT",
-                "__@toStringTag@230098",
+                "__@toStringTag@230119",
                 "buffer",
                 "byteLength",
                 "byteOffset",
@@ -483,13 +483,13 @@
         "byteLength": {
           "type": "number"
         },
-        "__@toStringTag@230098": {
+        "__@toStringTag@230119": {
           "type": "string"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@toStringTag@230098",
+        "__@toStringTag@230119",
         "byteLength"
       ]
     },
@@ -499,18 +499,18 @@
         "byteLength": {
           "type": "number"
         },
-        "__@species@230199": {
+        "__@species@230220": {
           "$ref": "#/definitions/SharedArrayBuffer"
         },
-        "__@toStringTag@230098": {
+        "__@toStringTag@230119": {
           "type": "string",
           "const": "SharedArrayBuffer"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@species@230199",
-        "__@toStringTag@230098",
+        "__@species@230220",
+        "__@toStringTag@230119",
         "byteLength"
       ]
     },

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

@@ -484,14 +484,14 @@
                 "length": {
                   "type": "number"
                 },
-                "__@toStringTag@252176": {
+                "__@toStringTag@241336": {
                   "type": "string",
                   "const": "Uint8Array"
                 }
               },
               "required": [
                 "BYTES_PER_ELEMENT",
-                "__@toStringTag@252176",
+                "__@toStringTag@241336",
                 "buffer",
                 "byteLength",
                 "byteOffset",
@@ -526,13 +526,13 @@
         "byteLength": {
           "type": "number"
         },
-        "__@toStringTag@252176": {
+        "__@toStringTag@241336": {
           "type": "string"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@toStringTag@252176",
+        "__@toStringTag@241336",
         "byteLength"
       ]
     },
@@ -542,18 +542,18 @@
         "byteLength": {
           "type": "number"
         },
-        "__@species@252277": {
+        "__@species@241437": {
           "$ref": "#/definitions/SharedArrayBuffer"
         },
-        "__@toStringTag@252176": {
+        "__@toStringTag@241336": {
           "type": "string",
           "const": "SharedArrayBuffer"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@species@252277",
-        "__@toStringTag@252176",
+        "__@species@241437",
+        "__@toStringTag@241336",
         "byteLength"
       ]
     },