Additional logging

Author: DonJayamanne

src/client/chat/createVirtualEnvTool.ts

@@ -21,6 +21,7 @@ import {
     getDisplayVersion,
     getEnvDetailsForResponse,
     IResourceReference,
+    isCancellationError,
     raceCancellationError,
 } from './utils';
 import { resolveFilePath } from './utils';
@@ -35,6 +36,7 @@ import { convertEnvInfoToPythonEnvironment } from '../pythonEnvironments/legacyI
 import { sortInterpreters } from '../interpreter/helpers';
 import { isStableVersion } from '../pythonEnvironments/info/pythonVersion';
 import { createVirtualEnvironment } from '../pythonEnvironments/creation/createEnvApi';
+import { traceError, traceWarn } from '../logging';
 
 export class CreateVirtualEnvTool implements LanguageModelTool<IResourceReference> {
     private readonly terminalExecutionService: TerminalCodeExecutionProvider;
@@ -64,6 +66,7 @@ export class CreateVirtualEnvTool implements LanguageModelTool<IResourceReferenc
         const resource = resolveFilePath(options.input.resourcePath);
         let info = await this.getPreferredEnvForCreation(resource);
         if (!info) {
+            traceWarn(`${CreateVirtualEnvTool.toolName} tool not invoked, no preferred environment found.`);
             return;
         }
         const { workspaceFolder, preferredGlobalPythonEnv } = info;
@@ -82,13 +85,15 @@ export class CreateVirtualEnvTool implements LanguageModelTool<IResourceReferenc
                 token,
             );
             if (!created?.path) {
+                traceWarn(`${CreateVirtualEnvTool.toolName} tool not invoked, no preferred environment found.`);
                 return;
             }
             // Wait a few secs to ensure the env is selected as the active environment..
             // If this doesn't work, then something went wrong.
             await raceTimeout(5_000, interpreterChanged);
             const env = await this.api.resolveEnvironment(created.path);
             if (!env) {
+                traceError(`${CreateVirtualEnvTool.toolName} tool not invoked, no preferred environment found.`);
                 return;
             }
             return await getEnvDetailsForResponse(
@@ -99,6 +104,16 @@ export class CreateVirtualEnvTool implements LanguageModelTool<IResourceReferenc
                 resource,
                 token,
             );
+        } catch (ex) {
+            if (!isCancellationError(ex)) {
+                traceError(
+                    `${
+                        CreateVirtualEnvTool.toolName
+                    } tool failed to create virtual environment for resource ${resource?.toString()}`,
+                    ex,
+                );
+            }
+            throw ex;
         } finally {
             disposables.dispose();
         }

src/client/chat/installPackagesTool.ts

@@ -2,7 +2,6 @@
 // Licensed under the MIT License.
 
 import {
-    CancellationError,
     CancellationToken,
     l10n,
     LanguageModelTextPart,
@@ -18,6 +17,7 @@ import {
     getEnvDisplayName,
     getToolResponseIfNotebook,
     IResourceReference,
+    isCancellationError,
     isCondaEnv,
     raceCancellationError,
 } from './utils';
@@ -74,7 +74,7 @@ export class InstallPackagesTool implements LanguageModelTool<IInstallPackageArg
             const resultMessage = `Successfully installed ${packagePlurality}: ${options.input.packageList.join(', ')}`;
             return new LanguageModelToolResult([new LanguageModelTextPart(resultMessage)]);
         } catch (error) {
-            if (error instanceof CancellationError) {
+            if (isCancellationError(error)) {
                 throw error;
             }
             const errorMessage = `An error occurred while installing ${packagePlurality}: ${error}`;

src/client/chat/selectEnvTool.ts

@@ -36,6 +36,7 @@ import { SelectEnvironmentResult } from '../interpreter/configuration/interprete
 import { Common, InterpreterQuickPickList } from '../common/utils/localize';
 import { showQuickPick } from '../common/vscodeApis/windowApis';
 import { DisposableStore } from '../common/utils/resourceLifecycle';
+import { traceError, traceVerbose, traceWarn } from '../logging';
 
 interface ISelectPythonEnvToolArguments extends IResourceReference {
     reason?: 'cancelled';
@@ -71,14 +72,29 @@ export class SelectPythonEnvTool implements LanguageModelTool<ISelectPythonEnvTo
                 }),
             )) as SelectEnvironmentResult | undefined;
             if (result?.path) {
+                traceVerbose(`User selected a Python environment ${result.path} in Select Python Tool.`);
                 selected = true;
+            } else {
+                traceWarn(`User did not select a Python environment in Select Python Tool.`);
             }
         } else {
             selected = await showCreateAndSelectEnvironmentQuickPick(resource, this.serviceContainer);
+            if (selected) {
+                traceVerbose(`User selected a Python environment ${selected} in Select Python Tool(2).`);
+            } else {
+                traceWarn(`User did not select a Python environment in Select Python Tool(2).`);
+            }
         }
         const env = selected
             ? await this.api.resolveEnvironment(this.api.getActiveEnvironmentPath(resource))
             : undefined;
+        if (selected && !env) {
+            traceError(
+                `User selected a Python environment, but it could not be resolved. This is unexpected. Environment: ${this.api.getActiveEnvironmentPath(
+                    resource,
+                )}`,
+            );
+        }
         if (selected && env) {
             return await getEnvDetailsForResponse(
                 env,