@browserless.io/browserless 2.0.0-beta-5 → 2.0.0-beta-7

package/src/routes/chromium/http/pdf-post.ts

@@ -16,6 +16,7 @@ import {
   bestAttempt,
   bestAttemptCatch,
   contentTypes,
+  dedent,
   noop,
   rejectRequestPattern,
   rejectResourceTypes,
@@ -61,14 +62,22 @@ export interface QuerySchema extends SystemQueryParameters {
  */
 export type ResponseSchema = string;
 
-const route: BrowserHTTPRoute = {
-  accepts: [contentTypes.json],
-  auth: true,
-  browser: CDPChromium,
-  concurrency: true,
-  contentTypes: [contentTypes.pdf],
-  description: `A JSON-based API for getting a PDF binary from either a supplied "url" or "html" payload in your request.`,
-  handler: async (
+export default class PDFPost extends BrowserHTTPRoute {
+  accepts = [contentTypes.json];
+  auth = true;
+  browser = CDPChromium;
+  concurrency = true;
+  contentTypes = [contentTypes.pdf];
+  description = dedent(`
+    A JSON-based API for getting a PDF binary from either a supplied
+    "url" or "html" payload in your request. Many options exist for
+    injecting cookies, request interceptors, user-agents and waiting for
+    selectors, timers and more.
+  `);
+  method = Methods.post;
+  path = HTTPRoutes.pdf;
+  tags = [APITags.browserAPI];
+  handler = async (
     req: Request,
     res: ServerResponse,
     browser: BrowserInstance,
@@ -225,10 +234,5 @@ const route: BrowserHTTPRoute = {
     });
 
     page.close().catch(noop);
-  },
-  method: Methods.post,
-  path: HTTPRoutes.pdf,
-  tags: [APITags.browserAPI],
-};
-
-export default route;
+  };
+}

package/src/routes/chromium/http/performance.ts

@@ -1,6 +1,5 @@
 import {
   APITags,
-  BadRequest,
   BrowserHTTPRoute,
   BrowserInstance,
   CDPChromium,
@@ -8,7 +7,6 @@ import {
   HTTPRoutes,
   Methods,
   Request,
-  ServerError,
   SystemQueryParameters,
   contentTypes,
   jsonResponse,
@@ -34,27 +32,22 @@ export interface QuerySchema extends SystemQueryParameters {
  */
 export type ResponseSchema = object;
 
-const route: BrowserHTTPRoute = {
-  accepts: [contentTypes.json],
-  auth: true,
-  browser: CDPChromium,
-  concurrency: true,
-  contentTypes: [contentTypes.json],
-  description: `Run lighthouse performance audits with a supplied "url" in your JSON payload.`,
-  handler: async (
+export default class PerformancePost extends BrowserHTTPRoute {
+  accepts = [contentTypes.json];
+  auth = true;
+  browser = CDPChromium;
+  concurrency = true;
+  contentTypes = [contentTypes.json];
+  description = `Run lighthouse performance audits with a supplied "url" in your JSON payload.`;
+  method = Methods.post;
+  path = HTTPRoutes.performance;
+  tags = [APITags.browserAPI];
+  handler = async (
     req: Request,
     res: ServerResponse,
     browser: BrowserInstance,
   ): Promise<void> => {
-    const { getConfig: getConfig } = route;
-    if (!req.body) {
-      throw new BadRequest(`No JSON body present`);
-    }
-
-    if (!getConfig) {
-      throw new ServerError(`Couldn't load configuration for timeouts`);
-    }
-    const config = getConfig();
+    const config = this.config();
     const response = await main({
       browser,
       context: req.body as BodySchema,
@@ -62,10 +55,5 @@ const route: BrowserHTTPRoute = {
     });
 
     return jsonResponse(res, 200, response);
-  },
-  method: Methods.post,
-  path: HTTPRoutes.performance,
-  tags: [APITags.browserAPI],
-};
-
-export default route;
+  };
+}

package/src/routes/chromium/http/scrape-post.ts

@@ -198,18 +198,21 @@ const scrape = async (elements: ScrapeElementSelector[]) => {
   });
 };
 
-const route: BrowserHTTPRoute = {
-  accepts: [contentTypes.json],
-  auth: true,
-  browser: CDPChromium,
-  concurrency: true,
-  contentTypes: [contentTypes.json],
-  description: dedent(`
+export default class ScrapePost extends BrowserHTTPRoute {
+  accepts = [contentTypes.json];
+  auth = true;
+  browser = CDPChromium;
+  concurrency = true;
+  contentTypes = [contentTypes.json];
+  description = dedent(`
     A JSON-based API that returns text, html, and meta-data from a given list of selectors.
     Debugging information is available by sending in the appropriate flags in the "debugOpts"
     property. Responds with an array of JSON objects.
-  `),
-  handler: async (
+  `);
+  method = Methods.post;
+  path = HTTPRoutes.scrape;
+  tags = [APITags.browserAPI];
+  handler = async (
     req: Request,
     res: ServerResponse,
     browser: BrowserInstance,
@@ -430,10 +433,5 @@ const route: BrowserHTTPRoute = {
     page.close().catch(noop);
 
     return jsonResponse(res, 200, response, false);
-  },
-  method: Methods.post,
-  path: HTTPRoutes.scrape,
-  tags: [APITags.browserAPI],
-};
-
-export default route;
+  };
+}

package/src/routes/chromium/http/screenshot-post.ts

@@ -16,6 +16,7 @@ import {
   bestAttempt,
   bestAttemptCatch,
   contentTypes,
+  dedent,
   noop,
   rejectRequestPattern,
   rejectResourceTypes,
@@ -64,14 +65,21 @@ export interface BodySchema {
   waitForTimeout?: Parameters<Page['waitForTimeout']>[0];
 }
 
-const route: BrowserHTTPRoute = {
-  accepts: [contentTypes.json],
-  auth: true,
-  browser: CDPChromium,
-  concurrency: true,
-  contentTypes: [contentTypes.png, contentTypes.jpeg, contentTypes.text],
-  description: `A JSON-based API for getting a screenshot binary from either a supplied "url" or "html" payload in your request.`,
-  handler: async (
+export default class ScreenshotPost extends BrowserHTTPRoute {
+  accepts = [contentTypes.json];
+  auth = true;
+  browser = CDPChromium;
+  concurrency = true;
+  contentTypes = [contentTypes.png, contentTypes.jpeg, contentTypes.text];
+  description = dedent(`
+    A JSON-based API for getting a screenshot binary from either a supplied
+    "url" or "html" payload in your request. Many options exist including
+    cookies, user-agents, setting timers and network mocks.
+  `);
+  method = Methods.post;
+  path = HTTPRoutes.screenshot;
+  tags = [APITags.browserAPI];
+  handler = async (
     req: Request,
     res: ServerResponse,
     browser: BrowserInstance,
@@ -253,10 +261,5 @@ const route: BrowserHTTPRoute = {
     await new Promise((r) => readStream.pipe(res).once('close', r));
 
     page.close().catch(noop);
-  },
-  method: Methods.post,
-  path: HTTPRoutes.screenshot,
-  tags: [APITags.browserAPI],
-};
-
-export default route;
+  };
+}

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

@@ -170,6 +170,33 @@ describe('WebSocket API', function () {
     expect(await exists(userDataDir)).to.be.false;
   });
 
+  it('allows specified user-data-dirs', async () => {
+    const dataDir = '/tmp/data-dir';
+    const config = new Config();
+    config.setToken('browserless');
+    const metrics = new Metrics();
+    await start({ config, metrics });
+    const launch = JSON.stringify({
+      args: [`--user-data-dir=${dataDir}`],
+    });
+
+    const browser = await puppeteer.connect({
+      browserWSEndpoint: `ws://localhost:3000?token=browserless&launch=${launch}`,
+    });
+
+    const [{ userDataDir }] = await fetch(
+      'http://localhost:3000/sessions?token=browserless',
+    ).then((r) => r.json());
+
+    expect(await exists(userDataDir)).to.be.true;
+    expect(userDataDir).to.equal(dataDir);
+
+    await browser.disconnect();
+    await sleep(1000);
+
+    expect(await exists(userDataDir)).to.be.true;
+  });
+
   it('creates user-data-dirs with userDataDir options', async () => {
     const dataDirLocation = '/tmp/browserless-test-dir';
     const launch = JSON.stringify({
@@ -201,7 +228,7 @@ describe('WebSocket API', function () {
   it('creates user-data-dirs with CLI flags', async () => {
     const dataDirLocation = '/tmp/browserless-test-dir';
     const launch = JSON.stringify({
-      args: [`--user-data-dir==${dataDirLocation}`],
+      args: [`--user-data-dir=${dataDirLocation}`],
     });
     const config = new Config();
     config.setToken('browserless');

package/src/routes/chromium/utils/function/handler.ts

@@ -9,6 +9,7 @@ import {
   contentTypes,
   convertIfBase64,
   exists,
+  getTokenFromRequest,
   id,
   makeExternalURL,
   mimeTypes,
@@ -66,7 +67,7 @@ export default (
     const context = JSON.stringify(rawContext);
     const code = convertIfBase64(rawCode);
     const browserWSEndpoint = browser.publicWSEndpoint(
-      req.parsed.searchParams.get('token') ?? '',
+      getTokenFromRequest(req) ?? '',
     );
 
     if (!browserWSEndpoint) {

package/src/routes/chromium/ws/browser.ts

@@ -13,19 +13,17 @@ export interface QuerySchema extends SystemQueryParameters {
   launch?: CDPLaunchOptions | string;
 }
 
-const route: BrowserWebsocketRoute = {
-  auth: true,
-  browser: CDPChromium,
-  concurrency: false,
-  description: `Connect to an already-running Chromium with a library like puppeteer, or others, that work over chrome-devtools-protocol.`,
-  handler: async (
+export default class CDPExistingBrowser extends BrowserWebsocketRoute {
+  auth = true;
+  browser = CDPChromium;
+  concurrency = false;
+  description = `Connect to an already-running Chromium with a library like puppeteer, or others, that work over chrome-devtools-protocol.`;
+  path = WebsocketRoutes.browser;
+  tags = [APITags.browserWS];
+  handler = async (
     req: Request,
     socket: Duplex,
     head: Buffer,
     chrome: CDPChromium,
-  ): Promise<void> => chrome.proxyWebSocket(req, socket, head),
-  path: WebsocketRoutes.browser,
-  tags: [APITags.browserWS],
-};
-
-export default route;
+  ): Promise<void> => chrome.proxyWebSocket(req, socket, head);
+}

package/src/routes/chromium/ws/cdp-chromium.ts

@@ -13,19 +13,17 @@ export interface QuerySchema extends SystemQueryParameters {
   launch?: CDPLaunchOptions | string;
 }
 
-const route: BrowserWebsocketRoute = {
-  auth: true,
-  browser: CDPChromium,
-  concurrency: true,
-  description: `Launch and connect to Chromium with a library like puppeteer or others that work over chrome-devtools-protocol.`,
-  handler: async (
+export default class CDPChromiumRoute extends BrowserWebsocketRoute {
+  auth = true;
+  browser = CDPChromium;
+  concurrency = true;
+  description = `Launch and connect to Chromium with a library like puppeteer or others that work over chrome-devtools-protocol.`;
+  path = WebsocketRoutes['/'];
+  tags = [APITags.browserWS];
+  handler = async (
     req: Request,
     socket: Duplex,
     head: Buffer,
     chrome: CDPChromium,
-  ): Promise<void> => chrome.proxyWebSocket(req, socket, head),
-  path: WebsocketRoutes['/'],
-  tags: [APITags.browserWS],
-};
-
-export default route;
+  ): Promise<void> => chrome.proxyWebSocket(req, socket, head);
+}

package/src/routes/chromium/ws/page.ts

@@ -13,19 +13,17 @@ export interface QuerySchema extends SystemQueryParameters {
   launch?: CDPLaunchOptions | string;
 }
 
-const route: BrowserWebsocketRoute = {
-  auth: true,
-  browser: CDPChromium,
-  concurrency: false,
-  description: `Connect to Chromium with a library like chrome-remote-interface or others that work over JSON chrome-devtools-protocol.`,
-  handler: async (
+export default class PageWebSocketRoute extends BrowserWebsocketRoute {
+  auth = true;
+  browser = CDPChromium;
+  concurrency = false;
+  description = `Connect to Chromium with a library like chrome-remote-interface or others that work over JSON chrome-devtools-protocol.`;
+  path = WebsocketRoutes.page;
+  tags = [APITags.browserWS];
+  handler = async (
     req: Request,
     socket: Duplex,
     head: Buffer,
     chrome: CDPChromium,
-  ): Promise<void> => chrome.proxyPageWebSocket(req, socket, head),
-  path: WebsocketRoutes.page,
-  tags: [APITags.browserWS],
-};
-
-export default route;
+  ): Promise<void> => chrome.proxyPageWebSocket(req, socket, head);
+}

package/src/routes/chromium/ws/playwright-chromium.ts

@@ -14,12 +14,14 @@ export interface QuerySchema extends SystemQueryParameters {
   launch?: BrowserServerOptions | string;
 }
 
-const route: BrowserWebsocketRoute = {
-  auth: true,
-  browser: PlaywrightChromium,
-  concurrency: true,
-  description: `Connect to Chromium with any playwright-compliant library.`,
-  handler: async (
+export default class PlaywrightChromiumRoute extends BrowserWebsocketRoute {
+  auth = true;
+  browser = PlaywrightChromium;
+  concurrency = true;
+  description = `Connect to Chromium with any playwright style library.`;
+  path = WebsocketRoutes.playwrightChromium;
+  tags = [APITags.browserWS];
+  handler = async (
     req: Request,
     socket: Duplex,
     head: Buffer,
@@ -36,9 +38,5 @@ const route: BrowserWebsocketRoute = {
     }
 
     return browser.proxyWebSocket(req, socket, head);
-  },
-  path: WebsocketRoutes.playwrightChromium,
-  tags: [APITags.browserWS],
-};
-
-export default route;
+  };
+}

package/src/routes/firefox/ws/playwright-firefox.ts

@@ -14,12 +14,14 @@ export interface QuerySchema extends SystemQueryParameters {
   launch?: BrowserServerOptions | string;
 }
 
-const route: BrowserWebsocketRoute = {
-  auth: true,
-  browser: PlaywrightFirefox,
-  concurrency: true,
-  description: `Connect to Firefox with any playwright-compliant library.`,
-  handler: async (
+export default class PlayWrightFirefoxRoute extends BrowserWebsocketRoute {
+  auth = true;
+  browser = PlaywrightFirefox;
+  concurrency = true;
+  description = `Connect to Firefox with any playwright-compliant library.`;
+  path = WebsocketRoutes.playwrightFirefox;
+  tags = [APITags.browserWS];
+  handler = async (
     req: Request,
     socket: Duplex,
     head: Buffer,
@@ -36,9 +38,5 @@ const route: BrowserWebsocketRoute = {
     }
 
     return browser.proxyWebSocket(req, socket, head);
-  },
-  path: WebsocketRoutes.playwrightFirefox,
-  tags: [APITags.browserWS],
-};
-
-export default route;
+  };
+}

package/src/routes/management/http/config-get.ts

@@ -4,7 +4,6 @@ import {
   HTTPRoute,
   Methods,
   Request,
-  ServerError,
   contentTypes,
   jsonResponse,
 } from '@browserless.io/browserless';
@@ -33,21 +32,18 @@ export interface ResponseSchema {
   token: string | null;
 }
 
-const route: HTTPRoute = {
-  accepts: [contentTypes.any],
-  auth: true,
-  browser: null,
-  concurrency: false,
-  contentTypes: [contentTypes.json],
-  description: `Returns a JSON payload of the current system configuration.`,
-  handler: async (_req: Request, res: ServerResponse): Promise<void> => {
-    const { getConfig: getConfig } = route;
-
-    if (!getConfig) {
-      throw new ServerError(`Couldn't locate the config object`);
-    }
-
-    const config = getConfig();
+export default class ConfigGetRoute extends HTTPRoute {
+  accepts = [contentTypes.any];
+  auth = true;
+  browser = null;
+  concurrency = false;
+  contentTypes = [contentTypes.json];
+  description = `Returns a JSON payload of the current system configuration.`;
+  method = Methods.get;
+  path = HTTPManagementRoutes.config;
+  tags = [APITags.management];
+  handler = async (_req: Request, res: ServerResponse): Promise<void> => {
+    const config = this.config();
 
     const response: ResponseSchema = {
       allowCORS: config.getAllowCORS(),
@@ -73,10 +69,5 @@ const route: HTTPRoute = {
     };
 
     return jsonResponse(res, 200, response);
-  },
-  method: Methods.get,
-  path: HTTPManagementRoutes.config,
-  tags: [APITags.management],
-};
-
-export default route;
+  };
+}

package/src/routes/management/http/metrics-get.ts

@@ -5,7 +5,6 @@ import {
   IBrowserlessStats,
   Methods,
   Request,
-  ServerError,
   contentTypes,
   writeResponse,
 } from '@browserless.io/browserless';
@@ -13,31 +12,23 @@ import { ServerResponse } from 'http';
 
 export type ResponseSchema = Array<IBrowserlessStats>;
 
-const route: HTTPRoute = {
-  accepts: [contentTypes.any],
-  auth: true,
-  browser: null,
-  concurrency: false,
-  contentTypes: [contentTypes.json],
-  description: `Gets total metric details from the time the server started.`,
-  handler: async (_req: Request, res: ServerResponse): Promise<void> => {
-    const { getFileSystem: _fileSystem, getConfig: _config } = route;
-
-    if (!_fileSystem || !_config) {
-      throw new ServerError(`Couldn't locate the file-system or config module`);
-    }
-
-    const fileSystem = _fileSystem();
-    const config = _config();
+export default class MetricsGetRoute extends HTTPRoute {
+  accepts = [contentTypes.any];
+  auth = true;
+  browser = null;
+  concurrency = false;
+  contentTypes = [contentTypes.json];
+  description = `Gets total metric details from the time the server started.`;
+  method = Methods.get;
+  path = HTTPManagementRoutes.metrics;
+  tags = [APITags.management];
+  handler = async (_req: Request, res: ServerResponse): Promise<void> => {
+    const fileSystem = this.fileSystem();
+    const config = this.config();
 
     const stats = await fileSystem.read(config.getMetricsJSONPath());
     const response = `[${stats.join(',')}]`;
 
     return writeResponse(res, 200, response, contentTypes.json);
-  },
-  method: Methods.get,
-  path: HTTPManagementRoutes.metrics,
-  tags: [APITags.management],
-};
-
-export default route;
+  };
+}

package/src/routes/management/http/metrics-total-get.ts

@@ -5,7 +5,6 @@ import {
   IBrowserlessMetricTotals,
   Methods,
   Request,
-  ServerError,
   contentTypes,
   writeResponse,
 } from '@browserless.io/browserless';
@@ -15,28 +14,23 @@ export type ResponseSchema = IBrowserlessMetricTotals;
 
 const fiveMinuteIntervalsInAMonth = 8640;
 
-const route: HTTPRoute = {
-  accepts: [contentTypes.any],
-  auth: true,
-  browser: null,
-  concurrency: false,
-  contentTypes: [contentTypes.json],
-  description: `Gets total metric details summed from the time the server started.`,
-  handler: async (_req: Request, res: ServerResponse): Promise<void> => {
-    const { getFileSystem: _fileSystem, getConfig: _config } = route;
-
-    if (!_fileSystem || !_config) {
-      throw new ServerError(`Couldn't locate the file-system or config module`);
-    }
-
-    const fileSystem = _fileSystem();
-    const config = _config();
-
+export default class MetricsTotalGetRoute extends HTTPRoute {
+  accepts = [contentTypes.any];
+  auth = true;
+  browser = null;
+  concurrency = false;
+  contentTypes = [contentTypes.json];
+  description = `Gets total metric details summed from the time the server started.`;
+  method = Methods.get;
+  path = HTTPManagementRoutes.metricsTotal;
+  tags = [APITags.management];
+  handler = async (_req: Request, res: ServerResponse): Promise<void> => {
+    const fileSystem = this.fileSystem();
+    const config = this.config();
     const metrics = (await fileSystem.read(config.getMetricsJSONPath())).map(
       (m) => JSON.parse(m),
     );
     const availableMetrics = metrics.length;
-
     const totals: IBrowserlessMetricTotals = metrics.reduce(
       (accum, metric) => ({
         error: accum.error + metric.error,
@@ -80,10 +74,5 @@ const route: HTTPRoute = {
     );
 
     return writeResponse(res, 200, JSON.stringify(totals), contentTypes.json);
-  },
-  method: Methods.get,
-  path: HTTPManagementRoutes.metricsTotal,
-  tags: [APITags.management],
-};
-
-export default route;
+  };
+}

package/src/routes/management/http/sessions-get.ts

@@ -1,6 +1,5 @@
 import {
   APITags,
-  BadRequest,
   BrowserlessSessionJSON,
   HTTPManagementRoutes,
   HTTPRoute,
@@ -13,27 +12,20 @@ import { ServerResponse } from 'http';
 
 export type ResponseSchema = BrowserlessSessionJSON[];
 
-const route: HTTPRoute = {
-  accepts: [contentTypes.any],
-  auth: true,
-  browser: null,
-  concurrency: false,
-  contentTypes: [contentTypes.json],
-  description: `Lists all currently running sessions and relevant meta-data excluding potentially open pages.`,
-  handler: async (_req: Request, res: ServerResponse): Promise<void> => {
-    const { getBrowserManager: browserManager } = route;
-
-    if (!browserManager) {
-      throw new BadRequest(`Couldn't load browsers running`);
-    }
-
-    const response: ResponseSchema = await browserManager().getAllSessions();
+export default class SessionsGetRoute extends HTTPRoute {
+  accepts = [contentTypes.any];
+  auth = true;
+  browser = null;
+  concurrency = false;
+  contentTypes = [contentTypes.json];
+  description = `Lists all currently running sessions and relevant meta-data excluding potentially open pages.`;
+  method = Methods.get;
+  path = HTTPManagementRoutes.sessions;
+  tags = [APITags.management];
+  handler = async (_req: Request, res: ServerResponse): Promise<void> => {
+    const browserManager = this.browserManager();
+    const response: ResponseSchema = await browserManager.getAllSessions();
 
     return jsonResponse(res, 200, response);
-  },
-  method: Methods.get,
-  path: HTTPManagementRoutes.sessions,
-  tags: [APITags.management],
-};
-
-export default route;
+  };
+}