@browserless.io/browserless 2.7.1 → 2.9.0

package/build/shared/pdf.http.js

@@ -1,4 +1,4 @@
-import { APITags, BadRequest, BrowserHTTPRoute, BrowserlessRoutes, ChromiumCDP, HTTPRoutes, Methods, bestAttemptCatch, contentTypes, dedent, noop, sleep, waitForEvent as waitForEvt, waitForFunction as waitForFn, writeResponse, } from '@browserless.io/browserless';
+import { APITags, BadRequest, BrowserHTTPRoute, BrowserlessRoutes, ChromiumCDP, HTTPRoutes, Methods, bestAttemptCatch, contentTypes, dedent, noop, sleep, waitForEvent as waitForEvt, waitForFunction as waitForFn, } from '@browserless.io/browserless';
 import { Stream } from 'stream';
 export default class ChromiumPDFPostRoute extends BrowserHTTPRoute {
     name = BrowserlessRoutes.ChromiumPDFPostRoute;
@@ -16,13 +16,13 @@ export default class ChromiumPDFPostRoute extends BrowserHTTPRoute {
     method = Methods.post;
     path = [HTTPRoutes.pdf, HTTPRoutes.chromiumPdf];
     tags = [APITags.browserAPI];
-    handler = async (req, res, browser) => {
+    handler = async (req, res, logger, browser) => {
+        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);
         const { url, gotoOptions, authenticate, html, addScriptTag = [], addStyleTag = [], cookies = [], emulateMediaType, rejectRequestPattern = [], requestInterceptors = [], rejectResourceTypes = [], options, setExtraHTTPHeaders, setJavaScriptEnabled, userAgent, viewport, waitForEvent, waitForFunction, waitForSelector, waitForTimeout, bestAttempt = false, } = req.body;
@@ -60,6 +60,7 @@ export default class ChromiumPDFPostRoute extends BrowserHTTPRoute {
             page.on('request', (req) => {
                 if (!!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) => req.url().match(r.pattern));
@@ -112,5 +113,6 @@ export default class ChromiumPDFPostRoute extends BrowserHTTPRoute {
         readStream.end(pdfBuffer);
         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

@@ -1,5 +1,5 @@
 /// <reference types="node" />
-import { APITags, BrowserHTTPRoute, BrowserInstance, CDPLaunchOptions, ChromiumCDP, HTTPRoutes, Methods, Request, SystemQueryParameters, contentTypes } from '@browserless.io/browserless';
+import { APITags, BrowserHTTPRoute, BrowserInstance, CDPLaunchOptions, ChromiumCDP, HTTPRoutes, Logger, Methods, Request, SystemQueryParameters, contentTypes } from '@browserless.io/browserless';
 import { ServerResponse } from 'http';
 export interface BodySchema {
     budgets?: Array<object>;
@@ -26,5 +26,5 @@ export default class PerformancePost extends BrowserHTTPRoute {
     method: Methods;
     path: HTTPRoutes[];
     tags: APITags[];
-    handler: (req: Request, res: ServerResponse, browser: BrowserInstance) => Promise<void>;
+    handler: (req: Request, res: ServerResponse, _logger: Logger, browser: BrowserInstance) => Promise<void>;
 }

package/build/shared/performance.http.js

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

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

@@ -1,5 +1,5 @@
 /// <reference types="node" />
-import { APITags, BrowserHTTPRoute, BrowserInstance, CDPLaunchOptions, ChromiumCDP, HTTPRoutes, InBoundRequest, Methods, OutBoundRequest, Request, ScrapeDebugOptions, ScrapeElementSelector, SystemQueryParameters, WaitForEventOptions, WaitForFunctionOptions, WaitForSelectorOptions, bestAttempt, contentTypes, rejectRequestPattern, rejectResourceTypes, requestInterceptors } from '@browserless.io/browserless';
+import { APITags, BrowserHTTPRoute, BrowserInstance, CDPLaunchOptions, ChromiumCDP, HTTPRoutes, InBoundRequest, Logger, Methods, OutBoundRequest, Request, ScrapeDebugOptions, ScrapeElementSelector, SystemQueryParameters, WaitForEventOptions, WaitForFunctionOptions, WaitForSelectorOptions, bestAttempt, contentTypes, rejectRequestPattern, rejectResourceTypes, requestInterceptors } from '@browserless.io/browserless';
 import { Cookie, Page } from 'puppeteer-core';
 import { ServerResponse } from 'http';
 export interface BodySchema {
@@ -115,5 +115,5 @@ export default class ChromiumScrapePostRoute extends BrowserHTTPRoute {
     method: Methods;
     path: HTTPRoutes[];
     tags: APITags[];
-    handler: (req: Request, res: ServerResponse, browser: BrowserInstance) => Promise<void>;
+    handler: (req: Request, res: ServerResponse, logger: Logger, browser: BrowserInstance) => Promise<void>;
 }

package/build/shared/scrape.http.js

@@ -54,7 +54,8 @@ export default class ChromiumScrapePostRoute extends BrowserHTTPRoute {
     method = Methods.post;
     path = [HTTPRoutes.scrape, HTTPRoutes.chromiumScrape];
     tags = [APITags.browserAPI];
-    handler = async (req, res, browser) => {
+    handler = async (req, res, logger, browser) => {
+        logger.info('Scrape API invoked with body:', req.body);
         const contentType = !req.headers.accept || req.headers.accept?.includes('*')
             ? contentTypes.html
             : req.headers.accept;
@@ -121,6 +122,7 @@ export default class ChromiumScrapePostRoute extends BrowserHTTPRoute {
             page.on('request', (req) => {
                 if (!!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) => req.url().match(r.pattern));
@@ -198,6 +200,7 @@ export default class ChromiumScrapePostRoute extends BrowserHTTPRoute {
             debug: debugData,
         };
         page.close().catch(noop);
+        logger.info('Scrape API request completed');
         return jsonResponse(res, 200, response, false);
     };
 }

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

@@ -1,5 +1,5 @@
 /// <reference types="node" />
-import { APITags, BrowserHTTPRoute, BrowserInstance, CDPLaunchOptions, ChromiumCDP, HTTPRoutes, Methods, Request, SystemQueryParameters, WaitForEventOptions, WaitForFunctionOptions, WaitForSelectorOptions, bestAttempt, contentTypes, rejectRequestPattern, rejectResourceTypes, requestInterceptors } from '@browserless.io/browserless';
+import { APITags, BrowserHTTPRoute, BrowserInstance, CDPLaunchOptions, ChromiumCDP, HTTPRoutes, Logger, Methods, Request, SystemQueryParameters, WaitForEventOptions, WaitForFunctionOptions, WaitForSelectorOptions, bestAttempt, contentTypes, rejectRequestPattern, rejectResourceTypes, requestInterceptors } from '@browserless.io/browserless';
 import { Page } from 'puppeteer-core';
 import { ServerResponse } from 'http';
 export interface QuerySchema extends SystemQueryParameters {
@@ -46,5 +46,5 @@ export default class ScreenshotPost extends BrowserHTTPRoute {
     method: Methods;
     path: HTTPRoutes[];
     tags: APITags[];
-    handler: (req: Request, res: ServerResponse, browser: BrowserInstance) => Promise<void>;
+    handler: (req: Request, res: ServerResponse, logger: Logger, browser: BrowserInstance) => Promise<void>;
 }

package/build/shared/screenshot.http.js

@@ -15,7 +15,8 @@ export default class ScreenshotPost extends BrowserHTTPRoute {
     method = Methods.post;
     path = [HTTPRoutes.screenshot, HTTPRoutes.chromiumScreenshot];
     tags = [APITags.browserAPI];
-    handler = async (req, res, browser) => {
+    handler = async (req, res, logger, browser) => {
+        logger.info('Screenshot API invoked with body:', req.body);
         const contentType = !req.headers.accept || req.headers.accept?.includes('*')
             ? 'image/png'
             : req.headers.accept;
@@ -61,6 +62,7 @@ export default class ScreenshotPost extends BrowserHTTPRoute {
             page.on('request', (req) => {
                 if (!!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) => req.url().match(r.pattern));
@@ -122,5 +124,6 @@ export default class ScreenshotPost extends BrowserHTTPRoute {
         readStream.end(buffer);
         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/handler.d.ts

@@ -1,7 +1,6 @@
-import { BrowserInstance, Config, Request } from '@browserless.io/browserless';
+import { BrowserInstance, Config, Logger, Request } from '@browserless.io/browserless';
 import { FunctionRunner } from './client.js';
 import { Page } from 'puppeteer-core';
-import debug from 'debug';
 declare global {
     interface Window {
         BrowserlessFunctionRunner: typeof FunctionRunner;
@@ -10,7 +9,7 @@ declare global {
 interface HandlerOptions {
     downloadPath?: string;
 }
-declare const _default: (config: Config, debug: debug.Debugger, options?: HandlerOptions) => (req: Request, browser: BrowserInstance) => Promise<{
+declare const _default: (config: Config, logger: Logger, options?: HandlerOptions) => (req: Request, browser: BrowserInstance) => Promise<{
     contentType: string;
     page: Page;
     payload: unknown;

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

@@ -1,7 +1,7 @@
 import { BadRequest, HTTPRoutes, contentTypes, convertIfBase64, exists, getTokenFromRequest, id, makeExternalURL, mimeTypes, } from '@browserless.io/browserless';
 import fs from 'fs';
 import path from 'path';
-export default (config, debug, options = {}) => async (req, browser) => {
+export default (config, logger, options = {}) => async (req, browser) => {
     const isJson = req.headers['content-type']?.includes('json');
     const functionAssetLocation = path.join(config.getStatic(), 'function');
     const functionRequestPath = makeExternalURL(config.getExternalAddress(), HTTPRoutes.function);
@@ -29,7 +29,7 @@ export default (config, debug, options = {}) => async (req, browser) => {
      */
     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) {
@@ -48,23 +48,23 @@ export default (config, debug, options = {}) => async (req, browser) => {
                     status: 200,
                 });
             }
-            debug(`Static asset request to "${requestUrl}" couldn't be found, 404-ing`);
+            logger.warn(`Static asset request to "${requestUrl}" couldn't be found, 404-ing`);
             return request.respond({
                 body: code,
                 contentType: `Couldn't locate this file "${filename}" request "${requestUrl}" in "${functionAssetLocation}"`,
                 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);
     const { contentType, payload } = await page
@@ -85,7 +85,7 @@ export default (config, debug, options = {}) => async (req, browser) => {
         });
     }, browserWSEndpoint, context, functionCodeJS, JSON.stringify(options))
         .catch((e) => {
-        debug(`Error running code: ${e}`);
+        logger.error(`Error running code: ${e}`);
         throw new BadRequest(e.message);
     });
     return {

package/build/shared/utils/performance/child.js

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

package/build/shared/utils/performance/main.d.ts

@@ -1,3 +1,3 @@
 import { mainOptions } from './types.js';
-declare const _default: ({ browser, context, timeout, }: mainOptions) => Promise<unknown>;
+declare const _default: ({ browser, context, logger, timeout, }: mainOptions) => Promise<unknown>;
 export default _default;

package/build/shared/utils/performance/main.js

@@ -1,14 +1,12 @@
-import { createLogger } from '@browserless.io/browserless';
 import { fork } from 'child_process';
 import path from 'path';
 const DEFAULT_AUDIT_CONFIG = {
     extends: 'lighthouse:default',
 };
-export default async ({ browser, context, timeout, }) => {
+export default async ({ browser, context, logger, timeout, }) => {
     return new Promise((resolve, reject) => {
-        const debug = createLogger('http:performance:main');
         const childPath = path.join('./', 'build', 'shared', 'utils', 'performance', '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;
         let closed = false;
@@ -34,13 +32,13 @@ export default async ({ browser, context, timeout, }) => {
             port,
         };
         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) => {
             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',
@@ -49,7 +47,7 @@ export default async ({ browser, context, timeout, }) => {
                 });
             }
             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/build/shared/utils/performance/types.d.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;
     error?: unknown;
@@ -12,6 +12,7 @@ export interface mainOptions {
         config?: unknown;
         url: string;
     };
+    logger: Logger;
     timeout: number;
 }
 export interface start {

package/build/types.d.ts

@@ -1,10 +1,9 @@
 /// <reference types="node" />
 /// <reference types="node" />
 /// <reference types="node" />
-/// <reference types="debug" />
 import * as http from 'http';
 import * as stream from 'stream';
-import { APITags, Browserless, ChromiumCDP, ChromiumPlaywright, Config, FirefoxPlaywright, HTTPManagementRoutes, HTTPRoutes, Methods, Metrics, Request, WebkitPlaywright, WebsocketRoutes, contentTypes } from '@browserless.io/browserless';
+import { APITags, Browserless, ChromiumCDP, ChromiumPlaywright, Config, FirefoxPlaywright, HTTPManagementRoutes, HTTPRoutes, Logger, Methods, Metrics, Request, WebkitPlaywright, WebsocketRoutes, contentTypes } from '@browserless.io/browserless';
 import { HTTPRequest, Page, ResponseForRequest, ScreenshotOptions } from 'puppeteer-core';
 export type PathTypes = HTTPRoutes | WebsocketRoutes | HTTPManagementRoutes | string;
 export interface BeforeRequest {
@@ -52,11 +51,10 @@ declare 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'];
-    constructor(_browserManager: Browserless['browserManager'], _config: Browserless['config'], _fileSystem: Browserless['fileSystem'], _debug: Browserless['debug'], _metrics: Browserless['metrics'], _monitoring: Browserless['monitoring'], _staticSDKDir: Browserless['staticSDKDir']);
+    constructor(_browserManager: Browserless['browserManager'], _config: Browserless['config'], _fileSystem: Browserless['fileSystem'], _metrics: Browserless['metrics'], _monitoring: Browserless['monitoring'], _staticSDKDir: Browserless['staticSDKDir']);
     /**
      * A unique name to identify this route. Used in downstream
      * SDKs to potentially remove or disable.
@@ -107,13 +105,6 @@ declare abstract class Route {
      * @returns Config
      */
     config: () => 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: () => import("debug").Debugger;
     /**
      * Helper function that loads the file-system module
      * for interacting with file-systems. Defined and injected by
@@ -184,7 +175,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) => 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
@@ -198,7 +189,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, 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.
@@ -214,7 +205,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) => 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
@@ -228,7 +219,7 @@ export declare abstract class BrowserWebsocketRoute extends Route {
      * Handles an inbound Websocket request, and handles the connection
      * with the prior set browser being injected.
      */
-    abstract handler(req: Request, socket: stream.Duplex, head: Buffer, browser: BrowserInstance): Promise<unknown>;
+    abstract handler(req: Request, socket: stream.Duplex, head: Buffer, 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.

package/build/types.js

@@ -2,15 +2,13 @@ class Route {
     _browserManager;
     _config;
     _fileSystem;
-    _debug;
     _metrics;
     _monitoring;
     _staticSDKDir;
-    constructor(_browserManager, _config, _fileSystem, _debug, _metrics, _monitoring, _staticSDKDir) {
+    constructor(_browserManager, _config, _fileSystem, _metrics, _monitoring, _staticSDKDir) {
         this._browserManager = _browserManager;
         this._config = _config;
         this._fileSystem = _fileSystem;
-        this._debug = _debug;
         this._metrics = _metrics;
         this._monitoring = _monitoring;
         this._staticSDKDir = _staticSDKDir;
@@ -60,13 +58,6 @@ class Route {
      * @returns Config
      */
     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

package/build/utils.d.ts

@@ -120,6 +120,6 @@ interface RequestInitTimeout extends RequestInit {
 }
 export declare const fetchTimeout: (input: RequestInfo | URL, initWithTimeout?: RequestInitTimeout) => Promise<Response>;
 export declare const untildify: (path: string) => string;
-export declare const printLogo: (docsLink: string) => string;
+export declare const printLogo: (docsLink: string, debugURL?: string | boolean) => string;
 export declare const getCDPClient: (page: Page) => CDPSession;
 export {};

package/build/utils.js

@@ -561,12 +561,16 @@ export const untildify = (path) => {
     const homeDir = homedir();
     return homeDir ? path.replace(/^~(?=$|\/|\\)/, homeDir) : path;
 };
-export const printLogo = (docsLink) => `
+export const printLogo = (docsLink, debugURL) => `
 ---------------------------------------------------------
 | 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', '#ffea00')(`
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@browserless.io/browserless",
-  "version": "2.7.1",
+  "version": "2.9.0",
   "license": "SSPL",
   "description": "The browserless platform",
   "author": "browserless.io",
@@ -25,8 +25,9 @@
     "clean": "node scripts/clean.js",
     "dev": "npm run build:dev && env-cmd -f .env node build",
     "install:adblock": "node scripts/install-adblock.js",
+    "install:debugger": "node scripts/install-debugger.js",
     "install:browsers": "npx --yes playwright install chromium firefox webkit chrome",
-    "install:dev": "npm run install:browsers",
+    "install:dev": "npm run install:browsers && npm run install:debugger",
     "lint": "eslint . --ext .ts --fix",
     "prepack": "npm run build:dev",
     "prettier": "prettier '{src,functions,scripts,bin,external,.github}/**/*.{js,ts,json,yml,yaml,md}' --log-level error --write",
@@ -55,40 +56,42 @@
     "get-port": "^7.1.0",
     "gradient-string": "^2.0.0",
     "http-proxy": "^1.18.1",
-    "lighthouse": "^11.1.0",
+    "lighthouse": "^12.0.0",
     "micromatch": "^4.0.4",
-    "playwright-core": "1.43.0",
-    "puppeteer-core": "^22.6.3",
+    "playwright-core": "1.44.0",
+    "puppeteer-core": "^22.8.0",
     "puppeteer-extra": "^3.3.6",
     "puppeteer-extra-plugin-stealth": "^2.11.2",
     "queue": "^7.0.0",
-    "systeminformation": "^5.22.7"
+    "systeminformation": "^5.22.8",
+    "tar-fs": "^3.0.6"
   },
   "optionalDependencies": {
-    "@types/chai": "^4.3.14",
+    "@types/chai": "^4.3.16",
     "@types/debug": "^4.1.12",
     "@types/gradient-string": "^1.1.6",
     "@types/http-proxy": "^1.17.14",
-    "@types/micromatch": "^4.0.6",
+    "@types/micromatch": "^4.0.7",
     "@types/mocha": "^10.0.6",
-    "@types/node": "^20.12.7",
+    "@types/node": "^20.12.11",
     "@types/sinon": "^17.0.3",
-    "@typescript-eslint/eslint-plugin": "^7.6.0",
-    "@typescript-eslint/parser": "^7.6.0",
+    "@typescript-eslint/eslint-plugin": "^7.8.0",
+    "@typescript-eslint/parser": "^7.8.0",
     "assert": "^2.0.0",
-    "chai": "^5.1.0",
+    "chai": "^5.1.1",
     "cross-env": "^7.0.3",
     "env-cmd": "^10.1.0",
-    "esbuild": "^0.20.2",
+    "esbuild": "^0.21.2",
     "esbuild-plugin-polyfill-node": "^0.3.0",
     "eslint": "^8.57.0",
     "eslint-plugin-typescript-sort-keys": "^3.2.0",
     "extract-zip": "^2.0.1",
-    "marked": "^12.0.1",
+    "gunzip-maybe": "^1.4.2",
+    "marked": "^12.0.2",
     "mocha": "^10.4.0",
     "move-file": "^3.1.0",
     "prettier": "^3.2.5",
-    "sinon": "^17.0.1",
+    "sinon": "^17.0.2",
     "ts-node": "^10.9.2",
     "typescript": "^5.4.5",
     "typescript-json-schema": "^0.63.0"

package/scripts/install-debugger.js

@@ -1,20 +1,60 @@
-import { cp } from 'fs/promises';
-import { fileURLToPath } from 'url';
-import path from 'path';
+/* global fetch, console, process */
+import { Readable } from 'stream';
+import { existsSync } from 'fs';
+import { join } from 'path';
+import os from 'os';
 
-const __dirname = path.dirname(fileURLToPath(import.meta.url));
+import { deleteAsync } from 'del';
+import gunzip from 'gunzip-maybe';
+import { moveFile } from 'move-file';
+import tar from 'tar-fs';
 
-const from = path.join(
-  __dirname,
-  '..',
-  'node_modules',
-  'browserless-debugger',
-  'static',
-);
-const to = path.join(__dirname, '..', 'static', 'debugger');
+const registryURL = 'https://registry.npmjs.org/@browserless.io/debugger/';
+const tmp = join(os.tmpdir(), 'browserless-debugger');
+const untarDir = join(tmp, 'package', 'static');
+const debuggerDir = join(process.cwd(), 'static', 'debugger');
+
+const lastFromArr = (arr) => arr[arr.length - 1];
+const dlAndExtract = (url) =>
+  fetch(url).then(
+    (response) =>
+      new Promise((resolve, reject) => {
+        // @ts-ignore
+        Readable.fromWeb(response.body)
+          .pipe(gunzip())
+          .pipe(tar.extract(tmp))
+          .on('error', reject)
+          .on('finish', resolve);
+      }),
+  );
+
+const getLatestVersion = async () => {
+  const response = await fetch(registryURL);
+  const json = await response.json();
+  const latest = lastFromArr(Object.keys(json.versions));
+  return json.versions[latest];
+};
 
 (async () => {
-  await cp(from, to, {
-    recursive: true,
+  if (existsSync(debuggerDir)) {
+    await deleteAsync(debuggerDir);
+  }
+
+  const dist = await getLatestVersion()
+    .then((version) => version.dist.tarball)
+    .catch((error) => {
+      console.error(`Couldn't fetch latest debugger version: ${error.message}`);
+      process.exit(1);
+    });
+
+  await dlAndExtract(dist).catch((error) => {
+    console.error(`Couldn't download debugger: ${error.message}`);
+    process.exit(1);
   });
-})();
+
+  await moveFile(untarDir, debuggerDir);
+  await deleteAsync(tmp, { force: true });
+})().catch((error) => {
+  console.error(`An error occurred: ${error.message}`);
+  process.exit(1);
+});