Pass config env vars to mirrord verify-config. (#74)

* Pass config env vars to mirrord verify-config. * changelog * pass config.env to binaryExecute * just pass config.env to binaryExewcute and spawn * missing semicolon * better docs * remove manual resolving config path // stop setting target to null * elseif * mini docs * format * fix order for env vars Co-authored-by: Michał Smolarek <[email protected]> --------- Co-authored-by: Michał Smolarek <[email protected]>
metalbear-co · Oct 19, 2023 · e07e9d2 · e07e9d2
1 parent bbdc8c7
commit e07e9d2
Show file tree

Hide file tree

Showing 5 changed files with 380 additions and 372 deletions.
diff --git a/changelog.d/70.fixed.md b/changelog.d/70.fixed.md
@@ -0,0 +1 @@
+Passes the `launch.json` `env` section to `mirrord verify-config`, resolving config options that were set as env vars. 
diff --git a/src/api.ts b/src/api.ts
@@ -4,7 +4,8 @@ import { globalContext } from './extension';
 import { tickWaitlistCounter } from './waitlist';
 import { NotificationBuilder } from './notification';
 import { MirrordStatus } from './status';
-import { VerifiedConfig } from './config';
+import { EnvVars, VerifiedConfig } from './config';
+import { PathLike } from 'fs';
 
 /**
 * Key to access the feedback counter (see `tickFeedbackCounter`) from the global user config.
@@ -133,6 +134,30 @@ export class MirrordExecution {
 
 }
 
+/**
+* Sets up the args that are going to be passed to the mirrord cli.
+*/
+const makeMirrordArgs = (target: string | null, configFilePath: PathLike | null, userExecutable: PathLike | null): readonly string[] => {
+  let args = ["ext"];
+
+  if (target) {
+    console.log(`target ${target}`);
+    args.push("-t", target);
+  }
+
+  if (configFilePath) {
+    console.log(`configFilePath ${configFilePath.toString()}`);
+    args.push("-f", configFilePath.toString());
+  }
+
+  if (userExecutable) {
+    console.log(`userExecutable ${userExecutable.toString()}`);
+    args.push("-e", userExecutable.toString());
+  }
+
+  return args;
+};
+
 /**
 * API to interact with the mirrord CLI, runs in the "ext" mode.
 */
@@ -144,18 +169,19 @@ export class MirrordAPI {
   }
 
   // Return environment for the spawned mirrord cli processes.
-  private static getEnv(): NodeJS.ProcessEnv {
+  private static getEnv(configEnv: EnvVars): NodeJS.ProcessEnv {
     // clone env vars and add MIRRORD_PROGRESS_MODE
     return {
+      ...process.env,
+      ...configEnv,
       // eslint-disable-next-line @typescript-eslint/naming-convention
       "MIRRORD_PROGRESS_MODE": "json",
-      ...process.env,
     };
   }
 
   // Execute the mirrord cli with the given arguments, return stdout.
-  private async exec(args: string[]): Promise<string> {
-    const child = this.spawn(args);
+  private async exec(args: string[], configEnv: EnvVars): Promise<string> {
+    const child = this.spawnCliWithArgsAndEnv(args, configEnv);
 
     return await new Promise<string>((resolve, reject) => {
       let stdoutData = "";
@@ -204,15 +230,15 @@ export class MirrordAPI {
   * Spawn the mirrord cli with the given arguments.
   * Used for reading/interacting while process still runs.
   */
-  private spawn(args: string[]): ChildProcessWithoutNullStreams {
-    return spawn(this.cliPath, args, { env: MirrordAPI.getEnv() });
+  private spawnCliWithArgsAndEnv(args: readonly string[], configEnv: EnvVars): ChildProcessWithoutNullStreams {
+    return spawn(this.cliPath, args, { env: MirrordAPI.getEnv(configEnv) });
   }
 
   /**
    * Runs mirrord --version and returns the version string.
    */
   async getBinaryVersion(): Promise<string | undefined> {
-    const stdout = await this.exec(["--version"]);
+    const stdout = await this.exec(["--version"], {});
     // parse mirrord x.y.z
     return stdout.split(" ")[1].trim();
   }
@@ -227,7 +253,7 @@ export class MirrordAPI {
       args.push('-f', configPath);
     }
 
-    const stdout = await this.exec(args);
+    const stdout = await this.exec(args, {});
 
     const targets: string[] = JSON.parse(stdout);
     targets.sort();
@@ -250,10 +276,10 @@ export class MirrordAPI {
   * Executes the `mirrord verify-config {configPath}` command, parsing its output into a
   * `VerifiedConfig`.
   */
-  async verifyConfig(configPath: vscode.Uri | null): Promise<VerifiedConfig | undefined> {
+  async verifyConfig(configPath: vscode.Uri | null, configEnv: EnvVars): Promise<VerifiedConfig | undefined> {
     if (configPath) {
       const args = ['verify-config', '--ide', `${configPath.path}`];
-      const stdout = await this.exec(args);
+      const stdout = await this.exec(args, configEnv);
 
       const verifiedConfig: VerifiedConfig = JSON.parse(stdout);
       return verifiedConfig;
@@ -262,10 +288,13 @@ export class MirrordAPI {
     }
   }
 
-  // Run the extension execute sequence
-  // Creating agent and gathering execution runtime (env vars to set)
-  // Has 60 seconds timeout
-  async binaryExecute(target: string | null, configFile: string | null, executable: string | null): Promise<MirrordExecution> {
+  /** 
+  * Runs the extension execute sequence, creating agent and gathering execution runtime while also
+  * setting env vars, both from system, and from `launch.json` (`configEnv`).
+  *
+  * Has 60 seconds timeout
+  */
+  async binaryExecute(target: string | null, configFile: string | null, executable: string | null, configEnv: EnvVars): Promise<MirrordExecution> {
     tickWaitlistCounter(!!target?.startsWith('deployment/'));
     tickFeedbackCounter();
 
@@ -280,18 +309,9 @@ export class MirrordAPI {
           reject("timeout");
         }, 120 * 1000);
 
-        const args = ["ext"];
-        if (target) {
-          args.push("-t", target);
-        }
-        if (configFile) {
-          args.push("-f", configFile);
-        }
-        if (executable) {
-          args.push("-e", executable);
-        }
+        const args = makeMirrordArgs(target, configFile, executable);
 
-        const child = this.spawn(args);
+        const child = this.spawnCliWithArgsAndEnv(args, configEnv);
 
         let stderrData = "";
         child.stderr.on("data", (data) => stderrData += data.toString());

diff --git a/src/config.ts b/src/config.ts
@@ -16,9 +16,11 @@ const DEFAULT_CONFIG = `{
 }
 `;
 
+export type EnvVars = { [key: string]: string };
+
 interface LaunchConfig {
   name: string,
-  env?: { [key: string]: string };
+  env?: EnvVars;
 }
 
 /**
@@ -284,20 +286,6 @@ export class MirrordConfigManager {
     vscode.window.showTextDocument(doc);
   }
 
-  /**
-   * Resolves config file path specified in the launch config.
-   * @param folder workspace folder of the launch config
-   * @param path taken from the `MIRRORD_CONFIG_FILE` environment variable in launch config
-   * @returns config file Uri
-   */
-  private static processPathFromLaunchConfig(folder: vscode.WorkspaceFolder | undefined, path: string): vscode.Uri {
-    if (folder) {
-      path = path.replace(/\$\{workspaceFolder\}/g, folder.uri.fsPath);
-    }
-
-    return vscode.Uri.file(path);
-  }
-
   /**
    * Used when preparing mirrord environment for the process.
    * @param folder optional origin of the launch config
@@ -306,20 +294,17 @@ export class MirrordConfigManager {
    */
   public async resolveMirrordConfig(folder: vscode.WorkspaceFolder | undefined, config: vscode.DebugConfiguration): Promise<vscode.Uri | null> {
     if (this.active) {
+      // User has selected a config (via active config button).
       new NotificationBuilder()
         .withMessage("using active mirrord configuration")
         .withOpenFileAction(this.active)
         .withDisableAction("promptUsingActiveConfig")
         .info();
       return this.active;
-    }
-
-    let launchConfig = config.env?.["MIRRORD_CONFIG_FILE"];
-    if (typeof launchConfig === "string") {
-      return MirrordConfigManager.processPathFromLaunchConfig(folder, launchConfig);
-    }
-
-    if (folder) {
+    } else if (config.env?.["MIRRORD_CONFIG_FILE"]) {
+      // Get the config path from the env var.
+      return vscode.Uri.parse(`file://${config.env?.["MIRRORD_CONFIG_FILE"]}`, true);
+    } else if (folder) {
       let predefinedConfig = await MirrordConfigManager.getDefaultConfig(folder);
       if (predefinedConfig) {
         new NotificationBuilder()
@@ -328,24 +313,26 @@ export class MirrordConfigManager {
           .withDisableAction("promptUsingDefaultConfig")
           .warning();
         return predefinedConfig;
+      } else {
+        return null;
+      }
+    } else {
+      folder = vscode.workspace.workspaceFolders?.[0];
+      if (!folder) {
+        throw new Error("mirrord requires an open folder in the workspace");
       }
-    }
-
-    folder = vscode.workspace.workspaceFolders?.[0];
-    if (!folder) {
-      throw new Error("mirrord requires an open folder in the workspace");
-    }
 
-    let predefinedConfig = await MirrordConfigManager.getDefaultConfig(folder);
-    if (predefinedConfig) {
-      new NotificationBuilder()
-        .withMessage(`using a default mirrord config from folder ${folder.name}`)
-        .withOpenFileAction(predefinedConfig)
-        .withDisableAction("promptUsingDefaultConfig")
-        .warning();
-      return predefinedConfig;
+      let predefinedConfig = await MirrordConfigManager.getDefaultConfig(folder);
+      if (predefinedConfig) {
+        new NotificationBuilder()
+          .withMessage(`using a default mirrord config from folder ${folder.name} `)
+          .withOpenFileAction(predefinedConfig)
+          .withDisableAction("promptUsingDefaultConfig")
+          .warning();
+        return predefinedConfig;
+      } else {
+        return null;
+      }
     }
-
-    return null;
   }
 }
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		Passes the `launch.json` `env` section to `mirrord verify-config`, resolving config options that were set as env vars.