Fix event duplication when using Python Environments

karthiknadig · Feb 5, 2025 · 7c6be1d · 7c6be1d
1 parent d5b19e7
commit 7c6be1d
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 9 deletions.
diff --git a/src/client/envExt/api.legacy.ts b/src/client/envExt/api.legacy.ts
@@ -1,7 +1,7 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 
-import { Terminal, Uri } from 'vscode';
+import { Terminal, Uri, WorkspaceFolder } from 'vscode';
 import { getEnvExtApi, getEnvironment } from './api.internal';
 import { EnvironmentType, PythonEnvironment as PythonEnvironmentLegacy } from '../pythonEnvironments/info';
 import { PythonEnvironment, PythonTerminalOptions } from './types';
@@ -10,7 +10,7 @@ import { parseVersion } from '../pythonEnvironments/base/info/pythonVersion';
 import { PythonEnvType } from '../pythonEnvironments/base/info';
 import { traceError, traceInfo } from '../logging';
 import { reportActiveInterpreterChanged } from '../environmentApi';
-import { getWorkspaceFolder } from '../common/vscodeApis/workspaceApis';
+import { getWorkspaceFolder, getWorkspaceFolders } from '../common/vscodeApis/workspaceApis';
 
 function toEnvironmentType(pythonEnv: PythonEnvironment): EnvironmentType {
     if (pythonEnv.envId.managerId.toLowerCase().endsWith('system')) {
@@ -106,16 +106,25 @@ export async function getActiveInterpreterLegacy(resource?: Uri): Promise<Python
     const pythonEnv = await getEnvironment(resource);
     const oldEnv = previousEnvMap.get(uri?.fsPath || '');
     const newEnv = pythonEnv ? toLegacyType(pythonEnv) : undefined;
-    if (newEnv && oldEnv?.envId.id !== pythonEnv?.envId.id) {
+
+    const folders = getWorkspaceFolders() ?? [];
+    const shouldReport =
+        (folders.length === 0 && resource === undefined) || (folders.length > 0 && resource !== undefined);
+    if (shouldReport && newEnv && oldEnv?.envId.id !== pythonEnv?.envId.id) {
         reportActiveInterpreterChanged({
             resource: getWorkspaceFolder(resource),
             path: newEnv.path,
         });
+        previousEnvMap.set(uri?.fsPath || '', pythonEnv);
     }
     return pythonEnv ? toLegacyType(pythonEnv) : undefined;
 }
 
-export async function ensureEnvironmentContainsPythonLegacy(pythonPath: string): Promise<void> {
+export async function ensureEnvironmentContainsPythonLegacy(
+    pythonPath: string,
+    workspaceFolder: WorkspaceFolder | undefined,
+    callback: () => void,
+): Promise<void> {
     const api = await getEnvExtApi();
     const pythonEnv = await api.resolveEnvironment(Uri.file(pythonPath));
     if (!pythonEnv) {
@@ -132,6 +141,12 @@ export async function ensureEnvironmentContainsPythonLegacy(pythonPath: string):
         traceInfo(`EnvExt: Python not found in ${envType} environment ${pythonPath}`);
         traceInfo(`EnvExt: Installing Python in ${envType} environment ${pythonPath}`);
         await api.installPackages(pythonEnv, ['python']);
+        previousEnvMap.set(workspaceFolder?.uri.fsPath || '', pythonEnv);
+        reportActiveInterpreterChanged({
+            path: pythonPath,
+            resource: workspaceFolder,
+        });
+        callback();
     }
 }
 

diff --git a/src/client/interpreter/interpreterService.ts b/src/client/interpreter/interpreterService.ts
@@ -290,11 +290,8 @@ export class InterpreterService implements Disposable, IInterpreterService {
     @cache(-1, true)
     private async ensureEnvironmentContainsPython(pythonPath: string, workspaceFolder: WorkspaceFolder | undefined) {
         if (useEnvExtension()) {
-            await ensureEnvironmentContainsPythonLegacy(pythonPath);
-            this.didChangeInterpreterEmitter.fire(workspaceFolder?.uri);
-            reportActiveInterpreterChanged({
-                path: pythonPath,
-                resource: workspaceFolder,
+            await ensureEnvironmentContainsPythonLegacy(pythonPath, workspaceFolder, () => {
+                this.didChangeInterpreterEmitter.fire(workspaceFolder?.uri);
             });
             return;
         }