Merge branch 'topic/eng/ide/ada_language_server#1592' into 'master'

Clear cache on 'als-reload-project' command

See merge request eng/ide/ada_language_server!1898

Author: AnthonyLeonardoGracio

integration/vscode/ada/src/ExtensionState.ts

@@ -61,7 +61,7 @@ export class ExtensionState {
     private adaTaskProvider?: SimpleTaskProvider;
     private sparkTaskProvider?: SimpleTaskProvider;
 
-    public clearALSCache() {
+    private clearALSCache() {
         this.cachedProjectUri = undefined;
         this.cachedObjectDir = undefined;
         this.cachedMains = undefined;
@@ -170,10 +170,9 @@ export class ExtensionState {
             e.affectsConfiguration('ada.scenarioVariables') ||
             e.affectsConfiguration('ada.projectFile')
         ) {
-            logger.info('project related settings have changed: clearing caches for tasks');
-            this.clearALSCache();
-            this.unregisterTaskDisposables();
-            this.registerTaskDisposables();
+            this.clearCacheAndTasks(
+                'project related settings have changed: clearing caches and tasks',
+            );
         }
 
         //  React to changes made in the environment variables, showing
@@ -188,6 +187,20 @@ export class ExtensionState {
         }
     };
 
+    /**
+     * Clear the extension's cache and, unregister its predefined tasks and register them
+     * again to make sure they take into account the current extension's state
+     * (environment, loaded project...).
+     *
+     * @param msg - Log message explaning why the cache is being cleared.
+     */
+    public clearCacheAndTasks(logMsg = ''): void {
+        logger.info(logMsg);
+        this.clearALSCache();
+        this.unregisterTaskDisposables();
+        this.registerTaskDisposables();
+    }
+
     /**
      * Returns the value of the given project attribute, or raises
      * an exception when the queried attribute is not known

integration/vscode/ada/src/alsExecuteCommand.ts

@@ -39,6 +39,7 @@ import {
     alsReplaceTypeCommandExecutor,
     ReplaceTypeCommandArgs,
 } from './refactoring/alsReplaceTypeCommand';
+import { adaExtState } from './extension';
 
 /**
  * Type alias for a function that intercepts a command and executes it by return a promise that
@@ -89,6 +90,10 @@ export const alsCommandExecutor = (client: LanguageClient): CommandExecutor => {
                 args[0] as ReplaceTypeCommandArgs,
             );
             if (!proceedWithExecution) return Promise.resolve(undefined);
+        } else if (command === 'als-reload-project') {
+            // Clear the cache and the predefined tasks when the project
+            // has been reloaded.
+            adaExtState.clearCacheAndTasks('project is being reloaded: clearing caches and tasks');
         }
         // eslint-disable-next-line @typescript-eslint/no-unsafe-return
         return next(command, args);

integration/vscode/ada/test/general/extension.test.ts

@@ -68,4 +68,38 @@ suite('Extensions Test Suite', function () {
             throw new Error('No workspace folder found for the specified URI');
         }
     });
+    test('Clear Cache On Project Reload', async () => {
+        if (vscode.workspace.workspaceFolders !== undefined) {
+            // Get the workspace root folder
+            const folder = vscode.workspace.workspaceFolders[0].uri;
+
+            //  Check the object directory when 'for Object_Dir use "obj"' is present
+            // in the GPR file
+            const originalObjDir: string = await adaExtState.getObjectDir();
+            assert.strictEqual(originalObjDir, vscode.Uri.joinPath(folder, 'obj').fsPath);
+
+            // Remove the line that specifies the object directory in the GPR file
+            const fileUri = vscode.Uri.joinPath(folder, 'prj.gpr');
+            const contentBefore = readFileSync(fileUri.fsPath, 'utf-8');
+            const newContent = contentBefore.replace('    for Object_Dir use "obj";', '');
+            writeFileSync(fileUri.fsPath, newContent, 'utf-8');
+
+            // Reload the project and check the object dir value: should be set
+            // to the project's root directory (workspace directory)
+            await vscode.commands.executeCommand('als-reload-project');
+            try {
+                assert.strictEqual(await adaExtState.getObjectDir(), folder.fsPath);
+            } finally {
+                // Restore the old GPR file contents
+                writeFileSync(fileUri.fsPath, contentBefore);
+            }
+
+            // Reload the project to its original state, and check that
+            // the object directory is back to its original value too.
+            await vscode.commands.executeCommand('als-reload-project');
+            assert.strictEqual(await adaExtState.getObjectDir(), originalObjDir);
+        } else {
+            throw new Error('No workspace folder found for the specified URI');
+        }
+    });
 });