@browserless.io/browserless 2.4.0-beta-1 → 2.4.0

package/src/server.ts

@@ -23,6 +23,7 @@ import {
   shimLegacyRequests,
   writeResponse,
 } from '@browserless.io/browserless';
+import { EventEmitter } from 'events';
 
 // @ts-ignore
 import Enjoi from 'enjoi';
@@ -35,7 +36,7 @@ export interface HTTPServerOptions {
   timeout: number;
 }
 
-export class HTTPServer {
+export class HTTPServer extends EventEmitter {
   protected server: http.Server = http.createServer();
   protected port: number;
   protected host?: string;
@@ -48,6 +49,7 @@ export class HTTPServer {
     protected token: Token,
     protected router: Router,
   ) {
+    super();
     this.host = config.getHost();
     this.port = config.getPort();
 
@@ -100,21 +102,6 @@ export class HTTPServer {
     });
   }
 
-  public async stop(): Promise<void> {
-    this.log(`HTTP Server is shutting down`);
-    await new Promise((r) => this.server.close(r));
-    await Promise.all([this.tearDown(), this.router.teardown()]);
-    this.log(`HTTP Server shutdown complete`);
-  }
-
-  protected tearDown() {
-    this.log(`Tearing down all listeners and internal routes`);
-    this.server && this.server.removeAllListeners();
-
-    // @ts-ignore garbage collect this reference
-    this.server = null;
-  }
-
   protected handleRequest = async (
     request: http.IncomingMessage,
     res: http.ServerResponse,
@@ -410,4 +397,19 @@ export class HTTPServer {
     this.log(`No matching WebSocket route handler for "${req.parsed.href}"`);
     return writeResponse(socket, 404, 'Not Found');
   };
+
+  public async shutdown(): Promise<void> {
+    this.log(`HTTP Server is shutting down`);
+    await new Promise((r) => this.server.close(r));
+    this.server && this.server.removeAllListeners();
+
+    // @ts-ignore garbage collect this reference
+    this.server = null;
+    this.log(`HTTP Server shutdown complete`);
+  }
+
+  /**
+   * Left blank for downstream SDK modules to optionally implement.
+   */
+  public stop = () => {};
 }

package/src/shared/content.http.ts

@@ -176,6 +176,11 @@ export default class ChromiumContentPostRoute extends BrowserHTTPRoute {
       });
     }
 
+    const gotoResponse = await gotoCall(content, gotoOptions).catch(
+      bestAttemptCatch(bestAttempt),
+    );
+
+
     if (addStyleTag.length) {
       for (const tag in addStyleTag) {
         await page.addStyleTag(addStyleTag[tag]);
@@ -188,10 +193,6 @@ export default class ChromiumContentPostRoute extends BrowserHTTPRoute {
       }
     }
 
-    const gotoResponse = await gotoCall(content, gotoOptions).catch(
-      bestAttemptCatch(bestAttempt),
-    );
-
     if (waitForTimeout) {
       await sleep(waitForTimeout).catch(bestAttemptCatch(bestAttempt));
     }

package/src/shared/pdf.http.ts

@@ -36,7 +36,6 @@ export interface BodySchema {
   addStyleTag?: Array<Parameters<Page['addStyleTag']>[0]>;
   authenticate?: Parameters<Page['authenticate']>[0];
   bestAttempt?: bestAttempt;
-  blockModals?: boolean;
   cookies?: Array<Parameters<Page['setCookie']>[0]>;
   emulateMediaType?: Parameters<Page['emulateMediaType']>[0];
   gotoOptions?: Parameters<Page['goto']>[1];
@@ -185,6 +184,10 @@ export default class ChromiumPDFPostRoute extends BrowserHTTPRoute {
       });
     }
 
+    const gotoResponse = await gotoCall(content, gotoOptions).catch(
+      bestAttemptCatch(bestAttempt),
+    );
+
     if (addStyleTag.length) {
       for (const tag in addStyleTag) {
         await page.addStyleTag(addStyleTag[tag]);
@@ -197,10 +200,6 @@ export default class ChromiumPDFPostRoute extends BrowserHTTPRoute {
       }
     }
 
-    const gotoResponse = await gotoCall(content, gotoOptions).catch(
-      bestAttemptCatch(bestAttempt),
-    );
-
     if (waitForTimeout) {
       await sleep(waitForTimeout).catch(bestAttemptCatch(bestAttempt));
     }

package/src/shared/screenshot.http.ts

@@ -191,6 +191,10 @@ export default class ScreenshotPost extends BrowserHTTPRoute {
       });
     }
 
+    const gotoResponse = await gotoCall(content, gotoOptions).catch(
+      bestAttemptCatch(bestAttempt),
+    );
+
     if (addStyleTag.length) {
       for (const tag in addStyleTag) {
         await page.addStyleTag(addStyleTag[tag]);
@@ -203,10 +207,6 @@ export default class ScreenshotPost extends BrowserHTTPRoute {
       }
     }
 
-    const gotoResponse = await gotoCall(content, gotoOptions).catch(
-      bestAttemptCatch(bestAttempt),
-    );
-
     if (waitForTimeout) {
       await sleep(waitForTimeout).catch(bestAttemptCatch(bestAttempt));
     }

package/src/token.ts

@@ -7,9 +7,12 @@ import {
   WebSocketRoute,
   getTokenFromRequest,
 } from '@browserless.io/browserless';
+import { EventEmitter } from 'events';
 
-export class Token {
-  constructor(protected config: Config) {}
+export class Token extends EventEmitter {
+  constructor(protected config: Config) {
+    super();
+  }
 
   public isAuthorized = async (
     req: Request,
@@ -37,4 +40,17 @@ export class Token {
 
     return (Array.isArray(token) ? token : [token]).includes(requestToken);
   };
+
+  /**
+   * Implement any browserless-core-specific shutdown logic here.
+   * Calls the empty-SDK stop method for downstream implementations.
+   */
+  public shutdown = async () => {
+    await this.stop();
+  };
+
+  /**
+   * Left blank for downstream SDK modules to optionally implement.
+   */
+  public stop = () => {};
 }

package/src/types.ts

@@ -478,19 +478,6 @@ export const debugScreenshotOpts: ScreenshotOptions = {
   type: 'jpeg',
 };
 
-declare global {
-  interface Window {
-    browserless: BrowserlessEmbeddedAPI;
-  }
-}
-
-export interface BrowserlessEmbeddedAPI {
-  getRecording: () => Promise<string>;
-  liveUrl: () => string;
-  saveRecording: () => Promise<boolean>;
-  startRecording: () => void;
-}
-
 /**
  * When bestAttempt is set to true, browserless attempt to proceed
  * when "awaited" events fail or timeout. This includes things like

package/src/webhooks.ts

@@ -1,7 +1,10 @@
 import { Config, fetchTimeout, noop } from '@browserless.io/browserless';
+import { EventEmitter } from 'events';
 
-export class WebHooks {
-  constructor(protected config: Config) {}
+export class WebHooks extends EventEmitter {
+  constructor(protected config: Config) {
+    super();
+  }
 
   protected callURL(url: string | null) {
     if (url) {
@@ -47,4 +50,17 @@ export class WebHooks {
       );
     }
   }
+
+  /**
+   * Implement any browserless-core-specific shutdown logic here.
+   * Calls the empty-SDK stop method for downstream implementations.
+   */
+  public shutdown = async () => {
+    await this.stop();
+  };
+
+  /**
+   * Left blank for downstream SDK modules to optionally implement.
+   */
+  public stop = () => {};
 }