fix: handling installables selection (#315)

fixes:
#304
fixes:
#301

Author: karthiknadig

src/managers/builtin/pipManager.ts

@@ -63,7 +63,7 @@ export class PipPackageManager implements PackageManager, Disposable {
 
         if (toInstall.length === 0 && toUninstall.length === 0) {
             const projects = this.venv.getProjectsByEnvironment(environment);
-            const result = await getWorkspacePackagesToInstall(this.api, options, projects, environment);
+            const result = await getWorkspacePackagesToInstall(this.api, options, projects, environment, this.log);
             if (result) {
                 toInstall = result.install;
                 toUninstall = result.uninstall;

src/managers/builtin/pipUtils.ts

@@ -1,7 +1,7 @@
 import * as fse from 'fs-extra';
 import * as path from 'path';
 import * as tomljs from '@iarna/toml';
-import { LogOutputChannel, ProgressLocation, QuickInputButtons, Uri } from 'vscode';
+import { LogOutputChannel, ProgressLocation, QuickInputButtons, QuickPickItem, Uri } from 'vscode';
 import { showQuickPickWithButtons, withProgress } from '../../common/window.apis';
 import { PackageManagement, Pickers, VenvManagerStrings } from '../../common/localize';
 import { PackageManagementOptions, PythonEnvironment, PythonEnvironmentApi, PythonProject } from '../../api';
@@ -10,6 +10,7 @@ import { EXTENSION_ROOT_DIR } from '../../common/constants';
 import { selectFromCommonPackagesToInstall, selectFromInstallableToInstall } from '../common/pickers';
 import { traceInfo } from '../../common/logging';
 import { Installable, mergePackages } from '../common/utils';
+import { refreshPipPackages } from './utils';
 
 async function tomlParse(fsPath: string, log?: LogOutputChannel): Promise<tomljs.JsonMap> {
     try {
@@ -83,7 +84,7 @@ async function selectWorkspaceOrCommon(
         return undefined;
     }
 
-    const items = [];
+    const items: QuickPickItem[] = [];
     if (installable.length > 0) {
         items.push({
             label: PackageManagement.workspaceDependencies,
@@ -102,27 +103,32 @@ async function selectWorkspaceOrCommon(
         items.push({ label: PackageManagement.skipPackageInstallation });
     }
 
-    const selected =
-        items.length === 1
-            ? items[0]
-            : await showQuickPickWithButtons(items, {
-                  placeHolder: Pickers.Packages.selectOption,
-                  ignoreFocusOut: true,
-                  showBackButton: true,
-                  matchOnDescription: false,
-                  matchOnDetail: false,
-              });
+    let showBackButton = true;
+    let selected: QuickPickItem[] | QuickPickItem | undefined = undefined;
+    if (items.length === 1) {
+        selected = items[0];
+        showBackButton = false;
+    } else {
+        selected = await showQuickPickWithButtons(items, {
+            placeHolder: Pickers.Packages.selectOption,
+            ignoreFocusOut: true,
+            showBackButton: true,
+            matchOnDescription: false,
+            matchOnDetail: false,
+        });
+    }
 
     if (selected && !Array.isArray(selected)) {
         try {
             if (selected.label === PackageManagement.workspaceDependencies) {
-                const installArgs = await selectFromInstallableToInstall(installable);
-                return { install: installArgs ?? [], uninstall: [] };
+                return await selectFromInstallableToInstall(installable, undefined, { showBackButton });
             } else if (selected.label === PackageManagement.searchCommonPackages) {
-                return await selectFromCommonPackagesToInstall(common, installed);
-            } else {
+                return await selectFromCommonPackagesToInstall(common, installed, undefined, { showBackButton });
+            } else if (selected.label === PackageManagement.skipPackageInstallation) {
                 traceInfo('Package Installer: user selected skip package installation');
                 return undefined;
+            } else {
+                return undefined;
             }
             // eslint-disable-next-line @typescript-eslint/no-explicit-any
         } catch (ex: any) {
@@ -144,12 +150,13 @@ export async function getWorkspacePackagesToInstall(
     options: PackageManagementOptions,
     project?: PythonProject[],
     environment?: PythonEnvironment,
+    log?: LogOutputChannel,
 ): Promise<PipPackages | undefined> {
     const installable = (await getProjectInstallable(api, project)) ?? [];
     let common = await getCommonPackages();
     let installed: string[] | undefined;
     if (environment) {
-        installed = (await api.getPackages(environment))?.map((pkg) => pkg.name);
+        installed = (await refreshPipPackages(environment, log, { showProgress: true }))?.map((pkg) => pkg.name);
         common = mergePackages(common, installed ?? []);
     }
     return selectWorkspaceOrCommon(installable, common, !!options.showSkipOption, installed ?? []);
@@ -166,7 +173,7 @@ export async function getProjectInstallable(
     const installable: Installable[] = [];
     await withProgress(
         {
-            location: ProgressLocation.Window,
+            location: ProgressLocation.Notification,
             title: VenvManagerStrings.searchingDependencies,
         },
         async (_progress, token) => {

src/managers/builtin/utils.ts

@@ -1,4 +1,4 @@
-import { CancellationToken, l10n, LogOutputChannel, QuickPickItem, ThemeIcon, Uri, window } from 'vscode';
+import { CancellationToken, LogOutputChannel, ProgressLocation, QuickPickItem, ThemeIcon, Uri, window } from 'vscode';
 import {
     EnvironmentManager,
     Package,
@@ -18,7 +18,8 @@ import { showErrorMessage } from '../../common/errors/utils';
 import { shortVersion, sortEnvironments } from '../common/utils';
 import { SysManagerStrings } from '../../common/localize';
 import { isUvInstalled, runUV, runPython } from './helpers';
-import { parsePipList } from './pipListUtils';
+import { parsePipList, PipPackage } from './pipListUtils';
+import { withProgress } from '../../common/window.apis';
 
 function asPackageQuickPickItem(name: string, version?: string): QuickPickItem {
     return {
@@ -138,39 +139,49 @@ export async function refreshPythons(
     return sortEnvironments(collection);
 }
 
-export async function refreshPackages(
-    environment: PythonEnvironment,
-    api: PythonEnvironmentApi,
-    manager: PackageManager,
-): Promise<Package[]> {
-    if (!environment.execInfo) {
-        manager.log?.error(`No executable found for python: ${environment.environmentPath.fsPath}`);
-        showErrorMessage(
-            l10n.t('No executable found for python: {0}', environment.environmentPath.fsPath),
-            manager.log,
-        );
-        return [];
+async function refreshPipPackagesRaw(environment: PythonEnvironment, log?: LogOutputChannel): Promise<string> {
+    const useUv = await isUvInstalled();
+    if (useUv) {
+        return await runUV(['pip', 'list', '--python', environment.execInfo.run.executable], undefined, log);
     }
+    return await runPython(environment.execInfo.run.executable, ['-m', 'pip', 'list'], undefined, log);
+}
 
+export async function refreshPipPackages(
+    environment: PythonEnvironment,
+    log?: LogOutputChannel,
+    options?: { showProgress: boolean },
+): Promise<PipPackage[] | undefined> {
     let data: string;
     try {
-        const useUv = await isUvInstalled();
-        if (useUv) {
-            data = await runUV(
-                ['pip', 'list', '--python', environment.execInfo.run.executable],
-                undefined,
-                manager.log,
+        if (options?.showProgress) {
+            data = await withProgress(
+                {
+                    location: ProgressLocation.Notification,
+                },
+                async () => {
+                    return await refreshPipPackagesRaw(environment, log);
+                },
             );
         } else {
-            data = await runPython(environment.execInfo.run.executable, ['-m', 'pip', 'list'], undefined, manager.log);
+            data = await refreshPipPackagesRaw(environment, log);
         }
+
+        return parsePipList(data);
     } catch (e) {
-        manager.log?.error('Error refreshing packages', e);
-        showErrorMessage(SysManagerStrings.packageRefreshError, manager.log);
-        return [];
+        log?.error('Error refreshing packages', e);
+        showErrorMessage(SysManagerStrings.packageRefreshError, log);
+        return undefined;
     }
+}
 
-    return parsePipList(data).map((pkg) => api.createPackageItem(pkg, environment, manager));
+export async function refreshPackages(
+    environment: PythonEnvironment,
+    api: PythonEnvironmentApi,
+    manager: PackageManager,
+): Promise<Package[]> {
+    const data = await refreshPipPackages(environment, manager.log);
+    return (data ?? []).map((pkg) => api.createPackageItem(pkg, environment, manager));
 }
 
 export async function managePackages(

src/managers/builtin/venvUtils.ts

@@ -527,6 +527,8 @@ export async function createPythonVenv(
         api,
         { showSkipOption: true, install: [] },
         project ? [project] : undefined,
+        undefined,
+        log,
     );
     const allPackages = [];
     allPackages.push(...(packages?.install ?? []), ...(options.additionalPackages ?? []));

src/managers/common/pickers.ts

@@ -105,12 +105,12 @@ function groupByInstalled(items: PackageQuickPickItem[], installed?: string[]):
     };
 }
 
-export interface CommonPackagesResult {
+interface PackagesPickerResult {
     install: string[];
     uninstall: string[];
 }
 
-function selectionsToResult(selections: string[], installed: string[]): CommonPackagesResult {
+function selectionsToResult(selections: string[], installed: string[]): PackagesPickerResult {
     const install: string[] = selections;
     const uninstall: string[] = [];
     installed.forEach((i) => {
@@ -128,7 +128,8 @@ export async function selectFromCommonPackagesToInstall(
     common: Installable[],
     installed: string[],
     preSelected?: PackageQuickPickItem[] | undefined,
-): Promise<CommonPackagesResult | undefined> {
+    options?: { showBackButton?: boolean } | undefined,
+): Promise<PackagesPickerResult | undefined> {
     const { installedItems, items } = groupByInstalled(common.map(installableToQuickPickItem), installed);
     const preSelectedItems = items.filter((i) => (preSelected ?? installedItems).some((s) => s.id === i.id));
     let selected: PackageQuickPickItem | PackageQuickPickItem[] | undefined;
@@ -139,7 +140,7 @@ export async function selectFromCommonPackagesToInstall(
                 placeHolder: PackageManagement.selectPackagesToInstall,
                 ignoreFocusOut: true,
                 canPickMany: true,
-                showBackButton: true,
+                showBackButton: options?.showBackButton,
                 buttons: [EDIT_ARGUMENTS_BUTTON],
                 selected: preSelectedItems,
             },
@@ -232,7 +233,8 @@ function getGroupedItems(items: Installable[]): PackageQuickPickItem[] {
 export async function selectFromInstallableToInstall(
     installable: Installable[],
     preSelected?: PackageQuickPickItem[],
-): Promise<string[] | undefined> {
+    options?: { showBackButton?: boolean } | undefined,
+): Promise<PackagesPickerResult | undefined> {
     const items: PackageQuickPickItem[] = [];
 
     if (installable && installable.length > 0) {
@@ -252,7 +254,7 @@ export async function selectFromInstallableToInstall(
             placeHolder: PackageManagement.selectPackagesToInstall,
             ignoreFocusOut: true,
             canPickMany: true,
-            showBackButton: true,
+            showBackButton: options?.showBackButton,
             selected: preSelectedItems,
         },
         undefined,
@@ -263,9 +265,9 @@ export async function selectFromInstallableToInstall(
 
     if (selected) {
         if (Array.isArray(selected)) {
-            return selected.flatMap((s) => s.args ?? []);
+            return { install: selected.flatMap((s) => s.args ?? []), uninstall: [] };
         } else {
-            return selected.args ?? [];
+            return { install: selected.args ?? [], uninstall: [] };
         }
     }
     return undefined;

src/managers/conda/condaUtils.ts

@@ -20,6 +20,7 @@ import {
     LogOutputChannel,
     ProgressLocation,
     QuickInputButtons,
+    QuickPickItem,
     Uri,
 } from 'vscode';
 import { ENVS_EXTENSION_ID, EXTENSION_ROOT_DIR } from '../../common/constants';
@@ -786,7 +787,7 @@ async function selectCommonPackagesOrSkip(
         return undefined;
     }
 
-    const items = [];
+    const items: QuickPickItem[] = [];
     if (common.length > 0) {
         items.push({
             label: PackageManagement.searchCommonPackages,
@@ -798,21 +799,25 @@ async function selectCommonPackagesOrSkip(
         items.push({ label: PackageManagement.skipPackageInstallation });
     }
 
-    const selected =
-        items.length === 1
-            ? items[0]
-            : await showQuickPickWithButtons(items, {
-                  placeHolder: Pickers.Packages.selectOption,
-                  ignoreFocusOut: true,
-                  showBackButton: true,
-                  matchOnDescription: false,
-                  matchOnDetail: false,
-              });
+    let showBackButton = true;
+    let selected: QuickPickItem[] | QuickPickItem | undefined = undefined;
+    if (items.length === 1) {
+        selected = items[0];
+        showBackButton = false;
+    } else {
+        selected = await showQuickPickWithButtons(items, {
+            placeHolder: Pickers.Packages.selectOption,
+            ignoreFocusOut: true,
+            showBackButton: true,
+            matchOnDescription: false,
+            matchOnDetail: false,
+        });
+    }
 
     if (selected && !Array.isArray(selected)) {
         try {
             if (selected.label === PackageManagement.searchCommonPackages) {
-                return await selectFromCommonPackagesToInstall(common, installed);
+                return await selectFromCommonPackagesToInstall(common, installed, undefined, { showBackButton });
             } else {
                 traceInfo('Package Installer: user selected skip package installation');
                 return undefined;