Update the initialization of the PythonEnvInfoCache to pass in a function that checks for env info completeness (#14446)

* Update the initialization of the PythonEnvInfoCache to pass in a function that checks for env info completeness

* Update interface

Author: Kartik Raj

src/client/pythonEnvironments/index.ts

@@ -10,6 +10,7 @@ import { CachingLocator } from './base/locators/composite/cachingLocator';
 import { PythonEnvsChangedEvent } from './base/watcher';
 import { getGlobalPersistentStore } from './common/externalDependencies';
 import { ExtensionLocators, WorkspaceLocators } from './discovery/locators';
+import { EnvironmentInfoService } from './info/environmentInfoService';
 import { registerForIOC } from './legacyIOC';
 
 /**
@@ -53,9 +54,9 @@ export class PythonEnvironments implements ILocator {
 export function createAPI(): [PythonEnvironments, () => void] {
     const [locators, activateLocators] = initLocators();
 
-    // Update this to pass in an actual function that checks for env info completeness.
+    const envInfoService = new EnvironmentInfoService();
     const envsCache = new PythonEnvInfoCache(
-        () => true, // "isComplete"
+        (env: PythonEnvInfo) => envInfoService.isInfoProvided(env.executable.filename), // "isComplete"
         () => {
             const storage = getGlobalPersistentStore<PythonEnvInfo[]>('PYTHON_ENV_INFO_CACHE');
             return {

src/client/pythonEnvironments/info/environmentInfoService.ts

@@ -19,6 +19,7 @@ export interface IEnvironmentInfoService {
         interpreterPath: string,
         priority?: EnvironmentInfoServiceQueuePriority
     ): Promise<InterpreterInformation | undefined>;
+    isInfoProvided(interpreterPath: string): boolean;
 }
 
 async function buildEnvironmentInfo(interpreterPath: string): Promise<InterpreterInformation | undefined> {
@@ -70,4 +71,9 @@ export class EnvironmentInfoService implements IEnvironmentInfoService {
             return r;
         });
     }
+
+    public isInfoProvided(interpreterPath: string): boolean {
+        const result = this.cache.get(interpreterPath);
+        return !!(result && result.completed);
+    }
 }

src/test/pythonEnvironments/info/environmentInfoService.functional.test.ts

@@ -91,4 +91,38 @@ suite('Environment Info Service', () => {
         });
         assert.ok(stubShellExec.calledOnce);
     });
+
+    test('isInfoProvided() returns true for items already processed', async () => {
+        const envService = new EnvironmentInfoService();
+        let result: boolean;
+        const promises: Promise<InterpreterInformation | undefined>[] = [];
+        const path1 = 'any-path1';
+        const path2 = 'any-path2';
+
+        promises.push(envService.getEnvironmentInfo(path1));
+        promises.push(envService.getEnvironmentInfo(path2));
+
+        await Promise.all(promises);
+        result = envService.isInfoProvided(path1);
+        assert.strictEqual(result, true);
+        result = envService.isInfoProvided(path2);
+        assert.strictEqual(result, true);
+    });
+
+    test('isInfoProvided() returns false otherwise', async () => {
+        const envService = new EnvironmentInfoService();
+        const promises: Promise<InterpreterInformation | undefined>[] = [];
+        const path1 = 'any-path1';
+        const path2 = 'any-path2';
+
+        promises.push(envService.getEnvironmentInfo(path1));
+        promises.push(envService.getEnvironmentInfo(path2));
+
+        let result = envService.isInfoProvided(path1);
+        assert.strictEqual(result, false);
+        result = envService.isInfoProvided(path2);
+        assert.strictEqual(result, false);
+        result = envService.isInfoProvided('some-random-path');
+        assert.strictEqual(result, false);
+    });
 });