Add logging which could help indicate why Discovering Python Interpreters... never finishes (#20792)

For #20250

Author: Kartik Raj

src/client/pythonEnvironments/base/locators/composite/envsReducer.ts

@@ -129,6 +129,7 @@ function checkIfFinishedAndNotify(
     if (state.done && state.pending === 0) {
         didUpdate.fire({ stage: ProgressReportStage.discoveryFinished });
         didUpdate.dispose();
+        traceVerbose(`Finished with environment reducer`);
     }
 }
 

src/client/pythonEnvironments/base/locators/composite/envsResolver.ts

@@ -174,6 +174,7 @@ function checkIfFinishedAndNotify(
     if (state.done && state.pending === 0) {
         didUpdate.fire({ stage: ProgressReportStage.discoveryFinished });
         didUpdate.dispose();
+        traceVerbose(`Finished with environment resolver`);
     }
 }
 

src/client/pythonEnvironments/base/locators/lowLevel/activestateLocator.ts renamed to src/client/pythonEnvironments/base/locators/lowLevel/activeStateLocator.ts

@@ -40,5 +40,6 @@ export class ActiveStateLocator extends LazyResourceBasedLocator {
                 }
             }
         }
+        traceVerbose(`Finished searching for active state environments`);
     }
 }

src/client/pythonEnvironments/base/locators/lowLevel/condaLocator.ts

@@ -38,5 +38,6 @@ export class CondaEnvironmentLocator extends FSWatchingLocator {
                 traceError(`Failed to process conda env: ${JSON.stringify(env)}`, ex);
             }
         }
+        traceVerbose(`Finished searching for conda environments`);
     }
 }

src/client/pythonEnvironments/base/locators/lowLevel/customVirtualEnvLocator.ts

@@ -132,6 +132,7 @@ export class CustomVirtualEnvironmentLocator extends FSWatchingLocator {
             });
 
             yield* iterable(chain(envGenerators));
+            traceVerbose(`Finished searching for custom virtual envs`);
         }
 
         return iterator();

src/client/pythonEnvironments/base/locators/lowLevel/globalVirtualEnvronmentLocator.ts

@@ -134,6 +134,7 @@ export class GlobalVirtualEnvironmentLocator extends FSWatchingLocator {
             });
 
             yield* iterable(chain(envGenerators));
+            traceVerbose(`Finished searching for global virtual envs`);
         }
 
         return iterator();

src/client/pythonEnvironments/base/locators/lowLevel/microsoftStoreLocator.ts

@@ -12,6 +12,7 @@ import {
     isStorePythonInstalled,
     getMicrosoftStoreAppsRoot,
 } from '../../../common/environmentManagers/microsoftStoreEnv';
+import { traceVerbose } from '../../../../logging';
 
 /**
  * This is a glob pattern which matches following file names:
@@ -91,6 +92,7 @@ export class MicrosoftStoreLocator extends FSWatchingLocator {
                 kind,
                 executablePath,
             }));
+            traceVerbose(`Finished searching for windows store envs`);
         };
         return iterator(this.kind);
     }

src/client/pythonEnvironments/base/locators/lowLevel/poetryLocator.ts

@@ -70,6 +70,7 @@ export class PoetryLocator extends LazyResourceBasedLocator {
             });
 
             yield* iterable(chain(envGenerators));
+            traceVerbose(`Finished searching for poetry envs`);
         }
 
         return iterator(this.root);

src/client/pythonEnvironments/base/locators/lowLevel/posixKnownPathsLocator.ts

@@ -8,8 +8,8 @@ import { BasicEnvInfo, IPythonEnvsIterator, Locator } from '../../locator';
 import { commonPosixBinPaths, getPythonBinFromPosixPaths } from '../../../common/posixUtils';
 import { isPyenvShimDir } from '../../../common/environmentManagers/pyenv';
 import { getOSType, OSType } from '../../../../common/utils/platform';
-import { isMacDefaultPythonPath } from './macDefaultLocator';
-import { traceError } from '../../../../logging';
+import { isMacDefaultPythonPath } from '../../../common/environmentManagers/macDefault';
+import { traceError, traceVerbose } from '../../../../logging';
 
 export class PosixKnownPathsLocator extends Locator<BasicEnvInfo> {
     public readonly providerId = 'posixKnownPaths';
@@ -44,6 +44,7 @@ export class PosixKnownPathsLocator extends Locator<BasicEnvInfo> {
                     traceError(`Failed to process environment: ${bin}`, ex);
                 }
             }
+            traceVerbose('Finished searching for interpreters in posix paths locator');
         };
         return iterator(this.kind);
     }

src/client/pythonEnvironments/base/locators/lowLevel/pyenvLocator.ts

@@ -7,7 +7,7 @@ import { FSWatchingLocator } from './fsWatchingLocator';
 import { getInterpreterPathFromDir } from '../../../common/commonUtils';
 import { getSubDirs } from '../../../common/externalDependencies';
 import { getPyenvVersionsDir } from '../../../common/environmentManagers/pyenv';
-import { traceError } from '../../../../logging';
+import { traceError, traceVerbose } from '../../../../logging';
 
 /**
  * Gets all the pyenv environments.
@@ -33,6 +33,7 @@ async function* getPyenvEnvironments(): AsyncIterableIterator<BasicEnvInfo> {
             }
         }
     }
+    traceVerbose('Finished searching for pyenv environments');
 }
 
 export class PyenvLocator extends FSWatchingLocator {