@browserless.io/browserless 2.33.0 → 2.34.0

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

@@ -22,7 +22,7 @@ describe('/chromium/screenshot API', function () {
     const metrics = new Metrics();
     await start({ config, metrics });
     const body = {
-      url: 'https://example.com',
+      url: 'https://one.one.one.one',
     };
 
     await fetch('http://localhost:3000/chromium/screenshot?token=browserless', {
@@ -59,7 +59,7 @@ describe('/chromium/screenshot API', function () {
     const metrics = new Metrics();
     await start({ config, metrics });
     const body = {
-      url: 'https://example.com',
+      url: 'https://one.one.one.one',
       viewport: {
         deviceScaleFactor: 3,
         height: 100,
@@ -86,7 +86,7 @@ describe('/chromium/screenshot API', function () {
     await start({ config, metrics });
     const body = {
       selector: 'h1',
-      url: 'https://example.com',
+      url: 'https://one.one.one.one',
     };
 
     await fetch('http://localhost:3000/chromium/screenshot?token=browserless', {
@@ -142,7 +142,7 @@ describe('/chromium/screenshot API', function () {
           },
         },
       ],
-      url: 'https://example.com',
+      url: 'https://one.one.one.one',
     };
 
     await fetch('http://localhost:3000/chromium/screenshot?token=browserless', {
@@ -163,7 +163,7 @@ describe('/chromium/screenshot API', function () {
     const metrics = new Metrics();
     await start({ config, metrics });
     const body = {
-      url: 'https://example.com',
+      url: 'https://one.one.one.one',
       waitForFunction: {
         fn: '() => 5 + 5',
       },
@@ -187,7 +187,7 @@ describe('/chromium/screenshot API', function () {
     const metrics = new Metrics();
     await start({ config, metrics });
     const body = {
-      url: 'https://example.com',
+      url: 'https://one.one.one.one',
       waitForFunction: {
         fn: 'async () => new Promise(resolve => resolve(5))',
       },
@@ -211,7 +211,7 @@ describe('/chromium/screenshot API', function () {
     const metrics = new Metrics();
     await start({ config, metrics });
     const body = {
-      url: 'https://example.com',
+      url: 'https://one.one.one.one',
       waitForSelector: {
         selector: 'h1',
       },
@@ -235,7 +235,7 @@ describe('/chromium/screenshot API', function () {
     const metrics = new Metrics();
     await start({ config, metrics });
     const body = {
-      url: 'https://example.com',
+      url: 'https://one.one.one.one',
       waitForTimeout: 500,
     };
 
@@ -284,8 +284,8 @@ describe('/chromium/screenshot API', function () {
     const metrics = new Metrics();
     await start({ config, metrics });
     const body = {
-      cookies: [{ domain: 'example.com', name: 'foo', value: 'bar' }],
-      url: 'https://example.com',
+      cookies: [{ domain: 'one.one.one.one', name: 'foo', value: 'bar' }],
+      url: 'https://one.one.one.one',
     };
 
     await fetch('http://localhost:3000/chromium/screenshot?token=browserless', {
@@ -306,7 +306,7 @@ describe('/chromium/screenshot API', function () {
     const metrics = new Metrics();
     await start({ config, metrics });
     const body = {
-      url: 'https://example.com',
+      url: 'https://one.one.one.one',
     };
 
     await fetch(
@@ -332,7 +332,7 @@ describe('/chromium/screenshot API', function () {
     await start({ config, metrics });
 
     const body = {
-      url: 'https://example.com',
+      url: 'https://one.one.one.one',
     };
 
     await fetch('http://localhost:3000/chromium/screenshot?token=browserless', {
@@ -353,7 +353,7 @@ describe('/chromium/screenshot API', function () {
     await start({ config, metrics });
 
     const body = {
-      url: 'https://example.com',
+      url: 'https://one.one.one.one',
     };
 
     await fetch('http://localhost:3000/chromium/screenshot?token=browserless', {
@@ -370,7 +370,7 @@ describe('/chromium/screenshot API', function () {
   it('allows requests without token when auth token is not set', async () => {
     await start();
     const body = {
-      url: 'https://example.com',
+      url: 'https://one.one.one.one',
     };
 
     await fetch('http://localhost:3000/chromium/screenshot', {

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

@@ -28,7 +28,7 @@ describe('/edge/content API', function () {
     const metrics = new Metrics();
     await start({ config, metrics });
     const body = {
-      url: 'https://example.com',
+      url: 'https://one.one.one.one',
     };
 
     await fetch('http://localhost:3000/edge/content?token=browserless', {
@@ -98,7 +98,7 @@ describe('/edge/content API', function () {
     const metrics = new Metrics();
     await start({ config, metrics });
     const body = {
-      url: 'https://example.com',
+      url: 'https://one.one.one.one',
       waitForFunction: {
         fn: '() => 5 + 5',
       },
@@ -124,7 +124,7 @@ describe('/edge/content API', function () {
     const metrics = new Metrics();
     await start({ config, metrics });
     const body = {
-      url: 'https://example.com',
+      url: 'https://one.one.one.one',
       waitForFunction: {
         fn: 'async () => new Promise(resolve => resolve(5))',
       },
@@ -150,7 +150,7 @@ describe('/edge/content API', function () {
     const metrics = new Metrics();
     await start({ config, metrics });
     const body = {
-      url: 'https://example.com',
+      url: 'https://one.one.one.one',
       waitForSelector: {
         selector: 'h1',
       },
@@ -176,7 +176,7 @@ describe('/edge/content API', function () {
     const metrics = new Metrics();
     await start({ config, metrics });
     const body = {
-      url: 'https://example.com',
+      url: 'https://one.one.one.one',
       waitForTimeout: 500,
     };
 
@@ -229,8 +229,8 @@ describe('/edge/content API', function () {
     const metrics = new Metrics();
     await start({ config, metrics });
     const body = {
-      cookies: [{ domain: 'example.com', name: 'foo', value: 'bar' }],
-      url: 'https://example.com',
+      cookies: [{ domain: 'one.one.one.one', name: 'foo', value: 'bar' }],
+      url: 'https://one.one.one.one',
     };
 
     await fetch('http://localhost:3000/edge/content?token=browserless', {
@@ -253,7 +253,7 @@ describe('/edge/content API', function () {
     const metrics = new Metrics();
     await start({ config, metrics });
     const body = {
-      url: 'https://example.com',
+      url: 'https://one.one.one.one',
     };
 
     await fetch(
@@ -279,7 +279,7 @@ describe('/edge/content API', function () {
     await start({ config, metrics });
 
     const body = {
-      url: 'https://example.com',
+      url: 'https://one.one.one.one',
     };
 
     await fetch('http://localhost:3000/edge/content?token=browserless', {
@@ -312,7 +312,7 @@ describe('/edge/content API', function () {
           },
         },
       ],
-      url: 'https://example.com',
+      url: 'https://one.one.one.one',
     };
 
     await fetch('http://localhost:3000/edge/content?token=browserless', {
@@ -336,7 +336,7 @@ describe('/edge/content API', function () {
       gotoOptions: {
         waitUntil: `networkidle2`,
       },
-      url: 'https://example.com',
+      url: 'https://one.one.one.one',
     };
 
     await fetch('http://localhost:3000/edge/content?token=browserless', {
@@ -353,7 +353,7 @@ describe('/edge/content API', function () {
   it('allows requests without token when auth token is not set', async () => {
     await start();
     const body = {
-      url: 'https://example.com',
+      url: 'https://one.one.one.one',
     };
 
     await fetch('http://localhost:3000/edge/content', {

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

@@ -27,7 +27,7 @@ describe('WebSocket Page API', function () {
       browserWSEndpoint: `ws://localhost:3000/edge`,
     });
     const page = await browser.newPage();
-    await page.goto('https://example.com/');
+    await page.goto('https://one.one.one.one/');
     // @ts-ignore
     const pageId = page.target()._targetId;
     const webSocketDebuggerUrl = `ws://localhost:3000/devtools/page/${pageId}`;
@@ -78,7 +78,7 @@ describe('WebSocket Page API', function () {
       browserWSEndpoint: `ws://localhost:3000/edge?token=browserless`,
     });
     const page = await browser.newPage();
-    await page.goto('https://example.com/');
+    await page.goto('https://one.one.one.one/');
     // @ts-ignore
     const pageId = page.target()._targetId;
     const webSocketDebuggerUrl = `ws://localhost:3000/devtools/page/${pageId}`;
@@ -106,7 +106,7 @@ describe('WebSocket Page API', function () {
       browserWSEndpoint: `ws://localhost:3000/edge?token=browserless`,
     });
     const page = await browser.newPage();
-    await page.goto('https://example.com/');
+    await page.goto('https://one.one.one.one/');
     const webSocketDebuggerUrl = `ws://localhost:3000/devtools/page/im-a-banana`;
 
     // Connect to raw page target without authorization

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

@@ -22,7 +22,7 @@ describe('/edge/pdf API', function () {
     const metrics = new Metrics();
     await start({ config, metrics });
     const body = {
-      url: 'https://example.com',
+      url: 'https://one.one.one.one',
     };
 
     await fetch('http://localhost:3000/edge/pdf?token=browserless', {
@@ -64,7 +64,7 @@ describe('/edge/pdf API', function () {
     const metrics = new Metrics();
     await start({ config, metrics });
     const body = {
-      url: 'https://example.com',
+      url: 'https://one.one.one.one',
       waitForFunction: {
         fn: '() => 5 + 5',
       },
@@ -89,7 +89,7 @@ describe('/edge/pdf API', function () {
     const metrics = new Metrics();
     await start({ config, metrics });
     const body = {
-      url: 'https://example.com',
+      url: 'https://one.one.one.one',
       waitForFunction: {
         fn: 'async () => new Promise(resolve => resolve(5))',
       },
@@ -114,7 +114,7 @@ describe('/edge/pdf API', function () {
     const metrics = new Metrics();
     await start({ config, metrics });
     const body = {
-      url: 'https://example.com',
+      url: 'https://one.one.one.one',
       waitForSelector: {
         selector: 'h1',
       },
@@ -167,8 +167,8 @@ describe('/edge/pdf API', function () {
     const metrics = new Metrics();
     await start({ config, metrics });
     const body = {
-      cookies: [{ domain: 'example.com', name: 'foo', value: 'bar' }],
-      url: 'https://example.com',
+      cookies: [{ domain: 'one.one.one.one', name: 'foo', value: 'bar' }],
+      url: 'https://one.one.one.one',
     };
 
     await fetch('http://localhost:3000/edge/pdf?token=browserless', {
@@ -191,7 +191,7 @@ describe('/edge/pdf API', function () {
     await start({ config, metrics });
 
     const body = {
-      url: 'https://example.com',
+      url: 'https://one.one.one.one',
     };
 
     await fetch('http://localhost:3000/edge/pdf?token=browserless&timeout=10', {
@@ -215,7 +215,7 @@ describe('/edge/pdf API', function () {
     await start({ config, metrics });
 
     const body = {
-      url: 'https://example.com',
+      url: 'https://one.one.one.one',
     };
 
     await fetch('http://localhost:3000/edge/pdf?token=browserless', {
@@ -249,7 +249,7 @@ describe('/edge/pdf API', function () {
           },
         },
       ],
-      url: 'https://example.com',
+      url: 'https://one.one.one.one',
     };
 
     await fetch('http://localhost:3000/edge/pdf?token=browserless', {
@@ -274,7 +274,7 @@ describe('/edge/pdf API', function () {
       gotoOptions: {
         waitUntil: `networkidle2`,
       },
-      url: 'https://example.com',
+      url: 'https://one.one.one.one',
     };
 
     await fetch('http://localhost:3000/edge/pdf?token=browserless', {
@@ -321,7 +321,7 @@ describe('/edge/pdf API', function () {
       options: {
         landscape: true,
       },
-      url: 'https://example.com',
+      url: 'https://one.one.one.one',
     };
 
     await fetch('http://localhost:3000/edge/pdf?token=browserless', {
@@ -343,7 +343,7 @@ describe('/edge/pdf API', function () {
     const metrics = new Metrics();
     await start({ config, metrics });
     const body = {
-      url: 'https://example.com',
+      url: 'https://one.one.one.one',
       viewport: {
         deviceScaleFactor: 3,
         height: 100,
@@ -367,7 +367,7 @@ describe('/edge/pdf API', function () {
   it('allows requests without token when auth token is not set', async () => {
     await start();
     const body = {
-      url: 'https://example.com',
+      url: 'https://one.one.one.one',
     };
 
     await fetch('http://localhost:3000/edge/pdf', {

package/src/routes/edge/tests/performance.spec.ts

@@ -22,7 +22,7 @@ describe('/edge/performance API', function () {
     const metrics = new Metrics();
     await start({ config, metrics });
     const body = {
-      url: 'https://example.com',
+      url: 'https://one.one.one.one',
     };
 
     await fetch('http://localhost:3000/edge/performance?token=browserless', {
@@ -96,7 +96,7 @@ describe('/edge/performance API', function () {
     await start({ config, metrics });
 
     const body = {
-      url: 'https://example.com',
+      url: 'https://one.one.one.one',
     };
 
     await fetch('http://localhost:3000/edge/performance?token=browserless', {
@@ -119,7 +119,7 @@ describe('/edge/performance API', function () {
     await start({ config, metrics });
 
     const body = {
-      url: 'https://example.com',
+      url: 'https://one.one.one.one',
     };
 
     await fetch('http://localhost:3000/edge/performance?token=browserless', {
@@ -136,7 +136,7 @@ describe('/edge/performance API', function () {
   it('allows requests without token when auth token is not set', async () => {
     await start();
     const body = {
-      url: 'https://example.com',
+      url: 'https://one.one.one.one',
     };
 
     await fetch('http://localhost:3000/edge/performance', {

package/src/routes/edge/tests/scrape.spec.ts

@@ -27,7 +27,7 @@ describe('/edge/scrape API', function () {
           selector: 'a',
         },
       ],
-      url: 'https://example.com',
+      url: 'https://one.one.one.one',
     };
 
     await fetch('http://localhost:3000/edge/scrape?token=browserless', {
@@ -74,7 +74,7 @@ describe('/edge/scrape API', function () {
           selector: 'a',
         },
       ],
-      url: 'https://example.com',
+      url: 'https://one.one.one.one',
     };
 
     await fetch('http://localhost:3000/edge/scrape?token=browserless', {
@@ -107,7 +107,7 @@ describe('/edge/scrape API', function () {
           timeout: 1000,
         },
       ],
-      url: 'https://example.com',
+      url: 'https://one.one.one.one',
     };
 
     await fetch('http://localhost:3000/edge/scrape?token=browserless', {
@@ -133,7 +133,7 @@ describe('/edge/scrape API', function () {
           selector: 'a',
         },
       ],
-      url: 'https://example.com',
+      url: 'https://one.one.one.one',
       waitForFunction: {
         fn: '() => 5 + 5',
       },
@@ -164,7 +164,7 @@ describe('/edge/scrape API', function () {
           selector: 'a',
         },
       ],
-      url: 'https://example.com',
+      url: 'https://one.one.one.one',
       waitForFunction: {
         fn: 'async () => new Promise(resolve => resolve(5))',
       },
@@ -195,7 +195,7 @@ describe('/edge/scrape API', function () {
           selector: 'a',
         },
       ],
-      url: 'https://example.com',
+      url: 'https://one.one.one.one',
       waitForSelector: {
         selector: 'h1',
       },
@@ -226,7 +226,7 @@ describe('/edge/scrape API', function () {
           selector: 'a',
         },
       ],
-      url: 'https://example.com',
+      url: 'https://one.one.one.one',
       waitForTimeout: 500,
     };
 
@@ -285,13 +285,13 @@ describe('/edge/scrape API', function () {
     const metrics = new Metrics();
     await start({ config, metrics });
     const body = {
-      cookies: [{ domain: 'example.com', name: 'foo', value: 'bar' }],
+      cookies: [{ domain: 'one.one.one.one', name: 'foo', value: 'bar' }],
       elements: [
         {
           selector: 'a',
         },
       ],
-      url: 'https://example.com',
+      url: 'https://one.one.one.one',
     };
 
     await fetch('http://localhost:3000/edge/scrape?token=browserless', {
@@ -319,7 +319,7 @@ describe('/edge/scrape API', function () {
           selector: 'a',
         },
       ],
-      url: 'https://example.com',
+      url: 'https://one.one.one.one',
     };
 
     await fetch(
@@ -350,7 +350,7 @@ describe('/edge/scrape API', function () {
           selector: 'a',
         },
       ],
-      url: 'https://example.com',
+      url: 'https://one.one.one.one',
     };
 
     await fetch('http://localhost:3000/edge/scrape?token=browserless', {
@@ -376,7 +376,7 @@ describe('/edge/scrape API', function () {
           selector: 'a',
         },
       ],
-      url: 'https://example.com',
+      url: 'https://one.one.one.one',
     };
 
     await fetch('http://localhost:3000/edge/scrape?token=browserless', {
@@ -398,7 +398,7 @@ describe('/edge/scrape API', function () {
           selector: 'a',
         },
       ],
-      url: 'https://example.com',
+      url: 'https://one.one.one.one',
     };
 
     await fetch('http://localhost:3000/edge/scrape', {

package/src/routes/edge/tests/screenshot.spec.ts

@@ -22,7 +22,7 @@ describe('/edge/screenshot API', function () {
     const metrics = new Metrics();
     await start({ config, metrics });
     const body = {
-      url: 'https://example.com',
+      url: 'https://one.one.one.one',
     };
 
     await fetch('http://localhost:3000/edge/screenshot?token=browserless', {
@@ -59,7 +59,7 @@ describe('/edge/screenshot API', function () {
     const metrics = new Metrics();
     await start({ config, metrics });
     const body = {
-      url: 'https://example.com',
+      url: 'https://one.one.one.one',
       viewport: {
         deviceScaleFactor: 3,
         height: 100,
@@ -86,7 +86,7 @@ describe('/edge/screenshot API', function () {
     await start({ config, metrics });
     const body = {
       selector: 'h1',
-      url: 'https://example.com',
+      url: 'https://one.one.one.one',
     };
 
     await fetch('http://localhost:3000/edge/screenshot?token=browserless', {
@@ -142,7 +142,7 @@ describe('/edge/screenshot API', function () {
           },
         },
       ],
-      url: 'https://example.com',
+      url: 'https://one.one.one.one',
     };
 
     await fetch('http://localhost:3000/edge/screenshot?token=browserless', {
@@ -163,7 +163,7 @@ describe('/edge/screenshot API', function () {
     const metrics = new Metrics();
     await start({ config, metrics });
     const body = {
-      url: 'https://example.com',
+      url: 'https://one.one.one.one',
       waitForFunction: {
         fn: '() => 5 + 5',
       },
@@ -187,7 +187,7 @@ describe('/edge/screenshot API', function () {
     const metrics = new Metrics();
     await start({ config, metrics });
     const body = {
-      url: 'https://example.com',
+      url: 'https://one.one.one.one',
       waitForFunction: {
         fn: 'async () => new Promise(resolve => resolve(5))',
       },
@@ -211,7 +211,7 @@ describe('/edge/screenshot API', function () {
     const metrics = new Metrics();
     await start({ config, metrics });
     const body = {
-      url: 'https://example.com',
+      url: 'https://one.one.one.one',
       waitForSelector: {
         selector: 'h1',
       },
@@ -235,7 +235,7 @@ describe('/edge/screenshot API', function () {
     const metrics = new Metrics();
     await start({ config, metrics });
     const body = {
-      url: 'https://example.com',
+      url: 'https://one.one.one.one',
       waitForTimeout: 500,
     };
 
@@ -284,8 +284,8 @@ describe('/edge/screenshot API', function () {
     const metrics = new Metrics();
     await start({ config, metrics });
     const body = {
-      cookies: [{ domain: 'example.com', name: 'foo', value: 'bar' }],
-      url: 'https://example.com',
+      cookies: [{ domain: 'one.one.one.one', name: 'foo', value: 'bar' }],
+      url: 'https://one.one.one.one',
     };
 
     await fetch('http://localhost:3000/edge/screenshot?token=browserless', {
@@ -306,7 +306,7 @@ describe('/edge/screenshot API', function () {
     const metrics = new Metrics();
     await start({ config, metrics });
     const body = {
-      url: 'https://example.com',
+      url: 'https://one.one.one.one',
     };
 
     await fetch(
@@ -332,7 +332,7 @@ describe('/edge/screenshot API', function () {
     await start({ config, metrics });
 
     const body = {
-      url: 'https://example.com',
+      url: 'https://one.one.one.one',
     };
 
     await fetch('http://localhost:3000/edge/screenshot?token=browserless', {
@@ -353,7 +353,7 @@ describe('/edge/screenshot API', function () {
     await start({ config, metrics });
 
     const body = {
-      url: 'https://example.com',
+      url: 'https://one.one.one.one',
     };
 
     await fetch('http://localhost:3000/edge/screenshot?token=browserless', {
@@ -370,7 +370,7 @@ describe('/edge/screenshot API', function () {
   it('allows requests without token when auth token is not set', async () => {
     await start();
     const body = {
-      url: 'https://example.com',
+      url: 'https://one.one.one.one',
     };
 
     await fetch('http://localhost:3000/edge/screenshot', {

package/src/routes/management/http/kill.get.ts

@@ -14,7 +14,7 @@ import { ServerResponse } from 'http';
 export type ResponseSchema = string;
 
 export interface QuerySchema extends SystemQueryParameters {
-  token: string;
+  token?: string;
   browserId?: string;
   trackingId?: string;
 }

package/src/routes/management/http/pressure.get.ts

@@ -6,7 +6,9 @@ import {
   Methods,
   Request,
   contentTypes,
+  dedent,
   jsonResponse,
+  writeResponse,
 } from '@browserless.io/browserless';
 import { ServerResponse } from 'http';
 
@@ -76,12 +78,17 @@ export default class PressureGetRoute extends HTTPRoute {
   auth = true;
   browser = null;
   concurrency = false;
-  contentTypes = [contentTypes.json];
-  description = `Returns a JSON body of stats related to the pressure being created on the instance.`;
+  contentTypes = [contentTypes.json, contentTypes.text];
+  description =
+    dedent(`Returns a JSON body of stats related to the pressure being exerted on the instance. This route is dynamic based upon the supplied "Accept" header, and will either return a human-readable message if the "Accept" header is set to "text/plain", or the default JSON body and a 200 HTTP code.
+
+    When Accept is set to "text/plain" a human-readable message is sent back describing the state of the container, and either a "200" code (indicating "ok") or a "503" code (indicating that the service is unavailable due to load).
+
+    If the "Accept" header is set to anything else it will return a JSON body with the same information.`);
   method = Methods.get;
   path = HTTPManagementRoutes.pressure;
   tags = [APITags.management];
-  async handler(_req: Request, res: ServerResponse): Promise<void> {
+  async handler(req: Request, res: ServerResponse): Promise<void> {
     const monitoring = this.monitoring();
     const config = this.config();
     const limiter = this.limiter();
@@ -134,6 +141,11 @@ export default class PressureGetRoute extends HTTPRoute {
       },
     };
 
+    if (req.headers.accept === contentTypes.text) {
+      const code = response.pressure.isAvailable ? 200 : 503;
+      return writeResponse(res, code, message);
+    }
+
     return jsonResponse(res, 200, response);
   }
 }

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

@@ -13,7 +13,7 @@ import {
 import { ServerResponse } from 'http';
 
 export interface QuerySchema extends SystemQueryParameters {
-  token: string;
+  token?: string;
   trackingId?: string;
 }