@browserless.io/browserless 2.20.0-beta-4 → 2.20.0

package/build/config.d.ts

@@ -39,6 +39,7 @@ export declare class Config extends EventEmitter {
     protected pwVersions: {
         [key: string]: string;
     };
+    protected enableDebugger: boolean;
     getRoutes(): string;
     getHost(): string;
     getPort(): number;

package/build/config.js

@@ -145,6 +145,7 @@ export class Config extends EventEmitter {
     timeoutAlertURL = process.env.TIMEOUT_ALERT_URL ?? null;
     errorAlertURL = process.env.ERROR_ALERT_URL ?? null;
     pwVersions = {};
+    enableDebugger = !!parseEnvVars(true, 'ENABLE_DEBUGGER');
     getRoutes() {
         return this.routes;
     }
@@ -221,8 +222,8 @@ export class Config extends EventEmitter {
     getErrorAlertURL() {
         return this.errorAlertURL;
     }
-    hasDebugger() {
-        return exists(this.debuggerDir);
+    async hasDebugger() {
+        return this.enableDebugger && (await exists(this.debuggerDir));
     }
     /**
      * If true, allows GET style calls on our browser-based APIs, using

package/build/router.js

@@ -143,7 +143,10 @@ export class Router extends EventEmitter {
     }
     async getRouteForHTTPRequest(req) {
         const accepts = (req.headers['accept']?.toLowerCase() || '*/*').split(',');
-        const contentType = req.headers['content-type']?.toLowerCase();
+        const contentType = req.headers['content-type']
+            ?.toLowerCase()
+            ?.split(';')
+            .shift();
         return (this.httpRoutes.find((r) => 
         // Once registered, paths are always an array here.
         r.path.some((p) => micromatch.isMatch(req.parsed.pathname, p)) &&

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

@@ -583,14 +583,14 @@
                 "length": {
                   "type": "number"
                 },
-                "__@toStringTag@84401": {
+                "__@toStringTag@112299": {
                   "type": "string",
                   "const": "Uint8Array"
                 }
               },
               "required": [
                 "BYTES_PER_ELEMENT",
-                "__@toStringTag@84401",
+                "__@toStringTag@112299",
                 "buffer",
                 "byteLength",
                 "byteOffset",
@@ -625,13 +625,13 @@
         "byteLength": {
           "type": "number"
         },
-        "__@toStringTag@84401": {
+        "__@toStringTag@112299": {
           "type": "string"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@toStringTag@84401",
+        "__@toStringTag@112299",
         "byteLength"
       ]
     },
@@ -641,18 +641,18 @@
         "byteLength": {
           "type": "number"
         },
-        "__@species@84439": {
+        "__@species@112337": {
           "$ref": "#/definitions/SharedArrayBuffer"
         },
-        "__@toStringTag@84401": {
+        "__@toStringTag@112299": {
           "type": "string",
           "const": "SharedArrayBuffer"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@species@84439",
-        "__@toStringTag@84401",
+        "__@species@112337",
+        "__@toStringTag@112299",
         "byteLength"
       ]
     },

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

@@ -485,14 +485,14 @@
                 "length": {
                   "type": "number"
                 },
-                "__@toStringTag@112631": {
+                "__@toStringTag@126514": {
                   "type": "string",
                   "const": "Uint8Array"
                 }
               },
               "required": [
                 "BYTES_PER_ELEMENT",
-                "__@toStringTag@112631",
+                "__@toStringTag@126514",
                 "buffer",
                 "byteLength",
                 "byteOffset",
@@ -527,13 +527,13 @@
         "byteLength": {
           "type": "number"
         },
-        "__@toStringTag@112631": {
+        "__@toStringTag@126514": {
           "type": "string"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@toStringTag@112631",
+        "__@toStringTag@126514",
         "byteLength"
       ]
     },
@@ -543,18 +543,18 @@
         "byteLength": {
           "type": "number"
         },
-        "__@species@112669": {
+        "__@species@126552": {
           "$ref": "#/definitions/SharedArrayBuffer"
         },
-        "__@toStringTag@112631": {
+        "__@toStringTag@126514": {
           "type": "string",
           "const": "SharedArrayBuffer"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@species@112669",
-        "__@toStringTag@112631",
+        "__@species@126552",
+        "__@toStringTag@126514",
         "byteLength"
       ]
     },

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

@@ -528,14 +528,14 @@
                 "length": {
                   "type": "number"
                 },
-                "__@toStringTag@140864": {
+                "__@toStringTag@140806": {
                   "type": "string",
                   "const": "Uint8Array"
                 }
               },
               "required": [
                 "BYTES_PER_ELEMENT",
-                "__@toStringTag@140864",
+                "__@toStringTag@140806",
                 "buffer",
                 "byteLength",
                 "byteOffset",
@@ -570,13 +570,13 @@
         "byteLength": {
           "type": "number"
         },
-        "__@toStringTag@140864": {
+        "__@toStringTag@140806": {
           "type": "string"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@toStringTag@140864",
+        "__@toStringTag@140806",
         "byteLength"
       ]
     },
@@ -586,18 +586,18 @@
         "byteLength": {
           "type": "number"
         },
-        "__@species@140902": {
+        "__@species@140844": {
           "$ref": "#/definitions/SharedArrayBuffer"
         },
-        "__@toStringTag@140864": {
+        "__@toStringTag@140806": {
           "type": "string",
           "const": "SharedArrayBuffer"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@species@140902",
-        "__@toStringTag@140864",
+        "__@species@140844",
+        "__@toStringTag@140806",
         "byteLength"
       ]
     },

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

@@ -438,14 +438,14 @@
                 "length": {
                   "type": "number"
                 },
-                "__@toStringTag@169023": {
+                "__@toStringTag@155008": {
                   "type": "string",
                   "const": "Uint8Array"
                 }
               },
               "required": [
                 "BYTES_PER_ELEMENT",
-                "__@toStringTag@169023",
+                "__@toStringTag@155008",
                 "buffer",
                 "byteLength",
                 "byteOffset",
@@ -480,13 +480,13 @@
         "byteLength": {
           "type": "number"
         },
-        "__@toStringTag@169023": {
+        "__@toStringTag@155008": {
           "type": "string"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@toStringTag@169023",
+        "__@toStringTag@155008",
         "byteLength"
       ]
     },
@@ -496,18 +496,18 @@
         "byteLength": {
           "type": "number"
         },
-        "__@species@169061": {
+        "__@species@155046": {
           "$ref": "#/definitions/SharedArrayBuffer"
         },
-        "__@toStringTag@169023": {
+        "__@toStringTag@155008": {
           "type": "string",
           "const": "SharedArrayBuffer"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@species@169061",
-        "__@toStringTag@169023",
+        "__@species@155046",
+        "__@toStringTag@155008",
         "byteLength"
       ]
     },

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

@@ -583,14 +583,14 @@
                 "length": {
                   "type": "number"
                 },
-                "__@toStringTag@253239": {
+                "__@toStringTag@267177": {
                   "type": "string",
                   "const": "Uint8Array"
                 }
               },
               "required": [
                 "BYTES_PER_ELEMENT",
-                "__@toStringTag@253239",
+                "__@toStringTag@267177",
                 "buffer",
                 "byteLength",
                 "byteOffset",
@@ -625,13 +625,13 @@
         "byteLength": {
           "type": "number"
         },
-        "__@toStringTag@253239": {
+        "__@toStringTag@267177": {
           "type": "string"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@toStringTag@253239",
+        "__@toStringTag@267177",
         "byteLength"
       ]
     },
@@ -641,18 +641,18 @@
         "byteLength": {
           "type": "number"
         },
-        "__@species@253277": {
+        "__@species@267215": {
           "$ref": "#/definitions/SharedArrayBuffer"
         },
-        "__@toStringTag@253239": {
+        "__@toStringTag@267177": {
           "type": "string",
           "const": "SharedArrayBuffer"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@species@253277",
-        "__@toStringTag@253239",
+        "__@species@267215",
+        "__@toStringTag@267177",
         "byteLength"
       ]
     },

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

@@ -485,14 +485,14 @@
                 "length": {
                   "type": "number"
                 },
-                "__@toStringTag@281463": {
+                "__@toStringTag@281389": {
                   "type": "string",
                   "const": "Uint8Array"
                 }
               },
               "required": [
                 "BYTES_PER_ELEMENT",
-                "__@toStringTag@281463",
+                "__@toStringTag@281389",
                 "buffer",
                 "byteLength",
                 "byteOffset",
@@ -527,13 +527,13 @@
         "byteLength": {
           "type": "number"
         },
-        "__@toStringTag@281463": {
+        "__@toStringTag@281389": {
           "type": "string"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@toStringTag@281463",
+        "__@toStringTag@281389",
         "byteLength"
       ]
     },
@@ -543,18 +543,18 @@
         "byteLength": {
           "type": "number"
         },
-        "__@species@281501": {
+        "__@species@281427": {
           "$ref": "#/definitions/SharedArrayBuffer"
         },
-        "__@toStringTag@281463": {
+        "__@toStringTag@281389": {
           "type": "string",
           "const": "SharedArrayBuffer"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@species@281501",
-        "__@toStringTag@281463",
+        "__@species@281427",
+        "__@toStringTag@281389",
         "byteLength"
       ]
     },

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

@@ -528,14 +528,14 @@
                 "length": {
                   "type": "number"
                 },
-                "__@toStringTag@323656": {
+                "__@toStringTag@309690": {
                   "type": "string",
                   "const": "Uint8Array"
                 }
               },
               "required": [
                 "BYTES_PER_ELEMENT",
-                "__@toStringTag@323656",
+                "__@toStringTag@309690",
                 "buffer",
                 "byteLength",
                 "byteOffset",
@@ -570,13 +570,13 @@
         "byteLength": {
           "type": "number"
         },
-        "__@toStringTag@323656": {
+        "__@toStringTag@309690": {
           "type": "string"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@toStringTag@323656",
+        "__@toStringTag@309690",
         "byteLength"
       ]
     },
@@ -586,18 +586,18 @@
         "byteLength": {
           "type": "number"
         },
-        "__@species@323694": {
+        "__@species@309728": {
           "$ref": "#/definitions/SharedArrayBuffer"
         },
-        "__@toStringTag@323656": {
+        "__@toStringTag@309690": {
           "type": "string",
           "const": "SharedArrayBuffer"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@species@323694",
-        "__@toStringTag@323656",
+        "__@species@309728",
+        "__@toStringTag@309690",
         "byteLength"
       ]
     },

package/build/routes/chromium/tests/content.spec.js

@@ -32,6 +32,29 @@ describe('/chromium/content API', function () {
             expect(res.status).to.equal(200);
         });
     });
+    it('allows requests with content-type charsets', async () => {
+        const config = new Config();
+        config.setToken('browserless');
+        const metrics = new Metrics();
+        await start({ config, metrics });
+        const body = {
+            url: 'https://example.com',
+        };
+        await fetch('http://localhost:3000/chromium/content?token=browserless', {
+            body: JSON.stringify(body),
+            headers: {
+                'content-type': 'application/json; charset=utf-8',
+            },
+            method: 'POST',
+        }).then((res) => {
+            expect(res.headers.get('x-response-code')).to.not.be.undefined;
+            expect(res.headers.get('x-response-url')).to.not.be.undefined;
+            expect(res.headers.get('x-response-ip')).to.not.be.undefined;
+            expect(res.headers.get('x-response-por')).to.not.be.undefined;
+            expect(res.headers.get('content-type')).to.equal('text/html; charset=UTF-8');
+            expect(res.status).to.equal(200);
+        });
+    });
     it('cancels request when they are closed early', async () => {
         const config = new Config();
         const metrics = new Metrics();

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

@@ -26,7 +26,7 @@ describe('/chromium/function API', function () {
         await fetch('http://localhost:3000/chromium/function?token=browserless', {
             body: JSON.stringify(body),
             headers: {
-                'content-type': 'application/json',
+                'content-type': 'application/json; charset=utf-8',
             },
             method: 'POST',
         }).then(async (res) => {

package/build/routes/chromium/tests/pdf.spec.js

@@ -20,7 +20,7 @@ describe('/chromium/pdf API', function () {
         await fetch('http://localhost:3000/chromium/pdf?token=browserless', {
             body: JSON.stringify(body),
             headers: {
-                'content-type': 'application/json',
+                'content-type': 'application/json; charset=utf-8',
             },
             method: 'POST',
         }).then((res) => {

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

@@ -44,6 +44,9 @@ export default class StaticGetRoute extends HTTPRoute {
             const sdkPath = path.join(sdkDir, pathname);
             locations.push(...[sdkPath, path.join(sdkPath, 'index.html')]);
         }
+        if (pathname.includes('/debugger/') && !(await config.hasDebugger())) {
+            throw new NotFound(`No route or file found for resource ${req.method}: ${pathname}`);
+        }
         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}`);

package/build/sdk-utils.js

@@ -36,11 +36,7 @@ export const getSourceFiles = async (cwd) => {
     const buildDir = path.join(cwd, 'build');
     const files = await fs.readdir(buildDir, { recursive: true });
     const [httpRoutes, webSocketRoutes] = files.reduce(([httpRoutes, webSocketRoutes], file) => {
-        const isInRootDir = !file.includes(path.sep);
         const parsed = path.parse(file);
-        if (isInRootDir) {
-            return [httpRoutes, webSocketRoutes];
-        }
         if (parsed.name.endsWith('http')) {
             httpRoutes.push(path.join(buildDir, file));
         }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@browserless.io/browserless",
-  "version": "2.20.0-beta-4",
+  "version": "2.20.0",
   "license": "SSPL",
   "description": "The browserless platform",
   "author": "browserless.io",
@@ -93,7 +93,7 @@
     "mocha": "^10.7.3",
     "move-file": "^3.1.0",
     "prettier": "^3.3.3",
-    "sinon": "^18.0.0",
+    "sinon": "^18.0.1",
     "ts-node": "^10.9.2",
     "typescript": "^5.6.2",
     "typescript-json-schema": "^0.65.1"

package/src/config.ts

@@ -175,6 +175,7 @@ export class Config extends EventEmitter {
   protected timeoutAlertURL = process.env.TIMEOUT_ALERT_URL ?? null;
   protected errorAlertURL = process.env.ERROR_ALERT_URL ?? null;
   protected pwVersions: { [key: string]: string } = {};
+  protected enableDebugger = !!parseEnvVars(true, 'ENABLE_DEBUGGER');
 
   public getRoutes(): string {
     return this.routes;
@@ -261,8 +262,8 @@ export class Config extends EventEmitter {
     return this.errorAlertURL;
   }
 
-  public hasDebugger(): Promise<boolean> {
-    return exists(this.debuggerDir);
+  public async hasDebugger(): Promise<boolean> {
+    return this.enableDebugger && (await exists(this.debuggerDir));
   }
 
   /**

package/src/router.ts

@@ -220,9 +220,10 @@ export class Router extends EventEmitter {
 
   public async getRouteForHTTPRequest(req: Request) {
     const accepts = (req.headers['accept']?.toLowerCase() || '*/*').split(',');
-    const contentType = req.headers['content-type']?.toLowerCase() as
-      | contentTypes
-      | undefined;
+    const contentType = req.headers['content-type']
+      ?.toLowerCase()
+      ?.split(';')
+      .shift() as contentTypes | undefined;
 
     return (
       this.httpRoutes.find(

package/src/routes/chromium/tests/content.spec.ts

@@ -48,6 +48,33 @@ describe('/chromium/content API', function () {
     });
   });
 
+  it('allows requests with content-type charsets', async () => {
+    const config = new Config();
+    config.setToken('browserless');
+    const metrics = new Metrics();
+    await start({ config, metrics });
+    const body = {
+      url: 'https://example.com',
+    };
+
+    await fetch('http://localhost:3000/chromium/content?token=browserless', {
+      body: JSON.stringify(body),
+      headers: {
+        'content-type': 'application/json; charset=utf-8',
+      },
+      method: 'POST',
+    }).then((res) => {
+      expect(res.headers.get('x-response-code')).to.not.be.undefined;
+      expect(res.headers.get('x-response-url')).to.not.be.undefined;
+      expect(res.headers.get('x-response-ip')).to.not.be.undefined;
+      expect(res.headers.get('x-response-por')).to.not.be.undefined;
+      expect(res.headers.get('content-type')).to.equal(
+        'text/html; charset=UTF-8',
+      );
+      expect(res.status).to.equal(200);
+    });
+  });
+
   it('cancels request when they are closed early', async () => {
     const config = new Config();
     const metrics = new Metrics();

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

@@ -34,7 +34,7 @@ describe('/chromium/function API', function () {
     await fetch('http://localhost:3000/chromium/function?token=browserless', {
       body: JSON.stringify(body),
       headers: {
-        'content-type': 'application/json',
+        'content-type': 'application/json; charset=utf-8',
       },
       method: 'POST',
     }).then(async (res) => {

package/src/routes/chromium/tests/pdf.spec.ts

@@ -28,7 +28,7 @@ describe('/chromium/pdf API', function () {
     await fetch('http://localhost:3000/chromium/pdf?token=browserless', {
       body: JSON.stringify(body),
       headers: {
-        'content-type': 'application/json',
+        'content-type': 'application/json; charset=utf-8',
       },
       method: 'POST',
     }).then((res) => {

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

@@ -83,6 +83,12 @@ export default class StaticGetRoute extends HTTPRoute {
       locations.push(...[sdkPath, path.join(sdkPath, 'index.html')]);
     }
 
+    if (pathname.includes('/debugger/') && !(await config.hasDebugger())) {
+      throw new NotFound(
+        `No route or file found for resource ${req.method}: ${pathname}`,
+      );
+    }
+
     const foundFilePaths = (
       await Promise.all(
         locations.map((l) => fileExists(l).then((e) => (e ? l : undefined))),

package/src/sdk-utils.ts

@@ -59,13 +59,7 @@ export const getSourceFiles = async (cwd: string) => {
   const files = await fs.readdir(buildDir, { recursive: true });
   const [httpRoutes, webSocketRoutes] = files.reduce(
     ([httpRoutes, webSocketRoutes], file) => {
-      const isInRootDir = !file.includes(path.sep);
       const parsed = path.parse(file);
-
-      if (isInRootDir) {
-        return [httpRoutes, webSocketRoutes];
-      }
-
       if (parsed.name.endsWith('http')) {
         httpRoutes.push(path.join(buildDir, file));
       }