Fix runtime env var inheritence in existing powershell terminals

Author: pimterry

src/interceptors/docker/docker-build-injection.ts

@@ -44,7 +44,7 @@ export function injectIntoBuildStream(
         envVars: getTerminalEnvVars(
             config.proxyPort,
             { certPath: HTTP_TOOLKIT_INJECTED_CA_PATH },
-            'runtime-inherit', // Dockerfile commands can reference vars directly
+            'posix-runtime-inherit', // Dockerfile commands can reference vars directly
             {
                 httpToolkitIp: DOCKER_HOST_HOSTNAME,
                 overridePath: HTTP_TOOLKIT_INJECTED_OVERRIDES_PATH,

src/interceptors/terminal/existing-terminal-interceptor.ts

@@ -81,25 +81,27 @@ export class ExistingTerminalInterceptor implements Interceptor {
         const server = getLocal();
         await server.start({ startPort: proxyPort + 1, endPort: 65535 });
 
-        const envVars = getTerminalEnvVars(proxyPort, this.config.https, 'runtime-inherit', {});
-
         const serverState = { server, isActive: false };
 
+        const posixEnvVars = getTerminalEnvVars(proxyPort, this.config.https, 'posix-runtime-inherit', {});
+
         // Endpoints for each of the various setup scripts:
         await server.forGet('/setup').thenReply(200,
-            getBashShellScript(server.urlFor('/success'), envVars),
+            getBashShellScript(server.urlFor('/success'), posixEnvVars),
             { "content-type": "text/x-shellscript" }
         );
         await server.forGet('/gb-setup').thenReply(200,
-            getGitBashShellScript(server.urlFor('/success'), envVars),
+            getGitBashShellScript(server.urlFor('/success'), posixEnvVars),
             { "content-type": "text/x-shellscript" }
         );
         await server.forGet('/fish-setup').thenReply(200,
-            getFishShellScript(server.urlFor('/success'), envVars),
+            getFishShellScript(server.urlFor('/success'), posixEnvVars),
             { "content-type": "application/x-fish" }
         );
+
+        const powerShellEnvVars = getTerminalEnvVars(proxyPort, this.config.https, 'powershell-runtime-inherit', {});
         await server.forGet('/ps-setup').thenReply(200,
-            getPowerShellScript(server.urlFor('/success'), envVars),
+            getPowerShellScript(server.urlFor('/success'), powerShellEnvVars),
             { "content-type": "text/plain" }
         );
 

src/interceptors/terminal/terminal-env-overrides.ts

@@ -20,7 +20,10 @@ export const OVERRIDE_JAVA_AGENT = path.join(OVERRIDES_DIR, JAVA_AGENT_JAR);
 export function getTerminalEnvVars(
     proxyPort: number,
     httpsConfig: { certPath: string },
-    currentEnv: { [key: string]: string | undefined } | 'runtime-inherit',
+    currentEnv:
+        | { [key: string]: string | undefined }
+        | 'posix-runtime-inherit'
+        | 'powershell-runtime-inherit',
     targetEnvConfig: {
         httpToolkitIp?: string,
         overridePath?: string,
@@ -34,6 +37,17 @@ export function getTerminalEnvVars(
         ...targetEnvConfig
     };
 
+    const runtimeInherit = currentEnv === 'posix-runtime-inherit'
+            ? (varName: string) => `$${varName}`
+        : currentEnv === 'powershell-runtime-inherit'
+            ? ((varName: string) => `$env:${varName}`)
+        : undefined;
+    currentEnv = (runtimeInherit
+        ? {} // Reset the env if we're using runtime inheritance:
+        // Or use the real values we were given if not:
+        : currentEnv
+    ) as { [key: string]: string | undefined };
+
     const pathVarSeparator = targetPlatform === 'win32' ? ';' : ':';
     const joinPath = targetPlatform === 'win32' ? path.win32.join : path.posix.join;
 
@@ -96,33 +110,33 @@ export function getTerminalEnvVars(
 
         // Prepend our bin overrides into $PATH
         'PATH': `${binPath}${pathVarSeparator}${
-            currentEnv == 'runtime-inherit' ? '$PATH' : currentEnv.PATH
+            runtimeInherit ? runtimeInherit('PATH') : currentEnv.PATH
         }`,
 
         // Prepend our Ruby gem overrides into $LOAD_PATH
-        'RUBYLIB': currentEnv === 'runtime-inherit'
-                ? `${rubyGemsPath}:$RUBYLIB`
+        'RUBYLIB': runtimeInherit
+                ? `${rubyGemsPath}:${runtimeInherit('RUBYLIB')}`
             : !!currentEnv.RUBYLIB
                 ? `${rubyGemsPath}:${currentEnv.RUBYLIB}`
             : rubyGemsPath,
 
         // Prepend our Python package overrides into $PYTHONPATH
-        'PYTHONPATH': currentEnv === 'runtime-inherit'
-                ? `${pythonPath}:$PYTHONPATH`
+        'PYTHONPATH': runtimeInherit
+                ? `${pythonPath}:${runtimeInherit('PYTHONPATH')}`
             : currentEnv.PYTHONPATH
                 ? `${pythonPath}:${currentEnv.PYTHONPATH}`
             : pythonPath,
 
         // We use $NODE_OPTIONS to prepend our script into node. Notably this drops existing
         // env values, when using our env, because _our_ NODE_OPTIONS aren't meant for
         // subprocesses. Otherwise e.g. --max-http-header-size breaks old Node/Electron.
-        'NODE_OPTIONS': currentEnv === 'runtime-inherit'
-            ? `$NODE_OPTIONS ${nodePrependOption}`
+        'NODE_OPTIONS': runtimeInherit
+            ? `${runtimeInherit('NODE_OPTIONS')} ${nodePrependOption}`
             : nodePrependOption,
 
         // Attach our Java agent to all launched Java processes:
-        'JAVA_TOOL_OPTIONS': currentEnv === 'runtime-inherit'
-                ? `$JAVA_TOOL_OPTIONS ${javaAgentOption}`
+        'JAVA_TOOL_OPTIONS': runtimeInherit
+                ? `${runtimeInherit('JAVA_TOOL_OPTIONS')} ${javaAgentOption}`
             : currentEnv.JAVA_TOOL_OPTIONS
                 ? `${currentEnv.JAVA_TOOL_OPTIONS} ${javaAgentOption}`
             : javaAgentOption,