Improve discovery resolving API (#18729)

* Improve discovery resolving API

* Improve public api doc

* Fix tests

Author: Kartik Raj

src/client/apiTypes.ts

@@ -139,7 +139,7 @@ export interface IProposedExtensionAPI {
          * Returns details for the given interpreter. Details such as absolute interpreter path,
          * version, type (conda, pyenv, etc). Metadata such as `sysPrefix` can be found under
          * metadata field.
-         * @param path : Path to environment folder or path to interpreter whose details you need.
+         * @param path : Full path to environment folder or interpreter whose details you need.
          * @param options : [optional]
          *     * useCache : When true, cache is checked first for any data, returns even if there
          *                  is partial data.
@@ -159,9 +159,9 @@ export interface IProposedExtensionAPI {
          */
         getEnvironmentPaths(): Promise<EnvPathType[] | undefined>;
         /**
-         * Sets the active environment path for the python extension. Configuration target will
-         * always be the workspace folder.
-         * @param path : Interpreter path to set for a given workspace.
+         * Sets the active environment path for the python extension for the resource. Configuration target
+         * will always be the workspace folder.
+         * @param path : Full path to environment folder or interpreter to set.
          * @param resource : [optional] Uri of a file ro workspace to scope to a particular workspace
          *                   folder.
          */
@@ -171,7 +171,7 @@ export interface IProposedExtensionAPI {
          * promise to get the updated environment list. If there is a refresh already going on
          * then it returns the promise for that refresh.
          * @param options : [optional]
-         *     * clearCache : When true, this will clear the cache before interpreter refresh
+         *     * clearCache : When true, this will clear the cache before environment refresh
          *                    is triggered.
          */
         refreshEnvironment(options?: RefreshEnvironmentsOptions): Promise<EnvPathType[] | undefined>;

src/client/interpreter/configuration/pythonPathUpdaterService.ts

@@ -2,6 +2,7 @@ import { inject, injectable } from 'inversify';
 import * as path from 'path';
 import { ConfigurationTarget, Uri, window } from 'vscode';
 import { StopWatch } from '../../common/utils/stopWatch';
+import { SystemVariables } from '../../common/variables/systemVariables';
 import { traceError } from '../../logging';
 import { sendTelemetryEvent } from '../../telemetry';
 import { EventName } from '../../telemetry/constants';
@@ -36,7 +37,7 @@ export class PythonPathUpdaterService implements IPythonPathUpdaterServiceManage
             traceError(reason);
         }
         // do not wait for this to complete
-        this.sendTelemetry(stopWatch.elapsedTime, failed, trigger, pythonPath).catch((ex) =>
+        this.sendTelemetry(stopWatch.elapsedTime, failed, trigger, pythonPath, wkspace).catch((ex) =>
             traceError('Python Extension: sendTelemetry', ex),
         );
     }
@@ -46,13 +47,15 @@ export class PythonPathUpdaterService implements IPythonPathUpdaterServiceManage
         failed: boolean,
         trigger: 'ui' | 'shebang' | 'load',
         pythonPath: string | undefined,
+        wkspace?: Uri,
     ) {
         const telemetryProperties: PythonInterpreterTelemetry = {
             failed,
             trigger,
         };
         if (!failed && pythonPath) {
-            const interpreterInfo = await this.pyenvs.getInterpreterInformation(pythonPath);
+            const systemVariables = new SystemVariables(undefined, wkspace?.fsPath);
+            const interpreterInfo = await this.pyenvs.getInterpreterInformation(systemVariables.resolveAny(pythonPath));
             if (interpreterInfo) {
                 telemetryProperties.pythonVersion = interpreterInfo.version?.raw;
             }

src/client/interpreter/display/index.ts

@@ -127,7 +127,7 @@ export class InterpreterDisplay implements IInterpreterDisplay, IExtensionSingle
             } else {
                 this.statusBar.tooltip = '';
                 this.statusBar.color = '';
-                this.statusBar.text = '$(alert) Select Python Interpreter';
+                this.statusBar.text = `$(alert) ${InterpreterQuickPickList.browsePath.openButtonLabel()}`;
                 this.currentlySelectedInterpreterDisplay = undefined;
             }
         } else if (this.languageStatus) {

src/client/pythonEnvironments/base/locator.ts

@@ -196,7 +196,7 @@ export interface IDiscoveryAPI {
      * Find as much info about the given Python environment as possible.
      * If path passed is invalid, then `undefined` is returned.
      *
-     * @param path - Python executable path or environment path to resolve more information about
+     * @param path - Full path of Python executable or environment folder to resolve more information about
      */
     resolveEnv(path: string): Promise<PythonEnvInfo | undefined>;
 }

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

@@ -66,7 +66,10 @@ export class EnvsCollectionService extends PythonEnvsWatcher<PythonEnvCollection
         if (cachedEnv) {
             return cachedEnv;
         }
-        const resolved = await this.locator.resolveEnv(path);
+        const resolved = await this.locator.resolveEnv(path).catch((ex) => {
+            traceError(`Failed to resolve ${path}`, ex);
+            return undefined;
+        });
         if (resolved) {
             this.cache.addEnv(resolved, true);
         }

src/client/pythonEnvironments/common/environmentIdentifier.ts

@@ -1,6 +1,7 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 
+import { traceWarn } from '../../logging';
 import { PythonEnvKind } from '../base/info';
 import { getPrioritizedEnvKinds } from '../base/info/envKind';
 import { isCondaEnvironment } from './environmentManagers/conda';
@@ -46,7 +47,13 @@ export async function identifyEnvironment(path: string): Promise<PythonEnvKind>
     const prioritizedEnvTypes = getPrioritizedEnvKinds();
     for (const e of prioritizedEnvTypes) {
         const identifier = identifiers.get(e);
-        if (identifier && (await identifier(path))) {
+        if (
+            identifier &&
+            (await identifier(path).catch((ex) => {
+                traceWarn(`Identifier for ${e} failed to identify ${path}`, ex);
+                return false;
+            }))
+        ) {
             return e;
         }
     }

src/test/interpreters/display.unit.test.ts

@@ -273,7 +273,10 @@ suite('Interpreters Display', () => {
                 } else {
                     statusBar.verify((s) => (s.color = TypeMoq.It.isValue('')), TypeMoq.Times.once());
                     statusBar.verify(
-                        (s) => (s.text = TypeMoq.It.isValue('$(alert) Select Python Interpreter')),
+                        (s) =>
+                            (s.text = TypeMoq.It.isValue(
+                                `$(alert) ${InterpreterQuickPickList.browsePath.openButtonLabel()}`,
+                            )),
                         TypeMoq.Times.once(),
                     );
                 }