@browserless.io/browserless 2.20.0-beta-5 → 2.20.1

package/CHANGELOG.md

@@ -1,7 +1,26 @@
-# [Latest](https://github.com/browserless/chrome/compare/v2.19.0...main)
+# [Latest](https://github.com/browserless/chrome/compare/v2.20.1...main)
+
 - Dependency updates.
 
+# [v2.20.1](https://github.com/browserless/chrome/compare/v2.20.0...v2.20.1)
+
+- Dependency updates.
+- Fix issues where connecting to a bad /devtools/page route can cause 500's.
+
+# [v2.20.0](https://github.com/browserless/chrome/compare/v2.19.0...v2.20.)
+
+- Dependency updates.
+- Supports `puppeteer@23.3.0`.
+- Support `playwright@1.47.0`.
+- Use installed playwright-core for downloading browser binaries instead of `npx`, ensuring the appropriate browsers are installed.
+- Fix JSON routes 404-ing when charset is specified in the content-type header.
+- Disable the built-in debugger by setting `ENABLE_DEBUGGER=false`.
+- Automatically run prettier on file save in VS Code.
+- Windows fixes for SDK projects.
+- README link fixes.
+
 # [v2.19.0](https://github.com/browserless/chrome/compare/v2.18.0...v2.19.0)
+
 - Dependency updates.
 - Drop `sort-keys` for eslint integrations.
 - Fix devtools URLs when `PROXY` is set and contains a path.
@@ -9,6 +28,7 @@
 - Small fixes for new eslint rules.
 
 # [v2.18.0](https://github.com/browserless/chrome/compare/v2.17.0...v2.18.0)
+
 - Dependency updates.
 - Supports `puppeteer-core@23.1.1`.
 - Supports `playwright-core@1.46.1, 1.44.1, 1.43.1, 1.42.1, 1.41.2`.
@@ -16,39 +36,47 @@
 - `/function` API now works properly when applying a 3rd-party proxy.
 
 # [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')
+- 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.
 
 # [v2.16.0](https://github.com/browserless/chrome/compare/v2.15.0...v2.16.0)
+
 - Dependency updates.
 - Better extension handling and merging when passing in custom extensions.
 - Fixes a bug where a failed job (error thrown) causes the internal queue to drain.
 - Prettier and other source improvements.
 
 # [v2.15.0](https://github.com/browserless/chrome/compare/v2.14.0...v2.15.0)
+
 - Bug fix to avoid removing healthy jobs from limiter when a job fails
 - Dependency updates.
 
 # [v2.14.0](https://github.com/browserless/chrome/compare/v2.13.0...v2.14.0)
+
 **Potentially Breaking**
+
 - Merged duplicate code in browsers and fixed name `WebkitPlaywright` to `WebKitPlaywright` (capitalized "K").
 - Devtools now bundled into the repository at build-time for the `/debugger` route.
 - Dependency updates.
 
 # [v2.13.0](https://github.com/browserless/chrome/compare/v2.12.0...v2.13.0)
+
 **Potentially Breaking**
+
 - The `browser` hook now gets the `req` property for the full request instead of `meta`.
 - Now embeds the debugger located at `/debugger`.
 - Preliminary support for `trackingId`.
@@ -58,23 +86,29 @@
 - Dependency updates.
 
 # [v2.12.0](https://github.com/browserless/chrome/compare/v2.11.0...v2.12.0)
+
 **Potentially Breaking**
+
 - SDK projects should now use conventional class method properties versus the "fat-arrow" style instance methods.
 
 **Updates**
+
 - Support for multi-version playwright (puppeteer coming soon). Browserless now checks the version in the User-Agent header and loads the appropriate playwright server for it.
 - Dependency updates.
 
 # [v2.11.0](https://github.com/browserless/chrome/compare/v2.10.0...v2.11.0)
+
 - Wrap the pressure response in a pressure key.
 - New `keepAlive` property on browser objects for downstream SDK projects to flag.
 - Dependency updates.
 
 # [v2.10.0](https://github.com/browserless/chrome/compare/v2.9.0...v2.10.0)
+
 - Adds back in the `/pressure` API from V1.
 - Dependency updates.
 
 # [v2.9.0](https://github.com/browserless/chrome/compare/v2.8.0...v2.9.0)
+
 - Dependency updates.
 - Debugger is now included and mounted under the `/debugger` path.
 - Browserless now uses the `Logger` utility internally. Better logs for certain classes as well.
@@ -83,29 +117,37 @@
 -
 
 # [v2.8.0](https://github.com/browserless/chrome/compare/v2.7.1...v2.8.0)
+
 **April 12, 2024**
 **Potentially Breaking**
+
 - New `Logger` class and SDK primitives in support of that.
 - Routes now get an instance of `Logger`, before the `browser` argument or as the last argument for HTTP routes.
 
 **Updates**
+
 - Numerous SDK fixes and updates in the CLI.
 - Dependency updates.
 
 # [v2.7.1](https://github.com/browserless/chrome/compare/v2.7.0...v2.7.1)
+
 **April 11, 2024**
+
 - Fixes a boot-looping issue due to bad startup script. Adds tests for this as well.
 - Dependency updates.
 
 # [v2.7.0](https://github.com/browserless/chrome/compare/v2.6.1...v2.7.0)
+
 - Support for Running GPUs
 - Dependency updates.
 
 # [v2.6.1](https://github.com/browserless/chrome/compare/v2.6.0...v2.6.1)
+
 - Fixes for function API calls when behind an external URL.
 - Dependency updates.
 
 # [v2.6.0](https://github.com/browserless/chrome/compare/v2.5.0...v2.6.0)
+
 - Adds a `GET /active` route that responds with no message and a `204` http code.
 - Move to NodeJS 20.12.0.
 - README, CHANGELOG, Migration and spelling fixes.
@@ -114,6 +156,7 @@
 - Dependency updates.
 
 # [v2.5.0](https://github.com/browserless/chrome/compare/v2.4.0...v2.5.0)
+
 - `Config` now allows for programmatic getting and setting of the external address.
 - Support for a new `Hooks` module for setting up hooks in a more SDK-friendly manner.
 - Adds new exports for building downstream SDK projects more easily, versus using our CLI:
@@ -126,11 +169,14 @@
 - Dependency updates.
 
 # [v2.4.0](https://github.com/browserless/chrome/compare/v2.3.0...v2.4.0)
+
 **Potentially Breaking**
+
 - Drops support for recording and screencasting in favor of library-based approaches.
 - `playwright@1.42.1` and `puppeteer@22.4.0`.
 
 **Other Changes**
+
 - SDK routes now take precedence over core routes when a path-collision occurs.
 - Support SDK projects with their own `static` directories.
 - Adds support for user-specified `stop` methods in SDK Module extensions.
@@ -139,7 +185,9 @@
 - Dependency updates.
 
 # [v2.3.0](https://github.com/browserless/chrome/compare/v2.2.0...v2.3.0)
+
 **Potentially Breaking**
+
 - Routes must define a unique `name` property in order to remove them in SDK projects.
 - A new `browserless` object in the SDK `package.json` file can specify module overrides, in camelCase, instead of using a path-based semantic.
 - Fixes issues with `npx playwright-core install...` potentially installing other browser versions than what is a dependency of Browserless.
@@ -147,7 +195,9 @@
 - Dependency updates.
 
 # [v2.2.0](https://github.com/browserless/chrome/compare/v2.1.0...v2.2.0)
+
 **Potentially Breaking**
+
 - `ghcr.io/browserless/chrome` now runs actual Chrome and not Chromium! If you were using this tag please update to use `ghcr.io/browserless/chromium`!
   - This Chrome tag uses the new routing convention below. If you get random 404's, please add `/chrome` to the start of the route. EG, `/pdf` becomes `/chrome/pdf`.
   - Websocket connections follow a similar breakage in that the URL will go from something like `ws://localhost:3000` to `ws://localhost:3000/chrome`.
@@ -158,6 +208,7 @@
 - Refer to the embedded documentation site for any and all updates on API differences.
 
 **Other Changes**
+
 - HTTPRoutes and WebSocket routes can now have multiple paths to listen on.
 - Add `clean` command to `@browserless.io/browserless` CLI.
 - Adds support for `/json/list`, `/json/new`, `/json/version` and `json/protocol` APIs (Chrome and Chromium only).
@@ -170,6 +221,7 @@
 - Dependency updates.
 
 # [v2.1.0](https://github.com/browserless/browserless/compare/v2.0.0-beta-1...v2.1.0)
+
 - Dependency updates.
 - Name is now `@browserless.io/browserless` to reflect our npm package.
 - NEW: SDK is now live here: https://www.npmjs.com/package/@browserless.io/browserless.
@@ -183,9 +235,11 @@
 - Numerous link and copyright fixes.
 
 # [v2.0.0](https://github.com/browserless/chrome/compare/master...feat/browserless-2.0)
+
 browserless 2.0.0 represents the best body of work after running browserless for over 5 years. It contains mostly the same functionality and more, and is rebuilt to be more modular and offer a NodeJS SDK. It's also much lighter and faster than prior versions and includes a lot of semantic changes.
 
 ## Features
+
 - ECMAScript style module loading and dependencies.
 - New routing system using purely NodeJS's HTTP module.
 - Better logs and concurrency/queueing parameters.
@@ -194,15 +248,18 @@ browserless 2.0.0 represents the best body of work after running browserless for
 - Soon: upcoming support for extensions, long-running sessions and more.
 
 ## Breaking Changes
+
 - Remove support for Selenium.
 - The `/function` API now runs inside the context of the browser and not in Node.
 - Drop support for keep-alive and pre-booting.
 - Support for a single `launch` query-string parameter for launching a browser versus many individual parameters.
 
 ## Minor Changes
+
 - Many docker parameters have been renamed, but are backwards compatible. See config.ts for details.
 
 # [v1.61.0](https://github.com/browserless/chrome/compare/v1.60.2...v1.61.0)
+
 - **FINAL of V1 for browserless/chrome. [See notes on V2 here](https://github.com/browserless/chrome/pull/3345)**
 - Dependency updates.
 - Added `fonts-urw-base35`.
@@ -212,11 +269,13 @@ browserless 2.0.0 represents the best body of work after running browserless for
 - Fix improper handling of HTTP writing on bare sockets with 500 errors.
 
 # [v1.60.2](https://github.com/browserless/chrome/compare/v1.60.1...v1.60.2)
+
 - Dependency updates.
 - Fixes an issue where calls to GET /sessions sometimes return blank results.
 - Drop puppeteer `21.3.1` in favor of `21.3.6`.
 
 # [v1.60.1](https://github.com/browserless/chrome/compare/v1.60.0...v1.60.1)
+
 - Dependency updates.
 - Drop the `partner` repo from builds as we no longer use it for installing `flash`.
 - Bump to `Ubuntu` lunar.
@@ -228,6 +287,7 @@ browserless 2.0.0 represents the best body of work after running browserless for
 - Drops `node-fetch` across the board in favor of `fetch` native.
 
 # [v1.60.0](https://github.com/browserless/chrome/compare/v1.59.0...v1.60.0)
+
 - Dependency updates.
 - New build arguments in our Dockerfile to apply different named base repo.
 - New `CHROME_STABLE_VERSION` build arg for specifying a particular chrome stable version.
@@ -242,6 +302,7 @@ browserless 2.0.0 represents the best body of work after running browserless for
 - Link fixes in README.md.
 
 # [v1.59.0](https://github.com/browserless/chrome/compare/v1.58.0...v1.59.0)
+
 - Dependency updates.
 - Bump to Ubuntu Kinetic release + updates to use relevant packages.
 - In support of puppeteer 20+, updates to `env.js` for finding/symlinking Chrome.
@@ -249,6 +310,7 @@ browserless 2.0.0 represents the best body of work after running browserless for
 - Ad-blocking and other request-interception in browserless is graceful using the `isInterceptResolutionHandled` method.
 
 # [v1.58.0](https://github.com/browserless/chrome/compare/v1.57.0...v1.58.0)
+
 - Dependency updates.
 - Documentation link fixes.
 - Add new required lib `libu2f-udev`.
@@ -262,6 +324,7 @@ browserless 2.0.0 represents the best body of work after running browserless for
 - Fixes an issue where user-data-dirs aren't deleted due to a crashed container.
 
 # [v1.57.0](https://github.com/browserless/chrome/compare/v1.56.0...v1.57.0)
+
 - Dependency updates.
 - Add back in `puppeteer@13.1.3` for PDF/Screenshot performance.
 - Replace `puppeteer@18.0.5` in favor of `puppeteer@19.2.2`.
@@ -274,6 +337,7 @@ browserless 2.0.0 represents the best body of work after running browserless for
   - 1.27.1
 
 # [v1.56.0](https://github.com/browserless/chrome/compare/v1.55.0...v1.56.0)
+
 - Dependency updates.
 - Fixes various puppeteer issues with regards to revision information and browser-fetching.
 - Fixes a Selenium issue where failed browsers can cause session to zombie.
@@ -281,10 +345,14 @@ browserless 2.0.0 represents the best body of work after running browserless for
 - Better selenium W3C support.
 
 # [v1.55.0](https://github.com/browserless/chrome/compare/v1.55.0...v1.54.1)
+
 **Potentially Breaking**
+
 - Update base OS from Ubuntu 20.04 to Ubuntu 22.04.
 - Drops `path` support for both `addScriptTag` and `addStyleTag`. Use `url` or inject content directly.
+
 ---
+
 - Dependency updates.
 - We now support multiple versions of playwright via `playwright-core`. browserless checks the User-Agent string and tries to load a compatible playwright server at runtime in order to avoid breakages between versions.
 - New `scrollPage` boolean parameter for the screenshot and other relevant APIs.
@@ -295,6 +363,7 @@ browserless 2.0.0 represents the best body of work after running browserless for
 - Updated links for browserless documentation in docs.
 
 # [v1.54.1](https://github.com/browserless/chrome/compare/v1.54.1...v1.54.0)
+
 - Dependency updates.
 - Add `browser.json` file to git tags.
 - Prettier fixes on source.
@@ -303,6 +372,7 @@ browserless 2.0.0 represents the best body of work after running browserless for
 - Fix: allow `disconnect` listeners to fire before closing.
 
 # [v1.54.0](https://github.com/browserless/chrome/compare/v1.53.0...v1.54.0)
+
 - Dependency updates.
 - Move to using `mocha` for better esm support.
 - Drop puppeteer `13.6.0` in favor of `14.4.1`.
@@ -310,6 +380,7 @@ browserless 2.0.0 represents the best body of work after running browserless for
 - New internal `getCDPClient` for loading a page's CPD connection.
 
 # [v1.53.0](https://github.com/browserless/chrome/compare/v1.52.1...v1.53.0)
+
 - Dependency updates.
 - Bump `browserless:base` to `1.16.0`.
 - Drop `--quiet` from deploy scripts.
@@ -318,12 +389,14 @@ browserless 2.0.0 represents the best body of work after running browserless for
 - README updates.
 
 # [v1.52.1](https://github.com/browserless/chrome/compare/v1.52.0...v1.52.1)
+
 - Dependency updates.
 - Playwright example correction in README.md.
 - Use revision `970485` for puppeteer 13.x.x, `latest`, chrome-stable and `arm64`.
 - When using `KEEPALIVE` and `PREBOOT`, don't create new blank pages, and use the existing one instead.
 
 # [v1.52.0](https://github.com/browserless/chrome/compare/v1.51.1...v1.52.0)
+
 - Dependency updates.
 - Added in new fonts: `fonts-gfs-neohellenic`.
 - Minor code formatting changes.
@@ -340,6 +413,7 @@ browserless 2.0.0 represents the best body of work after running browserless for
 - Add in more unit and integration tests.
 
 # [v1.52.0](https://github.com/browserless/chrome/compare/v1.51.1...v1.52.0)
+
 - Dependency updates.
 - Added in new fonts: `fonts-gfs-neohellenic`.
 - Minor code formatting changes.
@@ -356,9 +430,12 @@ browserless 2.0.0 represents the best body of work after running browserless for
 - Add in more unit and integration tests.
 
 # [v1.51.1](https://github.com/browserless/chrome/compare/v1.51.0...v1.51.1)
+
 - Dependency updates.
 - Updates the `vm2` module to `3.9.7`.
+
 # [v1.51.0](https://github.com/browserless/chrome/compare/v1.50.0...v1.51.0)
+
 - Dependency updates.
 - New `viewport` option inside of the content API.
 - New `encoding` option in the screenshot API.
@@ -369,6 +446,7 @@ browserless 2.0.0 represents the best body of work after running browserless for
 - Small type updates.
 
 # [v1.50.0](https://github.com/browserless/chrome/compare/v1.49.1...v1.50.0)
+
 - Dependency updates.
 - Drops support for `puppeteer-4.0.1` in favor of `puppeteer-12.0.1`.
 - Chrome-stable now utilizes puppeteer @ `12.0.1`.
@@ -383,19 +461,25 @@ browserless 2.0.0 represents the best body of work after running browserless for
 - New `/metrics/total` route for summing up all statistics in a single JSON payload.
 
 # [v1.49.1](https://github.com/browserless/chrome/compare/v1.49.0...v1.49.1)
+
 - Dependency updates.
 - Fix webhook not using timeout URL.
 
 # [v1.49.0](https://github.com/browserless/chrome/compare/v1.48.0...v1.49.0)
+
 - Dependency updates.
 - Support for ARM64 builds by dropping flash for it.
 - Bump puppeteer 10.2.0 for 10.4.0.
 - New puppeteer-hook for injecting a puppeteer-compatible library, eg. puppeteer-extra.
 
 # [v1.48.0](https://github.com/browserless/chrome/compare/v1.47.0...v1.48.0)
+
 **Potentially Breaking**
+
 - API calls with `html` in their payloads now use the `page.setContent` API versus a prior hack using one-time network-request interception ([example here](https://github.com/browserless/chrome/compare/v1.47.0...master#diff-67b699af1b24472604e21081d0509620d4ab3d986fcd4f8aa0b04d5ee5e4c63fL88)). Old versions of puppeteer might not work properly with this (<= 5.x.x). This effects the following APIS: `/content`, `/pdf` and `/screenshot`.
+
 ---
+
 - Dependency updates.
 - Bump `browserless/base` to `1.12.0` (add user-id to `blessuser` of `BLESS_USER_ID=999`).
 - Bumps puppeteer @10.x.x to `10.2.0` with revision `901912`.
@@ -403,6 +487,7 @@ browserless 2.0.0 represents the best body of work after running browserless for
 - Fix some typings in tests.
 
 # [v1.47.0](https://github.com/browserless/chrome/compare/v1.46.0...v1.47.0)
+
 - Dependency updates.
 - Bump `browserless/base` to `1.11.0`.
 - Add new lint task and rename GitHub actions tasks, remove `tslint`.
@@ -414,6 +499,7 @@ browserless 2.0.0 represents the best body of work after running browserless for
 -
 
 # [v1.46.0](https://github.com/browserless/chrome/compare/v1.45.0...v1.46.0)
+
 - Dependency updates.
 - Move to Node 16.x.x.
 - Bump browserless/base to 1.10.0.
@@ -428,14 +514,19 @@ browserless 2.0.0 represents the best body of work after running browserless for
 - Improvements on how chrome is closed.
 
 # [1.45.0](https://github.com/browserless/chrome/compare/v1.44.0...v1.45.0)
+
 - Dependency Updates.
 - Support for [playwright proxies](https://github.com/browserless/chrome/commit/0903795e936b93a511ec04f7ae35c03397682905).
 - Fixes an issue with larger headers potentially causing load-balancers to crash and fail.
 
 # [v1.44.0](https://github.com/browserless/chrome/compare/v1.43.0...v1.44.0)
+
 **Potentially Breaking**
+
 - `PROXY_HOST` and `PROXY_PORT` are now replaced with a single `PROXY_URL` param, eg: `https://www.mybrowserless.com/optional/paths`. When set, browserless uses this fully-qualified URL to build out links _back_ to its internal debugger and sessions. Useful when you're instance is behind a proxy or load-balancer of some kind.
+
 ---
+
 - Dependency Updates.
 - Use recent Node 14 (browserless-base 1.7.0).
 - New `rejectResourceTypes` property on most APIs (content, screenshot, pdf, etc.).
@@ -447,12 +538,14 @@ browserless 2.0.0 represents the best body of work after running browserless for
 - More types, tests, and utility consolidation.
 
 # [v1.43.0](https://github.com/browserless/chrome/compare/v1.42.0...v1.43.0)
+
 - Dependency Updates.
 - Fixes an issue where --user-data-dirs aren't deleted properly, potentially filling disks.
 - Changes CPU/Memory checks to be user-based and not the entire OS.
 - Adds tests for the user-data-dir issue.
 
 # [v1.42.0](https://github.com/browserless/chrome/compare/v1.41.0...v1.42.0)
+
 - Dependency Updates.
 - Move to Node 14!
 - Use `esModuleInterop` for imports.
@@ -463,30 +556,36 @@ browserless 2.0.0 represents the best body of work after running browserless for
 - Ensure temp user-data-dirs are always cleaned up.
 
 # [v1.41.0](https://github.com/browserless/chrome/compare/v1.40.2...v1.41.0)
+
 - Dependency Updates.
 - New `SESSION_CHECK_FAIL_URL` webhook for when pre-session checks fail.
 - Health checks now take the last two CPU/Memory samples to determine if a failure (5 minutes).
 
 # [v1.40.2](https://github.com/browserless/chrome/compare/v1.40.1...v1.40.2)
+
 - Dependency Updates.
 - Fix potentially unhandled stream error events when closing chrome.
 - Bump puppeteer to 5.4.1 for major 5.
 
 # [v1.40.1](https://github.com/browserless/chrome/compare/v1.40.0...v1.40.1)
+
 - Dependency Updates
 - New `SOCKET_CLOSE_METHOD` for better load-balancing behavior when under load.
 
 # [v1.40.0](https://github.com/browserless/chrome/compare/v1.39.0...v1.40.0)
+
 - Dependency Updates
 - Support for playwright 1.4.0 and greater. [See more here](https://github.com/microsoft/playwright/issues/4054).
 - New `PRE_REQUEST_HEALTH_CHECK` env variable to check CPU/Memory prior to running a session. Set `MAX_CPU_PERCENT` or `MAX_MEMORY_PERCENT` for setting these thresholds. Responds with a `503` HTTP code if CPU/Memory are high on any inbound session (API, puppeteer or webdriver).
 
 # [v1.39.0](https://github.com/browserless/chrome/compare/v1.38.0...v1.39.0)
+
 - Dependency Updates
 - Fixes a crash due to `browser.close` streams not completing properly.
 - Adds a `dumpio` query-string parameter for launching with puppeteer.
 
 # [v1.38.0](https://github.com/browserless/chrome/compare/v1.37.2...v1.38.0)
+
 - Dependency Updates
 - Fixes a memory leak when browsers don't close properly.
 - Adds a `/heapdump` route for capturing heap dumps. Turn on by setting `ENABLE_HEAP_DUMP=true` in your docker env.
@@ -495,24 +594,31 @@ browserless 2.0.0 represents the best body of work after running browserless for
 - README fixes.
 
 # [v1.37.2](https://github.com/browserless/chrome/compare/v1.37.1...v1.37.2)
+
 - Dependency Updates
 - Fixes an issue where the webserver can crash after rejecting a request.
 - Fixes deployment script not waiting for zip files to be finished unzipped.
 
 # [1.37.1](https://github.com/browserless/chrome/compare/v1.37.0...v1.37.1)
+
 - Dependency Updates
 - Fixes an issue in webdriver not starting properly.
 
 # [1.37.0](https://github.com/browserless/chrome/compare/v1.36.0...v1.37.0)
+
 **Potentially Breaking**
+
 - Due to stability issues, puppeteer version 3.x.x and 4.x.x now use chromium revision `782078`. See our `package.json` for details.
+
 ---
+
 - Dependency Updates
 - README Updates
 - Fixes an issue for secured containers using prometheus (plus tests).
 - Support for puppeteer `5.2.1`
 
 # [1.36.0](https://github.com/browserless/chrome/compare/v1.35.0...v1.36.0)
+
 - Dependency Updates
 - Drops support for puppeteer `2.0.0` and `3.0.4`, please use `2.1.1` and `3.3.0` for those revisions.
 - Adds support for puppeteer `5.0.0`.
@@ -520,16 +626,21 @@ browserless 2.0.0 represents the best body of work after running browserless for
 - Adds back in `--disable-dev-shm-usage` to default arguments for better SHM performance.
 
 # [1.35.0](https://github.com/browserless/chrome/compare/v1.34.0...v1.35.0)
+
 - Dependency Updates
 - New `maxTime`, `minTime`, `meanTime` and `totalTime` of all sessions for a given period in /stats.
 - Bugfix on CPU/Memory triggering health failure webhooks.
 - Fix issues in websocket errors by awaiting browser.close (or 5 seconds, whichever is quickest).
 
 # [v1.34.0](https://github.com/browserless/chrome/compare/v1.33.1...v1.34.0)
+
 **Potentially Breaking**
+
 - screencast API no longer supports `audio` or the `setPreferences` function in order to offer a better video experience. In order to set the width/height, simply set a page width height to what you'd like.
 - `chrome-stable` will now use `puppeteer@3.1.0` for better compatibility.
+
 ---
+
 - Dependency updates.
 - Drops puppeteer version `1.20.0` and below.
 - Move `browserless/base` to `v1.5.0`.
@@ -538,10 +649,12 @@ browserless 2.0.0 represents the best body of work after running browserless for
 - `about:blank` pages now are returned in the `/sessions` API for transparency of open sessions/browsers.
 
 # [1.33.1](https://github.com/browserless/chrome/compare/v1.33.0...v1.33.1)
+
 - Dependency updates.
 - Fix socket errors from accidentally firing error webhooks.
 
 # [1.33.0](https://github.com/browserless/chrome/compare/v1.32.0...v1.33.0)
+
 - Drops support for puppeteer 1.17.x and 1.18.x
 - Support for puppeteer 3.0.x
 - Dependency updates
@@ -549,32 +662,38 @@ browserless 2.0.0 represents the best body of work after running browserless for
 - Consolidates more types.
 
 # [1.32.0](https://github.com/browserless/chrome/compare/v1.31.1...v1.32.0)
+
 - Dependency Updates.
 - Adds roboto fonts.
 - Updates `pressure` API to take account of running browsers in the `running` count.
 - Adds `maxConcurrent`, `maxQueued`, `cpu` and `memory` to pressure.
 
 # [1.31.1](https://github.com/browserless/chrome/compare/v1.31.0...v1.31.1)
+
 - Dependency Updates.
 - Fixes a small issue where XVFB doesn't start properly during an automated restart.
 
 # [1.31.0](https://github.com/browserless/chrome/compare/v1.30.0...v1.31.0)
+
 - Dependency Updates.
 - Allows `trackingId` on uploaded files to save in the appropriate tracking-ID folder.
 - New `userAgent` param for setting user-agent in API requests.
 - Fixes an issue where chrome wasn't being closed in rare cases.
 
 # [1.30.0](https://github.com/browserless/chrome/compare/v1.29.1...v1.30.0)
+
 - Dependency Updates.
 - Updates to Node 13 for speed and memory improvements.
 - browserless/base@1.4.0
 
 # [1.29.1](https://github.com/browserless/chrome/compare/v1.29.0...v1.29.1)
+
 - Dependency Updates.
 - Fixes how deploy script determines errors when running child commands.
 - Fixes issues when many selenium sessions can potentially fill up disk space.
 
 # [1.29.0](https://github.com/browserless/chrome/compare/v1.28.0...v1.29.0)
+
 - Dependency updates.
 - Uses `pipe`'s for most API calls and other internal endpoints for faster/better throughput. Works only for `headless` API/puppeteer calls.
 - Allows custom lighthouse configs via POST `config` property.
@@ -583,6 +702,7 @@ browserless 2.0.0 represents the best body of work after running browserless for
 - Properly passes socket errors to the error handler/webhook
 
 # [1.28.0](https://github.com/browserless/chrome/compare/v1.27.0...v1.28.0)
+
 - Dependency updates.
 - Sets a system-default font of Ubuntu for most sites that use `system-ui` in their font declarations.
 - Fixes health-check failure webhooks.
@@ -590,17 +710,20 @@ browserless 2.0.0 represents the best body of work after running browserless for
 - Moves over to GH actions over Travis for CI.
 
 # [1.27.0](https://github.com/browserless/chrome/compare/v1.26.1...v1.27.0)
+
 - Dependency updates.
 - New `manipulate` params for screenshots, allowing for resizing, flipping and more.
 - Better tracking of chrome-process for cleanup of zombied sessions.
 
 # [1.26.1](https://github.com/browserless/chrome/compare/v1.26.0...v1.26.1)
+
 - Dependency updates.
 - Added `git` as a dependency in dockerfile for git-based npm dependencies to work.
 - Fixed an issue in `start.sh` so that errors bubble up properly and close the process.
 - Bumps `browserless/base` to `1.2.0`.
 
 # [1.26.0](https://github.com/browserless/chrome/compare/v1.25.0...v1.26.0)
+
 - Dependency updates.
 - Dropping pre-push hooks for speed.
 - Consolidate all interfaces/types to a types.d.ts file.
@@ -610,6 +733,7 @@ browserless 2.0.0 represents the best body of work after running browserless for
 -
 
 # [1.25.0](https://github.com/browserless/chrome/compare/v1.24.0...v1.25.0)
+
 - Dependency updates.
 - Stricter build-time arguments for chromium and chromedriver assets.
 - Better XVFB functionality.
@@ -618,6 +742,7 @@ browserless 2.0.0 represents the best body of work after running browserless for
 - Proper support for parsing `ignoreDefaultArgs` query-parameters.
 
 # [1.24.0](https://github.com/browserless/chrome/compare/v1.23.1...v1.24.0)
+
 - Dependency updates.
 - Bugfix on our debugger's play button being off-center.
 - Fixes driver.close() calls not cleaning the browser.
@@ -626,11 +751,13 @@ browserless 2.0.0 represents the best body of work after running browserless for
 - More integration and unit tests added.
 
 # [1.23.1](https://github.com/browserless/chrome/compare/v1.23.0...v1.23.1)
+
 - Fixes an issue in chromedriver where commands would hang.
 - Fixes an issue in chromedriver sessions not being removed properly.
 - Fixes and pins the base image so that headful sessions work again.
 
 # [1.23.0](https://github.com/browserless/chrome/compare/v1.22.0...v1.23.0)
+
 - Dependency updates.
 - Use `apt-get` to install `dumb-init`.
 - Add a LANG arg in docker.
@@ -640,6 +767,7 @@ browserless 2.0.0 represents the best body of work after running browserless for
 - Updates protocol and host information in ad-blocking.
 
 # [1.22.0](https://github.com/browserless/chrome/compare/v1.21.0...v1.22.0)
+
 - Dependency updates.
 - Removal of unnecessary '--disable-dev-shm-usage'
 - Squelching of chromedriver's verbose args unless `DEBUG=*` is set.
@@ -647,6 +775,7 @@ browserless 2.0.0 represents the best body of work after running browserless for
 - Allowing of sub-child routes in workspaces.
 
 # [1.21.0](https://github.com/browserless/chrome/compare/v1.20.0...v1.21.0)
+
 - Dependency updates.
 - New `viewport` property option for PDF endpoint.
 - The `/stats` endpoint now runs in a separate process meaning it can be parallelized.
@@ -654,10 +783,12 @@ browserless 2.0.0 represents the best body of work after running browserless for
 - Fixes an issue with the file-chooser API not working in puppeteer.
 
 # [1.20.0](https://github.com/browserless/chrome/compare/v1.19.0...v1.20.0)
+
 - Dependency updates.
 - New `/scrape` API!
 
 # [1.19.0](https://github.com/browserless/chrome/compare/v1.18.0...v1.19.0)
+
 - Dependency updates.
 - Fixes chrome-stable's binary chromedriver.
 - Move over to Node 12.
@@ -672,6 +803,7 @@ browserless 2.0.0 represents the best body of work after running browserless for
 -
 
 # [1.18.0](https://github.com/browserless/chrome/compare/v1.17.0...v1.18.0)
+
 - Dependency updates
 - Better `IS_DOCKER` check for kubernetes.
 - Updates to README.md, spelling fixes and Slack link.
@@ -686,6 +818,7 @@ browserless 2.0.0 represents the best body of work after running browserless for
 - Fixing issues with keeping chrome alive (only closing once TTL is met).
 
 # [1.17.0](https://github.com/browserless/chrome/compare/v1.16.0...v1.17.0)
+
 - Dependency updates
 - Splitting docker images into two repositories for faster builds and pulls
 - Adding in external routing capabilities
@@ -695,6 +828,7 @@ browserless 2.0.0 represents the best body of work after running browserless for
 - Better chromedriver failure messages.
 
 # [1.16.0](https://github.com/browserless/chrome/compare/v1.15.0...v1.16.0)
+
 - Adding `ffmpeg` to the docker dependency list.
 - Add `timecut` as a dependency for recording.
 - Better logs on chrome PID's and closing forcefully.
@@ -704,15 +838,18 @@ browserless 2.0.0 represents the best body of work after running browserless for
 - `/json/version` now returns a `webSocketDebuggerUrl`.
 
 # [1.15.0](https://github.com/browserless/chrome/compare/v1.14.1...v1.15.0)
+
 - New `page` and `browser` hooks for docker images that `FROM` browserless.
 - `bluebird` added as a module for `function` and other endpoints.
 - More dependency updates.
 
 # [1.14.1](https://github.com/browserless/chrome/compare/v1.14.0...v1.14.1)
+
 - Bugfix when running multiple "headfull" sessions.
 - Dependency updates.
 
 # [1.14.0](https://github.com/browserless/chrome/compare/v1.13.0...v1.14.0)
+
 - New `WORKSPACE_DELETE_EXPIRED` and `WORKSPACE_EXPIRE_DAYS` to auto-cleanup workspace dirs.
 - README.md cleanup now that HTTPS is no longer required.
 - Support for `~` in docker env parameters.
@@ -724,17 +861,20 @@ browserless 2.0.0 represents the best body of work after running browserless for
 - Better internal types.
 
 # [1.13.0](https://github.com/browserless/chrome/compare/v1.12.0...v1.13.0)
+
 - A minor refactor to consolidate calls to `url.parse` for performance gains.
 - Introduces a per-session based timeout that overrides the global timeout.
 - Consolidates authorization checks to remove duplication.
 - Moves more types into their backing modules in order to better consolidate files.
 
 # [1.12.0](https://github.com/browserless/chrome/compare/v1.11.0...v1.12.0)
+
 - Set's a non-conflicting `WORKSPACE_DIR` and `DEFAULT_USER_DATA_DIR` in docker by default.
 - Drops support for puppeteer `1.15.0` and adds `1.19.0`.
 - Web-based debugger now sends cookies for docker deployments that are secure.
 
 # [1.11.0](https://github.com/browserless/chrome/compare/v1.10.0...v1.11.0)
+
 - Live debugger is now self-hosted, no more enforced https though it's still recommended.
 - Consolidated build steps.
 - Using the same chromedriver binary that matches the puppeteer's bundled chromium.
@@ -745,6 +885,7 @@ browserless 2.0.0 represents the best body of work after running browserless for
 - Dependency updates.
 
 # [1.10.0](https://github.com/browserless/chrome/compare/v1.9.0...v1.10.0)
+
 - Dropped support for puppeteer `1.9.0 => 1.14.0`.
 - Added support for puppeteer `1.16.0 => 1.18.0`.
 - A version of chromedriver is now installed to perfectly match the version of puppeteer's chromium.
@@ -758,12 +899,14 @@ browserless 2.0.0 represents the best body of work after running browserless for
 - Workspace support for selenium-based integrations.
 
 # [1.9.0](https://github.com/browserless/chrome/compare/v1.8.0...v1.9.0)
+
 - Better handling of browser/socket closing in puppeteer integrations.
 - Numerous screencast fixes.
 - Moved all GH links to new repo location.
 - Dep updates.
 
 # [1.8.0](https://github.com/browserless/chrome/compare/v1.7.0...v1.8.0)
+
 - Better windows dev experience.
 - Indian font support.
 - Video capture now supports audio and browser width/height.
@@ -771,10 +914,12 @@ browserless 2.0.0 represents the best body of work after running browserless for
 - DEFAULT env variables for launching pre-booted Chrome.
 
 # 1.7.0
+
 - Dep updates
 - New `?blockAds` query-parameter for disabling 3rd-party ad calls.
 
 # 1.6.0
+
 - New `authenticate` and `setExtraHTTPHeaders` params for the `content`, `pdf`, and `screenshot` APIs. Useful for using proxies in our REST APIs.
 - Fixed a bunch of bugs inside of the webdriver integration, making it more REST-ful.
 - Updated dependencies inside of Chromedriver.
@@ -782,6 +927,7 @@ browserless 2.0.0 represents the best body of work after running browserless for
 - Bumped Puppeteer to 1.15.0.
 
 # 1.5.0
+
 - New `/session` API (and accompanying routes) for display/viewing active sesions in a remote debugger(!).
 - New `?pause` query-param for pausing sessions prior to running them (useful for the live debug viewer).
 - The browserless debugger now exposes links to these debug pages via the sidebar.
@@ -790,11 +936,13 @@ browserless 2.0.0 represents the best body of work after running browserless for
 - No more `no-implicit-any`'s inside the codebase.
 
 # 1.4.0
+
 - During connection, we now set the download dir of REST and puppeteer sessions. Cloud users and docker users no longer have to manually set this field, and the `/workspace` API references it as well!
 
 # 1.3.1
 
 # Fixes
+
 - New deploy.js file to do deployments "on-prem"
 - Updated new builds for puppeteer 1.12.2 and 1.13.0
 - Fixes an issues in CORS handling
@@ -802,6 +950,7 @@ browserless 2.0.0 represents the best body of work after running browserless for
 # 1.3.0
 
 # Minor changes
+
 - The `screenshot`, `function`, `pdf`, and `content` API's now accept new content-types for easier POSTing of small payloads (see docsite).
 - The `screencast` API can now start/stop recording programmatically via a `startScreencast` and `stopScreencast` params (see docsite).
 - New `external` dir for injecting custom `before` and `after` hooks in external docker builds.
@@ -809,6 +958,7 @@ browserless 2.0.0 represents the best body of work after running browserless for
 - New `requestInterceptors` for injection custom request behavior.
 
 # Fixes
+
 - Numerous default fixes in the APIs.
 - Stray consoles removed :)
 - Consolidated download behavior in `screencast` and `download` APIs
@@ -816,11 +966,13 @@ browserless 2.0.0 represents the best body of work after running browserless for
 # 1.2.0
 
 # Minor Changes
+
 - New `requestInterceptors` for the /screenshot API, [allowing you to mock data in response to a request](https://github.com/browserless/chrome/pull/119).
 - Code debugger now transmits code over-the-wire via cookies to avoid URL max-length issues.
 - Now supports cookie-based authentication via a `browserless_token=TOKEN;` cookie.
 
 # Fixes
+
 - [Comments in the debugger won't break it.](https://github.com/browserless/chrome/issues/118)
 - Requests that are rejected due to auth reasons aren't logged in stats.
 
@@ -829,11 +981,13 @@ browserless 2.0.0 represents the best body of work after running browserless for
 With 1.1.0 we offer a refined way of dealing with both downloads and uploads. Both use-cases are tightly coupled to the file-system, and can leave you scratching your head as to what's going one. For more information and detailed documentation, please refer to our doc-site at https://www.browserless.io/
 
 ## Minor Changes
+
 - New `WORKSPACE_DIR` variable for controlling where browserless stores files and uploads.
 - New `/workspace` API for doing RESTful operations on the downloads/uploads file-system.
 - New `/download` API for running a puppeteer-script, and responding with the resulting downloaded file.
 
 ## Internal Changes
+
 - Moved routes out of the browserless module and into their own file/module.
 - Renamed the `browserless-web-service` module to just `browserless` for simplicity.
 - Moved the `DOWNLOAD_DIR` to `WORKSPACE_DIR` since it handles both uploads and downloads.