@browserless.io/browserless 2.9.0 → 2.10.0

package/CHANGELOG.md

@@ -1,4 +1,8 @@
-# [Latest](https://github.com/browserless/chrome/compare/v2.9.0...main)
+# [Latest](https://github.com/browserless/chrome/compare/v2.10.0...main)
+- 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/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@65656": {
                   "type": "string",
                   "const": "Uint8Array"
                 }
               },
               "required": [
                 "BYTES_PER_ELEMENT",
-                "__@toStringTag@76527",
+                "__@toStringTag@65656",
                 "buffer",
                 "byteLength",
                 "byteOffset",
@@ -577,13 +577,13 @@
         "byteLength": {
           "type": "number"
         },
-        "__@toStringTag@76527": {
+        "__@toStringTag@65656": {
           "type": "string"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@toStringTag@76527",
+        "__@toStringTag@65656",
         "byteLength"
       ]
     },
@@ -593,18 +593,18 @@
         "byteLength": {
           "type": "number"
         },
-        "__@species@76628": {
+        "__@species@65757": {
           "$ref": "#/definitions/SharedArrayBuffer"
         },
-        "__@toStringTag@76527": {
+        "__@toStringTag@65656": {
           "type": "string",
           "const": "SharedArrayBuffer"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@species@76628",
-        "__@toStringTag@76527",
+        "__@species@65757",
+        "__@toStringTag@65656",
         "byteLength"
       ]
     },

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

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

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

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

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

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

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

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

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

@@ -441,14 +441,14 @@
                 "length": {
                   "type": "number"
                 },
-                "__@toStringTag@230098": {
+                "__@toStringTag@208093": {
                   "type": "string",
                   "const": "Uint8Array"
                 }
               },
               "required": [
                 "BYTES_PER_ELEMENT",
-                "__@toStringTag@230098",
+                "__@toStringTag@208093",
                 "buffer",
                 "byteLength",
                 "byteOffset",
@@ -483,13 +483,13 @@
         "byteLength": {
           "type": "number"
         },
-        "__@toStringTag@230098": {
+        "__@toStringTag@208093": {
           "type": "string"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@toStringTag@230098",
+        "__@toStringTag@208093",
         "byteLength"
       ]
     },
@@ -499,18 +499,18 @@
         "byteLength": {
           "type": "number"
         },
-        "__@species@230199": {
+        "__@species@208194": {
           "$ref": "#/definitions/SharedArrayBuffer"
         },
-        "__@toStringTag@230098": {
+        "__@toStringTag@208093": {
           "type": "string",
           "const": "SharedArrayBuffer"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@species@230199",
-        "__@toStringTag@230098",
+        "__@species@208194",
+        "__@toStringTag@208093",
         "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"
       ]
     },

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

@@ -0,0 +1,63 @@
+/// <reference types="node" />
+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;
+};
+export default class PressureGetRoute 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/pressure.get.js

@@ -0,0 +1,56 @@
+import { APITags, BrowserlessRoutes, HTTPManagementRoutes, HTTPRoute, Methods, contentTypes, jsonResponse, } from '@browserless.io/browserless';
+export default class PressureGetRoute extends HTTPRoute {
+    name = BrowserlessRoutes.PressureGetRoute;
+    accepts = [contentTypes.any];
+    auth = true;
+    browser = null;
+    concurrency = false;
+    contentTypes = [contentTypes.json];
+    description = `Returns a JSON body of stats related to the pressure being created on the instance.`;
+    method = Methods.get;
+    path = HTTPManagementRoutes.pressure;
+    tags = [APITags.management];
+    handler = async (_req, res) => {
+        const monitoring = this.monitoring();
+        const config = this.config();
+        const limiter = this.limiter();
+        const metrics = this.metrics();
+        const { cpuInt: cpu, memoryInt: memory, cpuOverloaded, memoryOverloaded, } = await monitoring.overloaded();
+        const date = Date.now();
+        const hasCapacity = limiter.hasCapacity;
+        const queued = limiter.waiting;
+        const isAvailable = hasCapacity && !cpuOverloaded && !memoryOverloaded;
+        const running = limiter.executing;
+        const recentlyRejected = metrics.get().rejected;
+        const maxConcurrent = config.getConcurrent();
+        const maxQueued = config.getQueued();
+        const reason = !hasCapacity
+            ? 'full'
+            : cpuOverloaded
+                ? 'cpu'
+                : memoryOverloaded
+                    ? 'memory'
+                    : '';
+        const message = !hasCapacity
+            ? 'Concurrency and queue are full'
+            : cpuOverloaded
+                ? 'CPU is over the configured maximum for cpu percent'
+                : memoryOverloaded
+                    ? 'Memory is over the configured maximum for memory percent'
+                    : '';
+        const response = {
+            cpu,
+            date,
+            isAvailable,
+            maxConcurrent,
+            maxQueued,
+            memory,
+            message,
+            queued,
+            reason,
+            recentlyRejected,
+            running,
+        };
+        return jsonResponse(res, 200, response);
+    };
+}