@browserless.io/browserless 2.34.1 → 2.36.0

package/CHANGELOG.md

@@ -1,6 +1,28 @@
-# [Latest](https://github.com/browserless/chrome/compare/v2.34.0...main)
-
-- Dependency updates.
+# [Latest](https://github.com/browserless/chrome/compare/v2.35.0...main)
+
+- Dependency updates.
+
+# [v2.35.0](https://github.com/browserless/chrome/compare/v2.34.1...v2.35.0)
+
+- Dependency updates.
+- Updates base image to Ubuntu `24.04`.
+- Updates NodeJS to `24.8.0`.
+- Move to `npm ci` for automated tests and release processes.
+- Small cleanup in dockerfiles for consistency.
+- Added a `npm run coverage` command for determining areas of code needing coverage.
+- `bestAttempt` fixes in the `/scrape` API.
+- Fixes a few OpenAPI issues in the swagger.json manifests.
+- Fixes issues where install-adblock can fail.
+- Updated messaging around concurrency limits being reached.
+- Few more unit-tests.
+- Supports the following libraries and browsers:
+  - puppeteer-core: `24.22.0`
+  - playwright-core: `1.55.0`, `1.54.2`, `1.53.2`, `1.52.0`, and `1.51.1`.
+  - Chromium: `140.0.7339.16`
+  - Chrome: `140.0.7339.186` (amd64 only)
+  - Firefox: `141.0`
+  - Webkit: `26.0`
+  - Edge: `140.0.3485.81` (amd64 only)
 
 # [v2.34.1](https://github.com/browserless/chrome/compare/v2.34.0...v2.34.1)
 

package/build/limiter.js

@@ -127,7 +127,7 @@ export class Limiter extends q {
                 overCapacityFn(...args);
                 const concurrencyLimit = this.concurrency;
                 const queueLimit = this.queued;
-                return rej(new TooManyRequests(`Concurrency limit of ${concurrencyLimit} and queue limit of ${queueLimit} reached. Possible causes: 1) Your token has reached maximum capacity, 2) Your token may not have access to this version, 3) Your requests are coming too quickly.`));
+                return rej(new TooManyRequests(`Your plan allows ${concurrencyLimit} concurrent sessions and ${queueLimit} queued requests, but both limits have been reached. Possible causes: 1) Your plan has reached maximum capacity, 2) Your token may not have access to this version, 3) Your requests are coming too quickly.`));
             }
             if (this.willQueue) {
                 this.logQueue(`Concurrency is at capacity, queueing`);

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

@@ -124,7 +124,20 @@
       "type": "string"
     },
     "userAgent": {
-      "type": "string"
+      "type": "object",
+      "properties": {
+        "userAgent": {
+          "type": "string"
+        },
+        "userAgentMetadata": {
+          "description": "Used to specify User Agent Client Hints to emulate. See https://wicg.github.io/ua-client-hints\nMissing optional values will be filled in by the target with what it would normally use.",
+          "$ref": "#/definitions/Protocol.Emulation.UserAgentMetadata"
+        },
+        "platform": {
+          "type": "string"
+        }
+      },
+      "additionalProperties": false
     },
     "viewport": {
       "anyOf": [
@@ -450,6 +463,82 @@
       "type": "object",
       "additionalProperties": false
     },
+    "Protocol.Emulation.UserAgentMetadata": {
+      "description": "Used to specify User Agent Client Hints to emulate. See https://wicg.github.io/ua-client-hints\nMissing optional values will be filled in by the target with what it would normally use.",
+      "type": "object",
+      "properties": {
+        "brands": {
+          "description": "Brands appearing in Sec-CH-UA.",
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/Protocol.Emulation.UserAgentBrandVersion"
+          }
+        },
+        "fullVersionList": {
+          "description": "Brands appearing in Sec-CH-UA-Full-Version-List.",
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/Protocol.Emulation.UserAgentBrandVersion"
+          }
+        },
+        "fullVersion": {
+          "type": "string"
+        },
+        "platform": {
+          "type": "string"
+        },
+        "platformVersion": {
+          "type": "string"
+        },
+        "architecture": {
+          "type": "string"
+        },
+        "model": {
+          "type": "string"
+        },
+        "mobile": {
+          "type": "boolean"
+        },
+        "bitness": {
+          "type": "string"
+        },
+        "wow64": {
+          "type": "boolean"
+        },
+        "formFactors": {
+          "description": "Used to specify User Agent form-factor values.\nSee https://wicg.github.io/ua-client-hints/#sec-ch-ua-form-factors",
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        }
+      },
+      "additionalProperties": false,
+      "required": [
+        "architecture",
+        "mobile",
+        "model",
+        "platform",
+        "platformVersion"
+      ]
+    },
+    "Protocol.Emulation.UserAgentBrandVersion": {
+      "description": "Used to specify User Agent Client Hints to emulate. See https://wicg.github.io/ua-client-hints",
+      "type": "object",
+      "properties": {
+        "brand": {
+          "type": "string"
+        },
+        "version": {
+          "type": "string"
+        }
+      },
+      "additionalProperties": false,
+      "required": [
+        "brand",
+        "version"
+      ]
+    },
     "Viewport": {
       "type": "object",
       "properties": {

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

@@ -126,7 +126,20 @@
       "type": "string"
     },
     "userAgent": {
-      "type": "string"
+      "type": "object",
+      "properties": {
+        "userAgent": {
+          "type": "string"
+        },
+        "userAgentMetadata": {
+          "description": "Used to specify User Agent Client Hints to emulate. See https://wicg.github.io/ua-client-hints\nMissing optional values will be filled in by the target with what it would normally use.",
+          "$ref": "#/definitions/Protocol.Emulation.UserAgentMetadata"
+        },
+        "platform": {
+          "type": "string"
+        }
+      },
+      "additionalProperties": false
     },
     "viewport": {
       "anyOf": [
@@ -595,6 +608,82 @@
       "type": "object",
       "additionalProperties": false
     },
+    "Protocol.Emulation.UserAgentMetadata": {
+      "description": "Used to specify User Agent Client Hints to emulate. See https://wicg.github.io/ua-client-hints\nMissing optional values will be filled in by the target with what it would normally use.",
+      "type": "object",
+      "properties": {
+        "brands": {
+          "description": "Brands appearing in Sec-CH-UA.",
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/Protocol.Emulation.UserAgentBrandVersion"
+          }
+        },
+        "fullVersionList": {
+          "description": "Brands appearing in Sec-CH-UA-Full-Version-List.",
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/Protocol.Emulation.UserAgentBrandVersion"
+          }
+        },
+        "fullVersion": {
+          "type": "string"
+        },
+        "platform": {
+          "type": "string"
+        },
+        "platformVersion": {
+          "type": "string"
+        },
+        "architecture": {
+          "type": "string"
+        },
+        "model": {
+          "type": "string"
+        },
+        "mobile": {
+          "type": "boolean"
+        },
+        "bitness": {
+          "type": "string"
+        },
+        "wow64": {
+          "type": "boolean"
+        },
+        "formFactors": {
+          "description": "Used to specify User Agent form-factor values.\nSee https://wicg.github.io/ua-client-hints/#sec-ch-ua-form-factors",
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        }
+      },
+      "additionalProperties": false,
+      "required": [
+        "architecture",
+        "mobile",
+        "model",
+        "platform",
+        "platformVersion"
+      ]
+    },
+    "Protocol.Emulation.UserAgentBrandVersion": {
+      "description": "Used to specify User Agent Client Hints to emulate. See https://wicg.github.io/ua-client-hints",
+      "type": "object",
+      "properties": {
+        "brand": {
+          "type": "string"
+        },
+        "version": {
+          "type": "string"
+        }
+      },
+      "additionalProperties": false,
+      "required": [
+        "brand",
+        "version"
+      ]
+    },
     "Viewport": {
       "type": "object",
       "properties": {

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

@@ -132,7 +132,20 @@
       "type": "string"
     },
     "userAgent": {
-      "type": "string"
+      "type": "object",
+      "properties": {
+        "userAgent": {
+          "type": "string"
+        },
+        "userAgentMetadata": {
+          "description": "Used to specify User Agent Client Hints to emulate. See https://wicg.github.io/ua-client-hints\nMissing optional values will be filled in by the target with what it would normally use.",
+          "$ref": "#/definitions/Protocol.Emulation.UserAgentMetadata"
+        },
+        "platform": {
+          "type": "string"
+        }
+      },
+      "additionalProperties": false
     },
     "viewport": {
       "anyOf": [
@@ -497,6 +510,82 @@
       "type": "object",
       "additionalProperties": false
     },
+    "Protocol.Emulation.UserAgentMetadata": {
+      "description": "Used to specify User Agent Client Hints to emulate. See https://wicg.github.io/ua-client-hints\nMissing optional values will be filled in by the target with what it would normally use.",
+      "type": "object",
+      "properties": {
+        "brands": {
+          "description": "Brands appearing in Sec-CH-UA.",
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/Protocol.Emulation.UserAgentBrandVersion"
+          }
+        },
+        "fullVersionList": {
+          "description": "Brands appearing in Sec-CH-UA-Full-Version-List.",
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/Protocol.Emulation.UserAgentBrandVersion"
+          }
+        },
+        "fullVersion": {
+          "type": "string"
+        },
+        "platform": {
+          "type": "string"
+        },
+        "platformVersion": {
+          "type": "string"
+        },
+        "architecture": {
+          "type": "string"
+        },
+        "model": {
+          "type": "string"
+        },
+        "mobile": {
+          "type": "boolean"
+        },
+        "bitness": {
+          "type": "string"
+        },
+        "wow64": {
+          "type": "boolean"
+        },
+        "formFactors": {
+          "description": "Used to specify User Agent form-factor values.\nSee https://wicg.github.io/ua-client-hints/#sec-ch-ua-form-factors",
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        }
+      },
+      "additionalProperties": false,
+      "required": [
+        "architecture",
+        "mobile",
+        "model",
+        "platform",
+        "platformVersion"
+      ]
+    },
+    "Protocol.Emulation.UserAgentBrandVersion": {
+      "description": "Used to specify User Agent Client Hints to emulate. See https://wicg.github.io/ua-client-hints",
+      "type": "object",
+      "properties": {
+        "brand": {
+          "type": "string"
+        },
+        "version": {
+          "type": "string"
+        }
+      },
+      "additionalProperties": false,
+      "required": [
+        "brand",
+        "version"
+      ]
+    },
     "Viewport": {
       "type": "object",
       "properties": {

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

@@ -179,18 +179,6 @@
       "description": "Represents a cookie object.",
       "type": "object",
       "properties": {
-        "name": {
-          "description": "Cookie name.",
-          "type": "string"
-        },
-        "value": {
-          "description": "Cookie value.",
-          "type": "string"
-        },
-        "domain": {
-          "description": "Cookie domain.",
-          "type": "string"
-        },
         "path": {
           "description": "Cookie path.",
           "type": "string"
@@ -203,10 +191,6 @@
           "description": "Cookie size.",
           "type": "number"
         },
-        "httpOnly": {
-          "description": "True if cookie is http-only.",
-          "type": "boolean"
-        },
         "secure": {
           "description": "True if cookie is secure.",
           "type": "boolean"
@@ -215,6 +199,26 @@
           "description": "True in case of session cookie.",
           "type": "boolean"
         },
+        "partitionKeyOpaque": {
+          "description": "True if cookie partition key is opaque. Supported only in Chrome.",
+          "type": "boolean"
+        },
+        "name": {
+          "description": "Cookie name.",
+          "type": "string"
+        },
+        "value": {
+          "description": "Cookie value.",
+          "type": "string"
+        },
+        "domain": {
+          "description": "Cookie domain.",
+          "type": "string"
+        },
+        "httpOnly": {
+          "description": "True if cookie is http-only.",
+          "type": "boolean"
+        },
         "sameSite": {
           "description": "Cookie SameSite type.",
           "enum": [
@@ -247,7 +251,7 @@
           "type": "string"
         },
         "partitionKey": {
-          "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 in the\n{@link https://w3c.github.io/webdriver-bidi/#type-storage-PartitionKey PartitionKey}.",
+          "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 in the\n{@link https://w3c.github.io/webdriver-bidi/#type-storage-PartitionKey PartitionKey}.",
           "anyOf": [
             {
               "$ref": "#/definitions/CookiePartitionKey"
@@ -256,17 +260,12 @@
               "type": "string"
             }
           ]
-        },
-        "partitionKeyOpaque": {
-          "description": "True if cookie partition key is opaque. Supported only in Chrome.",
-          "type": "boolean"
         }
       },
       "additionalProperties": false,
       "required": [
         "domain",
         "expires",
-        "httpOnly",
         "name",
         "path",
         "secure",

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

@@ -132,7 +132,20 @@
       "type": "string"
     },
     "userAgent": {
-      "type": "string"
+      "type": "object",
+      "properties": {
+        "userAgent": {
+          "type": "string"
+        },
+        "userAgentMetadata": {
+          "description": "Used to specify User Agent Client Hints to emulate. See https://wicg.github.io/ua-client-hints\nMissing optional values will be filled in by the target with what it would normally use.",
+          "$ref": "#/definitions/Protocol.Emulation.UserAgentMetadata"
+        },
+        "platform": {
+          "type": "string"
+        }
+      },
+      "additionalProperties": false
     },
     "viewport": {
       "anyOf": [
@@ -553,6 +566,82 @@
       "type": "object",
       "additionalProperties": false
     },
+    "Protocol.Emulation.UserAgentMetadata": {
+      "description": "Used to specify User Agent Client Hints to emulate. See https://wicg.github.io/ua-client-hints\nMissing optional values will be filled in by the target with what it would normally use.",
+      "type": "object",
+      "properties": {
+        "brands": {
+          "description": "Brands appearing in Sec-CH-UA.",
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/Protocol.Emulation.UserAgentBrandVersion"
+          }
+        },
+        "fullVersionList": {
+          "description": "Brands appearing in Sec-CH-UA-Full-Version-List.",
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/Protocol.Emulation.UserAgentBrandVersion"
+          }
+        },
+        "fullVersion": {
+          "type": "string"
+        },
+        "platform": {
+          "type": "string"
+        },
+        "platformVersion": {
+          "type": "string"
+        },
+        "architecture": {
+          "type": "string"
+        },
+        "model": {
+          "type": "string"
+        },
+        "mobile": {
+          "type": "boolean"
+        },
+        "bitness": {
+          "type": "string"
+        },
+        "wow64": {
+          "type": "boolean"
+        },
+        "formFactors": {
+          "description": "Used to specify User Agent form-factor values.\nSee https://wicg.github.io/ua-client-hints/#sec-ch-ua-form-factors",
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        }
+      },
+      "additionalProperties": false,
+      "required": [
+        "architecture",
+        "mobile",
+        "model",
+        "platform",
+        "platformVersion"
+      ]
+    },
+    "Protocol.Emulation.UserAgentBrandVersion": {
+      "description": "Used to specify User Agent Client Hints to emulate. See https://wicg.github.io/ua-client-hints",
+      "type": "object",
+      "properties": {
+        "brand": {
+          "type": "string"
+        },
+        "version": {
+          "type": "string"
+        }
+      },
+      "additionalProperties": false,
+      "required": [
+        "brand",
+        "version"
+      ]
+    },
     "Viewport": {
       "type": "object",
       "properties": {

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

@@ -124,7 +124,20 @@
       "type": "string"
     },
     "userAgent": {
-      "type": "string"
+      "type": "object",
+      "properties": {
+        "userAgent": {
+          "type": "string"
+        },
+        "userAgentMetadata": {
+          "description": "Used to specify User Agent Client Hints to emulate. See https://wicg.github.io/ua-client-hints\nMissing optional values will be filled in by the target with what it would normally use.",
+          "$ref": "#/definitions/Protocol.Emulation.UserAgentMetadata"
+        },
+        "platform": {
+          "type": "string"
+        }
+      },
+      "additionalProperties": false
     },
     "viewport": {
       "anyOf": [
@@ -450,6 +463,82 @@
       "type": "object",
       "additionalProperties": false
     },
+    "Protocol.Emulation.UserAgentMetadata": {
+      "description": "Used to specify User Agent Client Hints to emulate. See https://wicg.github.io/ua-client-hints\nMissing optional values will be filled in by the target with what it would normally use.",
+      "type": "object",
+      "properties": {
+        "brands": {
+          "description": "Brands appearing in Sec-CH-UA.",
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/Protocol.Emulation.UserAgentBrandVersion"
+          }
+        },
+        "fullVersionList": {
+          "description": "Brands appearing in Sec-CH-UA-Full-Version-List.",
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/Protocol.Emulation.UserAgentBrandVersion"
+          }
+        },
+        "fullVersion": {
+          "type": "string"
+        },
+        "platform": {
+          "type": "string"
+        },
+        "platformVersion": {
+          "type": "string"
+        },
+        "architecture": {
+          "type": "string"
+        },
+        "model": {
+          "type": "string"
+        },
+        "mobile": {
+          "type": "boolean"
+        },
+        "bitness": {
+          "type": "string"
+        },
+        "wow64": {
+          "type": "boolean"
+        },
+        "formFactors": {
+          "description": "Used to specify User Agent form-factor values.\nSee https://wicg.github.io/ua-client-hints/#sec-ch-ua-form-factors",
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        }
+      },
+      "additionalProperties": false,
+      "required": [
+        "architecture",
+        "mobile",
+        "model",
+        "platform",
+        "platformVersion"
+      ]
+    },
+    "Protocol.Emulation.UserAgentBrandVersion": {
+      "description": "Used to specify User Agent Client Hints to emulate. See https://wicg.github.io/ua-client-hints",
+      "type": "object",
+      "properties": {
+        "brand": {
+          "type": "string"
+        },
+        "version": {
+          "type": "string"
+        }
+      },
+      "additionalProperties": false,
+      "required": [
+        "brand",
+        "version"
+      ]
+    },
     "Viewport": {
       "type": "object",
       "properties": {