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

package/src/server.ts

@@ -61,30 +61,28 @@ export class HTTPServer extends EventEmitter {
     );
   }
 
-  protected onHTTPUnauthorized = (_req: Request, res: Response) => {
+  protected onHTTPUnauthorized(_req: Request, res: Response) {
     this.logger.error(
       `HTTP request is not properly authorized, responding with 401`,
     );
     this.metrics.addUnauthorized();
     return writeResponse(res, 401, 'Bad or missing authentication.');
-  };
+  }
 
-  protected onWebsocketUnauthorized = (
-    _req: Request,
-    socket: stream.Duplex,
-  ) => {
+  protected onWebsocketUnauthorized(_req: Request, socket: stream.Duplex) {
     this.logger.error(
       `Websocket request is not properly authorized, responding with 401`,
     );
     this.metrics.addUnauthorized();
     return writeResponse(socket, 401, 'Bad or missing authentication.');
-  };
+  }
 
   public async start(): Promise<void> {
     this.logger.info(`HTTP Server is starting`);
 
-    this.server.on('request', this.handleRequest);
-    this.server.on('upgrade', this.handleWebSocket);
+    this.server.on('request', this.handleRequest.bind(this));
+    this.server.on('upgrade', this.handleWebSocket.bind(this));
+
     const listenMessage = [
       `HTTP Server is listening on ${this.config.getServerAddress()}`,
       `Use ${this.config.getExternalAddress()} for API and connect calls`,
@@ -105,10 +103,10 @@ export class HTTPServer extends EventEmitter {
     });
   }
 
-  protected handleRequest = async (
+  protected async handleRequest(
     request: http.IncomingMessage,
     res: http.ServerResponse,
-  ) => {
+  ) {
     this.logger.trace(
       `Handling inbound HTTP request on "${request.method}: ${request.url}"`,
     );
@@ -299,13 +297,13 @@ export class HTTPServer extends EventEmitter {
 
         return writeResponse(res, 500, e.toString());
       });
-  };
+  }
 
-  protected handleWebSocket = async (
+  protected async handleWebSocket(
     request: http.IncomingMessage,
     socket: stream.Duplex,
     head: Buffer,
-  ) => {
+  ) {
     this.logger.trace(`Handling inbound WebSocket request on "${request.url}"`);
 
     const req = request as Request;
@@ -414,7 +412,7 @@ export class HTTPServer extends EventEmitter {
       `No matching WebSocket route handler for "${req.parsed.href}"`,
     );
     return writeResponse(socket, 404, 'Not Found');
-  };
+  }
 
   public async shutdown(): Promise<void> {
     this.logger.info(`HTTP Server is shutting down`);
@@ -429,5 +427,5 @@ export class HTTPServer extends EventEmitter {
   /**
    * Left blank for downstream SDK modules to optionally implement.
    */
-  public stop = () => {};
+  public stop() {}
 }

package/src/shared/browser.ws.ts

@@ -28,11 +28,13 @@ export default class ChromiumBrowserWebSocketRoute extends BrowserWebsocketRoute
   );
   path = WebsocketRoutes.browser;
   tags = [APITags.browserWS];
-  handler = async (
+  async handler(
     req: Request,
     socket: Duplex,
     head: Buffer,
     _logger: Logger,
     browser: ChromiumCDP,
-  ): Promise<void> => browser.proxyWebSocket(req, socket, head);
+  ): Promise<void> {
+    return browser.proxyWebSocket(req, socket, head);
+  }
 }

package/src/shared/chromium.playwright.ws.ts

@@ -27,13 +27,13 @@ export default class ChromiumPlaywrightWebSocketRoute extends BrowserWebsocketRo
     WebsocketRoutes.chromiumPlaywright,
   ];
   tags = [APITags.browserWS];
-  handler = async (
+  async handler(
     req: Request,
     socket: Duplex,
     head: Buffer,
     _logger: Logger,
     browser: ChromiumPlaywright,
-  ): Promise<void> => {
+  ): Promise<void> {
     const isPlaywright = req.headers['user-agent']
       ?.toLowerCase()
       .includes('playwright');
@@ -45,5 +45,5 @@ export default class ChromiumPlaywrightWebSocketRoute extends BrowserWebsocketRo
     }
 
     return browser.proxyWebSocket(req, socket, head);
-  };
+  }
 }

package/src/shared/chromium.ws.ts

@@ -23,11 +23,13 @@ export default class ChromiumCDPWebSocketRoute extends BrowserWebsocketRoute {
   description = `Launch and connect to Chromium with a library like puppeteer or others that work over chrome-devtools-protocol.`;
   path = [WebsocketRoutes['/'], WebsocketRoutes.chromium];
   tags = [APITags.browserWS];
-  handler = async (
+  async handler(
     req: Request,
     socket: Duplex,
     head: Buffer,
     _logger: Logger,
     browser: ChromiumCDP,
-  ): Promise<void> => browser.proxyWebSocket(req, socket, head);
+  ): Promise<void> {
+    return browser.proxyWebSocket(req, socket, head);
+  }
 }

package/src/shared/content.http.ts

@@ -75,12 +75,12 @@ export default class ChromiumContentPostRoute extends BrowserHTTPRoute {
   method = Methods.post;
   path = [HTTPRoutes.content, HTTPRoutes.chromiumContent];
   tags = [APITags.browserAPI];
-  handler = async (
+  async handler(
     req: Request,
     res: ServerResponse,
     logger: Logger,
     browser: BrowserInstance,
-  ): Promise<void> => {
+  ): Promise<void> {
     logger.info('Content API invoked with body:', req.body);
     const contentType =
       !req.headers.accept || req.headers.accept?.includes('*')
@@ -238,5 +238,5 @@ export default class ChromiumContentPostRoute extends BrowserHTTPRoute {
     logger.info('Content API request completed');
 
     return writeResponse(res, 200, markup, contentTypes.html);
-  };
+  }
 }

package/src/shared/download.http.ts

@@ -59,13 +59,13 @@ export default class ChromiumDownloadPostRoute extends BrowserHTTPRoute {
   method = Methods.post;
   path = [HTTPRoutes.download, HTTPRoutes.chromiumDownload];
   tags = [APITags.browserAPI];
-  handler = async (
+  async handler(
     req: Request,
     res: ServerResponse,
     logger: Logger,
     browser: BrowserInstance,
-  ): Promise<void> =>
-    new Promise(async (resolve, reject) => {
+  ): Promise<void> {
+    return new Promise(async (resolve, reject) => {
       const config = this.config();
       const downloadPath = path.join(
         await config.getDownloadsDir(),
@@ -153,4 +153,5 @@ export default class ChromiumDownloadPostRoute extends BrowserHTTPRoute {
         })
         .pipe(res);
     });
+  }
 }

package/src/shared/function.http.ts

@@ -55,12 +55,12 @@ export default class ChromiumFunctionPostRoute extends BrowserHTTPRoute {
   method = Methods.post;
   path = [HTTPRoutes.function, HTTPRoutes.chromiumFunction];
   tags = [APITags.browserAPI];
-  handler = async (
+  async handler(
     req: Request,
     res: ServerResponse,
     logger: Logger,
     browser: BrowserInstance,
-  ): Promise<void> => {
+  ): Promise<void> {
     const config = this.config();
     const handler = functionHandler(config, logger);
     const { contentType, payload, page } = await handler(req, browser);
@@ -88,5 +88,5 @@ export default class ChromiumFunctionPostRoute extends BrowserHTTPRoute {
     }
 
     return;
-  };
+  }
 }

package/src/shared/json-list.http.ts

@@ -30,8 +30,8 @@ export default class ChromiumJSONListGetRoute extends HTTPRoute {
   path = HTTPRoutes.jsonList;
   tags = [APITags.browserAPI];
 
-  handler = async (_req: Request, res: Response): Promise<void> => {
+  async handler(_req: Request, res: Response): Promise<void> {
     const browserManage = this.browserManager();
     return jsonResponse(res, 200, await browserManage.getJSONList());
-  };
+  }
 }

package/src/shared/json-new.http.ts

@@ -44,7 +44,7 @@ export default class ChromiumJSONNewPutRoute extends HTTPRoute {
   path = HTTPRoutes.jsonNew;
   tags = [APITags.browserAPI];
 
-  handler = async (_req: Request, res: Response): Promise<void> => {
+  async handler(_req: Request, res: Response): Promise<void> {
     const config = this.config();
     const externalAddress = config.getExternalWebSocketAddress();
     const id = pageID();
@@ -64,5 +64,5 @@ export default class ChromiumJSONNewPutRoute extends HTTPRoute {
       url: 'about:blank',
       webSocketDebuggerUrl: href,
     });
-  };
+  }
 }

package/src/shared/json-protocol.http.ts

@@ -27,11 +27,7 @@ export default class ChromiumJSONProtocolGetRoute extends HTTPRoute {
   path = HTTPRoutes.jsonProtocol;
   tags = [APITags.browserAPI];
 
-  handler = async (
-    _req: Request,
-    res: Response,
-    logger: Logger,
-  ): Promise<void> => {
+  async handler(_req: Request, res: Response, logger: Logger): Promise<void> {
     const browserManager = this.browserManager();
 
     if (!this.cachedProtocol) {
@@ -39,5 +35,5 @@ export default class ChromiumJSONProtocolGetRoute extends HTTPRoute {
     }
 
     return jsonResponse(res, 200, this.cachedProtocol);
-  };
+  }
 }

package/src/shared/json-version.http.ts

@@ -31,11 +31,7 @@ export default class ChromiumJSONVersionGetRoute extends HTTPRoute {
   method = Methods.get;
   path = HTTPRoutes.jsonVersion;
   tags = [APITags.browserAPI];
-  handler = async (
-    req: Request,
-    res: Response,
-    logger: Logger,
-  ): Promise<void> => {
+  async handler(req: Request, res: Response, logger: Logger): Promise<void> {
     const baseUrl = req.parsed.host;
     const protocol = req.parsed.protocol.includes('s') ? 'wss' : 'ws';
 
@@ -56,5 +52,5 @@ export default class ChromiumJSONVersionGetRoute extends HTTPRoute {
         contentTypes.text,
       );
     }
-  };
+  }
 }

package/src/shared/page.ws.ts

@@ -29,11 +29,13 @@ export default class ChromiumPageWebSocketRoute extends BrowserWebsocketRoute {
   );
   path = WebsocketRoutes.page;
   tags = [APITags.browserWS];
-  handler = async (
+  async handler(
     req: Request,
     socket: Duplex,
     head: Buffer,
     _logger: Logger,
     browser: ChromiumCDP,
-  ): Promise<void> => browser.proxyPageWebSocket(req, socket, head);
+  ): Promise<void> {
+    return browser.proxyPageWebSocket(req, socket, head);
+  }
 }

package/src/shared/pdf.http.ts

@@ -80,12 +80,12 @@ export default class ChromiumPDFPostRoute extends BrowserHTTPRoute {
   method = Methods.post;
   path = [HTTPRoutes.pdf, HTTPRoutes.chromiumPdf];
   tags = [APITags.browserAPI];
-  handler = async (
+  async handler(
     req: Request,
     res: ServerResponse,
     logger: Logger,
     browser: BrowserInstance,
-  ): Promise<void> => {
+  ): Promise<void> {
     logger.info('PDF API invoked with body:', req.body);
     const contentType =
       !req.headers.accept || req.headers.accept?.includes('*')
@@ -246,5 +246,5 @@ export default class ChromiumPDFPostRoute extends BrowserHTTPRoute {
     page.close().catch(noop);
 
     logger.info('PDF API request completed');
-  };
+  }
 }

package/src/shared/performance.http.ts

@@ -45,12 +45,12 @@ export default class PerformancePost extends BrowserHTTPRoute {
   method = Methods.post;
   path = [HTTPRoutes.performance, HTTPRoutes.chromiumPerformance];
   tags = [APITags.browserAPI];
-  handler = async (
+  async handler(
     req: Request,
     res: ServerResponse,
     _logger: Logger,
     browser: BrowserInstance,
-  ): Promise<void> => {
+  ): Promise<void> {
     const config = this.config();
     const response = await main({
       browser,
@@ -60,5 +60,5 @@ export default class PerformancePost extends BrowserHTTPRoute {
     });
 
     return jsonResponse(res, 200, response);
-  };
+  }
 }

package/src/shared/scrape.http.ts

@@ -216,12 +216,12 @@ export default class ChromiumScrapePostRoute extends BrowserHTTPRoute {
   method = Methods.post;
   path = [HTTPRoutes.scrape, HTTPRoutes.chromiumScrape];
   tags = [APITags.browserAPI];
-  handler = async (
+  async handler(
     req: Request,
     res: ServerResponse,
     logger: Logger,
     browser: BrowserInstance,
-  ) => {
+  ) {
     logger.info('Scrape API invoked with body:', req.body);
     const contentType =
       !req.headers.accept || req.headers.accept?.includes('*')
@@ -440,5 +440,5 @@ export default class ChromiumScrapePostRoute extends BrowserHTTPRoute {
     logger.info('Scrape API request completed');
 
     return jsonResponse(res, 200, response, false);
-  };
+  }
 }

package/src/shared/screenshot.http.ts

@@ -83,12 +83,12 @@ export default class ScreenshotPost extends BrowserHTTPRoute {
   method = Methods.post;
   path = [HTTPRoutes.screenshot, HTTPRoutes.chromiumScreenshot];
   tags = [APITags.browserAPI];
-  handler = async (
+  async handler(
     req: Request,
     res: ServerResponse,
     logger: Logger,
     browser: BrowserInstance,
-  ): Promise<void> => {
+  ): Promise<void> {
     logger.info('Screenshot API invoked with body:', req.body);
     const contentType =
       !req.headers.accept || req.headers.accept?.includes('*')
@@ -267,5 +267,5 @@ export default class ScreenshotPost extends BrowserHTTPRoute {
 
     page.close().catch(noop);
     logger.info('Screenshot API request completed');
-  };
+  }
 }

package/src/shared/utils/function/client.ts

@@ -11,7 +11,9 @@ export class FunctionRunner {
   protected browser?: Browser;
   protected page?: Page;
 
-  public log = () => console.log.bind(console);
+  public log() {
+    return console.log.bind(console);
+  }
 
   public async start(data: {
     browserWSEndpoint: string;

package/src/shim.ts

@@ -14,7 +14,7 @@ const shimParam = ['headless', 'stealth', 'ignoreDefaultArgs', 'slowMo'];
  *
  * @param req A parsed user requests
  */
-export const shimLegacyRequests = (url: URL): URL => {
+export function shimLegacyRequests(url: URL): URL {
   const { searchParams } = url;
   const params = [...searchParams];
   const names = params.map(([k]) => k);
@@ -76,4 +76,4 @@ export const shimLegacyRequests = (url: URL): URL => {
   }
 
   return url;
-};
+}

package/src/token.ts

@@ -14,14 +14,14 @@ export class Token extends EventEmitter {
     super();
   }
 
-  public isAuthorized = async (
+  public async isAuthorized(
     req: Request,
     route:
       | BrowserHTTPRoute
       | BrowserWebsocketRoute
       | HTTPRoute
       | WebSocketRoute,
-  ): Promise<boolean> => {
+  ): Promise<boolean> {
     const token = this.config.getToken();
 
     if (token === null) {
@@ -39,18 +39,18 @@ export class Token extends EventEmitter {
     }
 
     return (Array.isArray(token) ? token : [token]).includes(requestToken);
-  };
+  }
 
   /**
    * 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/types.ts

@@ -251,11 +251,11 @@ export 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: (
+  abstract handler(
     req: Request,
     res: http.ServerResponse,
     logger: Logger,
-  ) => Promise<unknown>;
+  ): Promise<unknown>;
 }
 
 /**
@@ -272,12 +272,12 @@ export 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: (
+  abstract handler(
     req: Request,
     res: http.ServerResponse,
     logger: Logger,
     browser: BrowserInstance,
-  ) => Promise<unknown>;
+  ): Promise<unknown>;
 
   /**
    * An optional function to automatically set up or handle new page
@@ -296,12 +296,12 @@ export abstract class WebSocketRoute extends Route {
   /**
    * Handles an inbound Websocket request, and handles the connection
    */
-  abstract handler: (
+  abstract handler(
     req: Request,
     socket: stream.Duplex,
     head: Buffer,
     logger: Logger,
-  ) => Promise<unknown>;
+  ): Promise<unknown>;
 }
 
 /**
@@ -377,12 +377,12 @@ export interface BrowserServerOptions {
 }
 
 export interface BrowserlessSession {
-  id: string | null;
+  id: string;
   initialConnectURL: string;
   isTempDataDir: boolean;
   launchOptions: CDPLaunchOptions | BrowserServerOptions;
   numbConnected: number;
-  resolver: (val: unknown) => void;
+  resolver(val: unknown): void;
   routePath: string | string[];
   startedOn: number;
   ttl: number;

package/src/utils.ts

@@ -50,7 +50,7 @@ const getAuthHeaderToken = (header: string) => {
 
 /**
  * RegEx to match the Playwright version from the innitial request header.
- * 
+ *
  * @example
  * const userAgent = "Playwright/1.43.1 (x64; windows 10.0) node/20.11";
  * userAgent.match(pwVersionRegex);

package/src/webhooks.ts

@@ -55,12 +55,12 @@ export class WebHooks extends EventEmitter {
    * 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/static/docs/swagger.json

@@ -1098,7 +1098,7 @@
   },
   "info": {
     "title": "Browserless",
-    "version": "2.12.0-beta-3",
+    "version": "2.12.0-beta-6",
     "x-logo": {
       "altText": "browserless logo",
       "url": "./docs/browserless-logo-inline.svg"

package/static/docs/swagger.min.json

@@ -1098,7 +1098,7 @@
   },
   "info": {
     "title": "Browserless",
-    "version": "2.12.0-beta-3",
+    "version": "2.12.0-beta-6",
     "x-logo": {
       "altText": "browserless logo",
       "url": "./docs/browserless-logo-inline.svg"

package/static/function/client.js

@@ -31207,7 +31207,9 @@ ${sourceUrlComment}
   var FunctionRunner = class {
     browser;
     page;
-    log = () => console.log.bind(console);
+    log() {
+      return console.log.bind(console);
+    }
     async start(data) {
       console.log(`/function.js: Got endpoint: "${data.browserWSEndpoint}"`);
       const { browserWSEndpoint, code, context: context2, options } = data;

package/static/function/index.html

@@ -31215,7 +31215,9 @@ ${sourceUrlComment}
   var FunctionRunner = class {
     browser;
     page;
-    log = () => console.log.bind(console);
+    log() {
+      return console.log.bind(console);
+    }
     async start(data) {
       console.log(`/function.js: Got endpoint: "${data.browserWSEndpoint}"`);
       const { browserWSEndpoint, code, context: context2, options } = data;