@browserless.io/browserless 2.12.0-beta-3 → 2.12.0-beta-6

package/src/limiter.ts

@@ -19,7 +19,7 @@ export type ErrorFn<TArgs extends unknown[]> = (...args: TArgs) => void;
 interface Job {
   (): Promise<unknown>;
   args: unknown[];
-  onTimeoutFn: (job: Job) => unknown;
+  onTimeoutFn(job: Job): unknown;
   start: number;
   timeout: number;
 }
@@ -62,15 +62,15 @@ export class Limiter extends q {
     });
 
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    this.addEventListener('timeout', this.handleJobTimeout as any);
+    this.addEventListener('timeout', this.handleJobTimeout.bind(this) as any);
 
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    this.addEventListener('success', this.handleSuccess as any);
+    this.addEventListener('success', this.handleSuccess.bind(this) as any);
 
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    this.addEventListener('error', this.handleFail as any);
+    this.addEventListener('error', this.handleFail.bind(this) as any);
 
-    this.addEventListener('end', this.handleEnd);
+    this.addEventListener('end', this.handleEnd.bind(this));
   }
 
   protected handleEnd() {
@@ -160,12 +160,12 @@ export class Limiter extends q {
     return this.length < this.concurrency + this.queued;
   }
 
-  public limit = <TArgs extends unknown[], TResult>(
+  public limit<TArgs extends unknown[], TResult>(
     limitFn: LimitFn<TArgs, TResult>,
     overCapacityFn: ErrorFn<TArgs>,
     onTimeoutFn: ErrorFn<TArgs>,
     timeoutOverrideFn: (...args: TArgs) => number | undefined,
-  ): LimitFn<TArgs, unknown> => {
+  ): LimitFn<TArgs, unknown> {
     return (...args: TArgs) =>
       new Promise(async (res, rej) => {
         const timeout = timeoutOverrideFn(...args) ?? this.timeout;
@@ -227,18 +227,18 @@ export class Limiter extends q {
 
         return bound;
       });
-  };
+  }
 
   /**
    * Implement any browserless-core-specific shutdown logic here.
    * Calls the empty-SDK stop method for downstream implementations.
    */
-  public shutdown = async () => {
-    await this.stop();
-  };
+  public async shutdown() {
+    return await this.stop();
+  }
 
   /**
    * Left blank for downstream SDK modules to optionally implement.
    */
-  public stop = () => {};
+  public stop() {}
 }

package/src/logger.ts

@@ -26,27 +26,27 @@ export class Logger {
     return this.request ? this.request.socket.remoteAddress ?? 'Unknown' : '';
   }
 
-  public trace = (...messages: unknown[]) => {
+  public trace(...messages: unknown[]) {
     this._trace(this.reqInfo, ...messages);
-  };
+  }
 
-  public debug = (...messages: unknown[]) => {
+  public debug(...messages: unknown[]) {
     this._debug(this.reqInfo, ...messages);
-  };
+  }
 
-  public info = (...messages: unknown[]) => {
+  public info(...messages: unknown[]) {
     this._info(this.reqInfo, ...messages);
-  };
+  }
 
-  public warn = (...messages: unknown[]) => {
+  public warn(...messages: unknown[]) {
     this._warn(this.reqInfo, ...messages);
-  };
+  }
 
-  public error = (...messages: unknown[]) => {
+  public error(...messages: unknown[]) {
     this._error(this.reqInfo, ...messages);
-  };
+  }
 
-  public fatal = (...messages: unknown[]) => {
+  public fatal(...messages: unknown[]) {
     this._fatal(this.reqInfo, ...messages);
-  };
+  }
 }

package/src/metrics.ts

@@ -14,41 +14,41 @@ export class Metrics extends EventEmitter {
   protected unhealthy = 0;
   protected error = 0;
 
-  addSuccessful = (sessionTime: number): number => {
+  addSuccessful(sessionTime: number): number {
     --this.running;
     this.sessionTimes.push(sessionTime);
     return ++this.successful;
-  };
+  }
 
-  addTimedout = (sessionTime: number): number => {
+  addTimedout(sessionTime: number): number {
     --this.running;
     this.sessionTimes.push(sessionTime);
     return ++this.timedout;
-  };
+  }
 
-  addError = (sessionTime: number): number => {
+  addError(sessionTime: number): number {
     --this.running;
     this.sessionTimes.push(sessionTime);
     return ++this.error;
-  };
+  }
 
-  addQueued = (): number => {
+  addQueued(): number {
     return ++this.queued;
-  };
+  }
 
-  addRejected = (): number => {
+  addRejected(): number {
     return ++this.rejected;
-  };
+  }
 
-  addUnhealthy = (): number => {
+  addUnhealthy(): number {
     return ++this.unhealthy;
-  };
+  }
 
-  addUnauthorized = (): number => {
+  addUnauthorized(): number {
     return ++this.unauthorized;
-  };
+  }
 
-  addRunning = (): number => {
+  addRunning(): number {
     ++this.running;
 
     if (this.concurrent < this.running) {
@@ -56,9 +56,9 @@ export class Metrics extends EventEmitter {
     }
 
     return this.running;
-  };
+  }
 
-  public get = (): Omit<IBrowserlessStats, 'cpu' | 'memory'> => {
+  public get(): Omit<IBrowserlessStats, 'cpu' | 'memory'> {
     const currentStat = {
       error: this.error,
       maxConcurrent: this.concurrent,
@@ -77,9 +77,9 @@ export class Metrics extends EventEmitter {
       ...this.calculateStats(currentStat.sessionTimes),
       date: Date.now(),
     };
-  };
+  }
 
-  public reset = () => {
+  public reset() {
     this.successful = 0;
     this.error = 0;
     this.queued = 0;
@@ -90,7 +90,7 @@ export class Metrics extends EventEmitter {
     this.running = 0;
     this.unhealthy = 0;
     this.sessionTimes = [];
-  };
+  }
 
   protected calculateStats(sessionTimes: number[]) {
     return {
@@ -112,12 +112,12 @@ export class Metrics extends EventEmitter {
    * Implement any browserless-core-specific shutdown logic here.
    * Calls the empty-SDK stop method for downstream implementations.
    */
-  public shutdown = async () => {
+  public async shutdown() {
     await this.stop();
-  };
+  }
 
   /**
    * Left blank for downstream SDK modules to optionally implement.
    */
-  public stop = () => {};
+  public stop() {}
 }

package/src/monitoring.ts

@@ -8,7 +8,7 @@ export class Monitoring extends EventEmitter {
     super();
   }
 
-  public getMachineStats = async (): Promise<IResourceLoad> => {
+  public async getMachineStats(): Promise<IResourceLoad> {
     const [cpuLoad, memLoad] = await Promise.all([
       si.currentLoad(),
       si.mem(),
@@ -24,14 +24,14 @@ export class Monitoring extends EventEmitter {
       cpu,
       memory,
     };
-  };
+  }
 
-  public overloaded = async (): Promise<{
+  public async overloaded(): Promise<{
     cpuInt: number | null;
     cpuOverloaded: boolean;
     memoryInt: number | null;
     memoryOverloaded: boolean;
-  }> => {
+  }> {
     const { cpu, memory } = await this.getMachineStats();
     const cpuInt = cpu && Math.ceil(cpu * 100);
     const memoryInt = memory && Math.ceil(memory * 100);
@@ -50,18 +50,18 @@ export class Monitoring extends EventEmitter {
       memoryInt,
       memoryOverloaded,
     };
-  };
+  }
 
   /**
    * Implement any browserless-core-specific shutdown logic here.
    * Calls the empty-SDK stop method for downstream implementations.
    */
-  public shutdown = async () => {
-    await this.stop();
-  };
+  public async shutdown() {
+    return await this.stop();
+  }
 
   /**
    * Left blank for downstream SDK modules to optionally implement.
    */
-  public stop = () => {};
+  public stop() {}
 }

package/src/router.ts

@@ -40,32 +40,31 @@ export class Router extends EventEmitter {
     return timer ? +timer : undefined;
   }
 
-  protected onQueueFullHTTP = (_req: Request, res: Response) => {
+  protected onQueueFullHTTP(_req: Request, res: Response) {
     this.log.warn(`Queue is full, sending 429 response`);
     return writeResponse(res, 429, 'Too many requests');
-  };
+  }
 
-  protected onQueueFullWebSocket = (_req: Request, socket: stream.Duplex) => {
+  protected onQueueFullWebSocket(_req: Request, socket: stream.Duplex) {
     this.log.warn(`Queue is full, sending 429 response`);
     return writeResponse(socket, 429, 'Too many requests');
-  };
+  }
 
-  protected onHTTPTimeout = (_req: Request, res: Response) => {
+  protected onHTTPTimeout(_req: Request, res: Response) {
     this.log.error(`HTTP job has timedout, sending 429 response`);
     return writeResponse(res, 408, 'Request has timed out');
-  };
+  }
 
-  protected onWebsocketTimeout = (_req: Request, socket: stream.Duplex) => {
+  protected onWebsocketTimeout(_req: Request, socket: stream.Duplex) {
     this.log.error(`Websocket job has timedout, sending 429 response`);
     return writeResponse(socket, 408, 'Request has timed out');
-  };
-
-  protected wrapHTTPHandler =
-    (
-      route: HTTPRoute | BrowserHTTPRoute,
-      handler: HTTPRoute['handler'] | BrowserHTTPRoute['handler'],
-    ) =>
-    async (req: Request, res: Response) => {
+  }
+
+  protected wrapHTTPHandler(
+    route: HTTPRoute | BrowserHTTPRoute,
+    handler: HTTPRoute['handler'] | BrowserHTTPRoute['handler'],
+  ) {
+    return async (req: Request, res: Response) => {
       if (!isConnected(res)) {
         this.log.warn(`HTTP Request has closed prior to running`);
         return Promise.resolve();
@@ -110,13 +109,13 @@ export class Router extends EventEmitter {
 
       return (handler as HTTPRoute['handler'])(req, res, logger);
     };
+  }
 
-  protected wrapWebSocketHandler =
-    (
-      route: WebSocketRoute | BrowserWebsocketRoute,
-      handler: WebSocketRoute['handler'] | BrowserWebsocketRoute['handler'],
-    ) =>
-    async (req: Request, socket: stream.Duplex, head: Buffer) => {
+  protected wrapWebSocketHandler(
+    route: WebSocketRoute | BrowserWebsocketRoute,
+    handler: WebSocketRoute['handler'] | BrowserWebsocketRoute['handler'],
+  ) {
+    return async (req: Request, socket: stream.Duplex, head: Buffer) => {
       if (!isConnected(socket)) {
         this.log.warn(`WebSocket Request has closed prior to running`);
         return Promise.resolve();
@@ -150,6 +149,7 @@ export class Router extends EventEmitter {
       }
       return (handler as WebSocketRoute['handler'])(req, socket, head, logger);
     };
+  }
 
   public registerHTTPRoute(
     route: HTTPRoute | BrowserHTTPRoute,
@@ -164,9 +164,9 @@ export class Router extends EventEmitter {
     route.handler = route.concurrency
       ? this.limiter.limit(
           wrapped,
-          this.onQueueFullHTTP,
-          this.onHTTPTimeout,
-          this.getTimeout,
+          this.onQueueFullHTTP.bind(this),
+          this.onHTTPTimeout.bind(this),
+          this.getTimeout.bind(this),
         )
       : wrapped;
     route.path = Array.isArray(route.path) ? route.path : [route.path];
@@ -194,9 +194,9 @@ export class Router extends EventEmitter {
     route.handler = route.concurrency
       ? this.limiter.limit(
           wrapped,
-          this.onQueueFullWebSocket,
-          this.onWebsocketTimeout,
-          this.getTimeout,
+          this.onQueueFullWebSocket.bind(this),
+          this.onWebsocketTimeout.bind(this),
+          this.getTimeout.bind(this),
         )
       : wrapped;
     route.path = Array.isArray(route.path) ? route.path : [route.path];
@@ -256,14 +256,14 @@ export class Router extends EventEmitter {
    * Implement any browserless-core-specific shutdown logic here.
    * Calls the empty-SDK stop method for downstream implementations.
    */
-  public shutdown = async () => {
+  public async shutdown() {
     this.httpRoutes = [];
     this.webSocketRoutes = [];
-    await this.stop();
-  };
+    return await this.stop();
+  }
 
   /**
    * Left blank for downstream SDK modules to optionally implement.
    */
-  public stop = () => {};
+  public stop() {}
 }

package/src/routes/chrome/tests/websocket.spec.ts

@@ -470,9 +470,9 @@ describe('Chrome WebSocket API', function () {
       const browser = await pw.chromium.connect(
         `ws://localhost:3000/chrome/playwright?token=browserless`,
       );
-  
+
       await browser.close();
-      await sleep(100);  
+      await sleep(100);
     }
 
     const results = metrics.get();

package/src/routes/chromium/tests/websocket.spec.ts

@@ -474,9 +474,9 @@ describe('Chromium WebSocket API', function () {
       const browser = await pw.chromium.connect(
         `ws://localhost:3000/playwright/chromium?token=browserless`,
       );
-  
+
       await browser.close();
-      await sleep(100);  
+      await sleep(100);
     }
 
     const results = metrics.get();

package/src/routes/firefox/tests/websocket.spec.ts

@@ -38,9 +38,7 @@ describe('Firefox Websocket API', function () {
     await browser.close();
   });
 
-  
   it('runs multiple versions of playwright', async () => {
-
     const config = new Config();
     config.setToken('browserless');
     const metrics = new Metrics();
@@ -53,9 +51,9 @@ describe('Firefox Websocket API', function () {
       const browser = await pw.firefox.connect(
         `ws://localhost:3000/playwright/firefox?token=browserless`,
       );
-  
+
       await browser.close();
-      await sleep(100);  
+      await sleep(100);
     }
 
     const results = metrics.get();

package/src/routes/firefox/ws/playwright.ts

@@ -26,13 +26,13 @@ export default class FirefoxPlaywrightWebSocketRoute extends BrowserWebsocketRou
   description = `Connect to Firefox with any playwright-compliant library.`;
   path = [WebsocketRoutes.playwrightFirefox, WebsocketRoutes.firefoxPlaywright];
   tags = [APITags.browserWS];
-  handler = async (
+  async handler(
     req: Request,
     socket: Duplex,
     head: Buffer,
     _logger: Logger,
     browser: FirefoxPlaywright,
-  ): Promise<void> => {
+  ): Promise<void> {
     const isPlaywright = req.headers['user-agent']
       ?.toLowerCase()
       .includes('playwright');
@@ -44,5 +44,5 @@ export default class FirefoxPlaywrightWebSocketRoute extends BrowserWebsocketRou
     }
 
     return browser.proxyWebSocket(req, socket, head);
-  };
+  }
 }

package/src/routes/management/http/active.get.ts

@@ -25,6 +25,7 @@ export default class ActiveGetRoute extends HTTPRoute {
   method = Methods.get;
   path = HTTPManagementRoutes.active;
   tags = [APITags.management];
-  handler = async (_req: Request, res: ServerResponse): Promise<void> =>
-    writeResponse(res, 204, '', contentTypes.text);
+  async handler(_req: Request, res: ServerResponse): Promise<void> {
+    return writeResponse(res, 204, '', contentTypes.text);
+  }
 }

package/src/routes/management/http/config.get.ts

@@ -44,7 +44,7 @@ export default class ConfigGetRoute extends HTTPRoute {
   method = Methods.get;
   path = HTTPManagementRoutes.config;
   tags = [APITags.management];
-  handler = async (_req: Request, res: ServerResponse): Promise<void> => {
+  async handler(_req: Request, res: ServerResponse): Promise<void> {
     const config = this.config();
 
     const response: ResponseSchema = {
@@ -71,5 +71,5 @@ export default class ConfigGetRoute extends HTTPRoute {
     };
 
     return jsonResponse(res, 200, response);
-  };
+  }
 }

package/src/routes/management/http/metrics-total.get.ts

@@ -26,7 +26,7 @@ export default class MetricsTotalGetRoute extends HTTPRoute {
   method = Methods.get;
   path = HTTPManagementRoutes.metricsTotal;
   tags = [APITags.management];
-  handler = async (_req: Request, res: ServerResponse): Promise<void> => {
+  async handler(_req: Request, res: ServerResponse): Promise<void> {
     const fileSystem = this.fileSystem();
     const config = this.config();
     const metrics = (
@@ -76,5 +76,5 @@ export default class MetricsTotalGetRoute extends HTTPRoute {
     );
 
     return writeResponse(res, 200, JSON.stringify(totals), contentTypes.json);
-  };
+  }
 }

package/src/routes/management/http/metrics.get.ts

@@ -24,7 +24,7 @@ export default class MetricsGetRoute extends HTTPRoute {
   method = Methods.get;
   path = HTTPManagementRoutes.metrics;
   tags = [APITags.management];
-  handler = async (_req: Request, res: ServerResponse): Promise<void> => {
+  async handler(_req: Request, res: ServerResponse): Promise<void> {
     const fileSystem = this.fileSystem();
     const config = this.config();
 
@@ -32,5 +32,5 @@ export default class MetricsGetRoute extends HTTPRoute {
     const response = `[${stats.join(',')}]`;
 
     return writeResponse(res, 200, response, contentTypes.json);
-  };
+  }
 }

package/src/routes/management/http/pressure.get.ts

@@ -81,7 +81,7 @@ export default class PressureGetRoute extends HTTPRoute {
   method = Methods.get;
   path = HTTPManagementRoutes.pressure;
   tags = [APITags.management];
-  handler = async (_req: Request, res: ServerResponse): Promise<void> => {
+  async handler(_req: Request, res: ServerResponse): Promise<void> {
     const monitoring = this.monitoring();
     const config = this.config();
     const limiter = this.limiter();
@@ -135,5 +135,5 @@ export default class PressureGetRoute extends HTTPRoute {
     };
 
     return jsonResponse(res, 200, response);
-  };
+  }
 }

package/src/routes/management/http/sessions.get.ts

@@ -24,10 +24,10 @@ export default class SessionsGetRoute extends HTTPRoute {
   method = Methods.get;
   path = HTTPManagementRoutes.sessions;
   tags = [APITags.management];
-  handler = async (_req: Request, res: ServerResponse): Promise<void> => {
+  async handler(_req: Request, res: ServerResponse): Promise<void> {
     const browserManager = this.browserManager();
     const response: ResponseSchema = await browserManager.getAllSessions();
 
     return jsonResponse(res, 200, response);
-  };
+  }
 }

package/src/routes/management/http/static.get.ts

@@ -60,11 +60,11 @@ export default class StaticGetRoute extends HTTPRoute {
   method = Methods.get;
   path = HTTPManagementRoutes.static;
   tags = [APITags.management];
-  handler = async (
+  async handler(
     req: Request,
     res: ServerResponse,
     logger: Logger,
-  ): Promise<unknown> => {
+  ): Promise<unknown> {
     const { pathname } = req.parsed;
     const fileCache = pathMap.get(pathname);
 
@@ -117,5 +117,5 @@ export default class StaticGetRoute extends HTTPRoute {
     });
 
     return streamFile(logger, res, foundFilePath, contentType);
-  };
+  }
 }

package/src/routes/webkit/tests/websocket.spec.ts

@@ -39,7 +39,6 @@ describe('Webkit Websocket API', function () {
     await browser.close();
   });
 
-    
   it('runs multiple versions of playwright', async () => {
     const config = new Config();
     config.setToken('browserless');
@@ -53,9 +52,9 @@ describe('Webkit Websocket API', function () {
       const browser = await pw.webkit.connect(
         `ws://localhost:3000/playwright/webkit?token=browserless`,
       );
-  
+
       await browser.close();
-      await sleep(100);  
+      await sleep(100);
     }
 
     const results = metrics.get();

package/src/routes/webkit/ws/playwright.ts

@@ -24,13 +24,13 @@ export default class WebKitPlaywrightWebSocketRoute extends BrowserWebsocketRout
   description = `Connect to Webkit with any playwright-compliant library.`;
   path = [WebsocketRoutes.playwrightWebkit, WebsocketRoutes.webkitPlaywright];
   tags = [APITags.browserWS];
-  handler = async (
+  async handler(
     req: Request,
     socket: Duplex,
     head: Buffer,
     _logger: Logger,
     browser: WebkitPlaywright,
-  ): Promise<void> => {
+  ): Promise<void> {
     const isPlaywright = req.headers['user-agent']
       ?.toLowerCase()
       .includes('playwright');
@@ -42,5 +42,5 @@ export default class WebKitPlaywrightWebSocketRoute extends BrowserWebsocketRout
     }
 
     return browser.proxyWebSocket(req, socket, head);
-  };
+  }
 }