@browserless.io/browserless 2.10.0 → 2.11.0

package/CHANGELOG.md

@@ -1,4 +1,9 @@
-# [Latest](https://github.com/browserless/chrome/compare/v2.10.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)

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/routes/chrome/http/pdf.post.body.json

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

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

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

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

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

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

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

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

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

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

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

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

@@ -2,51 +2,53 @@
 import { APITags, HTTPManagementRoutes, HTTPRoute, Methods, Request, contentTypes } from '@browserless.io/browserless';
 import { ServerResponse } from 'http';
 export type ResponseSchema = {
-    /**
-     * An integer representing the percentage of CPU being used. For instance 92 means 92%
-     */
-    cpu: number | null;
-    /**
-     * A number of milliseconds since epoch, or "Date.now()" equivalent.
-     */
-    date: number;
-    /**
-     * Whether or not a session can be connected and immediately ran on a health instance.
-     */
-    isAvailable: boolean;
-    /**
-     * The maximum amount of browsers that can be ran at a single time.
-     */
-    maxConcurrent: number;
-    /**
-     * The maximum amount of queued connections allowed at a single time.
-     */
-    maxQueued: number;
-    /**
-     * An integer representing the percentage of Memory being used. For instance 95 means 95%
-     */
-    memory: number | null;
-    /**
-     * A human-readable message as the overall status of the instance.
-     */
-    message: string;
-    /**
-     * The current number of connect or API calls pending to run.
-     */
-    queued: number;
-    /**
-     * A simple single-word reason as to why an instance may or may not be available.
-     */
-    reason: 'full' | 'cpu' | 'memory' | '';
-    /**
-     * The number of recent connections that were rejected due to the queue and concurrency
-     * limits having been filled.
-     */
-    recentlyRejected: number;
-    /**
-     * The current number of running connections or API calls.
-     */
-    running: number;
+    pressure: {
+        /**
+         * An integer representing the percentage of CPU being used. For instance 92 means 92%
+         */
+        cpu: number | null;
+        /**
+         * A number of milliseconds since epoch, or "Date.now()" equivalent.
+         */
+        date: number;
+        /**
+         * Whether or not a session can be connected and immediately ran on a health instance.
+         */
+        isAvailable: boolean;
+        /**
+         * The maximum amount of browsers that can be ran at a single time.
+         */
+        maxConcurrent: number;
+        /**
+         * The maximum amount of queued connections allowed at a single time.
+         */
+        maxQueued: number;
+        /**
+         * An integer representing the percentage of Memory being used. For instance 95 means 95%
+         */
+        memory: number | null;
+        /**
+         * A human-readable message as the overall status of the instance.
+         */
+        message: string;
+        /**
+         * The current number of connect or API calls pending to run.
+         */
+        queued: number;
+        /**
+         * A simple single-word reason as to why an instance may or may not be available.
+         */
+        reason: 'full' | 'cpu' | 'memory' | '';
+        /**
+         * The number of recent connections that were rejected due to the queue and concurrency
+         * limits having been filled.
+         */
+        recentlyRejected: number;
+        /**
+         * The current number of running connections or API calls.
+         */
+        running: number;
+    };
 };
 export default class PressureGetRoute extends HTTPRoute {
     name: string;

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

@@ -39,17 +39,19 @@ export default class PressureGetRoute extends HTTPRoute {
                     ? 'Memory is over the configured maximum for memory percent'
                     : '';
         const response = {
-            cpu,
-            date,
-            isAvailable,
-            maxConcurrent,
-            maxQueued,
-            memory,
-            message,
-            queued,
-            reason,
-            recentlyRejected,
-            running,
+            pressure: {
+                cpu,
+                date,
+                isAvailable,
+                maxConcurrent,
+                maxQueued,
+                memory,
+                message,
+                queued,
+                reason,
+                recentlyRejected,
+                running,
+            },
         };
         return jsonResponse(res, 200, response);
     };