fix(puppet): no chrome launch errors to client

Author: blakebyrnes

core/server/ConnectionToClient.ts

@@ -11,6 +11,8 @@ import IWaitForOptions from '@secret-agent/core-interfaces/IWaitForOptions';
 import IAgentMeta from '@secret-agent/core-interfaces/IAgentMeta';
 import Log from '@secret-agent/commons/Logger';
 import { CanceledPromiseError } from '@secret-agent/commons/interfaces/IPendingWaitEvent';
+import PuppetLaunchError from '@secret-agent/puppet/lib/PuppetLaunchError';
+import { DependenciesMissingError } from '@secret-agent/puppet/lib/DependenciesMissingError';
 import Session from '../lib/Session';
 import Tab from '../lib/Tab';
 import GlobalPool from '../lib/GlobalPool';
@@ -65,15 +67,28 @@ export default class ConnectionToClient extends TypedEventEmitter<{
       if ((this.isClosing || session?.isClosing) && error instanceof CanceledPromiseError) {
         return;
       }
+      const isChildProcess = !!process.send;
+      if (isChildProcess === false) {
+        log.error('ConnectionToClient.HandleRequestError', {
+          error,
+          sessionId: session?.id,
+        });
+      }
       isError = true;
-      data =
-        error instanceof Error
-          ? {
-              message: error.message,
-              stack: error.stack,
-              ...error,
-            }
-          : new Error(`Unknown error occurred ${error}`);
+      if (error instanceof PuppetLaunchError || error instanceof DependenciesMissingError) {
+        data = {
+          message: 'CoreServer needs further setup to launch the browserEmulator. See server logs.',
+        };
+      } else if (error instanceof Error) {
+        data = {
+          message: error.message,
+          stack: error.stack,
+          ...error,
+        };
+      } else {
+        const tempError = new Error(`Unknown error occurred ${error}`);
+        data = { message: tempError.message, stack: tempError.stack };
+      }
     }
 
     const commandId = session?.sessionState?.lastCommand?.id;

puppet-chrome/index.ts

@@ -4,6 +4,7 @@ import IPuppetLauncher from '@secret-agent/puppet-interfaces/IPuppetLauncher';
 import * as os from 'os';
 import * as Path from 'path';
 import IBrowserEngine from '@secret-agent/core-interfaces/IBrowserEngine';
+import { IPuppetLaunchError } from '@secret-agent/puppet-interfaces/IPuppetLaunchError';
 import { Browser } from './lib/Browser';
 import { Connection } from './lib/Connection';
 
@@ -51,29 +52,35 @@ const PuppetLauncher: IPuppetLauncher = {
       const connection = new Connection(transport);
       return await Browser.create(connection, engine, close);
     } catch (error) {
-      close();
+      await close();
       throw error;
     }
   },
-  translateLaunchError(error: Error): Error {
+  translateLaunchError(rawError: Error): IPuppetLaunchError {
     // These error messages are taken from Chromium source code as of July, 2020:
     // https://github.com/chromium/chromium/blob/70565f67e79f79e17663ad1337dc6e63ee207ce9/content/browser/zygote_host/zygote_host_impl_linux.cc
+    const error = {
+      message: rawError.message,
+      stack: rawError.stack,
+      name: 'PuppetLaunchError',
+      isSandboxError: false,
+    };
     if (
-      !error.message.includes('crbug.com/357670') &&
-      !error.message.includes('No usable sandbox!') &&
-      !error.message.includes('crbug.com/638180')
+      error.message.includes('crbug.com/357670') ||
+      error.message.includes('No usable sandbox!') ||
+      error.message.includes('crbug.com/638180')
     ) {
-      return error;
+      error.stack += [
+        `\nChromium sandboxing failed!`,
+        `================================`,
+        `To workaround sandboxing issues, do either of the following:`,
+        `  - (preferred): Configure environment to support sandboxing (as here: https://github.com/ulixee/secret-agent/tree/master/tools/docker)`,
+        `  - (alternative): Launch Chromium without sandbox using 'NO_CHROME_SANDBOX=false' environmental variable`,
+        `================================`,
+        ``,
+      ].join('\n');
+      error.isSandboxError = true;
     }
-    error.stack += [
-      `\nChromium sandboxing failed!`,
-      `================================`,
-      `To workaround sandboxing issues, do either of the following:`,
-      `  - (preferred): Configure environment to support sandboxing (eg: in Docker, use custom seccomp profile + non-root user + --ipc=host)`,
-      `  - (alternative): Launch Chromium without sandbox using 'NO_CHROME_SANDBOX=false' environmental variable`,
-      `================================`,
-      ``,
-    ].join('\n');
     return error;
   },
 };

puppet-chrome/lib/CDPSession.ts

@@ -115,7 +115,7 @@ export class CDPSession extends EventEmitter {
       error.stack += `\n${'------DEVTOOLS'.padEnd(
         50,
         '-',
-      )}\n${`------DEVTOOLS-SESSION-ID =${this.sessionId}`.padEnd(50, '-')}\n${resolvable.stack}`;
+      )}\n${`------CDP_SESSION_ID=${this.sessionId}`.padEnd(50, '-')}\n${resolvable.stack}`;
       resolvable.reject(error);
     }
     this.pendingMessages.clear();

puppet-interfaces/IPuppetLaunchError.ts

@@ -0,0 +1,3 @@
+export interface IPuppetLaunchError extends Error {
+  isSandboxError: boolean;
+}

puppet-interfaces/IPuppetLauncher.ts

@@ -1,9 +1,10 @@
 import IBrowserEngine from '@secret-agent/core-interfaces/IBrowserEngine';
 import ILaunchedProcess from './ILaunchedProcess';
 import IPuppetBrowser from './IPuppetBrowser';
+import { IPuppetLaunchError } from './IPuppetLaunchError';
 
 export default interface IPuppetLauncher {
   getLaunchArgs(options: { proxyPort?: number; showBrowser?: boolean }): string[];
   createPuppet(process: ILaunchedProcess, engine: IBrowserEngine): Promise<IPuppetBrowser>;
-  translateLaunchError(error: Error): Error;
+  translateLaunchError(error: Error): IPuppetLaunchError;
 }

puppet/index.ts

@@ -9,6 +9,7 @@ import { existsSync } from 'fs';
 import launchProcess from './lib/launchProcess';
 import { validateHostRequirements } from './lib/validateHostDependencies';
 import { EngineFetcher } from './lib/EngineFetcher';
+import PuppetLaunchError from './lib/PuppetLaunchError';
 
 const { log } = Log(module);
 
@@ -100,7 +101,12 @@ export default class Puppet {
       const launchedProcess = await launchProcess(executablePath, launchArgs, {}, pipeBrowserIo);
       return launcher.createPuppet(launchedProcess, this.engine);
     } catch (err) {
-      throw launcher.translateLaunchError(err);
+      const launchError = launcher.translateLaunchError(err);
+      throw new PuppetLaunchError(
+        launchError.message,
+        launchError.stack,
+        launchError.isSandboxError,
+      );
     }
   }
 

puppet/lib/DependenciesMissingError.ts

@@ -0,0 +1,11 @@
+export class DependenciesMissingError extends Error {
+  constructor(
+    resolutionMessage: string,
+    readonly engineName: string,
+    readonly missingDependencies: string[],
+  ) {
+    super(
+      `Some of the dependencies needed to run ${engineName} are not on your system!\n\n${resolutionMessage}`,
+    );
+  }
+}

puppet/lib/PuppetLaunchError.ts

@@ -0,0 +1,8 @@
+import { IPuppetLaunchError } from '@secret-agent/puppet-interfaces/IPuppetLaunchError';
+
+export default class PuppetLaunchError extends Error implements IPuppetLaunchError {
+  constructor(message: string, stack: string, readonly isSandboxError: boolean) {
+    super(message);
+    this.stack = stack;
+  }
+}

puppet/lib/installEngineWithProgress.ts

@@ -40,7 +40,8 @@ export default async function installEngineWithProgress(engine: IBrowserEngineCo
       progressBar.tick(delta);
     });
 
-    await validateHostRequirements(engineFetcher.toJSON());
+    // don't blow up during install process if host requirements can't be met
+    await validateHostRequirements(engineFetcher.toJSON()).catch(err => npmlog(err.toString()));
 
     npmlog(`${browserTitle} (${version}) downloaded to ${engineFetcher.browsersDir}`);
   } catch (error) {

puppet/lib/validateHostDependencies.ts

@@ -20,11 +20,9 @@ import * as path from 'path';
 import * as os from 'os';
 import { spawn } from 'child_process';
 import IBrowserEngine from '@secret-agent/core-interfaces/IBrowserEngine';
-import Log from '@secret-agent/commons/Logger';
 import { isDebianFlavor } from './LinuxUtils';
 import DependencyInstaller from './DependencyInstaller';
-
-const { log } = Log(module);
+import { DependenciesMissingError } from './DependenciesMissingError';
 
 export async function validateHostRequirements(engine: IBrowserEngine): Promise<void> {
   const isWindows64 = os.platform() === 'win32' && os.arch() === 'x64';
@@ -48,7 +46,7 @@ export async function validateHostRequirements(engine: IBrowserEngine): Promise<
     resolutionMessage = getWindowsResolutionMessage(missingDeps);
   } else if (isDebian) {
     await DependencyInstaller.appendAptInstallNeeded(engine);
-    resolutionMessage = `You can resolve this by running the apt installer at:
+    resolutionMessage = `You can resolve this by running the apt dependency installer at:
 -------------------------------------------------
 
 ${DependencyInstaller.aptScriptPath}
@@ -62,9 +60,7 @@ missing: ${[...missingDeps].join(', ')}
       '\n    ',
     )}`;
   }
-  log.warn(
-    `Some of the dependencies needed to run ${engineName} are not on your system!\n\n${resolutionMessage}`,
-  );
+  throw new DependenciesMissingError(resolutionMessage, engineName, [...missingDeps]);
 }
 
 function getWindowsResolutionMessage(missingDeps: Set<string>): string {
@@ -122,21 +118,17 @@ async function findAllMissingDependencies(directoryPath: string): Promise<Set<st
         return await spawnMissingDepsCheck(filePath);
       }
 
-      const canAccess = await fileExists(filePath, FsConstants.X_OK);
-      if (canAccess) {
+      try {
+        await Fs.access(filePath, FsConstants.X_OK);
         return await spawnMissingDepsCheck(filePath);
+      } catch (error) {
+        // just break through and return if we can't access
       }
       return [];
     }),
   );
 
-  return new Set<string>(...[].concat(...missingDeps));
-}
-
-function fileExists(filePath: string, mode?: number): Promise<boolean> {
-  return Fs.access(filePath, mode)
-    .then(() => true)
-    .catch(() => false);
+  return new Set<string>([].concat(...missingDeps));
 }
 
 async function spawnMissingDepsCheck(filePath: string): Promise<string[]> {
@@ -168,7 +160,7 @@ async function spawnMissingDepsCheck(filePath: string): Promise<string[]> {
   }
 
   return stdout
-    .split(/\r?\n/)
+    .split(/\r?\n/g)
     .filter(line => line.trim().endsWith('not found') && line.includes('=>'))
     .map(line => line.split('=>')[0].trim());
 }