Merge branch 'topic/vscode-user-build' into 'master'

Do not check platform compatibility with external ALS env variable

Closes #1189

See merge request eng/ide/ada_language_server!1407

Author: eliericha

integration/vscode/ada/src/clients.ts

@@ -1,16 +1,16 @@
-import * as vscode from 'vscode';
 import { existsSync } from 'fs';
+import * as vscode from 'vscode';
 import {
     Disposable,
     ExecuteCommandRequest,
     LanguageClient,
     LanguageClientOptions,
     ServerOptions,
 } from 'vscode-languageclient/node';
+import { mainLogChannel } from './extension';
 import GnatTaskProvider from './gnatTaskProvider';
 import GprTaskProvider from './gprTaskProvider';
-import { getEvaluatedCustomEnv, logErrorAndThrow } from './helpers';
-import { mainLogChannel } from './extension';
+import { logErrorAndThrow } from './helpers';
 
 export class ContextClients {
     public readonly gprClient: LanguageClient;
@@ -147,18 +147,6 @@ function createClient(
     // If the extension is launched in debug mode then the debug server options are used
     // Otherwise the run options are used
 
-    // Retrieve the user's custom environment variables if specified in their
-    // settings/workspace: we'll then launch any child process with this custom
-    // environment
-    const custom_env = getEvaluatedCustomEnv();
-
-    if (custom_env) {
-        for (const var_name in custom_env) {
-            const var_value: string = custom_env[var_name];
-            process.env[var_name] = var_value;
-        }
-    }
-
     // Options to control the server
     const serverOptions: ServerOptions = {
         run: { command: serverExecPath, args: extra },

integration/vscode/ada/src/extension.ts

@@ -26,7 +26,11 @@ import { ContextClients } from './clients';
 import { registerCommands } from './commands';
 import { initializeDebugging } from './debugConfigProvider';
 import { initializeTestView } from './gnattest';
-import { assertSupportedEnvironments, getEvaluatedCustomEnv } from './helpers';
+import {
+    assertSupportedEnvironments,
+    getEvaluatedCustomEnv,
+    setCustomEnvironment,
+} from './helpers';
 
 const ADA_CONTEXT = 'ADA_PROJECT_CONTEXT';
 export let contextClients: ContextClients;
@@ -39,8 +43,6 @@ export async function activate(context: vscode.ExtensionContext): Promise<void>
     mainLogChannel = vscode.window.createOutputChannel('Ada Extension');
     mainLogChannel.appendLine('Starting Ada extension');
 
-    assertSupportedEnvironments(mainLogChannel);
-
     // Log the environment that the extension (and all VS Code) will be using
     const customEnv = getEvaluatedCustomEnv();
 
@@ -52,6 +54,13 @@ export async function activate(context: vscode.ExtensionContext): Promise<void>
         }
     }
 
+    // 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(mainLogChannel);
+
     // Create the Ada and GPR clients.
     contextClients = new ContextClients(context);
 

integration/vscode/ada/src/helpers.ts

@@ -148,7 +148,33 @@ export function getEvaluatedCustomEnv() {
     return custom_env;
 }
 
+/**
+ * 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.
+ */
+export function setCustomEnvironment() {
+    // Retrieve the user's custom environment variables if specified in their
+    // settings/workspace: we'll then launch any child process with this custom
+    // environment
+    const custom_env = getEvaluatedCustomEnv();
+
+    if (custom_env) {
+        for (const var_name in custom_env) {
+            const var_value: string = custom_env[var_name];
+            process.env[var_name] = var_value;
+        }
+    }
+}
+
 export function assertSupportedEnvironments(mainChannel: vscode.OutputChannel) {
+    if (process.env.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.
+        return;
+    }
+
     type Env = {
         arch: 'arm' | 'arm64' | 'x64';
         platform: 'win32' | 'linux' | 'darwin';