@browserless.io/browserless 2.7.0 → 2.8.0

package/build/shared/download.http.js

@@ -21,15 +21,14 @@ export default class ChromiumDownloadPostRoute extends BrowserHTTPRoute {
     method = Methods.post;
     path = [HTTPRoutes.download, HTTPRoutes.chromiumDownload];
     tags = [APITags.browserAPI];
-    handler = async (req, res, browser) => new Promise(async (resolve, reject) => {
-        const debug = this.debug();
+    handler = async (req, res, logger, browser) => new Promise(async (resolve, reject) => {
         const config = this.config();
         const downloadPath = path.join(await config.getDownloadsDir(), `.browserless.download.${id()}`);
-        debug(`Generating a download directory at "${downloadPath}"`);
+        logger.log(`Generating a download directory at "${downloadPath}"`);
         await mkdir(downloadPath);
-        const handler = functionHandler(config, debug, { downloadPath });
+        const handler = functionHandler(config, logger, { downloadPath });
         const response = await handler(req, browser).catch((e) => {
-            debug(`Error running download code handler: "${e}"`);
+            logger.log(`Error running download code handler: "${e}"`);
             reject(e);
             return null;
         });
@@ -37,10 +36,10 @@ export default class ChromiumDownloadPostRoute extends BrowserHTTPRoute {
             return;
         }
         const { page } = response;
-        debug(`Download function has returned, finding downloads...`);
+        logger.log(`Download function has returned, finding downloads...`);
         async function checkIfDownloadComplete() {
             if (res.headersSent) {
-                debug(`Request headers have been sent, terminating download watch.`);
+                logger.log(`Request headers have been sent, terminating download watch.`);
                 return null;
             }
             const [fileName] = await readdir(downloadPath);
@@ -48,20 +47,20 @@ export default class ChromiumDownloadPostRoute extends BrowserHTTPRoute {
                 await sleep(500);
                 return checkIfDownloadComplete();
             }
-            debug(`All files have finished downloading`);
+            logger.log(`All files have finished downloading`);
             return path.join(downloadPath, fileName);
         }
         const filePath = await checkIfDownloadComplete();
-        debug(`Closing pages.`);
+        logger.log(`Closing pages.`);
         page.close();
         page.removeAllListeners();
         const rmDownload = once(() => filePath &&
             deleteAsync(filePath, { force: true })
                 .then(() => {
-                debug(`Successfully deleted downloads from disk at "${filePath}"`);
+                logger.log(`Successfully deleted downloads from disk at "${filePath}"`);
             })
                 .catch((err) => {
-                debug(`Error cleaning up downloaded files: "${err}" at "${filePath}"`);
+                logger.log(`Error cleaning up downloaded files: "${err}" at "${filePath}"`);
             }));
         if (res.headersSent || !filePath) {
             rmDownload();
@@ -79,7 +78,7 @@ export default class ChromiumDownloadPostRoute extends BrowserHTTPRoute {
             }
         })
             .on('end', () => {
-            debug(`Downloads successfully sent`);
+            logger.log(`Downloads successfully sent`);
             rmDownload();
             return resolve();
         })

package/build/shared/function.http.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="node" />
-import { APITags, BrowserHTTPRoute, BrowserInstance, CDPLaunchOptions, ChromiumCDP, HTTPRoutes, Methods, Request, SystemQueryParameters, contentTypes } from '@browserless.io/browserless';
+import { APITags, BrowserHTTPRoute, BrowserInstance, CDPLaunchOptions, ChromiumCDP, HTTPRoutes, Logger, Methods, Request, SystemQueryParameters, contentTypes } from '@browserless.io/browserless';
 import { ServerResponse } from 'http';
 interface JSONSchema {
     code: string;
@@ -27,6 +27,6 @@ export default class ChromiumFunctionPostRoute extends BrowserHTTPRoute {
     method: Methods;
     path: HTTPRoutes[];
     tags: APITags[];
-    handler: (req: Request, res: ServerResponse, browser: BrowserInstance) => Promise<void>;
+    handler: (req: Request, res: ServerResponse, logger: Logger, browser: BrowserInstance) => Promise<void>;
 }
 export {};

package/build/shared/function.http.js

@@ -18,12 +18,11 @@ export default class ChromiumFunctionPostRoute extends BrowserHTTPRoute {
     method = Methods.post;
     path = [HTTPRoutes.function, HTTPRoutes.chromiumFunction];
     tags = [APITags.browserAPI];
-    handler = async (req, res, browser) => {
-        const debug = this.debug();
+    handler = async (req, res, logger, browser) => {
         const config = this.config();
-        const handler = functionHandler(config, debug);
+        const handler = functionHandler(config, logger);
         const { contentType, payload, page } = await handler(req, browser);
-        debug(`Got function response of "${contentType}"`);
+        logger.log(`Got function response of "${contentType}"`);
         page.close();
         page.removeAllListeners();
         if (contentType === 'uint8array') {
@@ -34,7 +33,7 @@ export default class ChromiumFunctionPostRoute extends BrowserHTTPRoute {
                 throw new BadRequest(`Couldn't determine function's response type.`);
             }
             else {
-                debug(`Sending file-type response of "${type}"`);
+                logger.log(`Sending file-type response of "${type}"`);
                 const readStream = new Stream.PassThrough();
                 readStream.end(response);
                 res.setHeader('Content-Type', type);

package/build/shared/page.ws.d.ts

@@ -1,6 +1,6 @@
 /// <reference types="node" />
 /// <reference types="node" />
-import { APITags, BrowserWebsocketRoute, CDPLaunchOptions, ChromiumCDP, Request, SystemQueryParameters, WebsocketRoutes } from '@browserless.io/browserless';
+import { APITags, BrowserWebsocketRoute, CDPLaunchOptions, ChromiumCDP, Logger, Request, SystemQueryParameters, WebsocketRoutes } from '@browserless.io/browserless';
 import { Duplex } from 'stream';
 export interface QuerySchema extends SystemQueryParameters {
     launch?: CDPLaunchOptions | string;
@@ -13,5 +13,5 @@ export default class ChromiumPageWebSocketRoute extends BrowserWebsocketRoute {
     description: string;
     path: WebsocketRoutes;
     tags: APITags[];
-    handler: (req: Request, socket: Duplex, head: Buffer, browser: ChromiumCDP) => Promise<void>;
+    handler: (req: Request, socket: Duplex, head: Buffer, _logger: Logger, browser: ChromiumCDP) => Promise<void>;
 }

package/build/shared/page.ws.js

@@ -10,5 +10,5 @@ export default class ChromiumPageWebSocketRoute extends BrowserWebsocketRoute {
     or by finding the page's unique ID from your library of choice.`);
     path = WebsocketRoutes.page;
     tags = [APITags.browserWS];
-    handler = async (req, socket, head, browser) => browser.proxyPageWebSocket(req, socket, head);
+    handler = async (req, socket, head, _logger, browser) => browser.proxyPageWebSocket(req, socket, head);
 }

package/build/shared/pdf.http.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="node" />
-import { APITags, BrowserHTTPRoute, BrowserInstance, CDPLaunchOptions, ChromiumCDP, HTTPRoutes, Methods, Request, SystemQueryParameters, WaitForEventOptions, WaitForFunctionOptions, WaitForSelectorOptions, bestAttempt, contentTypes, rejectRequestPattern, rejectResourceTypes, requestInterceptors } from '@browserless.io/browserless';
+import { APITags, BrowserHTTPRoute, BrowserInstance, CDPLaunchOptions, ChromiumCDP, HTTPRoutes, Logger, Methods, Request, SystemQueryParameters, WaitForEventOptions, WaitForFunctionOptions, WaitForSelectorOptions, bestAttempt, contentTypes, rejectRequestPattern, rejectResourceTypes, requestInterceptors } from '@browserless.io/browserless';
 import { Page } from 'puppeteer-core';
 import { ServerResponse } from 'http';
 export interface BodySchema {
@@ -43,5 +43,5 @@ export default class ChromiumPDFPostRoute extends BrowserHTTPRoute {
     method: Methods;
     path: HTTPRoutes[];
     tags: APITags[];
-    handler: (req: Request, res: ServerResponse, browser: BrowserInstance) => Promise<void>;
+    handler: (req: Request, res: ServerResponse, _logger: Logger, browser: BrowserInstance) => Promise<void>;
 }

package/build/shared/pdf.http.js

@@ -16,7 +16,7 @@ export default class ChromiumPDFPostRoute extends BrowserHTTPRoute {
     method = Methods.post;
     path = [HTTPRoutes.pdf, HTTPRoutes.chromiumPdf];
     tags = [APITags.browserAPI];
-    handler = async (req, res, browser) => {
+    handler = async (req, res, _logger, browser) => {
         const contentType = !req.headers.accept || req.headers.accept?.includes('*')
             ? 'application/pdf'
             : req.headers.accept;

package/build/shared/performance.http.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="node" />
-import { APITags, BrowserHTTPRoute, BrowserInstance, CDPLaunchOptions, ChromiumCDP, HTTPRoutes, Methods, Request, SystemQueryParameters, contentTypes } from '@browserless.io/browserless';
+import { APITags, BrowserHTTPRoute, BrowserInstance, CDPLaunchOptions, ChromiumCDP, HTTPRoutes, Logger, Methods, Request, SystemQueryParameters, contentTypes } from '@browserless.io/browserless';
 import { ServerResponse } from 'http';
 export interface BodySchema {
     budgets?: Array<object>;
@@ -26,5 +26,5 @@ export default class PerformancePost extends BrowserHTTPRoute {
     method: Methods;
     path: HTTPRoutes[];
     tags: APITags[];
-    handler: (req: Request, res: ServerResponse, browser: BrowserInstance) => Promise<void>;
+    handler: (req: Request, res: ServerResponse, _logger: Logger, browser: BrowserInstance) => Promise<void>;
 }

package/build/shared/performance.http.js

@@ -11,7 +11,7 @@ export default class PerformancePost extends BrowserHTTPRoute {
     method = Methods.post;
     path = [HTTPRoutes.performance, HTTPRoutes.chromiumPerformance];
     tags = [APITags.browserAPI];
-    handler = async (req, res, browser) => {
+    handler = async (req, res, _logger, browser) => {
         const config = this.config();
         const response = await main({
             browser,

package/build/shared/scrape.http.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="node" />
-import { APITags, BrowserHTTPRoute, BrowserInstance, CDPLaunchOptions, ChromiumCDP, HTTPRoutes, InBoundRequest, Methods, OutBoundRequest, Request, ScrapeDebugOptions, ScrapeElementSelector, SystemQueryParameters, WaitForEventOptions, WaitForFunctionOptions, WaitForSelectorOptions, bestAttempt, contentTypes, rejectRequestPattern, rejectResourceTypes, requestInterceptors } from '@browserless.io/browserless';
+import { APITags, BrowserHTTPRoute, BrowserInstance, CDPLaunchOptions, ChromiumCDP, HTTPRoutes, InBoundRequest, Logger, Methods, OutBoundRequest, Request, ScrapeDebugOptions, ScrapeElementSelector, SystemQueryParameters, WaitForEventOptions, WaitForFunctionOptions, WaitForSelectorOptions, bestAttempt, contentTypes, rejectRequestPattern, rejectResourceTypes, requestInterceptors } from '@browserless.io/browserless';
 import { Cookie, Page } from 'puppeteer-core';
 import { ServerResponse } from 'http';
 export interface BodySchema {
@@ -115,5 +115,5 @@ export default class ChromiumScrapePostRoute extends BrowserHTTPRoute {
     method: Methods;
     path: HTTPRoutes[];
     tags: APITags[];
-    handler: (req: Request, res: ServerResponse, browser: BrowserInstance) => Promise<void>;
+    handler: (req: Request, res: ServerResponse, _logger: Logger, browser: BrowserInstance) => Promise<void>;
 }

package/build/shared/scrape.http.js

@@ -54,7 +54,7 @@ export default class ChromiumScrapePostRoute extends BrowserHTTPRoute {
     method = Methods.post;
     path = [HTTPRoutes.scrape, HTTPRoutes.chromiumScrape];
     tags = [APITags.browserAPI];
-    handler = async (req, res, browser) => {
+    handler = async (req, res, _logger, browser) => {
         const contentType = !req.headers.accept || req.headers.accept?.includes('*')
             ? contentTypes.html
             : req.headers.accept;

package/build/shared/screenshot.http.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="node" />
-import { APITags, BrowserHTTPRoute, BrowserInstance, CDPLaunchOptions, ChromiumCDP, HTTPRoutes, Methods, Request, SystemQueryParameters, WaitForEventOptions, WaitForFunctionOptions, WaitForSelectorOptions, bestAttempt, contentTypes, rejectRequestPattern, rejectResourceTypes, requestInterceptors } from '@browserless.io/browserless';
+import { APITags, BrowserHTTPRoute, BrowserInstance, CDPLaunchOptions, ChromiumCDP, HTTPRoutes, Logger, Methods, Request, SystemQueryParameters, WaitForEventOptions, WaitForFunctionOptions, WaitForSelectorOptions, bestAttempt, contentTypes, rejectRequestPattern, rejectResourceTypes, requestInterceptors } from '@browserless.io/browserless';
 import { Page } from 'puppeteer-core';
 import { ServerResponse } from 'http';
 export interface QuerySchema extends SystemQueryParameters {
@@ -46,5 +46,5 @@ export default class ScreenshotPost extends BrowserHTTPRoute {
     method: Methods;
     path: HTTPRoutes[];
     tags: APITags[];
-    handler: (req: Request, res: ServerResponse, browser: BrowserInstance) => Promise<void>;
+    handler: (req: Request, res: ServerResponse, _logger: Logger, browser: BrowserInstance) => Promise<void>;
 }

package/build/shared/screenshot.http.js

@@ -15,7 +15,7 @@ export default class ScreenshotPost extends BrowserHTTPRoute {
     method = Methods.post;
     path = [HTTPRoutes.screenshot, HTTPRoutes.chromiumScreenshot];
     tags = [APITags.browserAPI];
-    handler = async (req, res, browser) => {
+    handler = async (req, res, _logger, browser) => {
         const contentType = !req.headers.accept || req.headers.accept?.includes('*')
             ? 'image/png'
             : req.headers.accept;

package/build/shared/utils/function/handler.d.ts

@@ -1,7 +1,6 @@
-import { BrowserInstance, Config, Request } from '@browserless.io/browserless';
+import { BrowserInstance, Config, Logger, Request } from '@browserless.io/browserless';
 import { FunctionRunner } from './client.js';
 import { Page } from 'puppeteer-core';
-import debug from 'debug';
 declare global {
     interface Window {
         BrowserlessFunctionRunner: typeof FunctionRunner;
@@ -10,7 +9,7 @@ declare global {
 interface HandlerOptions {
     downloadPath?: string;
 }
-declare const _default: (config: Config, debug: debug.Debugger, options?: HandlerOptions) => (req: Request, browser: BrowserInstance) => Promise<{
+declare const _default: (config: Config, logger: Logger, options?: HandlerOptions) => (req: Request, browser: BrowserInstance) => Promise<{
     contentType: string;
     page: Page;
     payload: unknown;

package/build/shared/utils/function/handler.js

@@ -1,7 +1,7 @@
 import { BadRequest, HTTPRoutes, contentTypes, convertIfBase64, exists, getTokenFromRequest, id, makeExternalURL, mimeTypes, } from '@browserless.io/browserless';
 import fs from 'fs';
 import path from 'path';
-export default (config, debug, options = {}) => async (req, browser) => {
+export default (config, logger, options = {}) => async (req, browser) => {
     const isJson = req.headers['content-type']?.includes('json');
     const functionAssetLocation = path.join(config.getStatic(), 'function');
     const functionRequestPath = makeExternalURL(config.getExternalAddress(), HTTPRoutes.function);
@@ -29,7 +29,7 @@ export default (config, debug, options = {}) => async (req, browser) => {
      */
     page.on('request', async (request) => {
         const requestUrl = request.url();
-        debug(`Outbound Page Request: "${requestUrl}"`);
+        logger.log(`Outbound Page Request: "${requestUrl}"`);
         if (requestUrl.startsWith(functionRequestPath)) {
             const filename = path.basename(requestUrl);
             if (filename === functionCodeJS) {
@@ -48,23 +48,23 @@ export default (config, debug, options = {}) => async (req, browser) => {
                     status: 200,
                 });
             }
-            debug(`Static asset request to "${requestUrl}" couldn't be found, 404-ing`);
+            logger.log(`Static asset request to "${requestUrl}" couldn't be found, 404-ing`);
             return request.respond({
                 body: code,
                 contentType: `Couldn't locate this file "${filename}" request "${requestUrl}" in "${functionAssetLocation}"`,
                 status: 404,
             });
         }
-        debug(`Request: "${requestUrl}" no responder found, continuing...`);
+        logger.log(`Request: "${requestUrl}" no responder found, continuing...`);
         return request.continue();
     });
     page.on('response', (res) => {
         if (res.status() !== 200) {
-            debug(`Received a non-200 response for request "${res.url()}"`);
+            logger.log(`Received a non-200 response for request "${res.url()}"`);
         }
     });
     page.on('console', (event) => {
-        debug(`${event.type()}: ${event.text()}`);
+        logger.log(`${event.type()}: ${event.text()}`);
     });
     await page.goto(functionIndexHTML);
     const { contentType, payload } = await page
@@ -85,7 +85,7 @@ export default (config, debug, options = {}) => async (req, browser) => {
         });
     }, browserWSEndpoint, context, functionCodeJS, JSON.stringify(options))
         .catch((e) => {
-        debug(`Error running code: ${e}`);
+        logger.log(`Error running code: ${e}`);
         throw new BadRequest(e.message);
     });
     return {

package/build/types.d.ts

@@ -1,10 +1,9 @@
 /// <reference types="node" />
 /// <reference types="node" />
 /// <reference types="node" />
-/// <reference types="debug" />
 import * as http from 'http';
 import * as stream from 'stream';
-import { APITags, Browserless, ChromiumCDP, ChromiumPlaywright, Config, FirefoxPlaywright, HTTPManagementRoutes, HTTPRoutes, Methods, Metrics, Request, WebkitPlaywright, WebsocketRoutes, contentTypes } from '@browserless.io/browserless';
+import { APITags, Browserless, ChromiumCDP, ChromiumPlaywright, Config, FirefoxPlaywright, HTTPManagementRoutes, HTTPRoutes, Logger, Methods, Metrics, Request, WebkitPlaywright, WebsocketRoutes, contentTypes } from '@browserless.io/browserless';
 import { HTTPRequest, Page, ResponseForRequest, ScreenshotOptions } from 'puppeteer-core';
 export type PathTypes = HTTPRoutes | WebsocketRoutes | HTTPManagementRoutes | string;
 export interface BeforeRequest {
@@ -52,11 +51,10 @@ declare abstract class Route {
     protected _browserManager: Browserless['browserManager'];
     protected _config: Browserless['config'];
     protected _fileSystem: Browserless['fileSystem'];
-    protected _debug: Browserless['debug'];
     protected _metrics: Browserless['metrics'];
     protected _monitoring: Browserless['monitoring'];
     protected _staticSDKDir: Browserless['staticSDKDir'];
-    constructor(_browserManager: Browserless['browserManager'], _config: Browserless['config'], _fileSystem: Browserless['fileSystem'], _debug: Browserless['debug'], _metrics: Browserless['metrics'], _monitoring: Browserless['monitoring'], _staticSDKDir: Browserless['staticSDKDir']);
+    constructor(_browserManager: Browserless['browserManager'], _config: Browserless['config'], _fileSystem: Browserless['fileSystem'], _metrics: Browserless['metrics'], _monitoring: Browserless['monitoring'], _staticSDKDir: Browserless['staticSDKDir']);
     /**
      * A unique name to identify this route. Used in downstream
      * SDKs to potentially remove or disable.
@@ -107,13 +105,6 @@ declare abstract class Route {
      * @returns Config
      */
     config: () => Config;
-    /**
-     * Helper function that loads the debug module, useful
-     * for logging messages scoped to the routes path. Defined
-     * and injected by browserless after initialization.
-     * @returns Debug
-     */
-    debug: () => import("debug").Debugger;
     /**
      * Helper function that loads the file-system module
      * for interacting with file-systems. Defined and injected by
@@ -184,7 +175,7 @@ export declare abstract class HTTPRoute extends BasicHTTPRoute {
     /**
      * Handles an inbound HTTP request, and supplies the Request and Response objects from node's HTTP request event
      */
-    abstract handler: (req: Request, res: http.ServerResponse) => Promise<unknown>;
+    abstract handler: (req: Request, res: http.ServerResponse, logger: Logger) => Promise<unknown>;
 }
 /**
  * A HTTP-based route, with a handler, that can fulfill requests but
@@ -198,7 +189,7 @@ export declare abstract class BrowserHTTPRoute extends BasicHTTPRoute {
      * Handles an inbound HTTP request with a 3rd param of the predefined
      * browser used for the route -- only Chrome CDP is support currently.
      */
-    abstract handler: (req: Request, res: http.ServerResponse, browser: BrowserInstance) => Promise<unknown>;
+    abstract handler: (req: Request, res: http.ServerResponse, logger: Logger, browser: BrowserInstance) => Promise<unknown>;
     /**
      * An optional function to automatically set up or handle new page
      * creation. Useful for injecting behaviors or other functionality.
@@ -214,7 +205,7 @@ export declare abstract class WebSocketRoute extends Route {
     /**
      * Handles an inbound Websocket request, and handles the connection
      */
-    abstract handler: (req: Request, socket: stream.Duplex, head: Buffer) => Promise<unknown>;
+    abstract handler: (req: Request, socket: stream.Duplex, head: Buffer, logger: Logger) => Promise<unknown>;
 }
 /**
  * A WebSocket-based route, with a handler, that can fulfill requests
@@ -228,7 +219,7 @@ export declare abstract class BrowserWebsocketRoute extends Route {
      * Handles an inbound Websocket request, and handles the connection
      * with the prior set browser being injected.
      */
-    abstract handler(req: Request, socket: stream.Duplex, head: Buffer, browser: BrowserInstance): Promise<unknown>;
+    abstract handler(req: Request, socket: stream.Duplex, head: Buffer, logger: Logger, browser: BrowserInstance): Promise<unknown>;
     /**
      * An optional function to automatically set up or handle new page
      * creation. Useful for injecting behaviors or other functionality.

package/build/types.js

@@ -2,15 +2,13 @@ class Route {
     _browserManager;
     _config;
     _fileSystem;
-    _debug;
     _metrics;
     _monitoring;
     _staticSDKDir;
-    constructor(_browserManager, _config, _fileSystem, _debug, _metrics, _monitoring, _staticSDKDir) {
+    constructor(_browserManager, _config, _fileSystem, _metrics, _monitoring, _staticSDKDir) {
         this._browserManager = _browserManager;
         this._config = _config;
         this._fileSystem = _fileSystem;
-        this._debug = _debug;
         this._metrics = _metrics;
         this._monitoring = _monitoring;
         this._staticSDKDir = _staticSDKDir;
@@ -60,13 +58,6 @@ class Route {
      * @returns Config
      */
     config = () => this._config;
-    /**
-     * Helper function that loads the debug module, useful
-     * for logging messages scoped to the routes path. Defined
-     * and injected by browserless after initialization.
-     * @returns Debug
-     */
-    debug = () => this._debug;
     /**
      * Helper function that loads the file-system module
      * for interacting with file-systems. Defined and injected by

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@browserless.io/browserless",
-  "version": "2.7.0",
+  "version": "2.8.0",
   "license": "SSPL",
   "description": "The browserless platform",
   "author": "browserless.io",
@@ -58,7 +58,7 @@
     "lighthouse": "^11.1.0",
     "micromatch": "^4.0.4",
     "playwright-core": "1.43.0",
-    "puppeteer-core": "^22.6.3",
+    "puppeteer-core": "^22.6.4",
     "puppeteer-extra": "^3.3.6",
     "puppeteer-extra-plugin-stealth": "^2.11.2",
     "queue": "^7.0.0",
@@ -90,7 +90,7 @@
     "prettier": "^3.2.5",
     "sinon": "^17.0.1",
     "ts-node": "^10.9.2",
-    "typescript": "^5.4.4",
+    "typescript": "^5.4.5",
     "typescript-json-schema": "^0.63.0"
   },
   "eslintConfig": {

package/scripts/start.sh

@@ -13,7 +13,8 @@ _kill_procs() {
 # Relay quit commands to processes
 trap _kill_procs SIGTERM SIGINT
 
-if [ -z "$DISPLAY" ] then
+if [ -z "$DISPLAY" ]
+then
   Xvfb :99 -screen 0 1024x768x16 -nolisten tcp -nolisten unix &
   xvfb=$!
   export DISPLAY=:99

package/scripts/test.sh

@@ -4,14 +4,17 @@ set -e
 # Install all dependencies for tests
 npm i --production=false
 
-# Setup env variables
-export DISPLAY=:1
+# Setup Env Variables
 export DEBUG=-*
 export PUPPETEER_DISABLE_HEADLESS_WARNING=true
 export NODE_OPTIONS="--loader ts-node/esm"
 
-Xvfb :1 -screen 0 1024x768x16 -nolisten tcp -nolisten unix &
-xvfb=$!
+if [ -z "$DISPLAY" ]
+then
+  Xvfb :99 -screen 0 1024x768x16 -nolisten tcp -nolisten unix &
+  xvfb=$!
+  export DISPLAY=:99
+fi
 
 # Run the tests
 ./node_modules/.bin/_mocha --timeout 30000 --slow 10000 --exit $@ && kill -TERM $xvfb

package/src/browserless.ts

@@ -1,5 +1,6 @@
 import * as path from 'path';
 import {
+  Logger as BlessLogger,
   BrowserHTTPRoute,
   BrowserManager,
   BrowserWebsocketRoute,
@@ -51,6 +52,7 @@ export class Browserless extends EventEmitter {
   protected fileSystem: FileSystem;
   protected hooks: Hooks;
   protected limiter: Limiter;
+  protected Logger: typeof BlessLogger;
   protected metrics: Metrics;
   protected monitoring: Monitoring;
   protected router: Router;
@@ -71,12 +73,14 @@ export class Browserless extends EventEmitter {
     fileSystem,
     hooks,
     limiter,
+    Logger: LoggerOverride,
     metrics,
     monitoring,
     router,
     token,
     webhooks,
   }: {
+    Logger?: Browserless['Logger'];
     browserManager?: Browserless['browserManager'];
     config?: Browserless['config'];
     fileSystem?: Browserless['fileSystem'];
@@ -89,6 +93,7 @@ export class Browserless extends EventEmitter {
     webhooks?: Browserless['webhooks'];
   } = {}) {
     super();
+    this.Logger = LoggerOverride ?? BlessLogger;
     this.config = config || new Config();
     this.metrics = metrics || new Metrics();
     this.token = token || new Token(this.config);
@@ -108,7 +113,8 @@ export class Browserless extends EventEmitter {
         this.hooks,
       );
     this.router =
-      router || new Router(this.config, this.browserManager, this.limiter);
+      router ||
+      new Router(this.config, this.browserManager, this.limiter, this.Logger);
   }
 
   protected saveMetrics = async (): Promise<void> => {
@@ -235,7 +241,6 @@ export class Browserless extends EventEmitter {
       ...internalHttpRouteFiles,
     ]) {
       if (httpRoute.endsWith('js')) {
-        const { name } = path.parse(httpRoute);
         const [bodySchema, querySchema] = await Promise.all(
           routeSchemas.map(async (schemaType) => {
             const schemaPath = path.parse(httpRoute);
@@ -249,7 +254,6 @@ export class Browserless extends EventEmitter {
         const routeImport = `${
           this.config.getIsWin() ? 'file:///' : ''
         }${httpRoute}`;
-        const logger = createLogger(`http:${name}`);
         const {
           default: Route,
         }: { default: Implements<HTTPRoute> | Implements<BrowserHTTPRoute> } =
@@ -258,7 +262,6 @@ export class Browserless extends EventEmitter {
           this.browserManager,
           this.config,
           this.fileSystem,
-          logger,
           this.metrics,
           this.monitoring,
           this.staticSDKDir,
@@ -271,7 +274,6 @@ export class Browserless extends EventEmitter {
           route.metrics = () => this.metrics;
           route.monitoring = () => this.monitoring;
           route.fileSystem = () => this.fileSystem;
-          route.debug = () => logger;
           route.staticSDKDir = () => this.staticSDKDir;
 
           httpRoutes.push(route);
@@ -285,7 +287,6 @@ export class Browserless extends EventEmitter {
       ...internalWsRouteFiles,
     ]) {
       if (wsRoute.endsWith('js')) {
-        const { name } = path.parse(wsRoute);
         const [, querySchema] = await Promise.all(
           routeSchemas.map(async (schemaType) => {
             const schemaPath = path.parse(wsRoute);
@@ -299,7 +300,6 @@ export class Browserless extends EventEmitter {
         const wsImport = `${
           this.config.getIsWin() ? 'file:///' : ''
         }${wsRoute}`;
-        const logger = createLogger(`ws:${name}`);
         const {
           default: Route,
         }: {
@@ -311,7 +311,6 @@ export class Browserless extends EventEmitter {
           this.browserManager,
           this.config,
           this.fileSystem,
-          logger,
           this.metrics,
           this.monitoring,
           this.staticSDKDir,
@@ -323,7 +322,6 @@ export class Browserless extends EventEmitter {
           route.metrics = () => this.metrics;
           route.monitoring = () => this.monitoring;
           route.fileSystem = () => this.fileSystem;
-          route.debug = () => logger;
           route.staticSDKDir = () => this.staticSDKDir;
 
           wsRoutes.push(route);
@@ -368,6 +366,7 @@ export class Browserless extends EventEmitter {
       this.token,
       this.router,
       this.hooks,
+      this.Logger,
     );
 
     await this.server.start();

package/src/exports.ts

@@ -6,6 +6,7 @@ export * from './file-system.js';
 export * from './hooks.js';
 export * from './http.js';
 export * from './limiter.js';
+export * from './logger.js';
 export * from './metrics.js';
 export * from './mime-types.js';
 export * from './monitoring.js';

package/src/logger.ts

@@ -0,0 +1,31 @@
+import { Request, createLogger } from '@browserless.io/browserless';
+
+export class Logger {
+  protected _log: ReturnType<typeof createLogger>;
+  protected _verbose: ReturnType<typeof createLogger>;
+  protected _error: ReturnType<typeof createLogger>;
+
+  constructor(
+    protected prefix: string,
+    protected request: Request,
+  ) {
+    this._log = createLogger(prefix);
+    this._verbose = this._log.extend('verbose');
+    this._error = this._log.extend('error');
+  }
+
+  public verbose(...messages: string[]) {
+    const ip = this.request.socket.remoteAddress ?? 'Unknown';
+    this._verbose(ip, ...messages);
+  }
+
+  public log(...messages: string[]) {
+    const ip = this.request.socket.remoteAddress ?? 'Unknown';
+    this._log(ip, ...messages);
+  }
+
+  public error(...messages: string[]) {
+    const ip = this.request.socket.remoteAddress ?? 'Unknown';
+    this._error(ip, ...messages);
+  }
+}