@browserless.io/browserless 2.19.0 → 2.20.0-beta-1

package/README.md

@@ -74,7 +74,7 @@ You still execute the script itself which gives you total control over what libr
 ### Docker
 
 > [!TIP]
-> See more options on our [full documentation site](https://docs.browserless.io/Docker/docker-quickstart).
+> See more options on our [full documentation site](https://docs.browserless.io/docker/quickstart).
 
 1. `docker run -p 3000:3000 ghcr.io/browserless/chromium`
 2. Visit `http://localhost:3000/docs` to see the documentation site.
@@ -180,7 +180,7 @@ You will then see the debugger url during the startup process.
 
 Most libraries allow you to specify a remote instance of Chrome to interact with. They are either looking for a websocket endpoint, a host and port, or some address. Browserless supports these by default, however if you're having issues please make an issue in this project and we'll try and work with the library authors to get them integrated with browserless. Please note that in V2 we no longer support selenium or webdriver integrations.
 
-You can find a much larger list of supported libraries [on our documentation site](https://docs.browserless.io/Libraries/puppeteer-library).
+You can find a much larger list of supported libraries [on our documentation site](https://docs.browserless.io/libraries/puppeteer).
 
 ## Motivations
 

package/bin/browserless.js

@@ -8,6 +8,7 @@ import {
   getArgSwitches,
   getSourceFiles,
   installDependencies,
+  normalizeFileProtocol,
   prompt,
 } from '@browserless.io/browserless';
 import { readFile, writeFile } from 'fs/promises';
@@ -27,7 +28,6 @@ if (typeof process.env.DEBUG === 'undefined') {
 }
 
 const log = debug('browserless.io:sdk:log');
-
 const __dirname = path.dirname(fileURLToPath(import.meta.url));
 const cmd = process.argv[2] ?? 'help';
 const subCMD = process.argv[3];
@@ -90,7 +90,7 @@ const importDefault = async (files, fileName) => {
     return;
   }
 
-  const fullFilePath = path.join(compiledDir, classModuleFile);
+  const fullFilePath = normalizeFileProtocol(path.join(compiledDir, classModuleFile));
 
   if (!classModuleFile) {
     return;

package/build/browserless.js

@@ -1,6 +1,6 @@
 import * as fs from 'fs/promises';
 import * as path from 'path';
-import { Logger as BlessLogger, BrowserManager, ChromeCDP, ChromiumCDP, ChromiumPlaywright, Config, FileSystem, FirefoxPlaywright, HTTPServer, Hooks, Limiter, Metrics, Monitoring, Router, Token, WebHooks, WebKitPlaywright, availableBrowsers, getRouteFiles, makeExternalURL, printLogo, safeParse, } from '@browserless.io/browserless';
+import { Logger as BlessLogger, BrowserManager, ChromeCDP, ChromiumCDP, ChromiumPlaywright, Config, FileSystem, FirefoxPlaywright, HTTPServer, Hooks, Limiter, Metrics, Monitoring, Router, Token, WebHooks, WebKitPlaywright, availableBrowsers, dedent, getRouteFiles, makeExternalURL, normalizeFileProtocol, printLogo, safeParse, } from '@browserless.io/browserless';
 import { EventEmitter } from 'events';
 import { readFile } from 'fs/promises';
 import { userInfo } from 'os';
@@ -177,7 +177,7 @@ export class Browserless extends EventEmitter {
                     schemaPath.base = `${schemaPath.name}.${schemaType}.json`;
                     return await readFile(path.format(schemaPath), 'utf-8').catch(() => '');
                 }));
-                const wsImport = `${this.config.getIsWin() ? 'file:///' : ''}${wsRoute}`;
+                const wsImport = normalizeFileProtocol(wsRoute);
                 const { default: Route, } = await import(wsImport + `?cb=${Date.now()}`);
                 const route = new Route(this.browserManager, this.config, this.fileSystem, this.metrics, this.monitoring, this.staticSDKDir, this.limiter);
                 if (!this.routeIsDisabled(route)) {
@@ -199,7 +199,8 @@ export class Browserless extends EventEmitter {
                 route.browser &&
                 internalBrowsers.includes(route.browser) &&
                 !installedBrowsers.some((b) => b.name === route.browser?.name)) {
-                throw new Error(`Couldn't load route "${route.path}" due to missing browser binary for "${route.browser?.name}"`);
+                throw new Error(dedent(`Couldn't load route "${route.path}" due to missing browser binary for "${route.browser?.name}".
+            Installed Browsers: ${installedBrowsers.join(', ')}`));
             }
         });
         const duplicateNamedRoutes = allRoutes

package/build/config.d.ts

@@ -3,8 +3,8 @@ import playwright from 'playwright-core';
 export declare class Config extends EventEmitter {
     protected readonly debug: string;
     protected readonly host: string;
-    protected external: string | undefined;
     protected readonly isWin: boolean;
+    protected external: string | undefined;
     protected port: number;
     protected downloadsDir: string;
     protected dataDir: string;

package/build/config.js

@@ -1,4 +1,4 @@
-import { exists, keyLength, untildify } from '@browserless.io/browserless';
+import { exists, isWin as isWindows, keyLength, untildify } from '@browserless.io/browserless';
 import { EventEmitter } from 'events';
 import debug from 'debug';
 import { fileURLToPath } from 'url';
@@ -99,8 +99,8 @@ const getDebug = () => {
 export class Config extends EventEmitter {
     debug = getDebug();
     host = process.env.HOST ?? 'localhost';
+    isWin = isWindows;
     external = process.env.PROXY_URL ?? process.env.EXTERNAL;
-    isWin = process.platform === 'win32';
     port = +(process.env.PORT ?? '3000');
     downloadsDir = process.env.DOWNLOAD_DIR
         ? untildify(process.env.DOWNLOAD_DIR)

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

@@ -438,14 +438,14 @@
                 "length": {
                   "type": "number"
                 },
-                "__@toStringTag@14083": {
+                "__@toStringTag@14124": {
                   "type": "string",
                   "const": "Uint8Array"
                 }
               },
               "required": [
                 "BYTES_PER_ELEMENT",
-                "__@toStringTag@14083",
+                "__@toStringTag@14124",
                 "buffer",
                 "byteLength",
                 "byteOffset",
@@ -480,13 +480,13 @@
         "byteLength": {
           "type": "number"
         },
-        "__@toStringTag@14083": {
+        "__@toStringTag@14124": {
           "type": "string"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@toStringTag@14083",
+        "__@toStringTag@14124",
         "byteLength"
       ]
     },
@@ -496,18 +496,18 @@
         "byteLength": {
           "type": "number"
         },
-        "__@species@14121": {
+        "__@species@14162": {
           "$ref": "#/definitions/SharedArrayBuffer"
         },
-        "__@toStringTag@14083": {
+        "__@toStringTag@14124": {
           "type": "string",
           "const": "SharedArrayBuffer"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@species@14121",
-        "__@toStringTag@14083",
+        "__@species@14162",
+        "__@toStringTag@14124",
         "byteLength"
       ]
     },

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

@@ -583,14 +583,14 @@
                 "length": {
                   "type": "number"
                 },
-                "__@toStringTag@111971": {
+                "__@toStringTag@112307": {
                   "type": "string",
                   "const": "Uint8Array"
                 }
               },
               "required": [
                 "BYTES_PER_ELEMENT",
-                "__@toStringTag@111971",
+                "__@toStringTag@112307",
                 "buffer",
                 "byteLength",
                 "byteOffset",
@@ -625,13 +625,13 @@
         "byteLength": {
           "type": "number"
         },
-        "__@toStringTag@111971": {
+        "__@toStringTag@112307": {
           "type": "string"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@toStringTag@111971",
+        "__@toStringTag@112307",
         "byteLength"
       ]
     },
@@ -641,18 +641,18 @@
         "byteLength": {
           "type": "number"
         },
-        "__@species@112009": {
+        "__@species@112345": {
           "$ref": "#/definitions/SharedArrayBuffer"
         },
-        "__@toStringTag@111971": {
+        "__@toStringTag@112307": {
           "type": "string",
           "const": "SharedArrayBuffer"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@species@112009",
-        "__@toStringTag@111971",
+        "__@species@112345",
+        "__@toStringTag@112307",
         "byteLength"
       ]
     },

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

@@ -485,14 +485,14 @@
                 "length": {
                   "type": "number"
                 },
-                "__@toStringTag@154304": {
+                "__@toStringTag@140529": {
                   "type": "string",
                   "const": "Uint8Array"
                 }
               },
               "required": [
                 "BYTES_PER_ELEMENT",
-                "__@toStringTag@154304",
+                "__@toStringTag@140529",
                 "buffer",
                 "byteLength",
                 "byteOffset",
@@ -527,13 +527,13 @@
         "byteLength": {
           "type": "number"
         },
-        "__@toStringTag@154304": {
+        "__@toStringTag@140529": {
           "type": "string"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@toStringTag@154304",
+        "__@toStringTag@140529",
         "byteLength"
       ]
     },
@@ -543,18 +543,18 @@
         "byteLength": {
           "type": "number"
         },
-        "__@species@154342": {
+        "__@species@140567": {
           "$ref": "#/definitions/SharedArrayBuffer"
         },
-        "__@toStringTag@154304": {
+        "__@toStringTag@140529": {
           "type": "string",
           "const": "SharedArrayBuffer"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@species@154342",
-        "__@toStringTag@154304",
+        "__@species@140567",
+        "__@toStringTag@140529",
         "byteLength"
       ]
     },

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

@@ -528,14 +528,14 @@
                 "length": {
                   "type": "number"
                 },
-                "__@toStringTag@140130": {
+                "__@toStringTag@168834": {
                   "type": "string",
                   "const": "Uint8Array"
                 }
               },
               "required": [
                 "BYTES_PER_ELEMENT",
-                "__@toStringTag@140130",
+                "__@toStringTag@168834",
                 "buffer",
                 "byteLength",
                 "byteOffset",
@@ -570,13 +570,13 @@
         "byteLength": {
           "type": "number"
         },
-        "__@toStringTag@140130": {
+        "__@toStringTag@168834": {
           "type": "string"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@toStringTag@140130",
+        "__@toStringTag@168834",
         "byteLength"
       ]
     },
@@ -586,18 +586,18 @@
         "byteLength": {
           "type": "number"
         },
-        "__@species@140168": {
+        "__@species@168872": {
           "$ref": "#/definitions/SharedArrayBuffer"
         },
-        "__@toStringTag@140130": {
+        "__@toStringTag@168834": {
           "type": "string",
           "const": "SharedArrayBuffer"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@species@140168",
-        "__@toStringTag@140130",
+        "__@species@168872",
+        "__@toStringTag@168834",
         "byteLength"
       ]
     },

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

@@ -438,14 +438,14 @@
                 "length": {
                   "type": "number"
                 },
-                "__@toStringTag@168531": {
+                "__@toStringTag@183036": {
                   "type": "string",
                   "const": "Uint8Array"
                 }
               },
               "required": [
                 "BYTES_PER_ELEMENT",
-                "__@toStringTag@168531",
+                "__@toStringTag@183036",
                 "buffer",
                 "byteLength",
                 "byteOffset",
@@ -480,13 +480,13 @@
         "byteLength": {
           "type": "number"
         },
-        "__@toStringTag@168531": {
+        "__@toStringTag@183036": {
           "type": "string"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@toStringTag@168531",
+        "__@toStringTag@183036",
         "byteLength"
       ]
     },
@@ -496,18 +496,18 @@
         "byteLength": {
           "type": "number"
         },
-        "__@species@168569": {
+        "__@species@183074": {
           "$ref": "#/definitions/SharedArrayBuffer"
         },
-        "__@toStringTag@168531": {
+        "__@toStringTag@183036": {
           "type": "string",
           "const": "SharedArrayBuffer"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@species@168569",
-        "__@toStringTag@168531",
+        "__@species@183074",
+        "__@toStringTag@183036",
         "byteLength"
       ]
     },

package/build/routes/chromium/http/pdf.post.body.json

@@ -583,14 +583,14 @@
                 "length": {
                   "type": "number"
                 },
-                "__@toStringTag@252426": {
+                "__@toStringTag@267177": {
                   "type": "string",
                   "const": "Uint8Array"
                 }
               },
               "required": [
                 "BYTES_PER_ELEMENT",
-                "__@toStringTag@252426",
+                "__@toStringTag@267177",
                 "buffer",
                 "byteLength",
                 "byteOffset",
@@ -625,13 +625,13 @@
         "byteLength": {
           "type": "number"
         },
-        "__@toStringTag@252426": {
+        "__@toStringTag@267177": {
           "type": "string"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@toStringTag@252426",
+        "__@toStringTag@267177",
         "byteLength"
       ]
     },
@@ -641,18 +641,18 @@
         "byteLength": {
           "type": "number"
         },
-        "__@species@252464": {
+        "__@species@267215": {
           "$ref": "#/definitions/SharedArrayBuffer"
         },
-        "__@toStringTag@252426": {
+        "__@toStringTag@267177": {
           "type": "string",
           "const": "SharedArrayBuffer"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@species@252464",
-        "__@toStringTag@252426",
+        "__@species@267215",
+        "__@toStringTag@267177",
         "byteLength"
       ]
     },

package/build/routes/chromium/http/scrape.post.body.json

@@ -485,14 +485,14 @@
                 "length": {
                   "type": "number"
                 },
-                "__@toStringTag@294540": {
+                "__@toStringTag@295401": {
                   "type": "string",
                   "const": "Uint8Array"
                 }
               },
               "required": [
                 "BYTES_PER_ELEMENT",
-                "__@toStringTag@294540",
+                "__@toStringTag@295401",
                 "buffer",
                 "byteLength",
                 "byteOffset",
@@ -527,13 +527,13 @@
         "byteLength": {
           "type": "number"
         },
-        "__@toStringTag@294540": {
+        "__@toStringTag@295401": {
           "type": "string"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@toStringTag@294540",
+        "__@toStringTag@295401",
         "byteLength"
       ]
     },
@@ -543,18 +543,18 @@
         "byteLength": {
           "type": "number"
         },
-        "__@species@294578": {
+        "__@species@295439": {
           "$ref": "#/definitions/SharedArrayBuffer"
         },
-        "__@toStringTag@294540": {
+        "__@toStringTag@295401": {
           "type": "string",
           "const": "SharedArrayBuffer"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@species@294578",
-        "__@toStringTag@294540",
+        "__@species@295439",
+        "__@toStringTag@295401",
         "byteLength"
       ]
     },

package/build/routes/chromium/http/screenshot.post.body.json

@@ -528,14 +528,14 @@
                 "length": {
                   "type": "number"
                 },
-                "__@toStringTag@308788": {
+                "__@toStringTag@323656": {
                   "type": "string",
                   "const": "Uint8Array"
                 }
               },
               "required": [
                 "BYTES_PER_ELEMENT",
-                "__@toStringTag@308788",
+                "__@toStringTag@323656",
                 "buffer",
                 "byteLength",
                 "byteOffset",
@@ -570,13 +570,13 @@
         "byteLength": {
           "type": "number"
         },
-        "__@toStringTag@308788": {
+        "__@toStringTag@323656": {
           "type": "string"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@toStringTag@308788",
+        "__@toStringTag@323656",
         "byteLength"
       ]
     },
@@ -586,18 +586,18 @@
         "byteLength": {
           "type": "number"
         },
-        "__@species@308826": {
+        "__@species@323694": {
           "$ref": "#/definitions/SharedArrayBuffer"
         },
-        "__@toStringTag@308788": {
+        "__@toStringTag@323656": {
           "type": "string",
           "const": "SharedArrayBuffer"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@species@308826",
-        "__@toStringTag@308788",
+        "__@species@323694",
+        "__@toStringTag@323656",
         "byteLength"
       ]
     },

package/build/sdk-utils.js

@@ -2,7 +2,15 @@ import { createInterface } from 'readline';
 import debug from 'debug';
 import fs from 'fs/promises';
 import path from 'path';
-import { spawn } from 'child_process';
+import { promisify } from 'util';
+import { exec } from 'child_process';
+const execAsync = promisify(exec);
+const waitForCommand = async (cmd, workingDirectory) => new Promise((resolve, reject) => execAsync(cmd, { cwd: workingDirectory }).then(({ stderr }) => {
+    if (stderr) {
+        return reject(`Error running ${cmd}. See output for more details: \n${stderr}`);
+    }
+    return resolve();
+}));
 export const getArgSwitches = () => {
     return process.argv.reduce((accum, arg, idx) => {
         if (!arg.startsWith('--')) {
@@ -28,7 +36,11 @@ export const getSourceFiles = async (cwd) => {
     const buildDir = path.join(cwd, 'build');
     const files = await fs.readdir(buildDir, { recursive: true });
     const [httpRoutes, webSocketRoutes] = files.reduce(([httpRoutes, webSocketRoutes], file) => {
+        const isInRootDir = !file.includes(path.sep);
         const parsed = path.parse(file);
+        if (isInRootDir) {
+            return [httpRoutes, webSocketRoutes];
+        }
         if (parsed.name.endsWith('http')) {
             httpRoutes.push(path.join(buildDir, file));
         }
@@ -58,50 +70,10 @@ export const prompt = async (question) => {
         });
     });
 };
+// Exceptions are not caught, since any error would result in a crash regardless
 export const installDependencies = async (workingDirectory) => {
-    await new Promise((resolve, reject) => {
-        spawn('npm', ['i'], {
-            cwd: workingDirectory,
-            stdio: 'inherit',
-        }).once('close', (code) => {
-            if (code === 0) {
-                return resolve();
-            }
-            return reject(`Error when installing dependencies, see output for more details`);
-        });
-    });
-    await new Promise((resolve, reject) => {
-        spawn('npx', 'playwright-core install --with-deps chromium firefox webkit'.split(' '), {
-            cwd: workingDirectory,
-            stdio: 'inherit',
-        }).once('close', (code) => {
-            if (code === 0) {
-                return resolve();
-            }
-            return reject(`Error when installing dependencies, see output for more details`);
-        });
-    });
+    await waitForCommand('npm install', workingDirectory);
+    await waitForCommand('npx playwright-core install --with-deps chromium firefox webkit', workingDirectory);
 };
-export const buildDockerImage = async (cmd, projectDir) => new Promise((resolve, reject) => {
-    const [docker, ...args] = cmd.split(' ');
-    spawn(docker, args, {
-        cwd: projectDir,
-        stdio: 'inherit',
-    }).once('close', (code) => {
-        if (code === 0) {
-            return resolve();
-        }
-        return reject(`Error when building Docker image, see output for more details`);
-    });
-});
-export const buildTypeScript = async (buildDir, projectDir) => new Promise((resolve, reject) => {
-    spawn('npx', ['tsc', '--outDir', buildDir], {
-        cwd: projectDir,
-        stdio: 'inherit',
-    }).once('close', (code) => {
-        if (code === 0) {
-            return resolve();
-        }
-        return reject(`Error in building TypeScript, see output for more details`);
-    });
-});
+export const buildDockerImage = async (cmd, projectDir) => waitForCommand(cmd, projectDir);
+export const buildTypeScript = async (buildDir, projectDir) => waitForCommand(`npx tsc --outDir ${buildDir}`, projectDir);

package/build/utils.d.ts

@@ -17,7 +17,15 @@ export declare const buildDir: string;
 export declare const tsExtension = ".d.ts";
 export declare const jsonExtension = ".json";
 export declare const jsExtension = ".js";
+export declare const isWin: boolean;
 export declare const id: () => string;
+/**
+ * Normalizes a full-path by adding the `file://` protocol if needed.
+ *
+ * @param filepath - The file path to normalize.
+ * @returns The normalized file path.
+ */
+export declare const normalizeFileProtocol: (filepath: string) => string;
 /**
  * Generates a random, Chromium-compliant page ID with "BLESS"
  * prepended. This prepended text signals to other parts of the