@browserless.io/browserless 2.26.1 → 2.27.0

package/CHANGELOG.md

@@ -1,6 +1,13 @@
-# [Latest](https://github.com/browserless/chrome/compare/v2.26.0...main)
+# [Latest](https://github.com/browserless/chrome/compare/v2.27.0...main)
 
 - Dependency updates.
+- New `MAX_PAYLOAD_SIZE` env variable for specifying a max-payload size in HTTP-based APIs. Value is a number specified in bytes, so `10485760` = 10MB.
+- Consolidation of HTTP and Websocket Error handling into a singular method.
+
+# [v2.26.1](https://github.com/browserless/chrome/compare/v2.26.0...v2.26.1)
+
+- Dependency updates.
+- Fix http routes being ignored in SDK projects.
 
 # [v2.26.0](https://github.com/browserless/chrome/compare/v2.25.2...v2.26.0)
 

package/build/config.d.ts

@@ -30,6 +30,7 @@ export declare class Config extends EventEmitter {
     protected corsMaxAge: number;
     protected maxCpu: number;
     protected maxMemory: number;
+    protected maxPayloadSize: number;
     protected healthCheck: boolean;
     protected failedHealthURL: string | null;
     protected queueAlertURL: string | null;
@@ -68,6 +69,7 @@ export declare class Config extends EventEmitter {
     getAllowFileProtocol(): boolean;
     getCPULimit(): number;
     getMemoryLimit(): number;
+    getMaxPayloadSize(): number;
     getHealthChecksEnabled(): boolean;
     getFailedHealthURL(): string | null;
     getQueueAlertURL(): string | null;
@@ -109,6 +111,7 @@ export declare class Config extends EventEmitter {
     setRetries(newRetries: number): number;
     setCPULimit(limit: number): number;
     setMemoryLimit(limit: number): number;
+    setMaxPayloadSize(limit: number): number;
     enableHealthChecks(enable: boolean): boolean;
     enableGETRequests(enable: boolean): boolean;
     enableCORS(enable: boolean): boolean;

package/build/config.js

@@ -10,7 +10,6 @@ const __dirname = path.dirname(fileURLToPath(import.meta.url));
 /**
  * configs to add:
  * EXIT_ON_HEALTH_FAILURE
- * MAX_PAYLOAD_SIZE
  */
 var oldConfig;
 (function (oldConfig) {
@@ -142,6 +141,7 @@ export class Config extends EventEmitter {
     corsMaxAge = +(process.env.CORS_MAX_AGE ?? '2592000');
     maxCpu = +(process.env.MAX_CPU_PERCENT ?? '99');
     maxMemory = +(process.env.MAX_MEMORY_PERCENT ?? '99');
+    maxPayloadSize = +(process.env.MAX_PAYLOAD_SIZE ?? '10485760'); // Default 10MB
     healthCheck = !!parseEnvVars(false, 'HEALTH');
     failedHealthURL = process.env.FAILED_HEALTH_URL ?? null;
     queueAlertURL = process.env.QUEUE_ALERT_URL ?? null;
@@ -208,6 +208,9 @@ export class Config extends EventEmitter {
     getMemoryLimit() {
         return this.maxMemory;
     }
+    getMaxPayloadSize() {
+        return this.maxPayloadSize;
+    }
     getHealthChecksEnabled() {
         return this.healthCheck;
     }
@@ -335,6 +338,10 @@ export class Config extends EventEmitter {
         this.emit('memoryLimit', limit);
         return (this.maxMemory = limit);
     }
+    setMaxPayloadSize(limit) {
+        this.emit('maxPayloadSize', limit);
+        return (this.maxPayloadSize = limit);
+    }
     enableHealthChecks(enable) {
         this.emit('healthCheck', enable);
         return (this.healthCheck = enable);

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

@@ -463,14 +463,14 @@
                 "length": {
                   "type": "number"
                 },
-                "__@toStringTag@14748": {
+                "__@toStringTag@14772": {
                   "type": "string",
                   "const": "Uint8Array"
                 }
               },
               "required": [
                 "BYTES_PER_ELEMENT",
-                "__@toStringTag@14748",
+                "__@toStringTag@14772",
                 "buffer",
                 "byteLength",
                 "byteOffset",
@@ -505,13 +505,13 @@
         "byteLength": {
           "type": "number"
         },
-        "__@toStringTag@14748": {
+        "__@toStringTag@14772": {
           "type": "string"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@toStringTag@14748",
+        "__@toStringTag@14772",
         "byteLength"
       ]
     },
@@ -521,18 +521,18 @@
         "byteLength": {
           "type": "number"
         },
-        "__@species@14786": {
+        "__@species@14810": {
           "$ref": "#/definitions/SharedArrayBuffer"
         },
-        "__@toStringTag@14748": {
+        "__@toStringTag@14772": {
           "type": "string",
           "const": "SharedArrayBuffer"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@species@14786",
-        "__@toStringTag@14748",
+        "__@species@14810",
+        "__@toStringTag@14772",
         "byteLength"
       ]
     },

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

@@ -608,14 +608,14 @@
                 "length": {
                   "type": "number"
                 },
-                "__@toStringTag@147141": {
+                "__@toStringTag@88296": {
                   "type": "string",
                   "const": "Uint8Array"
                 }
               },
               "required": [
                 "BYTES_PER_ELEMENT",
-                "__@toStringTag@147141",
+                "__@toStringTag@88296",
                 "buffer",
                 "byteLength",
                 "byteOffset",
@@ -650,13 +650,13 @@
         "byteLength": {
           "type": "number"
         },
-        "__@toStringTag@147141": {
+        "__@toStringTag@88296": {
           "type": "string"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@toStringTag@147141",
+        "__@toStringTag@88296",
         "byteLength"
       ]
     },
@@ -666,18 +666,18 @@
         "byteLength": {
           "type": "number"
         },
-        "__@species@147179": {
+        "__@species@88334": {
           "$ref": "#/definitions/SharedArrayBuffer"
         },
-        "__@toStringTag@147141": {
+        "__@toStringTag@88296": {
           "type": "string",
           "const": "SharedArrayBuffer"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@species@147179",
-        "__@toStringTag@147141",
+        "__@species@88334",
+        "__@toStringTag@88296",
         "byteLength"
       ]
     },

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

@@ -510,14 +510,14 @@
                 "length": {
                   "type": "number"
                 },
-                "__@toStringTag@117378": {
+                "__@toStringTag@176852": {
                   "type": "string",
                   "const": "Uint8Array"
                 }
               },
               "required": [
                 "BYTES_PER_ELEMENT",
-                "__@toStringTag@117378",
+                "__@toStringTag@176852",
                 "buffer",
                 "byteLength",
                 "byteOffset",
@@ -552,13 +552,13 @@
         "byteLength": {
           "type": "number"
         },
-        "__@toStringTag@117378": {
+        "__@toStringTag@176852": {
           "type": "string"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@toStringTag@117378",
+        "__@toStringTag@176852",
         "byteLength"
       ]
     },
@@ -568,18 +568,18 @@
         "byteLength": {
           "type": "number"
         },
-        "__@species@117416": {
+        "__@species@176890": {
           "$ref": "#/definitions/SharedArrayBuffer"
         },
-        "__@toStringTag@117378": {
+        "__@toStringTag@176852": {
           "type": "string",
           "const": "SharedArrayBuffer"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@species@117416",
-        "__@toStringTag@117378",
+        "__@species@176890",
+        "__@toStringTag@176852",
         "byteLength"
       ]
     },

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

@@ -553,14 +553,14 @@
                 "length": {
                   "type": "number"
                 },
-                "__@toStringTag@176630": {
+                "__@toStringTag@161988": {
                   "type": "string",
                   "const": "Uint8Array"
                 }
               },
               "required": [
                 "BYTES_PER_ELEMENT",
-                "__@toStringTag@176630",
+                "__@toStringTag@161988",
                 "buffer",
                 "byteLength",
                 "byteOffset",
@@ -595,13 +595,13 @@
         "byteLength": {
           "type": "number"
         },
-        "__@toStringTag@176630": {
+        "__@toStringTag@161988": {
           "type": "string"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@toStringTag@176630",
+        "__@toStringTag@161988",
         "byteLength"
       ]
     },
@@ -611,18 +611,18 @@
         "byteLength": {
           "type": "number"
         },
-        "__@species@176668": {
+        "__@species@162026": {
           "$ref": "#/definitions/SharedArrayBuffer"
         },
-        "__@toStringTag@176630": {
+        "__@toStringTag@161988": {
           "type": "string",
           "const": "SharedArrayBuffer"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@species@176668",
-        "__@toStringTag@176630",
+        "__@species@162026",
+        "__@toStringTag@161988",
         "byteLength"
       ]
     },

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

@@ -463,14 +463,14 @@
                 "length": {
                   "type": "number"
                 },
-                "__@toStringTag@132271": {
+                "__@toStringTag@147096": {
                   "type": "string",
                   "const": "Uint8Array"
                 }
               },
               "required": [
                 "BYTES_PER_ELEMENT",
-                "__@toStringTag@132271",
+                "__@toStringTag@147096",
                 "buffer",
                 "byteLength",
                 "byteOffset",
@@ -505,13 +505,13 @@
         "byteLength": {
           "type": "number"
         },
-        "__@toStringTag@132271": {
+        "__@toStringTag@147096": {
           "type": "string"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@toStringTag@132271",
+        "__@toStringTag@147096",
         "byteLength"
       ]
     },
@@ -521,18 +521,18 @@
         "byteLength": {
           "type": "number"
         },
-        "__@species@132309": {
+        "__@species@147134": {
           "$ref": "#/definitions/SharedArrayBuffer"
         },
-        "__@toStringTag@132271": {
+        "__@toStringTag@147096": {
           "type": "string",
           "const": "SharedArrayBuffer"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@species@132309",
-        "__@toStringTag@132271",
+        "__@species@147134",
+        "__@toStringTag@147096",
         "byteLength"
       ]
     },

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

@@ -608,14 +608,14 @@
                 "length": {
                   "type": "number"
                 },
-                "__@toStringTag@279235": {
+                "__@toStringTag@250383": {
                   "type": "string",
                   "const": "Uint8Array"
                 }
               },
               "required": [
                 "BYTES_PER_ELEMENT",
-                "__@toStringTag@279235",
+                "__@toStringTag@250383",
                 "buffer",
                 "byteLength",
                 "byteOffset",
@@ -650,13 +650,13 @@
         "byteLength": {
           "type": "number"
         },
-        "__@toStringTag@279235": {
+        "__@toStringTag@250383": {
           "type": "string"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@toStringTag@279235",
+        "__@toStringTag@250383",
         "byteLength"
       ]
     },
@@ -666,18 +666,18 @@
         "byteLength": {
           "type": "number"
         },
-        "__@species@279273": {
+        "__@species@250421": {
           "$ref": "#/definitions/SharedArrayBuffer"
         },
-        "__@toStringTag@279235": {
+        "__@toStringTag@250383": {
           "type": "string",
           "const": "SharedArrayBuffer"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@species@279273",
-        "__@toStringTag@279235",
+        "__@species@250421",
+        "__@toStringTag@250383",
         "byteLength"
       ]
     },

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

@@ -510,14 +510,14 @@
                 "length": {
                   "type": "number"
                 },
-                "__@toStringTag@308707": {
+                "__@toStringTag@294774": {
                   "type": "string",
                   "const": "Uint8Array"
                 }
               },
               "required": [
                 "BYTES_PER_ELEMENT",
-                "__@toStringTag@308707",
+                "__@toStringTag@294774",
                 "buffer",
                 "byteLength",
                 "byteOffset",
@@ -552,13 +552,13 @@
         "byteLength": {
           "type": "number"
         },
-        "__@toStringTag@308707": {
+        "__@toStringTag@294774": {
           "type": "string"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@toStringTag@308707",
+        "__@toStringTag@294774",
         "byteLength"
       ]
     },
@@ -568,18 +568,18 @@
         "byteLength": {
           "type": "number"
         },
-        "__@species@308745": {
+        "__@species@294812": {
           "$ref": "#/definitions/SharedArrayBuffer"
         },
-        "__@toStringTag@308707": {
+        "__@toStringTag@294774": {
           "type": "string",
           "const": "SharedArrayBuffer"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@species@308745",
-        "__@toStringTag@308707",
+        "__@species@294812",
+        "__@toStringTag@294774",
         "byteLength"
       ]
     },

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

@@ -553,14 +553,14 @@
                 "length": {
                   "type": "number"
                 },
-                "__@toStringTag@323621": {
+                "__@toStringTag@324333": {
                   "type": "string",
                   "const": "Uint8Array"
                 }
               },
               "required": [
                 "BYTES_PER_ELEMENT",
-                "__@toStringTag@323621",
+                "__@toStringTag@324333",
                 "buffer",
                 "byteLength",
                 "byteOffset",
@@ -595,13 +595,13 @@
         "byteLength": {
           "type": "number"
         },
-        "__@toStringTag@323621": {
+        "__@toStringTag@324333": {
           "type": "string"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@toStringTag@323621",
+        "__@toStringTag@324333",
         "byteLength"
       ]
     },
@@ -611,18 +611,18 @@
         "byteLength": {
           "type": "number"
         },
-        "__@species@323659": {
+        "__@species@324371": {
           "$ref": "#/definitions/SharedArrayBuffer"
         },
-        "__@toStringTag@323621": {
+        "__@toStringTag@324333": {
           "type": "string",
           "const": "SharedArrayBuffer"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@species@323659",
-        "__@toStringTag@323621",
+        "__@species@324371",
+        "__@toStringTag@324333",
         "byteLength"
       ]
     },

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

@@ -342,4 +342,28 @@ describe('/chromium/pdf API', function () {
             expect(res.status).to.equal(200);
         });
     });
+    it('returns 400 when payload size exceeds maximum allowed size', async () => {
+        const config = new Config();
+        config.setToken('browserless');
+        config.setMaxPayloadSize(100); // Set a very small max payload size for testing
+        const metrics = new Metrics();
+        await start({ config, metrics });
+        // Create a large payload that exceeds the 100 byte limit
+        const body = {
+            html: 'a'.repeat(200), // Create a 200 byte string
+        };
+        await fetch('http://localhost:3000/chromium/pdf?token=browserless', {
+            body: JSON.stringify(body),
+            headers: {
+                'content-type': 'application/json',
+            },
+            method: 'POST',
+        }).then(async (res) => {
+            const errorText = await res.text();
+            console.log(errorText);
+            expect(res.status).to.equal(400);
+            expect(errorText).to.include('Request payload size');
+            expect(errorText).to.include('exceeds maximum allowed size');
+        });
+    });
 });

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

@@ -463,14 +463,14 @@
                 "length": {
                   "type": "number"
                 },
-                "__@toStringTag@338451": {
+                "__@toStringTag@279896": {
                   "type": "string",
                   "const": "Uint8Array"
                 }
               },
               "required": [
                 "BYTES_PER_ELEMENT",
-                "__@toStringTag@338451",
+                "__@toStringTag@279896",
                 "buffer",
                 "byteLength",
                 "byteOffset",
@@ -505,13 +505,13 @@
         "byteLength": {
           "type": "number"
         },
-        "__@toStringTag@338451": {
+        "__@toStringTag@279896": {
           "type": "string"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@toStringTag@338451",
+        "__@toStringTag@279896",
         "byteLength"
       ]
     },
@@ -521,18 +521,18 @@
         "byteLength": {
           "type": "number"
         },
-        "__@species@338489": {
+        "__@species@279934": {
           "$ref": "#/definitions/SharedArrayBuffer"
         },
-        "__@toStringTag@338451": {
+        "__@toStringTag@279896": {
           "type": "string",
           "const": "SharedArrayBuffer"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@species@338489",
-        "__@toStringTag@338451",
+        "__@species@279934",
+        "__@toStringTag@279896",
         "byteLength"
       ]
     },

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

@@ -608,14 +608,14 @@
                 "length": {
                   "type": "number"
                 },
-                "__@toStringTag@411841": {
+                "__@toStringTag@471406": {
                   "type": "string",
                   "const": "Uint8Array"
                 }
               },
               "required": [
                 "BYTES_PER_ELEMENT",
-                "__@toStringTag@411841",
+                "__@toStringTag@471406",
                 "buffer",
                 "byteLength",
                 "byteOffset",
@@ -650,13 +650,13 @@
         "byteLength": {
           "type": "number"
         },
-        "__@toStringTag@411841": {
+        "__@toStringTag@471406": {
           "type": "string"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@toStringTag@411841",
+        "__@toStringTag@471406",
         "byteLength"
       ]
     },
@@ -666,18 +666,18 @@
         "byteLength": {
           "type": "number"
         },
-        "__@species@411879": {
+        "__@species@471444": {
           "$ref": "#/definitions/SharedArrayBuffer"
         },
-        "__@toStringTag@411841": {
+        "__@toStringTag@471406": {
           "type": "string",
           "const": "SharedArrayBuffer"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@species@411879",
-        "__@toStringTag@411841",
+        "__@species@471444",
+        "__@toStringTag@471406",
         "byteLength"
       ]
     },