@browserless.io/browserless 2.4.0 → 2.5.0-beta-2

package/src/limiter.ts

@@ -1,11 +1,11 @@
 import {
   AfterResponse,
   Config,
+  Hooks,
   Metrics,
   Monitoring,
   TooManyRequests,
   WebHooks,
-  afterRequest,
   createLogger,
 } from '@browserless.io/browserless';
 import q from 'queue';
@@ -33,13 +33,13 @@ export class Limiter extends q {
     protected metrics: Metrics,
     protected monitor: Monitoring,
     protected webhooks: WebHooks,
+    protected hooks: Hooks,
   ) {
     super({
       autostart: true,
       concurrency: config.getConcurrent(),
       timeout: config.getTimeout(),
     });
-
     this.queued = config.getQueued();
 
     this.debug(
@@ -78,7 +78,7 @@ export class Limiter extends q {
   }
 
   protected jobEnd(jobInfo: AfterResponse) {
-    afterRequest(jobInfo);
+    this.hooks.after(jobInfo);
   }
 
   protected handleSuccess({ detail: { job } }: { detail: { job: Job } }) {

package/src/routes/management/http/metrics-total.get.ts

@@ -29,9 +29,9 @@ export default class MetricsTotalGetRoute extends HTTPRoute {
   handler = async (_req: Request, res: ServerResponse): Promise<void> => {
     const fileSystem = this.fileSystem();
     const config = this.config();
-    const metrics = (await fileSystem.read(config.getMetricsJSONPath())).map(
-      (m) => JSON.parse(m),
-    );
+    const metrics = (
+      await fileSystem.read(config.getMetricsJSONPath(), false)
+    ).map((m) => JSON.parse(m));
     const availableMetrics = metrics.length;
     const totals: IBrowserlessMetricTotals = metrics.reduce(
       (accum, metric) => ({

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

@@ -20,7 +20,7 @@ export default class MetricsGetRoute extends HTTPRoute {
   browser = null;
   concurrency = false;
   contentTypes = [contentTypes.json];
-  description = `Gets total metric details from the time the server started.`;
+  description = `Returns a list of metric details as far back as possible.`;
   method = Methods.get;
   path = HTTPManagementRoutes.metrics;
   tags = [APITags.management];
@@ -28,7 +28,7 @@ export default class MetricsGetRoute extends HTTPRoute {
     const fileSystem = this.fileSystem();
     const config = this.config();
 
-    const stats = await fileSystem.read(config.getMetricsJSONPath());
+    const stats = await fileSystem.read(config.getMetricsJSONPath(), false);
     const response = `[${stats.join(',')}]`;
 
     return writeResponse(res, 200, response, contentTypes.json);

package/src/sdk-utils.ts

@@ -0,0 +1,136 @@
+import { createInterface } from 'readline';
+import debug from 'debug';
+import fs from 'fs/promises';
+import path from 'path';
+import { spawn } from 'child_process';
+
+export const getArgSwitches = () => {
+  return process.argv.reduce(
+    (accum, arg, idx) => {
+      if (!arg.startsWith('--')) {
+        return accum;
+      }
+
+      if (arg.includes('=')) {
+        const [parameter, value] = arg.split('=');
+        accum[parameter.replace(/-/gi, '')] = value || true;
+        return accum;
+      }
+
+      const nextSwitchOrParameter = process.argv[idx + 1];
+      const param = arg.replace(/-/gi, '');
+
+      if (
+        typeof nextSwitchOrParameter === 'undefined' ||
+        nextSwitchOrParameter?.startsWith('--')
+      ) {
+        accum[param] = true;
+        return accum;
+      }
+
+      accum[param] = nextSwitchOrParameter;
+
+      return accum;
+    },
+    {} as { [key: string]: string | true },
+  );
+};
+
+export const getSourceFiles = async (cwd: string) => {
+  const buildDir = path.join(cwd, 'build');
+  const files = await fs.readdir(buildDir, { recursive: true });
+  const [httpRoutes, webSocketRoutes] = files.reduce(
+    ([httpRoutes, webSocketRoutes], file) => {
+      const parsed = path.parse(file);
+      if (parsed.name.endsWith('http')) {
+        httpRoutes.push(path.join(buildDir, file));
+      }
+
+      if (parsed.name.endsWith('ws')) {
+        webSocketRoutes.push(path.join(buildDir, file));
+      }
+
+      return [httpRoutes, webSocketRoutes];
+    },
+    [[] as string[], [] as string[]],
+  );
+
+  return {
+    files,
+    httpRoutes,
+    webSocketRoutes,
+  };
+};
+
+export const camelCase = (str: string) =>
+  str.replace(/-([a-z])/g, (_, w) => w.toUpperCase());
+
+export const prompt = async (question: string) => {
+  const promptLog = debug('browserless.io:prompt');
+  const rl = createInterface({
+    input: process.stdin,
+    output: process.stdout,
+  });
+
+  return new Promise((resolve) => {
+    promptLog(question);
+    rl.question('  > ', (a) => {
+      rl.close();
+      resolve(a.trim());
+    });
+  });
+};
+
+export const installDependencies = async (
+  workingDirectory: string,
+): Promise<void> =>
+  new Promise((resolve, reject) => {
+    spawn('npm', ['i'], {
+      cwd: workingDirectory,
+      stdio: 'inherit',
+    }).once('close', (code) => {
+      if (code === 0) {
+        return resolve();
+      }
+      return reject(
+        `Error when installing dependencies, see output for more details`,
+      );
+    });
+  });
+
+export const buildDockerImage = async (
+  cmd: string,
+  projectDir: string,
+): Promise<void> =>
+  new Promise((resolve, reject) => {
+    const [docker, ...args] = cmd.split(' ');
+    spawn(docker, args, {
+      cwd: projectDir,
+      stdio: 'inherit',
+    }).once('close', (code) => {
+      if (code === 0) {
+        return resolve();
+      }
+      return reject(
+        `Error when building Docker image, see output for more details`,
+      );
+    });
+  });
+
+export const buildTypeScript = async (
+  buildDir: string,
+  projectDir: string,
+): Promise<void> =>
+  new Promise((resolve, reject) => {
+    spawn('npx', ['tsc', '--outDir', buildDir], {
+      cwd: projectDir,
+      stdio: 'inherit',
+    }).once('close', (code) => {
+      if (code === 0) {
+        return resolve();
+      }
+      return reject(
+        `Error in building TypeScript, see output for more details`,
+      );
+    });
+  });

package/src/server.ts

@@ -4,6 +4,7 @@ import {
   BadRequest,
   Config,
   HTTPRoute,
+  Hooks,
   Metrics,
   NotFound,
   Request,
@@ -14,7 +15,6 @@ import {
   TooManyRequests,
   Unauthorized,
   WebSocketRoute,
-  beforeRequest,
   contentTypes,
   convertPathToURL,
   createLogger,
@@ -48,6 +48,7 @@ export class HTTPServer extends EventEmitter {
     protected metrics: Metrics,
     protected token: Token,
     protected router: Router,
+    protected hooks: Hooks,
   ) {
     super();
     this.host = config.getHost();
@@ -111,7 +112,7 @@ export class HTTPServer extends EventEmitter {
     );
 
     const req = request as Request;
-    const proceed = await beforeRequest({ req, res });
+    const proceed = await this.hooks.before({ req, res });
     req.parsed = convertPathToURL(request.url || '', this.config);
     shimLegacyRequests(req.parsed);
 
@@ -297,7 +298,7 @@ export class HTTPServer extends EventEmitter {
     this.verbose(`Handling inbound WebSocket request on "${request.url}"`);
 
     const req = request as Request;
-    const proceed = await beforeRequest({ head, req, socket });
+    const proceed = await this.hooks.before({ head, req, socket });
     req.parsed = convertPathToURL(request.url || '', this.config);
     shimLegacyRequests(req.parsed);
 

package/src/shared/content.http.ts

@@ -180,7 +180,6 @@ export default class ChromiumContentPostRoute extends BrowserHTTPRoute {
       bestAttemptCatch(bestAttempt),
     );
 
-
     if (addStyleTag.length) {
       for (const tag in addStyleTag) {
         await page.addStyleTag(addStyleTag[tag]);

package/src/types.ts

@@ -31,13 +31,13 @@ export type PathTypes =
 
 export interface BeforeRequest {
   head?: Buffer;
-  req: Request;
+  req: http.IncomingMessage;
   res?: http.ServerResponse;
   socket?: stream.Duplex;
 }
 
 export interface AfterResponse {
-  req: http.IncomingMessage;
+  req: Request;
   start: number;
   status: 'successful' | 'error' | 'timedout';
 }

package/src/utils.ts

@@ -463,16 +463,14 @@ export const availableBrowsers = Promise.all([
 
 export const queryParamsToObject = (
   params: URLSearchParams,
-): Record<string, unknown> => {
-  const entries = params.entries();
-
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  const result: any = {};
-  for (const [key, value] of entries) {
-    result[key] = value === '' ? true : jsonOrString(value);
-  }
-  return result;
-};
+): Record<string, unknown> =>
+  [...params.entries()].reduce(
+    (accum, [key, value]) => {
+      accum[key] = value;
+      return accum;
+    },
+    {} as Record<string, string>,
+  );
 
 // eslint-disable-next-line @typescript-eslint/no-empty-function
 const AsyncFunction = Object.getPrototypeOf(async function () {}).constructor;
@@ -745,7 +743,8 @@ export const encrypt = (text: string, secret: Buffer) => {
 };
 
 export const decrypt = (encryptedText: string, secret: Buffer) => {
-  const [encrypted, iv] = encryptedText.split(encryptionSep);
+  const [encrypted, iv] = encryptedText.toString().split(encryptionSep);
+  console.log('>>', encryptedText.toString());
   if (!iv) throw new ServerError('Bad or invalid encrypted format');
   const decipher = crypto.createDecipheriv(
     encryptionAlgo,