Fix reducer and resolver.

Author: ericsnowcurrently

src/client/pythonEnvironments/base/info/env.ts

@@ -3,6 +3,7 @@
 
 import { cloneDeep } from 'lodash';
 import { Architecture } from '../../../common/utils/platform';
+import { arePathsSame } from '../../common/externalDependencies';
 
 import {
     PythonEnvInfo,
@@ -91,3 +92,31 @@ function updateEnv(env: PythonEnvInfo, updates: {
         env.version = updates.version;
     }
 }
+
+/**
+ * Determine if the given infos correspond to the same env.
+ *
+ * @param environment1 - one of the two envs to compare
+ * @param environment2 - one of the two envs to compare
+ */
+export function areSameEnv(
+    environment1: PythonEnvInfo | string,
+    environment2: PythonEnvInfo | string,
+): boolean {
+    let path1: string;
+    let path2: string;
+    if (typeof environment1 === 'string') {
+        path1 = environment1;
+    } else {
+        path1 = environment1.executable.filename;
+    }
+    if (typeof environment2 === 'string') {
+        path2 = environment2;
+    } else {
+        path2 = environment2.executable.filename;
+    }
+    if (arePathsSame(path1, path2)) {
+        return true;
+    }
+    return false;
+}

src/client/pythonEnvironments/base/info/index.ts

@@ -4,7 +4,6 @@
 import { Uri } from 'vscode';
 import { Architecture } from '../../../common/utils/platform';
 import { BasicVersionInfo, VersionInfo } from '../../../common/utils/version';
-import { arePathsSame } from '../../common/externalDependencies';
 
 /**
  * IDs for the various supported Python environments.
@@ -138,31 +137,3 @@ export type PythonEnvInfo = _PythonEnvInfo & {
     defaultDisplayName?: string;
     searchLocation?: Uri;
 };
-
-/**
- * Determine if the given infos correspond to the same env.
- *
- * @param environment1 - one of the two envs to compare
- * @param environment2 - one of the two envs to compare
- */
-export function areSameEnvironment(
-    environment1: PythonEnvInfo | string,
-    environment2: PythonEnvInfo | string,
-): boolean {
-    let path1: string;
-    let path2: string;
-    if (typeof environment1 === 'string') {
-        path1 = environment1;
-    } else {
-        path1 = environment1.executable.filename;
-    }
-    if (typeof environment2 === 'string') {
-        path2 = environment2;
-    } else {
-        path2 = environment2.executable.filename;
-    }
-    if (arePathsSame(path1, path2)) {
-        return true;
-    }
-    return false;
-}

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

@@ -5,7 +5,8 @@ import { cloneDeep, isEqual } from 'lodash';
 import { Event, EventEmitter } from 'vscode';
 import { traceVerbose } from '../../../../common/logger';
 import { createDeferred } from '../../../../common/utils/async';
-import { areSameEnvironment, PythonEnvInfo, PythonEnvKind } from '../../info';
+import { PythonEnvInfo, PythonEnvKind } from '../../info';
+import { areSameEnv } from '../../info/env';
 import {
     ILocator, IPythonEnvsIterator, PythonEnvUpdatedEvent, PythonLocatorQuery,
 } from '../../locator';
@@ -28,13 +29,13 @@ export class PythonEnvsReducer implements ILocator {
         iterator.onUpdated!((event) => {
             if (event === null) {
                 waitForUpdatesDeferred.resolve();
-            } else if (environment && areSameEnvironment(environment, event.new)) {
-                environment = event.new;
+            } else if (environment && areSameEnv(environment, event.update)) {
+                environment = event.update;
             }
         });
         let result = await iterator.next();
         while (!result.done) {
-            if (areSameEnvironment(result.value, env)) {
+            if (areSameEnv(result.value, env)) {
                 environment = result.value;
             }
             // eslint-disable-next-line no-await-in-loop
@@ -72,13 +73,13 @@ async function* iterEnvsIterator(
                 state.done = true;
                 checkIfFinishedAndNotify(state, didUpdate);
             } else {
-                const oldIndex = seen.findIndex((s) => areSameEnvironment(s, event.old));
-                if (oldIndex !== -1) {
+                if (seen[event.index] !== undefined) {
                     state.pending += 1;
-                    resolveDifferencesInBackground(oldIndex, event.new, state, didUpdate, seen).ignoreErrors();
+                    resolveDifferencesInBackground(event.index, event.update, state, didUpdate, seen)
+                        .ignoreErrors();
                 } else {
                     // This implies a problem in a downstream locator
-                    traceVerbose(`Expected already iterated env, got ${event.old}`);
+                    traceVerbose(`Expected already iterated env, got ${event.old} (#${event.index})`);
                 }
             }
         });
@@ -87,7 +88,7 @@ async function* iterEnvsIterator(
     let result = await iterator.next();
     while (!result.done) {
         const currEnv = result.value;
-        const oldIndex = seen.findIndex((s) => areSameEnvironment(s, currEnv));
+        const oldIndex = seen.findIndex((s) => areSameEnv(s, currEnv));
         if (oldIndex !== -1) {
             state.pending += 1;
             resolveDifferencesInBackground(oldIndex, currEnv, state, didUpdate, seen).ignoreErrors();
@@ -115,8 +116,8 @@ async function resolveDifferencesInBackground(
     const oldEnv = seen[oldIndex];
     const merged = mergeEnvironments(oldEnv, newEnv);
     if (!isEqual(oldEnv, merged)) {
-        didUpdate.fire({ old: oldEnv, new: merged });
         seen[oldIndex] = merged;
+        didUpdate.fire({ index: oldIndex, old: oldEnv, update: merged });
     }
     state.pending -= 1;
     checkIfFinishedAndNotify(state, didUpdate);

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

@@ -5,7 +5,7 @@ import { cloneDeep } from 'lodash';
 import { Event, EventEmitter } from 'vscode';
 import { traceVerbose } from '../../../../common/logger';
 import { IEnvironmentInfoService } from '../../../info/environmentInfoService';
-import { areSameEnvironment, PythonEnvInfo } from '../../info';
+import { PythonEnvInfo } from '../../info';
 import { InterpreterInformation } from '../../info/interpreter';
 import {
     ILocator, IPythonEnvsIterator, PythonEnvUpdatedEvent, PythonLocatorQuery,
@@ -62,14 +62,14 @@ export class PythonEnvsResolver implements ILocator {
                     state.done = true;
                     checkIfFinishedAndNotify(state, didUpdate);
                 } else {
-                    const oldIndex = seen.findIndex((s) => areSameEnvironment(s, event.old));
-                    if (oldIndex !== -1) {
-                        seen[oldIndex] = event.new;
+                    if (seen[event.index] !== undefined) {
+                        seen[event.index] = event.update;
                         state.pending += 1;
-                        this.resolveInBackground(oldIndex, state, didUpdate, seen).ignoreErrors();
+                        this.resolveInBackground(event.index, state, didUpdate, seen)
+                            .ignoreErrors();
                     } else {
                         // This implies a problem in a downstream locator
-                        traceVerbose(`Expected already iterated env in resolver, got ${event.old}`);
+                        traceVerbose(`Expected already iterated env, got ${event.old} (#${event.index})`);
                     }
                 }
             });
@@ -102,8 +102,9 @@ export class PythonEnvsResolver implements ILocator {
         );
         if (interpreterInfo) {
             const resolvedEnv = getResolvedEnv(interpreterInfo, seen[envIndex]);
-            didUpdate.fire({ old: seen[envIndex], new: resolvedEnv });
+            const old = seen[envIndex];
             seen[envIndex] = resolvedEnv;
+            didUpdate.fire({ old, index: envIndex, update: resolvedEnv });
         }
         state.pending -= 1;
         checkIfFinishedAndNotify(state, didUpdate);