@browserless.io/browserless 2.24.0-beta-2 → 2.24.0-beta-4

package/build/utils.js

@@ -377,13 +377,14 @@ export const waitForEvent = async (page, opts) => {
     const awaitEvent = async (event) => {
         await new Promise((resolve) => {
             document.addEventListener(event, () => resolve(), { once: true });
+            window.addEventListener(event, () => resolve(), { once: true });
         });
     };
     const timeout = opts.timeout || 30000;
     await Promise.race([
         page.evaluate(awaitEvent, opts.event),
         sleep(timeout).then(() => {
-            throw new Error('Event awaiting timeout');
+            throw new Timeout(`Timed out waiting for event "${opts.event}"'`);
         }),
     ]);
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@browserless.io/browserless",
-  "version": "2.24.0-beta-2",
+  "version": "2.24.0-beta-4",
   "license": "SSPL",
   "description": "The browserless platform",
   "author": "browserless.io",
@@ -76,23 +76,23 @@
     "@types/http-proxy": "^1.17.15",
     "@types/micromatch": "^4.0.9",
     "@types/mocha": "^10.0.10",
-    "@types/node": "^22.9.3",
+    "@types/node": "^22.10.1",
     "@types/sinon": "^17.0.3",
-    "@typescript-eslint/eslint-plugin": "^8.15.0",
-    "@typescript-eslint/parser": "^8.15.0",
+    "@typescript-eslint/eslint-plugin": "^8.17.0",
+    "@typescript-eslint/parser": "^8.17.0",
     "assert": "^2.0.0",
     "chai": "^5.1.2",
     "cross-env": "^7.0.3",
     "env-cmd": "^10.1.0",
     "esbuild": "^0.24.0",
     "esbuild-plugin-polyfill-node": "^0.3.0",
-    "eslint": "^9.14.0",
+    "eslint": "^9.16.0",
     "extract-zip": "^2.0.1",
     "gunzip-maybe": "^1.4.2",
-    "marked": "^15.0.2",
-    "mocha": "^10.8.2",
+    "marked": "^15.0.3",
+    "mocha": "^11.0.1",
     "move-file": "^3.1.0",
-    "prettier": "^3.3.3",
+    "prettier": "^3.4.1",
     "sinon": "^19.0.2",
     "ts-node": "^10.9.2",
     "typescript": "^5.7.2",

package/src/http.ts

@@ -126,6 +126,7 @@ export enum HTTPRoutes {
 export enum HTTPManagementRoutes {
   active = '/active?(/)',
   config = '/config?(/)',
+  meta = '/meta?(/)',
   metrics = '/metrics?(/)',
   metricsTotal = '/metrics/total?(/)',
   pressure = '/pressure?(/)',

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

@@ -0,0 +1,102 @@
+import {
+  APITags,
+  BrowserlessRoutes,
+  ChromiumCDP,
+  FirefoxPlaywright,
+  HTTPManagementRoutes,
+  HTTPRoute,
+  Methods,
+  Request,
+  WebKitPlaywright,
+  availableBrowsers,
+  contentTypes,
+  jsonResponse,
+} from '@browserless.io/browserless';
+import { ServerResponse } from 'http';
+import { createRequire } from 'module';
+
+export interface ResponseSchema {
+  /**
+   * The semantic version of the Browserless API
+   */
+  version: string;
+
+  /**
+   * The version of Chromium installed, or null if not installed
+   */
+  chromium: string | null;
+
+  /**
+   * The version of Webkit installed, or null if not installed
+   */
+  webkit: string | null;
+
+  /**
+   * The version of Firefox installed, or null if not installed
+   */
+  firefox: string | null;
+
+  /**
+   * The supported version(s) of puppeteer
+   */
+  playwright: string[];
+
+  /**
+   * The supported version(s) of playwright
+   */
+  puppeteer: string[];
+}
+
+const semverReg = /(\*|\^|>|=|<|~)/gi;
+const require = createRequire(import.meta.url);
+const blessPackageJSON = require('../../../../package.json');
+const { browsers } =
+  require('../../../../node_modules/playwright-core/browsers.json') as {
+    browsers: [
+      {
+        name: string;
+        browserVersion: string;
+      },
+    ];
+  };
+const chromium = browsers.find((b) => b.name === 'chromium')!.browserVersion;
+const firefox = browsers.find((b) => b.name === 'firefox')!.browserVersion;
+const webkit = browsers.find((b) => b.name === 'webkit')!.browserVersion;
+const playwrightCore = blessPackageJSON.dependencies['playwright-core'].replace(
+  semverReg,
+  '',
+);
+const puppeteer = blessPackageJSON.dependencies['puppeteer-core'].replace(
+  semverReg,
+  '',
+);
+const playwright = Object.entries(blessPackageJSON.playwrightVersions)
+  .map(([, v]) => blessPackageJSON.dependencies[v as string])
+  .filter((_) => !!_)
+  .map((v) => v.match(/[0-9.]+/g).join(''))
+  .concat(playwrightCore);
+
+export default class MetaGetRoute extends HTTPRoute {
+  name = BrowserlessRoutes.MetaGetRoute;
+  accepts = [contentTypes.any];
+  auth = true;
+  browser = null;
+  concurrency = false;
+  contentTypes = [contentTypes.json];
+  description = `Returns a JSON payload of the current system versions, including the core API version.`;
+  method = Methods.get;
+  path = HTTPManagementRoutes.meta;
+  tags = [APITags.management];
+  async handler(_req: Request, res: ServerResponse): Promise<void> {
+    const installedBrowsers = await availableBrowsers;
+    const response: ResponseSchema = {
+      version: blessPackageJSON.version,
+      chromium: installedBrowsers.includes(ChromiumCDP) ? chromium : null,
+      firefox: installedBrowsers.includes(FirefoxPlaywright) ? firefox : null,
+      webkit: installedBrowsers.includes(WebKitPlaywright) ? webkit : null,
+      playwright: [...new Set(playwright)],
+      puppeteer: [puppeteer],
+    };
+    return jsonResponse(res, 200, response);
+  }
+}

package/src/routes/management/tests/management.spec.ts

@@ -30,6 +30,19 @@ describe('Management APIs', function () {
     );
   });
 
+  it('allows requests to /meta', async () => {
+    await start();
+
+    await fetch('http://localhost:3000/meta?token=6R0W53R135510').then(
+      async (res) => {
+        expect(res.headers.get('content-type')).to.equal(
+          'application/json; charset=UTF-8',
+        );
+        expect(res.status).to.equal(200);
+      },
+    );
+  });
+
   it('allows requests to /metrics', async () => {
     await start();
 

package/src/shared/utils/function/handler.ts

@@ -6,6 +6,7 @@ import {
   HTTPRoutes,
   Logger,
   Request,
+  ServerError,
   UnwrapPromise,
   contentTypes,
   convertIfBase64,
@@ -67,7 +68,9 @@ export default (config: Config, logger: Logger, options: HandlerOptions = {}) =>
     );
 
     if (!browserWSEndpoint) {
-      throw new Error(`No browser endpoint was found, is the browser running?`);
+      throw new ServerError(
+        `No browser endpoint was found, is the browser running?`,
+      );
     }
 
     const functionCodeJS = `browserless-function-${id()}.js`;

package/src/types.ts

@@ -661,6 +661,7 @@ export const BrowserlessWebKitRoutes = {
 export const BrowserlessManagementRoutes = {
   ActiveGetRoute: 'ActiveGetRoute',
   ConfigGetRoute: 'ConfigGetRoute',
+  MetaGetRoute: 'MetaGetRoute',
   MetricsGetRoute: 'MetricsGetRoute',
   MetricsTotalGetRoute: 'MetricsTotalGetRoute',
   PressureGetRoute: 'PressureGetRoute',

package/src/utils.ts

@@ -537,6 +537,7 @@ export const waitForEvent = async (
   const awaitEvent = async (event: string) => {
     await new Promise<void>((resolve) => {
       document.addEventListener(event, () => resolve(), { once: true });
+      window.addEventListener(event, () => resolve(), { once: true });
     });
   };
 
@@ -545,7 +546,7 @@ export const waitForEvent = async (
   await Promise.race([
     page.evaluate(awaitEvent, opts.event),
     sleep(timeout).then(() => {
-      throw new Error('Event awaiting timeout');
+      throw new Timeout(`Timed out waiting for event "${opts.event}"'`);
     }),
   ]);
 };

package/static/docs/swagger.json

@@ -255,14 +255,14 @@
                 "length": {
                   "type": "number"
                 },
-                "__@toStringTag@14497": {
+                "__@toStringTag@14520": {
                   "type": "string",
                   "const": "Uint8Array"
                 }
               },
               "required": [
                 "BYTES_PER_ELEMENT",
-                "__@toStringTag@14497",
+                "__@toStringTag@14520",
                 "buffer",
                 "byteLength",
                 "byteOffset",
@@ -297,13 +297,13 @@
         "byteLength": {
           "type": "number"
         },
-        "__@toStringTag@14497": {
+        "__@toStringTag@14520": {
           "type": "string"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@toStringTag@14497",
+        "__@toStringTag@14520",
         "byteLength"
       ]
     },
@@ -313,18 +313,18 @@
         "byteLength": {
           "type": "number"
         },
-        "__@species@14535": {
+        "__@species@14558": {
           "$ref": "#/definitions/SharedArrayBuffer"
         },
-        "__@toStringTag@14497": {
+        "__@toStringTag@14520": {
           "type": "string",
           "const": "SharedArrayBuffer"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@species@14535",
-        "__@toStringTag@14497",
+        "__@species@14558",
+        "__@toStringTag@14520",
         "byteLength"
       ]
     },
@@ -969,7 +969,7 @@
   },
   "info": {
     "title": "Browserless",
-    "version": "2.24.0-beta-2",
+    "version": "2.24.0-beta-4",
     "x-logo": {
       "altText": "browserless logo",
       "url": "./docs/browserless-logo-inline.svg"
@@ -5848,6 +5848,112 @@
         ]
       }
     },
+    "/meta": {
+      "get": {
+        "definitions": {},
+        "description": "Returns a JSON payload of the current system versions, including the core API version.",
+        "parameters": [],
+        "requestBody": {
+          "content": {}
+        },
+        "responses": {
+          "200": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "version": {
+                      "description": "The semantic version of the Browserless API",
+                      "type": "string"
+                    },
+                    "chromium": {
+                      "description": "The version of Chromium installed, or null if not installed",
+                      "type": [
+                        "null",
+                        "string"
+                      ]
+                    },
+                    "webkit": {
+                      "description": "The version of Webkit installed, or null if not installed",
+                      "type": [
+                        "null",
+                        "string"
+                      ]
+                    },
+                    "firefox": {
+                      "description": "The version of Firefox installed, or null if not installed",
+                      "type": [
+                        "null",
+                        "string"
+                      ]
+                    },
+                    "playwright": {
+                      "description": "The supported version(s) of puppeteer",
+                      "type": "array",
+                      "items": {
+                        "type": "string"
+                      }
+                    },
+                    "puppeteer": {
+                      "description": "The supported version(s) of playwright",
+                      "type": "array",
+                      "items": {
+                        "type": "string"
+                      }
+                    }
+                  },
+                  "additionalProperties": false,
+                  "required": [
+                    "chromium",
+                    "firefox",
+                    "playwright",
+                    "puppeteer",
+                    "version",
+                    "webkit"
+                  ],
+                  "$schema": "http://json-schema.org/draft-07/schema#"
+                }
+              }
+            }
+          },
+          "400": {
+            "code": 400,
+            "description": "The request contains errors or didn't properly encode content.",
+            "message": "HTTP/1.1 400 Bad Request"
+          },
+          "401": {
+            "code": 401,
+            "description": "The request is missing, or contains bad, authorization credentials.",
+            "message": "HTTP/1.1 401 Unauthorized"
+          },
+          "404": {
+            "code": 404,
+            "description": "Resource couldn't be found.",
+            "message": "HTTP/1.1 404 Not Found"
+          },
+          "408": {
+            "code": 408,
+            "description": "The request took has taken too long to process.",
+            "message": "HTTP/1.1 408 Request Timeout"
+          },
+          "429": {
+            "code": 429,
+            "description": "Too many requests are currently being processed.",
+            "message": "HTTP/1.1 429 Too Many Requests"
+          },
+          "500": {
+            "code": 500,
+            "description": "An internal error occurred when handling the request.",
+            "message": "HTTP/1.1 500 Internal Server Error"
+          }
+        },
+        "summary": "/meta",
+        "tags": [
+          "Management REST APIs"
+        ]
+      }
+    },
     "/metrics/total": {
       "get": {
         "definitions": {},

package/static/docs/swagger.min.json

@@ -255,14 +255,14 @@
                 "length": {
                   "type": "number"
                 },
-                "__@toStringTag@14497": {
+                "__@toStringTag@14520": {
                   "type": "string",
                   "const": "Uint8Array"
                 }
               },
               "required": [
                 "BYTES_PER_ELEMENT",
-                "__@toStringTag@14497",
+                "__@toStringTag@14520",
                 "buffer",
                 "byteLength",
                 "byteOffset",
@@ -297,13 +297,13 @@
         "byteLength": {
           "type": "number"
         },
-        "__@toStringTag@14497": {
+        "__@toStringTag@14520": {
           "type": "string"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@toStringTag@14497",
+        "__@toStringTag@14520",
         "byteLength"
       ]
     },
@@ -313,18 +313,18 @@
         "byteLength": {
           "type": "number"
         },
-        "__@species@14535": {
+        "__@species@14558": {
           "$ref": "#/definitions/SharedArrayBuffer"
         },
-        "__@toStringTag@14497": {
+        "__@toStringTag@14520": {
           "type": "string",
           "const": "SharedArrayBuffer"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@species@14535",
-        "__@toStringTag@14497",
+        "__@species@14558",
+        "__@toStringTag@14520",
         "byteLength"
       ]
     },
@@ -969,7 +969,7 @@
   },
   "info": {
     "title": "Browserless",
-    "version": "2.24.0-beta-2",
+    "version": "2.24.0-beta-4",
     "x-logo": {
       "altText": "browserless logo",
       "url": "./docs/browserless-logo-inline.svg"
@@ -5847,6 +5847,112 @@
         ]
       }
     },
+    "/meta": {
+      "get": {
+        "definitions": {},
+        "description": "Returns a JSON payload of the current system versions, including the core API version.",
+        "parameters": [],
+        "requestBody": {
+          "content": {}
+        },
+        "responses": {
+          "200": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "version": {
+                      "description": "The semantic version of the Browserless API",
+                      "type": "string"
+                    },
+                    "chromium": {
+                      "description": "The version of Chromium installed, or null if not installed",
+                      "type": [
+                        "null",
+                        "string"
+                      ]
+                    },
+                    "webkit": {
+                      "description": "The version of Webkit installed, or null if not installed",
+                      "type": [
+                        "null",
+                        "string"
+                      ]
+                    },
+                    "firefox": {
+                      "description": "The version of Firefox installed, or null if not installed",
+                      "type": [
+                        "null",
+                        "string"
+                      ]
+                    },
+                    "playwright": {
+                      "description": "The supported version(s) of puppeteer",
+                      "type": "array",
+                      "items": {
+                        "type": "string"
+                      }
+                    },
+                    "puppeteer": {
+                      "description": "The supported version(s) of playwright",
+                      "type": "array",
+                      "items": {
+                        "type": "string"
+                      }
+                    }
+                  },
+                  "additionalProperties": false,
+                  "required": [
+                    "chromium",
+                    "firefox",
+                    "playwright",
+                    "puppeteer",
+                    "version",
+                    "webkit"
+                  ],
+                  "$schema": "http://json-schema.org/draft-07/schema#"
+                }
+              }
+            }
+          },
+          "400": {
+            "code": 400,
+            "description": "The request contains errors or didn't properly encode content.",
+            "message": "HTTP/1.1 400 Bad Request"
+          },
+          "401": {
+            "code": 401,
+            "description": "The request is missing, or contains bad, authorization credentials.",
+            "message": "HTTP/1.1 401 Unauthorized"
+          },
+          "404": {
+            "code": 404,
+            "description": "Resource couldn't be found.",
+            "message": "HTTP/1.1 404 Not Found"
+          },
+          "408": {
+            "code": 408,
+            "description": "The request took has taken too long to process.",
+            "message": "HTTP/1.1 408 Request Timeout"
+          },
+          "429": {
+            "code": 429,
+            "description": "Too many requests are currently being processed.",
+            "message": "HTTP/1.1 429 Too Many Requests"
+          },
+          "500": {
+            "code": 500,
+            "description": "An internal error occurred when handling the request.",
+            "message": "HTTP/1.1 500 Internal Server Error"
+          }
+        },
+        "summary": "/meta",
+        "tags": [
+          "Management REST APIs"
+        ]
+      }
+    },
     "/metrics/total": {
       "get": {
         "definitions": {},