Merge branch 'topic/fix-vscode-env' into 'master'

Refactor passing environment from vscode to ALS

Closes #1191

See merge request eng/ide/ada_language_server!1417

Author: eliericha

integration/vscode/ada/src/clients.ts

@@ -10,7 +10,7 @@ import {
 import { logger } from './extension';
 import GnatTaskProvider from './gnatTaskProvider';
 import GprTaskProvider from './gprTaskProvider';
-import { logErrorAndThrow } from './helpers';
+import { logErrorAndThrow, setCustomEnvironment } from './helpers';
 import { registerTaskProviders } from './taskProviders';
 
 export class ContextClients {
@@ -145,15 +145,15 @@ function createClient(
 
     logger.debug(`Using ALS at: ${serverExecPath}`);
 
-    // The debug options for the server
-    // let debugOptions = { execArgv: [] };
-    // If the extension is launched in debug mode then the debug server options are used
-    // Otherwise the run options are used
+    // Copy this process's environment
+    const serverEnv: NodeJS.ProcessEnv = { ...process.env };
+    // Set custom environment
+    setCustomEnvironment(serverEnv);
 
     // Options to control the server
     const serverOptions: ServerOptions = {
-        run: { command: serverExecPath, args: extra },
-        debug: { command: serverExecPath, args: extra },
+        run: { command: serverExecPath, args: extra, options: { env: serverEnv } },
+        debug: { command: serverExecPath, args: extra, options: { env: serverEnv } },
     };
 
     // Options to control the language client

integration/vscode/ada/src/extension.ts

@@ -33,7 +33,6 @@ import {
     assertSupportedEnvironments,
     getCustomEnvSettingName,
     getEvaluatedCustomEnv,
-    setCustomEnvironment,
     startedInDebugMode,
 } from './helpers';
 
@@ -124,9 +123,8 @@ async function activateExtension(context: vscode.ExtensionContext) {
 
     // Log the environment that the extension (and all VS Code) will be using
     const customEnv = getEvaluatedCustomEnv();
-
     if (customEnv && Object.keys(customEnv).length > 0) {
-        logger.info('Setting environment variables:');
+        logger.info('Custom environment variables:');
         for (const varName in customEnv) {
             const varValue: string = customEnv[varName];
             logger.info(`${varName}=${varValue}`);
@@ -135,13 +133,6 @@ async function activateExtension(context: vscode.ExtensionContext) {
         logger.debug('No custom environment variables set in %s', getCustomEnvSettingName());
     }
 
-    // Set the custom environment into the current node process. This must be
-    // done before calling assertSupportedEnvironments in order to set the ALS
-    // environment variable if provided.
-    setCustomEnvironment();
-
-    assertSupportedEnvironments(logger);
-
     // Create the Ada and GPR clients.
     contextClients = new ContextClients(context);
 

integration/vscode/ada/src/helpers.ts

@@ -158,10 +158,15 @@ export function getEvaluatedCustomEnv() {
 
 /**
  * Read the environment variables specified in the vscode setting
- * `terminal.integrated.env.<os>` and set them in the current node process so
- * that they become inherited by any child processes.
+ * `terminal.integrated.env.<os>` and set them in the given ProcessEnv object.
+ *
+ * If no targetEnv is given, `process.env` is used as a target environment.
  */
-export function setCustomEnvironment() {
+export function setCustomEnvironment(targetEnv?: NodeJS.ProcessEnv) {
+    if (!targetEnv) {
+        targetEnv = process.env;
+    }
+
     // Retrieve the user's custom environment variables if specified in their
     // settings/workspace: we'll then launch any child process with this custom
     // environment
@@ -170,13 +175,17 @@ export function setCustomEnvironment() {
     if (custom_env) {
         for (const var_name in custom_env) {
             const var_value: string = custom_env[var_name];
-            process.env[var_name] = var_value;
+            targetEnv[var_name] = var_value;
         }
     }
 }
 
 export function assertSupportedEnvironments(mainChannel: winston.Logger) {
-    if (process.env.ALS) {
+    // Get the ALS environment variable from the custom environment, or from the
+    // process environment
+    const customEnv = getEvaluatedCustomEnv();
+    const als = customEnv?.ALS ?? process.env.ALS;
+    if (als) {
         // The User provided an external ALS executable. Do not perform any
         // platform support checks because we may be on an unsupported platform
         // where the User built and provided ALS.