@browserless.io/browserless 2.7.0 → 2.8.0

package/src/router.ts

@@ -6,6 +6,7 @@ import {
   HTTPManagementRoutes,
   HTTPRoute,
   Limiter,
+  Logger,
   Methods,
   PathTypes,
   Request,
@@ -30,6 +31,7 @@ export class Router extends EventEmitter {
     protected config: Config,
     protected browserManager: BrowserManager,
     protected limiter: Limiter,
+    protected logger: typeof Logger,
   ) {
     super();
   }
@@ -70,7 +72,7 @@ export class Router extends EventEmitter {
         this.log(`HTTP Request has closed prior to running`);
         return Promise.resolve();
       }
-
+      const logger = new this.logger(route.name, req);
       if ('browser' in route && route.browser) {
         const browser = await this.browserManager.getBrowserForRequest(
           req,
@@ -90,7 +92,7 @@ export class Router extends EventEmitter {
         try {
           this.verbose(`Running found HTTP handler.`);
           return await Promise.race([
-            handler(req, res, browser),
+            handler(req, res, logger, browser),
             new Promise((resolve, reject) => {
               res.once('close', () => {
                 if (!res.writableEnded) {
@@ -107,7 +109,7 @@ export class Router extends EventEmitter {
         }
       }
 
-      return (handler as HTTPRoute['handler'])(req, res);
+      return (handler as HTTPRoute['handler'])(req, res, logger);
     };
 
   protected wrapWebSocketHandler =
@@ -120,7 +122,7 @@ export class Router extends EventEmitter {
         this.log(`WebSocket Request has closed prior to running`);
         return Promise.resolve();
       }
-
+      const logger = new this.logger(route.name, req);
       if ('browser' in route && route.browser) {
         const browser = await this.browserManager.getBrowserForRequest(
           req,
@@ -139,14 +141,14 @@ export class Router extends EventEmitter {
 
         try {
           this.verbose(`Running found WebSocket handler.`);
-          await handler(req, socket, head, browser);
+          await handler(req, socket, head, logger, browser);
         } finally {
           this.verbose(`WebSocket Request handler has finished.`);
           this.browserManager.complete(browser);
         }
         return;
       }
-      return (handler as WebSocketRoute['handler'])(req, socket, head);
+      return (handler as WebSocketRoute['handler'])(req, socket, head, logger);
     };
 
   public registerHTTPRoute(
@@ -230,7 +232,7 @@ export class Router extends EventEmitter {
             micromatch.isMatch(req.parsed.pathname, p),
           ) &&
           r.method === (req.method?.toLocaleLowerCase() as Methods) &&
-          (accepts.some((a) => a.startsWith('*/*')) ||
+          (accepts.some((a) => a.includes('*/*')) ||
             r.contentTypes.some((contentType) =>
               accepts.includes(contentType),
             )) &&

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

@@ -5,6 +5,7 @@ import {
   BrowserWebsocketRoute,
   BrowserlessRoutes,
   FirefoxPlaywright,
+  Logger,
   Request,
   SystemQueryParameters,
   WebsocketRoutes,
@@ -29,6 +30,7 @@ export default class FirefoxPlaywrightWebSocketRoute extends BrowserWebsocketRou
     req: Request,
     socket: Duplex,
     head: Buffer,
+    _logger: Logger,
     browser: FirefoxPlaywright,
   ): Promise<void> => {
     const isPlaywright = req.headers['user-agent']

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

@@ -3,6 +3,7 @@ import {
   BrowserlessRoutes,
   HTTPManagementRoutes,
   HTTPRoute,
+  Logger,
   Methods,
   NotFound,
   Request,
@@ -23,21 +24,21 @@ const pathMap: Map<
 > = new Map();
 
 const streamFile = (
-  debug: debug.Debugger,
+  logger: Logger,
   res: ServerResponse,
   file: string,
   contentType?: string,
 ) =>
   new Promise((resolve, reject) => {
     if (contentType) {
-      debug(`Setting content-type ${contentType}`);
+      logger.log(`Setting content-type ${contentType}`);
       res.setHeader('Content-Type', contentType);
     }
 
     return createReadStream(file)
       .on('error', (error) => {
         if (error) {
-          debug(`Error finding file ${file}, sending 404`);
+          logger.error(`Error finding file ${file}, sending 404`);
           pathMap.delete(file);
           return reject(
             new NotFound(`Request for file "${file}" was not found`),
@@ -59,14 +60,16 @@ export default class StaticGetRoute extends HTTPRoute {
   method = Methods.get;
   path = HTTPManagementRoutes.static;
   tags = [APITags.management];
-  handler = async (req: Request, res: ServerResponse): Promise<unknown> => {
+  handler = async (
+    req: Request,
+    res: ServerResponse,
+    logger: Logger,
+  ): Promise<unknown> => {
     const { pathname } = req.parsed;
     const fileCache = pathMap.get(pathname);
-    const debug = this.debug();
-    const verbose = debug.extend('verbose');
 
     if (fileCache) {
-      return streamFile(verbose, res, fileCache.path, fileCache.contentType);
+      return streamFile(logger, res, fileCache.path, fileCache.contentType);
     }
 
     const config = this.config();
@@ -93,13 +96,15 @@ export default class StaticGetRoute extends HTTPRoute {
     }
 
     if (foundFilePaths.length > 1) {
-      debug(
+      logger.log(
         `Multiple files found for request to "${pathname}". Only the first file is served, so please name your files uniquely.`,
       );
     }
 
     const [foundFilePath] = foundFilePaths;
-    verbose(`Found new file "${foundFilePath}", caching path and serving`);
+    logger.verbose(
+      `Found new file "${foundFilePath}", caching path and serving`,
+    );
 
     const contentType = mimeTypes.get(path.extname(foundFilePath));
 
@@ -113,6 +118,6 @@ export default class StaticGetRoute extends HTTPRoute {
       path: foundFilePath,
     });
 
-    return streamFile(verbose, res, foundFilePath, contentType);
+    return streamFile(logger, res, foundFilePath, contentType);
   };
 }

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

@@ -4,6 +4,7 @@ import {
   BrowserServerOptions,
   BrowserWebsocketRoute,
   BrowserlessRoutes,
+  Logger,
   Request,
   SystemQueryParameters,
   WebkitPlaywright,
@@ -27,6 +28,7 @@ export default class WebKitPlaywrightWebSocketRoute extends BrowserWebsocketRout
     req: Request,
     socket: Duplex,
     head: Buffer,
+    _logger: Logger,
     browser: WebkitPlaywright,
   ): Promise<void> => {
     const isPlaywright = req.headers['user-agent']

package/src/sdk-utils.ts

@@ -83,8 +83,8 @@ export const prompt = async (question: string) => {
 
 export const installDependencies = async (
   workingDirectory: string,
-): Promise<void> =>
-  new Promise((resolve, reject) => {
+): Promise<void> => {
+  await new Promise<void>((resolve, reject) => {
     spawn('npm', ['i'], {
       cwd: workingDirectory,
       stdio: 'inherit',
@@ -97,6 +97,24 @@ export const installDependencies = async (
       );
     });
   });
+  await new Promise<void>((resolve, reject) => {
+    spawn(
+      'npx',
+      'playwright-core install --with-deps chromium firefox webkit'.split(' '),
+      {
+        cwd: workingDirectory,
+        stdio: 'inherit',
+      },
+    ).once('close', (code) => {
+      if (code === 0) {
+        return resolve();
+      }
+      return reject(
+        `Error when installing dependencies, see output for more details`,
+      );
+    });
+  });
+};
 
 export const buildDockerImage = async (
   cmd: string,

package/src/server.ts

@@ -2,6 +2,7 @@ import * as http from 'http';
 import * as stream from 'stream';
 import {
   BadRequest,
+  Logger as BlessLogger,
   Config,
   HTTPRoute,
   Hooks,
@@ -49,6 +50,7 @@ export class HTTPServer extends EventEmitter {
     protected token: Token,
     protected router: Router,
     protected hooks: Hooks,
+    protected Logger: typeof BlessLogger,
   ) {
     super();
     this.host = config.getHost();
@@ -263,7 +265,7 @@ export class HTTPServer extends EventEmitter {
     }
 
     return (route as HTTPRoute)
-      .handler(req, res)
+      .handler(req, res, new this.Logger(route.name, req))
       .then(() => {
         this.verbose('HTTP connection complete');
       })
@@ -368,7 +370,7 @@ export class HTTPServer extends EventEmitter {
       }
 
       return (route as WebSocketRoute)
-        .handler(req, socket, head)
+        .handler(req, socket, head, new this.Logger(route.name, req))
         .then(() => {
           this.verbose('Websocket connection complete');
         })

package/src/shared/browser.ws.ts

@@ -4,6 +4,7 @@ import {
   BrowserlessRoutes,
   CDPLaunchOptions,
   ChromiumCDP,
+  Logger,
   Request,
   SystemQueryParameters,
   WebsocketRoutes,
@@ -31,6 +32,7 @@ export default class ChromiumBrowserWebSocketRoute extends BrowserWebsocketRoute
     req: Request,
     socket: Duplex,
     head: Buffer,
+    _logger: Logger,
     browser: ChromiumCDP,
   ): Promise<void> => browser.proxyWebSocket(req, socket, head);
 }

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

@@ -5,6 +5,7 @@ import {
   BrowserWebsocketRoute,
   BrowserlessRoutes,
   ChromiumPlaywright,
+  Logger,
   Request,
   SystemQueryParameters,
   WebsocketRoutes,
@@ -30,6 +31,7 @@ export default class ChromiumPlaywrightWebSocketRoute extends BrowserWebsocketRo
     req: Request,
     socket: Duplex,
     head: Buffer,
+    _logger: Logger,
     browser: ChromiumPlaywright,
   ): Promise<void> => {
     const isPlaywright = req.headers['user-agent']

package/src/shared/chromium.ws.ts

@@ -4,6 +4,7 @@ import {
   BrowserlessRoutes,
   CDPLaunchOptions,
   ChromiumCDP,
+  Logger,
   Request,
   SystemQueryParameters,
   WebsocketRoutes,
@@ -26,6 +27,7 @@ export default class ChromiumCDPWebSocketRoute extends BrowserWebsocketRoute {
     req: Request,
     socket: Duplex,
     head: Buffer,
+    _logger: Logger,
     browser: ChromiumCDP,
   ): Promise<void> => browser.proxyWebSocket(req, socket, head);
 }

package/src/shared/content.http.ts

@@ -7,6 +7,7 @@ import {
   CDPLaunchOptions,
   ChromiumCDP,
   HTTPRoutes,
+  Logger,
   Methods,
   Request,
   SystemQueryParameters,
@@ -77,6 +78,7 @@ export default class ChromiumContentPostRoute extends BrowserHTTPRoute {
   handler = async (
     req: Request,
     res: ServerResponse,
+    _logger: Logger,
     browser: BrowserInstance,
   ): Promise<void> => {
     const contentType =

package/src/shared/download.http.ts

@@ -6,6 +6,7 @@ import {
   CDPLaunchOptions,
   ChromiumCDP,
   HTTPRoutes,
+  Logger,
   Methods,
   NotFound,
   Request,
@@ -61,21 +62,21 @@ export default class ChromiumDownloadPostRoute extends BrowserHTTPRoute {
   handler = async (
     req: Request,
     res: ServerResponse,
+    logger: Logger,
     browser: BrowserInstance,
   ): Promise<void> =>
     new Promise(async (resolve, reject) => {
-      const debug = this.debug();
       const config = this.config();
       const downloadPath = path.join(
         await config.getDownloadsDir(),
         `.browserless.download.${id()}`,
       );
 
-      debug(`Generating a download directory at "${downloadPath}"`);
+      logger.log(`Generating a download directory at "${downloadPath}"`);
       await mkdir(downloadPath);
-      const handler = functionHandler(config, debug, { downloadPath });
+      const handler = functionHandler(config, logger, { downloadPath });
       const response = await handler(req, browser).catch((e) => {
-        debug(`Error running download code handler: "${e}"`);
+        logger.log(`Error running download code handler: "${e}"`);
         reject(e);
         return null;
       });
@@ -85,10 +86,12 @@ export default class ChromiumDownloadPostRoute extends BrowserHTTPRoute {
       }
 
       const { page } = response;
-      debug(`Download function has returned, finding downloads...`);
+      logger.log(`Download function has returned, finding downloads...`);
       async function checkIfDownloadComplete(): Promise<string | null> {
         if (res.headersSent) {
-          debug(`Request headers have been sent, terminating download watch.`);
+          logger.log(
+            `Request headers have been sent, terminating download watch.`,
+          );
           return null;
         }
         const [fileName] = await readdir(downloadPath);
@@ -97,13 +100,13 @@ export default class ChromiumDownloadPostRoute extends BrowserHTTPRoute {
           return checkIfDownloadComplete();
         }
 
-        debug(`All files have finished downloading`);
+        logger.log(`All files have finished downloading`);
 
         return path.join(downloadPath, fileName);
       }
 
       const filePath = await checkIfDownloadComplete();
-      debug(`Closing pages.`);
+      logger.log(`Closing pages.`);
       page.close();
       page.removeAllListeners();
 
@@ -112,12 +115,12 @@ export default class ChromiumDownloadPostRoute extends BrowserHTTPRoute {
           filePath &&
           deleteAsync(filePath, { force: true })
             .then(() => {
-              debug(
+              logger.log(
                 `Successfully deleted downloads from disk at "${filePath}"`,
               );
             })
             .catch((err) => {
-              debug(
+              logger.log(
                 `Error cleaning up downloaded files: "${err}" at "${filePath}"`,
               );
             }),
@@ -144,7 +147,7 @@ export default class ChromiumDownloadPostRoute extends BrowserHTTPRoute {
           }
         })
         .on('end', () => {
-          debug(`Downloads successfully sent`);
+          logger.log(`Downloads successfully sent`);
           rmDownload();
           return resolve();
         })

package/src/shared/function.http.ts

@@ -7,6 +7,7 @@ import {
   CDPLaunchOptions,
   ChromiumCDP,
   HTTPRoutes,
+  Logger,
   Methods,
   Request,
   SystemQueryParameters,
@@ -57,14 +58,14 @@ export default class ChromiumFunctionPostRoute extends BrowserHTTPRoute {
   handler = async (
     req: Request,
     res: ServerResponse,
+    logger: Logger,
     browser: BrowserInstance,
   ): Promise<void> => {
-    const debug = this.debug();
     const config = this.config();
-    const handler = functionHandler(config, debug);
+    const handler = functionHandler(config, logger);
     const { contentType, payload, page } = await handler(req, browser);
 
-    debug(`Got function response of "${contentType}"`);
+    logger.log(`Got function response of "${contentType}"`);
     page.close();
     page.removeAllListeners();
 
@@ -76,7 +77,7 @@ export default class ChromiumFunctionPostRoute extends BrowserHTTPRoute {
       if (!type) {
         throw new BadRequest(`Couldn't determine function's response type.`);
       } else {
-        debug(`Sending file-type response of "${type}"`);
+        logger.log(`Sending file-type response of "${type}"`);
         const readStream = new Stream.PassThrough();
         readStream.end(response);
         res.setHeader('Content-Type', type);

package/src/shared/page.ws.ts

@@ -4,6 +4,7 @@ import {
   BrowserlessRoutes,
   CDPLaunchOptions,
   ChromiumCDP,
+  Logger,
   Request,
   SystemQueryParameters,
   WebsocketRoutes,
@@ -32,6 +33,7 @@ export default class ChromiumPageWebSocketRoute extends BrowserWebsocketRoute {
     req: Request,
     socket: Duplex,
     head: Buffer,
+    _logger: Logger,
     browser: ChromiumCDP,
   ): Promise<void> => browser.proxyPageWebSocket(req, socket, head);
 }

package/src/shared/pdf.http.ts

@@ -7,6 +7,7 @@ import {
   CDPLaunchOptions,
   ChromiumCDP,
   HTTPRoutes,
+  Logger,
   Methods,
   Request,
   SystemQueryParameters,
@@ -83,6 +84,7 @@ export default class ChromiumPDFPostRoute extends BrowserHTTPRoute {
   handler = async (
     req: Request,
     res: ServerResponse,
+    _logger: Logger,
     browser: BrowserInstance,
   ): Promise<void> => {
     const contentType =

package/src/shared/performance.http.ts

@@ -6,6 +6,7 @@ import {
   CDPLaunchOptions,
   ChromiumCDP,
   HTTPRoutes,
+  Logger,
   Methods,
   Request,
   SystemQueryParameters,
@@ -47,6 +48,7 @@ export default class PerformancePost extends BrowserHTTPRoute {
   handler = async (
     req: Request,
     res: ServerResponse,
+    _logger: Logger,
     browser: BrowserInstance,
   ): Promise<void> => {
     const config = this.config();

package/src/shared/scrape.http.ts

@@ -8,6 +8,7 @@ import {
   ChromiumCDP,
   HTTPRoutes,
   InBoundRequest,
+  Logger,
   Methods,
   OutBoundRequest,
   Request,
@@ -218,6 +219,7 @@ export default class ChromiumScrapePostRoute extends BrowserHTTPRoute {
   handler = async (
     req: Request,
     res: ServerResponse,
+    _logger: Logger,
     browser: BrowserInstance,
   ) => {
     const contentType =

package/src/shared/screenshot.http.ts

@@ -7,6 +7,7 @@ import {
   CDPLaunchOptions,
   ChromiumCDP,
   HTTPRoutes,
+  Logger,
   Methods,
   Request,
   SystemQueryParameters,
@@ -85,6 +86,7 @@ export default class ScreenshotPost extends BrowserHTTPRoute {
   handler = async (
     req: Request,
     res: ServerResponse,
+    _logger: Logger,
     browser: BrowserInstance,
   ): Promise<void> => {
     const contentType =

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

@@ -4,6 +4,7 @@ import {
   ChromiumCDP,
   Config,
   HTTPRoutes,
+  Logger,
   Request,
   UnwrapPromise,
   contentTypes,
@@ -16,7 +17,6 @@ import {
 } from '@browserless.io/browserless';
 import { FunctionRunner } from './client.js';
 import { Page } from 'puppeteer-core';
-import debug from 'debug';
 import fs from 'fs';
 import path from 'path';
 
@@ -35,11 +35,7 @@ interface HandlerOptions {
   downloadPath?: string;
 }
 
-export default (
-    config: Config,
-    debug: debug.Debugger,
-    options: HandlerOptions = {},
-  ) =>
+export default (config: Config, logger: Logger, options: HandlerOptions = {}) =>
   async (
     req: Request,
     browser: BrowserInstance,
@@ -88,7 +84,7 @@ export default (
      */
     page.on('request', async (request) => {
       const requestUrl = request.url();
-      debug(`Outbound Page Request: "${requestUrl}"`);
+      logger.log(`Outbound Page Request: "${requestUrl}"`);
       if (requestUrl.startsWith(functionRequestPath)) {
         const filename = path.basename(requestUrl);
         if (filename === functionCodeJS) {
@@ -107,7 +103,7 @@ export default (
             status: 200,
           });
         }
-        debug(
+        logger.log(
           `Static asset request to "${requestUrl}" couldn't be found, 404-ing`,
         );
         return request.respond({
@@ -116,18 +112,18 @@ export default (
           status: 404,
         });
       }
-      debug(`Request: "${requestUrl}" no responder found, continuing...`);
+      logger.log(`Request: "${requestUrl}" no responder found, continuing...`);
       return request.continue();
     });
 
     page.on('response', (res) => {
       if (res.status() !== 200) {
-        debug(`Received a non-200 response for request "${res.url()}"`);
+        logger.log(`Received a non-200 response for request "${res.url()}"`);
       }
     });
 
     page.on('console', (event) => {
-      debug(`${event.type()}: ${event.text()}`);
+      logger.log(`${event.type()}: ${event.text()}`);
     });
 
     await page.goto(functionIndexHTML);
@@ -164,7 +160,7 @@ export default (
         JSON.stringify(options),
       )
       .catch((e) => {
-        debug(`Error running code: ${e}`);
+        logger.log(`Error running code: ${e}`);
         throw new BadRequest(e.message);
       });
 

package/src/types.ts

@@ -9,6 +9,7 @@ import {
   FirefoxPlaywright,
   HTTPManagementRoutes,
   HTTPRoutes,
+  Logger,
   Methods,
   Metrics,
   Request,
@@ -99,7 +100,6 @@ abstract class Route {
     protected _browserManager: Browserless['browserManager'],
     protected _config: Browserless['config'],
     protected _fileSystem: Browserless['fileSystem'],
-    protected _debug: Browserless['debug'],
     protected _metrics: Browserless['metrics'],
     protected _monitoring: Browserless['monitoring'],
     protected _staticSDKDir: Browserless['staticSDKDir'],
@@ -164,14 +164,6 @@ abstract class Route {
    */
   config = () => this._config;
 
-  /**
-   * Helper function that loads the debug module, useful
-   * for logging messages scoped to the routes path. Defined
-   * and injected by browserless after initialization.
-   * @returns Debug
-   */
-  debug = () => this._debug;
-
   /**
    * Helper function that loads the file-system module
    * for interacting with file-systems. Defined and injected by
@@ -254,6 +246,7 @@ export abstract class HTTPRoute extends BasicHTTPRoute {
   abstract handler: (
     req: Request,
     res: http.ServerResponse,
+    logger: Logger,
   ) => Promise<unknown>;
 }
 
@@ -274,6 +267,7 @@ export abstract class BrowserHTTPRoute extends BasicHTTPRoute {
   abstract handler: (
     req: Request,
     res: http.ServerResponse,
+    logger: Logger,
     browser: BrowserInstance,
   ) => Promise<unknown>;
 
@@ -298,6 +292,7 @@ export abstract class WebSocketRoute extends Route {
     req: Request,
     socket: stream.Duplex,
     head: Buffer,
+    logger: Logger,
   ) => Promise<unknown>;
 }
 
@@ -319,6 +314,7 @@ export abstract class BrowserWebsocketRoute extends Route {
     req: Request,
     socket: stream.Duplex,
     head: Buffer,
+    logger: Logger,
     browser: BrowserInstance,
   ): Promise<unknown>;