@browserless.io/browserless 2.0.0-beta-8 → 2.1.1

package/src/routes/chromium/tests/json-version.spec.ts

@@ -0,0 +1,52 @@
+import { Browserless, Config, Metrics } from '@browserless.io/browserless';
+import { expect } from 'chai';
+
+describe('/json/version API', function () {
+  let browserless: Browserless;
+
+  const start = ({
+    config = new Config(),
+    metrics = new Metrics(),
+  }: { config?: Config; metrics?: Metrics } = {}) => {
+    browserless = new Browserless({ config, metrics });
+    return browserless.start();
+  };
+
+  afterEach(async () => {
+    await browserless.stop();
+  });
+
+  it('allows requests to /json/version', async () => {
+    const config = new Config();
+    config.setToken('browserless');
+    const metrics = new Metrics();
+    await start({ config, metrics });
+
+    const res = await fetch(
+      'http://localhost:3000/json/version?token=browserless',
+    );
+    const resJSON = await res.json();
+
+    [
+      'Browser',
+      'Protocol-Version',
+      'User-Agent',
+      'V8-Version',
+      'WebKit-Version',
+      'webSocketDebuggerUrl',
+      'Debugger-Version',
+    ].forEach((k) => expect(resJSON).to.haveOwnProperty(k));
+  });
+
+  it('rejects unauthorized requests to /json/version', async () => {
+    const config = new Config();
+    config.setToken('browserless');
+    const metrics = new Metrics();
+    await start({ config, metrics });
+
+    const res = await fetch(
+      'http://localhost:3000/json/version?token=imabadboi',
+    );
+    expect(res.status).to.equal(401);
+  });
+});

package/src/routes/chromium/utils/cdp.ts

@@ -0,0 +1,19 @@
+import { CDPJSONPayload, pageID } from '@browserless.io/browserless';
+
+export const getCDPJSONPayload = (externalAddress: string): CDPJSONPayload => {
+  const id = pageID();
+  const { protocol, host, pathname, href } = new URL(
+    `/devtools/page/${id}`,
+    externalAddress,
+  );
+
+  return {
+    description: '',
+    devtoolsFrontendUrl: `/devtools/inspector.html?${protocol.replace(':', '')}=${host}${pathname}`,
+    id,
+    title: 'New Tab',
+    type: 'page',
+    url: 'about:blank',
+    webSocketDebuggerUrl: href,
+  };
+};

package/src/types.ts

@@ -556,3 +556,41 @@ export interface IBrowserlessStats {
   unhealthy: number;
   units: number;
 }
+
+export interface CDPJSONPayload {
+  /**
+   * The description of the target. Generally the page's title.
+   */
+  description: string;
+
+  /**
+   * The fully-qualified URL of the Devtools inspector app.
+   */
+  devtoolsFrontendUrl: string;
+
+  /**
+   * A Unique Id for the underlying target.
+   */
+  id: string;
+
+  /**
+   * The title of the target. For pages this is the page's title.
+   */
+  title: string;
+
+  /**
+   * The type of target, generally "page" or "background_page".
+   */
+  type: string;
+
+  /**
+   * The current URL the target is consuming or visiting.
+   */
+  url: string;
+
+  /**
+   * The target or page's WebSocket Debugger URL. Primarily used for legacy
+   * libraries to connect and inspect or remote automate this target.
+   */
+  webSocketDebuggerUrl: string;
+}

package/src/utils.ts

@@ -1,5 +1,6 @@
 import * as fs from 'fs/promises';
 import {
+  BLESS_PAGE_IDENTIFIER,
   CDPChromium,
   Config,
   PlaywrightChromium,
@@ -52,6 +53,23 @@ export const jsExtension = '.js';
 
 export const id = (): string => crypto.randomUUID();
 
+/**
+ * Generates a random, Chrome-compliant page ID with "BLESS"
+ * prepended. This prepended text signals to other parts of the
+ * system that this is a Browserless-created ID so it can be appropriately
+ * handled.
+ *
+ * @returns {string} A random Page ID
+ */
+export const pageID = (): string => {
+  const chars = '0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ';
+  const id = Array.from({ length: 32 - BLESS_PAGE_IDENTIFIER.length })
+    .map(() => chars[Math.floor(Math.random() * chars.length)])
+    .join('');
+
+  return `${BLESS_PAGE_IDENTIFIER}${id}`;
+};
+
 export const createLogger = (domain: string): debug.Debugger => {
   return debug(`browserless.io:${domain}`);
 };
@@ -224,10 +242,14 @@ export const removeNullStringify = (
   json: unknown,
   allowNull = true,
 ): string => {
-  return JSON.stringify(json, (_key, value) => {
-    if (allowNull) return value;
-    if (value !== null) return value;
-  });
+  return JSON.stringify(
+    json,
+    (_key, value) => {
+      if (allowNull) return value;
+      if (value !== null) return value;
+    },
+    '  ',
+  );
 };
 
 export const jsonOrString = (maybeJson: string): unknown | string =>