Use areSameEnvironment in getEnv

Author: kimadeline

src/client/pythonEnvironments/base/envsCache.ts

@@ -2,8 +2,10 @@
 // Licensed under the MIT License.
 
 import { cloneDeep } from 'lodash';
+import { IFileSystem } from '../../common/platform/types';
 import { IPersistentState } from '../../common/types';
 import { createGlobalPersistentStore } from '../common/externalDependencies';
+import { areSameEnvironment, PartialPythonEnvironment } from '../info';
 import { PythonEnvInfo } from './info';
 
 /**
@@ -32,12 +34,13 @@ export interface IEnvsCache {
     /**
      * Return a specific environmnent info object.
      *
-     * @param env The environment info data that will be used to look for an environment info object in the cache.
-     * This object may contain incomplete environment info.
+     * @param env The environment info data that will be used to look for
+     * an environment info object in the cache, or a unique environment key.
+     * If passing an environment info object, it may contain incomplete environment info.
      * @return The environment info object that matches all non-undefined keys from the `env` param,
      *  `undefined` otherwise.
      */
-    getEnv(env: Partial<PythonEnvInfo>): PythonEnvInfo | undefined;
+    getEnv(env: PythonEnvInfo | string): PythonEnvInfo | undefined;
 
     /**
      * Writes the content of the in-memory cache to persistent storage.
@@ -67,18 +70,14 @@ export class PythonEnvInfoCache implements IEnvsCache {
         this.envsList = cloneDeep(envs);
     }
 
-    public getEnv(env: Partial<PythonEnvInfo>): PythonEnvInfo | undefined {
-        // Retrieve all keys with non-undefined values.
-        type EnvParamKeys = keyof typeof env;
-        const keys = (Object.keys(env) as unknown as EnvParamKeys[]).filter((key) => env[key] !== undefined);
-
-        // Return the first object where the values match env's.
-        return this.envsList?.find((info) => {
-            // Check if there is any mismatch between the values of the in-memory info and env.
-            const mismatch = keys.some((key) => info[key] !== env[key]);
-
-            return !mismatch;
-        });
+    public getEnv(env: PythonEnvInfo | string): PythonEnvInfo | undefined {
+        // This will have to be updated when areSameEnvironment's signature changes.
+        // See https://github.com/microsoft/vscode-python/pull/14026/files#r493720817.
+        return this.envsList?.find((info) => areSameEnvironment(
+            info as unknown as PartialPythonEnvironment,
+            env as unknown as PartialPythonEnvironment,
+            {} as unknown as IFileSystem,
+        ));
     }
 
     public async flush(): Promise<void> {

src/test/pythonEnvironments/base/envsCache.unit.test.ts

@@ -5,10 +5,12 @@ import * as assert from 'assert';
 import * as sinon from 'sinon';
 import { CompleteEnvInfoFunction, PythonEnvInfoCache } from '../../../client/pythonEnvironments/base/envsCache';
 import { PythonEnvInfo, PythonEnvKind } from '../../../client/pythonEnvironments/base/info';
-import * as externalDeps from '../../../client/pythonEnvironments/common/externalDependencies';
+import * as externalDependencies from '../../../client/pythonEnvironments/common/externalDependencies';
+import * as envInfo from '../../../client/pythonEnvironments/info';
 
 suite('Environment Info cache', () => {
     let createGlobalPersistentStoreStub: sinon.SinonStub;
+    let areSameEnvironmentStub: sinon.SinonStub;
     let updatedValues: PythonEnvInfo[] | undefined;
 
     const allEnvsComplete: CompleteEnvInfoFunction = () => true;
@@ -25,7 +27,12 @@ suite('Environment Info cache', () => {
     ] as PythonEnvInfo[];
 
     setup(() => {
-        createGlobalPersistentStoreStub = sinon.stub(externalDeps, 'createGlobalPersistentStore');
+        areSameEnvironmentStub = sinon.stub(envInfo, 'areSameEnvironment');
+        areSameEnvironmentStub.callsFake(
+            (env1: PythonEnvInfo, env2:PythonEnvInfo) => env1.name === env2.name,
+        );
+
+        createGlobalPersistentStoreStub = sinon.stub(externalDependencies, 'createGlobalPersistentStore');
         createGlobalPersistentStoreStub.returns({
             value: envInfoArray,
             updateValue: async (envs: PythonEnvInfo[]) => {
@@ -37,6 +44,7 @@ suite('Environment Info cache', () => {
 
     teardown(() => {
         createGlobalPersistentStoreStub.restore();
+        areSameEnvironmentStub.restore();
         updatedValues = undefined;
     });
 
@@ -78,9 +86,11 @@ suite('Environment Info cache', () => {
 
     test('`getEnv` should return an environment that matches all non-undefined properties of its argument', () => {
         const envsCache = new PythonEnvInfoCache(allEnvsComplete);
+        const env:PythonEnvInfo = { name: 'my-venv-env' } as unknown as PythonEnvInfo;
+
         envsCache.initialize();
 
-        const result = envsCache.getEnv({ name: 'my-venv-env' });
+        const result = envsCache.getEnv(env);
 
         assert.deepStrictEqual(result, {
             id: 'someid2', kind: PythonEnvKind.Venv, name: 'my-venv-env', defaultDisplayName: 'env-two',
@@ -89,9 +99,11 @@ suite('Environment Info cache', () => {
 
     test('`getEnv` should return undefined if no environment matches the properties of its argument', () => {
         const envsCache = new PythonEnvInfoCache(allEnvsComplete);
+        const env:PythonEnvInfo = { name: 'my-nonexistent-env' } as unknown as PythonEnvInfo;
+
         envsCache.initialize();
 
-        const result = envsCache.getEnv({ name: 'my-nonexistent-env' });
+        const result = envsCache.getEnv(env);
 
         assert.strictEqual(result, undefined);
     });