@browserless.io/browserless 2.2.0-beta-6 → 2.2.0

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

@@ -1,7 +1,12 @@
-import { Browserless, Config, Metrics, sleep } from '@browserless.io/browserless';
+import {
+  Browserless,
+  Config,
+  Metrics,
+  sleep,
+} from '@browserless.io/browserless';
 import { expect } from 'chai';
 
-describe('/content API', function () {
+describe('/chromium/content API', function () {
   let browserless: Browserless;
 
   const start = ({
@@ -25,7 +30,7 @@ describe('/content API', function () {
       url: 'https://example.com',
     };
 
-    await fetch('http://localhost:3000/content?token=browserless', {
+    await fetch('http://localhost:3000/chromium/content?token=browserless', {
       body: JSON.stringify(body),
       headers: {
         'content-type': 'application/json',
@@ -52,7 +57,7 @@ describe('/content API', function () {
     };
     const controller = new AbortController();
     const signal = controller.signal;
-    const promise = fetch('http://localhost:3000/content', {
+    const promise = fetch('http://localhost:3000/chromium/content', {
       body: JSON.stringify(body),
       headers: {
         'content-type': 'application/json',
@@ -76,14 +81,14 @@ describe('/content API', function () {
     const metrics = new Metrics();
     await start({ config, metrics });
 
-    await fetch('http://localhost:3000/content?token=browserless').then(
-      (res) => {
-        expect(res.headers.get('content-type')).to.equal(
-          'text/plain; charset=UTF-8',
-        );
-        expect(res.status).not.to.equal(200);
-      },
-    );
+    await fetch(
+      'http://localhost:3000/chromium/content?token=browserless',
+    ).then((res) => {
+      expect(res.headers.get('content-type')).to.equal(
+        'text/plain; charset=UTF-8',
+      );
+      expect(res.status).not.to.equal(200);
+    });
   });
 
   it('handles `waitForFunction` properties', async () => {
@@ -98,7 +103,7 @@ describe('/content API', function () {
       },
     };
 
-    await fetch('http://localhost:3000/content?token=browserless', {
+    await fetch('http://localhost:3000/chromium/content?token=browserless', {
       body: JSON.stringify(body),
       headers: {
         'content-type': 'application/json',
@@ -124,7 +129,7 @@ describe('/content API', function () {
       },
     };
 
-    await fetch('http://localhost:3000/content?token=browserless', {
+    await fetch('http://localhost:3000/chromium/content?token=browserless', {
       body: JSON.stringify(body),
       headers: {
         'content-type': 'application/json',
@@ -150,7 +155,7 @@ describe('/content API', function () {
       },
     };
 
-    await fetch('http://localhost:3000/content?token=browserless', {
+    await fetch('http://localhost:3000/chromium/content?token=browserless', {
       body: JSON.stringify(body),
       headers: {
         'content-type': 'application/json',
@@ -174,7 +179,7 @@ describe('/content API', function () {
       waitForTimeout: 500,
     };
 
-    await fetch('http://localhost:3000/content?token=browserless', {
+    await fetch('http://localhost:3000/chromium/content?token=browserless', {
       body: JSON.stringify(body),
       headers: {
         'content-type': 'application/json',
@@ -203,7 +208,7 @@ describe('/content API', function () {
       },
     };
 
-    await fetch('http://localhost:3000/content?token=browserless', {
+    await fetch('http://localhost:3000/chromium/content?token=browserless', {
       body: JSON.stringify(body),
       headers: {
         'content-type': 'application/json',
@@ -227,7 +232,7 @@ describe('/content API', function () {
       url: 'https://example.com',
     };
 
-    await fetch('http://localhost:3000/content?token=browserless', {
+    await fetch('http://localhost:3000/chromium/content?token=browserless', {
       body: JSON.stringify(body),
       headers: {
         'content-type': 'application/json',
@@ -250,13 +255,16 @@ describe('/content API', function () {
       url: 'https://example.com',
     };
 
-    await fetch('http://localhost:3000/content?token=browserless&timeout=10', {
-      body: JSON.stringify(body),
-      headers: {
-        'content-type': 'application/json',
+    await fetch(
+      'http://localhost:3000/chromium/content?token=browserless&timeout=10',
+      {
+        body: JSON.stringify(body),
+        headers: {
+          'content-type': 'application/json',
+        },
+        method: 'POST',
       },
-      method: 'POST',
-    }).then((res) => {
+    ).then((res) => {
       expect(res.status).to.equal(408);
     });
   });
@@ -273,7 +281,7 @@ describe('/content API', function () {
       url: 'https://example.com',
     };
 
-    await fetch('http://localhost:3000/content?token=browserless', {
+    await fetch('http://localhost:3000/chromium/content?token=browserless', {
       body: JSON.stringify(body),
       headers: {
         'content-type': 'application/json',
@@ -306,7 +314,7 @@ describe('/content API', function () {
       url: 'https://example.com',
     };
 
-    await fetch('http://localhost:3000/content?token=browserless', {
+    await fetch('http://localhost:3000/chromium/content?token=browserless', {
       body: JSON.stringify(body),
       headers: {
         'content-type': 'application/json',
@@ -330,7 +338,7 @@ describe('/content API', function () {
       url: 'https://example.com',
     };
 
-    await fetch('http://localhost:3000/content?token=browserless', {
+    await fetch('http://localhost:3000/chromium/content?token=browserless', {
       body: JSON.stringify(body),
       headers: {
         'content-type': 'application/json',
@@ -347,7 +355,7 @@ describe('/content API', function () {
       url: 'https://example.com',
     };
 
-    await fetch('http://localhost:3000/content', {
+    await fetch('http://localhost:3000/chromium/content', {
       body: JSON.stringify(body),
       headers: {
         'content-type': 'application/json',

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

@@ -1,7 +1,7 @@
 import { Browserless, Config, Metrics } from '@browserless.io/browserless';
 import { expect } from 'chai';
 
-describe('/download API', function () {
+describe('/chromium/download API', function () {
   let browserless: Browserless;
 
   const start = ({
@@ -22,7 +22,7 @@ describe('/download API', function () {
     const metrics = new Metrics();
     await start({ config, metrics });
 
-    await fetch('http://localhost:3000/download?token=browserless', {
+    await fetch('http://localhost:3000/chromium/download?token=browserless', {
       body: `export default async ({ page }) => {
         await page.evaluate(() => {
           const txtContent = "data:text/plain;charset=utf-8,Hello world!";
@@ -50,7 +50,7 @@ describe('/download API', function () {
   it('allows requests without token when auth token is not set', async () => {
     await start();
 
-    await fetch('http://localhost:3000/download', {
+    await fetch('http://localhost:3000/chromium/download', {
       body: `export default async ({ page }) => {
         await page.evaluate(() => {
           const txtContent = "data:text/plain;charset=utf-8,Hello world!";

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

@@ -1,7 +1,7 @@
 import { Browserless, Config, Metrics } from '@browserless.io/browserless';
 import { expect } from 'chai';
 
-describe('/function API', function () {
+describe('/chromium/function API', function () {
   let browserless: Browserless;
 
   const start = ({
@@ -31,7 +31,7 @@ describe('/function API', function () {
       context: {},
     };
 
-    await fetch('http://localhost:3000/function?token=browserless', {
+    await fetch('http://localhost:3000/chromium/function?token=browserless', {
       body: JSON.stringify(body),
       headers: {
         'content-type': 'application/json',
@@ -58,7 +58,7 @@ describe('/function API', function () {
       });
     }`;
 
-    await fetch('http://localhost:3000/function?token=browserless', {
+    await fetch('http://localhost:3000/chromium/function?token=browserless', {
       body,
       headers: { 'Content-Type': 'application/javascript' },
       method: 'POST',
@@ -87,7 +87,7 @@ describe('/function API', function () {
       context: {},
     };
 
-    await fetch('http://localhost:3000/function?token=browserless', {
+    await fetch('http://localhost:3000/chromium/function?token=browserless', {
       body: JSON.stringify(body),
       headers: {
         'content-type': 'application/json',
@@ -119,7 +119,7 @@ describe('/function API', function () {
       context: {},
     };
 
-    await fetch('http://localhost:3000/function?token=browserless', {
+    await fetch('http://localhost:3000/chromium/function?token=browserless', {
       body: JSON.stringify(body),
       headers: {
         'content-type': 'application/json',
@@ -151,13 +151,16 @@ describe('/function API', function () {
       context: {},
     };
 
-    await fetch('http://localhost:3000/function?token=browserless&timeout=10', {
-      body: JSON.stringify(body),
-      headers: {
-        'content-type': 'application/json',
+    await fetch(
+      'http://localhost:3000/chromium/function?token=browserless&timeout=10',
+      {
+        body: JSON.stringify(body),
+        headers: {
+          'content-type': 'application/json',
+        },
+        method: 'POST',
       },
-      method: 'POST',
-    }).then((res) => {
+    ).then((res) => {
       expect(res.status).to.equal(408);
     });
   });
@@ -180,7 +183,7 @@ describe('/function API', function () {
       context: {},
     };
 
-    await fetch('http://localhost:3000/function?token=browserless', {
+    await fetch('http://localhost:3000/chromium/function?token=browserless', {
       body: JSON.stringify(body),
       headers: {
         'content-type': 'joelson',
@@ -209,7 +212,7 @@ describe('/function API', function () {
       context: {},
     };
 
-    await fetch('http://localhost:3000/function?token=browserless', {
+    await fetch('http://localhost:3000/chromium/function?token=browserless', {
       body: JSON.stringify(body),
       headers: {
         'content-type': 'application/json',
@@ -236,7 +239,7 @@ describe('/function API', function () {
       context: {},
     };
 
-    await fetch('http://localhost:3000/function?token=bless', {
+    await fetch('http://localhost:3000/chromium/function?token=bless', {
       body: JSON.stringify(body),
       headers: {
         'content-type': 'application/json',
@@ -262,7 +265,7 @@ describe('/function API', function () {
       context: {},
     };
 
-    await fetch('http://localhost:3000/function', {
+    await fetch('http://localhost:3000/chromium/function', {
       body: JSON.stringify(body),
       headers: {
         'content-type': 'application/json',

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

@@ -0,0 +1,129 @@
+import { Browserless, Config, Metrics } from '@browserless.io/browserless';
+import puppeteer, { Connection } from 'puppeteer-core';
+import { NodeWebSocketTransport } from 'puppeteer-core/lib/esm/puppeteer/node/NodeWebSocketTransport.js';
+import { expect } from 'chai';
+
+describe('WebSocket Page API', function () {
+  // Server shutdown can take a few seconds
+  // and so can these tests :/
+  this.timeout(5000);
+
+  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('forwards requests to running pages', async () => {
+    const config = new Config();
+    const metrics = new Metrics();
+    await start({ config, metrics });
+
+    const browser = await puppeteer.connect({
+      browserWSEndpoint: `ws://localhost:3000`,
+    });
+    const page = await browser.newPage();
+    await page.goto('https://example.com/');
+    // @ts-ignore
+    const pageId = page.target()._targetId;
+    const webSocketDebuggerUrl = `ws://localhost:3000/devtools/page/${pageId}`;
+
+    // Connect to raw page target
+    const cdp = new Connection(
+      webSocketDebuggerUrl,
+      await NodeWebSocketTransport.create(webSocketDebuggerUrl),
+    );
+
+    // Send a command
+    const result = await cdp.send('Page.enable');
+    await browser.close();
+    expect(result);
+  });
+
+  it('creates pages when interacting with /json/new', async () => {
+    const config = new Config();
+    const metrics = new Metrics();
+    await start({ config, metrics });
+
+    const { webSocketDebuggerUrl } = await fetch(
+      'http://localhost:3000/json/new',
+      {
+        method: 'PUT',
+      },
+    ).then((r) => r.json());
+
+    // Connect to raw page target
+    const cdp = new Connection(
+      webSocketDebuggerUrl,
+      await NodeWebSocketTransport.create(webSocketDebuggerUrl),
+    );
+
+    // Send a command
+    const result = await cdp.send('Page.enable');
+    cdp.dispose();
+    expect(result);
+  });
+
+  it('rejects unauthorized page requests', async () => {
+    const config = new Config();
+    config.setToken('browserless');
+    const metrics = new Metrics();
+    await start({ config, metrics });
+
+    const browser = await puppeteer.connect({
+      browserWSEndpoint: `ws://localhost:3000?token=browserless`,
+    });
+    const page = await browser.newPage();
+    await page.goto('https://example.com/');
+    // @ts-ignore
+    const pageId = page.target()._targetId;
+    const webSocketDebuggerUrl = `ws://localhost:3000/devtools/page/${pageId}`;
+
+    // Connect to raw page target without authorization
+    try {
+      new Connection(
+        webSocketDebuggerUrl,
+        await NodeWebSocketTransport.create(webSocketDebuggerUrl),
+      );
+    } catch (err: unknown) {
+      //@ts-ignore
+      expect(err.message).to.include('401');
+    } finally {
+      browser.close();
+    }
+  });
+
+  it('404s pages not found', async () => {
+    const config = new Config();
+    const metrics = new Metrics();
+    await start({ config, metrics });
+
+    const browser = await puppeteer.connect({
+      browserWSEndpoint: `ws://localhost:3000?token=browserless`,
+    });
+    const page = await browser.newPage();
+    await page.goto('https://example.com/');
+    const webSocketDebuggerUrl = `ws://localhost:3000/devtools/page/im-a-banana`;
+
+    // Connect to raw page target without authorization
+    try {
+      new Connection(
+        webSocketDebuggerUrl,
+        await NodeWebSocketTransport.create(webSocketDebuggerUrl),
+      );
+    } catch (err: unknown) {
+      //@ts-ignore
+      expect(err.message).to.include('404');
+    } finally {
+      browser.close();
+    }
+  });
+});

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

@@ -1,7 +1,7 @@
 import { Browserless, Config, Metrics } from '@browserless.io/browserless';
 import { expect } from 'chai';
 
-describe('/pdf API', function () {
+describe('/chromium/pdf API', function () {
   let browserless: Browserless;
 
   const start = ({
@@ -25,7 +25,7 @@ describe('/pdf API', function () {
       url: 'https://example.com',
     };
 
-    await fetch('http://localhost:3000/pdf?token=browserless', {
+    await fetch('http://localhost:3000/chromium/pdf?token=browserless', {
       body: JSON.stringify(body),
       headers: {
         'content-type': 'application/json',
@@ -47,12 +47,14 @@ describe('/pdf API', function () {
     const metrics = new Metrics();
     await start({ config, metrics });
 
-    await fetch('http://localhost:3000/pdf?token=browserless').then((res) => {
-      expect(res.headers.get('content-type')).to.equal(
-        'text/plain; charset=UTF-8',
-      );
-      expect(res.status).not.to.equal(200);
-    });
+    await fetch('http://localhost:3000/chromium/pdf?token=browserless').then(
+      (res) => {
+        expect(res.headers.get('content-type')).to.equal(
+          'text/plain; charset=UTF-8',
+        );
+        expect(res.status).not.to.equal(200);
+      },
+    );
   });
 
   it('handles `waitForFunction` properties', async () => {
@@ -67,7 +69,7 @@ describe('/pdf API', function () {
       },
     };
 
-    await fetch('http://localhost:3000/pdf?token=browserless', {
+    await fetch('http://localhost:3000/chromium/pdf?token=browserless', {
       body: JSON.stringify(body),
       headers: {
         'content-type': 'application/json',
@@ -91,7 +93,7 @@ describe('/pdf API', function () {
       },
     };
 
-    await fetch('http://localhost:3000/pdf?token=browserless', {
+    await fetch('http://localhost:3000/chromium/pdf?token=browserless', {
       body: JSON.stringify(body),
       headers: {
         'content-type': 'application/json',
@@ -115,7 +117,7 @@ describe('/pdf API', function () {
       },
     };
 
-    await fetch('http://localhost:3000/pdf?token=browserless', {
+    await fetch('http://localhost:3000/chromium/pdf?token=browserless', {
       body: JSON.stringify(body),
       headers: {
         'content-type': 'application/json',
@@ -142,7 +144,7 @@ describe('/pdf API', function () {
       },
     };
 
-    await fetch('http://localhost:3000/pdf?token=browserless', {
+    await fetch('http://localhost:3000/chromium/pdf?token=browserless', {
       body: JSON.stringify(body),
       headers: {
         'content-type': 'application/json',
@@ -164,7 +166,7 @@ describe('/pdf API', function () {
       url: 'https://example.com',
     };
 
-    await fetch('http://localhost:3000/pdf?token=browserless', {
+    await fetch('http://localhost:3000/chromium/pdf?token=browserless', {
       body: JSON.stringify(body),
       headers: {
         'content-type': 'application/json',
@@ -186,13 +188,16 @@ describe('/pdf API', function () {
       url: 'https://example.com',
     };
 
-    await fetch('http://localhost:3000/pdf?token=browserless&timeout=10', {
-      body: JSON.stringify(body),
-      headers: {
-        'content-type': 'application/json',
+    await fetch(
+      'http://localhost:3000/chromium/pdf?token=browserless&timeout=10',
+      {
+        body: JSON.stringify(body),
+        headers: {
+          'content-type': 'application/json',
+        },
+        method: 'POST',
       },
-      method: 'POST',
-    }).then((res) => {
+    ).then((res) => {
       expect(res.status).to.equal(408);
     });
   });
@@ -210,7 +215,7 @@ describe('/pdf API', function () {
       url: 'https://example.com',
     };
 
-    await fetch('http://localhost:3000/pdf?token=browserless', {
+    await fetch('http://localhost:3000/chromium/pdf?token=browserless', {
       body: JSON.stringify(body),
       headers: {
         'content-type': 'application/json',
@@ -244,7 +249,7 @@ describe('/pdf API', function () {
       url: 'https://example.com',
     };
 
-    await fetch('http://localhost:3000/pdf?token=browserless', {
+    await fetch('http://localhost:3000/chromium/pdf?token=browserless', {
       body: JSON.stringify(body),
       headers: {
         'content-type': 'application/json',
@@ -268,7 +273,7 @@ describe('/pdf API', function () {
       url: 'https://example.com',
     };
 
-    await fetch('http://localhost:3000/pdf?token=browserless', {
+    await fetch('http://localhost:3000/chromium/pdf?token=browserless', {
       body: JSON.stringify(body),
       headers: {
         'content-type': 'application/json',
@@ -289,7 +294,7 @@ describe('/pdf API', function () {
       html: '<h1>Hello!</h1>',
     };
 
-    await fetch('http://localhost:3000/pdf?token=browserless', {
+    await fetch('http://localhost:3000/chromium/pdf?token=browserless', {
       body: JSON.stringify(body),
       headers: {
         'content-type': 'application/json',
@@ -313,7 +318,7 @@ describe('/pdf API', function () {
       url: 'https://example.com',
     };
 
-    await fetch('http://localhost:3000/pdf?token=browserless', {
+    await fetch('http://localhost:3000/chromium/pdf?token=browserless', {
       body: JSON.stringify(body),
       headers: {
         'content-type': 'application/json',
@@ -339,7 +344,7 @@ describe('/pdf API', function () {
       },
     };
 
-    await fetch('http://localhost:3000/pdf?token=browserless', {
+    await fetch('http://localhost:3000/chromium/pdf?token=browserless', {
       body: JSON.stringify(body),
       headers: {
         'content-type': 'application/json',
@@ -357,7 +362,7 @@ describe('/pdf API', function () {
       url: 'https://example.com',
     };
 
-    await fetch('http://localhost:3000/pdf', {
+    await fetch('http://localhost:3000/chromium/pdf', {
       body: JSON.stringify(body),
       headers: {
         'content-type': 'application/json',