@browserless.io/browserless 2.4.0 → 2.5.0-beta-2

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

@@ -441,14 +441,14 @@
                 "length": {
                   "type": "number"
                 },
-                "__@toStringTag@130822": {
+                "__@toStringTag@108694": {
                   "type": "string",
                   "const": "Uint8Array"
                 }
               },
               "required": [
                 "BYTES_PER_ELEMENT",
-                "__@toStringTag@130822",
+                "__@toStringTag@108694",
                 "buffer",
                 "byteLength",
                 "byteOffset",
@@ -483,13 +483,13 @@
         "byteLength": {
           "type": "number"
         },
-        "__@toStringTag@130822": {
+        "__@toStringTag@108694": {
           "type": "string"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@toStringTag@130822",
+        "__@toStringTag@108694",
         "byteLength"
       ]
     },
@@ -499,18 +499,18 @@
         "byteLength": {
           "type": "number"
         },
-        "__@species@130923": {
+        "__@species@108795": {
           "$ref": "#/definitions/SharedArrayBuffer"
         },
-        "__@toStringTag@130822": {
+        "__@toStringTag@108694": {
           "type": "string",
           "const": "SharedArrayBuffer"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@species@130923",
-        "__@toStringTag@130822",
+        "__@species@108795",
+        "__@toStringTag@108694",
         "byteLength"
       ]
     },

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

@@ -484,14 +484,14 @@
                 "length": {
                   "type": "number"
                 },
-                "__@toStringTag@97868": {
+                "__@toStringTag@119846": {
                   "type": "string",
                   "const": "Uint8Array"
                 }
               },
               "required": [
                 "BYTES_PER_ELEMENT",
-                "__@toStringTag@97868",
+                "__@toStringTag@119846",
                 "buffer",
                 "byteLength",
                 "byteOffset",
@@ -526,13 +526,13 @@
         "byteLength": {
           "type": "number"
         },
-        "__@toStringTag@97868": {
+        "__@toStringTag@119846": {
           "type": "string"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@toStringTag@97868",
+        "__@toStringTag@119846",
         "byteLength"
       ]
     },
@@ -542,18 +542,18 @@
         "byteLength": {
           "type": "number"
         },
-        "__@species@97969": {
+        "__@species@119947": {
           "$ref": "#/definitions/SharedArrayBuffer"
         },
-        "__@toStringTag@97868": {
+        "__@toStringTag@119846": {
           "type": "string",
           "const": "SharedArrayBuffer"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@species@97969",
-        "__@toStringTag@97868",
+        "__@species@119947",
+        "__@toStringTag@119846",
         "byteLength"
       ]
     },

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

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

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

@@ -535,14 +535,14 @@
                 "length": {
                   "type": "number"
                 },
-                "__@toStringTag@195916": {
+                "__@toStringTag@217585": {
                   "type": "string",
                   "const": "Uint8Array"
                 }
               },
               "required": [
                 "BYTES_PER_ELEMENT",
-                "__@toStringTag@195916",
+                "__@toStringTag@217585",
                 "buffer",
                 "byteLength",
                 "byteOffset",
@@ -577,13 +577,13 @@
         "byteLength": {
           "type": "number"
         },
-        "__@toStringTag@195916": {
+        "__@toStringTag@217585": {
           "type": "string"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@toStringTag@195916",
+        "__@toStringTag@217585",
         "byteLength"
       ]
     },
@@ -593,18 +593,18 @@
         "byteLength": {
           "type": "number"
         },
-        "__@species@196017": {
+        "__@species@217686": {
           "$ref": "#/definitions/SharedArrayBuffer"
         },
-        "__@toStringTag@195916": {
+        "__@toStringTag@217585": {
           "type": "string",
           "const": "SharedArrayBuffer"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@species@196017",
-        "__@toStringTag@195916",
+        "__@species@217686",
+        "__@toStringTag@217585",
         "byteLength"
       ]
     },

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

@@ -441,14 +441,14 @@
                 "length": {
                   "type": "number"
                 },
-                "__@toStringTag@228592": {
+                "__@toStringTag@228657": {
                   "type": "string",
                   "const": "Uint8Array"
                 }
               },
               "required": [
                 "BYTES_PER_ELEMENT",
-                "__@toStringTag@228592",
+                "__@toStringTag@228657",
                 "buffer",
                 "byteLength",
                 "byteOffset",
@@ -483,13 +483,13 @@
         "byteLength": {
           "type": "number"
         },
-        "__@toStringTag@228592": {
+        "__@toStringTag@228657": {
           "type": "string"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@toStringTag@228592",
+        "__@toStringTag@228657",
         "byteLength"
       ]
     },
@@ -499,18 +499,18 @@
         "byteLength": {
           "type": "number"
         },
-        "__@species@228693": {
+        "__@species@228758": {
           "$ref": "#/definitions/SharedArrayBuffer"
         },
-        "__@toStringTag@228592": {
+        "__@toStringTag@228657": {
           "type": "string",
           "const": "SharedArrayBuffer"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@species@228693",
-        "__@toStringTag@228592",
+        "__@species@228758",
+        "__@toStringTag@228657",
         "byteLength"
       ]
     },

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

@@ -484,14 +484,14 @@
                 "length": {
                   "type": "number"
                 },
-                "__@toStringTag@239738": {
+                "__@toStringTag@239806": {
                   "type": "string",
                   "const": "Uint8Array"
                 }
               },
               "required": [
                 "BYTES_PER_ELEMENT",
-                "__@toStringTag@239738",
+                "__@toStringTag@239806",
                 "buffer",
                 "byteLength",
                 "byteOffset",
@@ -526,13 +526,13 @@
         "byteLength": {
           "type": "number"
         },
-        "__@toStringTag@239738": {
+        "__@toStringTag@239806": {
           "type": "string"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@toStringTag@239738",
+        "__@toStringTag@239806",
         "byteLength"
       ]
     },
@@ -542,18 +542,18 @@
         "byteLength": {
           "type": "number"
         },
-        "__@species@239839": {
+        "__@species@239907": {
           "$ref": "#/definitions/SharedArrayBuffer"
         },
-        "__@toStringTag@239738": {
+        "__@toStringTag@239806": {
           "type": "string",
           "const": "SharedArrayBuffer"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@species@239839",
-        "__@toStringTag@239738",
+        "__@species@239907",
+        "__@toStringTag@239806",
         "byteLength"
       ]
     },

package/build/routes/management/http/metrics-total.get.js

@@ -14,7 +14,7 @@ export default class MetricsTotalGetRoute extends HTTPRoute {
     handler = async (_req, res) => {
         const fileSystem = this.fileSystem();
         const config = this.config();
-        const metrics = (await fileSystem.read(config.getMetricsJSONPath())).map((m) => JSON.parse(m));
+        const metrics = (await fileSystem.read(config.getMetricsJSONPath(), false)).map((m) => JSON.parse(m));
         const availableMetrics = metrics.length;
         const totals = metrics.reduce((accum, metric) => ({
             error: accum.error + metric.error,

package/build/routes/management/http/metrics.get.js

@@ -6,14 +6,14 @@ export default class MetricsGetRoute extends HTTPRoute {
     browser = null;
     concurrency = false;
     contentTypes = [contentTypes.json];
-    description = `Gets total metric details from the time the server started.`;
+    description = `Returns a list of metric details as far back as possible.`;
     method = Methods.get;
     path = HTTPManagementRoutes.metrics;
     tags = [APITags.management];
     handler = async (_req, res) => {
         const fileSystem = this.fileSystem();
         const config = this.config();
-        const stats = await fileSystem.read(config.getMetricsJSONPath());
+        const stats = await fileSystem.read(config.getMetricsJSONPath(), false);
         const response = `[${stats.join(',')}]`;
         return writeResponse(res, 200, response, contentTypes.json);
     };

package/build/sdk-utils.d.ts

@@ -0,0 +1,13 @@
+export declare const getArgSwitches: () => {
+    [key: string]: string | true;
+};
+export declare const getSourceFiles: (cwd: string) => Promise<{
+    files: string[];
+    httpRoutes: string[];
+    webSocketRoutes: string[];
+}>;
+export declare const camelCase: (str: string) => string;
+export declare const prompt: (question: string) => Promise<unknown>;
+export declare const installDependencies: (workingDirectory: string) => Promise<void>;
+export declare const buildDockerImage: (cmd: string, projectDir: string) => Promise<void>;
+export declare const buildTypeScript: (buildDir: string, projectDir: string) => Promise<void>;

package/build/sdk-utils.js

@@ -0,0 +1,94 @@
+import { createInterface } from 'readline';
+import debug from 'debug';
+import fs from 'fs/promises';
+import path from 'path';
+import { spawn } from 'child_process';
+export const getArgSwitches = () => {
+    return process.argv.reduce((accum, arg, idx) => {
+        if (!arg.startsWith('--')) {
+            return accum;
+        }
+        if (arg.includes('=')) {
+            const [parameter, value] = arg.split('=');
+            accum[parameter.replace(/-/gi, '')] = value || true;
+            return accum;
+        }
+        const nextSwitchOrParameter = process.argv[idx + 1];
+        const param = arg.replace(/-/gi, '');
+        if (typeof nextSwitchOrParameter === 'undefined' ||
+            nextSwitchOrParameter?.startsWith('--')) {
+            accum[param] = true;
+            return accum;
+        }
+        accum[param] = nextSwitchOrParameter;
+        return accum;
+    }, {});
+};
+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 parsed = path.parse(file);
+        if (parsed.name.endsWith('http')) {
+            httpRoutes.push(path.join(buildDir, file));
+        }
+        if (parsed.name.endsWith('ws')) {
+            webSocketRoutes.push(path.join(buildDir, file));
+        }
+        return [httpRoutes, webSocketRoutes];
+    }, [[], []]);
+    return {
+        files,
+        httpRoutes,
+        webSocketRoutes,
+    };
+};
+export const camelCase = (str) => str.replace(/-([a-z])/g, (_, w) => w.toUpperCase());
+export const prompt = async (question) => {
+    const promptLog = debug('browserless.io:prompt');
+    const rl = createInterface({
+        input: process.stdin,
+        output: process.stdout,
+    });
+    return new Promise((resolve) => {
+        promptLog(question);
+        rl.question('  > ', (a) => {
+            rl.close();
+            resolve(a.trim());
+        });
+    });
+};
+export const installDependencies = async (workingDirectory) => 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`);
+    });
+});
+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`);
+    });
+});

package/build/server.d.ts

@@ -5,7 +5,7 @@
 /// <reference types="node" />
 import * as http from 'http';
 import * as stream from 'stream';
-import { Config, Metrics, Request, Response, Router, Token } from '@browserless.io/browserless';
+import { Config, Hooks, Metrics, Request, Response, Router, Token } from '@browserless.io/browserless';
 import { EventEmitter } from 'events';
 export interface HTTPServerOptions {
     concurrent: number;
@@ -19,12 +19,13 @@ export declare class HTTPServer extends EventEmitter {
     protected metrics: Metrics;
     protected token: Token;
     protected router: Router;
+    protected hooks: Hooks;
     protected server: http.Server;
     protected port: number;
     protected host?: string;
     protected log: import("debug").Debugger;
     protected verbose: import("debug").Debugger;
-    constructor(config: Config, metrics: Metrics, token: Token, router: Router);
+    constructor(config: Config, metrics: Metrics, token: Token, router: Router, hooks: Hooks);
     protected onHTTPUnauthorized: (_req: Request, res: Response) => void;
     protected onWebsocketUnauthorized: (_req: Request, socket: stream.Duplex) => void;
     start(): Promise<void>;

package/build/server.js

@@ -1,5 +1,5 @@
 import * as http from 'http';
-import { BadRequest, NotFound, Timeout, TooManyRequests, Unauthorized, beforeRequest, contentTypes, convertPathToURL, createLogger, queryParamsToObject, readBody, shimLegacyRequests, writeResponse, } from '@browserless.io/browserless';
+import { BadRequest, NotFound, Timeout, TooManyRequests, Unauthorized, contentTypes, convertPathToURL, createLogger, queryParamsToObject, readBody, shimLegacyRequests, writeResponse, } from '@browserless.io/browserless';
 import { EventEmitter } from 'events';
 // @ts-ignore
 import Enjoi from 'enjoi';
@@ -8,17 +8,19 @@ export class HTTPServer extends EventEmitter {
     metrics;
     token;
     router;
+    hooks;
     server = http.createServer();
     port;
     host;
     log = createLogger('server');
     verbose = createLogger('server:verbose');
-    constructor(config, metrics, token, router) {
+    constructor(config, metrics, token, router, hooks) {
         super();
         this.config = config;
         this.metrics = metrics;
         this.token = token;
         this.router = router;
+        this.hooks = hooks;
         this.host = config.getHost();
         this.port = config.getPort();
         this.log(`Server instantiated with host "${this.host}" on port "${this.port}" using token "${this.config.getToken()}"`);
@@ -54,7 +56,7 @@ export class HTTPServer extends EventEmitter {
     handleRequest = async (request, res) => {
         this.verbose(`Handling inbound HTTP request on "${request.method}: ${request.url}"`);
         const req = request;
-        const proceed = await beforeRequest({ req, res });
+        const proceed = await this.hooks.before({ req, res });
         req.parsed = convertPathToURL(request.url || '', this.config);
         shimLegacyRequests(req.parsed);
         if (!proceed)
@@ -168,7 +170,7 @@ export class HTTPServer extends EventEmitter {
     handleWebSocket = async (request, socket, head) => {
         this.verbose(`Handling inbound WebSocket request on "${request.url}"`);
         const req = request;
-        const proceed = await beforeRequest({ head, req, socket });
+        const proceed = await this.hooks.before({ head, req, socket });
         req.parsed = convertPathToURL(request.url || '', this.config);
         shimLegacyRequests(req.parsed);
         if (!proceed)

package/build/types.d.ts

@@ -9,12 +9,12 @@ import { HTTPRequest, Page, ResponseForRequest, ScreenshotOptions } from 'puppet
 export type PathTypes = HTTPRoutes | WebsocketRoutes | HTTPManagementRoutes | string;
 export interface BeforeRequest {
     head?: Buffer;
-    req: Request;
+    req: http.IncomingMessage;
     res?: http.ServerResponse;
     socket?: stream.Duplex;
 }
 export interface AfterResponse {
-    req: http.IncomingMessage;
+    req: Request;
     start: number;
     status: 'successful' | 'error' | 'timedout';
 }

package/build/utils.js

@@ -322,15 +322,10 @@ export const availableBrowsers = Promise.all([
     }
     return availableBrowsers;
 });
-export const queryParamsToObject = (params) => {
-    const entries = params.entries();
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    const result = {};
-    for (const [key, value] of entries) {
-        result[key] = value === '' ? true : jsonOrString(value);
-    }
-    return result;
-};
+export const queryParamsToObject = (params) => [...params.entries()].reduce((accum, [key, value]) => {
+    accum[key] = value;
+    return accum;
+}, {});
 // eslint-disable-next-line @typescript-eslint/no-empty-function
 const AsyncFunction = Object.getPrototypeOf(async function () { }).constructor;
 const wrapUserFunction = (fn) => {
@@ -536,7 +531,8 @@ export const encrypt = (text, secret) => {
     ].join(encryptionSep);
 };
 export const decrypt = (encryptedText, secret) => {
-    const [encrypted, iv] = encryptedText.split(encryptionSep);
+    const [encrypted, iv] = encryptedText.toString().split(encryptionSep);
+    console.log('>>', encryptedText.toString());
     if (!iv)
         throw new ServerError('Bad or invalid encrypted format');
     const decipher = crypto.createDecipheriv(encryptionAlgo, secret, Buffer.from(iv, 'hex'));

package/external/after.js

@@ -1 +1 @@
-export default () => true;
+export default async () => {};

package/external/before.js

@@ -1 +1 @@
-export default () => true;
+export default async () => true;

package/external/browser.js

@@ -1 +1 @@
-export default () => Promise.resolve(true);
+export default async () => {};

package/external/page.js

@@ -1 +1 @@
-export default () => Promise.resolve(true);
+export default async () => {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@browserless.io/browserless",
-  "version": "2.4.0",
+  "version": "2.5.0-beta-2",
   "license": "SSPL",
   "description": "The browserless platform",
   "author": "browserless.io",
@@ -29,7 +29,7 @@
     "install:dev": "npm run install:browsers",
     "lint": "eslint . --ext .ts --fix",
     "prepack": "npm run build:dev",
-    "prettier": "prettier '{src,functions,scripts,bin,external,bin}/**/*.{js,ts,json}' --log-level error --write",
+    "prettier": "prettier '{src,functions,scripts,bin,external,.github}/**/*.{js,ts,json,yml,yaml,md}' --log-level error --write",
     "test": "cross-env DEBUG=quiet mocha",
     "start": "env-cmd -f .env node build"
   },
@@ -58,11 +58,11 @@
     "lighthouse": "^11.1.0",
     "micromatch": "^4.0.4",
     "playwright-core": "1.42.1",
-    "puppeteer-core": "^22.4.0",
+    "puppeteer-core": "^22.4.1",
     "puppeteer-extra": "^3.3.6",
     "puppeteer-extra-plugin-stealth": "^2.11.2",
     "queue": "^7.0.0",
-    "systeminformation": "^5.22.0"
+    "systeminformation": "^5.22.1"
   },
   "optionalDependencies": {
     "@types/chai": "^4.3.12",
@@ -71,10 +71,10 @@
     "@types/http-proxy": "^1.17.14",
     "@types/micromatch": "^4.0.6",
     "@types/mocha": "^10.0.6",
-    "@types/node": "^20.11.25",
+    "@types/node": "^20.11.26",
     "@types/sinon": "^17.0.3",
-    "@typescript-eslint/eslint-plugin": "^7.1.1",
-    "@typescript-eslint/parser": "^7.1.1",
+    "@typescript-eslint/eslint-plugin": "^7.2.0",
+    "@typescript-eslint/parser": "^7.2.0",
     "assert": "^2.0.0",
     "chai": "^5.1.0",
     "cross-env": "^7.0.3",