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

Improve logging of environment in vscode

See merge request eng/ide/ada_language_server!1426

Author: eliericha

.vscode/launch.json

@@ -28,7 +28,7 @@
             // "${workspaceFolder}/../als-rt"
             // "${workspaceFolder}/integration/vscode/ada/test/TestWorkspace"
          ],
-         "preLaunchTask": "npm: compile",
+         "preLaunchTask": "npm: watch - integration/vscode/ada",
          "env": {
             // This is necessary to make the "child" vscode inherit the PATH
             // variable set in the workspace settings. Without it in some setups
@@ -69,7 +69,7 @@
             "MOCHA_TIMEOUT": "0",
             "MOCHA_ALS_UPDATE": "${input:updateTestRefs}"
          },
-         "preLaunchTask": "npm: pretest",
+         "preLaunchTask": "npm: pretest - integration/vscode/ada",
          "internalConsoleOptions": "openOnSessionStart"
       },
       {
@@ -103,7 +103,7 @@
             "MOCHA_TIMEOUT": "0",
             "MOCHA_ALS_UPDATE": "${input:updateTestRefs}"
          },
-         "preLaunchTask": "npm: pretest",
+         "preLaunchTask": "npm: pretest - integration/vscode/ada",
          // Switch to Debug Console to see test results
          "internalConsoleOptions": "openOnSessionStart"
       },

.vscode/tasks.json

@@ -19,39 +19,6 @@
          "problemMatcher": ["$ada"],
          "group": "test"
       },
-      {
-         "type": "npm",
-         "script": "compile",
-         "path": "integration/vscode/ada",
-         "group": "build",
-         "problemMatcher": ["$tsc"],
-         "label": "npm: compile",
-         "detail": "node ./node_modules/typescript/bin/tsc",
-         "presentation": {
-            "echo": true,
-            "reveal": "silent",
-            "focus": false,
-            "panel": "shared",
-            "showReuseMessage": true,
-            "clear": false
-         }
-      },
-      {
-         "type": "npm",
-         "script": "pretest",
-         "path": "integration/vscode/ada",
-         "problemMatcher": [],
-         "label": "npm: pretest",
-         "detail": "npm run compile",
-         "presentation": {
-            "echo": true,
-            "reveal": "silent",
-            "focus": false,
-            "panel": "shared",
-            "showReuseMessage": true,
-            "clear": false
-         }
-      },
       {
          "type": "shell",
          "label": "ada: Compile current file",
@@ -79,8 +46,25 @@
          }
       },
       {
-         "type": "gnat",
-         "taskKind": "checkFile",
+         // This task starts a background npm process that monitors changes to
+         // TS files and recompiles them as needed. It is configured to be run
+         // before the (vscode)-based launch configurations to make sure the TS
+         // files are compiled and re-compiled upon changes.
+         "type": "npm",
+         "script": "watch",
+         "path": "integration/vscode/ada",
+         "group": "build",
+         "problemMatcher": ["$tsc-watch"],
+         "label": "npm: watch - integration/vscode/ada",
+         "detail": "node ./node_modules/typescript/bin/tsc -watch",
+         "isBackground": true
+      },
+      {
+         "type": "ada",
+         "configuration": {
+            "kind": "checkFile",
+            "projectFile": "${config:ada.projectFile}"
+         },
          "problemMatcher": ["$ada"],
          "group": "build",
          "label": "ada: Check current file"

integration/vscode/ada/src/clients.ts

@@ -50,13 +50,21 @@ export function createClient(
         }
     }
 
-    logger.debug(`Using ALS at: ${serverExecPath}`);
+    logger.info(`Using ALS at: ${serverExecPath}`);
 
     // Copy this process's environment
     const serverEnv: NodeJS.ProcessEnv = { ...process.env };
     // Set custom environment
     setCustomEnvironment(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 } },

integration/vscode/ada/src/extension.ts

@@ -110,7 +110,7 @@ class VSCodeOutputChannelTransport extends Transport {
 }
 
 export async function activate(context: vscode.ExtensionContext): Promise<void> {
-    setUpLogging();
+    setUpLogging(context);
 
     logger.info('Starting Ada extension');
 
@@ -130,7 +130,7 @@ 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('Custom environment variables:');
+        logger.info(`Custom environment variables from ${getCustomEnvSettingName()}`);
         for (const varName in customEnv) {
             const varValue: string = customEnv[varName];
             logger.info(`${varName}=${varValue}`);
@@ -155,22 +155,27 @@ async function activateExtension(context: vscode.ExtensionContext) {
         vscode.workspace.onDidChangeConfiguration(adaExtState.configChanged)
     );
 
+    /**
+     * Register commands first so that commands such as displaying the extension
+     * Output become available even if the language servers fail to start.
+     */
+    registerCommands(context, adaExtState);
+
     await Promise.all([adaExtState.adaClient.onReady(), adaExtState.gprClient.onReady()]);
 
     await vscode.commands.executeCommand('setContext', ADA_CONTEXT, true);
 
-    await checkSrcDirectories(adaExtState.adaClient);
-
     await initializeTestView(context, adaExtState);
 
-    await Promise.all([adaExtState.adaClient.onReady(), adaExtState.gprClient.onReady()]);
-
     initializeDebugging(context);
 
-    registerCommands(context, adaExtState);
+    /**
+     * This can display a dialog to the User so don't wait on the result.
+     */
+    void checkSrcDirectories(adaExtState.adaClient);
 }
 
-function setUpLogging() {
+function setUpLogging(context: vscode.ExtensionContext) {
     // Create an output channel for the extension. There are dedicated channels
     // for the Ada and Gpr language servers, and this one is a general channel
     // for non-LSP features of the extension.
@@ -204,6 +209,21 @@ function setUpLogging() {
         })
     );
 
+    /**
+     * Set logging level according to configuration
+     */
+    updateLogLevel();
+    /**
+     * Listen to configuration changes and update the transport level
+     */
+    context.subscriptions.push(
+        vscode.workspace.onDidChangeConfiguration((e) => {
+            if (e.affectsConfiguration('ada.trace.server')) {
+                updateLogLevel();
+            }
+        })
+    );
+
     if (startedInDebugMode()) {
         // In debug mode, print log messages to the console with colors. Use
         // level 'debug' for more verbosity.
@@ -218,6 +238,17 @@ function setUpLogging() {
             })
         );
     }
+
+    function updateLogLevel() {
+        /**
+         * Decide the log level from configuration.
+         */
+        const adaTraceServer: 'off' | 'messages' | 'verbose' =
+            vscode.workspace.getConfiguration('ada').get('trace.server') ?? 'off';
+        const logLevel: 'info' | 'debug' = adaTraceServer == 'off' ? 'info' : 'debug';
+        logger.transports.forEach((t) => (t.level = logLevel));
+        logger.info('Setting log level to: ' + logLevel);
+    }
 }
 
 export async function deactivate() {