@browserless.io/browserless 2.8.0 → 2.9.0

package/build/browsers/firefox.playwright.js

@@ -1,4 +1,4 @@
-import { ServerError, createLogger, } from '@browserless.io/browserless';
+import { ServerError, } from '@browserless.io/browserless';
 import playwright from 'playwright-core';
 import { EventEmitter } from 'events';
 import httpProxy from 'http-proxy';
@@ -7,15 +7,16 @@ export class FirefoxPlaywright extends EventEmitter {
     config;
     userDataDir;
     running = false;
+    logger;
     proxy = httpProxy.createProxyServer();
     browser = null;
     browserWSEndpoint = null;
-    debug = createLogger('browsers:firefox:playwright');
-    constructor({ config, userDataDir, }) {
+    constructor({ config, userDataDir, logger, }) {
         super();
         this.userDataDir = userDataDir;
         this.config = config;
-        this.debug(`Starting new browser instance`);
+        this.logger = logger;
+        this.logger.info(`Starting new ${this.constructor.name} instance`);
     }
     cleanListeners() {
         this.removeAllListeners();
@@ -23,7 +24,7 @@ export class FirefoxPlaywright extends EventEmitter {
     isRunning = () => this.running;
     close = async () => {
         if (this.browser) {
-            this.debug(`Closing browser process and all listeners`);
+            this.logger.trace(`Closing ${this.constructor.name} process and all listeners`);
             this.emit('close');
             this.cleanListeners();
             this.browser.close();
@@ -34,16 +35,16 @@ export class FirefoxPlaywright extends EventEmitter {
     };
     pages = async () => [];
     getPageId = () => {
-        throw new ServerError(`#getPageId is not yet supported with this browser.`);
+        throw new ServerError(`#getPageId is not yet supported with ${this.constructor.name}.`);
     };
     makeLiveURL = () => {
-        throw new ServerError(`Live URLs are not yet supported with this browser.`);
+        throw new ServerError(`Live URLs are not yet supported with ${this.constructor.name}.`);
     };
     newPage = async () => {
-        throw new ServerError(`Can't create new page with this browser`);
+        throw new ServerError(`Can't create new page with ${this.constructor.name}`);
     };
     launch = async (options = {}) => {
-        this.debug(`Launching Playwright Handler`);
+        this.logger.info(`Launching ${this.constructor.name} Handler`);
         this.browser = await playwright.firefox.launchServer({
             ...options,
             args: [
@@ -53,7 +54,7 @@ export class FirefoxPlaywright extends EventEmitter {
             executablePath: playwright.firefox.executablePath(),
         });
         const browserWSEndpoint = this.browser.wsEndpoint();
-        this.debug(`Browser is running on ${browserWSEndpoint}`);
+        this.logger.info(`${this.constructor.name} is running on ${browserWSEndpoint}`);
         this.browserWSEndpoint = browserWSEndpoint;
         this.running = true;
         return this.browser;
@@ -72,14 +73,14 @@ export class FirefoxPlaywright extends EventEmitter {
         return externalURL.href;
     };
     proxyPageWebSocket = async () => {
-        console.warn(`Not yet implemented`);
+        this.logger.warn(`Not yet implemented in ${this.constructor.name}`);
     };
     proxyWebSocket = async (req, socket, head) => new Promise((resolve, reject) => {
         if (!this.browserWSEndpoint) {
             throw new ServerError(`No browserWSEndpoint found, did you launch first?`);
         }
         socket.once('close', resolve);
-        this.debug(`Proxying ${req.parsed.href} to browser ${this.browserWSEndpoint}`);
+        this.logger.info(`Proxying ${req.parsed.href} to ${this.constructor.name} ${this.browserWSEndpoint}`);
         // Delete headers known to cause issues
         delete req.headers.origin;
         req.url = '';
@@ -87,7 +88,7 @@ export class FirefoxPlaywright extends EventEmitter {
             changeOrigin: true,
             target: this.browserWSEndpoint,
         }, (error) => {
-            this.debug(`Error proxying session: ${error}`);
+            this.logger.error(`Error proxying session to ${this.constructor.name}: ${error}`);
             this.close();
             return reject(error);
         });

package/build/browsers/index.d.ts

@@ -1,5 +1,4 @@
-/// <reference types="debug" />
-import { BrowserHTTPRoute, BrowserInstance, BrowserWebsocketRoute, BrowserlessSession, BrowserlessSessionJSON, CDPJSONPayload, ChromiumCDP, Config, Hooks, Request } from '@browserless.io/browserless';
+import { BrowserHTTPRoute, BrowserInstance, BrowserServerOptions, BrowserWebsocketRoute, BrowserlessSession, BrowserlessSessionJSON, CDPJSONPayload, CDPLaunchOptions, ChromiumCDP, Config, Hooks, Logger, Request } from '@browserless.io/browserless';
 import { Page } from 'puppeteer-core';
 export declare class BrowserManager {
     protected config: Config;
@@ -7,11 +6,11 @@ export declare class BrowserManager {
     protected browsers: Map<BrowserInstance, BrowserlessSession>;
     protected launching: Map<string, Promise<unknown>>;
     protected timers: Map<string, number>;
-    protected debug: import("debug").Debugger;
+    protected log: Logger;
     protected chromeBrowsers: (typeof ChromiumCDP)[];
     protected playwrightBrowserNames: string[];
     constructor(config: Config, hooks: Hooks);
-    private browserIsChrome;
+    protected browserIsChrome: (b: BrowserInstance) => boolean;
     protected removeUserDataDir: (userDataDir: string | null) => Promise<void>;
     protected onNewPage: (req: Request, page: Page) => Promise<void>;
     /**
@@ -19,24 +18,41 @@ export declare class BrowserManager {
      * and modifies URLs to set them to the appropriate addresses configured.
      * When both Chrome and Chromium are installed, defaults to Chromium.
      */
-    getProtocolJSON: () => Promise<object>;
+    getProtocolJSON: (logger: Logger) => Promise<object>;
     /**
      * Returns the /json/version API from Chromium or Chrome, whichever is installed,
      * and modifies URLs to set them to the appropriate addresses configured.
      * When both Chrome and Chromium are installed, defaults to Chromium.
      */
-    getVersionJSON: () => Promise<CDPJSONPayload>;
+    getVersionJSON: (logger: Logger) => Promise<CDPJSONPayload>;
     /**
      * Returns a list of all Chrome-like browsers (both Chromium and Chrome) with
      * their respective /json/list contents. URLs are modified so that subsequent
      * calls can be forwarded to the appropriate destination
      */
     getJSONList: () => Promise<Array<CDPJSONPayload>>;
-    private generateSessionJson;
+    protected generateSessionJson: (browser: BrowserInstance, session: BrowserlessSession) => Promise<{
+        browser: string;
+        browserId: string;
+        initialConnectURL: string;
+        killURL: string | null;
+        running: boolean;
+        timeAliveMs: number;
+        type: string;
+        id: string | null;
+        isTempDataDir: boolean;
+        launchOptions: CDPLaunchOptions | BrowserServerOptions;
+        numbConnected: number;
+        resolver: (val: unknown) => void;
+        routePath: string | string[];
+        startedOn: number;
+        ttl: number;
+        userDataDir: string | null;
+    }[]>;
     close: (browser: BrowserInstance, session: BrowserlessSession) => Promise<void>;
     getAllSessions: () => Promise<BrowserlessSessionJSON[]>;
     complete: (browser: BrowserInstance) => Promise<void>;
-    getBrowserForRequest: (req: Request, router: BrowserHTTPRoute | BrowserWebsocketRoute) => Promise<BrowserInstance>;
+    getBrowserForRequest: (req: Request, router: BrowserHTTPRoute | BrowserWebsocketRoute, logger: Logger) => Promise<BrowserInstance>;
     shutdown: () => Promise<void>;
     /**
      * Left blank for downstream SDK modules to optionally implement.

package/build/browsers/index.js

@@ -1,4 +1,4 @@
-import { BLESS_PAGE_IDENTIFIER, BadRequest, ChromeCDP, ChromePlaywright, ChromiumCDP, ChromiumPlaywright, FirefoxPlaywright, HTTPManagementRoutes, NotFound, ServerError, WebkitPlaywright, availableBrowsers, convertIfBase64, createLogger, exists, generateDataDir, makeExternalURL, noop, parseBooleanParam, } from '@browserless.io/browserless';
+import { BLESS_PAGE_IDENTIFIER, BadRequest, ChromeCDP, ChromePlaywright, ChromiumCDP, ChromiumPlaywright, FirefoxPlaywright, HTTPManagementRoutes, Logger, NotFound, ServerError, WebkitPlaywright, availableBrowsers, convertIfBase64, exists, generateDataDir, makeExternalURL, noop, parseBooleanParam, } from '@browserless.io/browserless';
 import { deleteAsync } from 'del';
 import path from 'path';
 export class BrowserManager {
@@ -7,7 +7,7 @@ export class BrowserManager {
     browsers = new Map();
     launching = new Map();
     timers = new Map();
-    debug = createLogger('browser-manager');
+    log = new Logger('browser-manager');
     chromeBrowsers = [ChromiumCDP, ChromeCDP];
     playwrightBrowserNames = [
         ChromiumPlaywright.name,
@@ -22,9 +22,9 @@ export class BrowserManager {
     browserIsChrome = (b) => this.chromeBrowsers.some((chromeBrowser) => b instanceof chromeBrowser);
     removeUserDataDir = async (userDataDir) => {
         if (userDataDir && (await exists(userDataDir))) {
-            this.debug(`Deleting data directory "${userDataDir}"`);
+            this.log.info(`Deleting data directory "${userDataDir}"`);
             await deleteAsync(userDataDir, { force: true }).catch((err) => {
-                this.debug(`Error cleaning up user-data-dir "${err}" at ${userDataDir}`);
+                this.log.error(`Error cleaning up user-data-dir "${err}" at ${userDataDir}`);
             });
         }
     };
@@ -36,7 +36,7 @@ export class BrowserManager {
      * and modifies URLs to set them to the appropriate addresses configured.
      * When both Chrome and Chromium are installed, defaults to Chromium.
      */
-    getProtocolJSON = async () => {
+    getProtocolJSON = async (logger) => {
         const Browser = (await availableBrowsers).find((InstalledBrowser) => this.chromeBrowsers.some((ChromeBrowser) => InstalledBrowser === ChromeBrowser));
         if (!Browser) {
             throw new Error(`No Chrome or Chromium browsers are installed!`);
@@ -44,6 +44,7 @@ export class BrowserManager {
         const browser = new Browser({
             blockAds: false,
             config: this.config,
+            logger,
             userDataDir: null,
         });
         await browser.launch();
@@ -62,8 +63,8 @@ export class BrowserManager {
      * and modifies URLs to set them to the appropriate addresses configured.
      * When both Chrome and Chromium are installed, defaults to Chromium.
      */
-    getVersionJSON = async () => {
-        this.debug(`Launching Chromium to generate /json/version results`);
+    getVersionJSON = async (logger) => {
+        this.log.info(`Launching Chromium to generate /json/version results`);
         const Browser = (await availableBrowsers).find((InstalledBrowser) => this.chromeBrowsers.some((ChromeBrowser) => InstalledBrowser === ChromeBrowser));
         if (!Browser) {
             throw new ServerError(`No Chrome or Chromium browsers are installed!`);
@@ -71,6 +72,7 @@ export class BrowserManager {
         const browser = new Browser({
             blockAds: false,
             config: this.config,
+            logger,
             userDataDir: null,
         });
         await browser.launch();
@@ -178,15 +180,15 @@ export class BrowserManager {
     };
     close = async (browser, session) => {
         const cleanupACtions = [];
-        this.debug(`${session.numbConnected} Client(s) are currently connected`);
+        this.log.info(`${session.numbConnected} Client(s) are currently connected`);
         // Don't close if there's clients still connected
         if (session.numbConnected > 0) {
             return;
         }
-        this.debug(`Closing browser session`);
+        this.log.info(`Closing browser session`);
         cleanupACtions.push(() => browser.close());
         if (session.isTempDataDir) {
-            this.debug(`Deleting "${session.userDataDir}" user-data-dir and session from memory`);
+            this.log.info(`Deleting "${session.userDataDir}" user-data-dir and session from memory`);
             this.browsers.delete(browser);
             cleanupACtions.push(() => this.removeUserDataDir(session.userDataDir));
         }
@@ -204,7 +206,7 @@ export class BrowserManager {
     complete = async (browser) => {
         const session = this.browsers.get(browser);
         if (!session) {
-            this.debug(`Couldn't locate session for browser, proceeding with close`);
+            this.log.info(`Couldn't locate session for browser, proceeding with close`);
             return browser.close();
         }
         const { id, resolver } = session;
@@ -215,7 +217,7 @@ export class BrowserManager {
         --session.numbConnected;
         this.close(browser, session);
     };
-    getBrowserForRequest = async (req, router) => {
+    getBrowserForRequest = async (req, router, logger) => {
         const { browser: Browser } = router;
         const blockAds = parseBooleanParam(req.parsed.searchParams, 'blockAds', false);
         const decodedLaunchOptions = convertIfBase64(req.parsed.searchParams.get('launch') || '{}');
@@ -228,7 +230,7 @@ export class BrowserManager {
             if (found) {
                 const [browser, session] = found;
                 ++session.numbConnected;
-                this.debug(`Located browser with ID ${id}`);
+                this.log.debug(`Located browser with ID ${id}`);
                 return browser;
             }
             throw new NotFound(`Couldn't locate browser "${id}" for request "${req.parsed.pathname}"`);
@@ -259,6 +261,8 @@ export class BrowserManager {
                 }));
                 const found = allPages.flat().find((b) => b.id === id);
                 if (found) {
+                    const session = this.browsers.get(found.browser);
+                    ++session.numbConnected;
                     return found.browser;
                 }
                 throw new NotFound(`Couldn't locate browser "${id}" for request "${req.parsed.pathname}"`);
@@ -299,6 +303,7 @@ export class BrowserManager {
         const browser = new Browser({
             blockAds,
             config: this.config,
+            logger,
             userDataDir,
         });
         const connectionMeta = {
@@ -323,7 +328,7 @@ export class BrowserManager {
         return browser;
     };
     shutdown = async () => {
-        this.debug(`Closing down browser instances`);
+        this.log.info(`Closing down browser instances`);
         const sessions = Array.from(this.browsers);
         await Promise.all(sessions.map(([b]) => b.close()));
         const timers = Array.from(this.timers);
@@ -332,7 +337,7 @@ export class BrowserManager {
         this.browsers = new Map();
         this.timers = new Map();
         await this.stop();
-        this.debug(`Shutdown complete`);
+        this.log.info(`Shutdown complete`);
     };
     /**
      * Left blank for downstream SDK modules to optionally implement.

package/build/browsers/webkit.playwright.d.ts

@@ -1,9 +1,8 @@
 /// <reference types="node" />
-/// <reference types="debug" />
 /// <reference types="node" />
 /// <reference types="node" />
 /// <reference types="node" />
-import { BrowserServerOptions, Config, Request } from '@browserless.io/browserless';
+import { BrowserServerOptions, Config, Logger, Request } from '@browserless.io/browserless';
 import playwright, { Page } from 'playwright-core';
 import { Duplex } from 'stream';
 import { EventEmitter } from 'events';
@@ -15,9 +14,10 @@ export declare class WebkitPlaywright extends EventEmitter {
     protected proxy: httpProxy<import("http").IncomingMessage, import("http").ServerResponse<import("http").IncomingMessage>>;
     protected browser: playwright.BrowserServer | null;
     protected browserWSEndpoint: string | null;
-    protected debug: import("debug").Debugger;
-    constructor({ config, userDataDir, }: {
+    protected logger: Logger;
+    constructor({ config, userDataDir, logger, }: {
         config: Config;
+        logger: Logger;
         userDataDir: WebkitPlaywright['userDataDir'];
     });
     protected cleanListeners(): void;

package/build/browsers/webkit.playwright.js

@@ -1,4 +1,4 @@
-import { ServerError, createLogger, } from '@browserless.io/browserless';
+import { ServerError, } from '@browserless.io/browserless';
 import playwright from 'playwright-core';
 import { EventEmitter } from 'events';
 import httpProxy from 'http-proxy';
@@ -10,12 +10,13 @@ export class WebkitPlaywright extends EventEmitter {
     proxy = httpProxy.createProxyServer();
     browser = null;
     browserWSEndpoint = null;
-    debug = createLogger('browsers:webkit:playwright');
-    constructor({ config, userDataDir, }) {
+    logger;
+    constructor({ config, userDataDir, logger, }) {
         super();
         this.userDataDir = userDataDir;
         this.config = config;
-        this.debug(`Starting new browser instance`);
+        this.logger = logger;
+        this.logger.info(`Starting new ${this.constructor.name} instance`);
     }
     cleanListeners() {
         this.removeAllListeners();
@@ -23,7 +24,7 @@ export class WebkitPlaywright extends EventEmitter {
     isRunning = () => this.running;
     close = async () => {
         if (this.browser) {
-            this.debug(`Closing browser process and all listeners`);
+            this.logger.info(`Closing ${this.constructor.name} process and all listeners`);
             this.emit('close');
             this.cleanListeners();
             this.browser.close();
@@ -34,16 +35,16 @@ export class WebkitPlaywright extends EventEmitter {
     };
     pages = async () => [];
     getPageId = () => {
-        throw new ServerError(`#getPageId is not yet supported with this browser.`);
+        throw new ServerError(`#getPageId is not yet supported with ${this.constructor.name}.`);
     };
     makeLiveURL = () => {
-        throw new ServerError(`Live URLs are not yet supported with this browser.`);
+        throw new ServerError(`Live URLs are not yet supported with ${this.constructor.name}.`);
     };
     newPage = async () => {
-        throw new ServerError(`Can't create new page with this browser`);
+        throw new ServerError(`Can't create new page with ${this.constructor.name}`);
     };
     launch = async (options = {}) => {
-        this.debug(`Launching Playwright Handler`);
+        this.logger.info(`Launching ${this.constructor.name} Handler`);
         this.browser = await playwright.webkit.launchServer({
             ...options,
             args: [
@@ -53,7 +54,7 @@ export class WebkitPlaywright extends EventEmitter {
             executablePath: playwright.webkit.executablePath(),
         });
         const browserWSEndpoint = this.browser.wsEndpoint();
-        this.debug(`Browser is running on ${browserWSEndpoint}`);
+        this.logger.info(`${this.constructor.name} is running on ${browserWSEndpoint}`);
         this.browserWSEndpoint = browserWSEndpoint;
         this.running = true;
         return this.browser;
@@ -72,14 +73,14 @@ export class WebkitPlaywright extends EventEmitter {
         return externalURL.href;
     };
     proxyPageWebSocket = async () => {
-        console.warn(`Not yet implemented`);
+        this.logger.warn(`Not yet implemented`);
     };
     proxyWebSocket = async (req, socket, head) => new Promise((resolve, reject) => {
         if (!this.browserWSEndpoint) {
             throw new ServerError(`No browserWSEndpoint found, did you launch first?`);
         }
         socket.once('close', resolve);
-        this.debug(`Proxying ${req.parsed.href} to browser ${this.browserWSEndpoint}`);
+        this.logger.info(`Proxying ${req.parsed.href} to ${this.constructor.name} ${this.browserWSEndpoint}`);
         // Delete headers known to cause issues
         delete req.headers.origin;
         req.url = '';
@@ -87,7 +88,7 @@ export class WebkitPlaywright extends EventEmitter {
             changeOrigin: true,
             target: this.browserWSEndpoint,
         }, (error) => {
-            this.debug(`Error proxying session: ${error}`);
+            this.logger.error(`Error proxying session to ${this.constructor.name}: ${error}`);
             this.close();
             return reject(error);
         });

package/build/config.d.ts

@@ -18,6 +18,7 @@ export declare class Config extends EventEmitter {
     protected queued: number;
     protected timeout: number;
     protected static: string;
+    protected debuggerDir: string;
     protected retries: number;
     protected allowFileProtocol: boolean;
     protected allowGet: boolean;
@@ -53,6 +54,7 @@ export declare class Config extends EventEmitter {
     getQueued: () => number;
     getTimeout: () => number;
     getStatic: () => string;
+    getDebuggerDir: () => string;
     getRetries: () => number;
     getAllowFileProtocol: () => boolean;
     getCPULimit: () => number;
@@ -63,6 +65,7 @@ export declare class Config extends EventEmitter {
     getRejectAlertURL: () => string | null;
     getTimeoutAlertURL: () => string | null;
     getErrorAlertURL: () => string | null;
+    hasDebugger: () => Promise<boolean>;
     /**
      * If true, allows GET style calls on our browser-based APIs, using
      * ?body=JSON format.

package/build/config.js

@@ -124,6 +124,7 @@ export class Config extends EventEmitter {
         process.env.CONNECTION_TIMEOUT ??
         '30000');
     static = process.env.STATIC ?? path.join(__dirname, '..', 'static');
+    debuggerDir = path.join(this.static, 'debugger');
     retries = +(process.env.RETRIES ?? '5');
     allowFileProtocol = !!parseEnvVars(false, 'ALLOW_FILE_PROTOCOL');
     allowGet = !!parseEnvVars(false, 'ALLOW_GET', 'ENABLE_API_GET');
@@ -159,6 +160,7 @@ export class Config extends EventEmitter {
     getQueued = () => this.queued;
     getTimeout = () => this.timeout;
     getStatic = () => this.static;
+    getDebuggerDir = () => this.debuggerDir;
     getRetries = () => this.retries;
     getAllowFileProtocol = () => this.allowFileProtocol;
     getCPULimit = () => this.maxCpu;
@@ -169,6 +171,7 @@ export class Config extends EventEmitter {
     getRejectAlertURL = () => this.rejectAlertURL;
     getTimeoutAlertURL = () => this.timeoutAlertURL;
     getErrorAlertURL = () => this.errorAlertURL;
+    hasDebugger = () => exists(this.debuggerDir);
     /**
      * If true, allows GET style calls on our browser-based APIs, using
      * ?body=JSON format.

package/build/file-system.d.ts

@@ -1,13 +1,12 @@
 /// <reference types="node" />
-/// <reference types="debug" />
 /// <reference types="node" />
-import { Config } from '@browserless.io/browserless';
+import { Config, Logger } from '@browserless.io/browserless';
 import { EventEmitter } from 'events';
 export declare class FileSystem extends EventEmitter {
     protected config: Config;
     protected fsMap: Map<string, string[]>;
     protected currentAESKey: Buffer;
-    protected log: import("debug").Debugger;
+    protected logger: Logger;
     constructor(config: Config);
     /**
      * Appends contents to a file-path for persistance. File contents are

package/build/file-system.js

@@ -1,11 +1,11 @@
-import { createLogger, decrypt, encrypt, } from '@browserless.io/browserless';
+import { Logger, decrypt, encrypt } from '@browserless.io/browserless';
 import { readFile, writeFile } from 'fs/promises';
 import { EventEmitter } from 'events';
 export class FileSystem extends EventEmitter {
     config;
     fsMap = new Map();
     currentAESKey;
-    log = createLogger('file-system');
+    logger = new Logger('file-system');
     constructor(config) {
         super();
         this.config = config;

package/build/index.js

@@ -1,7 +1,7 @@
-import { Browserless, createLogger } from '@browserless.io/browserless';
+import { Browserless, Logger } from '@browserless.io/browserless';
 (async () => {
     const browserless = new Browserless();
-    const debug = createLogger('index.js');
+    const logger = new Logger('index.js');
     browserless.start();
     process
         .on('unhandledRejection', async (reason, promise) => {
@@ -13,27 +13,27 @@ import { Browserless, createLogger } from '@browserless.io/browserless';
         process.exit(1);
     })
         .once('SIGTERM', async () => {
-        debug(`SIGTERM received, saving and closing down`);
+        logger.info(`SIGTERM received, saving and closing down`);
         await browserless.stop();
         process.exit(0);
     })
         .once('SIGINT', async () => {
-        debug(`SIGINT received, saving and closing down`);
+        logger.info(`SIGINT received, saving and closing down`);
         await browserless.stop();
         process.exit(0);
     })
         .once('SIGHUP', async () => {
-        debug(`SIGHUP received, saving and closing down`);
+        logger.info(`SIGHUP received, saving and closing down`);
         await browserless.stop();
         process.exit(0);
     })
         .once('SIGUSR2', async () => {
-        debug(`SIGUSR2 received, saving and closing down`);
+        logger.info(`SIGUSR2 received, saving and closing down`);
         await browserless.stop();
         process.exit(0);
     })
         .once('exit', () => {
-        debug(`Process is finished, exiting`);
+        logger.info(`Process is finished, exiting`);
         process.exit(0);
     });
 })();

package/build/limiter.d.ts

@@ -1,5 +1,4 @@
-/// <reference types="debug" />
-import { AfterResponse, Config, Hooks, Metrics, Monitoring, WebHooks } from '@browserless.io/browserless';
+import { AfterResponse, Config, Hooks, Logger, Metrics, Monitoring, WebHooks } from '@browserless.io/browserless';
 import q from 'queue';
 export type LimitFn<TArgs extends unknown[], TResult> = (...args: TArgs) => Promise<TResult>;
 export type ErrorFn<TArgs extends unknown[]> = (...args: TArgs) => void;
@@ -17,7 +16,7 @@ export declare class Limiter extends q {
     protected webhooks: WebHooks;
     protected hooks: Hooks;
     protected queued: number;
-    protected debug: import("debug").Debugger;
+    protected logger: Logger;
     constructor(config: Config, metrics: Metrics, monitor: Monitoring, webhooks: WebHooks, hooks: Hooks);
     protected handleEnd(): void;
     protected jobEnd(jobInfo: AfterResponse): void;

package/build/limiter.js

@@ -1,4 +1,4 @@
-import { TooManyRequests, createLogger, } from '@browserless.io/browserless';
+import { Logger, TooManyRequests, } from '@browserless.io/browserless';
 import q from 'queue';
 export class Limiter extends q {
     config;
@@ -7,7 +7,7 @@ export class Limiter extends q {
     webhooks;
     hooks;
     queued;
-    debug = createLogger('limiter');
+    logger = new Logger('limiter');
     constructor(config, metrics, monitor, webhooks, hooks) {
         super({
             autostart: true,
@@ -20,17 +20,17 @@ export class Limiter extends q {
         this.webhooks = webhooks;
         this.hooks = hooks;
         this.queued = config.getQueued();
-        this.debug(`Concurrency: ${this.concurrency} queue: ${this.queued} timeout: ${this.timeout}ms`);
+        this.logger.info(`Concurrency: ${this.concurrency} queue: ${this.queued} timeout: ${this.timeout}ms`);
         config.on('concurrent', (concurrency) => {
-            this.debug(`Concurrency updated to ${concurrency}`);
+            this.logger.info(`Concurrency updated to ${concurrency}`);
             this.concurrency = concurrency;
         });
         config.on('queued', (queued) => {
-            this.debug(`Queue updated to ${queued}`);
+            this.logger.info(`Queue updated to ${queued}`);
             this.queued = queued;
         });
         config.on('timeout', (timeout) => {
-            this.debug(`Timeout updated to ${timeout}ms`);
+            this.logger.info(`Timeout updated to ${timeout}ms`);
             this.timeout = timeout <= 0 ? 0 : timeout;
         });
         // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -49,7 +49,7 @@ export class Limiter extends q {
     }
     handleSuccess({ detail: { job } }) {
         const timeUsed = Date.now() - job.start;
-        this.debug(`Job has succeeded after ${timeUsed.toLocaleString()}ms of activity.`);
+        this.logger.info(`Job has succeeded after ${timeUsed.toLocaleString()}ms of activity.`);
         this.metrics.addSuccessful(Date.now() - job.start);
         // @TODO Figure out a better argument handling for jobs
         this.jobEnd({
@@ -60,10 +60,10 @@ export class Limiter extends q {
     }
     handleJobTimeout({ detail: { next, job }, }) {
         const timeUsed = Date.now() - job.start;
-        this.debug(`Job has hit timeout after ${timeUsed.toLocaleString()}ms of activity.`);
+        this.logger.warn(`Job has hit timeout after ${timeUsed.toLocaleString()}ms of activity.`);
         this.metrics.addTimedout(Date.now() - job.start);
         this.webhooks.callTimeoutAlertURL();
-        this.debug(`Calling timeout handler`);
+        this.logger.info(`Calling timeout handler`);
         job?.onTimeoutFn(job);
         this.jobEnd({
             req: job.args[0],
@@ -73,7 +73,7 @@ export class Limiter extends q {
         next();
     }
     handleFail({ detail: { error, job }, }) {
-        this.debug(`Recording failed stat, cleaning up: "${error?.toString()}"`);
+        this.logger.info(`Recording failed stat, cleaning up: "${error?.toString()}"`);
         this.metrics.addError(Date.now() - job.start);
         this.webhooks.callErrorAlertURL(error?.toString() ?? 'Unknown Error');
         this.jobEnd({
@@ -83,7 +83,7 @@ export class Limiter extends q {
         });
     }
     logQueue(message) {
-        this.debug(`(Running: ${this.executing}, Pending: ${this.waiting}) ${message} `);
+        this.logger.info(`(Running: ${this.executing}, Pending: ${this.waiting}) ${message} `);
     }
     get executing() {
         return this.length > this.concurrency ? this.concurrency : this.length;

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;
 }