feat(emulators): move installation into emulators

Author: blakebyrnes

.eslintrc.js

@@ -114,6 +114,7 @@ module.exports = {
     {
       files: [
         '**/install*',
+        '**/installer/index*',
         '**/*Install*',
         '**/prepare-*.js',
         '**/scripts/*.ts',

.github/workflows/lint-and-test.yml

@@ -131,7 +131,7 @@ jobs:
       - name: Linux - Apt Install Chrome(s)
         if: ${{ matrix.os == 'ubuntu-latest' }}
         working-directory: ./build
-        run: sudo $(npx puppet-install-deps)
+        run: sudo $(npx install-browser-deps)
 
       - name: Run tests
         run: yarn jest --testTimeout=60000 --maxWorkers=2

Dockerfile

@@ -50,7 +50,7 @@ RUN cat /etc/*-release
 # NOTE: this installs the monorepo, but you could also install secret-agent directly + and desired browsers
 # we will automatically install dependencies
 RUN cd /app/secret-agent && yarn \
-    && $(npx puppet-install-deps) \
+    && $(npx install-browser-deps) \
     && groupadd -r sagent && useradd -r -g sagent -G audio,video sagent \
     && mkdir -p /home/sagent/Downloads \
     && mkdir -p /home/sagent/.cache \

core/package.json

@@ -16,7 +16,6 @@
   "dependencies": {
     "@secret-agent/commons": "1.4.1-alpha.4",
     "@secret-agent/interfaces": "1.4.1-alpha.4",
-    "@secret-agent/emulate-browsers-base": "1.4.1-alpha.4",
     "@secret-agent/emulate-chrome-latest": "1.4.1-alpha.4",
     "@secret-agent/emulate-humans-basic": "1.4.1-alpha.4",
     "@secret-agent/emulate-humans-ghost": "1.4.1-alpha.4",
@@ -35,6 +34,7 @@
     "@secret-agent/client": "1.4.1-alpha.4",
     "@secret-agent/core": "1.4.1-alpha.4",
     "@secret-agent/puppet-chrome": "1.4.1-alpha.4",
+    "@secret-agent/emulate-browsers-installer": "1.4.1-alpha.4",
     "@secret-agent/testing": "1.4.1-alpha.4",
     "@types/better-sqlite3": "^5.4.1",
     "@types/json-socket": "^0.1.17",

core/server/ConnectionToClient.ts

@@ -12,7 +12,6 @@ import IAgentMeta from '@secret-agent/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 IUserProfile from '@secret-agent/interfaces/IUserProfile';
 import SessionClosedOrMissingError from '@secret-agent/commons/SessionClosedOrMissingError';
 import TimeoutError from '@secret-agent/commons/interfaces/TimeoutError';
@@ -324,7 +323,7 @@ export default class ConnectionToClient extends TypedEventEmitter<{
   }
 
   private isLaunchError(error: Error): boolean {
-    return error instanceof PuppetLaunchError || error instanceof DependenciesMissingError;
+    return error instanceof PuppetLaunchError || error.name === 'DependenciesMissingError';
   }
 
   private serializeError(error: Error): object {

core/test/connection.test.ts

@@ -1,12 +1,12 @@
 import { Helpers } from '@secret-agent/testing';
 import agent, { Agent, Handler } from '@secret-agent/client';
 import * as http from 'http';
-import { DependenciesMissingError } from '@secret-agent/puppet/lib/DependenciesMissingError';
-import DependencyInstaller from '@secret-agent/puppet/lib/DependencyInstaller';
-import * as ValidateHostDeps from '@secret-agent/puppet/lib/validateHostDependencies';
 import { Log } from '@secret-agent/commons/Logger';
 import ChromeLatest from '@secret-agent/emulate-chrome-latest';
 import BrowserEmulators from '@secret-agent/core/lib/BrowserEmulators';
+import { DependenciesMissingError } from '@secret-agent/emulate-browsers-installer/lib/DependenciesMissingError';
+import DependencyInstaller from '@secret-agent/emulate-browsers-installer/lib/DependencyInstaller';
+import * as ValidateHostDeps from '@secret-agent/emulate-browsers-installer/lib/validateHostDependencies';
 import CoreServer from '../server';
 
 const validate = jest.spyOn(ValidateHostDeps, 'validateHostRequirements');

emulate-browsers/base/index.ts

@@ -2,9 +2,6 @@ import IBrowserEmulatorClass, {
   BrowserEmulatorClassDecorator,
 } from '@secret-agent/interfaces/IBrowserEmulatorClass';
 import IBrowserEmulator from '@secret-agent/interfaces/IBrowserEmulator';
-import IBrowserEngine from '@secret-agent/interfaces/IBrowserEngine';
-import { EngineFetcher } from '@secret-agent/puppet/lib/EngineFetcher';
-import Log from '@secret-agent/commons/Logger';
 import modifyHeaders from './lib/modifyHeaders';
 import DataLoader from './lib/DataLoader';
 import DomPolyfillLoader from './lib/DomPolyfillLoader';
@@ -14,30 +11,6 @@ import DomOverridesBuilder from './lib/DomOverridesBuilder';
 import * as DnsOverTlsProviders from './lib/DnsOverTlsProviders';
 import Viewports from './lib/Viewports';
 
-const { log } = Log(module);
-
-function getEngine(
-  engine: { name: string; fullVersion: string },
-  executablePathEnvVar?: string,
-  getLaunchArguments?: IBrowserEngine['getLaunchArguments'],
-): IBrowserEngine {
-  const engineFetcher = new EngineFetcher(engine.name, engine.fullVersion, executablePathEnvVar);
-
-  const browserEngine = engineFetcher.toJSON();
-  log.stats('Browser.getEngine', {
-    sessionId: null,
-    browserEngine,
-  });
-  const engineFetcherLaunchArgs = engineFetcher.launchArgs;
-  browserEngine.getLaunchArguments = (puppetOptions, defaultArguments) => {
-    defaultArguments.push(...engineFetcherLaunchArgs);
-    if (getLaunchArguments) return getLaunchArguments(puppetOptions, defaultArguments);
-    return defaultArguments;
-  };
-
-  return browserEngine;
-}
-
 export {
   DnsOverTlsProviders,
   BrowserEmulatorClassDecorator,
@@ -49,6 +22,5 @@ export {
   DomPolyfillLoader,
   getTcpSettingsForOs,
   Viewports,
-  getEngine,
   parseNavigatorPlugins,
 };

emulate-browsers/base/install.ts

@@ -6,11 +6,13 @@
   "dependencies": {
     "@secret-agent/commons": "1.4.1-alpha.4",
     "@secret-agent/interfaces": "1.4.1-alpha.4",
-    "@secret-agent/puppet": "1.4.1-alpha.4"
+    "progress": "^2.0.3",
+    "tar": "^6.1.0"
   },
   "devDependencies": {
     "@secret-agent/core": "1.4.1-alpha.4",
     "@secret-agent/emulate-chrome-latest": "1.4.1-alpha.4",
-    "@secret-agent/testing": "1.4.1-alpha.4"
+    "@secret-agent/testing": "1.4.1-alpha.4",
+    "@secret-agent/puppet": "1.4.1-alpha.4"
   }
 }