Add more logging

Author: paulacamargo25

src/extension/debugger/configuration/launch.json/launchJsonReader.ts

@@ -6,15 +6,18 @@ import * as fs from 'fs-extra';
 import { parse } from 'jsonc-parser';
 import { DebugConfiguration, Uri, WorkspaceFolder } from 'vscode';
 import { getConfiguration, getWorkspaceFolder } from '../../../common/vscodeapi';
+import { traceLog } from '../../../common/log/logging';
 
 export async function getConfigurationsForWorkspace(workspace: WorkspaceFolder): Promise<DebugConfiguration[]> {
+    traceLog('Getting configurations for workspace');
     const filename = path.join(workspace.uri.fsPath, '.vscode', 'launch.json');
     if (!(await fs.pathExists(filename))) {
         // Check launch config in the workspace file
         const codeWorkspaceConfig = getConfiguration('launch', workspace);
         if (!codeWorkspaceConfig.configurations || !Array.isArray(codeWorkspaceConfig.configurations)) {
             return [];
         }
+        traceLog('Using configuration in workspace');
         return codeWorkspaceConfig.configurations;
     }
 
@@ -26,7 +29,7 @@ export async function getConfigurationsForWorkspace(workspace: WorkspaceFolder):
     if (!parsed.version) {
         throw Error('Missing field in launch.json: version');
     }
-    // We do not bother ensuring each item is a DebugConfiguration...
+    traceLog("Using configuration in launch.json");
     return parsed.configurations;
 }
 

src/extension/debugger/configuration/resolvers/attach.ts

@@ -8,13 +8,15 @@ import { getOSType, OSType } from '../../../common/platform';
 import { AttachRequestArguments, DebugOptions, PathMapping } from '../../../types';
 import { BaseConfigurationResolver } from './base';
 import { getConfiguration } from '../../../common/vscodeapi';
+import { traceLog } from '../../../common/log/logging';
 
 export class AttachConfigurationResolver extends BaseConfigurationResolver<AttachRequestArguments> {
     public async resolveDebugConfigurationWithSubstitutedVariables(
         folder: WorkspaceFolder | undefined,
         debugConfiguration: AttachRequestArguments,
         _token?: CancellationToken,
     ): Promise<AttachRequestArguments | undefined> {
+        traceLog('Resolving attach configuration with substituted variables');
         const workspaceFolder = AttachConfigurationResolver.getWorkspaceFolder(folder);
 
         await this.provideAttachDefaults(workspaceFolder, debugConfiguration as AttachRequestArguments);

src/extension/debugger/configuration/resolvers/base.ts

@@ -16,6 +16,7 @@ import { resolveVariables } from '../utils/common';
 import { getProgram } from './helper';
 import { getSettingsPythonPath, getInterpreterDetails } from '../../../common/python';
 import { getOSType, OSType } from '../../../common/platform';
+import { traceLog } from '../../../common/log/logging';
 
 export abstract class BaseConfigurationResolver<T extends DebugConfiguration>
     implements IDebugConfigurationResolver<T>
@@ -62,14 +63,17 @@ export abstract class BaseConfigurationResolver<T extends DebugConfiguration>
         const workspaceFolders = getWorkspaceFolders();
 
         if (!Array.isArray(workspaceFolders) || workspaceFolders.length === 0) {
+            traceLog("No workspace folder found");
             return program ? Uri.file(path.dirname(program)) : undefined;
         }
         if (workspaceFolders.length === 1) {
+            traceLog("Using the only workspaceFolder found: ", workspaceFolders[0].uri.fsPath);
             return workspaceFolders[0].uri;
         }
         if (program) {
             const workspaceFolder = getVSCodeWorkspaceFolder(Uri.file(program));
             if (workspaceFolder) {
+                traceLog("Using workspaceFolder found for the program: ", workspaceFolder.uri.fsPath);
                 return workspaceFolder.uri;
             }
         }

src/extension/extensionInit.ts

@@ -84,14 +84,14 @@ export async function registerDebugger(context: IExtensionContext): Promise<IExt
 
     context.subscriptions.push(
         registerCommand(Commands.Debug_In_Terminal, async (file?: Uri) => {
+            traceLog("Debugging using the editor button 'Debug in terminal'");
             sendTelemetryEvent(EventName.DEBUG_IN_TERMINAL_BUTTON);
             const interpreter = await getInterpreterDetails(file);
             if (!interpreter.path) {
                 runPythonExtensionCommand(Commands.TriggerEnvironmentSelection, file).then(noop, noop);
                 return;
             }
             const config = await getDebugConfiguration(file);
-            traceLog("Debugging using the editor button 'Debug in terminal'");
             startDebugging(undefined, config);
         }),
     );