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

package/build/file-system.d.ts

@@ -1,7 +1,9 @@
 /// <reference types="node" />
 /// <reference types="debug" />
+/// <reference types="node" />
 import { Config } from '@browserless.io/browserless';
-export declare class FileSystem {
+import { EventEmitter } from 'events';
+export declare class FileSystem extends EventEmitter {
     protected config: Config;
     protected fsMap: Map<string, string[]>;
     protected currentAESKey: Buffer;
@@ -26,4 +28,13 @@ export declare class FileSystem {
      * @returns Promise of the contents separated by newlines
      */
     read: (path: string) => Promise<string[]>;
+    /**
+     * 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/file-system.js

@@ -1,11 +1,13 @@
 import { createLogger, decrypt, encrypt, } from '@browserless.io/browserless';
 import { readFile, writeFile } from 'fs/promises';
-export class FileSystem {
+import { EventEmitter } from 'events';
+export class FileSystem extends EventEmitter {
     config;
     fsMap = new Map();
     currentAESKey;
     log = createLogger('file-system');
     constructor(config) {
+        super();
         this.config = config;
         this.currentAESKey = config.getAESKey();
         this.config.on('token', this.handleTokenChange);
@@ -58,4 +60,15 @@ export class FileSystem {
         this.fsMap.set(path, splitContents);
         return splitContents;
     };
+    /**
+     * 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/http.d.ts

@@ -181,13 +181,6 @@ export interface SystemQueryParameters {
      * object, or a base64-encoded JSON object.
      */
     launch?: CDPLaunchOptions | BrowserServerOptions | string;
-    /**
-     * Whether or nor to record the session. The browser will run
-     * in "head-full" mode, and recording is started and closed
-     * via the embedded browserless API. Please refer to the "Recording"
-     * section in the live documentation site for more details.
-     */
-    record?: boolean;
     /**
      * Override the system-level timeout for this request.
      * Accepts a value in milliseconds.

package/build/limiter.d.ts

@@ -44,5 +44,14 @@ export declare class Limiter extends q {
     get concurrencySize(): number;
     get hasCapacity(): boolean;
     limit: <TArgs extends unknown[], TResult>(limitFn: LimitFn<TArgs, TResult>, overCapacityFn: ErrorFn<TArgs>, onTimeoutFn: ErrorFn<TArgs>, timeoutOverrideFn: (...args: TArgs) => number | undefined) => LimitFn<TArgs, unknown>;
+    /**
+     * 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;
 }
 export {};

package/build/limiter.js

@@ -147,4 +147,15 @@ export class Limiter extends q {
             return bound;
         });
     };
+    /**
+     * 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/metrics.d.ts

@@ -1,5 +1,7 @@
+/// <reference types="node" />
 import { IBrowserlessStats } from '@browserless.io/browserless';
-export declare class Metrics {
+import { EventEmitter } from 'events';
+export declare class Metrics extends EventEmitter {
     protected sessionTimes: number[];
     protected successful: number;
     protected queued: number;
@@ -27,4 +29,13 @@ export declare class Metrics {
         totalTime: number;
         units: number;
     };
+    /**
+     * 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/metrics.js

@@ -1,4 +1,5 @@
-export class Metrics {
+import { EventEmitter } from 'events';
+export class Metrics extends EventEmitter {
     sessionTimes = [];
     successful = 0;
     queued = 0;
@@ -83,4 +84,15 @@ export class Metrics {
             units: sessionTimes.reduce((sum, value) => sum + Math.ceil(value / 30000), 0),
         };
     }
+    /**
+     * 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/monitoring.d.ts

@@ -1,6 +1,8 @@
 /// <reference types="debug" />
+/// <reference types="node" />
 import { Config, IResourceLoad } from '@browserless.io/browserless';
-export declare class Monitoring {
+import { EventEmitter } from 'events';
+export declare class Monitoring extends EventEmitter {
     protected config: Config;
     protected log: import("debug").Debugger;
     constructor(config: Config);
@@ -11,4 +13,13 @@ export declare class Monitoring {
         memoryInt: number | null;
         memoryOverloaded: 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/monitoring.js

@@ -1,9 +1,11 @@
 import { createLogger, } from '@browserless.io/browserless';
+import { EventEmitter } from 'events';
 import si from 'systeminformation';
-export class Monitoring {
+export class Monitoring extends EventEmitter {
     config;
     log = createLogger('hardware');
     constructor(config) {
+        super();
         this.config = config;
     }
     getMachineStats = async () => {
@@ -35,4 +37,15 @@ export class Monitoring {
             memoryOverloaded,
         };
     };
+    /**
+     * 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/router.d.ts

@@ -1,9 +1,11 @@
 /// <reference types="debug" />
 /// <reference types="node" />
 /// <reference types="node" />
+/// <reference types="node" />
 import { BrowserHTTPRoute, BrowserManager, BrowserWebsocketRoute, Config, HTTPRoute, Limiter, Request, Response, WebSocketRoute } from '@browserless.io/browserless';
+import { EventEmitter } from 'events';
 import stream from 'stream';
-export declare class Router {
+export declare class Router extends EventEmitter {
     protected config: Config;
     protected browserManager: BrowserManager;
     protected limiter: Limiter;
@@ -21,8 +23,16 @@ export declare class Router {
     protected wrapWebSocketHandler: (route: WebSocketRoute | BrowserWebsocketRoute, handler: WebSocketRoute['handler'] | BrowserWebsocketRoute['handler']) => (req: Request, socket: stream.Duplex, head: Buffer) => Promise<unknown>;
     registerHTTPRoute(route: HTTPRoute | BrowserHTTPRoute): HTTPRoute | BrowserHTTPRoute;
     registerWebSocketRoute(route: WebSocketRoute | BrowserWebsocketRoute): WebSocketRoute | BrowserWebsocketRoute;
-    teardown(): Promise<void>;
     getStaticHandler(): HTTPRoute;
     getRouteForHTTPRequest(req: Request): Promise<HTTPRoute | BrowserHTTPRoute | null>;
     getRouteForWebSocketRequest(req: Request): Promise<WebSocketRoute | BrowserWebsocketRoute | undefined>;
+    /**
+     * 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/router.js

@@ -1,6 +1,7 @@
 import { HTTPManagementRoutes, contentTypes, createLogger, isConnected, writeResponse, } from '@browserless.io/browserless';
+import { EventEmitter } from 'events';
 import micromatch from 'micromatch';
-export class Router {
+export class Router extends EventEmitter {
     config;
     browserManager;
     limiter;
@@ -9,6 +10,7 @@ export class Router {
     httpRoutes = [];
     webSocketRoutes = [];
     constructor(config, browserManager, limiter) {
+        super();
         this.config = config;
         this.browserManager = browserManager;
         this.limiter = limiter;
@@ -129,11 +131,6 @@ export class Router {
         this.webSocketRoutes.push(route);
         return route;
     }
-    teardown() {
-        this.httpRoutes = [];
-        this.webSocketRoutes = [];
-        return this.browserManager.stop();
-    }
     getStaticHandler() {
         return this.httpRoutes.find((route) => route.path.includes(HTTPManagementRoutes.static));
     }
@@ -156,4 +153,17 @@ export class Router {
         // Once registered, paths are always an array here.
         r.path.some((p) => micromatch.isMatch(pathname, p)));
     }
+    /**
+     * Implement any browserless-core-specific shutdown logic here.
+     * Calls the empty-SDK stop method for downstream implementations.
+     */
+    shutdown = async () => {
+        this.httpRoutes = [];
+        this.webSocketRoutes = [];
+        await this.stop();
+    };
+    /**
+     * Left blank for downstream SDK modules to optionally implement.
+     */
+    stop = () => { };
 }

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

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

package/build/routes/chrome/http/content.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/chrome/http/download.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/chrome/http/function.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/chrome/http/pdf.post.body.json

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

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

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

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

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

package/build/routes/chrome/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/chrome/tests/function.spec.js

@@ -36,6 +36,38 @@ describe('/chrome/function API', function () {
             expect(res.status).to.equal(200);
         });
     });
+    it('runs functions with "context"', async () => {
+        const config = new Config();
+        config.setToken('browserless');
+        const metrics = new Metrics();
+        await start({ config, metrics });
+        const body = {
+            code: `export default async function ({ page, context }) {
+        if (!!context.ok) {
+          return Promise.resolve({
+            data: "ok",
+            type: "application/text",
+          });
+        }
+        return Promise.reject(new Error('Bad context!'));
+      }`,
+            context: {
+                ok: true,
+            },
+        };
+        await fetch('http://localhost:3000/chrome/function?token=browserless', {
+            body: JSON.stringify(body),
+            headers: {
+                'content-type': 'application/json',
+            },
+            method: 'POST',
+        }).then(async (res) => {
+            const json = await res.json();
+            expect(json).to.have.property('data');
+            expect(json.data).to.equal('ok');
+            expect(res.status).to.equal(200);
+        });
+    });
     it('runs "application/javascript" functions', async () => {
         const config = new Config();
         config.setToken('browserless');

package/build/routes/chrome/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/chrome/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"