@browserless.io/browserless 2.37.0 → 2.37.1

package/src/routes/management/tests/management.spec.ts

@@ -151,6 +151,72 @@ describe('Management APIs', function () {
     });
   });
 
+  describe('Static Files Serving', () => {
+    it('serves docs pages', async () => {
+      await start();
+
+      await fetch(
+        'http://localhost:3000/docs/index.html?token=6R0W53R135510',
+      ).then(async (res) => {
+        expect(res.status).to.equal(200);
+        expect(res.headers.get('content-type')).to.equal('text/html');
+        const content = await res.text();
+        expect(content).to.include('<title>Browserless Docs</title>');
+      });
+
+      await fetch(
+        'http://localhost:3000/docs/docs.js?token=6R0W53R135510',
+      ).then(async (res) => {
+        expect(res.status).to.equal(200);
+        expect(res.headers.get('content-type')).to.equal(
+          'application/javascript',
+        );
+        const content = await res.text();
+        expect(content).to.be.an('string');
+      });
+    });
+
+    it('serves swagger.json', async () => {
+      await start();
+
+      await fetch(
+        'http://localhost:3000/docs/swagger.json?token=6R0W53R135510',
+      ).then(async (res) => {
+        expect(res.status).to.equal(200);
+        expect(res.headers.get('content-type')).to.equal('application/json');
+        const content = await res.json();
+        expect(content).to.be.an('object');
+      });
+    });
+
+    it('returns 404 if debugger is disabled', async () => {
+      process.env.ENABLE_DEBUGGER = 'false';
+      const config = new Config();
+      config.setToken('6R0W53R135510');
+      // Ensure debugger is not available
+
+      await start({ config });
+
+      await fetch(
+        'http://localhost:3000/debugger/some-file.html?token=6R0W53R135510',
+      ).then(async (res) => {
+        expect(res.status).to.equal(404);
+        expect(res.headers.get('content-type')).to.equal(
+          'text/plain; charset=UTF-8',
+        );
+      });
+    });
+
+    it('handles requests without authentication token for static files', async () => {
+      await start();
+
+      await fetch('http://localhost:3000/docs/index.html').then(async (res) => {
+        expect(res.status).to.equal(200);
+        expect(res.headers.get('content-type')).to.equal('text/html');
+      });
+    });
+  });
+
   it('allows requests to /config', async () => {
     await start();
 

package/src/server.ts

@@ -424,7 +424,7 @@ export class HTTPServer extends EventEmitter {
 
   public async shutdown(): Promise<void> {
     this.logger.info(`HTTP Server is shutting down`);
-    await new Promise((r) => this.server.close(r));
+    await new Promise((r) => this.server?.close(r));
 
     if (this.server) {
       this.server.removeAllListeners();

package/src/shared/screenshot.http.ts

@@ -63,7 +63,7 @@ export interface BodySchema {
   url?: Parameters<Page['goto']>[0];
   userAgent?: Parameters<Page['setUserAgent']>[0];
   viewport?: Parameters<Page['setViewport']>[0];
-  waitForEvent?: WaitForEventOptions;
+  waitForEvent?: WaitForEventOptions;                                                       
   waitForFunction?: WaitForFunctionOptions;
   waitForSelector?: WaitForSelectorOptions;
   waitForTimeout?: number;

package/src/shim.spec.ts

@@ -174,6 +174,24 @@ describe('Request Shimming', () => {
     });
   });
 
+  describe('insecure certs', () => {
+    it('converts ignoreHTTPSErrors to acceptInsecureCerts', () => {
+      const url = 'wss://localhost?ignoreHTTPSErrors';
+      const final = 'wss://localhost/?launch={"acceptInsecureCerts":true}';
+      const shimmed = shimLegacyRequests(new URL(url));
+
+      expect(decodeURIComponent(shimmed.href)).to.equal(final);
+    });
+
+    it('acceptInsecureCerts takes precedence over ignoreHTTPSErrors', () => {
+      const url = 'wss://localhost?ignoreHTTPSErrors&launch={"acceptInsecureCerts":false}';
+      const final = 'wss://localhost/?launch={"acceptInsecureCerts":false}';
+      const shimmed = shimLegacyRequests(new URL(url));
+
+      expect(decodeURIComponent(shimmed.href)).to.equal(final);
+    });
+  });
+
   describe('token shimming', () => {
     it('converts token query parameters to an authorization header', () => {
       const url = 'wss://localhost?token=12345';

package/src/shim.ts

@@ -5,7 +5,7 @@ import {
   safeParse,
 } from '@browserless.io/browserless';
 
-const shimParam = ['headless', 'stealth', 'ignoreDefaultArgs', 'slowMo'];
+const shimParam = ['headless', 'stealth', 'ignoreDefaultArgs', 'slowMo', 'ignoreHTTPSErrors'];
 
 /**
  * Obfuscates the ?token parameter by shifting it to a header instead of a query-parameter.
@@ -74,6 +74,20 @@ export function shimLegacyRequests(url: URL): URL {
       launchParams.ignoreHTTPSErrors = ignoreHTTPSErrors !== 'false';
     }
 
+    // When acceptInsecureCerts is set, ignoreHTTPSErrors is ignored
+    if (launchParams.acceptInsecureCerts !== undefined) {
+      launchParams.ignoreHTTPSErrors = undefined;
+    }
+
+    // When ignoreHTTPSErrors sent, convert it to acceptInsecureCerts
+    if (
+      typeof ignoreHTTPSErrors !== 'undefined' &&
+      launchParams.acceptInsecureCerts === undefined
+    ) {
+      launchParams.acceptInsecureCerts = ignoreHTTPSErrors !== 'false';
+      launchParams.ignoreHTTPSErrors = undefined;
+    }
+
     if (
       typeof ignoreDefaultArgs !== 'undefined' &&
       launchParams.ignoreDefaultArgs === undefined

package/src/types.ts

@@ -373,7 +373,9 @@ export interface CDPLaunchOptions extends BrowserlessLaunch {
   dumpio?: boolean;
   headless?: boolean | 'shell';
   ignoreDefaultArgs?: boolean | string[];
+  /** @deprecated use acceptInsecureCerts field instead */
   ignoreHTTPSErrors?: boolean;
+  acceptInsecureCerts?: boolean;
   slowMo?: number;
   stealth?: boolean;
   timeout?: number;

package/static/docs/swagger.json

@@ -425,6 +425,9 @@
         "ignoreHTTPSErrors": {
           "type": "boolean"
         },
+        "acceptInsecureCerts": {
+          "type": "boolean"
+        },
         "slowMo": {
           "type": "number"
         },
@@ -981,7 +984,7 @@
   },
   "info": {
     "title": "Browserless",
-    "version": "2.37.0",
+    "version": "2.37.1",
     "x-logo": {
       "altText": "browserless logo",
       "url": "./docs/browserless-logo-inline.svg"

package/static/docs/swagger.min.json

@@ -425,6 +425,9 @@
         "ignoreHTTPSErrors": {
           "type": "boolean"
         },
+        "acceptInsecureCerts": {
+          "type": "boolean"
+        },
         "slowMo": {
           "type": "number"
         },
@@ -981,7 +984,7 @@
   },
   "info": {
     "title": "Browserless",
-    "version": "2.37.0",
+    "version": "2.37.1",
     "x-logo": {
       "altText": "browserless logo",
       "url": "./docs/browserless-logo-inline.svg"

package/static/function/client.js

@@ -4422,7 +4422,7 @@
   // node_modules/puppeteer-core/lib/esm/puppeteer/generated/version.js
   init_dirname();
   init_buffer2();
-  var packageVersion = "24.22.3";
+  var packageVersion = "24.23.0";
 
   // node_modules/puppeteer-core/lib/esm/puppeteer/util/assert.js
   init_dirname();
@@ -7399,14 +7399,12 @@
        * import {KnownDevices} from 'puppeteer';
        * const iPhone = KnownDevices['iPhone 15 Pro'];
        *
-       * (async () => {
-       *   const browser = await puppeteer.launch();
-       *   const page = await browser.newPage();
-       *   await page.emulate(iPhone);
-       *   await page.goto('https://www.google.com');
-       *   // other actions...
-       *   await browser.close();
-       * })();
+       * const browser = await puppeteer.launch();
+       * const page = await browser.newPage();
+       * await page.emulate(iPhone);
+       * await page.goto('https://www.google.com');
+       * // other actions...
+       * await browser.close();
        * ```
        */
       async emulate(device) {
@@ -7947,22 +7945,21 @@
        *
        * ```ts
        * import puppeteer from 'puppeteer';
-       * (async () => {
-       *   const browser = await puppeteer.launch();
-       *   const page = await browser.newPage();
-       *   let currentURL;
-       *   page
-       *     .waitForSelector('img')
-       *     .then(() => console.log('First URL with image: ' + currentURL));
-       *   for (currentURL of [
-       *     'https://example.com',
-       *     'https://google.com',
-       *     'https://bbc.com',
-       *   ]) {
-       *     await page.goto(currentURL);
-       *   }
-       *   await browser.close();
-       * })();
+       *
+       * const browser = await puppeteer.launch();
+       * const page = await browser.newPage();
+       * let currentURL;
+       * page
+       *   .waitForSelector('img')
+       *   .then(() => console.log('First URL with image: ' + currentURL));
+       * for (currentURL of [
+       *   'https://example.com',
+       *   'https://google.com',
+       *   'https://bbc.com',
+       * ]) {
+       *   await page.goto(currentURL);
+       * }
+       * await browser.close();
        * ```
        *
        * @param selector -
@@ -8012,14 +8009,13 @@
        *
        * ```ts
        * import puppeteer from 'puppeteer';
-       * (async () => {
-       *   const browser = await puppeteer.launch();
-       *   const page = await browser.newPage();
-       *   const watchDog = page.waitForFunction('window.innerWidth < 100');
-       *   await page.setViewport({width: 50, height: 50});
-       *   await watchDog;
-       *   await browser.close();
-       * })();
+       *
+       * const browser = await puppeteer.launch();
+       * const page = await browser.newPage();
+       * const watchDog = page.waitForFunction('window.innerWidth < 100');
+       * await page.setViewport({width: 50, height: 50});
+       * await watchDog;
+       * await browser.close();
        * ```
        *
        * @example
@@ -11288,24 +11284,22 @@
        * ```ts
        * import puppeteer from 'puppeteer';
        *
-       * (async () => {
-       *   const browser = await puppeteer.launch();
-       *   const page = await browser.newPage();
-       *   let currentURL;
-       *   page
-       *     .mainFrame()
-       *     .waitForSelector('img')
-       *     .then(() => console.log('First URL with image: ' + currentURL));
+       * const browser = await puppeteer.launch();
+       * const page = await browser.newPage();
+       * let currentURL;
+       * page
+       *   .mainFrame()
+       *   .waitForSelector('img')
+       *   .then(() => console.log('First URL with image: ' + currentURL));
        *
-       *   for (currentURL of [
-       *     'https://example.com',
-       *     'https://google.com',
-       *     'https://bbc.com',
-       *   ]) {
-       *     await page.goto(currentURL);
-       *   }
-       *   await browser.close();
-       * })();
+       * for (currentURL of [
+       *   'https://example.com',
+       *   'https://google.com',
+       *   'https://bbc.com',
+       * ]) {
+       *   await page.goto(currentURL);
+       * }
+       * await browser.close();
        * ```
        *
        * @param selector - The selector to query and wait for.
@@ -11327,14 +11321,14 @@
        * ```ts
        * import puppeteer from 'puppeteer';
        *
-       * (async () => {
-       * .  const browser = await puppeteer.launch();
-       * .  const page = await browser.newPage();
-       * .  const watchDog = page.mainFrame().waitForFunction('window.innerWidth < 100');
-       * .  page.setViewport({width: 50, height: 50});
-       * .  await watchDog;
-       * .  await browser.close();
-       * })();
+       * const browser = await puppeteer.launch();
+       * const page = await browser.newPage();
+       * const watchDog = page
+       *   .mainFrame()
+       *   .waitForFunction('window.innerWidth < 100');
+       * page.setViewport({width: 50, height: 50});
+       * await watchDog;
+       * await browser.close();
        * ```
        *
        * To pass arguments from Node.js to the predicate of `page.waitForFunction` function:
@@ -12364,9 +12358,10 @@
        *
        * ```ts
        * const feedHandle = await page.$('.feed');
-       * expect(
-       *   await feedHandle.$$eval('.tweet', nodes => nodes.map(n => n.innerText)),
-       * ).toEqual(['Hello!', 'Hi!']);
+       *
+       * const listOfTweets = await feedHandle.$$eval('.tweet', nodes =>
+       *   nodes.map(n => n.innerText),
+       * );
        * ```
        *
        * @param selector -
@@ -12424,24 +12419,22 @@
        * ```ts
        * import puppeteer from 'puppeteer';
        *
-       * (async () => {
-       *   const browser = await puppeteer.launch();
-       *   const page = await browser.newPage();
-       *   let currentURL;
-       *   page
-       *     .mainFrame()
-       *     .waitForSelector('img')
-       *     .then(() => console.log('First URL with image: ' + currentURL));
+       * const browser = await puppeteer.launch();
+       * const page = await browser.newPage();
+       * let currentURL;
+       * page
+       *   .mainFrame()
+       *   .waitForSelector('img')
+       *   .then(() => console.log('First URL with image: ' + currentURL));
        *
-       *   for (currentURL of [
-       *     'https://example.com',
-       *     'https://google.com',
-       *     'https://bbc.com',
-       *   ]) {
-       *     await page.goto(currentURL);
-       *   }
-       *   await browser.close();
-       * })();
+       * for (currentURL of [
+       *   'https://example.com',
+       *   'https://google.com',
+       *   'https://bbc.com',
+       * ]) {
+       *   await page.goto(currentURL);
+       * }
+       * await browser.close();
        * ```
        *
        * @param selector - The selector to query and wait for.
@@ -15466,7 +15459,6 @@ ${sourceUrlComment}
      * `respond()` aren't called).
      */
     continueRequestOverrides() {
-      assert(this.interception.enabled, "Request Interception is not enabled!");
       return this.interception.requestOverrides;
     }
     /**
@@ -15474,14 +15466,12 @@ ${sourceUrlComment}
      * interception is allowed to respond (ie, `abort()` is not called).
      */
     responseForRequest() {
-      assert(this.interception.enabled, "Request Interception is not enabled!");
       return this.interception.response;
     }
     /**
      * The most recent reason for aborting the request
      */
     abortErrorReason() {
-      assert(this.interception.enabled, "Request Interception is not enabled!");
       return this.interception.abortReason;
     }
     /**
@@ -15542,8 +15532,12 @@ ${sourceUrlComment}
           return await this._continue(this.interception.requestOverrides);
       }
     }
-    #canBeIntercepted() {
-      return !this.url().startsWith("data:") && !this._fromMemoryCache;
+    /**
+     * @internal
+     */
+    verifyInterception() {
+      assert(this.interception.enabled, "Request Interception is not enabled!");
+      assert(!this.interception.handled, "Request is already handled!");
     }
     /**
      * Continues request with optional request overrides.
@@ -15574,11 +15568,10 @@ ${sourceUrlComment}
      * Exception is immediately thrown if the request interception is not enabled.
      */
     async continue(overrides = {}, priority) {
-      if (!this.#canBeIntercepted()) {
+      this.verifyInterception();
+      if (!this.canBeIntercepted()) {
         return;
       }
-      assert(this.interception.enabled, "Request Interception is not enabled!");
-      assert(!this.interception.handled, "Request is already handled!");
       if (priority === void 0) {
         return await this._continue(overrides);
       }
@@ -15631,11 +15624,10 @@ ${sourceUrlComment}
      * Exception is immediately thrown if the request interception is not enabled.
      */
     async respond(response, priority) {
-      if (!this.#canBeIntercepted()) {
+      this.verifyInterception();
+      if (!this.canBeIntercepted()) {
         return;
       }
-      assert(this.interception.enabled, "Request Interception is not enabled!");
-      assert(!this.interception.handled, "Request is already handled!");
       if (priority === void 0) {
         return await this._respond(response);
       }
@@ -15669,13 +15661,12 @@ ${sourceUrlComment}
      * throw an exception immediately.
      */
     async abort(errorCode = "failed", priority) {
-      if (!this.#canBeIntercepted()) {
+      this.verifyInterception();
+      if (!this.canBeIntercepted()) {
         return;
       }
       const errorReason = errorReasons[errorCode];
       assert(errorReason, "Unknown error code: " + errorCode);
-      assert(this.interception.enabled, "Request Interception is not enabled!");
-      assert(!this.interception.handled, "Request is already handled!");
       if (priority === void 0) {
         return await this._abort(errorReason);
       }
@@ -15900,6 +15891,9 @@ ${sourceUrlComment}
         errorText: this._failureText
       };
     }
+    canBeIntercepted() {
+      return !this.url().startsWith("data:") && !this._fromMemoryCache;
+    }
     /**
      * @internal
      */