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

package/bin/browserless.js

@@ -60,22 +60,22 @@ const prompt = async (question) => {
   });
 };
 
-const importClassOverride = async (files, className) => {
+const importDefault = async (files, fileName) => {
   const classModuleFile = files.find((f) =>
-    path.parse(f).name.endsWith(className),
+    path.parse(f).name.endsWith(fileName),
   );
 
   if (!classModuleFile) {
     return;
   }
 
-  const classModuleFullFilePath = path.join(compiledDir, classModuleFile);
+  const fullFilePath = path.join(compiledDir, classModuleFile);
 
   if (!classModuleFile) {
     return;
   }
-  log(`Importing module override "${classModuleFullFilePath}"`);
-  return (await import(classModuleFullFilePath)).default;
+  log(`Importing module "${fullFilePath}"`);
+  return (await import(fullFilePath)).default;
 };
 
 const clean = async () =>
@@ -239,16 +239,18 @@ const start = async (dev = false) => {
     Router,
     Token,
     Webhooks,
+    DisabledRoutes,
   ] = await Promise.all([
-    importClassOverride(files, 'browser-manager'),
-    importClassOverride(files, 'config'),
-    importClassOverride(files, 'file-system'),
-    importClassOverride(files, 'limiter'),
-    importClassOverride(files, 'metrics'),
-    importClassOverride(files, 'monitoring'),
-    importClassOverride(files, 'router'),
-    importClassOverride(files, 'token'),
-    importClassOverride(files, 'webhooks'),
+    importDefault(files, 'browser-manager'),
+    importDefault(files, 'config'),
+    importDefault(files, 'file-system'),
+    importDefault(files, 'limiter'),
+    importDefault(files, 'metrics'),
+    importDefault(files, 'monitoring'),
+    importDefault(files, 'router'),
+    importDefault(files, 'token'),
+    importDefault(files, 'webhooks'),
+    importDefault(files, 'disabled-routes'),
   ]);
 
   log(`Starting Browserless`);
@@ -285,6 +287,15 @@ const start = async (dev = false) => {
     webhooks,
   });
 
+  if (DisabledRoutes !== undefined) {
+    if (!Array.isArray(DisabledRoutes)) {
+      throw new Error(
+        `The "disabled-routes.ts" default export should be an array of Route classes.`,
+      );
+    }
+    DisabledRoutes.forEach((R) => browserless.disableRoute(R));
+  }
+
   httpRoutes.forEach((r) => browserless.addHTTPRoute(r));
   webSocketRoutes.forEach((r) => browserless.addWebSocketRoute(r));
 

package/build/browserless.d.ts

@@ -1,6 +1,7 @@
 /// <reference types="debug" />
 /// <reference types="node" />
-import { BrowserManager, Config, FileSystem, HTTPServer, Limiter, Metrics, Monitoring, Router, Token, WebHooks } from '@browserless.io/browserless';
+import { BrowserHTTPRoute, BrowserManager, BrowserWebsocketRoute, Config, FileSystem, HTTPRoute, HTTPServer, Limiter, Metrics, Monitoring, Router, Token, WebHooks, WebSocketRoute } from '@browserless.io/browserless';
+type RouteTypes = typeof HTTPRoute | typeof BrowserHTTPRoute | typeof WebSocketRoute | typeof BrowserWebsocketRoute;
 export declare class Browserless {
     protected debug: debug.Debugger;
     protected browserManager: BrowserManager;
@@ -12,6 +13,7 @@ export declare class Browserless {
     protected router: Router;
     protected token: Token;
     protected webhooks: WebHooks;
+    DisabledRoutes: RouteTypes[];
     webSocketRouteFiles: string[];
     httpRouteFiles: string[];
     server?: HTTPServer;
@@ -30,9 +32,12 @@ export declare class Browserless {
     });
     protected saveMetrics: () => Promise<void>;
     setMetricsSaveInterval: (interval: number) => void;
+    private routeIsDisabled;
+    disableRoute(Route: RouteTypes): void;
     addHTTPRoute(httpRouteFilePath: string): void;
     addWebSocketRoute(webSocketRouteFilePath: string): void;
     setPort(port: number): void;
     stop(): Promise<[void | undefined]>;
     start(): Promise<void>;
 }
+export {};

package/build/browserless.js

@@ -14,6 +14,7 @@ export class Browserless {
     router;
     token;
     webhooks;
+    DisabledRoutes = [];
     webSocketRouteFiles = [];
     httpRouteFiles = [];
     server;
@@ -69,6 +70,13 @@ export class Browserless {
         this.metricsSaveInterval = interval;
         this.metricsSaveIntervalID = setInterval(this.saveMetrics, this.metricsSaveInterval);
     };
+    routeIsDisabled(Route) {
+        const Stringified = Route.toString();
+        return this.DisabledRoutes.some((r) => r.toString() === Stringified);
+    }
+    disableRoute(Route) {
+        this.DisabledRoutes.push(Route);
+    }
     addHTTPRoute(httpRouteFilePath) {
         this.httpRouteFiles.push(httpRouteFilePath);
     }
@@ -95,12 +103,15 @@ export class Browserless {
             ChromiumPlaywright,
             WebkitPlaywright,
         ];
-        const [[httpRouteFiles, wsRouteFiles], installedBrowsers] = await Promise.all([getRouteFiles(this.config), availableBrowsers]);
+        const [[internalHttpRouteFiles, internalWsRouteFiles], installedBrowsers] = await Promise.all([getRouteFiles(this.config), availableBrowsers]);
         const docsLink = makeExternalURL(this.config.getExternalAddress(), '/docs');
         this.debug(printLogo(docsLink));
         this.debug(`Running as user "${userInfo().username}"`);
         this.debug('Starting import of HTTP Routes');
-        for (const httpRoute of [...httpRouteFiles, ...this.httpRouteFiles]) {
+        for (const httpRoute of [
+            ...internalHttpRouteFiles,
+            ...this.httpRouteFiles,
+        ]) {
             if (httpRoute.endsWith('js')) {
                 const { name } = path.parse(httpRoute);
                 const [bodySchema, querySchema] = await Promise.all(routeSchemas.map(async (schemaType) => {
@@ -111,19 +122,24 @@ export class Browserless {
                 const routeImport = `${this.config.getIsWin() ? 'file:///' : ''}${httpRoute}`;
                 const logger = createLogger(`http:${name}`);
                 const { default: Route, } = await import(routeImport + `?cb=${Date.now()}`);
-                const route = new Route(this.browserManager, this.config, this.fileSystem, logger, this.metrics, this.monitoring);
-                route.bodySchema = safeParse(bodySchema);
-                route.querySchema = safeParse(querySchema);
-                route.config = () => this.config;
-                route.metrics = () => this.metrics;
-                route.monitoring = () => this.monitoring;
-                route.fileSystem = () => this.fileSystem;
-                route.debug = () => logger;
-                httpRoutes.push(route);
+                if (!this.routeIsDisabled(Route)) {
+                    const route = new Route(this.browserManager, this.config, this.fileSystem, logger, this.metrics, this.monitoring);
+                    route.bodySchema = safeParse(bodySchema);
+                    route.querySchema = safeParse(querySchema);
+                    route.config = () => this.config;
+                    route.metrics = () => this.metrics;
+                    route.monitoring = () => this.monitoring;
+                    route.fileSystem = () => this.fileSystem;
+                    route.debug = () => logger;
+                    httpRoutes.push(route);
+                }
             }
         }
         this.debug('Starting import of WebSocket Routes');
-        for (const wsRoute of [...wsRouteFiles, ...this.webSocketRouteFiles]) {
+        for (const wsRoute of [
+            ...internalWsRouteFiles,
+            ...this.webSocketRouteFiles,
+        ]) {
             if (wsRoute.endsWith('js')) {
                 const { name } = path.parse(wsRoute);
                 const [, querySchema] = await Promise.all(routeSchemas.map(async (schemaType) => {
@@ -134,14 +150,16 @@ export class Browserless {
                 const wsImport = `${this.config.getIsWin() ? 'file:///' : ''}${wsRoute}`;
                 const logger = createLogger(`ws:${name}`);
                 const { default: Route, } = await import(wsImport + `?cb=${Date.now()}`);
-                const route = new Route(this.browserManager, this.config, this.fileSystem, logger, this.metrics, this.monitoring);
-                route.querySchema = safeParse(querySchema);
-                route.config = () => this.config;
-                route.metrics = () => this.metrics;
-                route.monitoring = () => this.monitoring;
-                route.fileSystem = () => this.fileSystem;
-                route.debug = () => logger;
-                wsRoutes.push(route);
+                if (!this.routeIsDisabled(Route)) {
+                    const route = new Route(this.browserManager, this.config, this.fileSystem, logger, this.metrics, this.monitoring);
+                    route.querySchema = safeParse(querySchema);
+                    route.config = () => this.config;
+                    route.metrics = () => this.metrics;
+                    route.monitoring = () => this.monitoring;
+                    route.fileSystem = () => this.fileSystem;
+                    route.debug = () => logger;
+                    wsRoutes.push(route);
+                }
             }
         }
         // Validate that we have the browsers they are asking for

package/build/exports.core.d.ts

@@ -0,0 +1,24 @@
+export * from './browserless.js';
+export * from './config.js';
+export * from './constants.js';
+export * from './file-system.js';
+export * from './hooks.js';
+export * from './http.js';
+export * from './limiter.js';
+export * from './metrics.js';
+export * from './mime-types.js';
+export * from './monitoring.js';
+export * from './router.js';
+export * from './server.js';
+export * from './shim.js';
+export * from './token.js';
+export * from './types.js';
+export * from './utils.js';
+export * from './webhooks.js';
+export * from './browsers/index.js';
+export * from './browsers/chrome.cdp.js';
+export * from './browsers/chrome.playwright.js';
+export * from './browsers/chromium.cdp.js';
+export * from './browsers/chromium.playwright.js';
+export * from './browsers/firefox.playwright.js';
+export * from './browsers/webkit.playwright.js';

package/build/exports.core.js

@@ -0,0 +1,26 @@
+// This file takes the place of 'exports.ts' when doing our docker builds
+// since docker images are missing some/most of the browser routes depending.
+export * from './browserless.js';
+export * from './config.js';
+export * from './constants.js';
+export * from './file-system.js';
+export * from './hooks.js';
+export * from './http.js';
+export * from './limiter.js';
+export * from './metrics.js';
+export * from './mime-types.js';
+export * from './monitoring.js';
+export * from './router.js';
+export * from './server.js';
+export * from './shim.js';
+export * from './token.js';
+export * from './types.js';
+export * from './utils.js';
+export * from './webhooks.js';
+export * from './browsers/index.js';
+export * from './browsers/chrome.cdp.js';
+export * from './browsers/chrome.playwright.js';
+export * from './browsers/chromium.cdp.js';
+export * from './browsers/chromium.playwright.js';
+export * from './browsers/firefox.playwright.js';
+export * from './browsers/webkit.playwright.js';

package/build/exports.d.ts

@@ -1,24 +1,38 @@
-export * from './browserless.js';
-export * from './config.js';
-export * from './constants.js';
-export * from './file-system.js';
-export * from './hooks.js';
-export * from './http.js';
-export * from './limiter.js';
-export * from './metrics.js';
-export * from './mime-types.js';
-export * from './monitoring.js';
-export * from './router.js';
-export * from './server.js';
-export * from './shim.js';
-export * from './token.js';
-export * from './types.js';
-export * from './utils.js';
-export * from './webhooks.js';
-export * from './browsers/index.js';
-export * from './browsers/chrome.cdp.js';
-export * from './browsers/chrome.playwright.js';
-export * from './browsers/chromium.cdp.js';
-export * from './browsers/chromium.playwright.js';
-export * from './browsers/firefox.playwright.js';
-export * from './browsers/webkit.playwright.js';
+export * from './exports.core.js';
+export { default as ChromeContentPostRoute } from './routes/chrome/http/content.post.js';
+export { default as ChromeDownloadPostRoute } from './routes/chrome/http/download.post.js';
+export { default as ChromeFunctionPostRoute } from './routes/chrome/http/function.post.js';
+export { default as ChromeJSONListGetRoute } from './routes/chrome/http/json-list.get.js';
+export { default as ChromeJSONNewPutRoute } from './routes/chrome/http/json-new.put.js';
+export { default as ChromeJSONProtocolGetRoute } from './routes/chrome/http/json-protocol.get.js';
+export { default as ChromeJSONVersionGetRoute } from './routes/chrome/http/json-version.get.js';
+export { default as ChromePDFPostRoute } from './routes/chrome/http/pdf.post.js';
+export { default as ChromePerformancePostRoute } from './routes/chrome/http/performance.post.js';
+export { default as ChromeScrapePostRoute } from './routes/chrome/http/scrape.post.js';
+export { default as ChromeScreenshotPostRoute } from './routes/chrome/http/screenshot.post.js';
+export { default as ChromeBrowserWebSocketRoute } from './routes/chrome/ws/browser.js';
+export { default as ChromeCDPWebSocketRoute } from './routes/chrome/ws/cdp.js';
+export { default as ChromePageWebSocketRoute } from './routes/chrome/ws/page.js';
+export { default as ChromePlaywrightWebSocketRoute } from './routes/chrome/ws/playwright.js';
+export { default as ChromiumContentPostRoute } from './routes/chromium/http/content.post.js';
+export { default as ChromiumDownloadPostRoute } from './routes/chromium/http/download.post.js';
+export { default as ChromiumFunctionPostRoute } from './routes/chromium/http/function.post.js';
+export { default as ChromiumJSONListGetRoute } from './routes/chromium/http/json-list.get.js';
+export { default as ChromiumJSONNewPutRoute } from './routes/chromium/http/json-new.put.js';
+export { default as ChromiumJSONProtocolGetRoute } from './routes/chromium/http/json-protocol.get.js';
+export { default as ChromiumJSONVersionGetRoute } from './routes/chromium/http/json-version.get.js';
+export { default as ChromiumPDFPostRoute } from './routes/chromium/http/pdf.post.js';
+export { default as ChromiumPerformancePostRoute } from './routes/chromium/http/performance.post.js';
+export { default as ChromiumScrapePostRoute } from './routes/chromium/http/scrape.post.js';
+export { default as ChromiumScreenshotPostRoute } from './routes/chromium/http/screenshot.post.js';
+export { default as ChromiumBrowserWebSocketRoute } from './routes/chromium/ws/browser.js';
+export { default as ChromiumCDPWebSocketRoute } from './routes/chromium/ws/cdp.js';
+export { default as ChromiumPageWebSocketRoute } from './routes/chromium/ws/page.js';
+export { default as ChromiumPlaywrightWebSocketRoute } from './routes/chromium/ws/playwright.js';
+export { default as FirefoxPlaywrightWebSocketRoute } from './routes/firefox/ws/playwright.js';
+export { default as WebKitPlaywrightWebSocketRoute } from './routes/webkit/ws/playwright.js';
+export { default as ConfigGetRoute } from './routes/management/http/config.get.js';
+export { default as MetricsTotalGetRoute } from './routes/management/http/metrics-total.get.js';
+export { default as MetricsGetRoute } from './routes/management/http/metrics.get.js';
+export { default as SessionsGetGetRoute } from './routes/management/http/sessions.get.js';
+export { default as StaticGetRoute } from './routes/management/http/static.get.js';

package/build/exports.js

@@ -1,26 +1,44 @@
-// Main Files
-export * from './browserless.js';
-export * from './config.js';
-export * from './constants.js';
-export * from './file-system.js';
-export * from './hooks.js';
-export * from './http.js';
-export * from './limiter.js';
-export * from './metrics.js';
-export * from './mime-types.js';
-export * from './monitoring.js';
-export * from './router.js';
-export * from './server.js';
-export * from './shim.js';
-export * from './token.js';
-export * from './types.js';
-export * from './utils.js';
-export * from './webhooks.js';
-// Browsers and Helpers
-export * from './browsers/index.js';
-export * from './browsers/chrome.cdp.js';
-export * from './browsers/chrome.playwright.js';
-export * from './browsers/chromium.cdp.js';
-export * from './browsers/chromium.playwright.js';
-export * from './browsers/firefox.playwright.js';
-export * from './browsers/webkit.playwright.js';
+// Core
+export * from './exports.core.js';
+// Chrome
+export { default as ChromeContentPostRoute } from './routes/chrome/http/content.post.js';
+export { default as ChromeDownloadPostRoute } from './routes/chrome/http/download.post.js';
+export { default as ChromeFunctionPostRoute } from './routes/chrome/http/function.post.js';
+export { default as ChromeJSONListGetRoute } from './routes/chrome/http/json-list.get.js';
+export { default as ChromeJSONNewPutRoute } from './routes/chrome/http/json-new.put.js';
+export { default as ChromeJSONProtocolGetRoute } from './routes/chrome/http/json-protocol.get.js';
+export { default as ChromeJSONVersionGetRoute } from './routes/chrome/http/json-version.get.js';
+export { default as ChromePDFPostRoute } from './routes/chrome/http/pdf.post.js';
+export { default as ChromePerformancePostRoute } from './routes/chrome/http/performance.post.js';
+export { default as ChromeScrapePostRoute } from './routes/chrome/http/scrape.post.js';
+export { default as ChromeScreenshotPostRoute } from './routes/chrome/http/screenshot.post.js';
+export { default as ChromeBrowserWebSocketRoute } from './routes/chrome/ws/browser.js';
+export { default as ChromeCDPWebSocketRoute } from './routes/chrome/ws/cdp.js';
+export { default as ChromePageWebSocketRoute } from './routes/chrome/ws/page.js';
+export { default as ChromePlaywrightWebSocketRoute } from './routes/chrome/ws/playwright.js';
+// Chromium
+export { default as ChromiumContentPostRoute } from './routes/chromium/http/content.post.js';
+export { default as ChromiumDownloadPostRoute } from './routes/chromium/http/download.post.js';
+export { default as ChromiumFunctionPostRoute } from './routes/chromium/http/function.post.js';
+export { default as ChromiumJSONListGetRoute } from './routes/chromium/http/json-list.get.js';
+export { default as ChromiumJSONNewPutRoute } from './routes/chromium/http/json-new.put.js';
+export { default as ChromiumJSONProtocolGetRoute } from './routes/chromium/http/json-protocol.get.js';
+export { default as ChromiumJSONVersionGetRoute } from './routes/chromium/http/json-version.get.js';
+export { default as ChromiumPDFPostRoute } from './routes/chromium/http/pdf.post.js';
+export { default as ChromiumPerformancePostRoute } from './routes/chromium/http/performance.post.js';
+export { default as ChromiumScrapePostRoute } from './routes/chromium/http/scrape.post.js';
+export { default as ChromiumScreenshotPostRoute } from './routes/chromium/http/screenshot.post.js';
+export { default as ChromiumBrowserWebSocketRoute } from './routes/chromium/ws/browser.js';
+export { default as ChromiumCDPWebSocketRoute } from './routes/chromium/ws/cdp.js';
+export { default as ChromiumPageWebSocketRoute } from './routes/chromium/ws/page.js';
+export { default as ChromiumPlaywrightWebSocketRoute } from './routes/chromium/ws/playwright.js';
+// Firefox
+export { default as FirefoxPlaywrightWebSocketRoute } from './routes/firefox/ws/playwright.js';
+// WebKit
+export { default as WebKitPlaywrightWebSocketRoute } from './routes/webkit/ws/playwright.js';
+// Management
+export { default as ConfigGetRoute } from './routes/management/http/config.get.js';
+export { default as MetricsTotalGetRoute } from './routes/management/http/metrics-total.get.js';
+export { default as MetricsGetRoute } from './routes/management/http/metrics.get.js';
+export { default as SessionsGetGetRoute } from './routes/management/http/sessions.get.js';
+export { default as StaticGetRoute } from './routes/management/http/static.get.js';

package/build/routes/chrome/http/content.post.body.json

@@ -394,14 +394,14 @@
                 "length": {
                   "type": "number"
                 },
-                "__@toStringTag@10812": {
+                "__@toStringTag@11053": {
                   "type": "string",
                   "const": "Uint8Array"
                 }
               },
               "required": [
                 "BYTES_PER_ELEMENT",
-                "__@toStringTag@10812",
+                "__@toStringTag@11053",
                 "buffer",
                 "byteLength",
                 "byteOffset",
@@ -436,13 +436,13 @@
         "byteLength": {
           "type": "number"
         },
-        "__@toStringTag@10812": {
+        "__@toStringTag@11053": {
           "type": "string"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@toStringTag@10812",
+        "__@toStringTag@11053",
         "byteLength"
       ]
     },
@@ -452,18 +452,18 @@
         "byteLength": {
           "type": "number"
         },
-        "__@species@10913": {
+        "__@species@15209": {
           "$ref": "#/definitions/SharedArrayBuffer"
         },
-        "__@toStringTag@10812": {
+        "__@toStringTag@11053": {
           "type": "string",
           "const": "SharedArrayBuffer"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@species@10913",
-        "__@toStringTag@10812",
+        "__@species@15209",
+        "__@toStringTag@11053",
         "byteLength"
       ]
     },