@browserless.io/browserless 2.2.0 → 2.3.0-beta-1

package/build/routes/management/http/config.get.response.json

@@ -1,107 +1,4 @@
 {
-  "type": "object",
-  "properties": {
-    "allowCORS": {
-      "type": "boolean"
-    },
-    "allowFileProtocol": {
-      "type": "boolean"
-    },
-    "allowGetCalls": {
-      "type": "boolean"
-    },
-    "concurrent": {
-      "type": "number"
-    },
-    "data": {
-      "type": "string"
-    },
-    "debug": {
-      "type": "string"
-    },
-    "errorAlertURL": {
-      "type": [
-        "null",
-        "string"
-      ]
-    },
-    "healthFailureURL": {
-      "type": [
-        "null",
-        "string"
-      ]
-    },
-    "host": {
-      "type": "string"
-    },
-    "maxCPU": {
-      "type": "number"
-    },
-    "maxMemory": {
-      "type": "number"
-    },
-    "metricsJSONPath": {
-      "type": "string"
-    },
-    "port": {
-      "type": "number"
-    },
-    "queued": {
-      "type": "number"
-    },
-    "queuedAlertURL": {
-      "type": [
-        "null",
-        "string"
-      ]
-    },
-    "rejectAlertURL": {
-      "type": [
-        "null",
-        "string"
-      ]
-    },
-    "retries": {
-      "type": "number"
-    },
-    "timeout": {
-      "type": "number"
-    },
-    "timeoutAlertURL": {
-      "type": [
-        "null",
-        "string"
-      ]
-    },
-    "token": {
-      "type": [
-        "null",
-        "string"
-      ]
-    }
-  },
-  "additionalProperties": false,
-  "required": [
-    "allowCORS",
-    "allowFileProtocol",
-    "allowGetCalls",
-    "concurrent",
-    "data",
-    "debug",
-    "errorAlertURL",
-    "healthFailureURL",
-    "host",
-    "maxCPU",
-    "maxMemory",
-    "metricsJSONPath",
-    "port",
-    "queued",
-    "queuedAlertURL",
-    "rejectAlertURL",
-    "retries",
-    "timeout",
-    "timeoutAlertURL",
-    "token"
-  ],
+  "type": "string",
   "$schema": "http://json-schema.org/draft-07/schema#"
 }

package/build/routes/management/http/metrics-total.get.response.json

@@ -1,72 +1,4 @@
 {
-  "type": "object",
-  "properties": {
-    "error": {
-      "type": "number"
-    },
-    "estimatedMonthlyUnits": {
-      "type": "number"
-    },
-    "maxConcurrent": {
-      "type": "number"
-    },
-    "maxTime": {
-      "type": "number"
-    },
-    "meanTime": {
-      "type": "number"
-    },
-    "minTime": {
-      "type": "number"
-    },
-    "minutesOfMetricsAvailable": {
-      "type": "number"
-    },
-    "queued": {
-      "type": "number"
-    },
-    "rejected": {
-      "type": "number"
-    },
-    "sessionTimes": {
-      "type": "array",
-      "items": {
-        "type": "number"
-      }
-    },
-    "successful": {
-      "type": "number"
-    },
-    "timedout": {
-      "type": "number"
-    },
-    "totalTime": {
-      "type": "number"
-    },
-    "unhealthy": {
-      "type": "number"
-    },
-    "units": {
-      "type": "number"
-    }
-  },
-  "additionalProperties": false,
-  "required": [
-    "error",
-    "estimatedMonthlyUnits",
-    "maxConcurrent",
-    "maxTime",
-    "meanTime",
-    "minTime",
-    "minutesOfMetricsAvailable",
-    "queued",
-    "rejected",
-    "sessionTimes",
-    "successful",
-    "timedout",
-    "totalTime",
-    "unhealthy",
-    "units"
-  ],
+  "type": "string",
   "$schema": "http://json-schema.org/draft-07/schema#"
 }

package/build/routes/management/http/metrics.get.response.json

@@ -1,94 +1,4 @@
 {
-  "type": "array",
-  "items": {
-    "$ref": "#/definitions/IBrowserlessStats"
-  },
-  "definitions": {
-    "IBrowserlessStats": {
-      "type": "object",
-      "properties": {
-        "cpu": {
-          "type": [
-            "null",
-            "number"
-          ]
-        },
-        "date": {
-          "type": "number"
-        },
-        "error": {
-          "type": "number"
-        },
-        "maxConcurrent": {
-          "type": "number"
-        },
-        "maxTime": {
-          "type": "number"
-        },
-        "meanTime": {
-          "type": "number"
-        },
-        "memory": {
-          "type": [
-            "null",
-            "number"
-          ]
-        },
-        "minTime": {
-          "type": "number"
-        },
-        "queued": {
-          "type": "number"
-        },
-        "rejected": {
-          "type": "number"
-        },
-        "sessionTimes": {
-          "type": "array",
-          "items": {
-            "type": "number"
-          }
-        },
-        "successful": {
-          "type": "number"
-        },
-        "timedout": {
-          "type": "number"
-        },
-        "totalTime": {
-          "type": "number"
-        },
-        "unauthorized": {
-          "type": "number"
-        },
-        "unhealthy": {
-          "type": "number"
-        },
-        "units": {
-          "type": "number"
-        }
-      },
-      "additionalProperties": false,
-      "required": [
-        "cpu",
-        "date",
-        "error",
-        "maxConcurrent",
-        "maxTime",
-        "meanTime",
-        "memory",
-        "minTime",
-        "queued",
-        "rejected",
-        "sessionTimes",
-        "successful",
-        "timedout",
-        "totalTime",
-        "unauthorized",
-        "unhealthy",
-        "units"
-      ]
-    }
-  },
+  "type": "string",
   "$schema": "http://json-schema.org/draft-07/schema#"
 }

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

@@ -1,235 +1,4 @@
 {
-  "type": "array",
-  "items": {
-    "$ref": "#/definitions/BrowserlessSessionJSON"
-  },
-  "definitions": {
-    "BrowserlessSessionJSON": {
-      "type": "object",
-      "properties": {
-        "browser": {
-          "type": "string"
-        },
-        "browserId": {
-          "type": "string"
-        },
-        "id": {
-          "type": [
-            "null",
-            "string"
-          ]
-        },
-        "initialConnectURL": {
-          "type": "string"
-        },
-        "killURL": {
-          "type": [
-            "null",
-            "string"
-          ]
-        },
-        "launchOptions": {
-          "anyOf": [
-            {
-              "$ref": "#/definitions/CDPLaunchOptions"
-            },
-            {
-              "$ref": "#/definitions/BrowserServerOptions"
-            }
-          ]
-        },
-        "numbConnected": {
-          "type": "number"
-        },
-        "routePath": {
-          "anyOf": [
-            {
-              "type": "array",
-              "items": {
-                "type": "string"
-              }
-            },
-            {
-              "type": "string"
-            }
-          ]
-        },
-        "startedOn": {
-          "type": "number"
-        },
-        "timeAliveMs": {
-          "type": "number"
-        },
-        "userDataDir": {
-          "type": [
-            "null",
-            "string"
-          ]
-        }
-      },
-      "additionalProperties": false,
-      "required": [
-        "browser",
-        "browserId",
-        "id",
-        "initialConnectURL",
-        "killURL",
-        "launchOptions",
-        "numbConnected",
-        "routePath",
-        "startedOn",
-        "timeAliveMs",
-        "userDataDir"
-      ]
-    },
-    "CDPLaunchOptions": {
-      "type": "object",
-      "properties": {
-        "args": {
-          "type": "array",
-          "items": {
-            "type": "string"
-          }
-        },
-        "defaultViewport": {
-          "type": "object",
-          "properties": {
-            "deviceScaleFactor": {
-              "type": "number"
-            },
-            "hasTouch": {
-              "type": "boolean"
-            },
-            "height": {
-              "type": "number"
-            },
-            "isLandscape": {
-              "type": "boolean"
-            },
-            "isMobile": {
-              "type": "boolean"
-            },
-            "width": {
-              "type": "number"
-            }
-          },
-          "additionalProperties": false,
-          "required": [
-            "height",
-            "width"
-          ]
-        },
-        "devtools": {
-          "type": "boolean"
-        },
-        "dumpio": {
-          "type": "boolean"
-        },
-        "headless": {
-          "enum": [
-            false,
-            "shell",
-            true
-          ]
-        },
-        "ignoreDefaultArgs": {
-          "anyOf": [
-            {
-              "type": "array",
-              "items": {
-                "type": "string"
-              }
-            },
-            {
-              "type": "boolean"
-            }
-          ]
-        },
-        "ignoreHTTPSErrors": {
-          "type": "boolean"
-        },
-        "slowMo": {
-          "type": "number"
-        },
-        "stealth": {
-          "type": "boolean"
-        },
-        "timeout": {
-          "type": "number"
-        },
-        "userDataDir": {
-          "type": "string"
-        },
-        "waitForInitialPage": {
-          "type": "boolean"
-        }
-      },
-      "additionalProperties": false
-    },
-    "BrowserServerOptions": {
-      "type": "object",
-      "properties": {
-        "args": {
-          "type": "array",
-          "items": {
-            "type": "string"
-          }
-        },
-        "chromiumSandbox": {
-          "type": "boolean"
-        },
-        "devtools": {
-          "type": "boolean"
-        },
-        "downloadsPath": {
-          "type": "string"
-        },
-        "headless": {
-          "type": "boolean"
-        },
-        "ignoreDefaultArgs": {
-          "anyOf": [
-            {
-              "type": "array",
-              "items": {
-                "type": "string"
-              }
-            },
-            {
-              "type": "boolean"
-            }
-          ]
-        },
-        "proxy": {
-          "type": "object",
-          "properties": {
-            "bypass": {
-              "type": "string"
-            },
-            "password": {
-              "type": "string"
-            },
-            "server": {
-              "type": "string"
-            },
-            "username": {
-              "type": "string"
-            }
-          },
-          "additionalProperties": false,
-          "required": [
-            "server"
-          ]
-        },
-        "timeout": {
-          "type": "number"
-        },
-        "tracesDir": {
-          "type": "string"
-        }
-      },
-      "additionalProperties": false
-    }
-  },
+  "type": "string",
   "$schema": "http://json-schema.org/draft-07/schema#"
 }

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

@@ -1,12 +1,10 @@
-import { APITags, HTTPManagementRoutes, HTTPRoute, Methods, NotFound, contentTypes, createLogger, fileExists, mimeTypes, } from '@browserless.io/browserless';
+import { APITags, HTTPManagementRoutes, HTTPRoute, Methods, NotFound, contentTypes, fileExists, mimeTypes, } from '@browserless.io/browserless';
 import { createReadStream } from 'fs';
 import path from 'path';
-const debug = createLogger('http:static');
-const verbose = createLogger('http:static:verbose');
 const pathMap = new Map();
-const streamFile = (res, file, contentType) => new Promise((resolve, reject) => {
+const streamFile = (debug, res, file, contentType) => new Promise((resolve, reject) => {
     if (contentType) {
-        verbose(`Setting content-type ${contentType}`);
+        debug(`Setting content-type ${contentType}`);
         res.setHeader('Content-Type', contentType);
     }
     return createReadStream(file)
@@ -33,8 +31,10 @@ export default class StaticGetRoute extends HTTPRoute {
     handler = async (req, res) => {
         const { pathname } = req.parsed;
         const fileCache = pathMap.get(pathname);
+        const debug = this.debug();
+        const verbose = debug.extend('verbose');
         if (fileCache) {
-            return streamFile(res, fileCache.path, fileCache.contentType);
+            return streamFile(verbose, res, fileCache.path, fileCache.contentType);
         }
         const config = this.config();
         const file = path.join(config.getStatic(), pathname);
@@ -57,6 +57,6 @@ export default class StaticGetRoute extends HTTPRoute {
             contentType,
             path: filePath,
         });
-        return streamFile(res, filePath, contentType);
+        return streamFile(verbose, res, filePath, contentType);
     };
 }

package/build/routes/webkit/ws/playwright.query.json

@@ -1,21 +1,21 @@
 {
+  "additionalProperties": false,
   "type": "object",
   "properties": {
+    "blockAds": {
+      "description": "Whether or nor to load ad-blocking extensions for the session.\nThis currently uses uBlock Origin and may cause certain sites\nto not load properly.",
+      "type": "boolean"
+    },
     "launch": {
-      "description": "Launch options, which can be either an object\nof puppeteer.launch options or playwright.launchServer\noptions, depending on the API. Must be either JSON\nobject, or a base64-encoded JSON object.",
       "anyOf": [
         {
-          "$ref": "#/definitions/BrowserServerOptions"
+          "$ref": "#/definitions/CDPLaunchOptions"
         },
         {
           "type": "string"
         }
       ]
     },
-    "blockAds": {
-      "description": "Whether or nor to load ad-blocking extensions for the session.\nThis currently uses uBlock Origin and may cause certain sites\nto not load properly.",
-      "type": "boolean"
-    },
     "record": {
       "description": "Whether or nor to record the session. The browser will run\nin \"head-full\" mode, and recording is started and closed\nvia the embedded browserless API. Please refer to the \"Recording\"\nsection in the live documentation site for more details.",
       "type": "boolean"
@@ -29,8 +29,91 @@
       "type": "string"
     }
   },
-  "additionalProperties": false,
   "definitions": {
+    "CDPLaunchOptions": {
+      "type": "object",
+      "properties": {
+        "args": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "defaultViewport": {
+          "type": "object",
+          "properties": {
+            "deviceScaleFactor": {
+              "type": "number"
+            },
+            "hasTouch": {
+              "type": "boolean"
+            },
+            "height": {
+              "type": "number"
+            },
+            "isLandscape": {
+              "type": "boolean"
+            },
+            "isMobile": {
+              "type": "boolean"
+            },
+            "width": {
+              "type": "number"
+            }
+          },
+          "additionalProperties": false,
+          "required": [
+            "height",
+            "width"
+          ]
+        },
+        "devtools": {
+          "type": "boolean"
+        },
+        "dumpio": {
+          "type": "boolean"
+        },
+        "headless": {
+          "enum": [
+            false,
+            "shell",
+            true
+          ]
+        },
+        "ignoreDefaultArgs": {
+          "anyOf": [
+            {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            },
+            {
+              "type": "boolean"
+            }
+          ]
+        },
+        "ignoreHTTPSErrors": {
+          "type": "boolean"
+        },
+        "slowMo": {
+          "type": "number"
+        },
+        "stealth": {
+          "type": "boolean"
+        },
+        "timeout": {
+          "type": "number"
+        },
+        "userDataDir": {
+          "type": "string"
+        },
+        "waitForInitialPage": {
+          "type": "boolean"
+        }
+      },
+      "additionalProperties": false
+    },
     "BrowserServerOptions": {
       "type": "object",
       "properties": {

package/build/shared/utils/performance/main.js

@@ -4,9 +4,9 @@ import path from 'path';
 const DEFAULT_AUDIT_CONFIG = {
     extends: 'lighthouse:default',
 };
-const debug = createLogger('http:performance:main');
 export default async ({ browser, context, timeout, }) => {
     return new Promise((resolve, reject) => {
+        const debug = createLogger('http:performance:main');
         const childPath = path.join('./', 'build', 'shared', 'utils', 'performance', 'child.js');
         debug(`Starting up child at ${childPath}`);
         const child = fork(childPath);

package/docker/chrome/Dockerfile

@@ -4,6 +4,8 @@ LABEL org.opencontainers.image.source https://github.com/browserless/browserless
 
 COPY fonts/* /usr/share/fonts/truetype/
 COPY src src/
+# Only use core as exports since routes are lazy loaded and not always present
+COPY src/exports.core.ts src/exports.ts
 RUN rm -r src/routes/
 COPY src/routes/management src/routes/management/
 COPY src/routes/chrome src/routes/chrome/

package/docker/chromium/Dockerfile

@@ -4,6 +4,8 @@ LABEL org.opencontainers.image.source https://github.com/browserless/browserless
 
 COPY fonts/* /usr/share/fonts/truetype/
 COPY src src/
+# Only use core as exports since routes are lazy loaded and not always present
+COPY src/exports.core.ts src/exports.ts
 RUN rm -r src/routes/
 COPY src/routes/management src/routes/management/
 COPY src/routes/chromium src/routes/chromium/