@browserless.io/browserless 2.2.0 → 2.3.0-beta-2

package/src/routes/chrome/http/json-protocol.get.ts

@@ -1 +1,7 @@
-export { default, ResponseSchema } from '../../../shared/json-protocol.http.js';
+import { BrowserlessRoutes } from '@browserless.io/browserless';
+export { ResponseSchema } from '../../../shared/json-protocol.http.js';
+import { default as ChromiumJSONProtocolGetRoute } from '../../../shared/json-protocol.http.js';
+
+export default class ChromeJSONProtocolGetRoute extends ChromiumJSONProtocolGetRoute {
+  name = BrowserlessRoutes.ChromeJSONProtocolGetRoute;
+}

package/src/routes/chrome/http/json-version.get.ts

@@ -1 +1,7 @@
-export { default, ResponseSchema } from '../../../shared/json-version.http.js';
+import { BrowserlessRoutes } from '@browserless.io/browserless';
+export { ResponseSchema } from '../../../shared/json-version.http.js';
+import { default as ChromiumJSONVersionGetRoute } from '../../../shared/json-version.http.js';
+
+export default class ChromeJSONVersionGetRoute extends ChromiumJSONVersionGetRoute {
+  name = BrowserlessRoutes.ChromeJSONVersionGetRoute;
+}

package/src/routes/chrome/http/pdf.post.ts

@@ -4,9 +4,14 @@ import {
   QuerySchema,
   ResponseSchema,
 } from '../../../shared/pdf.http.js';
-import { ChromeCDP, HTTPRoutes } from '@browserless.io/browserless';
+import {
+  BrowserlessRoutes,
+  ChromeCDP,
+  HTTPRoutes,
+} from '@browserless.io/browserless';
 
-export default class ChromePDF extends PDF {
+export default class ChromePDFPostRoute extends PDF {
+  name = BrowserlessRoutes.ChromePDFPostRoute;
   browser = ChromeCDP;
   path = [HTTPRoutes.chromePdf];
 }

package/src/routes/chrome/http/performance.post.ts

@@ -4,9 +4,14 @@ import {
   QuerySchema,
   ResponseSchema,
 } from '../../../shared/performance.http.js';
-import { ChromeCDP, HTTPRoutes } from '@browserless.io/browserless';
+import {
+  BrowserlessRoutes,
+  ChromeCDP,
+  HTTPRoutes,
+} from '@browserless.io/browserless';
 
-export default class ChromePerformance extends Performance {
+export default class ChromePerformancePostRoute extends Performance {
+  name = BrowserlessRoutes.ChromePerformancePostRoute;
   browser = ChromeCDP;
   path = [HTTPRoutes.chromePerformance];
 }

package/src/routes/chrome/http/scrape.post.ts

@@ -4,9 +4,14 @@ import {
   ResponseSchema,
   default as Scrape,
 } from '../../../shared/scrape.http.js';
-import { ChromeCDP, HTTPRoutes } from '@browserless.io/browserless';
+import {
+  BrowserlessRoutes,
+  ChromeCDP,
+  HTTPRoutes,
+} from '@browserless.io/browserless';
 
-export default class ChromeScrape extends Scrape {
+export default class ChromeScrapePostRoute extends Scrape {
+  name = BrowserlessRoutes.ChromeScrapePostRoute;
   browser = ChromeCDP;
   path = [HTTPRoutes.chromeScrape];
 }

package/src/routes/chrome/http/screenshot.post.ts

@@ -4,9 +4,14 @@ import {
   ResponseSchema,
   default as Screenshot,
 } from '../../../shared/screenshot.http.js';
-import { ChromeCDP, HTTPRoutes } from '@browserless.io/browserless';
+import {
+  BrowserlessRoutes,
+  ChromeCDP,
+  HTTPRoutes,
+} from '@browserless.io/browserless';
 
-export default class ChromeScreenshot extends Screenshot {
+export default class ChromeScreenshotPostRoute extends Screenshot {
+  name = BrowserlessRoutes.ChromeScreenshotPostRoute;
   browser = ChromeCDP;
   path = [HTTPRoutes.chromeScreenshot];
 }

package/src/routes/chrome/ws/browser.ts

@@ -1,7 +1,8 @@
 import { default as Browser, QuerySchema } from '../../../shared/browser.ws.js';
-import { ChromeCDP } from '@browserless.io/browserless';
+import { BrowserlessRoutes, ChromeCDP } from '@browserless.io/browserless';
 
-export default class ChromeBrowser extends Browser {
+export default class ChromeBrowserWebSocketRoute extends Browser {
+  name = BrowserlessRoutes.ChromeBrowserWebSocketRoute;
   browser = ChromeCDP;
 }
 

package/src/routes/chrome/ws/cdp.ts

@@ -1,10 +1,15 @@
-import { ChromeCDP, WebsocketRoutes } from '@browserless.io/browserless';
+import {
+  BrowserlessRoutes,
+  ChromeCDP,
+  WebsocketRoutes,
+} from '@browserless.io/browserless';
 import {
   default as ChromiumWebSocketRoute,
   QuerySchema,
 } from '../../../shared/chromium.ws.js';
 
-export default class Chrome extends ChromiumWebSocketRoute {
+export default class ChromeCDPWebSocketRoute extends ChromiumWebSocketRoute {
+  name = BrowserlessRoutes.ChromeCDPWebSocketRoute;
   browser = ChromeCDP;
   path = [WebsocketRoutes.chrome];
 }

package/src/routes/chrome/ws/page.ts

@@ -1,7 +1,8 @@
+import { BrowserlessRoutes, ChromeCDP } from '@browserless.io/browserless';
 import { default as Page, QuerySchema } from '../../../shared/page.ws.js';
-import { ChromeCDP } from '@browserless.io/browserless';
 
-export default class ChromePage extends Page {
+export default class ChromePageWebSocketRoute extends Page {
+  name = BrowserlessRoutes.ChromePageWebSocketRoute;
   browser = ChromeCDP;
 }
 

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

@@ -1,10 +1,15 @@
-import { ChromePlaywright, WebsocketRoutes } from '@browserless.io/browserless';
+import {
+  BrowserlessRoutes,
+  ChromePlaywright,
+  WebsocketRoutes,
+} from '@browserless.io/browserless';
 import {
   default as ChromiumPlaywrightWebSocketRoute,
   QuerySchema,
 } from '../../../shared/chromium.playwright.ws.js';
 
 export default class ChromePlaywrightWebSocketRoute extends ChromiumPlaywrightWebSocketRoute {
+  name = BrowserlessRoutes.ChromePlaywrightWebSocketRoute;
   browser = ChromePlaywright;
   path = [WebsocketRoutes.chromePlaywright];
 }

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

@@ -3,6 +3,7 @@ import {
   BadRequest,
   BrowserServerOptions,
   BrowserWebsocketRoute,
+  BrowserlessRoutes,
   FirefoxPlaywright,
   Request,
   SystemQueryParameters,
@@ -11,10 +12,13 @@ import {
 import { Duplex } from 'stream';
 
 export interface QuerySchema extends SystemQueryParameters {
-  launch?: BrowserServerOptions | string;
+  launch?: BrowserServerOptions & {
+    firefoxUserPrefs?: { [key: string]: string | number | boolean };
+  };
 }
 
-export default class FirefoxPlayWrightRoute extends BrowserWebsocketRoute {
+export default class FirefoxPlaywrightWebSocketRoute extends BrowserWebsocketRoute {
+  name = BrowserlessRoutes.FirefoxPlaywrightWebSocketRoute;
   auth = true;
   browser = FirefoxPlaywright;
   concurrency = true;

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

@@ -1,5 +1,6 @@
 import {
   APITags,
+  BrowserlessRoutes,
   HTTPManagementRoutes,
   HTTPRoute,
   Methods,
@@ -33,6 +34,7 @@ export interface ResponseSchema {
 }
 
 export default class ConfigGetRoute extends HTTPRoute {
+  name = BrowserlessRoutes.ConfigGetRoute;
   accepts = [contentTypes.any];
   auth = true;
   browser = null;

package/src/routes/management/http/metrics-total.get.ts

@@ -1,5 +1,6 @@
 import {
   APITags,
+  BrowserlessRoutes,
   HTTPManagementRoutes,
   HTTPRoute,
   IBrowserlessMetricTotals,
@@ -15,6 +16,7 @@ export type ResponseSchema = IBrowserlessMetricTotals;
 const fiveMinuteIntervalsInAMonth = 8640;
 
 export default class MetricsTotalGetRoute extends HTTPRoute {
+  name = BrowserlessRoutes.MetricsTotalGetRoute;
   accepts = [contentTypes.any];
   auth = true;
   browser = null;

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

@@ -1,5 +1,6 @@
 import {
   APITags,
+  BrowserlessRoutes,
   HTTPManagementRoutes,
   HTTPRoute,
   IBrowserlessStats,
@@ -13,6 +14,7 @@ import { ServerResponse } from 'http';
 export type ResponseSchema = Array<IBrowserlessStats>;
 
 export default class MetricsGetRoute extends HTTPRoute {
+  name = BrowserlessRoutes.MetricsGetRoute;
   accepts = [contentTypes.any];
   auth = true;
   browser = null;

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

@@ -1,5 +1,6 @@
 import {
   APITags,
+  BrowserlessRoutes,
   BrowserlessSessionJSON,
   HTTPManagementRoutes,
   HTTPRoute,
@@ -13,6 +14,7 @@ import { ServerResponse } from 'http';
 export type ResponseSchema = BrowserlessSessionJSON[];
 
 export default class SessionsGetRoute extends HTTPRoute {
+  name = BrowserlessRoutes.SessionsGetRoute;
   accepts = [contentTypes.any];
   auth = true;
   browser = null;

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

@@ -1,12 +1,12 @@
 import {
   APITags,
+  BrowserlessRoutes,
   HTTPManagementRoutes,
   HTTPRoute,
   Methods,
   NotFound,
   Request,
   contentTypes,
-  createLogger,
   fileExists,
   mimeTypes,
 } from '@browserless.io/browserless';
@@ -14,9 +14,6 @@ import { ServerResponse } from 'http';
 import { createReadStream } from 'fs';
 import path from 'path';
 
-const debug = createLogger('http:static');
-const verbose = createLogger('http:static:verbose');
-
 const pathMap: Map<
   string,
   {
@@ -25,10 +22,15 @@ const pathMap: Map<
   }
 > = new Map();
 
-const streamFile = (res: ServerResponse, file: string, contentType?: string) =>
+const streamFile = (
+  debug: debug.Debugger,
+  res: ServerResponse,
+  file: string,
+  contentType?: string,
+) =>
   new Promise((resolve, reject) => {
     if (contentType) {
-      verbose(`Setting content-type ${contentType}`);
+      debug(`Setting content-type ${contentType}`);
       res.setHeader('Content-Type', contentType);
     }
 
@@ -47,6 +49,7 @@ const streamFile = (res: ServerResponse, file: string, contentType?: string) =>
   });
 
 export default class StaticGetRoute extends HTTPRoute {
+  name = BrowserlessRoutes.StaticGetRoute;
   accepts = [contentTypes.any];
   auth = false;
   browser = null;
@@ -59,9 +62,11 @@ export default class StaticGetRoute extends HTTPRoute {
   handler = async (req: Request, res: ServerResponse): Promise<unknown> => {
     const { pathname } = req.parsed;
     const fileCache = pathMap.get(pathname);
+    const debug = this.debug();
+    const verbose = debug.extend('verbose');
 
     if (fileCache) {
-      return streamFile(res, fileCache.path, fileCache.contentType);
+      return streamFile(verbose, res, fileCache.path, fileCache.contentType);
     }
 
     const config = this.config();
@@ -78,7 +83,9 @@ export default class StaticGetRoute extends HTTPRoute {
     ).find((_) => !!_);
 
     if (!filePath) {
-      throw new NotFound(`No route or file found for resource ${req.method}: ${pathname}`);
+      throw new NotFound(
+        `No route or file found for resource ${req.method}: ${pathname}`,
+      );
     }
 
     verbose(`Found new file "${filePath}", caching path and serving`);
@@ -96,6 +103,6 @@ export default class StaticGetRoute extends HTTPRoute {
       path: filePath,
     });
 
-    return streamFile(res, filePath, contentType);
+    return streamFile(verbose, res, filePath, contentType);
   };
 }

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

@@ -3,6 +3,7 @@ import {
   BadRequest,
   BrowserServerOptions,
   BrowserWebsocketRoute,
+  BrowserlessRoutes,
   Request,
   SystemQueryParameters,
   WebkitPlaywright,
@@ -14,7 +15,8 @@ export interface QuerySchema extends SystemQueryParameters {
   launch?: BrowserServerOptions | string;
 }
 
-export default class WebkitPlaywrightRoute extends BrowserWebsocketRoute {
+export default class WebKitPlaywrightWebSocketRoute extends BrowserWebsocketRoute {
+  name = BrowserlessRoutes.WebKitPlaywrightWebSocketRoute;
   auth = true;
   browser = WebkitPlaywright;
   concurrency = true;

package/src/shared/browser.ws.ts

@@ -1,6 +1,7 @@
 import {
   APITags,
   BrowserWebsocketRoute,
+  BrowserlessRoutes,
   CDPLaunchOptions,
   ChromiumCDP,
   Request,
@@ -14,7 +15,8 @@ export interface QuerySchema extends SystemQueryParameters {
   launch?: CDPLaunchOptions | string;
 }
 
-export default class CDPExistingBrowser extends BrowserWebsocketRoute {
+export default class ChromiumBrowserWebSocketRoute extends BrowserWebsocketRoute {
+  name = BrowserlessRoutes.ChromiumBrowserWebSocketRoute;
   auth = true;
   browser = ChromiumCDP;
   concurrency = true;

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

@@ -3,6 +3,7 @@ import {
   BadRequest,
   BrowserServerOptions,
   BrowserWebsocketRoute,
+  BrowserlessRoutes,
   ChromiumPlaywright,
   Request,
   SystemQueryParameters,
@@ -14,7 +15,8 @@ export interface QuerySchema extends SystemQueryParameters {
   launch?: BrowserServerOptions | string;
 }
 
-export default class PlaywrightChromiumRoute extends BrowserWebsocketRoute {
+export default class ChromiumPlaywrightWebSocketRoute extends BrowserWebsocketRoute {
+  name = BrowserlessRoutes.ChromiumPlaywrightWebSocketRoute;
   auth = true;
   browser = ChromiumPlaywright;
   concurrency = true;

package/src/shared/chromium.ws.ts

@@ -1,6 +1,7 @@
 import {
   APITags,
   BrowserWebsocketRoute,
+  BrowserlessRoutes,
   CDPLaunchOptions,
   ChromiumCDP,
   Request,
@@ -13,7 +14,8 @@ export interface QuerySchema extends SystemQueryParameters {
   launch?: CDPLaunchOptions | string;
 }
 
-export default class ChromiumCDPRoute extends BrowserWebsocketRoute {
+export default class ChromiumCDPWebSocketRoute extends BrowserWebsocketRoute {
+  name = BrowserlessRoutes.ChromiumCDPWebSocketRoute;
   auth = true;
   browser = ChromiumCDP;
   concurrency = true;

package/src/shared/content.http.ts

@@ -3,6 +3,7 @@ import {
   BadRequest,
   BrowserHTTPRoute,
   BrowserInstance,
+  BrowserlessRoutes,
   CDPLaunchOptions,
   ChromiumCDP,
   HTTPRoutes,
@@ -62,7 +63,8 @@ export type QuerySchema = SystemQueryParameters & {
   launch?: CDPLaunchOptions | string;
 };
 
-export default class ContentPostRoute extends BrowserHTTPRoute {
+export default class ChromiumContentPostRoute extends BrowserHTTPRoute {
+  name = BrowserlessRoutes.ChromiumContentPostRoute;
   accepts = [contentTypes.json];
   auth = true;
   browser = ChromiumCDP;

package/src/shared/download.http.ts

@@ -2,6 +2,7 @@ import {
   APITags,
   BrowserHTTPRoute,
   BrowserInstance,
+  BrowserlessRoutes,
   CDPLaunchOptions,
   ChromiumCDP,
   HTTPRoutes,
@@ -40,7 +41,8 @@ export interface QuerySchema extends SystemQueryParameters {
  */
 export type ResponseSchema = unknown;
 
-export default class DownloadPost extends BrowserHTTPRoute {
+export default class ChromiumDownloadPostRoute extends BrowserHTTPRoute {
+  name = BrowserlessRoutes.ChromiumDownloadPostRoute;
   accepts = [contentTypes.json, contentTypes.javascript];
   auth = true;
   browser = ChromiumCDP;

package/src/shared/function.http.ts

@@ -3,6 +3,7 @@ import {
   BadRequest,
   BrowserHTTPRoute,
   BrowserInstance,
+  BrowserlessRoutes,
   CDPLaunchOptions,
   ChromiumCDP,
   HTTPRoutes,
@@ -37,7 +38,8 @@ export interface QuerySchema extends SystemQueryParameters {
  */
 export type ResponseSchema = unknown;
 
-export default class FunctionPost extends BrowserHTTPRoute {
+export default class ChromiumFunctionPostRoute extends BrowserHTTPRoute {
+  name = BrowserlessRoutes.ChromiumFunctionPostRoute;
   accepts = [contentTypes.json, contentTypes.javascript];
   auth = true;
   browser = ChromiumCDP;

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

@@ -1,5 +1,6 @@
 import {
   APITags,
+  BrowserlessRoutes,
   CDPJSONPayload,
   HTTPRoute,
   HTTPRoutes,
@@ -13,7 +14,8 @@ import {
 
 export type ResponseSchema = Array<CDPJSONPayload>;
 
-export default class GetJSONList extends HTTPRoute {
+export default class ChromiumJSONListGetRoute extends HTTPRoute {
+  name = BrowserlessRoutes.ChromiumJSONListGetRoute;
   accepts = [contentTypes.any];
   auth = true;
   browser = null;

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

@@ -1,5 +1,6 @@
 import {
   APITags,
+  BrowserlessRoutes,
   CDPJSONPayload,
   HTTPRoute,
   HTTPRoutes,
@@ -27,7 +28,8 @@ Example Payload from Chromium:
 */
 export type ResponseSchema = CDPJSONPayload;
 
-export default class GetJSONList extends HTTPRoute {
+export default class ChromiumJSONNewPutRoute extends HTTPRoute {
+  name = BrowserlessRoutes.ChromiumJSONNewPutRoute;
   accepts = [contentTypes.any];
   auth = true;
   browser = null;

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

@@ -1,5 +1,6 @@
 import {
   APITags,
+  BrowserlessRoutes,
   HTTPRoute,
   HTTPRoutes,
   Methods,
@@ -11,9 +12,10 @@ import {
 
 export type ResponseSchema = object;
 
-export default class GetJSONVersion extends HTTPRoute {
+export default class ChromiumJSONProtocolGetRoute extends HTTPRoute {
   private cachedProtocol: object | undefined;
 
+  name = BrowserlessRoutes.ChromiumJSONProtocolGetRoute;
   accepts = [contentTypes.any];
   auth = true;
   browser = null;

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

@@ -1,6 +1,7 @@
 import {
   APITags,
   BrowserManager,
+  BrowserlessRoutes,
   HTTPRoute,
   HTTPRoutes,
   Methods,
@@ -16,9 +17,10 @@ export type ResponseSchema = UnwrapPromise<
   ReturnType<BrowserManager['getVersionJSON']>
 >;
 
-export default class GetJSONVersion extends HTTPRoute {
+export default class ChromiumJSONVersionGetRoute extends HTTPRoute {
   private cachedJSON: ResponseSchema | undefined;
 
+  name = BrowserlessRoutes.ChromiumJSONVersionGetRoute;
   accepts = [contentTypes.any];
   auth = true;
   browser = null;

package/src/shared/page.ws.ts

@@ -1,6 +1,7 @@
 import {
   APITags,
   BrowserWebsocketRoute,
+  BrowserlessRoutes,
   CDPLaunchOptions,
   ChromiumCDP,
   Request,
@@ -14,7 +15,8 @@ export interface QuerySchema extends SystemQueryParameters {
   launch?: CDPLaunchOptions | string;
 }
 
-export default class PageWebSocketRoute extends BrowserWebsocketRoute {
+export default class ChromiumPageWebSocketRoute extends BrowserWebsocketRoute {
+  name = BrowserlessRoutes.ChromiumPageWebSocketRoute;
   auth = true;
   browser = ChromiumCDP;
   concurrency = false;

package/src/shared/pdf.http.ts

@@ -3,6 +3,7 @@ import {
   BadRequest,
   BrowserHTTPRoute,
   BrowserInstance,
+  BrowserlessRoutes,
   CDPLaunchOptions,
   ChromiumCDP,
   HTTPRoutes,
@@ -64,7 +65,8 @@ export interface QuerySchema extends SystemQueryParameters {
  */
 export type ResponseSchema = string;
 
-export default class PDFPost extends BrowserHTTPRoute {
+export default class ChromiumPDFPostRoute extends BrowserHTTPRoute {
+  name = BrowserlessRoutes.ChromiumPDFPostRoute;
   accepts = [contentTypes.json];
   auth = true;
   browser = ChromiumCDP;

package/src/shared/performance.http.ts

@@ -2,6 +2,7 @@ import {
   APITags,
   BrowserHTTPRoute,
   BrowserInstance,
+  BrowserlessRoutes,
   CDPLaunchOptions,
   ChromiumCDP,
   HTTPRoutes,
@@ -33,6 +34,7 @@ export interface QuerySchema extends SystemQueryParameters {
 export type ResponseSchema = object;
 
 export default class PerformancePost extends BrowserHTTPRoute {
+  name = BrowserlessRoutes.ChromiumPerformancePostRoute;
   accepts = [contentTypes.json];
   auth = true;
   browser = ChromiumCDP;

package/src/shared/scrape.http.ts

@@ -3,6 +3,7 @@ import {
   BadRequest,
   BrowserHTTPRoute,
   BrowserInstance,
+  BrowserlessRoutes,
   CDPLaunchOptions,
   ChromiumCDP,
   HTTPRoutes,
@@ -199,7 +200,8 @@ const scrape = async (elements: ScrapeElementSelector[]) => {
   });
 };
 
-export default class ScrapePost extends BrowserHTTPRoute {
+export default class ChromiumScrapePostRoute extends BrowserHTTPRoute {
+  name = BrowserlessRoutes.ChromiumScrapePostRoute;
   accepts = [contentTypes.json];
   auth = true;
   browser = ChromiumCDP;

package/src/shared/screenshot.http.ts

@@ -3,6 +3,7 @@ import {
   BadRequest,
   BrowserHTTPRoute,
   BrowserInstance,
+  BrowserlessRoutes,
   CDPLaunchOptions,
   ChromiumCDP,
   HTTPRoutes,
@@ -67,6 +68,7 @@ export interface BodySchema {
 }
 
 export default class ScreenshotPost extends BrowserHTTPRoute {
+  name = BrowserlessRoutes.ChromiumScreenshotPostRoute;
   accepts = [contentTypes.json];
   auth = true;
   browser = ChromiumCDP;

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

@@ -7,14 +7,13 @@ const DEFAULT_AUDIT_CONFIG = {
   extends: 'lighthouse:default',
 };
 
-const debug = createLogger('http:performance:main');
-
 export default async ({
   browser,
   context,
   timeout,
 }: mainOptions): Promise<unknown> => {
   return new Promise((resolve, reject) => {
+    const debug = createLogger('http:performance:main');
     const childPath = path.join(
       './',
       'build',