@browserless.io/browserless 2.4.0-beta-1 → 2.4.0-beta-3

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

@@ -538,14 +538,14 @@
                 "length": {
                   "type": "number"
                 },
-                "__@toStringTag@217434": {
+                "__@toStringTag@206722": {
                   "type": "string",
                   "const": "Uint8Array"
                 }
               },
               "required": [
                 "BYTES_PER_ELEMENT",
-                "__@toStringTag@217434",
+                "__@toStringTag@206722",
                 "buffer",
                 "byteLength",
                 "byteOffset",
@@ -580,13 +580,13 @@
         "byteLength": {
           "type": "number"
         },
-        "__@toStringTag@217434": {
+        "__@toStringTag@206722": {
           "type": "string"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@toStringTag@217434",
+        "__@toStringTag@206722",
         "byteLength"
       ]
     },
@@ -596,18 +596,18 @@
         "byteLength": {
           "type": "number"
         },
-        "__@species@217535": {
+        "__@species@206823": {
           "$ref": "#/definitions/SharedArrayBuffer"
         },
-        "__@toStringTag@217434": {
+        "__@toStringTag@206722": {
           "type": "string",
           "const": "SharedArrayBuffer"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@species@217535",
-        "__@toStringTag@217434",
+        "__@species@206823",
+        "__@toStringTag@206722",
         "byteLength"
       ]
     },

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

@@ -16,10 +16,6 @@
       "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"
     },
-    "record": {
-      "description": "Whether or nor to record the session. The browser will run\nin \"head-full\" mode, and recording is started and closed\nvia the embedded browserless API. Please refer to the \"Recording\"\nsection in the live documentation site for more details.",
-      "type": "boolean"
-    },
     "timeout": {
       "description": "Override the system-level timeout for this request.\nAccepts a value in milliseconds.",
       "type": "number"

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

@@ -16,10 +16,6 @@
       "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"
     },
-    "record": {
-      "description": "Whether or nor to record the session. The browser will run\nin \"head-full\" mode, and recording is started and closed\nvia the embedded browserless API. Please refer to the \"Recording\"\nsection in the live documentation site for more details.",
-      "type": "boolean"
-    },
     "timeout": {
       "description": "Override the system-level timeout for this request.\nAccepts a value in milliseconds.",
       "type": "number"

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

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

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

@@ -16,10 +16,6 @@
         }
       ]
     },
-    "record": {
-      "description": "Whether or nor to record the session. The browser will run\nin \"head-full\" mode, and recording is started and closed\nvia the embedded browserless API. Please refer to the \"Recording\"\nsection in the live documentation site for more details.",
-      "type": "boolean"
-    },
     "timeout": {
       "description": "Override the system-level timeout for this request.\nAccepts a value in milliseconds.",
       "type": "number"

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

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

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

@@ -16,10 +16,6 @@
       "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"
     },
-    "record": {
-      "description": "Whether or nor to record the session. The browser will run\nin \"head-full\" mode, and recording is started and closed\nvia the embedded browserless API. Please refer to the \"Recording\"\nsection in the live documentation site for more details.",
-      "type": "boolean"
-    },
     "timeout": {
       "description": "Override the system-level timeout for this request.\nAccepts a value in milliseconds.",
       "type": "number"

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

@@ -16,10 +16,6 @@
       "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"
     },
-    "record": {
-      "description": "Whether or nor to record the session. The browser will run\nin \"head-full\" mode, and recording is started and closed\nvia the embedded browserless API. Please refer to the \"Recording\"\nsection in the live documentation site for more details.",
-      "type": "boolean"
-    },
     "timeout": {
       "description": "Override the system-level timeout for this request.\nAccepts a value in milliseconds.",
       "type": "number"

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

@@ -16,10 +16,6 @@
       "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"
     },
-    "record": {
-      "description": "Whether or nor to record the session. The browser will run\nin \"head-full\" mode, and recording is started and closed\nvia the embedded browserless API. Please refer to the \"Recording\"\nsection in the live documentation site for more details.",
-      "type": "boolean"
-    },
     "timeout": {
       "description": "Override the system-level timeout for this request.\nAccepts a value in milliseconds.",
       "type": "number"

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

@@ -16,10 +16,6 @@
       "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"
     },
-    "record": {
-      "description": "Whether or nor to record the session. The browser will run\nin \"head-full\" mode, and recording is started and closed\nvia the embedded browserless API. Please refer to the \"Recording\"\nsection in the live documentation site for more details.",
-      "type": "boolean"
-    },
     "timeout": {
       "description": "Override the system-level timeout for this request.\nAccepts a value in milliseconds.",
       "type": "number"

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

@@ -16,10 +16,6 @@
       "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"
     },
-    "record": {
-      "description": "Whether or nor to record the session. The browser will run\nin \"head-full\" mode, and recording is started and closed\nvia the embedded browserless API. Please refer to the \"Recording\"\nsection in the live documentation site for more details.",
-      "type": "boolean"
-    },
     "timeout": {
       "description": "Override the system-level timeout for this request.\nAccepts a value in milliseconds.",
       "type": "number"

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

@@ -80,10 +80,6 @@
       "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"
     },
-    "record": {
-      "description": "Whether or nor to record the session. The browser will run\nin \"head-full\" mode, and recording is started and closed\nvia the embedded browserless API. Please refer to the \"Recording\"\nsection in the live documentation site for more details.",
-      "type": "boolean"
-    },
     "timeout": {
       "description": "Override the system-level timeout for this request.\nAccepts a value in milliseconds.",
       "type": "number"

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

@@ -16,10 +16,6 @@
       "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"
     },
-    "record": {
-      "description": "Whether or nor to record the session. The browser will run\nin \"head-full\" mode, and recording is started and closed\nvia the embedded browserless API. Please refer to the \"Recording\"\nsection in the live documentation site for more details.",
-      "type": "boolean"
-    },
     "timeout": {
       "description": "Override the system-level timeout for this request.\nAccepts a value in milliseconds.",
       "type": "number"

package/build/server.d.ts

@@ -2,9 +2,11 @@
 /// <reference types="debug" />
 /// <reference types="node" />
 /// <reference types="node" />
+/// <reference types="node" />
 import * as http from 'http';
 import * as stream from 'stream';
 import { Config, Metrics, Request, Response, Router, Token } from '@browserless.io/browserless';
+import { EventEmitter } from 'events';
 export interface HTTPServerOptions {
     concurrent: number;
     host: string;
@@ -12,7 +14,7 @@ export interface HTTPServerOptions {
     queued: number;
     timeout: number;
 }
-export declare class HTTPServer {
+export declare class HTTPServer extends EventEmitter {
     protected config: Config;
     protected metrics: Metrics;
     protected token: Token;
@@ -26,8 +28,11 @@ export declare class HTTPServer {
     protected onHTTPUnauthorized: (_req: Request, res: Response) => void;
     protected onWebsocketUnauthorized: (_req: Request, socket: stream.Duplex) => void;
     start(): Promise<void>;
-    stop(): Promise<void>;
-    protected tearDown(): void;
     protected handleRequest: (request: http.IncomingMessage, res: http.ServerResponse) => Promise<void | http.ServerResponse<http.IncomingMessage>>;
     protected handleWebSocket: (request: http.IncomingMessage, socket: stream.Duplex, head: Buffer) => Promise<void>;
+    shutdown(): Promise<void>;
+    /**
+     * Left blank for downstream SDK modules to optionally implement.
+     */
+    stop: () => void;
 }

package/build/server.js

@@ -1,8 +1,9 @@
 import * as http from 'http';
 import { BadRequest, NotFound, Timeout, TooManyRequests, Unauthorized, beforeRequest, contentTypes, convertPathToURL, createLogger, queryParamsToObject, readBody, shimLegacyRequests, writeResponse, } from '@browserless.io/browserless';
+import { EventEmitter } from 'events';
 // @ts-ignore
 import Enjoi from 'enjoi';
-export class HTTPServer {
+export class HTTPServer extends EventEmitter {
     config;
     metrics;
     token;
@@ -13,6 +14,7 @@ export class HTTPServer {
     log = createLogger('server');
     verbose = createLogger('server:verbose');
     constructor(config, metrics, token, router) {
+        super();
         this.config = config;
         this.metrics = metrics;
         this.token = token;
@@ -49,18 +51,6 @@ export class HTTPServer {
             });
         });
     }
-    async stop() {
-        this.log(`HTTP Server is shutting down`);
-        await new Promise((r) => this.server.close(r));
-        await Promise.all([this.tearDown(), this.router.teardown()]);
-        this.log(`HTTP Server shutdown complete`);
-    }
-    tearDown() {
-        this.log(`Tearing down all listeners and internal routes`);
-        this.server && this.server.removeAllListeners();
-        // @ts-ignore garbage collect this reference
-        this.server = null;
-    }
     handleRequest = async (request, res) => {
         this.verbose(`Handling inbound HTTP request on "${request.method}: ${request.url}"`);
         const req = request;
@@ -241,4 +231,16 @@ export class HTTPServer {
         this.log(`No matching WebSocket route handler for "${req.parsed.href}"`);
         return writeResponse(socket, 404, 'Not Found');
     };
+    async shutdown() {
+        this.log(`HTTP Server is shutting down`);
+        await new Promise((r) => this.server.close(r));
+        this.server && this.server.removeAllListeners();
+        // @ts-ignore garbage collect this reference
+        this.server = null;
+        this.log(`HTTP Server shutdown complete`);
+    }
+    /**
+     * Left blank for downstream SDK modules to optionally implement.
+     */
+    stop = () => { };
 }

package/build/token.d.ts

@@ -1,6 +1,17 @@
+/// <reference types="node" />
 import { BrowserHTTPRoute, BrowserWebsocketRoute, Config, HTTPRoute, Request, WebSocketRoute } from '@browserless.io/browserless';
-export declare class Token {
+import { EventEmitter } from 'events';
+export declare class Token extends EventEmitter {
     protected config: Config;
     constructor(config: Config);
     isAuthorized: (req: Request, route: BrowserHTTPRoute | BrowserWebsocketRoute | HTTPRoute | WebSocketRoute) => Promise<boolean>;
+    /**
+     * Implement any browserless-core-specific shutdown logic here.
+     * Calls the empty-SDK stop method for downstream implementations.
+     */
+    shutdown: () => Promise<void>;
+    /**
+     * Left blank for downstream SDK modules to optionally implement.
+     */
+    stop: () => void;
 }

package/build/token.js

@@ -1,7 +1,9 @@
 import { getTokenFromRequest, } from '@browserless.io/browserless';
-export class Token {
+import { EventEmitter } from 'events';
+export class Token extends EventEmitter {
     config;
     constructor(config) {
+        super();
         this.config = config;
     }
     isAuthorized = async (req, route) => {
@@ -18,4 +20,15 @@ export class Token {
         }
         return (Array.isArray(token) ? token : [token]).includes(requestToken);
     };
+    /**
+     * Implement any browserless-core-specific shutdown logic here.
+     * Calls the empty-SDK stop method for downstream implementations.
+     */
+    shutdown = async () => {
+        await this.stop();
+    };
+    /**
+     * Left blank for downstream SDK modules to optionally implement.
+     */
+    stop = () => { };
 }

package/build/types.d.ts

@@ -362,17 +362,6 @@ export interface InBoundRequest {
     url: string;
 }
 export declare const debugScreenshotOpts: ScreenshotOptions;
-declare global {
-    interface Window {
-        browserless: BrowserlessEmbeddedAPI;
-    }
-}
-export interface BrowserlessEmbeddedAPI {
-    getRecording: () => Promise<string>;
-    liveUrl: () => string;
-    saveRecording: () => Promise<boolean>;
-    startRecording: () => void;
-}
 /**
  * When bestAttempt is set to true, browserless attempt to proceed
  * when "awaited" events fail or timeout. This includes things like

package/build/webhooks.d.ts

@@ -1,5 +1,7 @@
+/// <reference types="node" />
 import { Config } from '@browserless.io/browserless';
-export declare class WebHooks {
+import { EventEmitter } from 'events';
+export declare class WebHooks extends EventEmitter {
     protected config: Config;
     constructor(config: Config);
     protected callURL(url: string | null): Promise<void | Response> | undefined;
@@ -8,4 +10,13 @@ export declare class WebHooks {
     callRejectAlertURL(): Promise<void | Response> | undefined;
     callTimeoutAlertURL(): Promise<void | Response> | undefined;
     callErrorAlertURL(message: string): void | Promise<void | Response>;
+    /**
+     * Implement any browserless-core-specific shutdown logic here.
+     * Calls the empty-SDK stop method for downstream implementations.
+     */
+    shutdown: () => Promise<void>;
+    /**
+     * Left blank for downstream SDK modules to optionally implement.
+     */
+    stop: () => void;
 }

package/build/webhooks.js

@@ -1,7 +1,9 @@
 import { fetchTimeout, noop } from '@browserless.io/browserless';
-export class WebHooks {
+import { EventEmitter } from 'events';
+export class WebHooks extends EventEmitter {
     config;
     constructor(config) {
+        super();
         this.config = config;
     }
     callURL(url) {
@@ -40,4 +42,15 @@ export class WebHooks {
             return console.error(`Issue calling error hook: "${err}". Did you set a working ERROR_ALERT_URL env variable?`);
         }
     }
+    /**
+     * Implement any browserless-core-specific shutdown logic here.
+     * Calls the empty-SDK stop method for downstream implementations.
+     */
+    shutdown = async () => {
+        await this.stop();
+    };
+    /**
+     * Left blank for downstream SDK modules to optionally implement.
+     */
+    stop = () => { };
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@browserless.io/browserless",
-  "version": "2.4.0-beta-1",
+  "version": "2.4.0-beta-3",
   "license": "SSPL",
   "description": "The browserless platform",
   "author": "browserless.io",
@@ -73,8 +73,8 @@
     "@types/mocha": "^10.0.6",
     "@types/node": "^20.11.24",
     "@types/sinon": "^17.0.3",
-    "@typescript-eslint/eslint-plugin": "^7.1.0",
-    "@typescript-eslint/parser": "^7.1.0",
+    "@typescript-eslint/eslint-plugin": "^7.1.1",
+    "@typescript-eslint/parser": "^7.1.1",
     "assert": "^2.0.0",
     "chai": "^5.1.0",
     "cross-env": "^7.0.3",

package/src/browserless.ts

@@ -27,6 +27,7 @@ import {
   printLogo,
   safeParse,
 } from '@browserless.io/browserless';
+import { EventEmitter } from 'events';
 import { readFile } from 'fs/promises';
 import { userInfo } from 'os';
 
@@ -42,7 +43,7 @@ type routeInstances =
   | WebSocketRoute
   | BrowserWebsocketRoute;
 
-export class Browserless {
+export class Browserless extends EventEmitter {
   protected debug: debug.Debugger = createLogger('index');
   protected browserManager: BrowserManager;
   protected config: Config;
@@ -83,6 +84,7 @@ export class Browserless {
     token?: Browserless['token'];
     webhooks?: Browserless['webhooks'];
   } = {}) {
+    super();
     this.config = config || new Config();
     this.metrics = metrics || new Metrics();
     this.token = token || new Token(this.config);
@@ -177,7 +179,18 @@ export class Browserless {
 
   public async stop() {
     clearInterval(this.metricsSaveIntervalID as unknown as number);
-    return Promise.all([this.server?.stop()]);
+    return Promise.all([
+      this.server?.shutdown(),
+      this.browserManager.shutdown(),
+      this.config.shutdown(),
+      this.fileSystem.shutdown(),
+      this.limiter.shutdown(),
+      this.metrics.shutdown(),
+      this.monitoring.shutdown(),
+      this.router.shutdown(),
+      this.token.shutdown(),
+      this.webhooks.shutdown(),
+    ]);
   }
 
   public async start() {