@browserless.io/browserless 2.10.0 → 2.11.0

package/build/routes/management/http/pressure.get.response.json

@@ -1,76 +1,85 @@
 {
   "type": "object",
   "properties": {
-    "cpu": {
-      "description": "An integer representing the percentage of CPU being used. For instance 92 means 92%",
-      "type": [
-        "null",
-        "number"
-      ]
-    },
-    "date": {
-      "description": "A number of milliseconds since epoch, or \"Date.now()\" equivalent.",
-      "type": "number"
-    },
-    "isAvailable": {
-      "description": "Whether or not a session can be connected and immediately ran on a health instance.",
-      "type": "boolean"
-    },
-    "maxConcurrent": {
-      "description": "The maximum amount of browsers that can be ran at a single time.",
-      "type": "number"
-    },
-    "maxQueued": {
-      "description": "The maximum amount of queued connections allowed at a single time.",
-      "type": "number"
-    },
-    "memory": {
-      "description": "An integer representing the percentage of Memory being used. For instance 95 means 95%",
-      "type": [
-        "null",
-        "number"
-      ]
-    },
-    "message": {
-      "description": "A human-readable message as the overall status of the instance.",
-      "type": "string"
-    },
-    "queued": {
-      "description": "The current number of connect or API calls pending to run.",
-      "type": "number"
-    },
-    "reason": {
-      "description": "A simple single-word reason as to why an instance may or may not be available.",
-      "enum": [
-        "",
+    "pressure": {
+      "type": "object",
+      "properties": {
+        "cpu": {
+          "description": "An integer representing the percentage of CPU being used. For instance 92 means 92%",
+          "type": [
+            "null",
+            "number"
+          ]
+        },
+        "date": {
+          "description": "A number of milliseconds since epoch, or \"Date.now()\" equivalent.",
+          "type": "number"
+        },
+        "isAvailable": {
+          "description": "Whether or not a session can be connected and immediately ran on a health instance.",
+          "type": "boolean"
+        },
+        "maxConcurrent": {
+          "description": "The maximum amount of browsers that can be ran at a single time.",
+          "type": "number"
+        },
+        "maxQueued": {
+          "description": "The maximum amount of queued connections allowed at a single time.",
+          "type": "number"
+        },
+        "memory": {
+          "description": "An integer representing the percentage of Memory being used. For instance 95 means 95%",
+          "type": [
+            "null",
+            "number"
+          ]
+        },
+        "message": {
+          "description": "A human-readable message as the overall status of the instance.",
+          "type": "string"
+        },
+        "queued": {
+          "description": "The current number of connect or API calls pending to run.",
+          "type": "number"
+        },
+        "reason": {
+          "description": "A simple single-word reason as to why an instance may or may not be available.",
+          "enum": [
+            "",
+            "cpu",
+            "full",
+            "memory"
+          ],
+          "type": "string"
+        },
+        "recentlyRejected": {
+          "description": "The number of recent connections that were rejected due to the queue and concurrency\nlimits having been filled.",
+          "type": "number"
+        },
+        "running": {
+          "description": "The current number of running connections or API calls.",
+          "type": "number"
+        }
+      },
+      "additionalProperties": false,
+      "required": [
         "cpu",
-        "full",
-        "memory"
-      ],
-      "type": "string"
-    },
-    "recentlyRejected": {
-      "description": "The number of recent connections that were rejected due to the queue and concurrency\nlimits having been filled.",
-      "type": "number"
-    },
-    "running": {
-      "description": "The current number of running connections or API calls.",
-      "type": "number"
+        "date",
+        "isAvailable",
+        "maxConcurrent",
+        "maxQueued",
+        "memory",
+        "message",
+        "queued",
+        "reason",
+        "recentlyRejected",
+        "running"
+      ]
     }
   },
   "additionalProperties": false,
   "required": [
-    "cpu",
-    "date",
-    "isAvailable",
-    "maxConcurrent",
-    "maxQueued",
-    "memory",
-    "message",
-    "queued",
-    "reason",
-    "recentlyRejected",
-    "running"
+    "pressure"
   ],
   "$schema": "http://json-schema.org/draft-07/schema#"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@browserless.io/browserless",
-  "version": "2.10.0",
+  "version": "2.11.0",
   "license": "SSPL",
   "description": "The browserless platform",
   "author": "browserless.io",

package/src/browsers/chromium.cdp.ts

@@ -59,6 +59,10 @@ export class ChromiumCDP extends EventEmitter {
     this.removeAllListeners();
   }
 
+  public keepAlive() {
+    return false;
+  }
+
   public getPageId = (page: Page): string => {
     // @ts-ignore
     return page.target()._targetId;

package/src/browsers/chromium.playwright.ts

@@ -43,6 +43,10 @@ export class ChromiumPlaywright extends EventEmitter {
     this.removeAllListeners();
   }
 
+  public keepAlive() {
+    return false;
+  }
+
   public isRunning = (): boolean => this.running;
 
   public close = async (): Promise<void> => {

package/src/browsers/firefox.playwright.ts

@@ -42,6 +42,10 @@ export class FirefoxPlaywright extends EventEmitter {
     this.removeAllListeners();
   }
 
+  public keepAlive() {
+    return false;
+  }
+
   public isRunning = (): boolean => this.running;
 
   public close = async (): Promise<void> => {

package/src/browsers/index.ts

@@ -36,7 +36,6 @@ import path from 'path';
 
 export class BrowserManager {
   protected browsers: Map<BrowserInstance, BrowserlessSession> = new Map();
-  protected launching: Map<string, Promise<unknown>> = new Map();
   protected timers: Map<string, number> = new Map();
   protected log = new Logger('browser-manager');
   protected chromeBrowsers = [ChromiumCDP, ChromeCDP];
@@ -272,7 +271,7 @@ export class BrowserManager {
     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;
     }
 
@@ -314,7 +313,6 @@ export class BrowserManager {
 
     if (id && resolver) {
       resolver(null);
-      this.launching.delete(id);
     }
 
     --session.numbConnected;
@@ -457,7 +455,7 @@ export class BrowserManager {
       userDataDir,
     });
 
-    const connectionMeta: BrowserlessSession = {
+    const session: BrowserlessSession = {
       id: null,
       initialConnectURL:
         path.join(req.parsed.pathname, req.parsed.search) || '',
@@ -471,7 +469,7 @@ export class BrowserManager {
       userDataDir,
     };
 
-    this.browsers.set(browser, connectionMeta);
+    this.browsers.set(browser, session);
 
     await browser.launch(launchOptions as object);
     await this.hooks.browser({ browser, meta: req.parsed });

package/src/browsers/webkit.playwright.ts

@@ -42,6 +42,10 @@ export class WebkitPlaywright extends EventEmitter {
     this.removeAllListeners();
   }
 
+  public keepAlive() {
+    return false;
+  }
+
   public isRunning = (): boolean => this.running;
 
   public close = async (): Promise<void> => {

package/src/routes/management/http/pressure.get.ts

@@ -11,61 +11,63 @@ import {
 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 {
@@ -117,17 +119,19 @@ export default class PressureGetRoute extends HTTPRoute {
           : '';
 
     const response: ResponseSchema = {
-      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);