@browserless.io/browserless 2.2.0-beta-2 → 2.2.0-beta-4

package/build/browsers/index.js

@@ -108,6 +108,10 @@ export class BrowserManager {
     close = async (browser, session) => {
         const cleanupACtions = [];
         this.debug(`${session.numbConnected} Client(s) are currently connected`);
+        // Don't close if there's clients still connected
+        if (session.numbConnected > 0) {
+            return;
+        }
         this.debug(`Closing browser session`);
         cleanupACtions.push(() => browser.close());
         if (session.isTempDataDir) {
@@ -150,10 +154,12 @@ export class BrowserManager {
         if (req.parsed.pathname.includes('/devtools/browser')) {
             const sessions = Array.from(this.browsers);
             const id = req.parsed.pathname.split('/').pop();
-            const browser = sessions.find(([b]) => b.wsEndpoint()?.includes(req.parsed.pathname));
-            if (browser) {
+            const found = sessions.find(([b]) => b.wsEndpoint()?.includes(req.parsed.pathname));
+            if (found) {
+                const [browser, session] = found;
+                ++session.numbConnected;
                 this.debug(`Located browser with ID ${id}`);
-                return browser[0];
+                return browser;
             }
             throw new NotFound(`Couldn't locate browser "${id}" for request "${req.parsed.pathname}"`);
         }

package/build/router.js

@@ -46,15 +46,22 @@ export class Router {
                 return Promise.resolve();
             }
             if (!browser) {
-                return writeResponse(res, 500, `Error loading the browser.`);
-            }
-            if (!isConnected(res)) {
-                this.log(`HTTP Request has closed prior to running`);
-                return Promise.resolve();
+                return writeResponse(res, 500, `Error loading the browser`);
             }
             try {
                 this.verbose(`Running found HTTP handler.`);
-                return await handler(req, res, browser);
+                return await Promise.race([
+                    handler(req, res, browser),
+                    new Promise((resolve, reject) => {
+                        res.once('close', () => {
+                            if (!res.writableEnded) {
+                                reject(new Error(`Request closed prior to writing results`));
+                            }
+                            this.verbose(`Response has been written, resolving`);
+                            resolve(null);
+                        });
+                    }),
+                ]);
             }
             finally {
                 this.verbose(`HTTP Request handler has finished.`);

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

@@ -23,7 +23,7 @@
     "cookies": {
       "type": "array",
       "items": {
-        "$ref": "#/definitions/Protocol.Network.CookieParam"
+        "$ref": "#/definitions/CookieParam"
       }
     },
     "emulateMediaType": {
@@ -230,7 +230,7 @@
         "username"
       ]
     },
-    "Protocol.Network.CookieParam": {
+    "CookieParam": {
       "description": "Cookie parameter object",
       "type": "object",
       "properties": {
@@ -243,7 +243,7 @@
           "type": "string"
         },
         "url": {
-          "description": "The request-URI to associate with the setting of the cookie. This value can affect the\ndefault domain, path, source port, and source scheme values of the created cookie.",
+          "description": "The request-URI to associate with the setting of the cookie. This value can affect\nthe default domain, path, and source scheme values of the created cookie.",
           "type": "string"
         },
         "domain": {
@@ -276,7 +276,7 @@
           "type": "number"
         },
         "priority": {
-          "description": "Cookie Priority.",
+          "description": "Cookie Priority. Supported only in Chrome.",
           "enum": [
             "High",
             "Low",
@@ -285,11 +285,11 @@
           "type": "string"
         },
         "sameParty": {
-          "description": "True if cookie is SameParty.",
+          "description": "True if cookie is SameParty. Supported only in Chrome.",
           "type": "boolean"
         },
         "sourceScheme": {
-          "description": "Cookie source scheme type.",
+          "description": "Cookie source scheme type. Supported only in Chrome.",
           "enum": [
             "NonSecure",
             "Secure",
@@ -297,12 +297,8 @@
           ],
           "type": "string"
         },
-        "sourcePort": {
-          "description": "Cookie source port. Valid values are {-1, [1, 65535]}, -1 indicates an unspecified port.\nAn unspecified port value allows protocol clients to emulate legacy cookie scope for the port.\nThis is a temporary ability and it will be removed in the future.",
-          "type": "number"
-        },
         "partitionKey": {
-          "description": "Cookie partition key. The site of the top-level URL the browser was visiting at the start\nof the request to the endpoint that set the cookie.\nIf not set, the cookie will be set as not partitioned.",
+          "description": "Cookie partition key. The site of the top-level URL the browser was visiting at the\nstart of the request to the endpoint that set the cookie. If not set, the cookie will\nbe set as not partitioned.",
           "type": "string"
         }
       },
@@ -398,14 +394,14 @@
                 "length": {
                   "type": "number"
                 },
-                "__@toStringTag@10788": {
+                "__@toStringTag@10774": {
                   "type": "string",
                   "const": "Uint8Array"
                 }
               },
               "required": [
                 "BYTES_PER_ELEMENT",
-                "__@toStringTag@10788",
+                "__@toStringTag@10774",
                 "buffer",
                 "byteLength",
                 "byteOffset",
@@ -440,13 +436,13 @@
         "byteLength": {
           "type": "number"
         },
-        "__@toStringTag@10788": {
+        "__@toStringTag@10774": {
           "type": "string"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@toStringTag@10788",
+        "__@toStringTag@10774",
         "byteLength"
       ]
     },
@@ -456,18 +452,18 @@
         "byteLength": {
           "type": "number"
         },
-        "__@species@10889": {
+        "__@species@10875": {
           "$ref": "#/definitions/SharedArrayBuffer"
         },
-        "__@toStringTag@10788": {
+        "__@toStringTag@10774": {
           "type": "string",
           "const": "SharedArrayBuffer"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@species@10889",
-        "__@toStringTag@10788",
+        "__@species@10875",
+        "__@toStringTag@10774",
         "byteLength"
       ]
     },

package/build/routes/chromium/http/content-post.d.ts

@@ -22,7 +22,7 @@ export interface BodySchema {
     waitForEvent?: WaitForEventOptions;
     waitForFunction?: WaitForFunctionOptions;
     waitForSelector?: WaitForSelectorOptions;
-    waitForTimeout?: Parameters<Page['waitForTimeout']>[0];
+    waitForTimeout?: number;
 }
 /**
  * An HTML payload of the website or HTML after JavaScript

package/build/routes/chromium/http/content-post.js

@@ -1,4 +1,4 @@
-import { APITags, BadRequest, BrowserHTTPRoute, CDPChromium, HTTPRoutes, Methods, bestAttemptCatch, contentTypes, noop, waitForEvent as waitForEvt, waitForFunction as waitForFn, writeResponse, } from '@browserless.io/browserless';
+import { APITags, BadRequest, BrowserHTTPRoute, CDPChromium, HTTPRoutes, Methods, bestAttemptCatch, contentTypes, noop, sleep, waitForEvent as waitForEvt, waitForFunction as waitForFn, writeResponse, } from '@browserless.io/browserless';
 export default class ContentPostRoute extends BrowserHTTPRoute {
     accepts = [contentTypes.json];
     auth = true;
@@ -73,9 +73,7 @@ export default class ContentPostRoute extends BrowserHTTPRoute {
         }
         const gotoResponse = await gotoCall(content, gotoOptions).catch(bestAttemptCatch(bestAttempt));
         if (waitForTimeout) {
-            await page
-                .waitForTimeout(waitForTimeout)
-                .catch(bestAttemptCatch(bestAttempt));
+            await sleep(waitForTimeout).catch(bestAttemptCatch(bestAttempt));
         }
         if (waitForFunction) {
             await waitForFn(page, waitForFunction).catch(bestAttemptCatch(bestAttempt));

package/build/routes/chromium/http/content-post.query.json

@@ -76,7 +76,7 @@
         "headless": {
           "enum": [
             false,
-            "new",
+            "shell",
             true
           ]
         },

package/build/routes/chromium/http/download-post.query.json

@@ -77,7 +77,7 @@
         "headless": {
           "enum": [
             false,
-            "new",
+            "shell",
             true
           ]
         },

package/build/routes/chromium/http/function-post.query.json

@@ -77,7 +77,7 @@
         "headless": {
           "enum": [
             false,
-            "new",
+            "shell",
             true
           ]
         },

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

@@ -26,7 +26,7 @@
     "cookies": {
       "type": "array",
       "items": {
-        "$ref": "#/definitions/Protocol.Network.CookieParam"
+        "$ref": "#/definitions/CookieParam"
       }
     },
     "emulateMediaType": {
@@ -235,7 +235,7 @@
         "username"
       ]
     },
-    "Protocol.Network.CookieParam": {
+    "CookieParam": {
       "description": "Cookie parameter object",
       "type": "object",
       "properties": {
@@ -248,7 +248,7 @@
           "type": "string"
         },
         "url": {
-          "description": "The request-URI to associate with the setting of the cookie. This value can affect the\ndefault domain, path, source port, and source scheme values of the created cookie.",
+          "description": "The request-URI to associate with the setting of the cookie. This value can affect\nthe default domain, path, and source scheme values of the created cookie.",
           "type": "string"
         },
         "domain": {
@@ -281,7 +281,7 @@
           "type": "number"
         },
         "priority": {
-          "description": "Cookie Priority.",
+          "description": "Cookie Priority. Supported only in Chrome.",
           "enum": [
             "High",
             "Low",
@@ -290,11 +290,11 @@
           "type": "string"
         },
         "sameParty": {
-          "description": "True if cookie is SameParty.",
+          "description": "True if cookie is SameParty. Supported only in Chrome.",
           "type": "boolean"
         },
         "sourceScheme": {
-          "description": "Cookie source scheme type.",
+          "description": "Cookie source scheme type. Supported only in Chrome.",
           "enum": [
             "NonSecure",
             "Secure",
@@ -302,12 +302,8 @@
           ],
           "type": "string"
         },
-        "sourcePort": {
-          "description": "Cookie source port. Valid values are {-1, [1, 65535]}, -1 indicates an unspecified port.\nAn unspecified port value allows protocol clients to emulate legacy cookie scope for the port.\nThis is a temporary ability and it will be removed in the future.",
-          "type": "number"
-        },
         "partitionKey": {
-          "description": "Cookie partition key. The site of the top-level URL the browser was visiting at the start\nof the request to the endpoint that set the cookie.\nIf not set, the cookie will be set as not partitioned.",
+          "description": "Cookie partition key. The site of the top-level URL the browser was visiting at the\nstart of the request to the endpoint that set the cookie. If not set, the cookie will\nbe set as not partitioned.",
           "type": "string"
         }
       },
@@ -542,14 +538,14 @@
                 "length": {
                   "type": "number"
                 },
-                "__@toStringTag@161037": {
+                "__@toStringTag@85666": {
                   "type": "string",
                   "const": "Uint8Array"
                 }
               },
               "required": [
                 "BYTES_PER_ELEMENT",
-                "__@toStringTag@161037",
+                "__@toStringTag@85666",
                 "buffer",
                 "byteLength",
                 "byteOffset",
@@ -584,13 +580,13 @@
         "byteLength": {
           "type": "number"
         },
-        "__@toStringTag@161037": {
+        "__@toStringTag@85666": {
           "type": "string"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@toStringTag@161037",
+        "__@toStringTag@85666",
         "byteLength"
       ]
     },
@@ -600,18 +596,18 @@
         "byteLength": {
           "type": "number"
         },
-        "__@species@161138": {
+        "__@species@85767": {
           "$ref": "#/definitions/SharedArrayBuffer"
         },
-        "__@toStringTag@161037": {
+        "__@toStringTag@85666": {
           "type": "string",
           "const": "SharedArrayBuffer"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@species@161138",
-        "__@toStringTag@161037",
+        "__@species@85767",
+        "__@toStringTag@85666",
         "byteLength"
       ]
     },

package/build/routes/chromium/http/pdf-post.d.ts

@@ -24,7 +24,7 @@ export interface BodySchema {
     waitForEvent?: WaitForEventOptions;
     waitForFunction?: WaitForFunctionOptions;
     waitForSelector?: WaitForSelectorOptions;
-    waitForTimeout?: Parameters<Page['waitForTimeout']>[0];
+    waitForTimeout?: number;
 }
 export interface QuerySchema extends SystemQueryParameters {
     launch?: CDPLaunchOptions | string;

package/build/routes/chromium/http/pdf-post.js

@@ -1,4 +1,5 @@
-import { APITags, BadRequest, BrowserHTTPRoute, CDPChromium, HTTPRoutes, Methods, bestAttemptCatch, contentTypes, dedent, noop, waitForEvent as waitForEvt, waitForFunction as waitForFn, writeResponse, } from '@browserless.io/browserless';
+import { APITags, BadRequest, BrowserHTTPRoute, CDPChromium, 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 {
     accepts = [contentTypes.json];
     auth = true;
@@ -23,7 +24,7 @@ export default class PDFPost extends BrowserHTTPRoute {
             return;
         }
         res.setHeader('Content-Type', contentType);
-        const { url, gotoOptions, authenticate, html, addScriptTag = [], addStyleTag = [], cookies = [], emulateMediaType, rejectRequestPattern = [], requestInterceptors = [], rejectResourceTypes = [], options, setExtraHTTPHeaders, setJavaScriptEnabled, userAgent, viewport, waitForFunction, waitForSelector, waitForEvent, bestAttempt = false, } = req.body;
+        const { url, gotoOptions, authenticate, html, addScriptTag = [], addStyleTag = [], cookies = [], emulateMediaType, rejectRequestPattern = [], requestInterceptors = [], rejectResourceTypes = [], options, setExtraHTTPHeaders, setJavaScriptEnabled, userAgent, viewport, waitForEvent, waitForFunction, waitForSelector, waitForTimeout, bestAttempt = false, } = req.body;
         const content = url || html;
         if (!content) {
             throw new BadRequest(`One of "url" or "html" properties are required.`);
@@ -78,6 +79,9 @@ export default class PDFPost extends BrowserHTTPRoute {
             }
         }
         const gotoResponse = await gotoCall(content, gotoOptions).catch(bestAttemptCatch(bestAttempt));
+        if (waitForTimeout) {
+            await sleep(waitForTimeout).catch(bestAttemptCatch(bestAttempt));
+        }
         if (waitForFunction) {
             await waitForFn(page, waitForFunction).catch(bestAttemptCatch(bestAttempt));
         }
@@ -102,10 +106,10 @@ export default class PDFPost extends BrowserHTTPRoute {
                 res.setHeader(key, value);
             }
         }
-        const pdfStream = await page.createPDFStream(options);
-        await new Promise((resolve, reject) => {
-            return pdfStream.pipe(res).once('finish', resolve).once('error', reject);
-        });
+        const pdfBuffer = await page.pdf(options);
+        const readStream = new Stream.PassThrough();
+        readStream.end(pdfBuffer);
+        await new Promise((r) => readStream.pipe(res).once('close', r));
         page.close().catch(noop);
     };
 }

package/build/routes/chromium/http/pdf-post.query.json

@@ -77,7 +77,7 @@
         "headless": {
           "enum": [
             false,
-            "new",
+            "shell",
             true
           ]
         },

package/build/routes/chromium/http/performance.query.json

@@ -77,7 +77,7 @@
         "headless": {
           "enum": [
             false,
-            "new",
+            "shell",
             true
           ]
         },

package/build/routes/chromium/http/scrape-post.body.json

@@ -23,7 +23,7 @@
     "cookies": {
       "type": "array",
       "items": {
-        "$ref": "#/definitions/Protocol.Network.CookieParam"
+        "$ref": "#/definitions/CookieParam"
       }
     },
     "debugOpts": {
@@ -241,7 +241,7 @@
         "username"
       ]
     },
-    "Protocol.Network.CookieParam": {
+    "CookieParam": {
       "description": "Cookie parameter object",
       "type": "object",
       "properties": {
@@ -254,7 +254,7 @@
           "type": "string"
         },
         "url": {
-          "description": "The request-URI to associate with the setting of the cookie. This value can affect the\ndefault domain, path, source port, and source scheme values of the created cookie.",
+          "description": "The request-URI to associate with the setting of the cookie. This value can affect\nthe default domain, path, and source scheme values of the created cookie.",
           "type": "string"
         },
         "domain": {
@@ -287,7 +287,7 @@
           "type": "number"
         },
         "priority": {
-          "description": "Cookie Priority.",
+          "description": "Cookie Priority. Supported only in Chrome.",
           "enum": [
             "High",
             "Low",
@@ -296,11 +296,11 @@
           "type": "string"
         },
         "sameParty": {
-          "description": "True if cookie is SameParty.",
+          "description": "True if cookie is SameParty. Supported only in Chrome.",
           "type": "boolean"
         },
         "sourceScheme": {
-          "description": "Cookie source scheme type.",
+          "description": "Cookie source scheme type. Supported only in Chrome.",
           "enum": [
             "NonSecure",
             "Secure",
@@ -308,12 +308,8 @@
           ],
           "type": "string"
         },
-        "sourcePort": {
-          "description": "Cookie source port. Valid values are {-1, [1, 65535]}, -1 indicates an unspecified port.\nAn unspecified port value allows protocol clients to emulate legacy cookie scope for the port.\nThis is a temporary ability and it will be removed in the future.",
-          "type": "number"
-        },
         "partitionKey": {
-          "description": "Cookie partition key. The site of the top-level URL the browser was visiting at the start\nof the request to the endpoint that set the cookie.\nIf not set, the cookie will be set as not partitioned.",
+          "description": "Cookie partition key. The site of the top-level URL the browser was visiting at the\nstart of the request to the endpoint that set the cookie. If not set, the cookie will\nbe set as not partitioned.",
           "type": "string"
         }
       },
@@ -445,14 +441,14 @@
                 "length": {
                   "type": "number"
                 },
-                "__@toStringTag@96403": {
+                "__@toStringTag@96598": {
                   "type": "string",
                   "const": "Uint8Array"
                 }
               },
               "required": [
                 "BYTES_PER_ELEMENT",
-                "__@toStringTag@96403",
+                "__@toStringTag@96598",
                 "buffer",
                 "byteLength",
                 "byteOffset",
@@ -487,13 +483,13 @@
         "byteLength": {
           "type": "number"
         },
-        "__@toStringTag@96403": {
+        "__@toStringTag@96598": {
           "type": "string"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@toStringTag@96403",
+        "__@toStringTag@96598",
         "byteLength"
       ]
     },
@@ -503,18 +499,18 @@
         "byteLength": {
           "type": "number"
         },
-        "__@species@96504": {
+        "__@species@96699": {
           "$ref": "#/definitions/SharedArrayBuffer"
         },
-        "__@toStringTag@96403": {
+        "__@toStringTag@96598": {
           "type": "string",
           "const": "SharedArrayBuffer"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@species@96504",
-        "__@toStringTag@96403",
+        "__@species@96699",
+        "__@toStringTag@96598",
         "byteLength"
       ]
     },

package/build/routes/chromium/http/scrape-post.d.ts

@@ -1,6 +1,6 @@
 /// <reference types="node" />
 import { APITags, BrowserHTTPRoute, BrowserInstance, CDPChromium, CDPLaunchOptions, HTTPRoutes, InBoundRequest, Methods, OutBoundRequest, Request, ScrapeDebugOptions, ScrapeElementSelector, SystemQueryParameters, WaitForEventOptions, WaitForFunctionOptions, WaitForSelectorOptions, bestAttempt, contentTypes, rejectRequestPattern, rejectResourceTypes, requestInterceptors } from '@browserless.io/browserless';
-import { Page, Protocol } from 'puppeteer-core';
+import { Cookie, Page } from 'puppeteer-core';
 import { ServerResponse } from 'http';
 export interface BodySchema {
     addScriptTag?: Array<Parameters<Page['addScriptTag']>[0]>;
@@ -24,7 +24,7 @@ export interface BodySchema {
     waitForEvent?: WaitForEventOptions;
     waitForFunction?: WaitForFunctionOptions;
     waitForSelector?: WaitForSelectorOptions;
-    waitForTimeout?: Parameters<Page['waitForTimeout']>[0];
+    waitForTimeout?: number;
 }
 export type QuerySchema = SystemQueryParameters & {
     launch?: CDPLaunchOptions | string;
@@ -89,7 +89,7 @@ export interface ResponseSchema {
         /**
          * List of cookies for the site or null
          */
-        cookies: Protocol.Network.Cookie[] | null;
+        cookies: Cookie[] | null;
         /**
          * The HTML string of the website or null
          */

package/build/routes/chromium/http/scrape-post.js

@@ -1,4 +1,4 @@
-import { APITags, BadRequest, BrowserHTTPRoute, CDPChromium, HTTPRoutes, Methods, Timeout, bestAttemptCatch, contentTypes, debugScreenshotOpts, dedent, jsonResponse, noop, waitForEvent as waitForEvt, waitForFunction as waitForFn, } from '@browserless.io/browserless';
+import { APITags, BadRequest, BrowserHTTPRoute, CDPChromium, 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) => {
@@ -141,9 +141,7 @@ export default class ScrapePost extends BrowserHTTPRoute {
             }
         }
         if (waitForTimeout) {
-            await page
-                .waitForTimeout(waitForTimeout)
-                .catch(bestAttemptCatch(bestAttempt));
+            await sleep(waitForTimeout).catch(bestAttemptCatch(bestAttempt));
         }
         if (waitForFunction) {
             await waitForFn(page, waitForFunction).catch(bestAttemptCatch(bestAttempt));

package/build/routes/chromium/http/scrape-post.query.json

@@ -76,7 +76,7 @@
         "headless": {
           "enum": [
             false,
-            "new",
+            "shell",
             true
           ]
         },