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

package/src/routes/chrome/tests/function.spec.ts

@@ -46,6 +46,41 @@ describe('/chrome/function API', function () {
     });
   });
 
+  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/src/routes/management/http/static.get.ts

@@ -70,39 +70,49 @@ export default class StaticGetRoute extends HTTPRoute {
     }
 
     const config = this.config();
+    const sdkDir = this.staticSDKDir();
     const file = path.join(config.getStatic(), pathname);
     const indexFile = path.join(file, 'index.html');
+    const locations = [file, indexFile];
 
-    const filePath = (
-      await Promise.all([
-        fileExists(file).then((exists) => (exists ? file : undefined)),
-        fileExists(indexFile).then((exists) =>
-          exists ? indexFile : undefined,
-        ),
-      ])
-    ).find((_) => !!_);
+    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((_) => !!_) as string[];
 
-    if (!filePath) {
+    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`);
+    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(filePath));
+    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/src/types.ts

@@ -102,6 +102,7 @@ abstract class Route {
     protected _debug: Browserless['debug'],
     protected _metrics: Browserless['metrics'],
     protected _monitoring: Browserless['monitoring'],
+    protected _staticSDKDir: Browserless['staticSDKDir'],
   ) {}
 
   /**
@@ -195,6 +196,14 @@ abstract class Route {
    */
   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;
+
   /**
    * The HTTP path that this route handles, eg '/my-route' OR an
    * array of paths that this route can handle.

package/static/docs/swagger.json

@@ -225,14 +225,14 @@
                 "length": {
                   "type": "number"
                 },
-                "__@toStringTag@10908": {
+                "__@toStringTag@10910": {
                   "type": "string",
                   "const": "Uint8Array"
                 }
               },
               "required": [
                 "BYTES_PER_ELEMENT",
-                "__@toStringTag@10908",
+                "__@toStringTag@10910",
                 "buffer",
                 "byteLength",
                 "byteOffset",
@@ -267,13 +267,13 @@
         "byteLength": {
           "type": "number"
         },
-        "__@toStringTag@10908": {
+        "__@toStringTag@10910": {
           "type": "string"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@toStringTag@10908",
+        "__@toStringTag@10910",
         "byteLength"
       ]
     },
@@ -283,18 +283,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"
       ]
     },
@@ -1098,7 +1098,7 @@
   },
   "info": {
     "title": "Browserless",
-    "version": "2.3.0",
+    "version": "2.4.0-beta-1",
     "x-logo": {
       "altText": "browserless logo",
       "url": "./docs/browserless-logo-inline.svg"

package/static/docs/swagger.min.json

@@ -225,14 +225,14 @@
                 "length": {
                   "type": "number"
                 },
-                "__@toStringTag@10908": {
+                "__@toStringTag@10910": {
                   "type": "string",
                   "const": "Uint8Array"
                 }
               },
               "required": [
                 "BYTES_PER_ELEMENT",
-                "__@toStringTag@10908",
+                "__@toStringTag@10910",
                 "buffer",
                 "byteLength",
                 "byteOffset",
@@ -267,13 +267,13 @@
         "byteLength": {
           "type": "number"
         },
-        "__@toStringTag@10908": {
+        "__@toStringTag@10910": {
           "type": "string"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@toStringTag@10908",
+        "__@toStringTag@10910",
         "byteLength"
       ]
     },
@@ -283,18 +283,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"
       ]
     },
@@ -1098,7 +1098,7 @@
   },
   "info": {
     "title": "Browserless",
-    "version": "2.3.0",
+    "version": "2.4.0-beta-1",
     "x-logo": {
       "altText": "browserless logo",
       "url": "./docs/browserless-logo-inline.svg"