Enhance logging in task execution functions for better debugging (#730)

Author: eleanorjboyd

src/features/execution/runAsTask.ts

@@ -9,6 +9,7 @@ import {
     WorkspaceFolder,
 } from 'vscode';
 import { PythonEnvironment, PythonTaskExecutionOptions } from '../../api';
+import { traceInfo } from '../../common/logging';
 import { executeTask } from '../../common/tasks.apis';
 import { getWorkspaceFolder } from '../../common/workspace.apis';
 import { quoteArg } from './execUtils';
@@ -29,6 +30,7 @@ export async function runAsTask(
     executable = quoteArg(executable);
     const args = environment.execInfo?.activatedRun?.args ?? environment.execInfo?.run.args ?? [];
     const allArgs = [...args, ...options.args];
+    traceInfo(`Running as task: ${executable} ${allArgs.join(' ')}`);
 
     const task = new Task(
         { type: 'python' },

src/features/execution/runInBackground.ts

@@ -1,5 +1,6 @@
 import * as cp from 'child_process';
-import { PythonEnvironment, PythonBackgroundRunOptions, PythonProcess } from '../../api';
+import { PythonBackgroundRunOptions, PythonEnvironment, PythonProcess } from '../../api';
+import { traceError, traceInfo } from '../../common/logging';
 
 export async function runInBackground(
     environment: PythonEnvironment,
@@ -9,6 +10,7 @@ export async function runInBackground(
         environment.execInfo?.activatedRun?.executable ?? environment.execInfo?.run.executable ?? 'python';
     const args = environment.execInfo?.activatedRun?.args ?? environment.execInfo?.run.args ?? [];
     const allArgs = [...args, ...options.args];
+    traceInfo(`Running in background: ${executable} ${allArgs.join(' ')}`);
 
     const proc = cp.spawn(executable, allArgs, { stdio: 'pipe', cwd: options.cwd, env: options.env });
 
@@ -22,8 +24,17 @@ export async function runInBackground(
                 proc.kill();
             }
         },
-        onExit: (listener: (code: number | null, signal: NodeJS.Signals | null) => void) => {
-            proc.on('exit', listener);
+        onExit: (listener: (code: number | null, signal: NodeJS.Signals | null, error?: Error | null) => void) => {
+            proc.on('exit', (code, signal) => {
+                if (code && code !== 0) {
+                    traceError(`Process exited with error code: ${code}, signal: ${signal}`);
+                }
+                listener(code, signal, null);
+            });
+            proc.on('error', (error) => {
+                traceError(`Process error: ${error?.message || error}${error?.stack ? '\n' + error.stack : ''}`);
+                listener(null, null, error);
+            });
         },
     };
 }