@browserless.io/browserless 2.33.0 → 2.34.0-beta-0

package/build/routes/edge/tests/content.spec.js

@@ -16,7 +16,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', {
             body: JSON.stringify(body),
@@ -75,7 +75,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',
             },
@@ -97,7 +97,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))',
             },
@@ -119,7 +119,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',
             },
@@ -141,7 +141,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,
         };
         await fetch('http://localhost:3000/edge/content?token=browserless', {
@@ -186,8 +186,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', {
             body: JSON.stringify(body),
@@ -206,7 +206,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&timeout=10', {
             body: JSON.stringify(body),
@@ -226,7 +226,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', {
             body: JSON.stringify(body),
@@ -256,7 +256,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', {
             body: JSON.stringify(body),
@@ -277,7 +277,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', {
             body: JSON.stringify(body),
@@ -292,7 +292,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', {
             body: JSON.stringify(body),

package/build/routes/edge/tests/page-websocket.spec.js

@@ -19,7 +19,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}`;
@@ -53,7 +53,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}`;
@@ -77,7 +77,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
         try {

package/build/routes/edge/tests/pdf.spec.js

@@ -15,7 +15,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', {
             body: JSON.stringify(body),
@@ -49,7 +49,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',
             },
@@ -72,7 +72,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))',
             },
@@ -95,7 +95,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',
             },
@@ -144,8 +144,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', {
             body: JSON.stringify(body),
@@ -165,7 +165,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&timeout=10', {
             body: JSON.stringify(body),
@@ -185,7 +185,7 @@ describe('/edge/pdf API', function () {
         config.setToken('browserless');
         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', {
             body: JSON.stringify(body),
@@ -216,7 +216,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', {
             body: JSON.stringify(body),
@@ -239,7 +239,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', {
             body: JSON.stringify(body),
@@ -282,7 +282,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', {
             body: JSON.stringify(body),
@@ -302,7 +302,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,
@@ -324,7 +324,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', {
             body: JSON.stringify(body),

package/build/routes/edge/tests/performance.spec.js

@@ -15,7 +15,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', {
             body: JSON.stringify(body),
@@ -73,7 +73,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', {
             body: JSON.stringify(body),
@@ -93,7 +93,7 @@ describe('/edge/performance API', function () {
         config.setToken('browserless');
         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', {
             body: JSON.stringify(body),
@@ -108,7 +108,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', {
             body: JSON.stringify(body),

package/build/routes/edge/tests/scrape.spec.js

@@ -20,7 +20,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', {
             body: JSON.stringify(body),
@@ -57,7 +57,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', {
             body: JSON.stringify(body),
@@ -85,7 +85,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', {
             body: JSON.stringify(body),
@@ -109,7 +109,7 @@ describe('/edge/scrape API', function () {
                     selector: 'a',
                 },
             ],
-            url: 'https://example.com',
+            url: 'https://one.one.one.one',
             waitForFunction: {
                 fn: '() => 5 + 5',
             },
@@ -136,7 +136,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))',
             },
@@ -163,7 +163,7 @@ describe('/edge/scrape API', function () {
                     selector: 'a',
                 },
             ],
-            url: 'https://example.com',
+            url: 'https://one.one.one.one',
             waitForSelector: {
                 selector: 'h1',
             },
@@ -190,7 +190,7 @@ describe('/edge/scrape API', function () {
                     selector: 'a',
                 },
             ],
-            url: 'https://example.com',
+            url: 'https://one.one.one.one',
             waitForTimeout: 500,
         };
         await fetch('http://localhost:3000/edge/scrape?token=browserless', {
@@ -240,13 +240,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', {
             body: JSON.stringify(body),
@@ -270,7 +270,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&timeout=10', {
             body: JSON.stringify(body),
@@ -295,7 +295,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', {
             body: JSON.stringify(body),
@@ -318,7 +318,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', {
             body: JSON.stringify(body),
@@ -338,7 +338,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', {
             body: JSON.stringify(body),

package/build/routes/edge/tests/screenshot.spec.js

@@ -15,7 +15,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', {
             body: JSON.stringify(body),
@@ -44,7 +44,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,
@@ -69,7 +69,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', {
             body: JSON.stringify(body),
@@ -120,7 +120,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', {
             body: JSON.stringify(body),
@@ -139,7 +139,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',
             },
@@ -161,7 +161,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))',
             },
@@ -183,7 +183,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',
             },
@@ -205,7 +205,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,
         };
         await fetch('http://localhost:3000/edge/screenshot?token=browserless', {
@@ -250,8 +250,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', {
             body: JSON.stringify(body),
@@ -270,7 +270,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&timeout=10', {
             body: JSON.stringify(body),
@@ -290,7 +290,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', {
             body: JSON.stringify(body),
@@ -308,7 +308,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', {
             body: JSON.stringify(body),
@@ -323,7 +323,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', {
             body: JSON.stringify(body),

package/build/routes/management/http/kill.get.d.ts

@@ -2,7 +2,7 @@ import { APITags, HTTPManagementRoutes, HTTPRoute, Methods, Request, SystemQuery
 import { ServerResponse } from 'http';
 export type ResponseSchema = string;
 export interface QuerySchema extends SystemQueryParameters {
-    token: string;
+    token?: string;
     browserId?: string;
     trackingId?: string;
 }

package/build/routes/management/http/kill.get.query.json

@@ -36,9 +36,6 @@
     }
   },
   "additionalProperties": false,
-  "required": [
-    "token"
-  ],
   "definitions": {
     "CDPLaunchOptions": {
       "type": "object",

package/build/routes/management/http/pressure.get.d.ts

@@ -60,5 +60,5 @@ export default class PressureGetRoute extends HTTPRoute {
     method: Methods;
     path: HTTPManagementRoutes;
     tags: APITags[];
-    handler(_req: Request, res: ServerResponse): Promise<void>;
+    handler(req: Request, res: ServerResponse): Promise<void>;
 }

package/build/routes/management/http/pressure.get.js

@@ -1,16 +1,20 @@
-import { APITags, BrowserlessRoutes, HTTPManagementRoutes, HTTPRoute, Methods, contentTypes, jsonResponse, } from '@browserless.io/browserless';
+import { APITags, BrowserlessRoutes, HTTPManagementRoutes, HTTPRoute, Methods, contentTypes, dedent, jsonResponse, writeResponse, } from '@browserless.io/browserless';
 export default class PressureGetRoute extends HTTPRoute {
     name = BrowserlessRoutes.PressureGetRoute;
     accepts = [contentTypes.any];
     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, res) {
+    async handler(req, res) {
         const monitoring = this.monitoring();
         const config = this.config();
         const limiter = this.limiter();
@@ -53,6 +57,10 @@ export default class PressureGetRoute extends HTTPRoute {
                 running,
             },
         };
+        if (req.headers.accept === contentTypes.text) {
+            const code = response.pressure.isAvailable ? 200 : 503;
+            return writeResponse(res, code, message);
+        }
         return jsonResponse(res, 200, response);
     }
 }

package/build/routes/management/http/sessions.get.d.ts

@@ -1,7 +1,7 @@
 import { APITags, BrowserlessSessionJSON, HTTPManagementRoutes, HTTPRoute, Methods, Request, SystemQueryParameters, contentTypes } from '@browserless.io/browserless';
 import { ServerResponse } from 'http';
 export interface QuerySchema extends SystemQueryParameters {
-    token: string;
+    token?: string;
     trackingId?: string;
 }
 export type ResponseSchema = BrowserlessSessionJSON[];

package/build/routes/management/http/sessions.get.query.json

@@ -33,9 +33,6 @@
     }
   },
   "additionalProperties": false,
-  "required": [
-    "token"
-  ],
   "definitions": {
     "CDPLaunchOptions": {
       "type": "object",