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

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

@@ -5,7 +5,6 @@ import {
   Methods,
   NotFound,
   Request,
-  ServerError,
   contentTypes,
   createLogger,
   fileExists,
@@ -47,15 +46,17 @@ const streamFile = (res: ServerResponse, file: string, contentType?: string) =>
       .pipe(res);
   });
 
-const route: HTTPRoute = {
-  accepts: [contentTypes.any],
-  auth: false,
-  browser: null,
-  concurrency: false,
-  contentTypes: [contentTypes.any],
-  description: `Serves static files inside of this "static" directory. Content-types will vary depending on the type of file being returned.`,
-  handler: async (req: Request, res: ServerResponse): Promise<unknown> => {
-    const { getConfig: getConfig } = route;
+export default class StaticGetRoute extends HTTPRoute {
+  accepts = [contentTypes.any];
+  auth = false;
+  browser = null;
+  concurrency = false;
+  contentTypes = [contentTypes.any];
+  description = `Serves static files inside of this "static" directory. Content-types will vary depending on the type =of file being returned.`;
+  method = Methods.get;
+  path = HTTPManagementRoutes.static;
+  tags = [APITags.management];
+  handler = async (req: Request, res: ServerResponse): Promise<unknown> => {
     const { pathname } = req.parsed;
     const fileCache = pathMap.get(pathname);
 
@@ -63,11 +64,7 @@ const route: HTTPRoute = {
       return streamFile(res, fileCache.path, fileCache.contentType);
     }
 
-    if (!getConfig) {
-      throw new ServerError(`Couldn't load configuration for request`);
-    }
-
-    const config = getConfig();
+    const config = this.config();
     const file = path.join(config.getStatic(), pathname);
     const indexFile = path.join(file, 'index.html');
 
@@ -100,10 +97,5 @@ const route: HTTPRoute = {
     });
 
     return streamFile(res, filePath, contentType);
-  },
-  method: Methods.get,
-  path: HTTPManagementRoutes.static,
-  tags: [APITags.management],
-};
-
-export default route;
+  };
+}

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

@@ -14,12 +14,14 @@ export interface QuerySchema extends SystemQueryParameters {
   launch?: BrowserServerOptions | string;
 }
 
-const route: BrowserWebsocketRoute = {
-  auth: true,
-  browser: PlaywrightWebkit,
-  concurrency: true,
-  description: `Connect to Webkit with any playwright-compliant library.`,
-  handler: async (
+export default class PlaywrightWebkitRoute extends BrowserWebsocketRoute {
+  auth = true;
+  browser = PlaywrightWebkit;
+  concurrency = true;
+  description = `Connect to Webkit with any playwright-compliant library.`;
+  path = WebsocketRoutes.playwrightWebkit;
+  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.playwrightWebkit,
-  tags: [APITags.browserWS],
-};
-
-export default route;
+  };
+}

package/src/server.ts

@@ -298,7 +298,6 @@ export class HTTPServer {
           return writeResponse(res, 408, e.message);
         }
 
-        this.log(`Error handling request at "${route.path}": ${e}`);
         return writeResponse(res, 500, e.toString());
       });
   };

package/src/types.ts

@@ -88,12 +88,21 @@ type defaultLaunchOptions =
   | BrowserlessLaunch
   | ((req: Request) => CDPLaunchOptions | BrowserlessLaunch);
 
-interface Route {
+abstract class Route {
+  constructor(
+    protected _browserManager: Browserless['browserManager'],
+    protected _config: Browserless['config'],
+    protected _fileSystem: Browserless['fileSystem'],
+    protected _debug: Browserless['debug'],
+    protected _metrics: Browserless['metrics'],
+    protected _monitoring: Browserless['monitoring'],
+  ) {}
+
   /**
    * A boolean, or a function that returns a boolean, on
    * whether the route requires an API token to access.
    */
-  auth: boolean | ((req: Request) => Promise<boolean>);
+  auth: boolean | ((req: Request) => Promise<boolean>) = true;
 
   /**
    * The schematic of the submitted BODY (typically)
@@ -102,31 +111,45 @@ interface Route {
    */
   bodySchema?: unknown;
 
+  /**
+   * The query parameters accepted by the route, defined in
+   * an object format. This is auto-generated for you if your
+   * route defines and exports a QuerySchema type.
+   */
+  querySchema?: unknown;
+
+  /**
+   * The structure of the routes response when successful. This
+   * is auto-generated for you if your route defines a ResponseSchema
+   * type and exports it in your route.
+   */
+  responseSchema?: unknown;
+
   /**
    * Whether the route should be bound by the global
    * concurrency limit defined in your configuration.
    */
-  concurrency: boolean;
+  concurrency: boolean = true;
 
   /**
    * Description of the route and what it does. This description
    * is then used in the embedded documentation site.
    */
-  description: string;
+  description?: string;
 
   /**
    * Helper function to load the browser-manager instance. Defined
    * and injected by browserless after initialization.
    * @returns BrowserManager
    */
-  getBrowserManager?: () => Browserless['browserManager'];
+  browserManager = () => this._browserManager;
 
   /**
    * Helper function that loads the config module. Defined and injected by
    * browserless after initialization.
    * @returns Config
    */
-  getConfig?: () => Browserless['config'];
+  config = () => this._config;
 
   /**
    * Helper function that loads the debug module, useful
@@ -134,7 +157,7 @@ interface Route {
    * and injected by browserless after initialization.
    * @returns Debug
    */
-  getDebug?: () => debug.Debugger;
+  debug = () => this._debug;
 
   /**
    * Helper function that loads the file-system module
@@ -142,7 +165,7 @@ interface Route {
    * browserless after initialization.
    * @returns FileSystem
    */
-  getFileSystem?: () => Browserless['fileSystem'];
+  fileSystem = () => this._fileSystem;
 
   /**
    * Helper function that loads the metrics module for
@@ -150,7 +173,7 @@ interface Route {
    * browserless after initialization.
    * @returns Metrics
    */
-  getMetrics?: () => Browserless['metrics'];
+  metrics = () => this._metrics;
 
   /**
    * Helper function that loads the monitoring module useful
@@ -158,32 +181,18 @@ interface Route {
    * browserless after initialization.
    * @returns Monitor
    */
-  getMonitoring?: () => Browserless['monitoring'];
+  monitoring = () => this._monitoring;
 
   /**
    * The HTTP path that this route handles, eg '/my-route'
    */
-  path: HTTPRoutes | WebsocketRoutes | HTTPManagementRoutes | string;
-
-  /**
-   * The query parameters accepted by the route, defined in
-   * an object format. This is auto-generated for you if your
-   * route defines and exports a QuerySchema type.
-   */
-  querySchema?: unknown;
-
-  /**
-   * The structure of the routes response when successful. This
-   * is auto-generated for you if your route defines a ResponseSchema
-   * type and exports it in your route.
-   */
-  responseSchema?: unknown;
+  abstract path: HTTPRoutes | WebsocketRoutes | HTTPManagementRoutes | string;
 
   /**
    * The tag(s) for the route to categorize it in the
    * documentation portal
    */
-  tags: APITags[];
+  abstract tags: APITags[];
 }
 
 /**
@@ -191,38 +200,39 @@ interface Route {
  * browser in order to fulfill requests. Used by downstream HTTPRoute
  * and WebSocketRoute
  */
-interface BasicHTTPRoute extends Route {
+abstract class BasicHTTPRoute extends Route {
   /**
    * The allowed Content-Types that this route can read and handle.
    * If a request comes in with a Content-Type of 'application/json', then
    * this accepts would need to include ["application/json"] in order to not 404
    */
-  accepts: Array<contentTypes>;
+  abstract accepts: Array<contentTypes>;
 
   /**
    * The Content-Types that this route will will respond with, and must match the Accepts
    * Header from a client if present. If a request comes in with an Accepts of "application/json"
    * then the contentTypes here would need to include ["application/json"] in order to not 404.
    */
-  contentTypes: Array<contentTypes>;
+  abstract contentTypes: Array<contentTypes>;
 
   /**
    * The allowed methods ("GET", "POST", etc) this route can utilize and match against.
    */
-  method: Methods;
+  abstract method: Methods;
 }
 
 /**
  * A HTTP-based route, with a handler, that can fulfill requests without
  * a browser required.
  */
-export interface HTTPRoute extends BasicHTTPRoute {
-  browser: null;
-
+export abstract class HTTPRoute extends BasicHTTPRoute {
   /**
    * Handles an inbound HTTP request, and supplies the Request and Response objects from node's HTTP request event
    */
-  handler: (req: Request, res: http.ServerResponse) => Promise<unknown>;
+  abstract handler: (
+    req: Request,
+    res: http.ServerResponse,
+  ) => Promise<unknown>;
 }
 
 /**
@@ -230,35 +240,39 @@ export interface HTTPRoute extends BasicHTTPRoute {
  * requires a browser in order to do so. Handler will then be called
  * with a 3rd argument of the browser class specified.
  */
-export interface BrowserHTTPRoute extends BasicHTTPRoute {
-  browser: BrowserClasses;
-
+export abstract class BrowserHTTPRoute extends BasicHTTPRoute {
   defaultLaunchOptions?: defaultLaunchOptions;
 
+  abstract browser: BrowserClasses;
+
   /**
    * Handles an inbound HTTP request with a 3rd param of the predefined
    * browser used for the route -- only Chrome CDP is support currently.
    */
-  handler: (
+  abstract handler: (
     req: Request,
     res: http.ServerResponse,
     browser: BrowserInstance,
   ) => Promise<unknown>;
 
-  onNewPage?: undefined;
+  /**
+   * An optional function to automatically set up or handle new page
+   * creation. Useful for injecting behaviors or other functionality.
+   */
+  onNewPage?: (url: URL, page: Page) => Promise<void>;
 }
 
 /**
  * A WebSocket-based route, with a handler, that can fulfill requests
  * that do not require a browser in order to operate.
  */
-export interface WebSocketRoute extends Route {
-  browser: null;
+export abstract class WebSocketRoute extends Route {
+  browser = null;
 
   /**
    * Handles an inbound Websocket request, and handles the connection
    */
-  handler: (
+  abstract handler: (
     req: Request,
     socket: stream.Duplex,
     head: Buffer,
@@ -270,8 +284,8 @@ export interface WebSocketRoute extends Route {
  * that need a browser. Handler is called with an additional argument of
  * browser (the browser class required to run the route).
  */
-export interface BrowserWebsocketRoute extends Route {
-  browser: BrowserClasses;
+export abstract class BrowserWebsocketRoute extends Route {
+  abstract browser: BrowserClasses;
 
   defaultLaunchOptions?: defaultLaunchOptions;
 
@@ -279,7 +293,7 @@ export interface BrowserWebsocketRoute extends Route {
    * Handles an inbound Websocket request, and handles the connection
    * with the prior set browser being injected.
    */
-  handler(
+  abstract handler(
     req: Request,
     socket: stream.Duplex,
     head: Buffer,

package/static/docs/browserless-logo-inline.svg

@@ -0,0 +1 @@
+<svg width="148" height="38" viewBox="0 0 148 38" fill="#fff" xmlns="http://www.w3.org/2000/svg" class="xl:h-8 xl:w-[125px]"><path class="logo_inline_svg__cls-1" d="M11.09 14.86V6.57L7.38 4.38V22.8l6.15-2.88.01 4.03-9.81 4.88V2.17L.04 0 0 30.73l3.56 2.39 13.69-6.8-.02-7.84-6.14-3.62zM35.06 16.13a3.21 3.21 0 00-1.42-1 6.33 6.33 0 00-2.07-.3 6.64 6.64 0 00-2.45.61v-3.29l-3-1.59v16.16h4.43a10.47 10.47 0 002.64-.29 3.81 3.81 0 001.75-1 3.91 3.91 0 001-1.83 11.13 11.13 0 00.3-2.81 12.56 12.56 0 00-.35-2.79 4.61 4.61 0 00-.83-1.87zM33 22.22a2.41 2.41 0 01-.41 1 1.62 1.62 0 01-.8.57 4 4 0 01-1.24.17L30 24l-.86-.07v-6.08l.32-.07a6.12 6.12 0 011.72-.23c1.28 0 1.91 1 1.91 3.07a10.28 10.28 0 01-.09 1.6zM41.79 15.1h-3v11.35h3v-7.61l.46-.15c.44-.14.92-.28 1.44-.41s1.09-.27 1.71-.39v-3.06a11.83 11.83 0 00-3.63 1.47zM52.19 14.83a6.3 6.3 0 00-2.45.42 3.94 3.94 0 00-1.62 1.19 4.87 4.87 0 00-.88 1.86 10.21 10.21 0 00-.24 2.45q0 6 5.22 6t5.22-6a7 7 0 00-1.2-4.37 4.77 4.77 0 00-4.05-1.55zm1.68 8.5a1.74 1.74 0 01-1.68.8 2 2 0 01-1.17-.3 2 2 0 01-.64-.8 3.56 3.56 0 01-.27-1.09 11.85 11.85 0 01-.06-1.19 5.35 5.35 0 01.46-2.55 2.18 2.18 0 013.36 0 5.37 5.37 0 01.45 2.55 5.56 5.56 0 01-.45 2.58zM71.17 23.86h-.54l-1.73-8.54h-3.13l-1.73 8.54h-.54l-1.39-8.76h-3l2.16 11.35h4.77l1.29-6.95 1.3 6.95h4.76l2.16-11.35h-2.99l-1.39 8.76zM85.59 20.62a3 3 0 00-1-.67 6.81 6.81 0 00-1.59-.42c-.62-.11-1.12-.2-1.49-.29a5.51 5.51 0 01-.78-.21.64.64 0 01-.46-.62.69.69 0 01.34-.63 3.18 3.18 0 011.46-.21q.57 0 1.53.09c.64.06 1.44.16 2.4.28v-2.52l-.75-.14c-.77-.15-1.46-.26-2.08-.33a13.89 13.89 0 00-1.57-.1 6.1 6.1 0 00-1.76.23 3.84 3.84 0 00-1.39.68 3.25 3.25 0 00-.91 1.13 3.64 3.64 0 00-.33 1.59 4.59 4.59 0 00.26 1.52 2.38 2.38 0 00.65 1 3.05 3.05 0 001.09.64 8.94 8.94 0 001.54.37 13.1 13.1 0 012.18.5.68.68 0 01.41.64.67.67 0 01-.39.63 3.29 3.29 0 01-1.5.23q-.56 0-1.53-.09c-.64-.06-1.44-.15-2.39-.27l-.09 2.54.72.13a19.48 19.48 0 003.64.41q4.56 0 4.56-3.67a5.05 5.05 0 00-.18-1.44 2.36 2.36 0 00-.59-1zM93.35 14.83c-3.34 0-5 2-5 6.1a6.82 6.82 0 001.16 4.43 4.64 4.64 0 003.73 1.36 20 20 0 004.72-.63v-2.25l-.63.07c-1.11.09-2.36.13-3.77.13a2.28 2.28 0 01-1.55-.46 2 2 0 01-.54-1.51h6.67L98.3 20q0-5.17-4.95-5.17zm-2 4.92a3.15 3.15 0 01.46-1.87 1.87 1.87 0 011.53-.56 1.81 1.81 0 011.51.54 3.13 3.13 0 01.42 1.89zM103.84 15.1h-3v11.35h3v-7.61l.46-.15c.44-.14.92-.28 1.44-.41s1.09-.27 1.71-.39v-3.06a11.83 11.83 0 00-3.63 1.47zM109.74 10.56h3.04v15.89h-3.04zM120.53 14.83q-5 0-5 6.1a6.82 6.82 0 001.16 4.43 4.62 4.62 0 003.72 1.36 20 20 0 004.73-.63l-.05-2.25-.64.07c-1.1.09-2.36.13-3.76.13a2.26 2.26 0 01-1.55-.46 2 2 0 01-.54-1.51h6.67l.23-2.11q-.02-5.13-4.97-5.13zm-2 4.92a3.14 3.14 0 01.47-1.87 1.85 1.85 0 011.53-.56 1.81 1.81 0 011.51.54 3.13 3.13 0 01.42 1.89zM135.74 20.62a3 3 0 00-1-.67 6.9 6.9 0 00-1.55-.42c-.62-.11-1.11-.2-1.48-.29a5.37 5.37 0 01-.79-.21.63.63 0 01-.45-.62.68.68 0 01.34-.63 3.1 3.1 0 011.45-.21q.57 0 1.53.09c.65.06 1.45.16 2.4.28v-2.52l-.75-.14c-.78-.15-1.47-.26-2.08-.33a14 14 0 00-1.58-.1 6.15 6.15 0 00-1.76.23 3.72 3.72 0 00-1.38.68 3.14 3.14 0 00-.91 1.13 3.64 3.64 0 00-.33 1.59 4.61 4.61 0 00.21 1.51 2.48 2.48 0 00.65 1 3.14 3.14 0 001.09.64 8.94 8.94 0 001.54.37 12.83 12.83 0 012.18.5.71.71 0 010 1.27 3.35 3.35 0 01-1.5.23q-.57 0-1.53-.09t-2.4-.27l-.09 2.54.73.13a19.39 19.39 0 003.63.41q4.56 0 4.56-3.67a5.05 5.05 0 00-.18-1.44 2.36 2.36 0 00-.55-.99zM147.39 21.61a2.36 2.36 0 00-.59-1 2.92 2.92 0 00-1.05-.67 6.81 6.81 0 00-1.54-.42c-.62-.11-1.12-.2-1.49-.29a5.51 5.51 0 01-.78-.21.63.63 0 01-.45-.62.68.68 0 01.34-.63 3.1 3.1 0 011.45-.21q.57 0 1.53.09c.64.06 1.44.16 2.4.28v-2.52l-.75-.14q-1.16-.22-2.07-.33a14.19 14.19 0 00-1.58-.1 6.1 6.1 0 00-1.76.23 3.84 3.84 0 00-1.39.68 3.25 3.25 0 00-.91 1.13 3.64 3.64 0 00-.32 1.59 4.61 4.61 0 00.21 1.51 2.38 2.38 0 00.65 1 3.14 3.14 0 001.09.64A8.94 8.94 0 00142 22a13.1 13.1 0 012.18.5.68.68 0 01.41.64.67.67 0 01-.39.63 3.27 3.27 0 01-1.49.23c-.38 0-.89 0-1.54-.09s-1.44-.15-2.39-.27l-.09 2.54.72.13a19.48 19.48 0 003.64.41q4.56 0 4.56-3.67a5.05 5.05 0 00-.22-1.44z"></path></svg>

package/static/docs/index.html

@@ -13,6 +13,8 @@
     a[href^="mailto:"] {
       text-decoration: underline !important;
     }
+
+    img[src="/assets/logo.png"],
     a[href="https://github.com/Redocly/redoc"],
     a[href="https://redocly.com/redoc/"] {
       display: none !important;
@@ -63,6 +65,31 @@
     .redoc-markdown :not(pre) code {
       color: rgb(255, 102, 178) !important;
     }
+
+    input[aria-label="Search"] {
+      color: white;
+    }
+
+    div[role="search"] svg.search-icon path {
+      fill: white !important;
+    }
+
+    div[data-role="search:results"] {
+      background: rgb(51, 51, 51);
+    }
+
+    div[role="search"] div.scrollbar-container {
+      height: fit-content;
+      z-index: 11111;
+      position: absolute;
+      width: 94%;
+    }
+
+    div.menu-content > div > img {
+      width: 75%;
+      margin-left: 5%;
+      margin-bottom: 10%;
+    }
   </style>
 </head>
 <body>