feat(puppet): unsupported linux install message

blakebyrnes · blakebyrnes · commit fe6e63472a81 · 2021-02-16T10:21:47.000-05:00
diff --git a/.github/workflows/lint-and-test.yml b/.github/workflows/lint-and-test.yml
@@ -128,7 +128,7 @@ jobs:
           done
 
       - name: Run tests
-        run: yarn jest --testTimeout=60000
+        run: yarn jest --testTimeout=60000 --runInBand
         working-directory: ./build
         env:
           SA_SHOW_REPLAY: false
diff --git a/core-interfaces/IBrowserEmulatorClass.ts b/core-interfaces/IBrowserEmulatorClass.ts
@@ -1,10 +1,11 @@
 import IBrowserEmulator from './IBrowserEmulator';
 import IUserAgentOption from './IUserAgentOption';
+import IBrowserEngine from './IBrowserEngine';
 
 export default interface IBrowserEmulatorClass {
   id: string;
   roundRobinPercent: number;
-  engine: { browser: string; executablePath: string; version: string };
+  engine: IBrowserEngine;
   new (): IBrowserEmulator;
   userAgentOptions?: IUserAgentOption[];
 }
diff --git a/core-interfaces/IBrowserEngine.ts b/core-interfaces/IBrowserEngine.ts
@@ -2,5 +2,11 @@ export default interface IBrowserEngine {
   browser: string;
   version: string;
   executablePath: string;
+  executablePathEnvVar: string;
   extraLaunchArgs?: string[];
 }
+
+export type IBrowserEngineConfig = Pick<
+  IBrowserEngine,
+  'browser' | 'version' | 'executablePathEnvVar'
+>;
diff --git a/emulate-browsers/base/index.ts b/emulate-browsers/base/index.ts
@@ -17,13 +17,13 @@ const { log } = Log(module);
 
 function getEngine(
   engine: { browser: string; version: string },
-  executablePathOverride?: string,
+  executablePathEnvVar?: string,
 ): IBrowserEngine {
-  const engineFetcher = new EngineFetcher(engine.browser, engine.version).toJSON();
-
-  if (executablePathOverride) {
-    engineFetcher.executablePath = executablePathOverride;
-  }
+  const engineFetcher = new EngineFetcher(
+    engine.browser,
+    engine.version,
+    executablePathEnvVar,
+  ).toJSON();
 
   log.stats('Browser.getEngine', {
     sessionId: null,
diff --git a/emulate-browsers/base/install.ts b/emulate-browsers/base/install.ts
@@ -1,6 +1,7 @@
 import EngineInstaller from '@secret-agent/puppet/lib/EngineInstaller';
+import { IBrowserEngineConfig } from '@secret-agent/core-interfaces/IBrowserEngine';
 
-export default function install(engine: { browser: string; version: string }) {
+export default function install(engine: IBrowserEngineConfig) {
   new EngineInstaller(engine)
     .install()
     .then(() => {
diff --git a/emulate-browsers/chrome-80/config.json b/emulate-browsers/chrome-80/config.json
@@ -4,7 +4,8 @@
     "id": "chrome-80-0",
     "name": "chrome",
     "version": "80.0.3987.162",
-    "features": ["headless"]
+    "features": ["headless"],
+    "executablePathEnvVar": "CHROME_80_BIN"
   },
   "marketshare": 0.4
 }
diff --git a/emulate-browsers/chrome-80/index.ts b/emulate-browsers/chrome-80/index.ts
@@ -36,9 +36,9 @@ const engineObj = {
 @BrowserEmulatorClassDecorator
 export default class Chrome80 {
   public static id = pkg.name;
-  public static roundRobinPercent: number = (config as any).marketshare;
+  public static roundRobinPercent: number = config.marketshare;
 
-  public static engine = getEngine(engineObj, process.env.CHROME_80_BIN);
+  public static engine = getEngine(engineObj, config.browserEngine.executablePathEnvVar);
 
   public static dnsOverTlsConnectOptions = DnsOverTlsProviders.Cloudflare;
 
diff --git a/emulate-browsers/chrome-80/install.ts b/emulate-browsers/chrome-80/install.ts
@@ -4,4 +4,5 @@ import * as config from './config.json';
 install({
   browser: config.browserEngine.name,
   version: config.browserEngine.version,
+  executablePathEnvVar: config.browserEngine.executablePathEnvVar,
 });
diff --git a/emulate-browsers/chrome-81/config.json b/emulate-browsers/chrome-81/config.json
@@ -4,7 +4,8 @@
     "id": "chrome-81-0",
     "name": "chrome",
     "version": "81.0.4044.138",
-    "features": ["headless"]
+    "features": ["headless"],
+    "executablePathEnvVar": "CHROME_81_BIN"
   },
   "marketshare": 0.4
 }
diff --git a/emulate-browsers/chrome-81/index.ts b/emulate-browsers/chrome-81/index.ts
@@ -36,9 +36,9 @@ const engineObj = {
 @BrowserEmulatorClassDecorator
 export default class Chrome81 {
   public static id = pkg.name;
-  public static roundRobinPercent: number = (config as any).marketshare;
+  public static roundRobinPercent: number = config.marketshare;
 
-  public static engine = getEngine(engineObj, process.env.CHROME_81_BIN);
+  public static engine = getEngine(engineObj, config.browserEngine.executablePathEnvVar);
 
   public static dnsOverTlsConnectOptions = DnsOverTlsProviders.Cloudflare;
 
diff --git a/emulate-browsers/chrome-81/install.ts b/emulate-browsers/chrome-81/install.ts
@@ -4,4 +4,5 @@ import * as config from './config.json';
 install({
   browser: config.browserEngine.name,
   version: config.browserEngine.version,
+  executablePathEnvVar: config.browserEngine.executablePathEnvVar,
 });
diff --git a/emulate-browsers/chrome-83/config.json b/emulate-browsers/chrome-83/config.json
@@ -4,7 +4,8 @@
     "id": "chrome-83-0",
     "name": "chrome",
     "version": "83.0.4103.61",
-    "features": ["headless"]
+    "features": ["headless"],
+    "executablePathEnvVar": "CHROME_83_BIN"
   },
   "marketshare": 0.8
 }
diff --git a/emulate-browsers/chrome-83/index.ts b/emulate-browsers/chrome-83/index.ts
@@ -36,9 +36,9 @@ const engineObj = {
 @BrowserEmulatorClassDecorator
 export default class Chrome83 {
   public static id = pkg.name;
-  public static roundRobinPercent: number = (config as any).marketshare;
+  public static roundRobinPercent: number = config.marketshare;
 
-  public static engine = getEngine(engineObj, process.env.CHROME_83_BIN);
+  public static engine = getEngine(engineObj, config.browserEngine.executablePathEnvVar);
 
   public static dnsOverTlsConnectOptions = DnsOverTlsProviders.Cloudflare;
 
diff --git a/emulate-browsers/chrome-83/install.ts b/emulate-browsers/chrome-83/install.ts
@@ -4,4 +4,5 @@ import * as config from './config.json';
 install({
   browser: config.browserEngine.name,
   version: config.browserEngine.version,
+  executablePathEnvVar: config.browserEngine.executablePathEnvVar,
 });
diff --git a/emulate-browsers/safari-13/config.json b/emulate-browsers/safari-13/config.json
@@ -1,4 +1,11 @@
 {
-  "browserEngine": ["chrome-80-0", "headless"],
+  "browserId": "safari-13-0",
+  "browserEngine": {
+    "id": "chrome-83-0",
+    "name": "chrome",
+    "version": "83.0.4103.61",
+    "features": ["headless"],
+    "executablePathEnvVar": "CHROME_83_BIN"
+  },
   "marketshare": 5.9
 }
diff --git a/emulate-browsers/safari-13/index.ts b/emulate-browsers/safari-13/index.ts
@@ -39,12 +39,17 @@ const codecsData = new DataLoader(`${__dirname}/data`, 'codecs');
 const cookieCallbackName = 'SecretAgentSetCookie';
 const { log } = Log(module);
 
+const engineObj = {
+  browser: config.browserEngine.name,
+  version: config.browserEngine.version,
+};
+
 @BrowserEmulatorClassDecorator
 export default class Safari13 {
   public static id = pkg.name;
   public static roundRobinPercent: number = (config as any).marketshare;
 
-  public static engine = getEngine(pkg.engine, process.env.CHROME_83_BIN);
+  public static engine = getEngine(engineObj, config.browserEngine.executablePathEnvVar);
 
   public readonly networkInterceptorDelegate: INetworkInterceptorDelegate;
 
diff --git a/emulate-browsers/safari-13/package.json b/emulate-browsers/safari-13/package.json
@@ -3,10 +3,6 @@
   "version": "1.3.1-alpha.0",
   "description": "EmulatorPlugin for Apple Safari version 13.0",
   "main": "index.js",
-  "engine": {
-    "browser": "chrome",
-    "version": "80.0.3987.162"
-  },
   "dependencies": {
     "@secret-agent/commons": "1.3.1-alpha.0",
     "@secret-agent/core-interfaces": "1.3.1-alpha.0",
diff --git a/puppet/index.ts b/puppet/index.ts
@@ -84,7 +84,7 @@ export default class Puppet {
     const executablePath = this.engine.executablePath;
 
     if (!existsSync(executablePath)) {
-      throw this.getLaunchError(executablePath);
+      throw await this.noExecutableAtPathError(executablePath);
     }
 
     try {
@@ -104,34 +104,43 @@ export default class Puppet {
     }
   }
 
-  private getLaunchError(executablePath: string): Error {
-    const engineFetcher = new EngineFetcher(this.engine.browser, this.engine.version);
-    if (engineFetcher.platform === 'linux') {
-      const installCommand = engineFetcher.getPendingInstallCommand();
+  private async noExecutableAtPathError(executablePath: string): Promise<Error> {
+    const engineFetcher = new EngineFetcher(
+      this.engine.browser,
+      this.engine.version,
+      this.engine.executablePathEnvVar,
+    );
+
+    let remedyMessage = `No executable exists at "${executablePath}"`;
+
+    // If we tried using stock downloaded browser, suggest further installation directions
+    if (executablePath === engineFetcher.executablePath) {
+      const installCommand = await engineFetcher.getPendingInstallCommand();
       if (installCommand) {
-        return new Error(`SecretAgent can't use ${this.engine.browser}@${this.engine.version} until you run the following apt installer:
+        remedyMessage = `Please run the following command:
 -------------- APT INSTALL NEEDED ---------------
 -------------------------------------------------
 
 ${installCommand}
 
 -------------------------------------------------
-`);
+`;
+      } else {
+        const majorBrowserVersion = this.engine.version.split('.').shift();
+        remedyMessage = `Please re-install the browser engine:
+-------------- NPM INSTALL ----------------------
+-------------------------------------------------
+
+ npm install @secret-agent/emulate-chrome-${majorBrowserVersion}
+
+-------------------------------------------------
+`;
       }
     }
 
-    const errorMessageLines = [
-      `Failed to launch ${this.engine.browser}@${this.engine.version} because executable doesn't exist at "${executablePath}"`,
-    ];
+    return new Error(`Failed to launch ${this.engine.browser} ${this.engine.version}:
 
-    // If we tried using stock downloaded browser, suggest re-installing SecretAgent.
-    if (executablePath === engineFetcher.executablePath) {
-      const majorBrowserVersion = this.engine.version.split('.').shift();
-      errorMessageLines.push(
-        `Try re-installing SecretAgent with "npm install secret-agent" or re-install any custom BrowserEmulators (eg, @secret-agent/emulate-chrome-${majorBrowserVersion}).`,
-      );
-    }
-    return new Error(errorMessageLines.join('\n'));
+${remedyMessage}`);
   }
 }
 
diff --git a/puppet/lib/EngineFetcher.ts b/puppet/lib/EngineFetcher.ts
@@ -6,7 +6,7 @@ import { createGunzip } from 'zlib';
 import * as Tar from 'tar';
 import downloadFile from '@secret-agent/commons/downloadFile';
 import IBrowserEngine from '@secret-agent/core-interfaces/IBrowserEngine';
-import { execSync } from 'child_process';
+import * as LinuxUtils from './LinuxUtils';
 
 export class EngineFetcher {
   private static linuxInstallerDirector = '/tmp/secret-agent/browser-installers';
@@ -41,7 +41,8 @@ export class EngineFetcher {
   public readonly platform: 'linux' | 'mac' | 'win32' | 'win64';
   public readonly version: string;
   public readonly browserVersionDir: string;
-  public executablePath: string;
+  public readonly executablePathEnvVar: string;
+  public readonly executablePath: string;
 
   public get isInstalled(): boolean {
     return Fs.existsSync(this.executablePath);
@@ -64,9 +65,15 @@ export class EngineFetcher {
     return [];
   }
 
-  constructor(browser: 'chrome' | string, version: string, downloadsBaseUrl?: string) {
+  constructor(
+    browser: 'chrome' | string,
+    version: string,
+    executablePathEnvVar: string,
+    downloadsBaseUrl?: string,
+  ) {
     this.browserName = browser as any;
     this.version = version;
+    this.executablePathEnvVar = executablePathEnvVar;
     this.platform = EngineFetcher.getPlatform();
 
     assert(this.platform, 'This operating system is not supported');
@@ -84,7 +91,8 @@ export class EngineFetcher {
     const relativePath =
       EngineFetcher.relativeBrowserExecutablePathsByOs[this.browserName][this.platform];
 
-    this.executablePath = Path.join(this.browserVersionDir, relativePath);
+    this.executablePath =
+      process.env[executablePathEnvVar] ?? Path.join(this.browserVersionDir, relativePath);
   }
 
   public async download(
@@ -132,26 +140,36 @@ export class EngineFetcher {
   ): Promise<{ installCommand: string }> {
     if (this.isInstalled) return;
 
+    const isDebianLinux = await LinuxUtils.isDebianFlavor();
     const downloadsDir = EngineFetcher.linuxInstallerDirector;
 
     if (!Fs.existsSync(downloadsDir)) {
       Fs.mkdirSync(downloadsDir, { recursive: true });
     }
 
-    const downloadedInstaller = `${downloadsDir}/${this.browserName}_${this.version}.deb`;
-
-    await downloadFile(this.url, downloadedInstaller, progressCallback);
+    if (isDebianLinux) {
+      const downloadedInstaller = `${downloadsDir}/${this.browserName}_${this.version}.deb`;
+      await downloadFile(this.url, downloadedInstaller, progressCallback);
+    }
 
     return {
-      installCommand: this.getPendingInstallCommand(),
+      installCommand: await this.getPendingInstallCommand(),
     };
   }
 
-  public getPendingInstallCommand(): string {
+  public async getPendingInstallCommand(): Promise<string> {
     if (this.platform === 'linux') {
+      if (!(await LinuxUtils.isDebianFlavor())) {
+        return `SecretAgent does not yet automatically install browsers on this flavor of linux.
+
+You can install ${this.browserName}@${this.version} to "${this.executablePath}".
+
+Or set the executablePath of your installation to the environment variable "${this.executablePathEnvVar}" (eg, ${this.executablePathEnvVar}=[path])`;
+      }
+
       const downloadedInstaller = `${EngineFetcher.linuxInstallerDirector}/${this.browserName}_${this.version}.deb`;
       if (Fs.existsSync(downloadedInstaller)) {
-        return `sudo chown _apt "${downloadedInstaller}" && sudo apt -y install ${downloadedInstaller} && rm ${downloadedInstaller}`;
+        return `sudo chown _apt ${downloadedInstaller} && sudo apt -y install ${downloadedInstaller} && rm ${downloadedInstaller}`;
       }
     }
   }
@@ -161,6 +179,7 @@ export class EngineFetcher {
       browser: this.browserName,
       version: this.version,
       executablePath: this.executablePath,
+      executablePathEnvVar: this.executablePathEnvVar,
       isInstalled: this.isInstalled,
       extraLaunchArgs: this.launchArgs,
     };
diff --git a/puppet/lib/EngineInstaller.ts b/puppet/lib/EngineInstaller.ts
@@ -1,16 +1,17 @@
 import * as os from 'os';
 import * as ProgressBar from 'progress';
+import { IBrowserEngineConfig } from '@secret-agent/core-interfaces/IBrowserEngine';
 import { EngineFetcher } from './EngineFetcher';
 
 export default class EngineInstaller {
-  constructor(readonly engine: { browser: string; version: string }) {}
+  constructor(readonly engine: IBrowserEngineConfig) {}
 
   public async install() {
     if (this.shouldSkipDownload()) return;
 
-    const { version, browser } = this.engine;
+    const { version, browser, executablePathEnvVar } = this.engine;
     const browserTitle = browser[0].toUpperCase() + browser.slice(1);
-    const engineFetcher = new EngineFetcher(browser as any, version);
+    const engineFetcher = new EngineFetcher(browser as any, version, executablePathEnvVar);
 
     // Do nothing if the revision is already downloaded.
     if (engineFetcher.isInstalled) {
diff --git a/puppet/lib/LinuxUtils.ts b/puppet/lib/LinuxUtils.ts
