@browserless.io/browserless 2.0.0-beta-7 → 2.1.0

package/build/file-system.spec.js

@@ -2,7 +2,7 @@ import { Config, FileSystem, sleep } from '@browserless.io/browserless';
 import { readFile, unlink } from 'fs/promises';
 import { expect } from 'chai';
 const filePath = '/tmp/_browserless_test_fs_';
-describe.only('File-System', () => {
+describe('File-System', () => {
     afterEach(async () => unlink(filePath));
     it('saves and encodes files', async () => {
         const mySecretContents = 'pony-foo';

package/build/http.d.ts

@@ -119,6 +119,7 @@ export declare enum HTTPRoutes {
     content = "/content",
     download = "/download",
     function = "/function",
+    jsonVersion = "/json/version",
     pdf = "/pdf",
     performance = "/performance",
     scrape = "/scrape",

package/build/http.js

@@ -83,6 +83,7 @@ export var HTTPRoutes;
     HTTPRoutes["content"] = "/content";
     HTTPRoutes["download"] = "/download";
     HTTPRoutes["function"] = "/function";
+    HTTPRoutes["jsonVersion"] = "/json/version";
     HTTPRoutes["pdf"] = "/pdf";
     HTTPRoutes["performance"] = "/performance";
     HTTPRoutes["scrape"] = "/scrape";

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

@@ -398,14 +398,14 @@
                 "length": {
                   "type": "number"
                 },
-                "__@toStringTag@10732": {
+                "__@toStringTag@10755": {
                   "type": "string",
                   "const": "Uint8Array"
                 }
               },
               "required": [
                 "BYTES_PER_ELEMENT",
-                "__@toStringTag@10732",
+                "__@toStringTag@10755",
                 "buffer",
                 "byteLength",
                 "byteOffset",
@@ -440,13 +440,13 @@
         "byteLength": {
           "type": "number"
         },
-        "__@toStringTag@10732": {
+        "__@toStringTag@10755": {
           "type": "string"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@toStringTag@10732",
+        "__@toStringTag@10755",
         "byteLength"
       ]
     },
@@ -456,18 +456,18 @@
         "byteLength": {
           "type": "number"
         },
-        "__@species@10833": {
+        "__@species@10856": {
           "$ref": "#/definitions/SharedArrayBuffer"
         },
-        "__@toStringTag@10732": {
+        "__@toStringTag@10755": {
           "type": "string",
           "const": "SharedArrayBuffer"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@species@10833",
-        "__@toStringTag@10732",
+        "__@species@10856",
+        "__@toStringTag@10755",
         "byteLength"
       ]
     },

package/build/routes/chromium/http/json-version-get.d.ts

@@ -0,0 +1,15 @@
+import { APITags, BrowserManager, HTTPRoutes, HTTPRoute, Methods, Request, Response, UnwrapPromise, contentTypes } from '@browserless.io/browserless';
+export type ResponseSchema = UnwrapPromise<ReturnType<BrowserManager['getVersionJSON']>>;
+export default class GetJSONVersion extends HTTPRoute {
+    accepts: contentTypes[];
+    auth: boolean;
+    browser: null;
+    concurrency: boolean;
+    contentTypes: contentTypes[];
+    description: string;
+    method: Methods;
+    path: HTTPRoutes;
+    tags: APITags[];
+    private cachedJSON;
+    handler: (req: Request, res: Response) => Promise<void>;
+}

package/build/routes/chromium/http/json-version-get.js

@@ -0,0 +1,30 @@
+import { APITags, HTTPRoutes, HTTPRoute, Methods, contentTypes, jsonResponse, writeResponse, } from '@browserless.io/browserless';
+export default class GetJSONVersion extends HTTPRoute {
+    accepts = [contentTypes.any];
+    auth = true;
+    browser = null;
+    concurrency = false;
+    contentTypes = [contentTypes.json];
+    description = `Returns a JSON payload that acts as a pass-through to the DevTools /json/version protocol in Chrome.`;
+    method = Methods.get;
+    path = HTTPRoutes.jsonVersion;
+    tags = [APITags.browserAPI];
+    cachedJSON;
+    handler = async (req, res) => {
+        const baseUrl = req.parsed.host;
+        const protocol = req.parsed.protocol.includes('s') ? 'wss' : 'ws';
+        const browserManager = this.browserManager();
+        try {
+            if (!this.cachedJSON) {
+                this.cachedJSON = {
+                    ...(await browserManager.getVersionJSON()),
+                    webSocketDebuggerUrl: `${protocol}://${baseUrl}`,
+                };
+            }
+            return jsonResponse(res, 200, this.cachedJSON);
+        }
+        catch (err) {
+            return writeResponse(res, 500, 'There was an error handling your request', contentTypes.text);
+        }
+    };
+}

package/build/routes/chromium/http/json-version-get.response.json

@@ -0,0 +1,37 @@
+{
+  "type": "object",
+  "properties": {
+    "Browser": {
+      "type": "string"
+    },
+    "Debugger-Version": {
+      "type": "string"
+    },
+    "Protocol-Version": {
+      "type": "string"
+    },
+    "User-Agent": {
+      "type": "string"
+    },
+    "V8-Version": {
+      "type": "string"
+    },
+    "WebKit-Version": {
+      "type": "string"
+    },
+    "webSocketDebuggerUrl": {
+      "type": "string"
+    }
+  },
+  "additionalProperties": false,
+  "required": [
+    "Browser",
+    "Debugger-Version",
+    "Protocol-Version",
+    "User-Agent",
+    "V8-Version",
+    "WebKit-Version",
+    "webSocketDebuggerUrl"
+  ],
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

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

@@ -538,14 +538,14 @@
                 "length": {
                   "type": "number"
                 },
-                "__@toStringTag@21651": {
+                "__@toStringTag@53628": {
                   "type": "string",
                   "const": "Uint8Array"
                 }
               },
               "required": [
                 "BYTES_PER_ELEMENT",
-                "__@toStringTag@21651",
+                "__@toStringTag@53628",
                 "buffer",
                 "byteLength",
                 "byteOffset",
@@ -580,13 +580,13 @@
         "byteLength": {
           "type": "number"
         },
-        "__@toStringTag@21651": {
+        "__@toStringTag@53628": {
           "type": "string"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@toStringTag@21651",
+        "__@toStringTag@53628",
         "byteLength"
       ]
     },
@@ -596,18 +596,18 @@
         "byteLength": {
           "type": "number"
         },
-        "__@species@21752": {
+        "__@species@53729": {
           "$ref": "#/definitions/SharedArrayBuffer"
         },
-        "__@toStringTag@21651": {
+        "__@toStringTag@53628": {
           "type": "string",
           "const": "SharedArrayBuffer"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@species@21752",
-        "__@toStringTag@21651",
+        "__@species@53729",
+        "__@toStringTag@53628",
         "byteLength"
       ]
     },

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

@@ -445,14 +445,14 @@
                 "length": {
                   "type": "number"
                 },
-                "__@toStringTag@64394": {
+                "__@toStringTag@64541": {
                   "type": "string",
                   "const": "Uint8Array"
                 }
               },
               "required": [
                 "BYTES_PER_ELEMENT",
-                "__@toStringTag@64394",
+                "__@toStringTag@64541",
                 "buffer",
                 "byteLength",
                 "byteOffset",
@@ -487,13 +487,13 @@
         "byteLength": {
           "type": "number"
         },
-        "__@toStringTag@64394": {
+        "__@toStringTag@64541": {
           "type": "string"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@toStringTag@64394",
+        "__@toStringTag@64541",
         "byteLength"
       ]
     },
@@ -503,18 +503,18 @@
         "byteLength": {
           "type": "number"
         },
-        "__@species@64495": {
+        "__@species@64642": {
           "$ref": "#/definitions/SharedArrayBuffer"
         },
-        "__@toStringTag@64394": {
+        "__@toStringTag@64541": {
           "type": "string",
           "const": "SharedArrayBuffer"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@species@64495",
-        "__@toStringTag@64394",
+        "__@species@64642",
+        "__@toStringTag@64541",
         "byteLength"
       ]
     },

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

@@ -488,14 +488,14 @@
                 "length": {
                   "type": "number"
                 },
-                "__@toStringTag@128397": {
+                "__@toStringTag@75532": {
                   "type": "string",
                   "const": "Uint8Array"
                 }
               },
               "required": [
                 "BYTES_PER_ELEMENT",
-                "__@toStringTag@128397",
+                "__@toStringTag@75532",
                 "buffer",
                 "byteLength",
                 "byteOffset",
@@ -530,13 +530,13 @@
         "byteLength": {
           "type": "number"
         },
-        "__@toStringTag@128397": {
+        "__@toStringTag@75532": {
           "type": "string"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@toStringTag@128397",
+        "__@toStringTag@75532",
         "byteLength"
       ]
     },
@@ -546,18 +546,18 @@
         "byteLength": {
           "type": "number"
         },
-        "__@species@128498": {
+        "__@species@75633": {
           "$ref": "#/definitions/SharedArrayBuffer"
         },
-        "__@toStringTag@128397": {
+        "__@toStringTag@75532": {
           "type": "string",
           "const": "SharedArrayBuffer"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@species@128498",
-        "__@toStringTag@128397",
+        "__@species@75633",
+        "__@toStringTag@75532",
         "byteLength"
       ]
     },

package/build/routes/chromium/tests/json-version.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/build/routes/chromium/tests/json-version.spec.js

@@ -0,0 +1,37 @@
+import { Browserless, Config, Metrics } from '@browserless.io/browserless';
+import { expect } from 'chai';
+describe('/json/version API', function () {
+    let browserless;
+    const start = ({ config = new Config(), metrics = new Metrics(), } = {}) => {
+        browserless = new Browserless({ config, metrics });
+        return browserless.start();
+    };
+    afterEach(async () => {
+        await browserless.stop();
+    });
+    it('allows requests to /json/version', async () => {
+        const config = new Config();
+        config.setToken('browserless');
+        const metrics = new Metrics();
+        await start({ config, metrics });
+        const res = await fetch('http://localhost:3000/json/version?token=browserless');
+        const resJSON = await res.json();
+        [
+            'Browser',
+            'Protocol-Version',
+            'User-Agent',
+            'V8-Version',
+            'WebKit-Version',
+            'webSocketDebuggerUrl',
+            'Debugger-Version',
+        ].forEach((k) => expect(resJSON).to.haveOwnProperty(k));
+    });
+    it('rejects unauthorized requests to /json/version', async () => {
+        const config = new Config();
+        config.setToken('browserless');
+        const metrics = new Metrics();
+        await start({ config, metrics });
+        const res = await fetch('http://localhost:3000/json/version?token=imabadboi');
+        expect(res.status).to.equal(401);
+    });
+});

package/build/utils.js

@@ -27,7 +27,7 @@ export const jsonExtension = '.json';
 export const jsExtension = '.js';
 export const id = () => crypto.randomUUID();
 export const createLogger = (domain) => {
-    return debug(`browserless:${domain}`);
+    return debug(`browserless.io:${domain}`);
 };
 const errorLog = createLogger('error');
 export const dedent = (strings, ...values) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@browserless.io/browserless",
-  "version": "2.0.0-beta-7",
+  "version": "2.1.0",
   "license": "SSPL",
   "description": "The browserless platform",
   "author": "browserless.io",
@@ -51,18 +51,18 @@
     "debug": "^4.3.2",
     "del": "^7.0.0",
     "enjoi": "^9.0.1",
-    "file-type": "^18.7.0",
+    "file-type": "^19.0.0",
     "get-port": "^7.0.0",
     "gradient-string": "^2.0.0",
     "http-proxy": "^1.18.1",
     "lighthouse": "^11.1.0",
     "micromatch": "^4.0.4",
-    "playwright-core": "^1.40.1",
+    "playwright-core": "^1.41.1",
     "puppeteer-core": "^21.6.1",
     "puppeteer-extra": "^3.3.6",
     "puppeteer-extra-plugin-stealth": "^2.11.2",
     "queue": "^7.0.0",
-    "systeminformation": "^5.21.20"
+    "systeminformation": "^5.21.24"
   },
   "optionalDependencies": {
     "@types/chai": "^4.3.11",
@@ -71,10 +71,10 @@
     "@types/http-proxy": "^1.17.14",
     "@types/micromatch": "^4.0.6",
     "@types/mocha": "^10.0.6",
-    "@types/node": "^20.10.8",
-    "@types/sinon": "^17.0.2",
-    "@typescript-eslint/eslint-plugin": "^6.18.1",
-    "@typescript-eslint/parser": "^6.18.1",
+    "@types/node": "^20.11.5",
+    "@types/sinon": "^17.0.3",
+    "@typescript-eslint/eslint-plugin": "^6.19.1",
+    "@typescript-eslint/parser": "^6.19.1",
     "assert": "^2.0.0",
     "chai": "^5.0.0",
     "cross-env": "^7.0.3",
@@ -88,8 +88,7 @@
     "marked": "^11.1.0",
     "mocha": "^10.0.0",
     "move-file": "^3.1.0",
-    "nodemon": "^3.0.2",
-    "prettier": "^3.1.1",
+    "prettier": "^3.2.4",
     "sinon": "^17.0.1",
     "ts-node": "^10.9.2",
     "typescript": "^5.3.3",
@@ -144,7 +143,7 @@
             "multiple",
             "single"
           ],
-          "allowSeparatedGroups": false
+          "allowSeparatedGroups": true
         }
       ]
     }

package/src/browsers/cdp-chromium.ts

@@ -319,12 +319,11 @@ export class CDPChromium extends EventEmitter {
       return null;
     }
 
+    const serverURL = new URL(this.config.getExternalWebSocketAddress());
     const wsURL = new URL(this.browserWSEndpoint);
-    const serverURL = new URL(this.config.getExternalAddress());
-
     wsURL.hostname = serverURL.hostname;
     wsURL.port = serverURL.port;
-    wsURL.protocol = serverURL.protocol === 'https' ? 'wss' : 'ws';
+
     if (token) {
       wsURL.searchParams.set('token', token);
     }

package/src/browsers/index.ts

@@ -82,6 +82,44 @@ export class BrowserManager {
     return dataDirPath;
   };
 
+  public getVersionJSON = async (): Promise<{
+    Browser: string;
+    'Debugger-Version': string;
+    'Protocol-Version': string;
+    'User-Agent': string;
+    'V8-Version': string;
+    'WebKit-Version': string;
+    webSocketDebuggerUrl: string;
+  }> => {
+    const browser = new CDPChromium({
+      blockAds: false,
+      config: this.config,
+      record: false,
+      userDataDir: null,
+    });
+    await browser.launch();
+    const wsEndpoint = browser.wsEndpoint();
+
+    if (!wsEndpoint) {
+      throw new Error('There was an error launching the browser');
+    }
+
+    const { port } = new URL(wsEndpoint);
+    const res = await fetch(`http://127.0.0.1:${port}/json/version`);
+    const meta = await res.json();
+
+    browser.close();
+
+    const { 'WebKit-Version': webkitVersion } = meta;
+    const debuggerVersion = webkitVersion.match(/\s\(@(\b[0-9a-f]{5,40}\b)/)[1];
+
+    return {
+      ...meta,
+      'Debugger-Version': debuggerVersion,
+      webSocketDebuggerUrl: this.config.getExternalWebSocketAddress(),
+    };
+  };
+
   private generateSessionJson = async (
     browser: BrowserInstance,
     session: BrowserlessSession,
@@ -201,8 +239,8 @@ export class BrowserManager {
     if (req.parsed.pathname.includes('/devtools/browser')) {
       const sessions = Array.from(this.browsers);
       const id = req.parsed.pathname.split('/').pop() as string;
-      const browser = sessions.find(
-        ([b]) => b.wsEndpoint()?.includes(req.parsed.pathname),
+      const browser = sessions.find(([b]) =>
+        b.wsEndpoint()?.includes(req.parsed.pathname),
       );
 
       if (browser) {

package/src/browsers/playwright-chromium.ts

@@ -111,12 +111,11 @@ export class PlaywrightChromium extends EventEmitter {
       return null;
     }
 
+    const serverURL = new URL(this.config.getExternalWebSocketAddress());
     const wsURL = new URL(this.browserWSEndpoint);
-    const serverURL = new URL(this.config.getExternalAddress());
-
     wsURL.hostname = serverURL.hostname;
     wsURL.port = serverURL.port;
-    wsURL.protocol = serverURL.protocol === 'https' ? 'wss' : 'ws';
+
     if (token) {
       wsURL.searchParams.set('token', token);
     }

package/src/browsers/playwright-firefox.ts

@@ -104,12 +104,11 @@ export class PlaywrightFirefox extends EventEmitter {
       return null;
     }
 
+    const serverURL = new URL(this.config.getExternalWebSocketAddress());
     const wsURL = new URL(this.browserWSEndpoint);
-    const serverURL = new URL(this.config.getExternalAddress());
-
     wsURL.hostname = serverURL.hostname;
     wsURL.port = serverURL.port;
-    wsURL.protocol = serverURL.protocol === 'https' ? 'wss' : 'ws';
+
     if (token) {
       wsURL.searchParams.set('token', token);
     }

package/src/browsers/playwright-webkit.ts

@@ -104,12 +104,11 @@ export class PlaywrightWebkit extends EventEmitter {
       return null;
     }
 
+    const serverURL = new URL(this.config.getExternalWebSocketAddress());
     const wsURL = new URL(this.browserWSEndpoint);
-    const serverURL = new URL(this.config.getExternalAddress());
-
     wsURL.hostname = serverURL.hostname;
     wsURL.port = serverURL.port;
-    wsURL.protocol = serverURL.protocol === 'https' ? 'wss' : 'ws';
+
     if (token) {
       wsURL.searchParams.set('token', token);
     }

package/src/config.ts

@@ -409,6 +409,23 @@ export class Config extends EventEmitter {
   public getExternalAddress = (): string =>
     this.external ?? this.getServerAddress();
 
+  /**
+   * Returns the the fully-qualified WebSocket URL for the
+   * external address that browserless might be
+   * running behind *or* the server address if
+   * no external URL is provided.
+   *
+   * @returns {string} The URL to reach the server
+   */
+  public getExternalWebSocketAddress = (): string => {
+    const httpAddress = new URL(this.external ?? this.getServerAddress());
+    httpAddress.protocol = httpAddress.protocol.startsWith('https')
+      ? 'wss:'
+      : 'ws:';
+
+    return httpAddress.href;
+  };
+
   /**
    * When CORS is enabled, returns relevant CORS headers
    * to requests and for the OPTIONS call. Values can be

package/src/file-system.spec.ts

@@ -4,7 +4,7 @@ import { expect } from 'chai';
 
 const filePath = '/tmp/_browserless_test_fs_';
 
-describe.only('File-System', () => {
+describe('File-System', () => {
   afterEach(async () => unlink(filePath));
 
   it('saves and encodes files', async () => {

package/src/http.ts

@@ -92,6 +92,7 @@ export enum HTTPRoutes {
   content = '/content',
   download = '/download',
   function = '/function',
+  jsonVersion = '/json/version',
   pdf = '/pdf',
   performance = '/performance',
   scrape = '/scrape',