Added environments resolver

src/client/pythonEnvironments/base/locator.ts

@@ -92,7 +92,7 @@ export type PythonLocatorQuery = BasicPythonLocatorQuery & {
     searchLocations?: Uri[];
 };
 
-export type QueryForEvent<E> = E extends PythonEnvsChangedEvent ? PythonLocatorQuery : BasicPythonLocatorQuery;
+type QueryForEvent<E> = E extends PythonEnvsChangedEvent ? PythonLocatorQuery : BasicPythonLocatorQuery;
 
 /**
  * A single Python environment locator.

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

@@ -3,13 +3,13 @@
 
 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 '../base/info';
+import { traceVerbose } from '../../../../common/logger';
+import { createDeferred } from '../../../../common/utils/async';
+import { areSameEnvironment, PythonEnvInfo, PythonEnvKind } from '../../info';
 import {
-    ILocator, IPythonEnvsIterator, PythonEnvUpdatedEvent, QueryForEvent,
-} from '../base/locator';
-import { PythonEnvsChangedEvent } from '../base/watcher';
+    ILocator, IPythonEnvsIterator, PythonEnvUpdatedEvent, PythonLocatorQuery,
+} from '../../locator';
+import { PythonEnvsChangedEvent } from '../../watcher';
 
 /**
  * Combines duplicate environments received from the incoming locator into one and passes on unique environments
@@ -47,7 +47,7 @@ export class PythonEnvsReducer implements ILocator {
         return this.parentLocator.resolveEnv(environment);
     }
 
-    public iterEnvs(query?: QueryForEvent<PythonEnvsChangedEvent>): IPythonEnvsIterator {
+    public iterEnvs(query?: PythonLocatorQuery): IPythonEnvsIterator {
         const didUpdate = new EventEmitter<PythonEnvUpdatedEvent | null>();
         const incomingIterator = this.parentLocator.iterEnvs(query);
         const iterator: IPythonEnvsIterator = iterEnvsIterator(incomingIterator, didUpdate);

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

@@ -0,0 +1,136 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+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 { InterpreterInformation } from '../../info/interpreter';
+import {
+    ILocator, IPythonEnvsIterator, PythonEnvUpdatedEvent, PythonLocatorQuery,
+} from '../../locator';
+import { PythonEnvsChangedEvent } from '../../watcher';
+
+/**
+ * Calls environment info service which runs `interpreterInfo.py` script on environments received
+ * from the parent locator. Uses information received to populate environments further and pass it on.
+ */
+export class PythonEnvsResolver implements ILocator {
+    public get onChanged(): Event<PythonEnvsChangedEvent> {
+        return this.parentLocator.onChanged;
+    }
+
+    constructor(
+        private readonly parentLocator: ILocator,
+        private readonly environmentInfoService: IEnvironmentInfoService,
+    ) {}
+
+    public async resolveEnv(env: string | PythonEnvInfo): Promise<PythonEnvInfo | undefined> {
+        const environment = await this.parentLocator.resolveEnv(env);
+        if (!environment) {
+            return undefined;
+        }
+        const interpreterInfo = await this.environmentInfoService.getEnvironmentInfo(environment.executable.filename);
+        if (!interpreterInfo) {
+            return undefined;
+        }
+        return getResolvedEnv(interpreterInfo, environment);
+    }
+
+    public iterEnvs(query?: PythonLocatorQuery): IPythonEnvsIterator {
+        const didUpdate = new EventEmitter<PythonEnvUpdatedEvent | null>();
+        const incomingIterator = this.parentLocator.iterEnvs(query);
+        const iterator: IPythonEnvsIterator = this.iterEnvsIterator(incomingIterator, didUpdate);
+        iterator.onUpdated = didUpdate.event;
+        return iterator;
+    }
+
+    private async* iterEnvsIterator(
+        iterator: IPythonEnvsIterator,
+        didUpdate: EventEmitter<PythonEnvUpdatedEvent | null>,
+    ): AsyncIterator<PythonEnvInfo, void> {
+        const state = {
+            done: false,
+            pending: 0,
+        };
+        const seen: PythonEnvInfo[] = [];
+
+        if (iterator.onUpdated !== undefined) {
+            iterator.onUpdated((event) => {
+                if (event === null) {
+                    state.done = true;
+                    checkIfFinishedAndNotify(state, didUpdate);
+                } else {
+                    const oldIndex = seen.findIndex((s) => areSameEnvironment(s, event.old));
+                    if (oldIndex !== -1) {
+                        seen[oldIndex] = event.new;
+                        state.pending += 1;
+                        this.resolveInBackground(oldIndex, state, didUpdate, seen).ignoreErrors();
+                    } else {
+                        // This implies a problem in a downstream locator
+                        traceVerbose(`Expected already iterated env in resolver, got ${event.old}`);
+                    }
+                }
+            });
+        }
+
+        let result = await iterator.next();
+        while (!result.done) {
+            const currEnv = result.value;
+            seen.push(currEnv);
+            yield currEnv;
+            state.pending += 1;
+            this.resolveInBackground(seen.indexOf(currEnv), state, didUpdate, seen).ignoreErrors();
+            // eslint-disable-next-line no-await-in-loop
+            result = await iterator.next();
+        }
+        if (iterator.onUpdated === undefined) {
+            state.done = true;
+            checkIfFinishedAndNotify(state, didUpdate);
+        }
+    }
+
+    private async resolveInBackground(
+        envIndex: number,
+        state: { done: boolean; pending: number },
+        didUpdate: EventEmitter<PythonEnvUpdatedEvent | null>,
+        seen: PythonEnvInfo[],
+    ) {
+        const interpreterInfo = await this.environmentInfoService.getEnvironmentInfo(
+            seen[envIndex].executable.filename,
+        );
+        if (interpreterInfo) {
+            const resolvedEnv = getResolvedEnv(interpreterInfo, seen[envIndex]);
+            didUpdate.fire({ old: seen[envIndex], new: resolvedEnv });
+            seen[envIndex] = resolvedEnv;
+        }
+        state.pending -= 1;
+        checkIfFinishedAndNotify(state, didUpdate);
+    }
+}
+
+/**
+ * When all info from incoming iterator has been received and all background calls finishes, notify that we're done
+ * @param state Carries the current state of progress
+ * @param didUpdate Used to notify when finished
+ */
+function checkIfFinishedAndNotify(
+    state: { done: boolean; pending: number },
+    didUpdate: EventEmitter<PythonEnvUpdatedEvent | null>,
+) {
+    if (state.done && state.pending === 0) {
+        didUpdate.fire(null);
+        didUpdate.dispose();
+    }
+}
+
+function getResolvedEnv(interpreterInfo: InterpreterInformation, environment: PythonEnvInfo) {
+    // Deep copy into a new object
+    const resolvedEnv = cloneDeep(environment);
+    resolvedEnv.version = interpreterInfo.version;
+    resolvedEnv.executable.filename = interpreterInfo.executable.filename;
+    resolvedEnv.executable.sysPrefix = interpreterInfo.executable.sysPrefix;
+    resolvedEnv.arch = interpreterInfo.arch;
+    return resolvedEnv;
+}

src/test/pythonEnvironments/collection/environmentsReducer.unit.test.ts → src/test/pythonEnvironments/base/locators/composite/environmentsReducer.unit.test.ts

@@ -5,15 +5,15 @@ import { assert, expect } from 'chai';
 import { isEqual } from 'lodash';
 import * as path from 'path';
 import { EventEmitter } from 'vscode';
-import { PythonEnvInfo, PythonEnvKind } from '../../../client/pythonEnvironments/base/info';
-import { PythonEnvUpdatedEvent } from '../../../client/pythonEnvironments/base/locator';
-import { PythonEnvsChangedEvent } from '../../../client/pythonEnvironments/base/watcher';
+import { PythonEnvInfo, PythonEnvKind } from '../../../../../client/pythonEnvironments/base/info';
+import { PythonEnvUpdatedEvent } from '../../../../../client/pythonEnvironments/base/locator';
 import {
     mergeEnvironments,
     PythonEnvsReducer,
-} from '../../../client/pythonEnvironments/collection/environmentsReducer';
-import { sleep } from '../../core';
-import { createEnv, getEnvs, SimpleLocator } from '../base/common';
+} from '../../../../../client/pythonEnvironments/base/locators/composite/environmentsReducer';
+import { PythonEnvsChangedEvent } from '../../../../../client/pythonEnvironments/base/watcher';
+import { sleep } from '../../../../core';
+import { createEnv, getEnvs, SimpleLocator } from '../../common';
 
 suite('Environments Reducer', () => {
     suite('iterEnvs()', () => {