@browserless.io/browserless 2.7.1 → 2.9.0

package/src/shared/content.http.ts

@@ -7,6 +7,7 @@ import {
   CDPLaunchOptions,
   ChromiumCDP,
   HTTPRoutes,
+  Logger,
   Methods,
   Request,
   SystemQueryParameters,
@@ -77,8 +78,10 @@ export default class ChromiumContentPostRoute extends BrowserHTTPRoute {
   handler = async (
     req: Request,
     res: ServerResponse,
+    logger: Logger,
     browser: BrowserInstance,
   ): Promise<void> => {
+    logger.info('Content API invoked with body:', req.body);
     const contentType =
       !req.headers.accept || req.headers.accept?.includes('*')
         ? contentTypes.html
@@ -164,6 +167,7 @@ export default class ChromiumContentPostRoute extends BrowserHTTPRoute {
           !!rejectRequestPattern.find((pattern) => req.url().match(pattern)) ||
           rejectResourceTypes.includes(req.resourceType())
         ) {
+          logger.debug(`Aborting request ${req.method()}: ${req.url()}`);
           return req.abort();
         }
         const interceptor = requestInterceptors.find((r) =>
@@ -231,6 +235,8 @@ export default class ChromiumContentPostRoute extends BrowserHTTPRoute {
 
     page.close().catch(noop);
 
+    logger.info('Content API request completed');
+
     return writeResponse(res, 200, markup, contentTypes.html);
   };
 }

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.info(`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.error(`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.info(`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.trace(
+            `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.info(`All files have finished downloading`);
 
         return path.join(downloadPath, fileName);
       }
 
       const filePath = await checkIfDownloadComplete();
-      debug(`Closing pages.`);
+      logger.info(`Closing pages.`);
       page.close();
       page.removeAllListeners();
 
@@ -112,12 +115,12 @@ export default class ChromiumDownloadPostRoute extends BrowserHTTPRoute {
           filePath &&
           deleteAsync(filePath, { force: true })
             .then(() => {
-              debug(
+              logger.info(
                 `Successfully deleted downloads from disk at "${filePath}"`,
               );
             })
             .catch((err) => {
-              debug(
+              logger.error(
                 `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.info(`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.info(`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.info(`Sending file-type response of "${type}"`);
         const readStream = new Stream.PassThrough();
         readStream.end(response);
         res.setHeader('Content-Type', type);

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

@@ -3,6 +3,7 @@ import {
   BrowserlessRoutes,
   HTTPRoute,
   HTTPRoutes,
+  Logger,
   Methods,
   Request,
   Response,
@@ -13,7 +14,7 @@ import {
 export type ResponseSchema = object;
 
 export default class ChromiumJSONProtocolGetRoute extends HTTPRoute {
-  private cachedProtocol: object | undefined;
+  protected cachedProtocol: object | undefined;
 
   name = BrowserlessRoutes.ChromiumJSONProtocolGetRoute;
   accepts = [contentTypes.any];
@@ -26,11 +27,15 @@ export default class ChromiumJSONProtocolGetRoute extends HTTPRoute {
   path = HTTPRoutes.jsonProtocol;
   tags = [APITags.browserAPI];
 
-  handler = async (_req: Request, res: Response): Promise<void> => {
+  handler = async (
+    _req: Request,
+    res: Response,
+    logger: Logger,
+  ): Promise<void> => {
     const browserManager = this.browserManager();
 
     if (!this.cachedProtocol) {
-      this.cachedProtocol = await browserManager.getProtocolJSON();
+      this.cachedProtocol = await browserManager.getProtocolJSON(logger);
     }
 
     return jsonResponse(res, 200, this.cachedProtocol);

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

@@ -4,6 +4,7 @@ import {
   BrowserlessRoutes,
   HTTPRoute,
   HTTPRoutes,
+  Logger,
   Methods,
   Request,
   Response,
@@ -18,7 +19,7 @@ export type ResponseSchema = UnwrapPromise<
 >;
 
 export default class ChromiumJSONVersionGetRoute extends HTTPRoute {
-  private cachedJSON: ResponseSchema | undefined;
+  protected cachedJSON: ResponseSchema | undefined;
 
   name = BrowserlessRoutes.ChromiumJSONVersionGetRoute;
   accepts = [contentTypes.any];
@@ -30,8 +31,11 @@ export default class ChromiumJSONVersionGetRoute extends HTTPRoute {
   method = Methods.get;
   path = HTTPRoutes.jsonVersion;
   tags = [APITags.browserAPI];
-
-  handler = async (req: Request, res: Response): Promise<void> => {
+  handler = async (
+    req: Request,
+    res: Response,
+    logger: Logger,
+  ): Promise<void> => {
     const baseUrl = req.parsed.host;
     const protocol = req.parsed.protocol.includes('s') ? 'wss' : 'ws';
 
@@ -39,7 +43,7 @@ export default class ChromiumJSONVersionGetRoute extends HTTPRoute {
       if (!this.cachedJSON) {
         const browserManager = this.browserManager();
         this.cachedJSON = {
-          ...(await browserManager.getVersionJSON()),
+          ...(await browserManager.getVersionJSON(logger)),
           webSocketDebuggerUrl: `${protocol}://${baseUrl}`,
         };
       }

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,
@@ -25,7 +26,6 @@ import {
   sleep,
   waitForEvent as waitForEvt,
   waitForFunction as waitForFn,
-  writeResponse,
 } from '@browserless.io/browserless';
 import { Page } from 'puppeteer-core';
 import { ServerResponse } from 'http';
@@ -83,16 +83,17 @@ export default class ChromiumPDFPostRoute extends BrowserHTTPRoute {
   handler = async (
     req: Request,
     res: ServerResponse,
+    logger: Logger,
     browser: BrowserInstance,
   ): Promise<void> => {
+    logger.info('PDF API invoked with body:', req.body);
     const contentType =
       !req.headers.accept || req.headers.accept?.includes('*')
         ? 'application/pdf'
         : req.headers.accept;
 
     if (!req.body) {
-      writeResponse(res, 400, `Couldn't parse JSON body`);
-      return;
+      throw new BadRequest(`Couldn't parse JSON body`);
     }
 
     res.setHeader('Content-Type', contentType);
@@ -172,6 +173,7 @@ export default class ChromiumPDFPostRoute extends BrowserHTTPRoute {
           !!rejectRequestPattern.find((pattern) => req.url().match(pattern)) ||
           rejectResourceTypes.includes(req.resourceType())
         ) {
+          logger.debug(`Aborting request ${req.method()}: ${req.url()}`);
           return req.abort();
         }
         const interceptor = requestInterceptors.find((r) =>
@@ -242,5 +244,7 @@ export default class ChromiumPDFPostRoute extends BrowserHTTPRoute {
     await new Promise((r) => readStream.pipe(res).once('close', r));
 
     page.close().catch(noop);
+
+    logger.info('PDF API request completed');
   };
 }

package/src/shared/performance.http.ts

@@ -6,6 +6,7 @@ import {
   CDPLaunchOptions,
   ChromiumCDP,
   HTTPRoutes,
+  Logger,
   Methods,
   Request,
   SystemQueryParameters,
@@ -47,12 +48,14 @@ export default class PerformancePost extends BrowserHTTPRoute {
   handler = async (
     req: Request,
     res: ServerResponse,
+    _logger: Logger,
     browser: BrowserInstance,
   ): Promise<void> => {
     const config = this.config();
     const response = await main({
       browser,
       context: req.body as BodySchema,
+      logger: _logger,
       timeout: config.getTimeout(),
     });
 

package/src/shared/scrape.http.ts

@@ -8,6 +8,7 @@ import {
   ChromiumCDP,
   HTTPRoutes,
   InBoundRequest,
+  Logger,
   Methods,
   OutBoundRequest,
   Request,
@@ -218,8 +219,10 @@ export default class ChromiumScrapePostRoute extends BrowserHTTPRoute {
   handler = async (
     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('*')
         ? contentTypes.html
@@ -335,6 +338,7 @@ export default class ChromiumScrapePostRoute extends BrowserHTTPRoute {
           !!rejectRequestPattern.find((pattern) => req.url().match(pattern)) ||
           rejectResourceTypes.includes(req.resourceType())
         ) {
+          logger.debug(`Aborting request ${req.method()}: ${req.url()}`);
           return req.abort();
         }
         const interceptor = requestInterceptors.find((r) =>
@@ -433,6 +437,8 @@ export default class ChromiumScrapePostRoute extends BrowserHTTPRoute {
 
     page.close().catch(noop);
 
+    logger.info('Scrape API request completed');
+
     return jsonResponse(res, 200, response, false);
   };
 }

package/src/shared/screenshot.http.ts

@@ -7,6 +7,7 @@ import {
   CDPLaunchOptions,
   ChromiumCDP,
   HTTPRoutes,
+  Logger,
   Methods,
   Request,
   SystemQueryParameters,
@@ -85,8 +86,10 @@ export default class ScreenshotPost extends BrowserHTTPRoute {
   handler = async (
     req: Request,
     res: ServerResponse,
+    logger: Logger,
     browser: BrowserInstance,
   ): Promise<void> => {
+    logger.info('Screenshot API invoked with body:', req.body);
     const contentType =
       !req.headers.accept || req.headers.accept?.includes('*')
         ? 'image/png'
@@ -179,6 +182,7 @@ export default class ScreenshotPost extends BrowserHTTPRoute {
           !!rejectRequestPattern.find((pattern) => req.url().match(pattern)) ||
           rejectResourceTypes.includes(req.resourceType())
         ) {
+          logger.debug(`Aborting request ${req.method()}: ${req.url()}`);
           return req.abort();
         }
         const interceptor = requestInterceptors.find((r) =>
@@ -262,5 +266,6 @@ export default class ScreenshotPost extends BrowserHTTPRoute {
     await new Promise((r) => readStream.pipe(res).once('close', r));
 
     page.close().catch(noop);
+    logger.info('Screenshot API request completed');
   };
 }

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.info(`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.warn(
           `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.info(`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()}"`);
+      if (!res.ok()) {
+        logger.warn(`Received a non-200 response for request "${res.url()}"`);
       }
     });
 
     page.on('console', (event) => {
-      debug(`${event.type()}: ${event.text()}`);
+      logger.trace(`${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.error(`Error running code: ${e}`);
         throw new BadRequest(e.message);
       });
 

package/src/shared/utils/performance/child.ts

@@ -1,16 +1,16 @@
 import { Message, start } from './types.js';
-import { createLogger } from '@browserless.io/browserless';
+import { Logger } from '@browserless.io/browserless';
 import lighthouse from 'lighthouse';
 
-const debug = createLogger('http:performance:child');
+const logger = new Logger('http:performance:child');
 
-debug(`Child init`);
+logger.info(`Child init`);
 
 const send = (msg: Message) => process.send && process.send(msg);
 
 const start = async ({ url, config, options }: start) => {
   try {
-    debug(`Child got payload, starting lighthouse`);
+    logger.info(`Child got payload, starting lighthouse`);
     const results = await lighthouse(url, options, config);
 
     send({

package/src/shared/utils/performance/main.ts

@@ -1,5 +1,4 @@
 import { Message, mainOptions } from './types.js';
-import { createLogger } from '@browserless.io/browserless';
 import { fork } from 'child_process';
 import path from 'path';
 
@@ -10,10 +9,10 @@ const DEFAULT_AUDIT_CONFIG = {
 export default async ({
   browser,
   context,
+  logger,
   timeout,
 }: mainOptions): Promise<unknown> => {
   return new Promise((resolve, reject) => {
-    const debug = createLogger('http:performance:main');
     const childPath = path.join(
       './',
       'build',
@@ -23,7 +22,7 @@ export default async ({
       'child.js',
     );
 
-    debug(`Starting up child at ${childPath}`);
+    logger.trace(`Starting up child at ${childPath}`);
 
     const child = fork(childPath);
     const port = new URL(browser.wsEndpoint() || '').port;
@@ -54,14 +53,14 @@ export default async ({
     };
 
     child.on('error', (err) => {
-      debug(`Error in child process`, err);
+      logger.error(`Error in child process`, err);
       reject('Performance run error: ' + err.message);
       close(child.pid);
     });
 
     child.on('message', (payload: Message) => {
       if (payload.event === 'created') {
-        debug(`Child process is up, sending performance request`);
+        logger.info(`Child process is up, sending performance request`);
         return child.send({
           config,
           event: 'start',
@@ -71,7 +70,7 @@ export default async ({
       }
 
       if (payload.event === 'complete') {
-        debug(`Performance gathered, closing and resolving request`);
+        logger.info(`Performance gathered, closing and resolving request`);
         close(child.pid);
         return resolve({
           data: payload.data,

package/src/shared/utils/performance/types.ts

@@ -1,5 +1,5 @@
+import { BrowserInstance, Logger } from '@browserless.io/browserless';
 import { Config, Flags } from 'lighthouse';
-import { BrowserInstance } from '@browserless.io/browserless';
 
 export interface Message {
   data?: unknown;
@@ -14,6 +14,7 @@ export interface mainOptions {
     config?: unknown;
     url: string;
   };
+  logger: Logger;
   timeout: number;
 }
 

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

package/src/utils.ts

@@ -790,12 +790,17 @@ export const untildify = (path: string) => {
   return homeDir ? path.replace(/^~(?=$|\/|\\)/, homeDir) : path;
 };
 
-export const printLogo = (docsLink: string) => `
+export const printLogo = (docsLink: string, debugURL?: string | boolean) => `
 ---------------------------------------------------------
 | browserless.io
 | To read documentation and more, load in your browser:
 |
-| ${docsLink}
+| OpenAPI: ${docsLink}
+| Full Documentation: https://docs.browserless.io/ ${
+  /*prettier-ignore*/
+  debugURL ? `
+| Debbuger: ${debugURL}`  : ""
+}
 ---------------------------------------------------------
 ${gradient(
   '#ff1a8c',