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

package/src/routes/chromium/http/json-version-get.ts

@@ -0,0 +1,55 @@
+import {
+  APITags,
+  BrowserManager,
+  HTTPRoutes,
+  HTTPRoute,
+  Methods,
+  Request,
+  Response,
+  UnwrapPromise,
+  contentTypes,
+  jsonResponse,
+  writeResponse,
+} from '@browserless.io/browserless';
+
+export type ResponseSchema = UnwrapPromise<
+  ReturnType<BrowserManager['getVersionJSON']>
+>;
+
+export default class GetJSONVersion extends HTTPRoute {
+  accepts = [contentTypes.any];
+  auth = true;
+  browser = null;
+  concurrency = false;
+  contentTypes = [contentTypes.json];
+  description = `Returns a JSON payload that acts as a pass-through to the DevTools /json/version protocol in Chrome.`;
+  method = Methods.get;
+  path = HTTPRoutes.jsonVersion;
+  tags = [APITags.browserAPI];
+
+  private cachedJSON: ResponseSchema | undefined;
+
+  handler = async (req: Request, res: Response): Promise<void> => {
+    const baseUrl = req.parsed.host;
+    const protocol = req.parsed.protocol.includes('s') ? 'wss' : 'ws';
+    const browserManager = this.browserManager();
+
+    try {
+      if (!this.cachedJSON) {
+        this.cachedJSON = {
+          ...(await browserManager.getVersionJSON()),
+          webSocketDebuggerUrl: `${protocol}://${baseUrl}`,
+        };
+      }
+
+      return jsonResponse(res, 200, this.cachedJSON);
+    } catch (err) {
+      return writeResponse(
+        res,
+        500,
+        'There was an error handling your request',
+        contentTypes.text,
+      );
+    }
+  };
+}

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/utils.ts

@@ -53,7 +53,7 @@ export const jsExtension = '.js';
 export const id = (): string => crypto.randomUUID();
 
 export const createLogger = (domain: string): debug.Debugger => {
-  return debug(`browserless:${domain}`);
+  return debug(`browserless.io:${domain}`);
 };
 
 const errorLog = createLogger('error');