@browserless.io/browserless 2.12.0-beta-4 → 2.12.0

package/build/shared/download.http.js

@@ -21,67 +21,69 @@ export default class ChromiumDownloadPostRoute extends BrowserHTTPRoute {
     method = Methods.post;
     path = [HTTPRoutes.download, HTTPRoutes.chromiumDownload];
     tags = [APITags.browserAPI];
-    handler = async (req, res, logger, browser) => new Promise(async (resolve, reject) => {
-        const config = this.config();
-        const downloadPath = path.join(await config.getDownloadsDir(), `.browserless.download.${id()}`);
-        logger.info(`Generating a download directory at "${downloadPath}"`);
-        await mkdir(downloadPath);
-        const handler = functionHandler(config, logger, { downloadPath });
-        const response = await handler(req, browser).catch((e) => {
-            logger.error(`Error running download code handler: "${e}"`);
-            reject(e);
-            return null;
-        });
-        if (!response) {
-            return;
-        }
-        const { page } = response;
-        logger.info(`Download function has returned, finding downloads...`);
-        async function checkIfDownloadComplete() {
-            if (res.headersSent) {
-                logger.trace(`Request headers have been sent, terminating download watch.`);
+    async handler(req, res, logger, browser) {
+        return new Promise(async (resolve, reject) => {
+            const config = this.config();
+            const downloadPath = path.join(await config.getDownloadsDir(), `.browserless.download.${id()}`);
+            logger.info(`Generating a download directory at "${downloadPath}"`);
+            await mkdir(downloadPath);
+            const handler = functionHandler(config, logger, { downloadPath });
+            const response = await handler(req, browser).catch((e) => {
+                logger.error(`Error running download code handler: "${e}"`);
+                reject(e);
                 return null;
+            });
+            if (!response) {
+                return;
             }
-            const [fileName] = await readdir(downloadPath);
-            if (!fileName || fileName.endsWith('.crdownload')) {
-                await sleep(500);
-                return checkIfDownloadComplete();
+            const { page } = response;
+            logger.info(`Download function has returned, finding downloads...`);
+            async function checkIfDownloadComplete() {
+                if (res.headersSent) {
+                    logger.trace(`Request headers have been sent, terminating download watch.`);
+                    return null;
+                }
+                const [fileName] = await readdir(downloadPath);
+                if (!fileName || fileName.endsWith('.crdownload')) {
+                    await sleep(500);
+                    return checkIfDownloadComplete();
+                }
+                logger.info(`All files have finished downloading`);
+                return path.join(downloadPath, fileName);
             }
-            logger.info(`All files have finished downloading`);
-            return path.join(downloadPath, fileName);
-        }
-        const filePath = await checkIfDownloadComplete();
-        logger.info(`Closing pages.`);
-        page.close();
-        page.removeAllListeners();
-        const rmDownload = once(() => filePath &&
-            deleteAsync(filePath, { force: true })
-                .then(() => {
-                logger.info(`Successfully deleted downloads from disk at "${filePath}"`);
-            })
-                .catch((err) => {
-                logger.error(`Error cleaning up downloaded files: "${err}" at "${filePath}"`);
-            }));
-        if (res.headersSent || !filePath) {
-            rmDownload();
-            return;
-        }
-        const contentType = mimeTypes.get(path.extname(filePath));
-        if (contentType) {
-            res.setHeader('Content-Type', contentType);
-        }
-        return createReadStream(filePath)
-            .on('error', (error) => {
-            if (error) {
+            const filePath = await checkIfDownloadComplete();
+            logger.info(`Closing pages.`);
+            page.close();
+            page.removeAllListeners();
+            const rmDownload = once(() => filePath &&
+                deleteAsync(filePath, { force: true })
+                    .then(() => {
+                    logger.info(`Successfully deleted downloads from disk at "${filePath}"`);
+                })
+                    .catch((err) => {
+                    logger.error(`Error cleaning up downloaded files: "${err}" at "${filePath}"`);
+                }));
+            if (res.headersSent || !filePath) {
                 rmDownload();
-                return reject(new NotFound(`Couldn't locate or send downloads in "${downloadPath}"`));
+                return;
             }
-        })
-            .on('end', () => {
-            logger.info(`Downloads successfully sent`);
-            rmDownload();
-            return resolve();
-        })
-            .pipe(res);
-    });
+            const contentType = mimeTypes.get(path.extname(filePath));
+            if (contentType) {
+                res.setHeader('Content-Type', contentType);
+            }
+            return createReadStream(filePath)
+                .on('error', (error) => {
+                if (error) {
+                    rmDownload();
+                    return reject(new NotFound(`Couldn't locate or send downloads in "${downloadPath}"`));
+                }
+            })
+                .on('end', () => {
+                logger.info(`Downloads successfully sent`);
+                rmDownload();
+                return resolve();
+            })
+                .pipe(res);
+        });
+    }
 }

package/build/shared/function.http.d.ts

@@ -27,6 +27,6 @@ export default class ChromiumFunctionPostRoute extends BrowserHTTPRoute {
     method: Methods;
     path: HTTPRoutes[];
     tags: APITags[];
-    handler: (req: Request, res: ServerResponse, logger: Logger, browser: BrowserInstance) => Promise<void>;
+    handler(req: Request, res: ServerResponse, logger: Logger, browser: BrowserInstance): Promise<void>;
 }
 export {};

package/build/shared/function.http.js

@@ -18,7 +18,7 @@ export default class ChromiumFunctionPostRoute extends BrowserHTTPRoute {
     method = Methods.post;
     path = [HTTPRoutes.function, HTTPRoutes.chromiumFunction];
     tags = [APITags.browserAPI];
-    handler = async (req, res, logger, browser) => {
+    async handler(req, res, logger, browser) {
         const config = this.config();
         const handler = functionHandler(config, logger);
         const { contentType, payload, page } = await handler(req, browser);
@@ -44,5 +44,5 @@ export default class ChromiumFunctionPostRoute extends BrowserHTTPRoute {
             writeResponse(res, 200, payload, contentType);
         }
         return;
-    };
+    }
 }

package/build/shared/json-list.http.d.ts

@@ -11,5 +11,5 @@ export default class ChromiumJSONListGetRoute extends HTTPRoute {
     method: Methods;
     path: HTTPRoutes;
     tags: APITags[];
-    handler: (_req: Request, res: Response) => Promise<void>;
+    handler(_req: Request, res: Response): Promise<void>;
 }

package/build/shared/json-list.http.js

@@ -14,8 +14,8 @@ export default class ChromiumJSONListGetRoute extends HTTPRoute {
     method = Methods.get;
     path = HTTPRoutes.jsonList;
     tags = [APITags.browserAPI];
-    handler = async (_req, res) => {
+    async handler(_req, res) {
         const browserManage = this.browserManager();
         return jsonResponse(res, 200, await browserManage.getJSONList());
-    };
+    }
 }

package/build/shared/json-new.http.d.ts

@@ -11,5 +11,5 @@ export default class ChromiumJSONNewPutRoute extends HTTPRoute {
     method: Methods;
     path: HTTPRoutes;
     tags: APITags[];
-    handler: (_req: Request, res: Response) => Promise<void>;
+    handler(_req: Request, res: Response): Promise<void>;
 }

package/build/shared/json-new.http.js

@@ -15,7 +15,7 @@ export default class ChromiumJSONNewPutRoute extends HTTPRoute {
     method = Methods.put;
     path = HTTPRoutes.jsonNew;
     tags = [APITags.browserAPI];
-    handler = async (_req, res) => {
+    async handler(_req, res) {
         const config = this.config();
         const externalAddress = config.getExternalWebSocketAddress();
         const id = pageID();
@@ -31,5 +31,5 @@ export default class ChromiumJSONNewPutRoute extends HTTPRoute {
             url: 'about:blank',
             webSocketDebuggerUrl: href,
         });
-    };
+    }
 }

package/build/shared/json-protocol.http.d.ts

@@ -12,5 +12,5 @@ export default class ChromiumJSONProtocolGetRoute extends HTTPRoute {
     method: Methods;
     path: HTTPRoutes;
     tags: APITags[];
-    handler: (_req: Request, res: Response, logger: Logger) => Promise<void>;
+    handler(_req: Request, res: Response, logger: Logger): Promise<void>;
 }

package/build/shared/json-protocol.http.js

@@ -11,11 +11,11 @@ export default class ChromiumJSONProtocolGetRoute extends HTTPRoute {
     method = Methods.get;
     path = HTTPRoutes.jsonProtocol;
     tags = [APITags.browserAPI];
-    handler = async (_req, res, logger) => {
+    async handler(_req, res, logger) {
         const browserManager = this.browserManager();
         if (!this.cachedProtocol) {
             this.cachedProtocol = await browserManager.getProtocolJSON(logger);
         }
         return jsonResponse(res, 200, this.cachedProtocol);
-    };
+    }
 }

package/build/shared/json-version.http.d.ts

@@ -12,5 +12,5 @@ export default class ChromiumJSONVersionGetRoute extends HTTPRoute {
     method: Methods;
     path: HTTPRoutes;
     tags: APITags[];
-    handler: (req: Request, res: Response, logger: Logger) => Promise<void>;
+    handler(req: Request, res: Response, logger: Logger): Promise<void>;
 }

package/build/shared/json-version.http.js

@@ -11,7 +11,7 @@ export default class ChromiumJSONVersionGetRoute extends HTTPRoute {
     method = Methods.get;
     path = HTTPRoutes.jsonVersion;
     tags = [APITags.browserAPI];
-    handler = async (req, res, logger) => {
+    async handler(req, res, logger) {
         const baseUrl = req.parsed.host;
         const protocol = req.parsed.protocol.includes('s') ? 'wss' : 'ws';
         try {
@@ -27,5 +27,5 @@ export default class ChromiumJSONVersionGetRoute extends HTTPRoute {
         catch (err) {
             return writeResponse(res, 500, 'There was an error handling your request', contentTypes.text);
         }
-    };
+    }
 }

package/build/shared/page.ws.d.ts

@@ -13,5 +13,5 @@ export default class ChromiumPageWebSocketRoute extends BrowserWebsocketRoute {
     description: string;
     path: WebsocketRoutes;
     tags: APITags[];
-    handler: (req: Request, socket: Duplex, head: Buffer, _logger: Logger, browser: ChromiumCDP) => Promise<void>;
+    handler(req: Request, socket: Duplex, head: Buffer, _logger: Logger, browser: ChromiumCDP): Promise<void>;
 }

package/build/shared/page.ws.js

@@ -10,5 +10,7 @@ export default class ChromiumPageWebSocketRoute extends BrowserWebsocketRoute {
     or by finding the page's unique ID from your library of choice.`);
     path = WebsocketRoutes.page;
     tags = [APITags.browserWS];
-    handler = async (req, socket, head, _logger, browser) => browser.proxyPageWebSocket(req, socket, head);
+    async handler(req, socket, head, _logger, browser) {
+        return browser.proxyPageWebSocket(req, socket, head);
+    }
 }

package/build/shared/pdf.http.d.ts

@@ -43,5 +43,5 @@ export default class ChromiumPDFPostRoute extends BrowserHTTPRoute {
     method: Methods;
     path: HTTPRoutes[];
     tags: APITags[];
-    handler: (req: Request, res: ServerResponse, logger: Logger, browser: BrowserInstance) => Promise<void>;
+    handler(req: Request, res: ServerResponse, logger: Logger, browser: BrowserInstance): Promise<void>;
 }

package/build/shared/pdf.http.js

@@ -16,7 +16,7 @@ export default class ChromiumPDFPostRoute extends BrowserHTTPRoute {
     method = Methods.post;
     path = [HTTPRoutes.pdf, HTTPRoutes.chromiumPdf];
     tags = [APITags.browserAPI];
-    handler = async (req, res, logger, browser) => {
+    async handler(req, res, logger, browser) {
         logger.info('PDF API invoked with body:', req.body);
         const contentType = !req.headers.accept || req.headers.accept?.includes('*')
             ? 'application/pdf'
@@ -114,5 +114,5 @@ 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/build/shared/performance.http.d.ts

@@ -26,5 +26,5 @@ export default class PerformancePost extends BrowserHTTPRoute {
     method: Methods;
     path: HTTPRoutes[];
     tags: APITags[];
-    handler: (req: Request, res: ServerResponse, _logger: Logger, browser: BrowserInstance) => Promise<void>;
+    handler(req: Request, res: ServerResponse, _logger: Logger, browser: BrowserInstance): Promise<void>;
 }

package/build/shared/performance.http.js

@@ -11,7 +11,7 @@ export default class PerformancePost extends BrowserHTTPRoute {
     method = Methods.post;
     path = [HTTPRoutes.performance, HTTPRoutes.chromiumPerformance];
     tags = [APITags.browserAPI];
-    handler = async (req, res, _logger, browser) => {
+    async handler(req, res, _logger, browser) {
         const config = this.config();
         const response = await main({
             browser,
@@ -20,5 +20,5 @@ export default class PerformancePost extends BrowserHTTPRoute {
             timeout: config.getTimeout(),
         });
         return jsonResponse(res, 200, response);
-    };
+    }
 }

package/build/shared/scrape.http.d.ts

@@ -115,5 +115,5 @@ export default class ChromiumScrapePostRoute extends BrowserHTTPRoute {
     method: Methods;
     path: HTTPRoutes[];
     tags: APITags[];
-    handler: (req: Request, res: ServerResponse, logger: Logger, browser: BrowserInstance) => Promise<void>;
+    handler(req: Request, res: ServerResponse, logger: Logger, browser: BrowserInstance): Promise<void>;
 }

package/build/shared/scrape.http.js

@@ -54,7 +54,7 @@ export default class ChromiumScrapePostRoute extends BrowserHTTPRoute {
     method = Methods.post;
     path = [HTTPRoutes.scrape, HTTPRoutes.chromiumScrape];
     tags = [APITags.browserAPI];
-    handler = async (req, res, logger, browser) => {
+    async handler(req, res, logger, browser) {
         logger.info('Scrape API invoked with body:', req.body);
         const contentType = !req.headers.accept || req.headers.accept?.includes('*')
             ? contentTypes.html
@@ -202,5 +202,5 @@ export default class ChromiumScrapePostRoute extends BrowserHTTPRoute {
         page.close().catch(noop);
         logger.info('Scrape API request completed');
         return jsonResponse(res, 200, response, false);
-    };
+    }
 }

package/build/shared/screenshot.http.d.ts

@@ -46,5 +46,5 @@ export default class ScreenshotPost extends BrowserHTTPRoute {
     method: Methods;
     path: HTTPRoutes[];
     tags: APITags[];
-    handler: (req: Request, res: ServerResponse, logger: Logger, browser: BrowserInstance) => Promise<void>;
+    handler(req: Request, res: ServerResponse, logger: Logger, browser: BrowserInstance): Promise<void>;
 }

package/build/shared/screenshot.http.js

@@ -15,7 +15,7 @@ export default class ScreenshotPost extends BrowserHTTPRoute {
     method = Methods.post;
     path = [HTTPRoutes.screenshot, HTTPRoutes.chromiumScreenshot];
     tags = [APITags.browserAPI];
-    handler = async (req, res, logger, browser) => {
+    async handler(req, res, logger, browser) {
         logger.info('Screenshot API invoked with body:', req.body);
         const contentType = !req.headers.accept || req.headers.accept?.includes('*')
             ? 'image/png'
@@ -125,5 +125,5 @@ 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/build/shared/utils/function/client.d.ts

@@ -6,7 +6,7 @@ type codeHandler = (params: {
 export declare class FunctionRunner {
     protected browser?: Browser;
     protected page?: Page;
-    log: () => {
+    log(): {
         (...data: any[]): void;
         (message?: any, ...optionalParams: any[]): void;
     };

package/build/shared/utils/function/client.js

@@ -3,7 +3,9 @@ import { _connectToCdpBrowser as connect } from 'puppeteer-core/lib/esm/puppetee
 export class FunctionRunner {
     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, options } = data;

package/build/shim.d.ts

@@ -6,4 +6,4 @@
  *
  * @param req A parsed user requests
  */
-export declare const shimLegacyRequests: (url: URL) => URL;
+export declare function shimLegacyRequests(url: URL): URL;

package/build/shim.js

@@ -8,7 +8,7 @@ const shimParam = ['headless', 'stealth', 'ignoreDefaultArgs', 'slowMo'];
  *
  * @param req A parsed user requests
  */
-export const shimLegacyRequests = (url) => {
+export function shimLegacyRequests(url) {
     const { searchParams } = url;
     const params = [...searchParams];
     const names = params.map(([k]) => k);
@@ -52,4 +52,4 @@ export const shimLegacyRequests = (url) => {
         searchParams.set('launch', JSON.stringify(launchParams));
     }
     return url;
-};
+}

package/build/token.d.ts

@@ -4,14 +4,14 @@ import { EventEmitter } from 'events';
 export declare class Token extends EventEmitter {
     protected config: Config;
     constructor(config: Config);
-    isAuthorized: (req: Request, route: BrowserHTTPRoute | BrowserWebsocketRoute | HTTPRoute | WebSocketRoute) => Promise<boolean>;
+    isAuthorized(req: Request, route: BrowserHTTPRoute | BrowserWebsocketRoute | HTTPRoute | WebSocketRoute): Promise<boolean>;
     /**
      * Implement any browserless-core-specific shutdown logic here.
      * Calls the empty-SDK stop method for downstream implementations.
      */
-    shutdown: () => Promise<void>;
+    shutdown(): Promise<void>;
     /**
      * Left blank for downstream SDK modules to optionally implement.
      */
-    stop: () => void;
+    stop(): void;
 }

package/build/token.js

@@ -6,7 +6,7 @@ export class Token extends EventEmitter {
         super();
         this.config = config;
     }
-    isAuthorized = async (req, route) => {
+    async isAuthorized(req, route) {
         const token = this.config.getToken();
         if (token === null) {
             return true;
@@ -19,16 +19,16 @@ export class Token extends EventEmitter {
             return false;
         }
         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.
      */
-    shutdown = async () => {
-        await this.stop();
-    };
+    async shutdown() {
+        return await this.stop();
+    }
     /**
      * Left blank for downstream SDK modules to optionally implement.
      */
-    stop = () => { };
+    stop() { }
 }

package/build/types.d.ts

@@ -182,7 +182,7 @@ export declare 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: (req: Request, res: http.ServerResponse, logger: Logger) => Promise<unknown>;
+    abstract handler(req: Request, res: http.ServerResponse, logger: Logger): Promise<unknown>;
 }
 /**
  * A HTTP-based route, with a handler, that can fulfill requests but
@@ -196,7 +196,7 @@ export declare 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: (req: Request, res: http.ServerResponse, logger: Logger, browser: BrowserInstance) => Promise<unknown>;
+    abstract handler(req: Request, res: http.ServerResponse, logger: Logger, browser: BrowserInstance): Promise<unknown>;
     /**
      * An optional function to automatically set up or handle new page
      * creation. Useful for injecting behaviors or other functionality.
@@ -212,7 +212,7 @@ export declare abstract class WebSocketRoute extends Route {
     /**
      * Handles an inbound Websocket request, and handles the connection
      */
-    abstract handler: (req: Request, socket: stream.Duplex, head: Buffer, logger: Logger) => Promise<unknown>;
+    abstract handler(req: Request, socket: stream.Duplex, head: Buffer, logger: Logger): Promise<unknown>;
 }
 /**
  * A WebSocket-based route, with a handler, that can fulfill requests
@@ -279,7 +279,7 @@ export interface BrowserlessSession {
     isTempDataDir: boolean;
     launchOptions: CDPLaunchOptions | BrowserServerOptions;
     numbConnected: number;
-    resolver: (val: unknown) => void;
+    resolver(val: unknown): void;
     routePath: string | string[];
     startedOn: number;
     ttl: number;

package/build/webhooks.d.ts

@@ -14,9 +14,9 @@ export declare class WebHooks extends EventEmitter {
      * Implement any browserless-core-specific shutdown logic here.
      * Calls the empty-SDK stop method for downstream implementations.
      */
-    shutdown: () => Promise<void>;
+    shutdown(): Promise<void>;
     /**
      * Left blank for downstream SDK modules to optionally implement.
      */
-    stop: () => void;
+    stop(): void;
 }

package/build/webhooks.js

@@ -46,11 +46,11 @@ export class WebHooks extends EventEmitter {
      * Implement any browserless-core-specific shutdown logic here.
      * Calls the empty-SDK stop method for downstream implementations.
      */
-    shutdown = async () => {
-        await this.stop();
-    };
+    async shutdown() {
+        return await this.stop();
+    }
     /**
      * Left blank for downstream SDK modules to optionally implement.
      */
-    stop = () => { };
+    stop() { }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@browserless.io/browserless",
-  "version": "2.12.0-beta-4",
+  "version": "2.12.0",
   "license": "SSPL",
   "description": "The browserless platform",
   "author": "browserless.io",
@@ -57,7 +57,7 @@
     "gradient-string": "^2.0.0",
     "http-proxy": "^1.18.1",
     "lighthouse": "^12.0.0",
-    "micromatch": "^4.0.4",
+    "micromatch": "^4.0.7",
     "playwright-1.40": "npm:playwright-core@1.40.1",
     "playwright-1.41": "npm:playwright-core@1.41.2",
     "playwright-1.42": "npm:playwright-core@1.42.1",
@@ -79,7 +79,7 @@
     "@types/mocha": "^10.0.6",
     "@types/node": "^20.12.12",
     "@types/sinon": "^17.0.3",
-    "@typescript-eslint/eslint-plugin": "^7.9.0",
+    "@typescript-eslint/eslint-plugin": "^7.10.0",
     "@typescript-eslint/parser": "^7.10.0",
     "assert": "^2.0.0",
     "chai": "^5.1.1",

package/src/browserless.ts

@@ -119,15 +119,15 @@ export class Browserless extends EventEmitter {
       new Router(this.config, this.browserManager, this.limiter, this.Logger);
   }
 
-  protected loadPwVersions = async (): Promise<void> => {
+  protected async loadPwVersions(): Promise<void> {
     const { playwrightVersions } = JSON.parse(
       (await fs.readFile('package.json')).toString(),
     );
 
     this.config.setPwVersions(playwrightVersions);
-  };
+  }
 
-  protected saveMetrics = async (): Promise<void> => {
+  protected async saveMetrics(): Promise<void> {
     const metricsPath = this.config.getMetricsJSONPath();
     const { cpu, memory } = await this.monitoring.getMachineStats();
     const metrics = await this.metrics.get();
@@ -163,9 +163,9 @@ export class Browserless extends EventEmitter {
         false,
       );
     }
-  };
+  }
 
-  public setMetricsSaveInterval = (interval: number) => {
+  public setMetricsSaveInterval(interval: number) {
     if (interval <= 0) {
       return console.warn(
         `Interval value of "${interval}" must be greater than 1. Ignoring`,
@@ -178,7 +178,7 @@ export class Browserless extends EventEmitter {
       this.saveMetrics,
       this.metricsSaveInterval,
     );
-  };
+  }
 
   protected routeIsDisabled(route: routeInstances) {
     return this.disabledRouteNames.some((name) => name === route.name);