@browserless.io/browserless 2.3.0-beta-1 → 2.3.0-beta-2

package/build/shared/pdf.http.js

@@ -1,6 +1,7 @@
-import { APITags, BadRequest, BrowserHTTPRoute, ChromiumCDP, HTTPRoutes, Methods, bestAttemptCatch, contentTypes, dedent, noop, sleep, waitForEvent as waitForEvt, waitForFunction as waitForFn, writeResponse, } from '@browserless.io/browserless';
+import { APITags, BadRequest, BrowserHTTPRoute, BrowserlessRoutes, ChromiumCDP, HTTPRoutes, Methods, bestAttemptCatch, contentTypes, dedent, noop, sleep, waitForEvent as waitForEvt, waitForFunction as waitForFn, writeResponse, } from '@browserless.io/browserless';
 import { Stream } from 'stream';
-export default class PDFPost extends BrowserHTTPRoute {
+export default class ChromiumPDFPostRoute extends BrowserHTTPRoute {
+    name = BrowserlessRoutes.ChromiumPDFPostRoute;
     accepts = [contentTypes.json];
     auth = true;
     browser = ChromiumCDP;

package/build/shared/performance.http.d.ts

@@ -16,6 +16,7 @@ export interface QuerySchema extends SystemQueryParameters {
  */
 export type ResponseSchema = object;
 export default class PerformancePost extends BrowserHTTPRoute {
+    name: string;
     accepts: contentTypes[];
     auth: boolean;
     browser: typeof ChromiumCDP;

package/build/shared/performance.http.js

@@ -1,6 +1,7 @@
-import { APITags, BrowserHTTPRoute, ChromiumCDP, HTTPRoutes, Methods, contentTypes, jsonResponse, } from '@browserless.io/browserless';
+import { APITags, BrowserHTTPRoute, BrowserlessRoutes, ChromiumCDP, HTTPRoutes, Methods, contentTypes, jsonResponse, } from '@browserless.io/browserless';
 import main from './utils/performance/main.js';
 export default class PerformancePost extends BrowserHTTPRoute {
+    name = BrowserlessRoutes.ChromiumPerformancePostRoute;
     accepts = [contentTypes.json];
     auth = true;
     browser = ChromiumCDP;

package/build/shared/scrape.http.d.ts

@@ -104,7 +104,8 @@ export interface ResponseSchema {
         screenshot: string | null;
     } | null;
 }
-export default class ScrapePost extends BrowserHTTPRoute {
+export default class ChromiumScrapePostRoute extends BrowserHTTPRoute {
+    name: string;
     accepts: contentTypes[];
     auth: boolean;
     browser: typeof ChromiumCDP;

package/build/shared/scrape.http.js

@@ -1,4 +1,4 @@
-import { APITags, BadRequest, BrowserHTTPRoute, ChromiumCDP, HTTPRoutes, Methods, Timeout, bestAttemptCatch, contentTypes, debugScreenshotOpts, dedent, jsonResponse, noop, sleep, waitForEvent as waitForEvt, waitForFunction as waitForFn, } from '@browserless.io/browserless';
+import { APITags, BadRequest, BrowserHTTPRoute, BrowserlessRoutes, ChromiumCDP, HTTPRoutes, Methods, Timeout, bestAttemptCatch, contentTypes, debugScreenshotOpts, dedent, jsonResponse, noop, sleep, waitForEvent as waitForEvt, waitForFunction as waitForFn, } from '@browserless.io/browserless';
 const scrape = async (elements) => {
     const wait = (selector, timeout = 30000) => {
         return new Promise((resolve, reject) => {
@@ -39,7 +39,8 @@ const scrape = async (elements) => {
         };
     });
 };
-export default class ScrapePost extends BrowserHTTPRoute {
+export default class ChromiumScrapePostRoute extends BrowserHTTPRoute {
+    name = BrowserlessRoutes.ChromiumScrapePostRoute;
     accepts = [contentTypes.json];
     auth = true;
     browser = ChromiumCDP;

package/build/shared/screenshot.http.d.ts

@@ -36,6 +36,7 @@ export interface BodySchema {
     waitForTimeout?: number;
 }
 export default class ScreenshotPost extends BrowserHTTPRoute {
+    name: string;
     accepts: contentTypes[];
     auth: boolean;
     browser: typeof ChromiumCDP;

package/build/shared/screenshot.http.js

@@ -1,6 +1,7 @@
-import { APITags, BadRequest, BrowserHTTPRoute, ChromiumCDP, HTTPRoutes, Methods, bestAttemptCatch, contentTypes, dedent, noop, scrollThroughPage, sleep, waitForEvent as waitForEvt, waitForFunction as waitForFn, } from '@browserless.io/browserless';
+import { APITags, BadRequest, BrowserHTTPRoute, BrowserlessRoutes, ChromiumCDP, HTTPRoutes, Methods, bestAttemptCatch, contentTypes, dedent, noop, scrollThroughPage, sleep, waitForEvent as waitForEvt, waitForFunction as waitForFn, } from '@browserless.io/browserless';
 import Stream from 'stream';
 export default class ScreenshotPost extends BrowserHTTPRoute {
+    name = BrowserlessRoutes.ChromiumScreenshotPostRoute;
     accepts = [contentTypes.json];
     auth = true;
     browser = ChromiumCDP;

package/build/types.d.ts

@@ -56,6 +56,11 @@ declare abstract class Route {
     protected _metrics: Browserless['metrics'];
     protected _monitoring: Browserless['monitoring'];
     constructor(_browserManager: Browserless['browserManager'], _config: Browserless['config'], _fileSystem: Browserless['fileSystem'], _debug: Browserless['debug'], _metrics: Browserless['metrics'], _monitoring: Browserless['monitoring']);
+    /**
+     * A unique name to identify this route. Used in downstream
+     * SDKs to potentially remove or disable.
+     */
+    abstract name: string;
     /**
      * A boolean, or a function that returns a boolean, on
      * whether the route requires an API token to access.
@@ -472,4 +477,90 @@ export interface CDPJSONPayload {
      */
     webSocketDebuggerUrl: string;
 }
+export declare const BrowserlessChromeRoutes: {
+    ChromeBrowserWebSocketRoute: string;
+    ChromeCDPWebSocketRoute: string;
+    ChromeContentPostRoute: string;
+    ChromeDownloadPostRoute: string;
+    ChromeFunctionPostRoute: string;
+    ChromeJSONListGetRoute: string;
+    ChromeJSONNewPutRoute: string;
+    ChromeJSONProtocolGetRoute: string;
+    ChromeJSONVersionGetRoute: string;
+    ChromePDFPostRoute: string;
+    ChromePageWebSocketRoute: string;
+    ChromePerformancePostRoute: string;
+    ChromePlaywrightWebSocketRoute: string;
+    ChromeScrapePostRoute: string;
+    ChromeScreenshotPostRoute: string;
+};
+export declare const BrowserlessChromiumRoutes: {
+    ChromiumBrowserWebSocketRoute: string;
+    ChromiumCDPWebSocketRoute: string;
+    ChromiumContentPostRoute: string;
+    ChromiumDownloadPostRoute: string;
+    ChromiumFunctionPostRoute: string;
+    ChromiumJSONListGetRoute: string;
+    ChromiumJSONNewPutRoute: string;
+    ChromiumJSONProtocolGetRoute: string;
+    ChromiumJSONVersionGetRoute: string;
+    ChromiumPDFPostRoute: string;
+    ChromiumPageWebSocketRoute: string;
+    ChromiumPerformancePostRoute: string;
+    ChromiumPlaywrightWebSocketRoute: string;
+    ChromiumScrapePostRoute: string;
+    ChromiumScreenshotPostRoute: string;
+};
+export declare const BrowserlessFirefoxRoutes: {
+    FirefoxPlaywrightWebSocketRoute: string;
+};
+export declare const BrowserlessWebKitRoutes: {
+    WebKitPlaywrightWebSocketRoute: string;
+};
+export declare const BrowserlessManagementRoutes: {
+    ConfigGetRoute: string;
+    MetricsGetRoute: string;
+    MetricsTotalGetRoute: string;
+    SessionsGetRoute: string;
+    StaticGetRoute: string;
+};
+export declare const BrowserlessRoutes: {
+    ConfigGetRoute: string;
+    MetricsGetRoute: string;
+    MetricsTotalGetRoute: string;
+    SessionsGetRoute: string;
+    StaticGetRoute: string;
+    WebKitPlaywrightWebSocketRoute: string;
+    FirefoxPlaywrightWebSocketRoute: string;
+    ChromiumBrowserWebSocketRoute: string;
+    ChromiumCDPWebSocketRoute: string;
+    ChromiumContentPostRoute: string;
+    ChromiumDownloadPostRoute: string;
+    ChromiumFunctionPostRoute: string;
+    ChromiumJSONListGetRoute: string;
+    ChromiumJSONNewPutRoute: string;
+    ChromiumJSONProtocolGetRoute: string;
+    ChromiumJSONVersionGetRoute: string;
+    ChromiumPDFPostRoute: string;
+    ChromiumPageWebSocketRoute: string;
+    ChromiumPerformancePostRoute: string;
+    ChromiumPlaywrightWebSocketRoute: string;
+    ChromiumScrapePostRoute: string;
+    ChromiumScreenshotPostRoute: string;
+    ChromeBrowserWebSocketRoute: string;
+    ChromeCDPWebSocketRoute: string;
+    ChromeContentPostRoute: string;
+    ChromeDownloadPostRoute: string;
+    ChromeFunctionPostRoute: string;
+    ChromeJSONListGetRoute: string;
+    ChromeJSONNewPutRoute: string;
+    ChromeJSONProtocolGetRoute: string;
+    ChromeJSONVersionGetRoute: string;
+    ChromePDFPostRoute: string;
+    ChromePageWebSocketRoute: string;
+    ChromePerformancePostRoute: string;
+    ChromePlaywrightWebSocketRoute: string;
+    ChromeScrapePostRoute: string;
+    ChromeScreenshotPostRoute: string;
+};
 export {};

package/build/types.js

@@ -139,3 +139,57 @@ export const debugScreenshotOpts = {
     quality: 20,
     type: 'jpeg',
 };
+export const BrowserlessChromeRoutes = {
+    ChromeBrowserWebSocketRoute: 'ChromeBrowserWebSocketRoute',
+    ChromeCDPWebSocketRoute: 'ChromeCDPWebSocketRoute',
+    ChromeContentPostRoute: 'ChromeContentPostRoute',
+    ChromeDownloadPostRoute: 'ChromeDownloadPostRoute',
+    ChromeFunctionPostRoute: 'ChromeFunctionPostRoute',
+    ChromeJSONListGetRoute: 'ChromeJSONListGetRoute',
+    ChromeJSONNewPutRoute: 'ChromeJSONNewPutRoute',
+    ChromeJSONProtocolGetRoute: 'ChromeJSONProtocolGetRoute',
+    ChromeJSONVersionGetRoute: 'ChromeJSONVersionGetRoute',
+    ChromePDFPostRoute: 'ChromePDFPostRoute',
+    ChromePageWebSocketRoute: 'ChromePageWebSocketRoute',
+    ChromePerformancePostRoute: 'ChromePerformancePostRoute',
+    ChromePlaywrightWebSocketRoute: 'ChromePlaywrightWebSocketRoute',
+    ChromeScrapePostRoute: 'ChromeScrapePostRoute',
+    ChromeScreenshotPostRoute: 'ChromeScreenshotPostRoute',
+};
+export const BrowserlessChromiumRoutes = {
+    ChromiumBrowserWebSocketRoute: 'ChromiumBrowserWebSocketRoute',
+    ChromiumCDPWebSocketRoute: 'ChromiumCDPWebSocketRoute',
+    ChromiumContentPostRoute: 'ChromiumContentPostRoute',
+    ChromiumDownloadPostRoute: 'ChromiumDownloadPostRoute',
+    ChromiumFunctionPostRoute: 'ChromiumFunctionPostRoute',
+    ChromiumJSONListGetRoute: 'ChromiumJSONListGetRoute',
+    ChromiumJSONNewPutRoute: 'ChromiumJSONNewPutRoute',
+    ChromiumJSONProtocolGetRoute: 'ChromiumJSONProtocolGetRoute',
+    ChromiumJSONVersionGetRoute: 'ChromiumJSONVersionGetRoute',
+    ChromiumPDFPostRoute: 'ChromiumPDFPostRoute',
+    ChromiumPageWebSocketRoute: 'ChromiumPageWebSocketRoute',
+    ChromiumPerformancePostRoute: 'ChromiumPerformancePostRoute',
+    ChromiumPlaywrightWebSocketRoute: 'ChromiumPlaywrightWebSocketRoute',
+    ChromiumScrapePostRoute: 'ChromiumScrapePostRoute',
+    ChromiumScreenshotPostRoute: 'ChromiumScreenshotPostRoute',
+};
+export const BrowserlessFirefoxRoutes = {
+    FirefoxPlaywrightWebSocketRoute: 'FirefoxPlaywrightWebSocketRoute',
+};
+export const BrowserlessWebKitRoutes = {
+    WebKitPlaywrightWebSocketRoute: 'WebKitPlaywrightWebSocketRoute',
+};
+export const BrowserlessManagementRoutes = {
+    ConfigGetRoute: 'ConfigGetRoute',
+    MetricsGetRoute: 'MetricsGetRoute',
+    MetricsTotalGetRoute: 'MetricsTotalGetRoute',
+    SessionsGetRoute: 'SessionsGetRoute',
+    StaticGetRoute: 'StaticGetRoute',
+};
+export const BrowserlessRoutes = {
+    ...BrowserlessChromeRoutes,
+    ...BrowserlessChromiumRoutes,
+    ...BrowserlessFirefoxRoutes,
+    ...BrowserlessWebKitRoutes,
+    ...BrowserlessManagementRoutes,
+};

package/build/utils.d.ts

@@ -38,7 +38,7 @@ export declare const readBody: (req: Request) => Promise<ReturnType<typeof safeP
  * Lists the path of Chromes (stable) install since
  * no library or utility out there does it including playwright.
  */
-export declare const chromeExecutablePath: string;
+export declare const chromeExecutablePath: () => string;
 export declare const getRouteFiles: (config: Config) => Promise<string[][]>;
 export declare const make404: (...messages: string[]) => string;
 /**

package/build/utils.js

@@ -203,11 +203,16 @@ export const readBody = async (req) => {
  * Lists the path of Chromes (stable) install since
  * no library or utility out there does it including playwright.
  */
-export const chromeExecutablePath = process.platform === 'win32'
-    ? `%ProgramFiles%\\Google\\Chrome\\Application\\chrome.exe`
-    : process.platform === 'darwin'
-        ? '/Applications/Google Chrome.app/Contents/MacOS/Google Chrome'
-        : '/usr/bin/google-chrome-stable';
+export const chromeExecutablePath = () => {
+    if (process.platform === 'win32') {
+        // Windows always includes the ProgramFiles variable in the environment
+        return `${process.env['ProgramFiles']}\\Google\\Chrome\\Application\\chrome.exe`;
+    }
+    if (process.platform === 'darwin') {
+        return '/Applications/Google Chrome.app/Contents/MacOS/Google Chrome';
+    }
+    return '/usr/bin/google-chrome-stable';
+};
 export const getRouteFiles = async (config) => {
     const routes = config.getRoutes();
     const foundRoutes = await fs
@@ -300,7 +305,7 @@ export const availableBrowsers = Promise.all([
     exists(playwright.chromium.executablePath()),
     exists(playwright.firefox.executablePath()),
     exists(playwright.webkit.executablePath()),
-    exists(chromeExecutablePath),
+    exists(chromeExecutablePath()),
 ]).then(([chromiumExists, firefoxExists, webkitExists, chromeExists]) => {
     const availableBrowsers = [];
     if (chromiumExists) {

package/docker/chrome/Dockerfile

@@ -4,8 +4,6 @@ LABEL org.opencontainers.image.source https://github.com/browserless/browserless
 
 COPY fonts/* /usr/share/fonts/truetype/
 COPY src src/
-# Only use core as exports since routes are lazy loaded and not always present
-COPY src/exports.core.ts src/exports.ts
 RUN rm -r src/routes/
 COPY src/routes/management src/routes/management/
 COPY src/routes/chrome src/routes/chrome/

package/docker/chromium/Dockerfile

@@ -4,8 +4,6 @@ LABEL org.opencontainers.image.source https://github.com/browserless/browserless
 
 COPY fonts/* /usr/share/fonts/truetype/
 COPY src src/
-# Only use core as exports since routes are lazy loaded and not always present
-COPY src/exports.core.ts src/exports.ts
 RUN rm -r src/routes/
 COPY src/routes/management src/routes/management/
 COPY src/routes/chromium src/routes/chromium/
@@ -28,8 +26,7 @@ RUN echo "ttf-mscorefonts-installer msttcorefonts/accepted-mscorefonts-eula sele
     fonts-ubuntu \
     fonts-wqy-zenhei
 
-RUN npx --yes playwright install chromium &&\
-  npx --yes playwright install-deps chromium &&\
+RUN ./node_modules/.bin/playwright-core install --with-deps chromium &&\
   npm run build &&\
   npm run build:function &&\
   npm prune production &&\

package/docker/firefox/Dockerfile

@@ -4,8 +4,6 @@ LABEL org.opencontainers.image.source https://github.com/browserless/browserless
 
 COPY fonts/* /usr/share/fonts/truetype/
 COPY src src/
-# Only use core as exports since routes are lazy loaded and not always present
-COPY src/exports.core.ts src/exports.ts
 RUN rm -r src/routes/
 COPY src/routes/management src/routes/management/
 COPY src/routes/firefox src/routes/firefox/
@@ -28,8 +26,7 @@ RUN echo "ttf-mscorefonts-installer msttcorefonts/accepted-mscorefonts-eula sele
     fonts-ubuntu \
     fonts-wqy-zenhei
 
-RUN npx --yes playwright install firefox &&\
-  npx --yes playwright install-deps firefox &&\
+RUN ./node_modules/.bin/playwright-core install --with-deps firefox &&\
   npm run build &&\
   npm prune production &&\
   chown -R blessuser:blessuser $APP_DIR &&\

package/docker/multi/Dockerfile

@@ -7,8 +7,6 @@ ENV TARGETPLATFORM=${TARGETPLATFORM}
 
 COPY fonts/* /usr/share/fonts/truetype/
 COPY src src/
-# Only use core as exports since routes are lazy loaded and not always present
-COPY src/exports.core.ts src/exports.ts
 
 RUN echo "ttf-mscorefonts-installer msttcorefonts/accepted-mscorefonts-eula select true" | debconf-set-selections &&\
   apt-get -y -qq install software-properties-common &&\
@@ -31,14 +29,12 @@ RUN echo "ttf-mscorefonts-installer msttcorefonts/accepted-mscorefonts-eula sele
 # Chrome stable is only supported on non-ARM builds
 # so it's installation is conditional on whether or not amd64
 RUN if [ "$TARGETPLATFORM" = "linux/amd64" ]; then \
-    npx --yes playwright install-deps chrome &&\
-    npx --yes playwright install chrome; \
+    ./node_modules/.bin/playwright-core install --with-deps chrome; \
   else \
     rm -rf ./src/routes/chrome; \
   fi
 
-RUN npx --yes playwright install chromium firefox webkit &&\
-  npx --yes playwright install-deps chromium firefox webkit &&\
+RUN ./node_modules/.bin/playwright-core install --with-deps chromium firefox webkit &&\
   npm run build &&\
   npm run build:function &&\
   npm prune production &&\

package/docker/webkit/Dockerfile

@@ -5,8 +5,6 @@ LABEL org.opencontainers.image.source https://github.com/browserless/browserless
 # Install Fonts
 COPY fonts/* /usr/share/fonts/truetype/
 COPY src src/
-# Only use core as exports since routes are lazy loaded and not always present
-COPY src/exports.core.ts src/exports.ts
 RUN rm -r src/routes/
 COPY src/routes/management src/routes/management/
 COPY src/routes/webkit src/routes/webkit/
@@ -29,8 +27,7 @@ RUN echo "ttf-mscorefonts-installer msttcorefonts/accepted-mscorefonts-eula sele
     fonts-ubuntu \
     fonts-wqy-zenhei
 
-RUN npx --yes playwright install webkit &&\
-  npx --yes playwright install-deps webkit &&\
+RUN ./node_modules/.bin/playwright-core install --with-deps webkit &&\
   npm run build &&\
   npm prune production &&\
   chown -R blessuser:blessuser $APP_DIR &&\

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@browserless.io/browserless",
-  "version": "2.3.0-beta-1",
+  "version": "2.3.0-beta-2",
   "license": "SSPL",
   "description": "The browserless platform",
   "author": "browserless.io",
@@ -30,7 +30,8 @@
     "lint": "eslint . --ext .ts --fix",
     "prepack": "npm run build:dev",
     "prettier": "prettier '{src,functions,scripts,bin,external,bin}/**/*.{js,ts,json}' --log-level error --write",
-    "test": "cross-env DEBUG=quiet mocha"
+    "test": "cross-env DEBUG=quiet mocha",
+    "start": "env-cmd -f .env node build"
   },
   "files": [
     "assets/*",
@@ -56,32 +57,32 @@
     "http-proxy": "^1.18.1",
     "lighthouse": "^11.1.0",
     "micromatch": "^4.0.4",
-    "playwright-core": "^1.41.2",
-    "puppeteer-core": "^22.1.0",
+    "playwright-core": "^1.42.0",
+    "puppeteer-core": "^22.3.0",
     "puppeteer-extra": "^3.3.6",
     "puppeteer-extra-plugin-stealth": "^2.11.2",
     "queue": "^7.0.0",
     "systeminformation": "^5.22.0"
   },
   "optionalDependencies": {
-    "@types/chai": "^4.3.11",
+    "@types/chai": "^4.3.12",
     "@types/debug": "^4.1.12",
     "@types/gradient-string": "^1.1.5",
     "@types/http-proxy": "^1.17.14",
     "@types/micromatch": "^4.0.6",
     "@types/mocha": "^10.0.6",
-    "@types/node": "^20.11.19",
+    "@types/node": "^20.11.21",
     "@types/sinon": "^17.0.3",
-    "@typescript-eslint/eslint-plugin": "^7.0.0",
-    "@typescript-eslint/parser": "^6.21.0",
+    "@typescript-eslint/eslint-plugin": "^7.1.0",
+    "@typescript-eslint/parser": "^7.1.0",
     "assert": "^2.0.0",
     "chai": "^5.1.0",
     "cross-env": "^7.0.3",
     "env-cmd": "^10.1.0",
     "esbuild": "^0.20.1",
     "esbuild-plugin-polyfill-node": "^0.3.0",
-    "eslint": "^8.56.0",
-    "eslint-plugin-typescript-sort-keys": "^3.1.0",
+    "eslint": "^8.57.0",
+    "eslint-plugin-typescript-sort-keys": "^3.2.0",
     "extract-zip": "^2.0.1",
     "marked": "^12.0.0",
     "mocha": "^10.3.0",