@browserless.io/browserless 2.17.0-beta-1 → 2.17.1

package/CHANGELOG.md

@@ -1,7 +1,19 @@
-# [Latest](https://github.com/browserless/chrome/compare/v2.16.1...main)
+# [Latest](https://github.com/browserless/chrome/compare/v2.17.0...main)
 - Dependency updates.
 
-# [Latest](https://github.com/browserless/chrome/compare/v2.16.0...v2.16.1)
+# [v2.17.0](https://github.com/browserless/chrome/compare/v2.16.1...v2.17.0)
+- Dependency updates.
+- Hide token in logs on startup.
+- Fixes an issue where using `--proxy-server` now works with /function-API calls.
+- Adds support for the following CORS headers via env variables (headers and their corresponding config names are below). *Please note that these are very permissive by default, but only set when `ENABLE_CORS` is `true`!*
+    - 'Access-Control-Allow-Credentials': CORS_ALLOW_CREDENTIALS (default '*')
+    - 'Access-Control-Allow-Headers': CORS_ALLOW_HEADERS (default: '*')
+    - 'Access-Control-Allow-Methods': CORS_ALLOW_METHODS (default: 'OPTIONS, POST, GET')
+    - 'Access-Control-Allow-Origin': CORS_ALLOW_ORIGIN (default: '*')
+    - 'Access-Control-Expose-Headers': CORS_EXPOSE_HEADERS (default: '*')
+    - 'Access-Control-Max-Age': CORS_MAX_AGE (default: '2592000')
+
+# [v2.16.1](https://github.com/browserless/chrome/compare/v2.16.0...v2.16.1)
 - Dependency updates.
 - Fixes numerous SDK issues when creating and building new projects.
 

package/build/browsers/browsers.cdp.js

@@ -121,6 +121,14 @@ export class ChromiumCDP extends EventEmitter {
             this.blockAds ? ublockPath : null,
             extensionLaunchArgs ? extensionLaunchArgs.split('=')[1] : null,
         ].filter((_) => !!_);
+        // Bypass the host we bind to so things like /function can work with proxies
+        if (options.args?.some((arg) => arg.includes('--proxy-server'))) {
+            const bypassList = [
+                this.config.getHost(),
+                new URL(this.config.getExternalAddress()).hostname,
+            ];
+            options.args.push(`--proxy-bypass-list=${bypassList.join(',')}`);
+        }
         const finalOptions = {
             ...options,
             args: [

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

@@ -312,7 +312,7 @@
           "type": "string"
         },
         "partitionKey": {
-          "description": "Cookie partition key. The site of the top-level URL the browser was visiting at the\nstart of the request to the endpoint that set the cookie. If not set, the cookie will\nbe set as not partitioned.",
+          "description": "Cookie partition key. In Chrome, it matches the top-level site the\npartitioned cookie is available in. In Firefox, it matches the\nsource origin\n(https://w3c.github.io/webdriver-bidi/#type-storage-PartitionKey).",
           "type": "string"
         }
       },
@@ -438,14 +438,14 @@
                 "length": {
                   "type": "number"
                 },
-                "__@toStringTag@11909": {
+                "__@toStringTag@11944": {
                   "type": "string",
                   "const": "Uint8Array"
                 }
               },
               "required": [
                 "BYTES_PER_ELEMENT",
-                "__@toStringTag@11909",
+                "__@toStringTag@11944",
                 "buffer",
                 "byteLength",
                 "byteOffset",
@@ -480,13 +480,13 @@
         "byteLength": {
           "type": "number"
         },
-        "__@toStringTag@11909": {
+        "__@toStringTag@11944": {
           "type": "string"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@toStringTag@11909",
+        "__@toStringTag@11944",
         "byteLength"
       ]
     },
@@ -496,18 +496,18 @@
         "byteLength": {
           "type": "number"
         },
-        "__@species@11948": {
+        "__@species@11983": {
           "$ref": "#/definitions/SharedArrayBuffer"
         },
-        "__@toStringTag@11909": {
+        "__@toStringTag@11944": {
           "type": "string",
           "const": "SharedArrayBuffer"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@species@11948",
-        "__@toStringTag@11909",
+        "__@species@11983",
+        "__@toStringTag@11944",
         "byteLength"
       ]
     },

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

@@ -314,7 +314,7 @@
           "type": "string"
         },
         "partitionKey": {
-          "description": "Cookie partition key. The site of the top-level URL the browser was visiting at the\nstart of the request to the endpoint that set the cookie. If not set, the cookie will\nbe set as not partitioned.",
+          "description": "Cookie partition key. In Chrome, it matches the top-level site the\npartitioned cookie is available in. In Firefox, it matches the\nsource origin\n(https://w3c.github.io/webdriver-bidi/#type-storage-PartitionKey).",
           "type": "string"
         }
       },
@@ -583,14 +583,14 @@
                 "length": {
                   "type": "number"
                 },
-                "__@toStringTag@82852": {
+                "__@toStringTag@94848": {
                   "type": "string",
                   "const": "Uint8Array"
                 }
               },
               "required": [
                 "BYTES_PER_ELEMENT",
-                "__@toStringTag@82852",
+                "__@toStringTag@94848",
                 "buffer",
                 "byteLength",
                 "byteOffset",
@@ -625,13 +625,13 @@
         "byteLength": {
           "type": "number"
         },
-        "__@toStringTag@82852": {
+        "__@toStringTag@94848": {
           "type": "string"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@toStringTag@82852",
+        "__@toStringTag@94848",
         "byteLength"
       ]
     },
@@ -641,18 +641,18 @@
         "byteLength": {
           "type": "number"
         },
-        "__@species@82891": {
+        "__@species@94887": {
           "$ref": "#/definitions/SharedArrayBuffer"
         },
-        "__@toStringTag@82852": {
+        "__@toStringTag@94848": {
           "type": "string",
           "const": "SharedArrayBuffer"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@species@82891",
-        "__@toStringTag@82852",
+        "__@species@94887",
+        "__@toStringTag@94848",
         "byteLength"
       ]
     },

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

@@ -323,7 +323,7 @@
           "type": "string"
         },
         "partitionKey": {
-          "description": "Cookie partition key. The site of the top-level URL the browser was visiting at the\nstart of the request to the endpoint that set the cookie. If not set, the cookie will\nbe set as not partitioned.",
+          "description": "Cookie partition key. In Chrome, it matches the top-level site the\npartitioned cookie is available in. In Firefox, it matches the\nsource origin\n(https://w3c.github.io/webdriver-bidi/#type-storage-PartitionKey).",
           "type": "string"
         }
       },
@@ -485,14 +485,14 @@
                 "length": {
                   "type": "number"
                 },
-                "__@toStringTag@118478": {
+                "__@toStringTag@118718": {
                   "type": "string",
                   "const": "Uint8Array"
                 }
               },
               "required": [
                 "BYTES_PER_ELEMENT",
-                "__@toStringTag@118478",
+                "__@toStringTag@118718",
                 "buffer",
                 "byteLength",
                 "byteOffset",
@@ -527,13 +527,13 @@
         "byteLength": {
           "type": "number"
         },
-        "__@toStringTag@118478": {
+        "__@toStringTag@118718": {
           "type": "string"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@toStringTag@118478",
+        "__@toStringTag@118718",
         "byteLength"
       ]
     },
@@ -543,18 +543,18 @@
         "byteLength": {
           "type": "number"
         },
-        "__@species@118517": {
+        "__@species@118757": {
           "$ref": "#/definitions/SharedArrayBuffer"
         },
-        "__@toStringTag@118478": {
+        "__@toStringTag@118718": {
           "type": "string",
           "const": "SharedArrayBuffer"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@species@118517",
-        "__@toStringTag@118478",
+        "__@species@118757",
+        "__@toStringTag@118718",
         "byteLength"
       ]
     },

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

@@ -247,7 +247,7 @@
           "type": "string"
         },
         "partitionKey": {
-          "description": "Cookie partition key. The site of the top-level URL the browser was visiting at the\nstart of the request to the endpoint that set the cookie. Supported only in Chrome.",
+          "description": "Cookie partition key. In Chrome, it is the top-level site the\npartitioned cookie is available in. In Firefox, it matches the\nsource origin\n(https://w3c.github.io/webdriver-bidi/#type-storage-PartitionKey).",
           "type": "string"
         },
         "partitionKeyOpaque": {

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

@@ -320,7 +320,7 @@
           "type": "string"
         },
         "partitionKey": {
-          "description": "Cookie partition key. The site of the top-level URL the browser was visiting at the\nstart of the request to the endpoint that set the cookie. If not set, the cookie will\nbe set as not partitioned.",
+          "description": "Cookie partition key. In Chrome, it matches the top-level site the\npartitioned cookie is available in. In Firefox, it matches the\nsource origin\n(https://w3c.github.io/webdriver-bidi/#type-storage-PartitionKey).",
           "type": "string"
         }
       },
@@ -528,14 +528,14 @@
                 "length": {
                   "type": "number"
                 },
-                "__@toStringTag@130556": {
+                "__@toStringTag@130831": {
                   "type": "string",
                   "const": "Uint8Array"
                 }
               },
               "required": [
                 "BYTES_PER_ELEMENT",
-                "__@toStringTag@130556",
+                "__@toStringTag@130831",
                 "buffer",
                 "byteLength",
                 "byteOffset",
@@ -570,13 +570,13 @@
         "byteLength": {
           "type": "number"
         },
-        "__@toStringTag@130556": {
+        "__@toStringTag@130831": {
           "type": "string"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@toStringTag@130556",
+        "__@toStringTag@130831",
         "byteLength"
       ]
     },
@@ -586,18 +586,18 @@
         "byteLength": {
           "type": "number"
         },
-        "__@species@130595": {
+        "__@species@130870": {
           "$ref": "#/definitions/SharedArrayBuffer"
         },
-        "__@toStringTag@130556": {
+        "__@toStringTag@130831": {
           "type": "string",
           "const": "SharedArrayBuffer"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@species@130595",
-        "__@toStringTag@130556",
+        "__@species@130870",
+        "__@toStringTag@130831",
         "byteLength"
       ]
     },

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

@@ -312,7 +312,7 @@
           "type": "string"
         },
         "partitionKey": {
-          "description": "Cookie partition key. The site of the top-level URL the browser was visiting at the\nstart of the request to the endpoint that set the cookie. If not set, the cookie will\nbe set as not partitioned.",
+          "description": "Cookie partition key. In Chrome, it matches the top-level site the\npartitioned cookie is available in. In Firefox, it matches the\nsource origin\n(https://w3c.github.io/webdriver-bidi/#type-storage-PartitionKey).",
           "type": "string"
         }
       },
@@ -438,14 +438,14 @@
                 "length": {
                   "type": "number"
                 },
-                "__@toStringTag@142544": {
+                "__@toStringTag@142854": {
                   "type": "string",
                   "const": "Uint8Array"
                 }
               },
               "required": [
                 "BYTES_PER_ELEMENT",
-                "__@toStringTag@142544",
+                "__@toStringTag@142854",
                 "buffer",
                 "byteLength",
                 "byteOffset",
@@ -480,13 +480,13 @@
         "byteLength": {
           "type": "number"
         },
-        "__@toStringTag@142544": {
+        "__@toStringTag@142854": {
           "type": "string"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@toStringTag@142544",
+        "__@toStringTag@142854",
         "byteLength"
       ]
     },
@@ -496,18 +496,18 @@
         "byteLength": {
           "type": "number"
         },
-        "__@species@142583": {
+        "__@species@142893": {
           "$ref": "#/definitions/SharedArrayBuffer"
         },
-        "__@toStringTag@142544": {
+        "__@toStringTag@142854": {
           "type": "string",
           "const": "SharedArrayBuffer"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@species@142583",
-        "__@toStringTag@142544",
+        "__@species@142893",
+        "__@toStringTag@142854",
         "byteLength"
       ]
     },

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

@@ -314,7 +314,7 @@
           "type": "string"
         },
         "partitionKey": {
-          "description": "Cookie partition key. The site of the top-level URL the browser was visiting at the\nstart of the request to the endpoint that set the cookie. If not set, the cookie will\nbe set as not partitioned.",
+          "description": "Cookie partition key. In Chrome, it matches the top-level site the\npartitioned cookie is available in. In Firefox, it matches the\nsource origin\n(https://w3c.github.io/webdriver-bidi/#type-storage-PartitionKey).",
           "type": "string"
         }
       },
@@ -583,14 +583,14 @@
                 "length": {
                   "type": "number"
                 },
-                "__@toStringTag@261161": {
+                "__@toStringTag@225737": {
                   "type": "string",
                   "const": "Uint8Array"
                 }
               },
               "required": [
                 "BYTES_PER_ELEMENT",
-                "__@toStringTag@261161",
+                "__@toStringTag@225737",
                 "buffer",
                 "byteLength",
                 "byteOffset",
@@ -625,13 +625,13 @@
         "byteLength": {
           "type": "number"
         },
-        "__@toStringTag@261161": {
+        "__@toStringTag@225737": {
           "type": "string"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@toStringTag@261161",
+        "__@toStringTag@225737",
         "byteLength"
       ]
     },
@@ -641,18 +641,18 @@
         "byteLength": {
           "type": "number"
         },
-        "__@species@261200": {
+        "__@species@225776": {
           "$ref": "#/definitions/SharedArrayBuffer"
         },
-        "__@toStringTag@261161": {
+        "__@toStringTag@225737": {
           "type": "string",
           "const": "SharedArrayBuffer"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@species@261200",
-        "__@toStringTag@261161",
+        "__@species@225776",
+        "__@toStringTag@225737",
         "byteLength"
       ]
     },

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

@@ -323,7 +323,7 @@
           "type": "string"
         },
         "partitionKey": {
-          "description": "Cookie partition key. The site of the top-level URL the browser was visiting at the\nstart of the request to the endpoint that set the cookie. If not set, the cookie will\nbe set as not partitioned.",
+          "description": "Cookie partition key. In Chrome, it matches the top-level site the\npartitioned cookie is available in. In Firefox, it matches the\nsource origin\n(https://w3c.github.io/webdriver-bidi/#type-storage-PartitionKey).",
           "type": "string"
         }
       },
@@ -485,14 +485,14 @@
                 "length": {
                   "type": "number"
                 },
-                "__@toStringTag@249084": {
+                "__@toStringTag@249601": {
                   "type": "string",
                   "const": "Uint8Array"
                 }
               },
               "required": [
                 "BYTES_PER_ELEMENT",
-                "__@toStringTag@249084",
+                "__@toStringTag@249601",
                 "buffer",
                 "byteLength",
                 "byteOffset",
@@ -527,13 +527,13 @@
         "byteLength": {
           "type": "number"
         },
-        "__@toStringTag@249084": {
+        "__@toStringTag@249601": {
           "type": "string"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@toStringTag@249084",
+        "__@toStringTag@249601",
         "byteLength"
       ]
     },
@@ -543,18 +543,18 @@
         "byteLength": {
           "type": "number"
         },
-        "__@species@249123": {
+        "__@species@249640": {
           "$ref": "#/definitions/SharedArrayBuffer"
         },
-        "__@toStringTag@249084": {
+        "__@toStringTag@249601": {
           "type": "string",
           "const": "SharedArrayBuffer"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@species@249123",
-        "__@toStringTag@249084",
+        "__@species@249640",
+        "__@toStringTag@249601",
         "byteLength"
       ]
     },

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

@@ -247,7 +247,7 @@
           "type": "string"
         },
         "partitionKey": {
-          "description": "Cookie partition key. The site of the top-level URL the browser was visiting at the\nstart of the request to the endpoint that set the cookie. Supported only in Chrome.",
+          "description": "Cookie partition key. In Chrome, it is the top-level site the\npartitioned cookie is available in. In Firefox, it matches the\nsource origin\n(https://w3c.github.io/webdriver-bidi/#type-storage-PartitionKey).",
           "type": "string"
         },
         "partitionKeyOpaque": {

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

@@ -320,7 +320,7 @@
           "type": "string"
         },
         "partitionKey": {
-          "description": "Cookie partition key. The site of the top-level URL the browser was visiting at the\nstart of the request to the endpoint that set the cookie. If not set, the cookie will\nbe set as not partitioned.",
+          "description": "Cookie partition key. In Chrome, it matches the top-level site the\npartitioned cookie is available in. In Firefox, it matches the\nsource origin\n(https://w3c.github.io/webdriver-bidi/#type-storage-PartitionKey).",
           "type": "string"
         }
       },
@@ -528,14 +528,14 @@
                 "length": {
                   "type": "number"
                 },
-                "__@toStringTag@225290": {
+                "__@toStringTag@261711": {
                   "type": "string",
                   "const": "Uint8Array"
                 }
               },
               "required": [
                 "BYTES_PER_ELEMENT",
-                "__@toStringTag@225290",
+                "__@toStringTag@261711",
                 "buffer",
                 "byteLength",
                 "byteOffset",
@@ -570,13 +570,13 @@
         "byteLength": {
           "type": "number"
         },
-        "__@toStringTag@225290": {
+        "__@toStringTag@261711": {
           "type": "string"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@toStringTag@225290",
+        "__@toStringTag@261711",
         "byteLength"
       ]
     },
@@ -586,18 +586,18 @@
         "byteLength": {
           "type": "number"
         },
-        "__@species@225329": {
+        "__@species@261750": {
           "$ref": "#/definitions/SharedArrayBuffer"
         },
-        "__@toStringTag@225290": {
+        "__@toStringTag@261711": {
           "type": "string",
           "const": "SharedArrayBuffer"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@species@225329",
-        "__@toStringTag@225290",
+        "__@species@261750",
+        "__@toStringTag@261711",
         "byteLength"
       ]
     },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@browserless.io/browserless",
-  "version": "2.17.0-beta-1",
+  "version": "2.17.1",
   "license": "SSPL",
   "description": "The browserless platform",
   "author": "browserless.io",
@@ -51,7 +51,7 @@
     "debug": "^4.3.6",
     "del": "^7.0.0",
     "enjoi": "^9.0.1",
-    "file-type": "^19.4.0",
+    "file-type": "^19.4.1",
     "get-port": "^7.1.0",
     "gradient-string": "^2.0.0",
     "http-proxy": "^1.18.1",
@@ -62,7 +62,7 @@
     "playwright-1.43": "npm:playwright-core@1.43.1",
     "playwright-1.44": "npm:playwright-core@1.44.1",
     "playwright-core": "^1.46.0",
-    "puppeteer-core": "^23.0.2",
+    "puppeteer-core": "^23.1.0",
     "puppeteer-extra": "^3.3.6",
     "puppeteer-extra-plugin-stealth": "^2.11.2",
     "queue": "^7.0.0",
@@ -76,7 +76,7 @@
     "@types/http-proxy": "^1.17.15",
     "@types/micromatch": "^4.0.9",
     "@types/mocha": "^10.0.7",
-    "@types/node": "^22.2.0",
+    "@types/node": "^22.3.0",
     "@types/sinon": "^17.0.3",
     "@typescript-eslint/eslint-plugin": "^7.18.0",
     "@typescript-eslint/parser": "^7.18.0",

package/src/browserless.ts

@@ -243,10 +243,7 @@ export class Browserless extends EventEmitter {
     const hasDebugger = await this.config.hasDebugger();
     const debuggerURL =
       hasDebugger &&
-      makeExternalURL(
-        this.config.getExternalAddress(),
-        `/debugger/?token=xxx`,
-      );
+      makeExternalURL(this.config.getExternalAddress(), `/debugger/?token=xxx`);
     const docsLink = makeExternalURL(this.config.getExternalAddress(), '/docs');
 
     this.logger.info(printLogo(docsLink, debuggerURL));

package/src/browsers/browsers.cdp.ts

@@ -193,6 +193,15 @@ export class ChromiumCDP extends EventEmitter {
       extensionLaunchArgs ? extensionLaunchArgs.split('=')[1] : null,
     ].filter((_) => !!_);
 
+    // Bypass the host we bind to so things like /function can work with proxies
+    if (options.args?.some((arg) => arg.includes('--proxy-server'))) {
+      const bypassList = [
+        this.config.getHost(),
+        new URL(this.config.getExternalAddress()).hostname,
+      ];
+      options.args.push(`--proxy-bypass-list=${bypassList.join(',')}`);
+    }
+
     const finalOptions = {
       ...options,
       args: [

package/src/server.ts

@@ -55,9 +55,7 @@ export class HTTPServer extends EventEmitter {
     this.port = config.getPort();
 
     this.logger.info(
-      `Server instantiated with host "${this.host}" on port "${
-        this.port
-      }`,
+      `Server instantiated with host "${this.host}" on port "${this.port}`,
     );
   }