Add a getSourceDirs function helper

To encapsulate the 'als-source-dirs' LSP request.

For eng/ide/ada_language_server#1515

Author: AnthonyLeonardoGracio

integration/vscode/ada/src/ExtensionState.ts

@@ -25,6 +25,14 @@ import {
 } from './taskProviders';
 import { isAbsolute } from 'path';
 
+/**
+ * Return type of the 'als-source-dirs' LSP request.
+ */
+export type ALSSourceDirDescription = {
+    name: string;
+    uri: string;
+};
+
 /**
  * This class encapsulates all state that should be maintained throughout the
  * lifecyle of the extension. This includes e.g. the Ada and GPR LSP clients,
@@ -56,6 +64,7 @@ export class ExtensionState {
      */
     cachedProjectUri: vscode.Uri | undefined;
     cachedObjectDir: string | undefined;
+    cachedSourceDirs: ALSSourceDirDescription[] | undefined;
     cachedTargetPrefix: string | undefined;
     cachedMains: string[] | undefined;
     cachedExecutables: string[] | undefined;
@@ -68,6 +77,7 @@ export class ExtensionState {
     private clearALSCache() {
         this.cachedProjectUri = undefined;
         this.cachedObjectDir = undefined;
+        this.cachedSourceDirs = undefined;
         this.cachedTargetPrefix = undefined;
         this.cachedMains = undefined;
         this.cachedExecutables = undefined;
@@ -381,6 +391,20 @@ export class ExtensionState {
         return this.cachedObjectDir;
     }
 
+    /**
+     *
+     * @returns the list of source directorues defined in the project loaded by the ALS
+     */
+    public async getSourceDirs(): Promise<ALSSourceDirDescription[]> {
+        if (this.cachedSourceDirs === undefined) {
+            this.cachedSourceDirs = (await this.adaClient.sendRequest(ExecuteCommandRequest.type, {
+                command: 'als-source-dirs',
+            })) as ALSSourceDirDescription[];
+        }
+
+        return this.cachedSourceDirs;
+    }
+
     /**
      *
      * @returns the list of full paths of main sources defined in the project from the ALS

integration/vscode/ada/src/commands.ts

@@ -5,7 +5,7 @@ import * as vscode from 'vscode';
 import { SymbolKind, commands } from 'vscode';
 import { Disposable } from 'vscode-jsonrpc';
 import { ExecuteCommandRequest } from 'vscode-languageclient';
-import { ExtensionState } from './ExtensionState';
+import { ALSSourceDirDescription, ExtensionState } from './ExtensionState';
 import { AdaConfig, getOrAskForProgram, initializeConfig } from './debugConfigProvider';
 import { adaExtState, logger, mainOutputChannel } from './extension';
 import { findAdaMain, getProjectFileRelPath, getSymbols } from './helpers';
@@ -464,7 +464,6 @@ export async function checkSrcDirectories(atStartup = false, displayYesNoPopup =
     };
 
     const foldersInSettings = vscode.workspace.getConfiguration().get('folders');
-    const alsClient = adaExtState.adaClient;
     const doNotShowAgainKey = 'ada.addMissingDirsToWorkspace.doNotShowAgain';
     const doNotShowAgain = adaExtState.context.workspaceState.get(doNotShowAgainKey);
 
@@ -473,13 +472,7 @@ export async function checkSrcDirectories(atStartup = false, displayYesNoPopup =
     //  triggered at startup while the user previously clicked on the
     //  'Don't show again' button for this workspace
     if (foldersInSettings === undefined && !(atStartup && doNotShowAgain)) {
-        const sourceDirs: ALSSourceDirDescription[] = (await alsClient.sendRequest(
-            ExecuteCommandRequest.type,
-            {
-                command: 'als-source-dirs',
-            },
-        )) as ALSSourceDirDescription[];
-
+        const sourceDirs: ALSSourceDirDescription[] = await adaExtState.getSourceDirs();
         const isSubdirectory = (dir: string, parent: string) => {
             //  Use lower-case on Windows since drives can be specified in VS Code
             //  either with lower or upper case characters.