@browserless.io/browserless 2.33.0 → 2.34.0

package/CHANGELOG.md

@@ -1,7 +1,19 @@
-# [Latest](https://github.com/browserless/chrome/compare/v2.33.0...main)
+# [Latest](https://github.com/browserless/chrome/compare/v2.34.0...main)
 
 - Dependency updates.
 
+# [v2.34.0](https://github.com/browserless/chrome/compare/v2.33.0...v2.34.0)
+
+- Dependency updates.
+- README spelling fixes.
+- Bumps `puppeteer-core` to `24.16.0`.
+- Bumps `playwright-core` to `1.54.2`.
+- Updates the /pressure API to return a `503` error when under load and the `Accept` header is `text/plain`. All other headers for "Accept" are treated similarly.
+- Internally, when Authorization is sent via the `token` query-parameter, browserless now migrates it to a more secure `Authorization` header before processing the request. This prevents accidental logging in source as well as SDK projects.
+- Supports a `before` hook in routes so that pre-route logic can be applied before the request is handled by the route.
+- Fixes an issue in API's where a `requestInterceptor` has a `body` with base64 encoded content. This is now properly handled and fulfills the request.
+- Minor internal changes and spec file updates.
+
 # [v2.33.0](https://github.com/browserless/chrome/compare/v2.32.1...v2.33.0)
 
 - Dependency updates.

package/README.md

@@ -134,7 +134,7 @@ const browser = await puppeteer.connect({
 
 ### Playwright
 
-We support running with playwright via their their browser's remote connection protocols interface out of the box. Just make sure that your Docker image, playwright browser type _and_ endpoint match:
+We support running with playwright via their browser's remote connection protocols interface out of the box. Just make sure that your Docker image, playwright browser type _and_ endpoint match:
 
 **Before**
 

package/build/config.d.ts

@@ -149,7 +149,7 @@ export declare class Config extends EventEmitter {
      * Set the external URL, which Browserless uses for encoding
      * URLs over the HOST:PORT that it's bound to.
      *
-     * @param address The fully-qualified URL, eg https://www.example.com/
+     * @param address The fully-qualified URL, eg https://www.one.one.one.one.com/
      * @returns {string} The address
      */
     setExternalAddress(address: string): string;

package/build/config.js

@@ -430,7 +430,7 @@ export class Config extends EventEmitter {
      * Set the external URL, which Browserless uses for encoding
      * URLs over the HOST:PORT that it's bound to.
      *
-     * @param address The fully-qualified URL, eg https://www.example.com/
+     * @param address The fully-qualified URL, eg https://www.one.one.one.one.com/
      * @returns {string} The address
      */
     setExternalAddress(address) {

package/build/http.d.ts

@@ -31,6 +31,11 @@ export declare const errorCodes: {
         readonly description: "An internal error occurred when handling the request.";
         readonly message: "HTTP/1.1 500 Internal Server Error";
     };
+    readonly 503: {
+        readonly code: 503;
+        readonly description: "Service is unavailable.";
+        readonly message: "HTTP/1.1 503 Service Unavailable";
+    };
 };
 export declare const okCodes: {
     readonly 200: {
@@ -85,6 +90,11 @@ export declare const codes: {
         readonly description: "An internal error occurred when handling the request.";
         readonly message: "HTTP/1.1 500 Internal Server Error";
     };
+    readonly 503: {
+        readonly code: 503;
+        readonly description: "Service is unavailable.";
+        readonly message: "HTTP/1.1 503 Service Unavailable";
+    };
 };
 export declare enum contentTypes {
     any = "*/*",

package/build/http.js

@@ -29,6 +29,11 @@ export const errorCodes = {
         description: `An internal error occurred when handling the request.`,
         message: 'HTTP/1.1 500 Internal Server Error',
     },
+    503: {
+        code: 503,
+        description: `Service is unavailable.`,
+        message: 'HTTP/1.1 503 Service Unavailable',
+    },
 };
 export const okCodes = {
     200: {

package/build/limiter.spec.js

@@ -21,7 +21,7 @@ describe(`Limiter`, () => {
     it('limits and queues function calls, calls hooks, and calls queue alert urls', async () => {
         return new Promise((resolve, reject) => {
             const config = new Config();
-            config.setQueueAlertURL('https://example.com');
+            config.setQueueAlertURL('https://one.one.one.one');
             const monitoring = new Monitoring(config);
             const metrics = new Metrics();
             config.setConcurrent(1);

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

@@ -86,7 +86,24 @@
             "type": "string"
           },
           "response": {
-            "$ref": "#/definitions/Partial<ResponseForRequest>"
+            "additionalProperties": false,
+            "type": "object",
+            "properties": {
+              "headers": {
+                "description": "Optional response headers.\n\nThe record values will be converted to string following:\nArrays' values will be mapped to String\n(Used when you need multiple headers with the same name).\nNon-arrays will be converted to String.",
+                "$ref": "#/definitions/Record<string,unknown>"
+              },
+              "status": {
+                "type": "number"
+              },
+              "contentType": {
+                "type": "string"
+              },
+              "body": {
+                "description": "A string representation of the body to return. Can be a base64-encoded\nstring but please omit any leading content-type data (eg \"data:image/png;base64,\").",
+                "type": "string"
+              }
+            }
           }
         },
         "additionalProperties": false,
@@ -425,118 +442,10 @@
         "reason"
       ]
     },
-    "Partial<ResponseForRequest>": {
-      "type": "object",
-      "properties": {
-        "status": {
-          "type": "number"
-        },
-        "headers": {
-          "description": "Optional response headers.\n\nThe record values will be converted to string following:\nArrays' values will be mapped to String\n(Used when you need multiple headers with the same name).\nNon-arrays will be converted to String.",
-          "$ref": "#/definitions/Record<string,unknown>"
-        },
-        "contentType": {
-          "type": "string"
-        },
-        "body": {
-          "anyOf": [
-            {
-              "type": "object",
-              "additionalProperties": false,
-              "patternProperties": {
-                "^[0-9]+$": {
-                  "type": "number"
-                }
-              },
-              "properties": {
-                "BYTES_PER_ELEMENT": {
-                  "type": "number"
-                },
-                "buffer": {
-                  "$ref": "#/definitions/ArrayBufferLike"
-                },
-                "byteLength": {
-                  "type": "number"
-                },
-                "byteOffset": {
-                  "type": "number"
-                },
-                "length": {
-                  "type": "number"
-                },
-                "__@toStringTag@6502": {
-                  "type": "string",
-                  "const": "Uint8Array"
-                }
-              },
-              "required": [
-                "BYTES_PER_ELEMENT",
-                "__@toStringTag@6502",
-                "buffer",
-                "byteLength",
-                "byteOffset",
-                "length"
-              ]
-            },
-            {
-              "type": "string"
-            }
-          ]
-        }
-      },
-      "additionalProperties": false
-    },
     "Record<string,unknown>": {
       "type": "object",
       "additionalProperties": false
     },
-    "ArrayBufferLike": {
-      "anyOf": [
-        {
-          "$ref": "#/definitions/ArrayBuffer"
-        },
-        {
-          "$ref": "#/definitions/SharedArrayBuffer"
-        }
-      ]
-    },
-    "ArrayBuffer": {
-      "type": "object",
-      "properties": {
-        "byteLength": {
-          "type": "number"
-        },
-        "__@toStringTag@6502": {
-          "type": "string"
-        }
-      },
-      "additionalProperties": false,
-      "required": [
-        "__@toStringTag@6502",
-        "byteLength"
-      ]
-    },
-    "SharedArrayBuffer": {
-      "type": "object",
-      "properties": {
-        "byteLength": {
-          "type": "number"
-        },
-        "__@species@15689": {
-          "$ref": "#/definitions/SharedArrayBuffer"
-        },
-        "__@toStringTag@6502": {
-          "type": "string",
-          "const": "SharedArrayBuffer"
-        }
-      },
-      "additionalProperties": false,
-      "required": [
-        "__@species@15689",
-        "__@toStringTag@6502",
-        "byteLength"
-      ]
-    },
     "Record<string,string>": {
       "type": "object",
       "additionalProperties": false

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

@@ -89,7 +89,24 @@
             "type": "string"
           },
           "response": {
-            "$ref": "#/definitions/Partial<ResponseForRequest>"
+            "additionalProperties": false,
+            "type": "object",
+            "properties": {
+              "headers": {
+                "description": "Optional response headers.\n\nThe record values will be converted to string following:\nArrays' values will be mapped to String\n(Used when you need multiple headers with the same name).\nNon-arrays will be converted to String.",
+                "$ref": "#/definitions/Record<string,unknown>"
+              },
+              "status": {
+                "type": "number"
+              },
+              "contentType": {
+                "type": "string"
+              },
+              "body": {
+                "description": "A string representation of the body to return. Can be a base64-encoded\nstring but please omit any leading content-type data (eg \"data:image/png;base64,\").",
+                "type": "string"
+              }
+            }
           }
         },
         "additionalProperties": false,
@@ -570,118 +587,10 @@
       },
       "additionalProperties": false
     },
-    "Partial<ResponseForRequest>": {
-      "type": "object",
-      "properties": {
-        "status": {
-          "type": "number"
-        },
-        "headers": {
-          "description": "Optional response headers.\n\nThe record values will be converted to string following:\nArrays' values will be mapped to String\n(Used when you need multiple headers with the same name).\nNon-arrays will be converted to String.",
-          "$ref": "#/definitions/Record<string,unknown>"
-        },
-        "contentType": {
-          "type": "string"
-        },
-        "body": {
-          "anyOf": [
-            {
-              "type": "object",
-              "additionalProperties": false,
-              "patternProperties": {
-                "^[0-9]+$": {
-                  "type": "number"
-                }
-              },
-              "properties": {
-                "BYTES_PER_ELEMENT": {
-                  "type": "number"
-                },
-                "buffer": {
-                  "$ref": "#/definitions/ArrayBufferLike"
-                },
-                "byteLength": {
-                  "type": "number"
-                },
-                "byteOffset": {
-                  "type": "number"
-                },
-                "length": {
-                  "type": "number"
-                },
-                "__@toStringTag@115454": {
-                  "type": "string",
-                  "const": "Uint8Array"
-                }
-              },
-              "required": [
-                "BYTES_PER_ELEMENT",
-                "__@toStringTag@115454",
-                "buffer",
-                "byteLength",
-                "byteOffset",
-                "length"
-              ]
-            },
-            {
-              "type": "string"
-            }
-          ]
-        }
-      },
-      "additionalProperties": false
-    },
     "Record<string,unknown>": {
       "type": "object",
       "additionalProperties": false
     },
-    "ArrayBufferLike": {
-      "anyOf": [
-        {
-          "$ref": "#/definitions/ArrayBuffer"
-        },
-        {
-          "$ref": "#/definitions/SharedArrayBuffer"
-        }
-      ]
-    },
-    "ArrayBuffer": {
-      "type": "object",
-      "properties": {
-        "byteLength": {
-          "type": "number"
-        },
-        "__@toStringTag@115454": {
-          "type": "string"
-        }
-      },
-      "additionalProperties": false,
-      "required": [
-        "__@toStringTag@115454",
-        "byteLength"
-      ]
-    },
-    "SharedArrayBuffer": {
-      "type": "object",
-      "properties": {
-        "byteLength": {
-          "type": "number"
-        },
-        "__@species@124664": {
-          "$ref": "#/definitions/SharedArrayBuffer"
-        },
-        "__@toStringTag@115454": {
-          "type": "string",
-          "const": "SharedArrayBuffer"
-        }
-      },
-      "additionalProperties": false,
-      "required": [
-        "__@species@124664",
-        "__@toStringTag@115454",
-        "byteLength"
-      ]
-    },
     "Record<string,string>": {
       "type": "object",
       "additionalProperties": false

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

@@ -95,7 +95,24 @@
             "type": "string"
           },
           "response": {
-            "$ref": "#/definitions/Partial<ResponseForRequest>"
+            "additionalProperties": false,
+            "type": "object",
+            "properties": {
+              "headers": {
+                "description": "Optional response headers.\n\nThe record values will be converted to string following:\nArrays' values will be mapped to String\n(Used when you need multiple headers with the same name).\nNon-arrays will be converted to String.",
+                "$ref": "#/definitions/Record<string,unknown>"
+              },
+              "status": {
+                "type": "number"
+              },
+              "contentType": {
+                "type": "string"
+              },
+              "body": {
+                "description": "A string representation of the body to return. Can be a base64-encoded\nstring but please omit any leading content-type data (eg \"data:image/png;base64,\").",
+                "type": "string"
+              }
+            }
           }
         },
         "additionalProperties": false,
@@ -472,118 +489,10 @@
         "reason"
       ]
     },
-    "Partial<ResponseForRequest>": {
-      "type": "object",
-      "properties": {
-        "status": {
-          "type": "number"
-        },
-        "headers": {
-          "description": "Optional response headers.\n\nThe record values will be converted to string following:\nArrays' values will be mapped to String\n(Used when you need multiple headers with the same name).\nNon-arrays will be converted to String.",
-          "$ref": "#/definitions/Record<string,unknown>"
-        },
-        "contentType": {
-          "type": "string"
-        },
-        "body": {
-          "anyOf": [
-            {
-              "type": "object",
-              "additionalProperties": false,
-              "patternProperties": {
-                "^[0-9]+$": {
-                  "type": "number"
-                }
-              },
-              "properties": {
-                "BYTES_PER_ELEMENT": {
-                  "type": "number"
-                },
-                "buffer": {
-                  "$ref": "#/definitions/ArrayBufferLike"
-                },
-                "byteLength": {
-                  "type": "number"
-                },
-                "byteOffset": {
-                  "type": "number"
-                },
-                "length": {
-                  "type": "number"
-                },
-                "__@toStringTag@146752": {
-                  "type": "string",
-                  "const": "Uint8Array"
-                }
-              },
-              "required": [
-                "BYTES_PER_ELEMENT",
-                "__@toStringTag@146752",
-                "buffer",
-                "byteLength",
-                "byteOffset",
-                "length"
-              ]
-            },
-            {
-              "type": "string"
-            }
-          ]
-        }
-      },
-      "additionalProperties": false
-    },
     "Record<string,unknown>": {
       "type": "object",
       "additionalProperties": false
     },
-    "ArrayBufferLike": {
-      "anyOf": [
-        {
-          "$ref": "#/definitions/ArrayBuffer"
-        },
-        {
-          "$ref": "#/definitions/SharedArrayBuffer"
-        }
-      ]
-    },
-    "ArrayBuffer": {
-      "type": "object",
-      "properties": {
-        "byteLength": {
-          "type": "number"
-        },
-        "__@toStringTag@146752": {
-          "type": "string"
-        }
-      },
-      "additionalProperties": false,
-      "required": [
-        "__@toStringTag@146752",
-        "byteLength"
-      ]
-    },
-    "SharedArrayBuffer": {
-      "type": "object",
-      "properties": {
-        "byteLength": {
-          "type": "number"
-        },
-        "__@species@155949": {
-          "$ref": "#/definitions/SharedArrayBuffer"
-        },
-        "__@toStringTag@146752": {
-          "type": "string",
-          "const": "SharedArrayBuffer"
-        }
-      },
-      "additionalProperties": false,
-      "required": [
-        "__@species@155949",
-        "__@toStringTag@146752",
-        "byteLength"
-      ]
-    },
     "Record<string,string>": {
       "type": "object",
       "additionalProperties": false

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

@@ -89,7 +89,24 @@
             "type": "string"
           },
           "response": {
-            "$ref": "#/definitions/Partial<ResponseForRequest>"
+            "additionalProperties": false,
+            "type": "object",
+            "properties": {
+              "headers": {
+                "description": "Optional response headers.\n\nThe record values will be converted to string following:\nArrays' values will be mapped to String\n(Used when you need multiple headers with the same name).\nNon-arrays will be converted to String.",
+                "$ref": "#/definitions/Record<string,unknown>"
+              },
+              "status": {
+                "type": "number"
+              },
+              "contentType": {
+                "type": "string"
+              },
+              "body": {
+                "description": "A string representation of the body to return. Can be a base64-encoded\nstring but please omit any leading content-type data (eg \"data:image/png;base64,\").",
+                "type": "string"
+              }
+            }
           }
         },
         "additionalProperties": false,
@@ -528,118 +545,10 @@
         "y"
       ]
     },
-    "Partial<ResponseForRequest>": {
-      "type": "object",
-      "properties": {
-        "status": {
-          "type": "number"
-        },
-        "headers": {
-          "description": "Optional response headers.\n\nThe record values will be converted to string following:\nArrays' values will be mapped to String\n(Used when you need multiple headers with the same name).\nNon-arrays will be converted to String.",
-          "$ref": "#/definitions/Record<string,unknown>"
-        },
-        "contentType": {
-          "type": "string"
-        },
-        "body": {
-          "anyOf": [
-            {
-              "type": "object",
-              "additionalProperties": false,
-              "patternProperties": {
-                "^[0-9]+$": {
-                  "type": "number"
-                }
-              },
-              "properties": {
-                "BYTES_PER_ELEMENT": {
-                  "type": "number"
-                },
-                "buffer": {
-                  "$ref": "#/definitions/ArrayBufferLike"
-                },
-                "byteLength": {
-                  "type": "number"
-                },
-                "byteOffset": {
-                  "type": "number"
-                },
-                "length": {
-                  "type": "number"
-                },
-                "__@toStringTag@162561": {
-                  "type": "string",
-                  "const": "Uint8Array"
-                }
-              },
-              "required": [
-                "BYTES_PER_ELEMENT",
-                "__@toStringTag@162561",
-                "buffer",
-                "byteLength",
-                "byteOffset",
-                "length"
-              ]
-            },
-            {
-              "type": "string"
-            }
-          ]
-        }
-      },
-      "additionalProperties": false
-    },
     "Record<string,unknown>": {
       "type": "object",
       "additionalProperties": false
     },
-    "ArrayBufferLike": {
-      "anyOf": [
-        {
-          "$ref": "#/definitions/ArrayBuffer"
-        },
-        {
-          "$ref": "#/definitions/SharedArrayBuffer"
-        }
-      ]
-    },
-    "ArrayBuffer": {
-      "type": "object",
-      "properties": {
-        "byteLength": {
-          "type": "number"
-        },
-        "__@toStringTag@162561": {
-          "type": "string"
-        }
-      },
-      "additionalProperties": false,
-      "required": [
-        "__@toStringTag@162561",
-        "byteLength"
-      ]
-    },
-    "SharedArrayBuffer": {
-      "type": "object",
-      "properties": {
-        "byteLength": {
-          "type": "number"
-        },
-        "__@species@171769": {
-          "$ref": "#/definitions/SharedArrayBuffer"
-        },
-        "__@toStringTag@162561": {
-          "type": "string",
-          "const": "SharedArrayBuffer"
-        }
-      },
-      "additionalProperties": false,
-      "required": [
-        "__@species@171769",
-        "__@toStringTag@162561",
-        "byteLength"
-      ]
-    },
     "Record<string,string>": {
       "type": "object",
       "additionalProperties": false