@browserless.io/browserless 2.13.1-beta.1 → 2.15.0

package/CHANGELOG.md

@@ -1,8 +1,17 @@
-# [Latest](https://github.com/browserless/chrome/compare/v2.13.0...main)
-- Merged duplicative code in browsers and fixed name `WebkitPlaywright` to `WebKitPlaywright` (capitalized "K").
+# [Latest](https://github.com/browserless/chrome/compare/v2.15.0...main)
 - Dependency updates.
 
-# [Latest](https://github.com/browserless/chrome/compare/v2.12.0...v2.13.0)
+# [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`.

package/build/browserless.d.ts

@@ -1,5 +1,3 @@
-/// <reference types="node" />
-/// <reference types="node" />
 import { Logger as BlessLogger, BrowserHTTPRoute, BrowserManager, BrowserWebsocketRoute, Config, FileSystem, HTTPRoute, HTTPServer, Hooks, Limiter, Metrics, Monitoring, Router, Token, WebHooks, WebSocketRoute } from '@browserless.io/browserless';
 import { EventEmitter } from 'events';
 type routeInstances = HTTPRoute | BrowserHTTPRoute | WebSocketRoute | BrowserWebsocketRoute;

package/build/browsers/browsers.cdp.d.ts

@@ -1,8 +1,3 @@
-/// <reference types="node" />
-/// <reference types="node" />
-/// <reference types="node" />
-/// <reference types="node" />
-/// <reference types="node" />
 import { BrowserLauncherOptions, Config, Logger, Request } from '@browserless.io/browserless';
 import { Browser, Page, Target } from 'puppeteer-core';
 import { Duplex } from 'stream';

package/build/browsers/browsers.playwright.d.ts

@@ -1,7 +1,3 @@
-/// <reference types="node" />
-/// <reference types="node" />
-/// <reference types="node" />
-/// <reference types="node" />
 import { BrowserLauncherOptions, BrowserServerOptions, Config, Logger, Request } from '@browserless.io/browserless';
 import playwright, { Page } from 'playwright-core';
 import { Duplex } from 'stream';
@@ -31,19 +27,19 @@ declare class BasePlaywright extends EventEmitter {
     protected makeLaunchOptions(opts: BrowserServerOptions): {
         args: string[];
         executablePath: string;
-        chromiumSandbox?: boolean | undefined;
-        devtools?: boolean | undefined;
-        downloadsPath?: string | undefined;
-        headless?: boolean | undefined;
-        ignoreDefaultArgs?: boolean | string[] | undefined;
+        chromiumSandbox?: boolean;
+        devtools?: boolean;
+        downloadsPath?: string;
+        headless?: boolean;
+        ignoreDefaultArgs?: boolean | string[];
         proxy?: {
-            bypass?: string | undefined;
-            password?: string | undefined;
+            bypass?: string;
+            password?: string;
             server: string;
-            username?: string | undefined;
-        } | undefined;
-        timeout?: number | undefined;
-        tracesDir?: string | undefined;
+            username?: string;
+        };
+        timeout?: number;
+        tracesDir?: string;
     };
     keepUntil(): number;
     isRunning(): boolean;
@@ -70,19 +66,19 @@ export declare class FirefoxPlaywright extends BasePlaywright {
     protected makeLaunchOptions(opts: BrowserServerOptions): {
         args: string[];
         executablePath: string;
-        chromiumSandbox?: boolean | undefined;
-        devtools?: boolean | undefined;
-        downloadsPath?: string | undefined;
-        headless?: boolean | undefined;
-        ignoreDefaultArgs?: boolean | string[] | undefined;
+        chromiumSandbox?: boolean;
+        devtools?: boolean;
+        downloadsPath?: string;
+        headless?: boolean;
+        ignoreDefaultArgs?: boolean | string[];
         proxy?: {
-            bypass?: string | undefined;
-            password?: string | undefined;
+            bypass?: string;
+            password?: string;
             server: string;
-            username?: string | undefined;
-        } | undefined;
-        timeout?: number | undefined;
-        tracesDir?: string | undefined;
+            username?: string;
+        };
+        timeout?: number;
+        tracesDir?: string;
     };
 }
 export declare class WebKitPlaywright extends BasePlaywright {
@@ -90,19 +86,19 @@ export declare class WebKitPlaywright extends BasePlaywright {
     protected makeLaunchOptions(opts: BrowserServerOptions): {
         args: string[];
         executablePath: string;
-        chromiumSandbox?: boolean | undefined;
-        devtools?: boolean | undefined;
-        downloadsPath?: string | undefined;
-        headless?: boolean | undefined;
-        ignoreDefaultArgs?: boolean | string[] | undefined;
+        chromiumSandbox?: boolean;
+        devtools?: boolean;
+        downloadsPath?: string;
+        headless?: boolean;
+        ignoreDefaultArgs?: boolean | string[];
         proxy?: {
-            bypass?: string | undefined;
-            password?: string | undefined;
+            bypass?: string;
+            password?: string;
             server: string;
-            username?: string | undefined;
-        } | undefined;
-        timeout?: number | undefined;
-        tracesDir?: string | undefined;
+            username?: string;
+        };
+        timeout?: number;
+        tracesDir?: string;
     };
 }
 export {};

package/build/browsers/index.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import { BrowserHTTPRoute, BrowserInstance, BrowserServerOptions, BrowserWebsocketRoute, BrowserlessSession, BrowserlessSessionJSON, CDPJSONPayload, CDPLaunchOptions, ChromiumCDP, Config, Hooks, Logger, Request } from '@browserless.io/browserless';
 import { Page } from 'puppeteer-core';
 export declare class BrowserManager {
@@ -46,7 +45,7 @@ export declare class BrowserManager {
         resolver(val: unknown): void;
         routePath: string | string[];
         startedOn: number;
-        trackingId?: string | undefined;
+        trackingId?: string;
         ttl: number;
         userDataDir: string | null;
     }[]>;

package/build/config.d.ts

@@ -1,5 +1,3 @@
-/// <reference types="node" />
-/// <reference types="node" />
 import { EventEmitter } from 'events';
 import playwright from 'playwright-core';
 export declare class Config extends EventEmitter {

package/build/file-system.d.ts

@@ -1,5 +1,3 @@
-/// <reference types="node" />
-/// <reference types="node" />
 import { Config, Logger } from '@browserless.io/browserless';
 import { EventEmitter } from 'events';
 export declare class FileSystem extends EventEmitter {

package/build/hooks.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import { AfterResponse, BeforeRequest, BrowserHook, PageHook } from '@browserless.io/browserless';
 import { EventEmitter } from 'events';
 export declare class Hooks extends EventEmitter {

package/build/http.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import { BrowserServerOptions, CDPLaunchOptions } from '@browserless.io/browserless';
 import http from 'http';
 export declare const errorCodes: {

package/build/limiter.d.ts

@@ -18,6 +18,11 @@ export declare class Limiter extends q {
     protected queued: number;
     protected logger: Logger;
     constructor(config: Config, metrics: Metrics, monitor: Monitoring, webhooks: WebHooks, hooks: Hooks);
+    protected _errorHandler({ detail: { error }, }: {
+        detail: {
+            error: unknown;
+        };
+    }): void;
     protected handleEnd(): void;
     protected jobEnd(jobInfo: AfterResponse): void;
     protected handleSuccess({ detail: { job } }: {

package/build/limiter.js

@@ -41,6 +41,9 @@ export class Limiter extends q {
         this.addEventListener('error', this.handleFail.bind(this));
         this.addEventListener('end', this.handleEnd.bind(this));
     }
+    _errorHandler({ detail: { error }, }) {
+        this.logger.error(error);
+    }
     handleEnd() {
         this.logQueue('All jobs complete.');
     }

package/build/limiter.spec.js

@@ -103,7 +103,7 @@ describe(`Limiter`, () => {
         const spy = () => new Promise((_r, rej) => rej(error));
         const job = limiter.limit(spy, asyncNoop, asyncNoop, noop);
         await job().catch(noop);
-        limiter.addEventListener('end', (res) => {
+        limiter.addEventListener('error', (res) => {
             // 'end' callback fires before the failed callback hooks do, so nextTick to wait
             process.nextTick(() => {
                 expect(res.detail.error).to.eql(error);

package/build/metrics.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import { IBrowserlessStats } from '@browserless.io/browserless';
 import { EventEmitter } from 'events';
 export declare class Metrics extends EventEmitter {

package/build/monitoring.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import { Config, IResourceLoad, Logger } from '@browserless.io/browserless';
 import { EventEmitter } from 'events';
 export declare class Monitoring extends EventEmitter {

package/build/router.d.ts

@@ -1,6 +1,3 @@
-/// <reference types="node" />
-/// <reference types="node" />
-/// <reference types="node" />
 import { BrowserHTTPRoute, BrowserManager, BrowserWebsocketRoute, Config, HTTPRoute, Limiter, Logger, Request, Response, WebSocketRoute } from '@browserless.io/browserless';
 import { EventEmitter } from 'events';
 import stream from 'stream';

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

@@ -109,7 +109,14 @@
       "type": "string"
     },
     "viewport": {
-      "$ref": "#/definitions/Viewport"
+      "anyOf": [
+        {
+          "$ref": "#/definitions/Viewport"
+        },
+        {
+          "type": "null"
+        }
+      ]
     },
     "waitForEvent": {
       "type": "object",
@@ -401,14 +408,14 @@
                 "length": {
                   "type": "number"
                 },
-                "__@toStringTag@11019": {
+                "__@toStringTag@32994": {
                   "type": "string",
                   "const": "Uint8Array"
                 }
               },
               "required": [
                 "BYTES_PER_ELEMENT",
-                "__@toStringTag@11019",
+                "__@toStringTag@32994",
                 "buffer",
                 "byteLength",
                 "byteOffset",
@@ -443,13 +450,13 @@
         "byteLength": {
           "type": "number"
         },
-        "__@toStringTag@11019": {
+        "__@toStringTag@32994": {
           "type": "string"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@toStringTag@11019",
+        "__@toStringTag@32994",
         "byteLength"
       ]
     },
@@ -459,18 +466,18 @@
         "byteLength": {
           "type": "number"
         },
-        "__@species@11120": {
+        "__@species@33095": {
           "$ref": "#/definitions/SharedArrayBuffer"
         },
-        "__@toStringTag@11019": {
+        "__@toStringTag@32994": {
           "type": "string",
           "const": "SharedArrayBuffer"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@species@11120",
-        "__@toStringTag@11019",
+        "__@species@33095",
+        "__@toStringTag@32994",
         "byteLength"
       ]
     },

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

@@ -111,7 +111,14 @@
       "type": "string"
     },
     "viewport": {
-      "$ref": "#/definitions/Viewport"
+      "anyOf": [
+        {
+          "$ref": "#/definitions/Viewport"
+        },
+        {
+          "type": "null"
+        }
+      ]
     },
     "waitForEvent": {
       "type": "object",
@@ -542,14 +549,14 @@
                 "length": {
                   "type": "number"
                 },
-                "__@toStringTag@242048": {
+                "__@toStringTag@88036": {
                   "type": "string",
                   "const": "Uint8Array"
                 }
               },
               "required": [
                 "BYTES_PER_ELEMENT",
-                "__@toStringTag@242048",
+                "__@toStringTag@88036",
                 "buffer",
                 "byteLength",
                 "byteOffset",
@@ -584,13 +591,13 @@
         "byteLength": {
           "type": "number"
         },
-        "__@toStringTag@242048": {
+        "__@toStringTag@88036": {
           "type": "string"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@toStringTag@242048",
+        "__@toStringTag@88036",
         "byteLength"
       ]
     },
@@ -600,18 +607,18 @@
         "byteLength": {
           "type": "number"
         },
-        "__@species@242149": {
+        "__@species@88137": {
           "$ref": "#/definitions/SharedArrayBuffer"
         },
-        "__@toStringTag@242048": {
+        "__@toStringTag@88036": {
           "type": "string",
           "const": "SharedArrayBuffer"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@species@242149",
-        "__@toStringTag@242048",
+        "__@species@88137",
+        "__@toStringTag@88036",
         "byteLength"
       ]
     },

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

@@ -117,7 +117,14 @@
       "type": "string"
     },
     "viewport": {
-      "$ref": "#/definitions/Viewport"
+      "anyOf": [
+        {
+          "$ref": "#/definitions/Viewport"
+        },
+        {
+          "type": "null"
+        }
+      ]
     },
     "waitForEvent": {
       "type": "object",
@@ -448,14 +455,14 @@
                 "length": {
                   "type": "number"
                 },
-                "__@toStringTag@87639": {
+                "__@toStringTag@121462": {
                   "type": "string",
                   "const": "Uint8Array"
                 }
               },
               "required": [
                 "BYTES_PER_ELEMENT",
-                "__@toStringTag@87639",
+                "__@toStringTag@121462",
                 "buffer",
                 "byteLength",
                 "byteOffset",
@@ -490,13 +497,13 @@
         "byteLength": {
           "type": "number"
         },
-        "__@toStringTag@87639": {
+        "__@toStringTag@121462": {
           "type": "string"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@toStringTag@87639",
+        "__@toStringTag@121462",
         "byteLength"
       ]
     },
@@ -506,18 +513,18 @@
         "byteLength": {
           "type": "number"
         },
-        "__@species@87740": {
+        "__@species@121563": {
           "$ref": "#/definitions/SharedArrayBuffer"
         },
-        "__@toStringTag@87639": {
+        "__@toStringTag@121462": {
           "type": "string",
           "const": "SharedArrayBuffer"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@species@87740",
-        "__@toStringTag@87639",
+        "__@species@121563",
+        "__@toStringTag@121462",
         "byteLength"
       ]
     },

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

@@ -117,7 +117,14 @@
       "type": "string"
     },
     "viewport": {
-      "$ref": "#/definitions/Viewport"
+      "anyOf": [
+        {
+          "$ref": "#/definitions/Viewport"
+        },
+        {
+          "type": "null"
+        }
+      ]
     },
     "waitForEvent": {
       "type": "object",
@@ -491,14 +498,14 @@
                 "length": {
                   "type": "number"
                 },
-                "__@toStringTag@98892": {
+                "__@toStringTag@110235": {
                   "type": "string",
                   "const": "Uint8Array"
                 }
               },
               "required": [
                 "BYTES_PER_ELEMENT",
-                "__@toStringTag@98892",
+                "__@toStringTag@110235",
                 "buffer",
                 "byteLength",
                 "byteOffset",
@@ -533,13 +540,13 @@
         "byteLength": {
           "type": "number"
         },
-        "__@toStringTag@98892": {
+        "__@toStringTag@110235": {
           "type": "string"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@toStringTag@98892",
+        "__@toStringTag@110235",
         "byteLength"
       ]
     },
@@ -549,18 +556,18 @@
         "byteLength": {
           "type": "number"
         },
-        "__@species@98993": {
+        "__@species@110336": {
           "$ref": "#/definitions/SharedArrayBuffer"
         },
-        "__@toStringTag@98892": {
+        "__@toStringTag@110235": {
           "type": "string",
           "const": "SharedArrayBuffer"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@species@98993",
-        "__@toStringTag@98892",
+        "__@species@110336",
+        "__@toStringTag@110235",
         "byteLength"
       ]
     },

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

@@ -109,7 +109,14 @@
       "type": "string"
     },
     "viewport": {
-      "$ref": "#/definitions/Viewport"
+      "anyOf": [
+        {
+          "$ref": "#/definitions/Viewport"
+        },
+        {
+          "type": "null"
+        }
+      ]
     },
     "waitForEvent": {
       "type": "object",
@@ -401,14 +408,14 @@
                 "length": {
                   "type": "number"
                 },
-                "__@toStringTag@110055": {
+                "__@toStringTag@132742": {
                   "type": "string",
                   "const": "Uint8Array"
                 }
               },
               "required": [
                 "BYTES_PER_ELEMENT",
-                "__@toStringTag@110055",
+                "__@toStringTag@132742",
                 "buffer",
                 "byteLength",
                 "byteOffset",
@@ -443,13 +450,13 @@
         "byteLength": {
           "type": "number"
         },
-        "__@toStringTag@110055": {
+        "__@toStringTag@132742": {
           "type": "string"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@toStringTag@110055",
+        "__@toStringTag@132742",
         "byteLength"
       ]
     },
@@ -459,18 +466,18 @@
         "byteLength": {
           "type": "number"
         },
-        "__@species@110156": {
+        "__@species@132843": {
           "$ref": "#/definitions/SharedArrayBuffer"
         },
-        "__@toStringTag@110055": {
+        "__@toStringTag@132742": {
           "type": "string",
           "const": "SharedArrayBuffer"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@species@110156",
-        "__@toStringTag@110055",
+        "__@species@132843",
+        "__@toStringTag@132742",
         "byteLength"
       ]
     },

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

@@ -111,7 +111,14 @@
       "type": "string"
     },
     "viewport": {
-      "$ref": "#/definitions/Viewport"
+      "anyOf": [
+        {
+          "$ref": "#/definitions/Viewport"
+        },
+        {
+          "type": "null"
+        }
+      ]
     },
     "waitForEvent": {
       "type": "object",
@@ -542,14 +549,14 @@
                 "length": {
                   "type": "number"
                 },
-                "__@toStringTag@208437": {
+                "__@toStringTag@220645": {
                   "type": "string",
                   "const": "Uint8Array"
                 }
               },
               "required": [
                 "BYTES_PER_ELEMENT",
-                "__@toStringTag@208437",
+                "__@toStringTag@220645",
                 "buffer",
                 "byteLength",
                 "byteOffset",
@@ -584,13 +591,13 @@
         "byteLength": {
           "type": "number"
         },
-        "__@toStringTag@208437": {
+        "__@toStringTag@220645": {
           "type": "string"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@toStringTag@208437",
+        "__@toStringTag@220645",
         "byteLength"
       ]
     },
@@ -600,18 +607,18 @@
         "byteLength": {
           "type": "number"
         },
-        "__@species@208538": {
+        "__@species@220746": {
           "$ref": "#/definitions/SharedArrayBuffer"
         },
-        "__@toStringTag@208437": {
+        "__@toStringTag@220645": {
           "type": "string",
           "const": "SharedArrayBuffer"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@species@208538",
-        "__@toStringTag@208437",
+        "__@species@220746",
+        "__@toStringTag@220645",
         "byteLength"
       ]
     },