@browserless.io/browserless 2.3.0 → 2.4.0-beta-1

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

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

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

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

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

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

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

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

package/build/routes/chrome/tests/function.spec.js

@@ -36,6 +36,38 @@ describe('/chrome/function API', function () {
             expect(res.status).to.equal(200);
         });
     });
+    it('runs functions with "context"', async () => {
+        const config = new Config();
+        config.setToken('browserless');
+        const metrics = new Metrics();
+        await start({ config, metrics });
+        const body = {
+            code: `export default async function ({ page, context }) {
+        if (!!context.ok) {
+          return Promise.resolve({
+            data: "ok",
+            type: "application/text",
+          });
+        }
+        return Promise.reject(new Error('Bad context!'));
+      }`,
+            context: {
+                ok: true,
+            },
+        };
+        await fetch('http://localhost:3000/chrome/function?token=browserless', {
+            body: JSON.stringify(body),
+            headers: {
+                'content-type': 'application/json',
+            },
+            method: 'POST',
+        }).then(async (res) => {
+            const json = await res.json();
+            expect(json).to.have.property('data');
+            expect(json.data).to.equal('ok');
+            expect(res.status).to.equal(200);
+        });
+    });
     it('runs "application/javascript" functions', async () => {
         const config = new Config();
         config.setToken('browserless');

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

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

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

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

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

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

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

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

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

@@ -38,26 +38,32 @@ export default class StaticGetRoute extends HTTPRoute {
             return streamFile(verbose, res, fileCache.path, fileCache.contentType);
         }
         const config = this.config();
+        const sdkDir = this.staticSDKDir();
         const file = path.join(config.getStatic(), pathname);
         const indexFile = path.join(file, 'index.html');
-        const filePath = (await Promise.all([
-            fileExists(file).then((exists) => (exists ? file : undefined)),
-            fileExists(indexFile).then((exists) => exists ? indexFile : undefined),
-        ])).find((_) => !!_);
-        if (!filePath) {
+        const locations = [file, indexFile];
+        if (sdkDir) {
+            const sdkPath = path.join(sdkDir, pathname);
+            locations.push(...[sdkPath, path.join(sdkPath, 'index.html')]);
+        }
+        const foundFilePaths = (await Promise.all(locations.map((l) => fileExists(l).then((e) => (e ? l : undefined))))).filter((_) => !!_);
+        if (!foundFilePaths.length) {
             throw new NotFound(`No route or file found for resource ${req.method}: ${pathname}`);
         }
-        verbose(`Found new file "${filePath}", caching path and serving`);
-        const contentType = mimeTypes.get(path.extname(filePath));
+        if (foundFilePaths.length > 1) {
+            debug(`Multiple files found for request to "${pathname}". Only the first file is served, so please name your files uniquely.`);
+        }
+        const [foundFilePath] = foundFilePaths;
+        verbose(`Found new file "${foundFilePath}", caching path and serving`);
+        const contentType = mimeTypes.get(path.extname(foundFilePath));
         if (contentType) {
             res.setHeader('Content-Type', contentType);
         }
-        // Cache the assets location so we don't have to
-        // do stat checks again when requests come back
+        // Cache the file as being found so we don't have to call 'stat'
         pathMap.set(pathname, {
             contentType,
-            path: filePath,
+            path: foundFilePath,
         });
-        return streamFile(verbose, res, filePath, contentType);
+        return streamFile(verbose, res, foundFilePath, contentType);
     };
 }

package/build/types.d.ts

@@ -55,7 +55,8 @@ declare abstract class Route {
     protected _debug: Browserless['debug'];
     protected _metrics: Browserless['metrics'];
     protected _monitoring: Browserless['monitoring'];
-    constructor(_browserManager: Browserless['browserManager'], _config: Browserless['config'], _fileSystem: Browserless['fileSystem'], _debug: Browserless['debug'], _metrics: Browserless['metrics'], _monitoring: Browserless['monitoring']);
+    protected _staticSDKDir: Browserless['staticSDKDir'];
+    constructor(_browserManager: Browserless['browserManager'], _config: Browserless['config'], _fileSystem: Browserless['fileSystem'], _debug: Browserless['debug'], _metrics: Browserless['metrics'], _monitoring: Browserless['monitoring'], _staticSDKDir: Browserless['staticSDKDir']);
     /**
      * A unique name to identify this route. Used in downstream
      * SDKs to potentially remove or disable.
@@ -134,6 +135,13 @@ declare abstract class Route {
      * @returns Monitor
      */
     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
+     * has been set.
+     * @returns {string | null} The full path location of the SDK's static directory
+     */
+    staticSDKDir: () => string | null;
     /**
      * The HTTP path that this route handles, eg '/my-route' OR an
      * array of paths that this route can handle.

package/build/types.js

@@ -5,13 +5,15 @@ class Route {
     _debug;
     _metrics;
     _monitoring;
-    constructor(_browserManager, _config, _fileSystem, _debug, _metrics, _monitoring) {
+    _staticSDKDir;
+    constructor(_browserManager, _config, _fileSystem, _debug, _metrics, _monitoring, _staticSDKDir) {
         this._browserManager = _browserManager;
         this._config = _config;
         this._fileSystem = _fileSystem;
         this._debug = _debug;
         this._metrics = _metrics;
         this._monitoring = _monitoring;
+        this._staticSDKDir = _staticSDKDir;
     }
     /**
      * A boolean, or a function that returns a boolean, on
@@ -86,6 +88,13 @@ class Route {
      * @returns Monitor
      */
     monitoring = () => this._monitoring;
+    /**
+     * When running in an SDK environment, this returns the fully-qualified
+     * directory of that static directory. When "null" then no SDK directory
+     * has been set.
+     * @returns {string | null} The full path location of the SDK's static directory
+     */
+    staticSDKDir = () => this._staticSDKDir;
 }
 /**
  * A primitive HTTP-based route that doesn't require a

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@browserless.io/browserless",
-  "version": "2.3.0",
+  "version": "2.4.0-beta-1",
   "license": "SSPL",
   "description": "The browserless platform",
   "author": "browserless.io",
@@ -57,7 +57,7 @@
     "http-proxy": "^1.18.1",
     "lighthouse": "^11.1.0",
     "micromatch": "^4.0.4",
-    "playwright-core": "^1.42.0",
+    "playwright-core": "^1.42.1",
     "puppeteer-core": "^22.3.0",
     "puppeteer-extra": "^3.3.6",
     "puppeteer-extra-plugin-stealth": "^2.11.2",
@@ -71,7 +71,7 @@
     "@types/http-proxy": "^1.17.14",
     "@types/micromatch": "^4.0.6",
     "@types/mocha": "^10.0.6",
-    "@types/node": "^20.11.22",
+    "@types/node": "^20.11.24",
     "@types/sinon": "^17.0.3",
     "@typescript-eslint/eslint-plugin": "^7.1.0",
     "@typescript-eslint/parser": "^7.1.0",

package/src/browserless.ts

@@ -53,6 +53,7 @@ export class Browserless {
   protected router: Router;
   protected token: Token;
   protected webhooks: WebHooks;
+  protected staticSDKDir: string | null = null;
 
   disabledRouteNames: string[] = [];
   webSocketRouteFiles: string[] = [];
@@ -149,6 +150,10 @@ export class Browserless {
     return this.disabledRouteNames.some((name) => name === route.name);
   }
 
+  public setStaticSDKDir(dir: string) {
+    this.staticSDKDir = dir;
+  }
+
   public disableRoutes(...routeNames: string[]) {
     this.disabledRouteNames.push(...routeNames);
   }
@@ -226,6 +231,7 @@ export class Browserless {
           logger,
           this.metrics,
           this.monitoring,
+          this.staticSDKDir,
         );
 
         if (!this.routeIsDisabled(route)) {
@@ -236,6 +242,7 @@ export class Browserless {
           route.monitoring = () => this.monitoring;
           route.fileSystem = () => this.fileSystem;
           route.debug = () => logger;
+          route.staticSDKDir = () => this.staticSDKDir;
 
           httpRoutes.push(route);
         }
@@ -277,6 +284,7 @@ export class Browserless {
           logger,
           this.metrics,
           this.monitoring,
+          this.staticSDKDir,
         );
 
         if (!this.routeIsDisabled(route)) {
@@ -286,6 +294,7 @@ export class Browserless {
           route.monitoring = () => this.monitoring;
           route.fileSystem = () => this.fileSystem;
           route.debug = () => logger;
+          route.staticSDKDir = () => this.staticSDKDir;
 
           wsRoutes.push(route);
         }