@browserless.io/browserless 2.7.1 → 2.9.0

package/src/browsers/firefox.playwright.ts

@@ -1,9 +1,9 @@
 import {
   BrowserServerOptions,
   Config,
+  Logger,
   Request,
   ServerError,
-  createLogger,
 } from '@browserless.io/browserless';
 import playwright, { Page } from 'playwright-core';
 import { Duplex } from 'stream';
@@ -15,24 +15,27 @@ export class FirefoxPlaywright extends EventEmitter {
   protected config: Config;
   protected userDataDir: string | null;
   protected running = false;
+  protected logger: Logger;
   protected proxy = httpProxy.createProxyServer();
   protected browser: playwright.BrowserServer | null = null;
   protected browserWSEndpoint: string | null = null;
-  protected debug = createLogger('browsers:firefox:playwright');
 
   constructor({
     config,
     userDataDir,
+    logger,
   }: {
     config: Config;
+    logger: Logger;
     userDataDir: FirefoxPlaywright['userDataDir'];
   }) {
     super();
 
     this.userDataDir = userDataDir;
     this.config = config;
+    this.logger = logger;
 
-    this.debug(`Starting new browser instance`);
+    this.logger.info(`Starting new ${this.constructor.name} instance`);
   }
 
   protected cleanListeners() {
@@ -43,7 +46,9 @@ export class FirefoxPlaywright extends EventEmitter {
 
   public close = async (): Promise<void> => {
     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();
@@ -56,21 +61,27 @@ export class FirefoxPlaywright extends EventEmitter {
   public pages = async (): Promise<[]> => [];
 
   public getPageId = (): string => {
-    throw new ServerError(`#getPageId is not yet supported with this browser.`);
+    throw new ServerError(
+      `#getPageId is not yet supported with ${this.constructor.name}.`,
+    );
   };
 
   public makeLiveURL = (): void => {
-    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}.`,
+    );
   };
 
   public newPage = async (): Promise<Page> => {
-    throw new ServerError(`Can't create new page with this browser`);
+    throw new ServerError(
+      `Can't create new page with ${this.constructor.name}`,
+    );
   };
 
   public launch = async (
     options: BrowserServerOptions = {},
   ): Promise<playwright.BrowserServer> => {
-    this.debug(`Launching Playwright Handler`);
+    this.logger.info(`Launching ${this.constructor.name} Handler`);
 
     this.browser = await playwright.firefox.launchServer({
       ...options,
@@ -83,7 +94,9 @@ export class FirefoxPlaywright extends EventEmitter {
 
     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;
 
@@ -110,7 +123,7 @@ export class FirefoxPlaywright extends EventEmitter {
   };
 
   public proxyPageWebSocket = async () => {
-    console.warn(`Not yet implemented`);
+    this.logger.warn(`Not yet implemented in ${this.constructor.name}`);
   };
 
   public proxyWebSocket = async (
@@ -126,8 +139,8 @@ export class FirefoxPlaywright extends EventEmitter {
       }
       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
@@ -144,7 +157,9 @@ export class FirefoxPlaywright extends EventEmitter {
           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/src/browsers/index.ts

@@ -17,13 +17,13 @@ import {
   FirefoxPlaywright,
   HTTPManagementRoutes,
   Hooks,
+  Logger,
   NotFound,
   Request,
   ServerError,
   WebkitPlaywright,
   availableBrowsers,
   convertIfBase64,
-  createLogger,
   exists,
   generateDataDir,
   makeExternalURL,
@@ -38,7 +38,7 @@ export class BrowserManager {
   protected browsers: Map<BrowserInstance, BrowserlessSession> = new Map();
   protected launching: Map<string, Promise<unknown>> = new Map();
   protected timers: Map<string, number> = new Map();
-  protected debug = createLogger('browser-manager');
+  protected log = new Logger('browser-manager');
   protected chromeBrowsers = [ChromiumCDP, ChromeCDP];
   protected playwrightBrowserNames = [
     ChromiumPlaywright.name,
@@ -52,14 +52,14 @@ export class BrowserManager {
     protected hooks: Hooks,
   ) {}
 
-  private browserIsChrome = (b: BrowserInstance) =>
+  protected browserIsChrome = (b: BrowserInstance) =>
     this.chromeBrowsers.some((chromeBrowser) => b instanceof chromeBrowser);
 
   protected removeUserDataDir = async (userDataDir: string | null) => {
     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(
+        this.log.error(
           `Error cleaning up user-data-dir "${err}" at ${userDataDir}`,
         );
       });
@@ -75,7 +75,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.
    */
-  public getProtocolJSON = async (): Promise<object> => {
+  public getProtocolJSON = async (logger: Logger): Promise<object> => {
     const Browser = (await availableBrowsers).find((InstalledBrowser) =>
       this.chromeBrowsers.some(
         (ChromeBrowser) => InstalledBrowser === ChromeBrowser,
@@ -87,6 +87,7 @@ export class BrowserManager {
     const browser = new Browser({
       blockAds: false,
       config: this.config,
+      logger,
       userDataDir: null,
     });
     await browser.launch();
@@ -110,8 +111,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.
    */
-  public getVersionJSON = async (): Promise<CDPJSONPayload> => {
-    this.debug(`Launching Chromium to generate /json/version results`);
+  public getVersionJSON = async (logger: Logger): Promise<CDPJSONPayload> => {
+    this.log.info(`Launching Chromium to generate /json/version results`);
     const Browser = (await availableBrowsers).find((InstalledBrowser) =>
       this.chromeBrowsers.some(
         (ChromeBrowser) => InstalledBrowser === ChromeBrowser,
@@ -124,6 +125,7 @@ export class BrowserManager {
     const browser = new Browser({
       blockAds: false,
       config: this.config,
+      logger,
       userDataDir: null,
     });
     await browser.launch();
@@ -214,7 +216,7 @@ export class BrowserManager {
       .filter((_) => _ !== null) as Array<CDPJSONPayload>;
   };
 
-  private generateSessionJson = async (
+  protected generateSessionJson = async (
     browser: BrowserInstance,
     session: BrowserlessSession,
   ) => {
@@ -267,18 +269,18 @@ export class BrowserManager {
     session: BrowserlessSession,
   ): Promise<void> => {
     const cleanupACtions: Array<() => Promise<void>> = [];
-    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(
+      this.log.info(
         `Deleting "${session.userDataDir}" user-data-dir and session from memory`,
       );
       this.browsers.delete(browser);
@@ -302,7 +304,9 @@ export class BrowserManager {
   public complete = async (browser: BrowserInstance): Promise<void> => {
     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();
     }
 
@@ -321,6 +325,7 @@ export class BrowserManager {
   public getBrowserForRequest = async (
     req: Request,
     router: BrowserHTTPRoute | BrowserWebsocketRoute,
+    logger: Logger,
   ): Promise<BrowserInstance> => {
     const { browser: Browser } = router;
     const blockAds = parseBooleanParam(
@@ -344,7 +349,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;
       }
 
@@ -387,6 +392,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;
         }
 
@@ -446,6 +453,7 @@ export class BrowserManager {
     const browser = new Browser({
       blockAds,
       config: this.config,
+      logger,
       userDataDir,
     });
 
@@ -477,7 +485,7 @@ export class BrowserManager {
   };
 
   public shutdown = async (): Promise<void> => {
-    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);
@@ -486,7 +494,7 @@ export class BrowserManager {
     this.browsers = new Map();
     this.timers = new Map();
     await this.stop();
-    this.debug(`Shutdown complete`);
+    this.log.info(`Shutdown complete`);
   };
 
   /**

package/src/browsers/webkit.playwright.ts

@@ -1,9 +1,9 @@
 import {
   BrowserServerOptions,
   Config,
+  Logger,
   Request,
   ServerError,
-  createLogger,
 } from '@browserless.io/browserless';
 import playwright, { Page } from 'playwright-core';
 import { Duplex } from 'stream';
@@ -18,21 +18,24 @@ export class WebkitPlaywright extends EventEmitter {
   protected proxy = httpProxy.createProxyServer();
   protected browser: playwright.BrowserServer | null = null;
   protected browserWSEndpoint: string | null = null;
-  protected debug = createLogger('browsers:webkit:playwright');
+  protected logger: Logger;
 
   constructor({
     config,
     userDataDir,
+    logger,
   }: {
     config: Config;
+    logger: Logger;
     userDataDir: WebkitPlaywright['userDataDir'];
   }) {
     super();
 
     this.userDataDir = userDataDir;
     this.config = config;
+    this.logger = logger;
 
-    this.debug(`Starting new browser instance`);
+    this.logger.info(`Starting new ${this.constructor.name} instance`);
   }
 
   protected cleanListeners() {
@@ -43,7 +46,9 @@ export class WebkitPlaywright extends EventEmitter {
 
   public close = async (): Promise<void> => {
     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();
@@ -56,21 +61,27 @@ export class WebkitPlaywright extends EventEmitter {
   public pages = async (): Promise<[]> => [];
 
   public getPageId = (): string => {
-    throw new ServerError(`#getPageId is not yet supported with this browser.`);
+    throw new ServerError(
+      `#getPageId is not yet supported with ${this.constructor.name}.`,
+    );
   };
 
   public makeLiveURL = (): void => {
-    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}.`,
+    );
   };
 
   public newPage = async (): Promise<Page> => {
-    throw new ServerError(`Can't create new page with this browser`);
+    throw new ServerError(
+      `Can't create new page with ${this.constructor.name}`,
+    );
   };
 
   public launch = async (
     options: BrowserServerOptions = {},
   ): Promise<playwright.BrowserServer> => {
-    this.debug(`Launching Playwright Handler`);
+    this.logger.info(`Launching ${this.constructor.name} Handler`);
 
     this.browser = await playwright.webkit.launchServer({
       ...options,
@@ -83,7 +94,9 @@ export class WebkitPlaywright extends EventEmitter {
 
     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;
 
@@ -110,7 +123,7 @@ export class WebkitPlaywright extends EventEmitter {
   };
 
   public proxyPageWebSocket = async () => {
-    console.warn(`Not yet implemented`);
+    this.logger.warn(`Not yet implemented`);
   };
 
   public proxyWebSocket = async (
@@ -126,8 +139,8 @@ export class WebkitPlaywright extends EventEmitter {
       }
       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
@@ -144,7 +157,9 @@ export class WebkitPlaywright extends EventEmitter {
           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/src/config.ts

@@ -148,6 +148,7 @@ export class Config extends EventEmitter {
     '30000'
   );
   protected static = process.env.STATIC ?? path.join(__dirname, '..', 'static');
+  protected debuggerDir = path.join(this.static, 'debugger');
   protected retries = +(process.env.RETRIES ?? '5');
   protected allowFileProtocol = !!parseEnvVars(false, 'ALLOW_FILE_PROTOCOL');
   protected allowGet = !!parseEnvVars(false, 'ALLOW_GET', 'ENABLE_API_GET');
@@ -187,6 +188,7 @@ export class Config extends EventEmitter {
   public getQueued = (): number => this.queued;
   public getTimeout = (): number => this.timeout;
   public getStatic = (): string => this.static;
+  public getDebuggerDir = (): string => this.debuggerDir;
   public getRetries = (): number => this.retries;
   public getAllowFileProtocol = (): boolean => this.allowFileProtocol;
   public getCPULimit = (): number => this.maxCpu;
@@ -198,6 +200,8 @@ export class Config extends EventEmitter {
   public getTimeoutAlertURL = () => this.timeoutAlertURL;
   public getErrorAlertURL = () => this.errorAlertURL;
 
+  public hasDebugger = (): Promise<boolean> => exists(this.debuggerDir);
+
   /**
    * If true, allows GET style calls on our browser-based APIs, using
    * ?body=JSON format.

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/file-system.ts

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

package/src/index.ts

@@ -1,8 +1,8 @@
-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
@@ -15,27 +15,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/src/limiter.ts

@@ -2,11 +2,11 @@ import {
   AfterResponse,
   Config,
   Hooks,
+  Logger,
   Metrics,
   Monitoring,
   TooManyRequests,
   WebHooks,
-  createLogger,
 } from '@browserless.io/browserless';
 import q from 'queue';
 
@@ -26,7 +26,7 @@ interface Job {
 
 export class Limiter extends q {
   protected queued: number;
-  protected debug = createLogger('limiter');
+  protected logger = new Logger('limiter');
 
   constructor(
     protected config: Config,
@@ -42,22 +42,22 @@ export class Limiter extends q {
     });
     this.queued = config.getQueued();
 
-    this.debug(
+    this.logger.info(
       `Concurrency: ${this.concurrency} queue: ${this.queued} timeout: ${this.timeout}ms`,
     );
 
     config.on('concurrent', (concurrency: number) => {
-      this.debug(`Concurrency updated to ${concurrency}`);
+      this.logger.info(`Concurrency updated to ${concurrency}`);
       this.concurrency = concurrency;
     });
 
     config.on('queued', (queued: number) => {
-      this.debug(`Queue updated to ${queued}`);
+      this.logger.info(`Queue updated to ${queued}`);
       this.queued = queued;
     });
 
     config.on('timeout', (timeout: number) => {
-      this.debug(`Timeout updated to ${timeout}ms`);
+      this.logger.info(`Timeout updated to ${timeout}ms`);
       this.timeout = timeout <= 0 ? 0 : timeout;
     });
 
@@ -83,7 +83,7 @@ export class Limiter extends q {
 
   protected handleSuccess({ detail: { job } }: { detail: { job: Job } }) {
     const timeUsed = Date.now() - job.start;
-    this.debug(
+    this.logger.info(
       `Job has succeeded after ${timeUsed.toLocaleString()}ms of activity.`,
     );
     this.metrics.addSuccessful(Date.now() - job.start);
@@ -101,12 +101,12 @@ export class Limiter extends q {
     detail: { job: Job; next: Job };
   }) {
     const timeUsed = Date.now() - job.start;
-    this.debug(
+    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],
@@ -122,7 +122,9 @@ export class Limiter extends q {
   }: {
     detail: { error: unknown; job: 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({
@@ -133,7 +135,7 @@ export class Limiter extends q {
   }
 
   protected logQueue(message: string) {
-    this.debug(
+    this.logger.info(
       `(Running: ${this.executing}, Pending: ${this.waiting}) ${message} `,
     );
   }

package/src/logger.ts

@@ -0,0 +1,52 @@
+import { Request, createLogger } from '@browserless.io/browserless';
+
+export class Logger {
+  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(
+    protected prefix: string,
+    protected request?: Request,
+  ) {
+    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');
+  }
+
+  protected get reqInfo() {
+    return this.request ? this.request.socket.remoteAddress ?? 'Unknown' : '';
+  }
+
+  public trace = (...messages: unknown[]) => {
+    this._trace(this.reqInfo, ...messages);
+  };
+
+  public debug = (...messages: unknown[]) => {
+    this._debug(this.reqInfo, ...messages);
+  };
+
+  public info = (...messages: unknown[]) => {
+    this._info(this.reqInfo, ...messages);
+  };
+
+  public warn = (...messages: unknown[]) => {
+    this._warn(this.reqInfo, ...messages);
+  };
+
+  public error = (...messages: unknown[]) => {
+    this._error(this.reqInfo, ...messages);
+  };
+
+  public fatal = (...messages: unknown[]) => {
+    this._fatal(this.reqInfo, ...messages);
+  };
+}

package/src/monitoring.ts

@@ -1,13 +1,9 @@
-import {
-  Config,
-  IResourceLoad,
-  createLogger,
-} from '@browserless.io/browserless';
+import { Config, IResourceLoad, Logger } from '@browserless.io/browserless';
 import { EventEmitter } from 'events';
 import si from 'systeminformation';
 
 export class Monitoring extends EventEmitter {
-  protected log = createLogger('hardware');
+  protected log = new Logger('hardware');
   constructor(protected config: Config) {
     super();
   }
@@ -17,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];
     });
 
@@ -40,7 +36,9 @@ export class Monitoring extends EventEmitter {
     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 = !!(