@browserless.io/browserless 2.38.1 → 2.38.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@browserless.io/browserless",
-  "version": "2.38.1",
+  "version": "2.38.2",
   "license": "SSPL",
   "description": "The browserless platform",
   "author": "browserless.io",

package/src/browsers/index.ts

@@ -28,6 +28,7 @@ import {
   convertIfBase64,
   exists,
   generateDataDir,
+  getFinalPathSegment,
   makeExternalURL,
   noop,
   parseBooleanParam,
@@ -466,9 +467,7 @@ export class BrowserManager {
       this.reconnectionPatterns.some((p) => req.parsed.pathname.includes(p))
     ) {
       const sessions = Array.from(this.browsers);
-      const pathParts = req.parsed.pathname.split('/');
-      // The last part of the path is the browser ID, or the second last part in case the path ends with "/"
-      const id = pathParts.pop() as string || pathParts.pop() as string;
+      const id = getFinalPathSegment(req.parsed.pathname);
       if (!id) {
         throw new NotFound(
           `Couldn't locate browser ID from path "${req.parsed.pathname}"`,
@@ -490,8 +489,8 @@ export class BrowserManager {
 
     // Handle page connections here
     if (req.parsed.pathname.includes('/devtools/page')) {
-      const id = req.parsed.pathname.split('/').pop() as string;
-      if (!id.includes(BLESS_PAGE_IDENTIFIER)) {
+      const id = getFinalPathSegment(req.parsed.pathname);
+      if (!id?.includes(BLESS_PAGE_IDENTIFIER)) {
         const browsers = Array.from(this.browsers).map(([browser]) => browser);
         const allPages = await Promise.all(
           browsers
@@ -555,11 +554,12 @@ export class BrowserManager {
       const filteredArgs = existingArgs.filter(
         (arg) => !arg.includes('--proxy-server='),
       );
-      launchOptions.args = [...filteredArgs, `--proxy-server=${proxyServerParam}`];
+      launchOptions.args = [
+        ...filteredArgs,
+        `--proxy-server=${proxyServerParam}`,
+      ];
     }
 
-
-
     const manualUserDataDir =
       launchOptions.args
         ?.find((arg) => arg.includes('--user-data-dir='))
@@ -588,7 +588,9 @@ export class BrowserManager {
      */
     if (Object.hasOwn(launchOptions, 'ignoreHTTPSErrors')) {
       if (!Object.hasOwn(launchOptions, 'acceptInsecureCerts')) {
-        (launchOptions as CDPLaunchOptions).acceptInsecureCerts = (launchOptions as CDPLaunchOptions).ignoreHTTPSErrors;
+        (launchOptions as CDPLaunchOptions).acceptInsecureCerts = (
+          launchOptions as CDPLaunchOptions
+        ).ignoreHTTPSErrors;
       }
       delete (launchOptions as CDPLaunchOptions).ignoreHTTPSErrors;
     }
@@ -627,7 +629,7 @@ export class BrowserManager {
     await this.hooks.browser({ browser, req });
 
     const session: BrowserlessSession = {
-      id: browser.wsEndpoint()?.split('/').pop() as string,
+      id: getFinalPathSegment(browser.wsEndpoint()!)!,
       initialConnectURL:
         path.join(req.parsed.pathname, req.parsed.search) || '',
       isTempDataDir: !manualUserDataDir,

package/src/routes/management/http/kill.get.ts

@@ -7,6 +7,7 @@ import {
   Request,
   SystemQueryParameters,
   contentTypes,
+  getFinalPathSegment,
   writeResponse,
 } from '@browserless.io/browserless';
 import { ServerResponse } from 'http';
@@ -32,7 +33,7 @@ export default class KillGetRoute extends HTTPRoute {
   tags = [APITags.management];
 
   async handler(req: Request, res: ServerResponse): Promise<void> {
-    const target = req.parsed.pathname.split('/')[2];
+    const target = getFinalPathSegment(req.parsed.pathname)!;
     const browserManager = this.browserManager();
     await browserManager.killSessions(target);
     return writeResponse(res, 204, '');

package/src/shared/utils/function/handler.ts

@@ -11,6 +11,7 @@ import {
   contentTypes,
   convertIfBase64,
   exists,
+  getFinalPathSegment,
   getTokenFromRequest,
   makeExternalURL,
   mimeTypes,
@@ -70,7 +71,7 @@ export default (config: Config, logger: Logger, options: HandlerOptions = {}) =>
       );
     }
 
-    const browserID = privateWSEndpoint.split('/').pop() as string;
+    const browserID = getFinalPathSegment(privateWSEndpoint)!;
     const browserWSEndpoint = makeExternalURL(
       config.getExternalWebSocketAddress(),
       'function',

package/src/utils.spec.ts

@@ -0,0 +1,62 @@
+import { expect } from 'chai';
+import { getFinalPathSegment } from '@browserless.io/browserless';
+
+describe('Utils', () => {
+  describe('#getFinalPathSegment', () => {
+    it('returns the final path segment', () => {
+      expect(
+        getFinalPathSegment(
+          'https://www.browserless.io/some/random/path/segment',
+        ),
+      ).to.equal('segment');
+    });
+
+    it('returns the final path segment with trailing slashes', () => {
+      expect(
+        getFinalPathSegment(
+          'https://www.browserless.io/some/random/path/segment/',
+        ),
+      ).to.equal('segment');
+    });
+
+    it('returns the final path segment with URLs that have query params', () => {
+      expect(
+        getFinalPathSegment(
+          'https://www.browserless.io/some/random/path/segment?foo=bar',
+        ),
+      ).to.equal('segment');
+    });
+
+    it('returns the final path segment with URLs that have fragments', () => {
+      expect(
+        getFinalPathSegment(
+          'https://www.browserless.io/some/random/path/segment#foo=bar',
+        ),
+      ).to.equal('segment');
+    });
+
+    it('returns the final path segment with trailing slashes, query-params and fragments', () => {
+      expect(
+        getFinalPathSegment(
+          'https://www.browserless.io/some/random/path/segment/?foo=bar&baz=qux#hello=world',
+        ),
+      ).to.equal('segment');
+    });
+
+    it('returns the final path segment with trailing slashes, query-params and fragments on websockets', () => {
+      expect(
+        getFinalPathSegment(
+          'wss://www.browserless.io/some/random/path/segment/?foo=bar&baz=qux#hello=world',
+        ),
+      ).to.equal('segment');
+    });
+
+    it('returns the final path segment with malformed URLs', () => {
+      expect(
+        getFinalPathSegment(
+          'wss://www.browserless.io/some/random/path/segment/&bad=query',
+        ),
+      ).to.equal('segment');
+    });
+  });
+});

package/src/utils.ts

@@ -917,3 +917,6 @@ export const ublockLitePath = path.join(
 export const isMatch = (text: string, pattern: string) => {
   return micromatch.isMatch(text, pattern, { bash: true });
 };
+
+export const getFinalPathSegment = (pathname: string): string | undefined =>
+  pathname.split(/[?#&]/)[0].split('/').filter(Boolean).pop();