@browserless.io/browserless 2.5.0-beta-4 → 2.6.0

package/build/http.d.ts

@@ -150,6 +150,7 @@ export declare enum HTTPRoutes {
     screenshot = "/screenshot"
 }
 export declare enum HTTPManagementRoutes {
+    active = "/active",
     config = "/config",
     metrics = "/metrics",
     metricsTotal = "/metrics/total",

package/build/http.js

@@ -115,6 +115,7 @@ export var HTTPRoutes;
 })(HTTPRoutes || (HTTPRoutes = {}));
 export var HTTPManagementRoutes;
 (function (HTTPManagementRoutes) {
+    HTTPManagementRoutes["active"] = "/active";
     HTTPManagementRoutes["config"] = "/config";
     HTTPManagementRoutes["metrics"] = "/metrics";
     HTTPManagementRoutes["metricsTotal"] = "/metrics/total";

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

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

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

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

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

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

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

@@ -398,7 +398,7 @@
           "type": "string"
         },
         "clip": {
-          "description": "Specifies the region of the page to clip.",
+          "description": "Specifies the region of the page/element to clip.",
           "$ref": "#/definitions/ScreenshotClip"
         },
         "encoding": {
@@ -484,14 +484,14 @@
                 "length": {
                   "type": "number"
                 },
-                "__@toStringTag@119846": {
+                "__@toStringTag@108895": {
                   "type": "string",
                   "const": "Uint8Array"
                 }
               },
               "required": [
                 "BYTES_PER_ELEMENT",
-                "__@toStringTag@119846",
+                "__@toStringTag@108895",
                 "buffer",
                 "byteLength",
                 "byteOffset",
@@ -526,13 +526,13 @@
         "byteLength": {
           "type": "number"
         },
-        "__@toStringTag@119846": {
+        "__@toStringTag@108895": {
           "type": "string"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@toStringTag@119846",
+        "__@toStringTag@108895",
         "byteLength"
       ]
     },
@@ -542,18 +542,18 @@
         "byteLength": {
           "type": "number"
         },
-        "__@species@119947": {
+        "__@species@108996": {
           "$ref": "#/definitions/SharedArrayBuffer"
         },
-        "__@toStringTag@119846": {
+        "__@toStringTag@108895": {
           "type": "string",
           "const": "SharedArrayBuffer"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@species@119947",
-        "__@toStringTag@119846",
+        "__@species@108996",
+        "__@toStringTag@108895",
         "byteLength"
       ]
     },

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

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

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

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

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

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

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

@@ -398,7 +398,7 @@
           "type": "string"
         },
         "clip": {
-          "description": "Specifies the region of the page to clip.",
+          "description": "Specifies the region of the page/element to clip.",
           "$ref": "#/definitions/ScreenshotClip"
         },
         "encoding": {
@@ -484,14 +484,14 @@
                 "length": {
                   "type": "number"
                 },
-                "__@toStringTag@239806": {
+                "__@toStringTag@240224": {
                   "type": "string",
                   "const": "Uint8Array"
                 }
               },
               "required": [
                 "BYTES_PER_ELEMENT",
-                "__@toStringTag@239806",
+                "__@toStringTag@240224",
                 "buffer",
                 "byteLength",
                 "byteOffset",
@@ -526,13 +526,13 @@
         "byteLength": {
           "type": "number"
         },
-        "__@toStringTag@239806": {
+        "__@toStringTag@240224": {
           "type": "string"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@toStringTag@239806",
+        "__@toStringTag@240224",
         "byteLength"
       ]
     },
@@ -542,18 +542,18 @@
         "byteLength": {
           "type": "number"
         },
-        "__@species@239907": {
+        "__@species@240325": {
           "$ref": "#/definitions/SharedArrayBuffer"
         },
-        "__@toStringTag@239806": {
+        "__@toStringTag@240224": {
           "type": "string",
           "const": "SharedArrayBuffer"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@species@239907",
-        "__@toStringTag@239806",
+        "__@species@240325",
+        "__@toStringTag@240224",
         "byteLength"
       ]
     },

package/build/routes/management/http/active.get.d.ts

@@ -0,0 +1,16 @@
+/// <reference types="node" />
+import { APITags, HTTPManagementRoutes, HTTPRoute, Methods, Request, contentTypes } from '@browserless.io/browserless';
+import { ServerResponse } from 'http';
+export default class ActiveGetRoute extends HTTPRoute {
+    name: string;
+    accepts: contentTypes[];
+    auth: boolean;
+    browser: null;
+    concurrency: boolean;
+    contentTypes: contentTypes[];
+    description: string;
+    method: Methods;
+    path: HTTPManagementRoutes;
+    tags: APITags[];
+    handler: (_req: Request, res: ServerResponse) => Promise<void>;
+}

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

@@ -0,0 +1,17 @@
+import { APITags, BrowserlessRoutes, HTTPManagementRoutes, HTTPRoute, Methods, contentTypes, dedent, writeResponse, } from '@browserless.io/browserless';
+export default class ActiveGetRoute extends HTTPRoute {
+    name = BrowserlessRoutes.ActiveGetRoute;
+    accepts = [contentTypes.any];
+    auth = true;
+    browser = null;
+    concurrency = false;
+    contentTypes = [contentTypes.text];
+    description = dedent(`
+    Returns a simple "204" HTTP code, with no response, indicating that the service itself is up and running.
+    Useful for liveliness probes or other external checks.
+  `);
+    method = Methods.get;
+    path = HTTPManagementRoutes.active;
+    tags = [APITags.management];
+    handler = async (_req, res) => writeResponse(res, 204, '', contentTypes.text);
+}

package/build/routes/management/tests/management.spec.js

@@ -38,4 +38,11 @@ describe('Management APIs', function () {
             expect(res.status).to.equal(200);
         });
     });
+    it('allows requests to /active', async () => {
+        await start();
+        await fetch('http://localhost:3000/active?token=6R0W53R135510').then(async (res) => {
+            expect(res.headers.get('content-type')).to.equal('text/plain; charset=UTF-8');
+            expect(res.status).to.equal(204);
+        });
+    });
 });

package/build/server.js

@@ -78,7 +78,7 @@ export class HTTPServer extends EventEmitter {
         }
         const route = await this.router.getRouteForHTTPRequest(req);
         if (!route) {
-            this.log(`No matching WebSocket route handler for "${req.parsed.href}"`);
+            this.log(`No matching HTTP route handler for "${req.method}: ${req.parsed.href}"`);
             writeResponse(res, 404, 'Not Found');
             return Promise.resolve();
         }

package/build/types.d.ts

@@ -100,7 +100,7 @@ declare abstract class Route {
      * and injected by browserless after initialization.
      * @returns BrowserManager
      */
-    browserManager: () => import("src/browsers").BrowserManager;
+    browserManager: () => import("@browserless.io/browserless").BrowserManager;
     /**
      * Helper function that loads the config module. Defined and injected by
      * browserless after initialization.
@@ -120,7 +120,7 @@ declare abstract class Route {
      * browserless after initialization.
      * @returns FileSystem
      */
-    fileSystem: () => import("src/file-system").FileSystem;
+    fileSystem: () => import("@browserless.io/browserless").FileSystem;
     /**
      * Helper function that loads the metrics module for
      * collecting and aggregating statistics. Defined and injected by
@@ -134,7 +134,7 @@ declare abstract class Route {
      * browserless after initialization.
      * @returns Monitor
      */
-    monitoring: () => import("src/monitoring").Monitoring;
+    monitoring: () => import("@browserless.io/browserless").Monitoring;
     /**
      * When running in an SDK environment, this returns the fully-qualified
      * directory of that static directory. When "null" then no SDK directory
@@ -166,7 +166,7 @@ declare abstract class BasicHTTPRoute extends Route {
      */
     abstract accepts: Array<contentTypes>;
     /**
-     * The Content-Types that this route will will respond with, and must match the Accepts
+     * The Content-Types that this route will respond with, and must match the Accepts
      * Header from a client if present. If a request comes in with an Accepts of "application/json"
      * then the contentTypes here would need to include ["application/json"] in order to not 404.
      */
@@ -515,6 +515,7 @@ export declare const BrowserlessWebKitRoutes: {
     WebKitPlaywrightWebSocketRoute: string;
 };
 export declare const BrowserlessManagementRoutes: {
+    ActiveGetRoute: string;
     ConfigGetRoute: string;
     MetricsGetRoute: string;
     MetricsTotalGetRoute: string;
@@ -522,6 +523,7 @@ export declare const BrowserlessManagementRoutes: {
     StaticGetRoute: string;
 };
 export declare const BrowserlessRoutes: {
+    ActiveGetRoute: string;
     ConfigGetRoute: string;
     MetricsGetRoute: string;
     MetricsTotalGetRoute: string;

package/build/types.js

@@ -189,6 +189,7 @@ export const BrowserlessWebKitRoutes = {
     WebKitPlaywrightWebSocketRoute: 'WebKitPlaywrightWebSocketRoute',
 };
 export const BrowserlessManagementRoutes = {
+    ActiveGetRoute: 'ActiveGetRoute',
     ConfigGetRoute: 'ConfigGetRoute',
     MetricsGetRoute: 'MetricsGetRoute',
     MetricsTotalGetRoute: 'MetricsTotalGetRoute',

package/build/utils.d.ts

@@ -79,7 +79,7 @@ export declare const waitForEvent: (page: Page, opts: WaitForEventOptions) => Pr
  */
 export declare const scrollThroughPage: (page: Page) => Promise<void>;
 export declare const noop: () => void;
-export declare const once: <A extends unknown[], R, T>(fn: (this: T, ...arg: A) => R) => (this: T, ...arg: A) => R | undefined;
+export declare const once: <A extends unknown[], R, T>(fn: (this: T, ...arg: A) => R) => ((this: T, ...arg: A) => R | undefined);
 export declare const getRandomNegativeInt: () => number;
 /**
  * Converts an inbound req.url string to a valid URL object.

package/docker/base/Dockerfile

@@ -6,7 +6,7 @@ ARG DEBIAN_FRONTEND=noninteractive
 ARG TZ=America/Los_Angeles
 ARG BLESS_USER_ID=999
 ARG APP_DIR=/usr/src/app
-ARG NODE_VERSION=v18.18.0
+ARG NODE_VERSION=v20.12.0
 
 ENV NODE_VERSION=$NODE_VERSION
 ENV NVM_DIR /usr/src/.nvm

package/extensions/ublock/1p-filters.html

@@ -22,15 +22,16 @@
 
 <div class="body">
     <div id="cloudWidget" class="hide" data-cloud-entry="myFiltersPane"></div>
-
-    <p class="vverbose"><span data-i18n="1pTrustWarning"></span>&ensp;<span data-i18n="1pFormatHint"></span>&thinsp;<a class="fa-icon info" href="https://github.com/gorhill/uBlock/wiki/Dashboard:-My-filters" target="_blank">question-circle</a></p>
     <p>
         <button id="userFiltersApply" class="preferred iconified" type="button" disabled><span class="fa-icon">check</span><span data-i18n="1pApplyChanges">_</span><span class="hover"></span></button>
         <button id="userFiltersRevert" class="iconified" type="button" disabled><span class="fa-icon">undo</span><span data-i18n="genericRevert">_</span><span class="hover"></span></button>
-        &ensp;
+        &emsp;
         <button id="importUserFiltersFromFile" class="iconified" type="button"><span class="fa-icon">download-alt</span><span data-i18n="1pImport">_</span><span class="hover"></span></button>
         <button id="exportUserFiltersToFile" class="iconified" type="button"><span class="fa-icon">upload-alt</span><span data-i18n="1pExport">_</span><span class="hover"></span></button>
     </p>
+    <p data-i18n="1pTrustWarning"></p>
+    <div class="li"><label><span id="enableMyFilters" class="input checkbox"><input type="checkbox"><svg viewBox="0 0 24 24"><path d="M1.73,12.91 8.1,19.28 22.79,4.59"/></svg></span><span data-i18n="1pEnableMyFiltersLabel"></span></label></div>
+    <div id="trustMyFilters" class="li"><label><span class="input checkbox"><input type="checkbox"><svg viewBox="0 0 24 24"><path d="M1.73,12.91 8.1,19.28 22.79,4.59"/></svg></span><span data-i18n="1pTrustMyFiltersLabel"></span></label></div>
 </div>
 <div id="userFilters" class="codeMirrorContainer codeMirrorBreakAll cm-theme-override" spellcheck="false"></div>
 <div class="hidden">