Reset stored info if we detect an environment was modified (#20038)

Kartik Raj · aeschli · web-flow · commit 33af5f78b1a0 · 2022-10-20T23:56:08.000-07:00
Closes microsoft#20028 Co-authored-by: Martin Aeschlimann <martinae@microsoft.com>
diff --git a/src/client/pythonEnvironments/base/info/environmentInfoService.ts b/src/client/pythonEnvironments/base/info/environmentInfoService.ts
@@ -1,6 +1,7 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 
+import { Uri } from 'vscode';
 import { IDisposableRegistry } from '../../../common/types';
 import { createDeferred, Deferred } from '../../../common/utils/async';
 import { createRunningWorkerPool, IWorkerPool, QueuePosition } from '../../../common/utils/workerPool';
@@ -20,10 +21,20 @@ export enum EnvironmentInfoServiceQueuePriority {
 }
 
 export interface IEnvironmentInfoService {
+    /**
+     * Get the interpreter information for the given environment.
+     * @param env The environment to get the interpreter information for.
+     * @param priority The priority of the request.
+     */
     getEnvironmentInfo(
         env: PythonEnvInfo,
         priority?: EnvironmentInfoServiceQueuePriority,
     ): Promise<InterpreterInformation | undefined>;
+    /**
+     * Reset any stored interpreter information for the given environment.
+     * @param searchLocation Search location of the environment.
+     */
+    resetInfo(searchLocation: Uri): void;
 }
 
 async function buildEnvironmentInfo(env: PythonEnvInfo): Promise<InterpreterInformation | undefined> {
@@ -154,6 +165,16 @@ class EnvironmentInfoService implements IEnvironmentInfoService {
         }
         return r;
     }
+
+    public resetInfo(searchLocation: Uri): void {
+        const searchLocationPath = searchLocation.fsPath;
+        const keys = Array.from(this.cache.keys());
+        keys.forEach((key) => {
+            if (key.startsWith(normCasePath(searchLocationPath))) {
+                this.cache.delete(key);
+            }
+        });
+    }
 }
 
 function addToQueue(
diff --git a/src/client/pythonEnvironments/base/locators/common/resourceBasedLocator.ts b/src/client/pythonEnvironments/base/locators/common/resourceBasedLocator.ts
@@ -125,7 +125,7 @@ export abstract class LazyResourceBasedLocator extends Locator<BasicEnvInfo> imp
         this.watchersReady = createDeferred<void>();
 
         // Don't create any file watchers in a virtual workspace.
-        if (!(await isVirtualWorkspace())) {
+        if (!isVirtualWorkspace()) {
             await this.initWatchers().catch((ex) => {
                 traceError(ex);
                 this.watchersReady?.reject(ex);
diff --git a/src/client/pythonEnvironments/base/locators/composite/envsResolver.ts b/src/client/pythonEnvironments/base/locators/composite/envsResolver.ts
@@ -37,7 +37,14 @@ export class PythonEnvsResolver implements IResolvingLocator {
     constructor(
         private readonly parentLocator: ICompositeLocator<BasicEnvInfo>,
         private readonly environmentInfoService: IEnvironmentInfoService,
-    ) {}
+    ) {
+        this.parentLocator.onChanged((event) => {
+            if (event.type && event.searchLocation !== undefined) {
+                // We detect an environment changed, reset any stored info for it so it can be re-run.
+                this.environmentInfoService.resetInfo(event.searchLocation);
+            }
+        });
+    }
 
     public async resolveEnv(path: string): Promise<PythonEnvInfo | undefined> {
         const [executablePath, envPath] = await getExecutablePathAndEnvPath(path);
diff --git a/src/client/pythonEnvironments/common/externalDependencies.ts b/src/client/pythonEnvironments/common/externalDependencies.ts
@@ -30,7 +30,7 @@ export async function exec(file: string, args: string[], options: SpawnOptions =
 
 // Workspace
 
-export async function isVirtualWorkspace(): Promise<boolean> {
+export function isVirtualWorkspace(): boolean {
     const service = internalServiceContainer.get<IWorkspaceService>(IWorkspaceService);
     return service.isVirtualWorkspace;
 }
diff --git a/src/client/pythonEnvironments/index.ts b/src/client/pythonEnvironments/index.ts
@@ -38,17 +38,15 @@ import { IDisposable } from '../common/types';
  * Set up the Python environments component (during extension activation).'
  */
 export async function initialize(ext: ExtensionState): Promise<IDiscoveryAPI> {
-    const api = await createPythonEnvironments(() => createLocator(ext));
-
-    // Any other initialization goes here.
-
+    // Set up the legacy IOC container before api is created.
     initializeLegacyExternalDependencies(ext.legacyIOC.serviceContainer);
+
+    const api = await createPythonEnvironments(() => createLocator(ext));
     registerNewDiscoveryForIOC(
         // These are what get wrapped in the legacy adapter.
         ext.legacyIOC.serviceManager,
         api,
     );
-
     return api;
 }
 

Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,7 @@ export async function exec(file: string, args: string[], options: SpawnOptions =`
`30`	`30`
`31`	`31`	`// Workspace`
`32`	`32`
`33`		`-export async function isVirtualWorkspace(): Promise<boolean> {`
	`33`	`+export function isVirtualWorkspace(): boolean {`
`34`	`34`	`const service = internalServiceContainer.get<IWorkspaceService>(IWorkspaceService);`
`35`	`35`	`return service.isVirtualWorkspace;`
`36`	`36`	`}`