Use Native Python Finder as the main locator (#23823)

karthiknadig · DonJayamanne · web-flow · commit 193b929f7cb1 · 2024-07-17T11:39:35.000-07:00
Closes #23719 --------- Co-authored-by: Don Jayamanne <Don.Jayamanne@microsoft.com>
diff --git a/src/client/environmentApi.ts b/src/client/environmentApi.ts
@@ -9,7 +9,7 @@ import { Architecture } from './common/utils/platform';
 import { IServiceContainer } from './ioc/types';
 import { PythonEnvInfo, PythonEnvKind, PythonEnvType } from './pythonEnvironments/base/info';
 import { getEnvPath } from './pythonEnvironments/base/info/env';
-import { IDiscoveryAPI } from './pythonEnvironments/base/locator';
+import { IDiscoveryAPI, ProgressReportStage } from './pythonEnvironments/base/locator';
 import { IPythonExecutionFactory } from './common/process/types';
 import { traceError, traceVerbose } from './logging';
 import { isParentPath, normCasePath } from './common/platform/fs-paths';
@@ -147,6 +147,11 @@ export function buildEnvironmentApi(
             .ignoreErrors();
     }
     disposables.push(
+        discoveryApi.onProgress((e) => {
+            if (e.stage === ProgressReportStage.discoveryFinished) {
+                knownCache = initKnownCache();
+            }
+        }),
         discoveryApi.onChanged((e) => {
             const env = e.new ?? e.old;
             if (!env || !filterUsingVSCodeContext(env)) {
diff --git a/src/client/interpreter/display/progressDisplay.ts b/src/client/interpreter/display/progressDisplay.ts
@@ -39,6 +39,8 @@ export class InterpreterLocatorProgressStatubarHandler implements IExtensionSing
                     if (refreshPromise) {
                         refreshPromise.then(() => this.hideProgress());
                     }
+                } else if (event.stage === ProgressReportStage.discoveryFinished) {
+                    this.hideProgress();
                 }
             },
             this,
diff --git a/src/client/pythonEnvironments/base/locator.ts b/src/client/pythonEnvironments/base/locator.ts
@@ -68,6 +68,7 @@ export interface IPythonEnvsIterator<I = PythonEnvInfo> extends IAsyncIterableIt
 }
 
 export enum ProgressReportStage {
+    idle = 'idle',
     discoveryStarted = 'discoveryStarted',
     allPathsDiscovered = 'allPathsDiscovered',
     discoveryFinished = 'discoveryFinished',
diff --git a/src/client/pythonEnvironments/base/locators/common/nativePythonFinder.ts b/src/client/pythonEnvironments/base/locators/common/nativePythonFinder.ts
@@ -1,7 +1,7 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 
-import { Disposable, EventEmitter, Event, Uri } from 'vscode';
+import { Disposable, EventEmitter, Event, Uri, LogOutputChannel } from 'vscode';
 import * as ch from 'child_process';
 import * as path from 'path';
 import * as rpc from 'vscode-jsonrpc/node';
@@ -29,7 +29,7 @@ export interface NativeEnvInfo {
     displayName?: string;
     name?: string;
     executable?: string;
-    kind: string;
+    kind?: string;
     version?: string;
     prefix?: string;
     manager?: NativeEnvManagerInfo;
@@ -57,10 +57,11 @@ export type NativeCondaInfo = {
     environmentsFromTxt: string[];
 };
 
-export interface NativeGlobalPythonFinder extends Disposable {
+export interface NativePythonFinder extends Disposable {
     resolve(executable: string): Promise<NativeEnvInfo>;
     refresh(): AsyncIterable<NativeEnvInfo>;
     categoryToKind(category?: string): PythonEnvKind;
+    logger(): LogOutputChannel;
     getCondaInfo(): Promise<NativeCondaInfo>;
     find(searchPath: string): Promise<NativeEnvInfo[]>;
 }
@@ -70,7 +71,7 @@ interface NativeLog {
     message: string;
 }
 
-class NativeGlobalPythonFinderImpl extends DisposableBase implements NativeGlobalPythonFinder {
+class NativeGlobalPythonFinderImpl extends DisposableBase implements NativePythonFinder {
     private readonly connection: rpc.MessageConnection;
 
     private firstRefreshResults: undefined | (() => AsyncGenerator<NativeEnvInfo, void, unknown>);
@@ -172,6 +173,10 @@ class NativeGlobalPythonFinderImpl extends DisposableBase implements NativeGloba
         }
     }
 
+    logger(): LogOutputChannel {
+        return this.outputChannel;
+    }
+
     refreshFirstTime() {
         const result = this.doRefresh();
         const completed = createDeferredFrom(result.completed);
@@ -304,7 +309,6 @@ class NativeGlobalPythonFinderImpl extends DisposableBase implements NativeGloba
         disposable.add(
             this.connection.onNotification('environment', (data: NativeEnvInfo) => {
                 this.outputChannel.info(`Discovered env: ${data.executable || data.prefix}`);
-                this.outputChannel.trace(`Discovered env info:\n ${JSON.stringify(data, undefined, 4)}`);
                 // We know that in the Python extension if either Version of Prefix is not provided by locator
                 // Then we end up resolving the information.
                 // Lets do that here,
@@ -321,7 +325,6 @@ class NativeGlobalPythonFinderImpl extends DisposableBase implements NativeGloba
                         })
                         .then((environment) => {
                             this.outputChannel.info(`Resolved ${environment.executable}`);
-                            this.outputChannel.trace(`Environment resolved:\n ${JSON.stringify(data, undefined, 4)}`);
                             discovered.fire(environment);
                         })
                         .catch((ex) => this.outputChannel.error(`Error in Resolving ${JSON.stringify(data)}`, ex));
@@ -419,6 +422,10 @@ function getPythonSettingAndUntildify<T>(name: string, scope?: Uri): T | undefin
     return value;
 }
 
-export function createNativeGlobalPythonFinder(): NativeGlobalPythonFinder {
-    return new NativeGlobalPythonFinderImpl();
+let _finder: NativePythonFinder | undefined;
+export function getNativePythonFinder(): NativePythonFinder {
+    if (!_finder) {
+        _finder = new NativeGlobalPythonFinderImpl();
+    }
+    return _finder;
 }
diff --git a/src/client/pythonEnvironments/base/locators/composite/envsCollectionService.ts b/src/client/pythonEnvironments/base/locators/composite/envsCollectionService.ts
@@ -25,11 +25,7 @@ import {
 import { getQueryFilter } from '../../locatorUtils';
 import { PythonEnvCollectionChangedEvent, PythonEnvsWatcher } from '../../watcher';
 import { IEnvsCollectionCache } from './envsCollectionCache';
-import {
-    createNativeGlobalPythonFinder,
-    NativeEnvInfo,
-    NativeGlobalPythonFinder as NativePythonFinder,
-} from '../common/nativePythonFinder';
+import { getNativePythonFinder, NativeEnvInfo, NativePythonFinder } from '../common/nativePythonFinder';
 import { pathExists } from '../../../../common/platform/fs-paths';
 import { noop } from '../../../../common/utils/misc';
 import { parseVersion } from '../../info/pythonVersion';
@@ -55,7 +51,7 @@ export class EnvsCollectionService extends PythonEnvsWatcher<PythonEnvCollection
 
     private readonly progress = new EventEmitter<ProgressNotificationEvent>();
 
-    private nativeFinder = createNativeGlobalPythonFinder();
+    private nativeFinder = getNativePythonFinder();
 
     public refreshState = ProgressReportStage.discoveryFinished;
 
diff --git a/src/client/pythonEnvironments/base/locators/lowLevel/nativeLocator.ts b/src/client/pythonEnvironments/base/locators/lowLevel/nativeLocator.ts
@@ -10,7 +10,7 @@ import { Conda } from '../../../common/environmentManagers/conda';
 import { traceError } from '../../../../logging';
 import type { KnownEnvironmentTools } from '../../../../api/types';
 import { setPyEnvBinary } from '../../../common/environmentManagers/pyenv';
-import { NativeGlobalPythonFinder, createNativeGlobalPythonFinder } from '../common/nativePythonFinder';
+import { NativePythonFinder, getNativePythonFinder } from '../common/nativePythonFinder';
 import { disposeAll } from '../../../../common/utils/resourceLifecycle';
 import { Architecture } from '../../../../common/utils/platform';
 
@@ -54,11 +54,11 @@ export class NativeLocator implements ILocator<BasicEnvInfo>, IDisposable {
 
     private readonly disposables: IDisposable[] = [];
 
-    private readonly finder: NativeGlobalPythonFinder;
+    private readonly finder: NativePythonFinder;
 
     constructor() {
         this.onChanged = this.onChangedEmitter.event;
-        this.finder = createNativeGlobalPythonFinder();
+        this.finder = getNativePythonFinder();
         this.disposables.push(this.onChangedEmitter, this.finder);
     }
 
diff --git a/src/client/pythonEnvironments/index.ts b/src/client/pythonEnvironments/index.ts
@@ -40,16 +40,34 @@ import { traceError } from '../logging';
 import { ActiveStateLocator } from './base/locators/lowLevel/activeStateLocator';
 import { CustomWorkspaceLocator } from './base/locators/lowLevel/customWorkspaceLocator';
 import { PixiLocator } from './base/locators/lowLevel/pixiLocator';
+import { getConfiguration } from '../common/vscodeApis/workspaceApis';
+import { getNativePythonFinder } from './base/locators/common/nativePythonFinder';
+import { createNativeEnvironmentsApi } from './nativeAPI';
 
 const PYTHON_ENV_INFO_CACHE_KEY = 'PYTHON_ENV_INFO_CACHEv2';
 
+export function shouldUseNativeLocator(): boolean {
+    const config = getConfiguration('python');
+    return config.get<string>('locator', 'js') === 'native';
+}
+
 /**
  * Set up the Python environments component (during extension activation).'
  */
 export async function initialize(ext: ExtensionState): Promise<IDiscoveryAPI> {
     // Set up the legacy IOC container before api is created.
     initializeLegacyExternalDependencies(ext.legacyIOC.serviceContainer);
 
+    if (shouldUseNativeLocator()) {
+        const finder = getNativePythonFinder();
+        const api = createNativeEnvironmentsApi(finder);
+        registerNewDiscoveryForIOC(
+            // These are what get wrapped in the legacy adapter.
+            ext.legacyIOC.serviceManager,
+            api,
+        );
+        return api;
+    }
     const api = await createPythonEnvironments(() => createLocator(ext));
     registerNewDiscoveryForIOC(
         // These are what get wrapped in the legacy adapter.
diff --git a/src/client/pythonEnvironments/nativeAPI.ts b/src/client/pythonEnvironments/nativeAPI.ts
diff --git a/src/test/pythonEnvironments/base/locators/composite/envsCollectionService.unit.test.ts b/src/test/pythonEnvironments/base/locators/composite/envsCollectionService.unit.test.ts
diff --git a/src/test/pythonEnvironments/nativeAPI.unit.test.ts b/src/test/pythonEnvironments/nativeAPI.unit.test.ts

Original file line number	Diff line number	Diff line change
`@@ -39,6 +39,8 @@ export class InterpreterLocatorProgressStatubarHandler implements IExtensionSing`
`39`	`39`	`if (refreshPromise) {`
`40`	`40`	`refreshPromise.then(() => this.hideProgress());`
`41`	`41`	`}`
	`42`	`+ } else if (event.stage === ProgressReportStage.discoveryFinished) {`
	`43`	`+ this.hideProgress();`
`42`	`44`	`}`
`43`	`45`	`},`
`44`	`46`	`this,`
Original file line number	Diff line number	Diff line change
`@@ -68,6 +68,7 @@ export interface IPythonEnvsIterator<I = PythonEnvInfo> extends IAsyncIterableIt`
`68`	`68`	`}`
`69`	`69`
`70`	`70`	`export enum ProgressReportStage {`
	`71`	`+ idle = 'idle',`
`71`	`72`	`discoveryStarted = 'discoveryStarted',`
`72`	`73`	`allPathsDiscovered = 'allPathsDiscovered',`
`73`	`74`	`discoveryFinished = 'discoveryFinished',`