Add commands to restart Ada/GPR language servers

AnthonyLeonardoGracio · AnthonyLeonardoGracio · commit 3d1b78b686d1 · 2025-02-27T17:07:54.000Z
And a basic test that executes them.

For eng/ide/ada_language_server#1520
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -19,6 +19,7 @@ section below it for the last release. -->
   been added, all available under the `File->New File...` menu
 * Add VS Code command `ada: GNATcoverage - Load an existing XML coverage report` for importing coverage reports
 * Support running GNATtest tests in coverage mode
+* Add command to restart the Ada Language Server instances
 
 ## 26.0.202412190
 
diff --git a/integration/vscode/ada/package.json b/integration/vscode/ada/package.json
@@ -780,6 +780,11 @@
             }
         ],
         "commands": [
+            {
+                "command": "ada.restartLanguageServers",
+                "title": "Ada: Restart Language Servers",
+                "when": "ADA_PROJECT_CONTEXT"
+            },
             {
                 "command": "ada.createNewAdaMainUnit",
                 "title": "Ada: Create Main Unit",
diff --git a/integration/vscode/ada/src/ExtensionState.ts b/integration/vscode/ada/src/ExtensionState.ts
@@ -3,10 +3,9 @@ import {
     Disposable,
     ExecuteCommandParams,
     ExecuteCommandRequest,
-    LanguageClient,
 } from 'vscode-languageclient/node';
 import { AdaCodeLensProvider } from './AdaCodeLensProvider';
-import { createClient } from './clients';
+import { AdaLanguageClient, createClient } from './clients';
 import { AdaInitialDebugConfigProvider, initializeDebugging } from './debugConfigProvider';
 import { logger } from './extension';
 import { existsSync } from 'fs';
@@ -43,8 +42,8 @@ export type ALSSourceDirDescription = {
  * wherever needed.
  */
 export class ExtensionState {
-    public readonly adaClient: LanguageClient;
-    public readonly gprClient: LanguageClient;
+    public readonly adaClient: AdaLanguageClient;
+    public readonly gprClient: AdaLanguageClient;
     public readonly context: vscode.ExtensionContext;
     public readonly dynamicDebugConfigProvider: {
         provideDebugConfigurations(
diff --git a/integration/vscode/ada/src/clients.ts b/integration/vscode/ada/src/clients.ts
@@ -9,7 +9,14 @@ import {
 import { logger } from './extension';
 import { logErrorAndThrow, setTerminalEnvironment } from './helpers';
 
-class AdaLanguageClient extends LanguageClient {
+export class AdaLanguageClient extends LanguageClient {
+    /**
+     * Used to store the client's process environment.
+     * Changes are taken into account when calling the
+     * {@link vscode.LanguageClient.restart} function.
+     */
+    public serverEnv: NodeJS.ProcessEnv = {};
+
     /**
      * Override this function to avoid displaying popup notifications on LSP errors when
      * the 'showNotificationsOnErrors' setting is disabled.
@@ -29,14 +36,29 @@ class AdaLanguageClient extends LanguageClient {
 
         return super.handleFailedRequest(type, token, error, defaultValue, showNotification);
     }
+
+    /**
+     * Override this function to update the client's process environment according to
+     * VS Code settings before restarting it.
+     */
+    override restart(): Promise<void> {
+        // Update the process environment before restarting the language servers, so
+        // that potential changes in VS Code settings related to the environment are
+        // taken into account.
+        setTerminalEnvironment(this.serverEnv);
+
+        // Restart the server
+        logger.info('Restarting language server: ' + this.name);
+        return super.restart();
+    }
 }
 export function createClient(
     context: vscode.ExtensionContext,
     id: string,
     name: string,
     extra: string[],
     pattern: string,
-) {
+): AdaLanguageClient {
     let serverExecPath: string;
 
     // If the ALS environment variable is specified, use it as the path of the
@@ -91,14 +113,6 @@ export function createClient(
     // Set custom environment
     setTerminalEnvironment(serverEnv);
 
-    logger.debug(`Environment for ${name}:`);
-    for (const key in serverEnv) {
-        const value = serverEnv[key];
-        if (value) {
-            logger.debug(`${key}=${value}`);
-        }
-    }
-
     // Options to control the server
     const serverOptions: ServerOptions = {
         run: { command: serverExecPath, args: extra, options: { env: serverEnv } },
@@ -119,5 +133,7 @@ export function createClient(
         initializationOptions: () => ({ ada: vscode.workspace.getConfiguration('ada') }),
     };
     // Create the language client
-    return new AdaLanguageClient(id, name, serverOptions, clientOptions);
+    const client = new AdaLanguageClient(id, name, serverOptions, clientOptions);
+    client.serverEnv = serverEnv;
+    return client;
 }
diff --git a/integration/vscode/ada/src/commands.ts b/integration/vscode/ada/src/commands.ts
@@ -87,6 +87,9 @@ export const CMD_SPARK_LIMIT_REGION_ARG = 'ada.spark.limitRegionArg';
 export const CMD_SPARK_PROVE_SUBP = 'ada.spark.proveSubprogram';
 
 export function registerCommands(context: vscode.ExtensionContext, clients: ExtensionState) {
+    context.subscriptions.push(
+        vscode.commands.registerCommand('ada.restartLanguageServers', restartLanguageServers),
+    );
     context.subscriptions.push(
         vscode.commands.registerCommand('ada.createHelloWorldProject', createHelloWorldProject),
     );
@@ -467,6 +470,24 @@ async function buildAndRunMainAsk() {
     }
 }
 
+/**
+ * Handler for commands that restart language servers launched by the extension.
+ *
+ */
+async function restartLanguageServers() {
+    logger.info('Restarting language servers, updating the process environment first...');
+
+    // Restart the language server clients
+    for (const client of [adaExtState.adaClient, adaExtState.gprClient]) {
+        await client.restart();
+    }
+
+    //  Clear the extension's cache and tasks after restarting the servers
+    adaExtState.clearCacheAndTasks(
+        'Language servers have been restarted, clearing cache and tasks',
+    );
+}
+
 /**
  * Handler for commands that create new files.
  * This function creates a new editor for the given language, focus it,
diff --git a/integration/vscode/ada/src/helpers.ts b/integration/vscode/ada/src/helpers.ts
@@ -203,6 +203,14 @@ export function setTerminalEnvironment(
             }
         }
     }
+
+    logger.debug(`New process environment after update:`);
+    for (const key in targetEnv) {
+        const value = targetEnv[key];
+        if (value) {
+            logger.debug(`${key}=${value}`);
+        }
+    }
 }
 
 export function assertSupportedEnvironments(mainChannel: winston.Logger) {
diff --git a/integration/vscode/ada/test/general/extension.test.ts b/integration/vscode/ada/test/general/extension.test.ts
@@ -1,6 +1,6 @@
 import * as assert from 'assert';
 import { adaExtState } from '../../src/extension';
-import { getObjectDir } from '../../src/helpers';
+import { getObjectDir, TERMINAL_ENV_SETTING_NAME } from '../../src/helpers';
 import { activate, assertEqualToFileContent } from '../utils';
 
 import { readFileSync, writeFileSync } from 'fs';
@@ -107,6 +107,72 @@ suite('Extensions Test Suite', function () {
         }
     });
 
+    test('Restart Language Server Commands', async () => {
+        if (vscode.workspace.workspaceFolders !== undefined) {
+            const initialEnvSettings = vscode.workspace
+                .getConfiguration()
+                .get(TERMINAL_ENV_SETTING_NAME);
+
+            try {
+                // Update the environment ARCHIVE_SUFFIX environment variable which
+                // controls the 'Archive_Suffix' GPR project attribute of the test
+                // workspace's project.
+
+                await vscode.workspace.getConfiguration().update(
+                    TERMINAL_ENV_SETTING_NAME,
+                    {
+                        ...(initialEnvSettings ?? {}),
+                        ARCHIVE_SUFFIX: '.b',
+                    },
+                    vscode.ConfigurationTarget.Workspace,
+                );
+
+                // Check that the 'Archive_Suffix' project attribute to
+                // make sure it's set to its default value ('.a') before setting
+                // the ARCHIVE_SUFFIX environment variable to '.b'.
+                assert.strictEqual(
+                    await adaExtState.getProjectAttributeValue('Archive_Suffix'),
+                    '.a',
+                    'Environment updates were not taken into account when restarting ALS',
+                );
+
+                // Restart the server and check that we still have the same project
+                // loaded on ALS side
+                const oldAlsUri = await adaExtState.getProjectUri();
+                await vscode.commands.executeCommand('ada.restartLanguageServers');
+                const newAlsUri = await adaExtState.getProjectUri();
+                assert.deepStrictEqual(
+                    oldAlsUri?.fsPath,
+                    newAlsUri?.fsPath,
+                    'Wrong project URI received after Ada server restarted',
+                );
+
+                // Check that environment updates are taken into account after restarting:
+                // 'Archive_Suffix' GPR project attribute should now be equal to '.b'
+                assert.strictEqual(
+                    await adaExtState.getProjectAttributeValue('Archive_Suffix'),
+                    '.b',
+                    'Environment updates were not taken into account when restarting ALS',
+                );
+
+                // Check that the GPR server runs correctly after restarting it
+                assert.ok(
+                    adaExtState.gprClient.isRunning(),
+                    'The ALS instance for GPR files should be running after restarting it',
+                );
+            } finally {
+                // Restore the terminal.integrate.env.* settings for the workspace
+                await vscode.workspace
+                    .getConfiguration()
+                    .update(
+                        TERMINAL_ENV_SETTING_NAME,
+                        undefined,
+                        vscode.ConfigurationTarget.Workspace,
+                    );
+            }
+        }
+    });
+
     test('Clear Cache On Project Reload', async () => {
         if (vscode.workspace.workspaceFolders !== undefined) {
             // Get the workspace root folder
diff --git a/integration/vscode/ada/test/general/ws/prj.gpr b/integration/vscode/ada/test/general/ws/prj.gpr
@@ -23,4 +23,9 @@ project Prj is
       for Excluded_Project_Files use ("prj.gpr");
    end Documentation;
 
+   --  This is only used to test that environment updates are taken into
+   --  account when restarting language servers.
+   Archive_Suffix_Var := external ("ARCHIVE_SUFFIX", ".a");
+   for Archive_Suffix use Archive_Suffix_Var;
+
 end Prj;
diff --git a/integration/vscode/ada/test/general/ws/prj.gpr.snap b/integration/vscode/ada/test/general/ws/prj.gpr.snap
@@ -166,6 +166,42 @@
 #       ^^^^^^^^^^^^^ source.gpr meta.project.gpr meta.package.gpr entity.name.package.gpr
 #                    ^ source.gpr meta.project.gpr meta.package.gpr punctuation.gpr
 >
+>   --  This is only used to test that environment updates are taken into
+#^^^ source.gpr meta.project.gpr
+#   ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ source.gpr meta.project.gpr comment.line.double-dash.gpr
+>   --  account when restarting language servers.
+#^^^ source.gpr meta.project.gpr
+#   ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ source.gpr meta.project.gpr comment.line.double-dash.gpr
+>   Archive_Suffix_Var := external ("ARCHIVE_SUFFIX", ".a");
+#^^^ source.gpr meta.project.gpr
+#   ^^^^^^^^^^^^^^^^^^ source.gpr meta.project.gpr meta.declaration.variable.gpr variable.name.gpr entity.name.gpr
+#                     ^ source.gpr meta.project.gpr meta.declaration.variable.gpr
+#                      ^^ source.gpr meta.project.gpr meta.declaration.variable.gpr meta.assignment.gpr punctuation.gpr
+#                        ^ source.gpr meta.project.gpr meta.declaration.variable.gpr meta.assignment.gpr
+#                         ^^^^^^^^ source.gpr meta.project.gpr meta.declaration.variable.gpr meta.assignment.gpr meta.external.gpr variable.language.gpr
+#                                 ^ source.gpr meta.project.gpr meta.declaration.variable.gpr meta.assignment.gpr meta.external.gpr
+#                                  ^ source.gpr meta.project.gpr meta.declaration.variable.gpr meta.assignment.gpr meta.external.gpr meta.string_list.gpr punctuation.gpr
+#                                   ^ source.gpr meta.project.gpr meta.declaration.variable.gpr meta.assignment.gpr meta.external.gpr meta.string_list.gpr string.quoted.double.gpr punctuation.definition.string.gpr
+#                                    ^^^^^^^^^^^^^^ source.gpr meta.project.gpr meta.declaration.variable.gpr meta.assignment.gpr meta.external.gpr meta.string_list.gpr string.quoted.double.gpr
+#                                                  ^ source.gpr meta.project.gpr meta.declaration.variable.gpr meta.assignment.gpr meta.external.gpr meta.string_list.gpr string.quoted.double.gpr punctuation.definition.string.gpr
+#                                                   ^ source.gpr meta.project.gpr meta.declaration.variable.gpr meta.assignment.gpr meta.external.gpr meta.string_list.gpr punctuation.gpr
+#                                                    ^ source.gpr meta.project.gpr meta.declaration.variable.gpr meta.assignment.gpr meta.external.gpr meta.string_list.gpr
+#                                                     ^ source.gpr meta.project.gpr meta.declaration.variable.gpr meta.assignment.gpr meta.external.gpr meta.string_list.gpr string.quoted.double.gpr punctuation.definition.string.gpr
+#                                                      ^^ source.gpr meta.project.gpr meta.declaration.variable.gpr meta.assignment.gpr meta.external.gpr meta.string_list.gpr string.quoted.double.gpr
+#                                                        ^ source.gpr meta.project.gpr meta.declaration.variable.gpr meta.assignment.gpr meta.external.gpr meta.string_list.gpr string.quoted.double.gpr punctuation.definition.string.gpr
+#                                                         ^ source.gpr meta.project.gpr meta.declaration.variable.gpr meta.assignment.gpr meta.external.gpr meta.string_list.gpr punctuation.gpr
+#                                                          ^ source.gpr meta.project.gpr meta.declaration.variable.gpr punctuation.gpr
+>   for Archive_Suffix use Archive_Suffix_Var;
+#^^^ source.gpr meta.project.gpr
+#   ^^^ source.gpr meta.project.gpr meta.attribute.gpr keyword.gpr
+#      ^ source.gpr meta.project.gpr meta.attribute.gpr
+#       ^^^^^^^^^^^^^^ source.gpr meta.project.gpr meta.attribute.gpr entity.other.attribute-name.gpr
+#                     ^ source.gpr meta.project.gpr meta.attribute.gpr
+#                      ^^^ source.gpr meta.project.gpr meta.attribute.gpr keyword.gpr
+#                         ^ source.gpr meta.project.gpr meta.attribute.gpr
+#                          ^^^^^^^^^^^^^^^^^^ source.gpr meta.project.gpr meta.attribute.gpr variable.name.gpr
+#                                            ^ source.gpr meta.project.gpr meta.attribute.gpr punctuation.gpr
+>
 >end Prj;
 #^^^ source.gpr meta.project.gpr keyword.gpr
 #   ^ source.gpr meta.project.gpr

Original file line number	Diff line number	Diff line change
`@@ -780,6 +780,11 @@`
`780`	`780`	`}`
`781`	`781`	`],`
`782`	`782`	`"commands": [`
	`783`	`+ {`
	`784`	`+ "command": "ada.restartLanguageServers",`
	`785`	`+ "title": "Ada: Restart Language Servers",`
	`786`	`+ "when": "ADA_PROJECT_CONTEXT"`
	`787`	`+ },`
`783`	`788`	`{`
`784`	`789`	`"command": "ada.createNewAdaMainUnit",`
`785`	`790`	`"title": "Ada: Create Main Unit",`
Original file line number	Diff line number	Diff line change
`@@ -203,6 +203,14 @@ export function setTerminalEnvironment(`
`203`	`203`	`}`
`204`	`204`	`}`
`205`	`205`	`}`
	`206`	`+`
	`207`	+ logger.debug(`New process environment after update:`);
	`208`	`+ for (const key in targetEnv) {`
	`209`	`+ const value = targetEnv[key];`
	`210`	`+ if (value) {`
	`211`	+ logger.debug(`${key}=${value}`);
	`212`	`+ }`
	`213`	`+ }`
`206`	`214`	`}`
`207`	`215`
`208`	`216`	`export function assertSupportedEnvironments(mainChannel: winston.Logger) {`