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

package/CHANGELOG.md

@@ -1,4 +1,12 @@
-# [Latest](https://github.com/browserless/chrome/compare/v2.11.0...main)
+# [Latest](https://github.com/browserless/chrome/compare/v2.12.0...main)
+- Dependency updates.
+
+# [v2.12.0](https://github.com/browserless/chrome/compare/v2.11.0...v2.12.0)
+**Potentially Breaking**
+- SDK projects should now use conventional class method properties versus the "fat-arrow" style instance methods.
+
+**Updates**
+- Support for multi-version playwright (puppeteer coming soon). Browserless now checks the version in the User-Agent header and loads the appropriate playwright server for it.
 - Dependency updates.
 
 # [v2.11.0](https://github.com/browserless/chrome/compare/v2.10.0...v2.11.0)

package/bin/scaffold/README.md

@@ -175,7 +175,7 @@ export default class HelloWorldRoute extends HTTPRoute {
   // Handler is a function, getting the request and response objects, and is where you'll write the
   // core logic behind this route. Use utilities like writeResponse or writeJSONResponse to help
   // return the appropriate response.
-  handler = async (_req, res, _logger: Logger): Promise<void> => {
+  async handler (_req, res, _logger: Logger): Promise<void> {
     const response: ResponseSchema = 'Hello World!';
     return writeResponse(res, 200, ResponseSchema, contentTypes.text);
   };
@@ -228,8 +228,9 @@ export default class ChromiumWebSocketRoute extends BrowserWebsocketRoute {
   // Routes with a browser type get a browser argument of the Browser instance, otherwise
   // request, socket, and head are the other 3 arguments. Here we pass them through
   // and proxy the request into Chromium to handle.
-  handler = async (req, socket, head, logger, chromium): Promise<void> =>
-    chromium.proxyWebSocket(req, socket, head);
+  async handler (req, socket, head, logger, chromium): Promise<void> {
+    return chromium.proxyWebSocket(req, socket, head);
+  }
 }
 ```
 
@@ -284,7 +285,7 @@ import { Config } from '@browserless.io/browserless';
 // Your config class must be the default export
 // and you can export the Class or an instance of it.
 export default class MyConfig extends Config {
-  public getS3Bucket = (): string => {
+  public getS3Bucket(): string {
     // Load from environment variables or default to some other named bucket.
     return process.env.S3_BUCKET ?? 'my-fun-s3-bucket';
   };
@@ -344,7 +345,7 @@ export default class PDFToS3Route extends BrowserHTTPRoute {
   tags = [APITags.browserAPI];
 
   // Handler's are where we embed the logic that facilitates this route.
-  handler = async (req, res, logger, browser): Promise<void> => {
+  async handler (req, res, logger, browser): Promise<void> {
     // Modules like Config are injected via this internal methods.
     // Use them to load core modules within the platform.
     const config = this.config() as MyConfig;

package/bin/scaffold/src/hello-world.http.ts

@@ -22,13 +22,13 @@ export default class HelloWorldHTTPRoute extends HTTPRoute {
   method = Methods.get;
   path = '/hello';
   tags = [APITags.management];
-  handler = async (
+  async handler (
     req: Request,
     res: Response,
     logger: Logger,
-  ): Promise<void> => {
+  ): Promise<void> {
     logger.verbose(`${req.method} /hello was called!`);
     const response: ResponseSchema = 'Hello World!';
     return writeResponse(res, 200, response, contentTypes.text);
-  };
+  }
 }

package/build/browserless.d.ts

@@ -36,9 +36,9 @@ export declare class Browserless extends EventEmitter {
         token?: Browserless['token'];
         webhooks?: Browserless['webhooks'];
     });
-    protected loadPwVersions: () => Promise<void>;
-    protected saveMetrics: () => Promise<void>;
-    setMetricsSaveInterval: (interval: number) => void;
+    protected loadPwVersions(): Promise<void>;
+    protected saveMetrics(): Promise<void>;
+    setMetricsSaveInterval(interval: number): void;
     protected routeIsDisabled(route: routeInstances): boolean;
     setStaticSDKDir(dir: string): void;
     disableRoutes(...routeNames: string[]): void;

package/build/browserless.js

@@ -45,11 +45,11 @@ export class Browserless extends EventEmitter {
             router ||
                 new Router(this.config, this.browserManager, this.limiter, this.Logger);
     }
-    loadPwVersions = async () => {
+    async loadPwVersions() {
         const { playwrightVersions } = JSON.parse((await fs.readFile('package.json')).toString());
         this.config.setPwVersions(playwrightVersions);
-    };
-    saveMetrics = async () => {
+    }
+    async saveMetrics() {
         const metricsPath = this.config.getMetricsJSONPath();
         const { cpu, memory } = await this.monitoring.getMachineStats();
         const metrics = await this.metrics.get();
@@ -76,15 +76,15 @@ export class Browserless extends EventEmitter {
             this.logger.info(`Saving metrics to "${metricsPath}"`);
             this.fileSystem.append(metricsPath, JSON.stringify(aggregatedStats), false);
         }
-    };
-    setMetricsSaveInterval = (interval) => {
+    }
+    setMetricsSaveInterval(interval) {
         if (interval <= 0) {
             return console.warn(`Interval value of "${interval}" must be greater than 1. Ignoring`);
         }
         clearInterval(this.metricsSaveInterval);
         this.metricsSaveInterval = interval;
         this.metricsSaveIntervalID = setInterval(this.saveMetrics, this.metricsSaveInterval);
-    };
+    }
     routeIsDisabled(route) {
         return this.disabledRouteNames.some((name) => name === route.name);
     }

package/build/browsers/chromium.cdp.d.ts

@@ -27,16 +27,16 @@ export declare class ChromiumCDP extends EventEmitter {
     });
     protected cleanListeners(): void;
     keepUntil(): number;
-    getPageId: (page: Page) => string;
-    protected onTargetCreated: (target: Target) => Promise<void>;
-    isRunning: () => boolean;
-    newPage: () => Promise<Page>;
-    close: () => Promise<void>;
-    pages: () => Promise<Page[]>;
-    process: () => import("child_process").ChildProcess | null;
-    launch: (options?: CDPLaunchOptions) => Promise<Browser>;
-    wsEndpoint: () => string | null;
-    publicWSEndpoint: (token: string | null) => string | null;
-    proxyPageWebSocket: (req: Request, socket: Duplex, head: Buffer) => Promise<void>;
-    proxyWebSocket: (req: Request, socket: Duplex, head: Buffer) => Promise<void>;
+    getPageId(page: Page): string;
+    protected onTargetCreated(target: Target): Promise<void>;
+    isRunning(): boolean;
+    newPage(): Promise<Page>;
+    close(): Promise<void>;
+    pages(): Promise<Page[]>;
+    process(): import("child_process").ChildProcess | null;
+    launch(options?: CDPLaunchOptions): Promise<Browser>;
+    wsEndpoint(): string | null;
+    publicWSEndpoint(token: string | null): string | null;
+    proxyPageWebSocket(req: Request, socket: Duplex, head: Buffer): Promise<void>;
+    proxyWebSocket(req: Request, socket: Duplex, head: Buffer): Promise<void>;
 }

package/build/browsers/chromium.cdp.js

@@ -35,11 +35,11 @@ export class ChromiumCDP extends EventEmitter {
     keepUntil() {
         return 0;
     }
-    getPageId = (page) => {
+    getPageId(page) {
         // @ts-ignore
         return page.target()._targetId;
-    };
-    onTargetCreated = async (target) => {
+    }
+    async onTargetCreated(target) {
         if (target.type() === 'page') {
             const page = await target.page().catch((e) => {
                 this.logger.error(`Error in ${this.constructor.name} new page ${e}`);
@@ -83,15 +83,17 @@ export class ChromiumCDP extends EventEmitter {
                 this.emit('newPage', page);
             }
         }
-    };
-    isRunning = () => this.running;
-    newPage = async () => {
+    }
+    isRunning() {
+        return this.running;
+    }
+    async newPage() {
         if (!this.browser) {
             throw new ServerError(`${this.constructor.name} hasn't been launched yet!`);
         }
         return this.browser.newPage();
-    };
-    close = async () => {
+    }
+    async close() {
         if (this.browser) {
             this.logger.info(`Closing ${this.constructor.name} process and all listeners`);
             this.emit('close');
@@ -102,10 +104,14 @@ export class ChromiumCDP extends EventEmitter {
             this.browser = null;
             this.browserWSEndpoint = null;
         }
-    };
-    pages = async () => this.browser?.pages() || [];
-    process = () => this.browser?.process() || null;
-    launch = async (options = {}) => {
+    }
+    async pages() {
+        return this.browser?.pages() || [];
+    }
+    process() {
+        return this.browser?.process() || null;
+    }
+    async launch(options = {}) {
         this.port = await getPort();
         this.logger.info(`${this.constructor.name} got open port ${this.port}`);
         const __dirname = path.dirname(fileURLToPath(import.meta.url));
@@ -130,14 +136,16 @@ export class ChromiumCDP extends EventEmitter {
             : puppeteer.launch.bind(puppeteer);
         this.logger.info(finalOptions, `Launching ${this.constructor.name} Handler`);
         this.browser = (await launch(finalOptions));
-        this.browser.on('targetcreated', this.onTargetCreated);
+        this.browser.on('targetcreated', this.onTargetCreated.bind(this));
         this.running = true;
         this.browserWSEndpoint = this.browser.wsEndpoint();
         this.logger.info(`${this.constructor.name} is running on ${this.browserWSEndpoint}`);
         return this.browser;
-    };
-    wsEndpoint = () => this.browserWSEndpoint;
-    publicWSEndpoint = (token) => {
+    }
+    wsEndpoint() {
+        return this.browserWSEndpoint;
+    }
+    publicWSEndpoint(token) {
         if (!this.browserWSEndpoint) {
             return null;
         }
@@ -148,55 +156,59 @@ export class ChromiumCDP extends EventEmitter {
             externalURL.searchParams.set('token', token);
         }
         return externalURL.href;
-    };
-    proxyPageWebSocket = async (req, socket, head) => new Promise(async (resolve, reject) => {
-        if (!this.browserWSEndpoint || !this.browser) {
-            throw new ServerError(`No browserWSEndpoint found, did you launch first?`);
-        }
-        socket.once('close', resolve);
-        this.logger.info(`Proxying ${req.parsed.href} to ${this.constructor.name}`);
-        const shouldMakePage = req.parsed.pathname.includes(BLESS_PAGE_IDENTIFIER);
-        const page = shouldMakePage ? await this.browser.newPage() : null;
-        const pathname = page
-            ? path.join('/devtools', '/page', this.getPageId(page))
-            : req.parsed.pathname;
-        const target = new URL(pathname, this.browserWSEndpoint).href;
-        req.url = '';
-        // Delete headers known to cause issues
-        delete req.headers.origin;
-        this.proxy.ws(req, socket, head, {
-            changeOrigin: true,
-            target,
-        }, (error) => {
-            this.logger.error(`Error proxying session to ${this.constructor.name}: ${error}`);
-            this.close();
-            return reject(error);
-        });
-    });
-    proxyWebSocket = async (req, socket, head) => new Promise((resolve, reject) => {
-        if (!this.browserWSEndpoint) {
-            throw new ServerError(`No browserWSEndpoint found, did you launch first?`);
-        }
-        const close = once(() => {
-            this.browser?.off('close', close);
-            this.browser?.process()?.off('close', close);
-            socket.off('close', close);
-            return resolve();
+    }
+    async proxyPageWebSocket(req, socket, head) {
+        return new Promise(async (resolve, reject) => {
+            if (!this.browserWSEndpoint || !this.browser) {
+                throw new ServerError(`No browserWSEndpoint found, did you launch first?`);
+            }
+            socket.once('close', resolve);
+            this.logger.info(`Proxying ${req.parsed.href} to ${this.constructor.name}`);
+            const shouldMakePage = req.parsed.pathname.includes(BLESS_PAGE_IDENTIFIER);
+            const page = shouldMakePage ? await this.browser.newPage() : null;
+            const pathname = page
+                ? path.join('/devtools', '/page', this.getPageId(page))
+                : req.parsed.pathname;
+            const target = new URL(pathname, this.browserWSEndpoint).href;
+            req.url = '';
+            // Delete headers known to cause issues
+            delete req.headers.origin;
+            this.proxy.ws(req, socket, head, {
+                changeOrigin: true,
+                target,
+            }, (error) => {
+                this.logger.error(`Error proxying session to ${this.constructor.name}: ${error}`);
+                this.close();
+                return reject(error);
+            });
         });
-        this.browser?.once('close', close);
-        this.browser?.process()?.once('close', close);
-        socket.once('close', close);
-        this.logger.info(`Proxying ${req.parsed.href} to ${this.constructor.name} ${this.browserWSEndpoint}`);
-        req.url = '';
-        // Delete headers known to cause issues
-        delete req.headers.origin;
-        this.proxy.ws(req, socket, head, {
-            changeOrigin: true,
-            target: this.browserWSEndpoint,
-        }, (error) => {
-            this.logger.error(`Error proxying session to ${this.constructor.name}: ${error}`);
-            this.close();
-            return reject(error);
+    }
+    async proxyWebSocket(req, socket, head) {
+        return new Promise((resolve, reject) => {
+            if (!this.browserWSEndpoint) {
+                throw new ServerError(`No browserWSEndpoint found, did you launch first?`);
+            }
+            const close = once(() => {
+                this.browser?.off('close', close);
+                this.browser?.process()?.off('close', close);
+                socket.off('close', close);
+                return resolve();
+            });
+            this.browser?.once('close', close);
+            this.browser?.process()?.once('close', close);
+            socket.once('close', close);
+            this.logger.info(`Proxying ${req.parsed.href} to ${this.constructor.name} ${this.browserWSEndpoint}`);
+            req.url = '';
+            // Delete headers known to cause issues
+            delete req.headers.origin;
+            this.proxy.ws(req, socket, head, {
+                changeOrigin: true,
+                target: this.browserWSEndpoint,
+            }, (error) => {
+                this.logger.error(`Error proxying session to ${this.constructor.name}: ${error}`);
+                this.close();
+                return reject(error);
+            });
         });
-    });
+    }
 }

package/build/browsers/chromium.playwright.d.ts

@@ -23,15 +23,15 @@ export declare class ChromiumPlaywright extends EventEmitter {
     });
     protected cleanListeners(): void;
     keepUntil(): number;
-    isRunning: () => boolean;
-    close: () => Promise<void>;
-    pages: () => Promise<[]>;
-    getPageId: () => string;
-    makeLiveURL: () => void;
-    newPage: () => Promise<Page>;
-    launch: (options?: BrowserServerOptions, version?: string) => Promise<playwright.BrowserServer>;
-    wsEndpoint: () => string | null;
-    publicWSEndpoint: (token: string | null) => string | null;
-    proxyPageWebSocket: () => Promise<void>;
-    proxyWebSocket: (req: Request, socket: Duplex, head: Buffer) => Promise<void>;
+    isRunning(): boolean;
+    close(): Promise<void>;
+    pages(): Promise<[]>;
+    getPageId(): string;
+    makeLiveURL(): void;
+    newPage(): Promise<Page>;
+    launch(options?: BrowserServerOptions, version?: string): Promise<playwright.BrowserServer>;
+    wsEndpoint(): string | null;
+    publicWSEndpoint(token: string | null): string | null;
+    proxyPageWebSocket(): Promise<void>;
+    proxyWebSocket(req: Request, socket: Duplex, head: Buffer): Promise<void>;
 }

package/build/browsers/chromium.playwright.js

@@ -25,8 +25,10 @@ export class ChromiumPlaywright extends EventEmitter {
     keepUntil() {
         return 0;
     }
-    isRunning = () => this.running;
-    close = async () => {
+    isRunning() {
+        return this.running;
+    }
+    async close() {
         if (this.browser) {
             this.logger.info(`Closing ${this.constructor.name} process and all listeners`);
             this.emit('close');
@@ -36,22 +38,24 @@ export class ChromiumPlaywright extends EventEmitter {
             this.browser = null;
             this.browserWSEndpoint = null;
         }
-    };
-    pages = async () => [];
-    getPageId = () => {
+    }
+    async pages() {
+        return [];
+    }
+    getPageId() {
         throw new ServerError(`#getPageId is not yet supported with ${this.constructor.name}.`);
-    };
-    makeLiveURL = () => {
+    }
+    makeLiveURL() {
         throw new ServerError(`Live URLs are not yet supported with ${this.constructor.name}. In the future this will be at "${this.config.getExternalAddress()}"`);
-    };
-    newPage = async () => {
+    }
+    async newPage() {
         if (!this.browser || !this.browserWSEndpoint) {
             throw new ServerError(`${this.constructor.name} hasn't been launched yet!`);
         }
         const browser = await playwright.chromium.connect(this.browserWSEndpoint);
         return await browser.newPage();
-    };
-    launch = async (options = {}, version) => {
+    }
+    async launch(options = {}, version) {
         this.logger.info(`Launching ${this.constructor.name} Handler`);
         const opts = {
             ...options,
@@ -69,9 +73,11 @@ export class ChromiumPlaywright extends EventEmitter {
         this.running = true;
         this.browserWSEndpoint = browserWSEndpoint;
         return this.browser;
-    };
-    wsEndpoint = () => this.browserWSEndpoint;
-    publicWSEndpoint = (token) => {
+    }
+    wsEndpoint() {
+        return this.browserWSEndpoint;
+    }
+    publicWSEndpoint(token) {
         if (!this.browserWSEndpoint) {
             return null;
         }
@@ -82,26 +88,28 @@ export class ChromiumPlaywright extends EventEmitter {
             externalURL.searchParams.set('token', token);
         }
         return externalURL.href;
-    };
-    proxyPageWebSocket = async () => {
+    }
+    async proxyPageWebSocket() {
         this.logger.warn(`${this.constructor.name} Not yet implemented`);
-    };
-    proxyWebSocket = async (req, socket, head) => new Promise((resolve, reject) => {
-        if (!this.browserWSEndpoint) {
-            throw new ServerError(`No browserWSEndpoint found, did you launch first?`);
-        }
-        socket.once('close', resolve);
-        this.logger.info(`Proxying ${req.parsed.href} to ${this.constructor.name} ${this.browserWSEndpoint}`);
-        // Delete headers known to cause issues
-        delete req.headers.origin;
-        req.url = '';
-        this.proxy.ws(req, socket, head, {
-            changeOrigin: true,
-            target: this.browserWSEndpoint,
-        }, (error) => {
-            this.logger.error(`Error proxying session to ${this.constructor.name}: ${error}`);
-            this.close();
-            return reject(error);
+    }
+    async proxyWebSocket(req, socket, head) {
+        return new Promise((resolve, reject) => {
+            if (!this.browserWSEndpoint) {
+                throw new ServerError(`No browserWSEndpoint found, did you launch first?`);
+            }
+            socket.once('close', resolve);
+            this.logger.info(`Proxying ${req.parsed.href} to ${this.constructor.name} ${this.browserWSEndpoint}`);
+            // Delete headers known to cause issues
+            delete req.headers.origin;
+            req.url = '';
+            this.proxy.ws(req, socket, head, {
+                changeOrigin: true,
+                target: this.browserWSEndpoint,
+            }, (error) => {
+                this.logger.error(`Error proxying session to ${this.constructor.name}: ${error}`);
+                this.close();
+                return reject(error);
+            });
         });
-    });
+    }
 }

package/build/browsers/firefox.playwright.d.ts

@@ -22,15 +22,15 @@ export declare class FirefoxPlaywright extends EventEmitter {
     });
     protected cleanListeners(): void;
     keepUntil(): number;
-    isRunning: () => boolean;
-    close: () => Promise<void>;
-    pages: () => Promise<[]>;
-    getPageId: () => string;
-    makeLiveURL: () => void;
-    newPage: () => Promise<Page>;
-    launch: (options?: BrowserServerOptions, version?: string) => Promise<playwright.BrowserServer>;
-    wsEndpoint: () => string | null;
-    publicWSEndpoint: (token: string | null) => string | null;
-    proxyPageWebSocket: () => Promise<void>;
-    proxyWebSocket: (req: Request, socket: Duplex, head: Buffer) => Promise<void>;
+    isRunning(): boolean;
+    close(): Promise<void>;
+    pages(): Promise<[]>;
+    getPageId(): string;
+    makeLiveURL(): void;
+    newPage(): Promise<Page>;
+    launch(options?: BrowserServerOptions, version?: string): Promise<playwright.BrowserServer>;
+    wsEndpoint(): string | null;
+    publicWSEndpoint(token: string | null): string | null;
+    proxyPageWebSocket(): Promise<void>;
+    proxyWebSocket(req: Request, socket: Duplex, head: Buffer): Promise<void>;
 }

package/build/browsers/firefox.playwright.js

@@ -24,8 +24,10 @@ export class FirefoxPlaywright extends EventEmitter {
     keepUntil() {
         return 0;
     }
-    isRunning = () => this.running;
-    close = async () => {
+    isRunning() {
+        return this.running;
+    }
+    async close() {
         if (this.browser) {
             this.logger.trace(`Closing ${this.constructor.name} process and all listeners`);
             this.emit('close');
@@ -35,18 +37,20 @@ export class FirefoxPlaywright extends EventEmitter {
             this.browser = null;
             this.browserWSEndpoint = null;
         }
-    };
-    pages = async () => [];
-    getPageId = () => {
+    }
+    async pages() {
+        return [];
+    }
+    getPageId() {
         throw new ServerError(`#getPageId is not yet supported with ${this.constructor.name}.`);
-    };
-    makeLiveURL = () => {
+    }
+    makeLiveURL() {
         throw new ServerError(`Live URLs are not yet supported with ${this.constructor.name}.`);
-    };
-    newPage = async () => {
+    }
+    async newPage() {
         throw new ServerError(`Can't create new page with ${this.constructor.name}`);
-    };
-    launch = async (options = {}, version) => {
+    }
+    async launch(options = {}, version) {
         this.logger.info(`Launching ${this.constructor.name} Handler`);
         const opts = {
             ...options,
@@ -63,9 +67,11 @@ export class FirefoxPlaywright extends EventEmitter {
         this.browserWSEndpoint = browserWSEndpoint;
         this.running = true;
         return this.browser;
-    };
-    wsEndpoint = () => this.browserWSEndpoint;
-    publicWSEndpoint = (token) => {
+    }
+    wsEndpoint() {
+        return this.browserWSEndpoint;
+    }
+    publicWSEndpoint(token) {
         if (!this.browserWSEndpoint) {
             return null;
         }
@@ -76,26 +82,28 @@ export class FirefoxPlaywright extends EventEmitter {
             externalURL.searchParams.set('token', token);
         }
         return externalURL.href;
-    };
-    proxyPageWebSocket = async () => {
+    }
+    async proxyPageWebSocket() {
         this.logger.warn(`Not yet implemented in ${this.constructor.name}`);
-    };
-    proxyWebSocket = async (req, socket, head) => new Promise((resolve, reject) => {
-        if (!this.browserWSEndpoint) {
-            throw new ServerError(`No browserWSEndpoint found, did you launch first?`);
-        }
-        socket.once('close', resolve);
-        this.logger.info(`Proxying ${req.parsed.href} to ${this.constructor.name} ${this.browserWSEndpoint}`);
-        // Delete headers known to cause issues
-        delete req.headers.origin;
-        req.url = '';
-        this.proxy.ws(req, socket, head, {
-            changeOrigin: true,
-            target: this.browserWSEndpoint,
-        }, (error) => {
-            this.logger.error(`Error proxying session to ${this.constructor.name}: ${error}`);
-            this.close();
-            return reject(error);
+    }
+    async proxyWebSocket(req, socket, head) {
+        return new Promise((resolve, reject) => {
+            if (!this.browserWSEndpoint) {
+                throw new ServerError(`No browserWSEndpoint found, did you launch first?`);
+            }
+            socket.once('close', resolve);
+            this.logger.info(`Proxying ${req.parsed.href} to ${this.constructor.name} ${this.browserWSEndpoint}`);
+            // Delete headers known to cause issues
+            delete req.headers.origin;
+            req.url = '';
+            this.proxy.ws(req, socket, head, {
+                changeOrigin: true,
+                target: this.browserWSEndpoint,
+            }, (error) => {
+                this.logger.error(`Error proxying session to ${this.constructor.name}: ${error}`);
+                this.close();
+                return reject(error);
+            });
         });
-    });
+    }
 }