@browserless.io/browserless 2.12.0-beta-3 → 2.12.0-beta-4

package/src/browsers/index.ts

@@ -37,7 +37,7 @@ import path from 'path';
 
 export class BrowserManager {
   protected browsers: Map<BrowserInstance, BrowserlessSession> = new Map();
-  protected timers: Map<string, number> = new Map();
+  protected timers: Map<string, NodeJS.Timeout> = new Map();
   protected log = new Logger('browser-manager');
   protected chromeBrowsers = [ChromiumCDP, ChromeCDP];
   protected playwrightBrowserNames = [
@@ -226,7 +226,7 @@ export class BrowserManager {
       {
         ...session,
         browser: browser.constructor.name,
-        browserId: browser.wsEndpoint()?.split('/').pop() as string,
+        browserId: session.id,
         initialConnectURL: new URL(session.initialConnectURL, serverAddress)
           .href,
         killURL: session.id
@@ -268,26 +268,54 @@ export class BrowserManager {
     browser: BrowserInstance,
     session: BrowserlessSession,
   ): Promise<void> => {
+    const now = Date.now();
+    const keepUntil = browser.keepUntil();
+    const connected = session.numbConnected;
+    const hasKeepUntil = keepUntil > now;
+    const keepOpen = connected > 0 || hasKeepUntil;
     const cleanupACtions: Array<() => Promise<void>> = [];
-    this.log.info(`${session.numbConnected} Client(s) are currently connected`);
+    const priorTimer = this.timers.get(session.id);
 
-    // Don't close if there's clients still connected
-    if (session.numbConnected > 0 || browser.keepAlive()) {
-      return;
+    if (priorTimer) {
+      this.log.info(`Deleting prior keep-until timer for "${session.id}"`);
+      global.clearTimeout(priorTimer);
     }
 
-    this.log.info(`Closing browser session`);
-    cleanupACtions.push(() => browser.close());
+    this.log.info(
+      `${session.numbConnected} Client(s) are currently connected, Keep-until: ${keepUntil}`,
+    );
 
-    if (session.isTempDataDir) {
-      this.log.info(
-        `Deleting "${session.userDataDir}" user-data-dir and session from memory`,
+    if (hasKeepUntil) {
+      const timeout = keepUntil - now;
+      this.log.trace(
+        `Setting timer ${timeout.toLocaleString()} for "${session.id}"`,
+      );
+      this.timers.set(
+        session.id,
+        global.setTimeout(() => {
+          const session = this.browsers.get(browser);
+          if (session) {
+            this.log.trace(`Timer hit for "${session.id}"`),
+              this.close(browser, session);
+          }
+        }, timeout),
       );
-      this.browsers.delete(browser);
-      cleanupACtions.push(() => this.removeUserDataDir(session.userDataDir));
     }
 
-    await Promise.all(cleanupACtions.map((a) => a()));
+    if (!keepOpen) {
+      this.log.info(`Closing browser session`);
+      cleanupACtions.push(() => browser.close());
+
+      if (session.isTempDataDir) {
+        this.log.info(
+          `Deleting "${session.userDataDir}" user-data-dir and session from memory`,
+        );
+        this.browsers.delete(browser);
+        cleanupACtions.push(() => this.removeUserDataDir(session.userDataDir));
+      }
+
+      await Promise.all(cleanupACtions.map((a) => a()));
+    }
   };
 
   public getAllSessions = async (): Promise<BrowserlessSessionJSON[]> => {
@@ -459,8 +487,14 @@ export class BrowserManager {
       userDataDir,
     });
 
+    const match = (req.headers['user-agent'] || '').match(pwVersionRegex);
+    const pwVersion = match ? match[1] : 'default';
+
+    await browser.launch(launchOptions as object, pwVersion);
+    await this.hooks.browser({ browser, meta: req.parsed });
+
     const session: BrowserlessSession = {
-      id: null,
+      id: browser.wsEndpoint()?.split('/').pop() as string,
       initialConnectURL:
         path.join(req.parsed.pathname, req.parsed.search) || '',
       isTempDataDir: !manualUserDataDir,
@@ -475,12 +509,6 @@ export class BrowserManager {
 
     this.browsers.set(browser, session);
 
-    const match = (req.headers['user-agent'] || '').match(pwVersionRegex);
-    const pwVersion = match ? match[1] : 'default';
-
-    await browser.launch(launchOptions as object, pwVersion);
-    await this.hooks.browser({ browser, meta: req.parsed });
-
     browser.on('newPage', async (page) => {
       await this.onNewPage(req, page);
       (router.onNewPage || noop)(req.parsed || '', page);

package/src/browsers/webkit.playwright.ts

@@ -42,8 +42,8 @@ export class WebkitPlaywright extends EventEmitter {
     this.removeAllListeners();
   }
 
-  public keepAlive() {
-    return false;
+  public keepUntil() {
+    return 0;
   }
 
   public isRunning = (): boolean => this.running;
@@ -88,14 +88,14 @@ export class WebkitPlaywright extends EventEmitter {
   ): Promise<playwright.BrowserServer> => {
     this.logger.info(`Launching ${this.constructor.name} Handler`);
 
-    const opts = ({
+    const opts = {
       ...options,
       args: [
         ...(options.args || []),
         this.userDataDir ? `-profile=${this.userDataDir}` : '',
       ],
       executablePath: playwright.webkit.executablePath(),
-    });
+    };
 
     const versionedPw = await this.config.loadPwVersion(version!);
 

package/src/routes/chrome/tests/websocket.spec.ts

@@ -470,9 +470,9 @@ describe('Chrome WebSocket API', function () {
       const browser = await pw.chromium.connect(
         `ws://localhost:3000/chrome/playwright?token=browserless`,
       );
-  
+
       await browser.close();
-      await sleep(100);  
+      await sleep(100);
     }
 
     const results = metrics.get();

package/src/routes/chromium/tests/websocket.spec.ts

@@ -474,9 +474,9 @@ describe('Chromium WebSocket API', function () {
       const browser = await pw.chromium.connect(
         `ws://localhost:3000/playwright/chromium?token=browserless`,
       );
-  
+
       await browser.close();
-      await sleep(100);  
+      await sleep(100);
     }
 
     const results = metrics.get();

package/src/routes/firefox/tests/websocket.spec.ts

@@ -38,9 +38,7 @@ describe('Firefox Websocket API', function () {
     await browser.close();
   });
 
-  
   it('runs multiple versions of playwright', async () => {
-
     const config = new Config();
     config.setToken('browserless');
     const metrics = new Metrics();
@@ -53,9 +51,9 @@ describe('Firefox Websocket API', function () {
       const browser = await pw.firefox.connect(
         `ws://localhost:3000/playwright/firefox?token=browserless`,
       );
-  
+
       await browser.close();
-      await sleep(100);  
+      await sleep(100);
     }
 
     const results = metrics.get();

package/src/routes/webkit/tests/websocket.spec.ts

@@ -39,7 +39,6 @@ describe('Webkit Websocket API', function () {
     await browser.close();
   });
 
-    
   it('runs multiple versions of playwright', async () => {
     const config = new Config();
     config.setToken('browserless');
@@ -53,9 +52,9 @@ describe('Webkit Websocket API', function () {
       const browser = await pw.webkit.connect(
         `ws://localhost:3000/playwright/webkit?token=browserless`,
       );
-  
+
       await browser.close();
-      await sleep(100);  
+      await sleep(100);
     }
 
     const results = metrics.get();

package/src/types.ts

@@ -377,7 +377,7 @@ export interface BrowserServerOptions {
 }
 
 export interface BrowserlessSession {
-  id: string | null;
+  id: string;
   initialConnectURL: string;
   isTempDataDir: boolean;
   launchOptions: CDPLaunchOptions | BrowserServerOptions;

package/src/utils.ts

@@ -50,7 +50,7 @@ const getAuthHeaderToken = (header: string) => {
 
 /**
  * RegEx to match the Playwright version from the innitial request header.
- * 
+ *
  * @example
  * const userAgent = "Playwright/1.43.1 (x64; windows 10.0) node/20.11";
  * userAgent.match(pwVersionRegex);

package/static/docs/swagger.json

@@ -1098,7 +1098,7 @@
   },
   "info": {
     "title": "Browserless",
-    "version": "2.12.0-beta-3",
+    "version": "2.12.0-beta-4",
     "x-logo": {
       "altText": "browserless logo",
       "url": "./docs/browserless-logo-inline.svg"

package/static/docs/swagger.min.json

@@ -1098,7 +1098,7 @@
   },
   "info": {
     "title": "Browserless",
-    "version": "2.12.0-beta-3",
+    "version": "2.12.0-beta-4",
     "x-logo": {
       "altText": "browserless logo",
       "url": "./docs/browserless-logo-inline.svg"