@browserless.io/browserless 2.5.0-beta-4 → 2.6.0

package/CHANGELOG.md

@@ -1,12 +1,24 @@
-# [Latest](https://github.com/browserless/chrome/compare/v2.4.0...main)
+# [Latest](https://github.com/browserless/chrome/compare/v2.6.0...main)
+- 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.
+- New `/active` route for determining if server is able to handle requests.
+- Better logging around 404'd HTTP requests.
+- 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 SDK hooks in a more SDK-friendly manner.
+- 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:
   - `getArgSwitches`
   - `getSourceFiles`
   - `installDependencies`
   - `buildDockerImage`
   - `buildTypeScript`
+- `README.md` updates.
 - Dependency updates.
 
 # [v2.4.0](https://github.com/browserless/chrome/compare/v2.3.0...v2.4.0)

package/README.md

@@ -1,3 +1,5 @@
+<!-- markdownlint-disable first-line-h1 no-emphasis-as-heading -->
+
 ![browserless.io logo](/assets/logo.png)
 
 ![Docker Pulls](https://img.shields.io/docker/pulls/browserless/chrome)
@@ -7,34 +9,39 @@
 ![Webkit CI](https://github.com/browserless/chrome/actions/workflows/docker-webkit.yml/badge.svg)
 ![Multi CI](https://github.com/browserless/chrome/actions/workflows/docker-multi.yml/badge.svg)
 
-
-> [Looking for v1.x.x of browserless? You can find it here](https://github.com/browserless/chrome/tree/v1), although we recommend migrating to v2.
+> [!NOTE]  
+> [Looking for v1.x.x of browserless? You can find it here](https://github.com/browserless/chrome/tree/v1), although we recommend [migrating](/MIGRATION-2.0.md) to v2.
 
 Browserless allows remote clients to connect and execute headless work, all inside of docker. It supports the standard, unforked Puppeteer and Playwright libraries, as well offering REST-based APIs for common actions like data collection, PDF generation and more.
 
 We take care of common issues such as missing system-fonts, missing external libraries, and performance improvements, along with edge-cases like downloading files and managing sessions. For details, check out the documentation site built into the project which includes Open API docs.
 
 If you've been struggling to deploy headless browsers without running into issues or bloated resource requirements, then Browserless was built for you. Run the browsers in [our cloud](https://browserless.io/) or your own, [free for non-commercial uses](https://github.com/browserless/browserless#licensing).
-# Table of Contents
-
-1. [Features](#features)
-2. [How it works](#how-it-works)
-3. [Docker](#docker)
-4. [Hosting](#hosting-providers)
-5. [Puppeteer](#puppeteer)
-6. [Playwright](#playwright)
-7. [Extending with NodeJS SDK](#extending-nodejs-sdk)
-8. [Licensing](#licensing)
-9. [Changelog](https://github.com/browserless/chrome/blob/master/CHANGELOG.md)
+
+## Table of Contents
+
+- [External links](#external-links)
+- [Features](#features)
+- [How it works](#how-it-works)
+  - [Docker](#docker)
+  - [Hosting Providers](#hosting-providers)
+  - [Puppeteer](#puppeteer)
+  - [Playwright](#playwright)
+- [Extending (NodeJS SDK)](#extending-nodejs-sdk)
+- [Usage with other libraries](#usage-with-other-libraries)
+- [Motivations](#motivations)
+- [Licensing](#licensing)
 
 ## External links
 
-1. [Full documentation site](https://www.browserless.io/docs/start)
+1. [Full documentation site](https://docs.browserless.io/)
 2. [Live Debugger (using browserless.io)](https://chrome.browserless.io/)
 3. [Docker](https://github.com/browserless/browserless/pkgs/container/base)
 4. [Slack](https://join.slack.com/t/browserless/shared_invite/enQtMzA3OTMwNjA3MzY1LTRmMWU5NjQ0MTQ2YTE2YmU3MzdjNmVlMmU4MThjM2UxODNmNzNlZjVkY2U2NjdkMzYyNTgyZTBiMmE3Nzg0MzY)
 
-# Features
+## Features
+
+### General
 
 - Parallelism and request-queueing are built-in + configurable.
 - Fonts and emoji's working out-of-the-box.
@@ -43,23 +50,34 @@ If you've been struggling to deploy headless browsers without running into issue
 - Works with unforked Puppeteer and Playwright.
 - Configurable session timers and health-checks to keep things running smoothly.
 - Error tolerant: if Chrome dies it won't.
-- [Support for running and development on Apple's M1 machines](#building-for-arm64-apple-m1-machines)
+- Support for running and development on Apple's M1 machines
+
+### Cloud
+
+Our [cloud accounts](https://www.browserless.io/pricing/) include all the general features plus extras, such as:
 
-# How it works
+- Inbuilt [residential proxy](https://www.browserless.io/blog/2023/09/24/residential-proxying/)
+- [/unblock API](https://www.browserless.io/blog/2024/02/26/unblock-api/) for avoiding detectors
+- [Hybrid automations](https://www.browserless.io/blog/2024/03/21/hybrid-automations-for-puppeteer/) for streaming login windows during scripts
+- Ability to upload and run extensions _(coming soon)_
+- SSO, tokens and user roles
+
+## How it works
 
 Browserless listens for both incoming websocket requests, generally issued by most libraries, as well as pre-build REST APIs to do common functions (PDF generation, images and so on). When a websocket connects to Browserless it starts Chrome and proxies your request into it. Once the session is done then it closes and awaits for more connections. Some libraries use Chrome's HTTP endpoints, like `/json` to inspect debug-able targets, which Browserless also supports.
 
 You still execute the script itself which gives you total control over what library you want to choose and when to do upgrades. This also comes with the benefit of keep your code proprietary and able to run on numerous platforms. We simply take care of all the browser-aspects and offer a management layer on top of the browser.
 
-# Docker
+### Docker
 
-> See more options on our [full documentation site](https://www.browserless.io/docs/docker-quickstart).
+> [!TIP]  
+> See more options on our [full documentation site](https://docs.browserless.io/Docker/docker-quickstart).
 
-1. `docker run -p 3000:3000 ghcr.io/browserless/chrome`
+1. `docker run -p 3000:3000 ghcr.io/browserless/chromium`
 2. Visit `http://localhost:3000/docs` to see the documentation site.
 3. See more at our [docker package](https://github.com/browserless/browserless/pkgs/container/base).
 
-# Hosting Providers
+### Hosting Providers
 
 We offer a first-class hosted product located [here](https://browserless.io). Alternatively you can host this image on just about any major platform that offers hosting for docker. Our hosted service takes care of all the machine provisioning, notifications, dashboards and monitoring plus more:
 
@@ -69,50 +87,63 @@ We offer a first-class hosted product located [here](https://browserless.io). Al
 
 If you're interested in using this image for commercial aspects, then please read the below section on licensing.
 
-# Puppeteer
+### Puppeteer
 
 Puppeteer allows you to specify a remote location for chrome via the `browserWSEndpoint` option. Setting this for Browserless is a single line of code change.
 
 **Before**
+
 ```js
 const browser = await puppeteer.launch();
 ```
 
 **After**
+
 ```js
-const browser = await puppeteer.connect({ browserWSEndpoint: 'ws://localhost:3000' });
+const browser = await puppeteer.connect({
+  browserWSEndpoint: 'ws://localhost:3000',
+});
 ```
 
-# Playwright
+### Playwright
 
-We support running with playwright via their remote connection method on the `chromium` interface. Since playwright is very similar to puppeteer, even launch arguments and other things "just work":
+We support running with playwright via their their browser's remot connection protocols interface out of the box. Just make sure that your Docker image, playwright browser type _and_ endpoint match:
 
 **Before**
+
 ```js
-const browser = await pw.chromium.launch();
+import pw from "playwright";
+const browser = await pw.firefox.launch();
 ```
 
 **After**
+
+```sh
+docker run -p 3000:3000 ghcr.io/browserless/firefox
+# or ghcr.io/browserless/multi for all the browsers
+```
+
 ```js
-const browser = await pw.chromium.connect('ws://localhost:3000/playwright/chromium');
+import pw from "playwright-core";
 
-// OR
-const browser = await pw.chromium.connectOverCDP('ws://localhost:3000');
+const browser = await pw.firefox.connect(
+  'ws://localhost:3000/firefox/playwright',
+);
 ```
 
 After that, the rest of your code remains the same with no other changes required.
 
-# Extending (NodeJS SDK)
+## Extending (NodeJS SDK)
 
 Browserless comes with built-in extension capabilities, and allows for extending nearly any aspect of the system (for Version 2+). For more details on how to write your own routes, build docker images, and more, [see our SDK README.md](/bin/scaffold/README.md) or simply run "npx @browserless.io/browserless create" in a terminal and follow the onscreen prompts.
 
-# Usage with other libraries
+## Usage with other libraries
 
 Most libraries allow you to specify a remote instance of Chrome to interact with. They are either looking for a websocket endpoint, a host and port, or some address. Browserless supports these by default, however if you're having issues please make an issue in this project and we'll try and work with the library authors to get them integrated with browserless. Please note that in V2 we no longer support selenium or webdriver integrations.
 
-You can find a much larger list of supported libraries [on our documentation site](https://www.browserless.io/docs/puppeteer-library).
+You can find a much larger list of supported libraries [on our documentation site](https://docs.browserless.io/Libraries/puppeteer-library).
 
-# Motivations
+## Motivations
 
 Running Chrome on lambda or on your own is a fantastic idea but in practice is quite challenging in production. You're met with pretty tough cloud limits, possibly building Chrome yourself, and then dealing with odd invocation issues should everything else go ok. A lot of issues in various repositories are due to just challenges of getting Chrome running smoothly in AWS (see [here](https://github.com/GoogleChrome/puppeteer/issues?q=is%3Aissue+is%3Aopen+sort%3Acomments-desc)). You can see for yourself by going to nearly any library and sorting issues by most commented.
 
@@ -120,7 +151,7 @@ Getting Chrome running well in docker is also a challenge as there's quiet a few
 
 All of these issues prompted us to build a first-class image and workflow for interacting with Chrome in a more streamlined way. With Browserless you never have to worry about fonts, extra packages, library support, security, or anything else. It just works reliably like any other modern web service. On top of that it comes with a prescribed approach on how you interact with Chrome, which is through socket connections (similar to a database or any other external appliance). What this means is that you get the ability to drive Chrome remotely without having to do updates/releases to the thing that runs Chrome since it's divorced from your application.
 
-# Licensing
+## Licensing
 
 SPDX-License-Identifier: SSPL-1.0 OR Browserless Commercial License.
 

package/build/config.d.ts

@@ -116,7 +116,7 @@ export declare class Config extends EventEmitter {
      */
     getServerAddress: () => string;
     /**
-     * Returns the the fully-qualified URL for the
+     * Returns the fully-qualified URL for the
      * external address that browserless might be
      * running behind *or* the server address if
      * no external URL is provided.
@@ -133,7 +133,7 @@ export declare class Config extends EventEmitter {
      */
     setExternalAddress: (address: string) => string;
     /**
-     * Returns the the fully-qualified WebSocket URL for the
+     * Returns the fully-qualified WebSocket URL for the
      * external address that browserless might be
      * running behind *or* the server address if
      * no external URL is provided.

package/build/config.js

@@ -327,7 +327,7 @@ export class Config extends EventEmitter {
             ? `http://${this.host}`
             : `http://${this.host}:${this.port}`;
     /**
-     * Returns the the fully-qualified URL for the
+     * Returns the fully-qualified URL for the
      * external address that browserless might be
      * running behind *or* the server address if
      * no external URL is provided.
@@ -342,9 +342,9 @@ export class Config extends EventEmitter {
      * @param address The fully-qualified URL, eg https://www.example.com/
      * @returns {string} The address
      */
-    setExternalAddress = (address) => this.external = address;
+    setExternalAddress = (address) => (this.external = address);
     /**
-     * Returns the the fully-qualified WebSocket URL for the
+     * Returns the fully-qualified WebSocket URL for the
      * external address that browserless might be
      * running behind *or* the server address if
      * no external URL is provided.

package/build/data/classes.json

@@ -1 +1 @@
-["appconsent_noscroll","b-modal-banner--disabled","blocked","bodyBlocked","c24-cc-visible","cbar","ccm-blocked","cmp-open","consent-modal-open","consent-modal-overflow","cookie_consent","CookiePolicy--show","cookies","cu_k_cookie_consent_modal_open","didomi-popup-open","gcdc-locked","gdpr-infobar-visible","gdprbanner_consent_gdpr_consent","gdprCookieBanner-acceptedAll","hasCookieBanner","ibeugdpr-disabled","idxrcookies-block-user-nav","modal--is-open","modal-open","no_scroll","no-scroll","noScroll","popin-gdpr-no-scroll","shopee-no-scroll","show-cookie-policy-info","sp-message-open","start-cookies","ta-cc-modal-open","touchevents-false","wt-cli-eu-country","wt-cli-geoip-on"]
+["404: Not Found"]