@browserless.io/browserless 2.8.0 → 2.10.0

package/build/logger.d.ts

@@ -1,12 +1,19 @@
-import { Request, createLogger } from '@browserless.io/browserless';
+import { Request } from '@browserless.io/browserless';
 export declare class Logger {
     protected prefix: string;
-    protected request: Request;
-    protected _log: ReturnType<typeof createLogger>;
-    protected _verbose: ReturnType<typeof createLogger>;
-    protected _error: ReturnType<typeof createLogger>;
-    constructor(prefix: string, request: Request);
-    verbose(...messages: string[]): void;
-    log(...messages: string[]): void;
-    error(...messages: string[]): void;
+    protected request?: Request | undefined;
+    protected _trace: (...args: unknown[]) => void;
+    protected _debug: (...args: unknown[]) => void;
+    protected _info: (...args: unknown[]) => void;
+    protected _warn: (...args: unknown[]) => void;
+    protected _error: (...args: unknown[]) => void;
+    protected _fatal: (...args: unknown[]) => void;
+    constructor(prefix: string, request?: Request | undefined);
+    protected get reqInfo(): string;
+    trace: (...messages: unknown[]) => void;
+    debug: (...messages: unknown[]) => void;
+    info: (...messages: unknown[]) => void;
+    warn: (...messages: unknown[]) => void;
+    error: (...messages: unknown[]) => void;
+    fatal: (...messages: unknown[]) => void;
 }

package/build/logger.js

@@ -2,26 +2,42 @@ import { createLogger } from '@browserless.io/browserless';
 export class Logger {
     prefix;
     request;
-    _log;
-    _verbose;
+    _trace;
+    _debug;
+    _info;
+    _warn;
     _error;
+    _fatal;
     constructor(prefix, request) {
         this.prefix = prefix;
         this.request = request;
-        this._log = createLogger(prefix);
-        this._verbose = this._log.extend('verbose');
-        this._error = this._log.extend('error');
+        const logger = createLogger(prefix);
+        this._trace = logger.extend('trace');
+        this._debug = logger.extend('debug');
+        this._info = logger.extend('info');
+        this._warn = logger.extend('warn');
+        this._error = logger.extend('error');
+        this._fatal = logger.extend('fatal');
     }
-    verbose(...messages) {
-        const ip = this.request.socket.remoteAddress ?? 'Unknown';
-        this._verbose(ip, ...messages);
-    }
-    log(...messages) {
-        const ip = this.request.socket.remoteAddress ?? 'Unknown';
-        this._log(ip, ...messages);
-    }
-    error(...messages) {
-        const ip = this.request.socket.remoteAddress ?? 'Unknown';
-        this._error(ip, ...messages);
+    get reqInfo() {
+        return this.request ? this.request.socket.remoteAddress ?? 'Unknown' : '';
     }
+    trace = (...messages) => {
+        this._trace(this.reqInfo, ...messages);
+    };
+    debug = (...messages) => {
+        this._debug(this.reqInfo, ...messages);
+    };
+    info = (...messages) => {
+        this._info(this.reqInfo, ...messages);
+    };
+    warn = (...messages) => {
+        this._warn(this.reqInfo, ...messages);
+    };
+    error = (...messages) => {
+        this._error(this.reqInfo, ...messages);
+    };
+    fatal = (...messages) => {
+        this._fatal(this.reqInfo, ...messages);
+    };
 }

package/build/monitoring.d.ts

@@ -1,10 +1,9 @@
-/// <reference types="debug" />
 /// <reference types="node" />
-import { Config, IResourceLoad } from '@browserless.io/browserless';
+import { Config, IResourceLoad, Logger } from '@browserless.io/browserless';
 import { EventEmitter } from 'events';
 export declare class Monitoring extends EventEmitter {
     protected config: Config;
-    protected log: import("debug").Debugger;
+    protected log: Logger;
     constructor(config: Config);
     getMachineStats: () => Promise<IResourceLoad>;
     overloaded: () => Promise<{

package/build/monitoring.js

@@ -1,9 +1,9 @@
-import { createLogger, } from '@browserless.io/browserless';
+import { Logger } from '@browserless.io/browserless';
 import { EventEmitter } from 'events';
 import si from 'systeminformation';
 export class Monitoring extends EventEmitter {
     config;
-    log = createLogger('hardware');
+    log = new Logger('hardware');
     constructor(config) {
         super();
         this.config = config;
@@ -13,7 +13,7 @@ export class Monitoring extends EventEmitter {
             si.currentLoad(),
             si.mem(),
         ]).catch((err) => {
-            this.log(`Error checking machine stats`, err);
+            this.log.error(`Error checking machine stats`, err);
             return [null, null];
         });
         const cpu = cpuLoad ? cpuLoad.currentLoadUser / 100 : null;
@@ -27,7 +27,7 @@ export class Monitoring extends EventEmitter {
         const { cpu, memory } = await this.getMachineStats();
         const cpuInt = cpu && Math.ceil(cpu * 100);
         const memoryInt = memory && Math.ceil(memory * 100);
-        this.log(`Checking overload status: CPU ${cpuInt}% Memory ${memoryInt}%`);
+        this.log.info(`Checking overload status: CPU ${cpuInt}% Memory ${memoryInt}%`);
         const cpuOverloaded = !!(cpuInt && cpuInt >= this.config.getCPULimit());
         const memoryOverloaded = !!(memoryInt && memoryInt >= this.config.getMemoryLimit());
         return {

package/build/router.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="debug" />
 /// <reference types="node" />
 /// <reference types="node" />
 /// <reference types="node" />
@@ -10,8 +9,7 @@ export declare class Router extends EventEmitter {
     protected browserManager: BrowserManager;
     protected limiter: Limiter;
     protected logger: typeof Logger;
-    protected log: import("debug").Debugger;
-    protected verbose: import("debug").Debugger;
+    protected log: Logger;
     protected httpRoutes: Array<HTTPRoute | BrowserHTTPRoute>;
     protected webSocketRoutes: Array<WebSocketRoute | BrowserWebsocketRoute>;
     constructor(config: Config, browserManager: BrowserManager, limiter: Limiter, logger: typeof Logger);

package/build/router.js

@@ -1,4 +1,4 @@
-import { HTTPManagementRoutes, contentTypes, createLogger, isConnected, writeResponse, } from '@browserless.io/browserless';
+import { HTTPManagementRoutes, Logger, contentTypes, isConnected, writeResponse, } from '@browserless.io/browserless';
 import { EventEmitter } from 'events';
 import micromatch from 'micromatch';
 export class Router extends EventEmitter {
@@ -6,8 +6,7 @@ export class Router extends EventEmitter {
     browserManager;
     limiter;
     logger;
-    log = createLogger('router');
-    verbose = createLogger('router:verbose');
+    log = new Logger('router');
     httpRoutes = [];
     webSocketRoutes = [];
     constructor(config, browserManager, limiter, logger) {
@@ -22,31 +21,31 @@ export class Router extends EventEmitter {
         return timer ? +timer : undefined;
     }
     onQueueFullHTTP = (_req, res) => {
-        this.log(`Queue is full, sending 429 response`);
+        this.log.warn(`Queue is full, sending 429 response`);
         return writeResponse(res, 429, 'Too many requests');
     };
     onQueueFullWebSocket = (_req, socket) => {
-        this.log(`Queue is full, sending 429 response`);
+        this.log.warn(`Queue is full, sending 429 response`);
         return writeResponse(socket, 429, 'Too many requests');
     };
     onHTTPTimeout = (_req, res) => {
-        this.log(`HTTP job has timedout, sending 429 response`);
+        this.log.error(`HTTP job has timedout, sending 429 response`);
         return writeResponse(res, 408, 'Request has timed out');
     };
     onWebsocketTimeout = (_req, socket) => {
-        this.log(`Websocket job has timedout, sending 429 response`);
+        this.log.error(`Websocket job has timedout, sending 429 response`);
         return writeResponse(socket, 408, 'Request has timed out');
     };
     wrapHTTPHandler = (route, handler) => async (req, res) => {
         if (!isConnected(res)) {
-            this.log(`HTTP Request has closed prior to running`);
+            this.log.warn(`HTTP Request has closed prior to running`);
             return Promise.resolve();
         }
         const logger = new this.logger(route.name, req);
         if ('browser' in route && route.browser) {
-            const browser = await this.browserManager.getBrowserForRequest(req, route);
+            const browser = await this.browserManager.getBrowserForRequest(req, route, logger);
             if (!isConnected(res)) {
-                this.log(`HTTP Request has closed prior to running`);
+                this.log.warn(`HTTP Request has closed prior to running`);
                 this.browserManager.complete(browser);
                 return Promise.resolve();
             }
@@ -54,7 +53,7 @@ export class Router extends EventEmitter {
                 return writeResponse(res, 500, `Error loading the browser`);
             }
             try {
-                this.verbose(`Running found HTTP handler.`);
+                this.log.trace(`Running found HTTP handler.`);
                 return await Promise.race([
                     handler(req, res, logger, browser),
                     new Promise((resolve, reject) => {
@@ -62,14 +61,14 @@ export class Router extends EventEmitter {
                             if (!res.writableEnded) {
                                 reject(new Error(`Request closed prior to writing results`));
                             }
-                            this.verbose(`Response has been written, resolving`);
+                            this.log.trace(`Response has been written, resolving`);
                             resolve(null);
                         });
                     }),
                 ]);
             }
             finally {
-                this.verbose(`HTTP Request handler has finished.`);
+                this.log.trace(`HTTP Request handler has finished.`);
                 this.browserManager.complete(browser);
             }
         }
@@ -77,14 +76,14 @@ export class Router extends EventEmitter {
     };
     wrapWebSocketHandler = (route, handler) => async (req, socket, head) => {
         if (!isConnected(socket)) {
-            this.log(`WebSocket Request has closed prior to running`);
+            this.log.warn(`WebSocket Request has closed prior to running`);
             return Promise.resolve();
         }
         const logger = new this.logger(route.name, req);
         if ('browser' in route && route.browser) {
-            const browser = await this.browserManager.getBrowserForRequest(req, route);
+            const browser = await this.browserManager.getBrowserForRequest(req, route, logger);
             if (!isConnected(socket)) {
-                this.log(`WebSocket Request has closed prior to running`);
+                this.log.warn(`WebSocket Request has closed prior to running`);
                 this.browserManager.complete(browser);
                 return Promise.resolve();
             }
@@ -92,11 +91,11 @@ export class Router extends EventEmitter {
                 return writeResponse(socket, 500, `Error loading the browser.`);
             }
             try {
-                this.verbose(`Running found WebSocket handler.`);
+                this.log.trace(`Running found WebSocket handler.`);
                 await handler(req, socket, head, logger, browser);
             }
             finally {
-                this.verbose(`WebSocket Request handler has finished.`);
+                this.log.trace(`WebSocket Request handler has finished.`);
                 this.browserManager.complete(browser);
             }
             return;
@@ -104,7 +103,7 @@ export class Router extends EventEmitter {
         return handler(req, socket, head, logger);
     };
     registerHTTPRoute(route) {
-        this.verbose(`Registering HTTP ${route.method.toUpperCase()} ${route.path}`);
+        this.log.trace(`Registering HTTP ${route.method.toUpperCase()} ${route.path}`);
         const bound = route.handler.bind(route);
         const wrapped = this.wrapHTTPHandler(route, bound);
         route.handler = route.concurrency
@@ -114,13 +113,13 @@ export class Router extends EventEmitter {
         const registeredPaths = this.httpRoutes.map((r) => r.path).flat();
         const duplicatePaths = registeredPaths.filter((path) => route.path.includes(path));
         if (duplicatePaths.length) {
-            this.log(`Found duplicate routes: ${duplicatePaths.join(', ')}`);
+            this.log.warn(`Found duplicate routes: ${duplicatePaths.join(', ')}`);
         }
         this.httpRoutes.push(route);
         return route;
     }
     registerWebSocketRoute(route) {
-        this.verbose(`Registering WebSocket "${route.path}"`);
+        this.log.trace(`Registering WebSocket "${route.path}"`);
         const bound = route.handler.bind(route);
         const wrapped = this.wrapWebSocketHandler(route, bound);
         route.handler = route.concurrency
@@ -130,7 +129,7 @@ export class Router extends EventEmitter {
         const registeredPaths = this.webSocketRoutes.map((r) => r.path).flat();
         const duplicatePaths = registeredPaths.filter((path) => route.path.includes(path));
         if (duplicatePaths.length) {
-            this.log(`Found duplicate routes: ${duplicatePaths.join(', ')}`);
+            this.log.warn(`Found duplicate routes: ${duplicatePaths.join(', ')}`);
         }
         this.webSocketRoutes.push(route);
         return route;

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

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

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

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

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

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

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

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

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

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

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

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