fix: improve some install selection bugs

Author: karthiknadig

src/managers/builtin/pipUtils.ts

@@ -7,8 +7,9 @@ import { PackageManagement, Pickers, VenvManagerStrings } from '../../common/loc
 import { PackageManagementOptions, PythonEnvironment, PythonEnvironmentApi, PythonProject } from '../../api';
 import { findFiles } from '../../common/workspace.apis';
 import { EXTENSION_ROOT_DIR } from '../../common/constants';
-import { Installable, selectFromCommonPackagesToInstall, selectFromInstallableToInstall } from '../common/pickers';
+import { selectFromCommonPackagesToInstall, selectFromInstallableToInstall } from '../common/pickers';
 import { traceInfo } from '../../common/logging';
+import { Installable, mergePackages } from '../common/utils';
 
 async function tomlParse(fsPath: string, log?: LogOutputChannel): Promise<tomljs.JsonMap> {
     try {
@@ -145,10 +146,11 @@ export async function getWorkspacePackagesToInstall(
     environment?: PythonEnvironment,
 ): Promise<PipPackages | undefined> {
     const installable = (await getProjectInstallable(api, project)) ?? [];
-    const common = await getCommonPackages();
+    let common = await getCommonPackages();
     let installed: string[] | undefined;
     if (environment) {
         installed = (await api.getPackages(environment))?.map((pkg) => pkg.name);
+        common = mergePackages(common, installed ?? []);
     }
     return selectWorkspaceOrCommon(installable, common, !!options.showSkipOption, installed ?? []);
 }

src/managers/common/pickers.ts

@@ -2,6 +2,7 @@ import { QuickInputButtons, QuickPickItem, QuickPickItemButtonEvent, QuickPickIt
 import { Common, PackageManagement } from '../../common/localize';
 import { launchBrowser } from '../../common/env.apis';
 import { showInputBoxWithButtons, showQuickPickWithButtons, showTextDocument } from '../../common/window.apis';
+import { Installable } from './utils';
 
 const OPEN_BROWSER_BUTTON = {
     iconPath: new ThemeIcon('globe'),
@@ -18,50 +19,6 @@ const EDIT_ARGUMENTS_BUTTON = {
     tooltip: PackageManagement.editArguments,
 };
 
-export interface Installable {
-    /**
-     * The name of the package, requirements, lock files, or step name.
-     */
-    readonly name: string;
-
-    /**
-     * The name of the package, requirements, pyproject.toml or any other project file, etc.
-     */
-    readonly displayName: string;
-
-    /**
-     * Arguments passed to the package manager to install the package.
-     *
-     * @example
-     *  ['debugpy==1.8.7'] for `pip install debugpy==1.8.7`.
-     *  ['--pre', 'debugpy'] for `pip install --pre debugpy`.
-     *  ['-r', 'requirements.txt'] for `pip install -r requirements.txt`.
-     */
-    readonly args?: string[];
-
-    /**
-     * Installable group name, this will be used to group installable items in the UI.
-     *
-     * @example
-     *  `Requirements` for any requirements file.
-     *  `Packages` for any package.
-     */
-    readonly group?: string;
-
-    /**
-     * Description about the installable item. This can also be path to the requirements,
-     * version of the package, or any other project file path.
-     */
-    readonly description?: string;
-
-    /**
-     * External Uri to the package on pypi or docs.
-     * @example
-     *  https://pypi.org/project/debugpy/ for `debugpy`.
-     */
-    readonly uri?: Uri;
-}
-
 function handleItemButton(uri?: Uri) {
     if (uri) {
         if (uri.scheme.toLowerCase().startsWith('http')) {
@@ -118,7 +75,7 @@ async function enterPackageManually(filler?: string): Promise<string[] | undefin
 }
 
 interface GroupingResult {
-    items: QuickPickItem[];
+    items: PackageQuickPickItem[];
     installedItems: PackageQuickPickItem[];
 }
 
@@ -132,11 +89,13 @@ function groupByInstalled(items: PackageQuickPickItem[], installed?: string[]):
             result.push(i);
         }
     });
-    const installedSeparator: QuickPickItem = {
+    const installedSeparator: PackageQuickPickItem = {
+        id: 'installed-sep',
         label: PackageManagement.installed,
         kind: QuickPickItemKind.Separator,
     };
-    const commonPackages: QuickPickItem = {
+    const commonPackages: PackageQuickPickItem = {
+        id: 'common-packages-sep',
         label: PackageManagement.commonPackages,
         kind: QuickPickItemKind.Separator,
     };
@@ -171,7 +130,7 @@ export async function selectFromCommonPackagesToInstall(
     preSelected?: PackageQuickPickItem[] | undefined,
 ): Promise<CommonPackagesResult | undefined> {
     const { installedItems, items } = groupByInstalled(common.map(installableToQuickPickItem), installed);
-    const preSelectedItems = [...installedItems, ...(preSelected ?? [])];
+    const preSelectedItems = items.filter((i) => (preSelected ?? installedItems).some((s) => s.id === i.id));
     let selected: PackageQuickPickItem | PackageQuickPickItem[] | undefined;
     try {
         selected = await showQuickPickWithButtons(
@@ -208,10 +167,8 @@ export async function selectFromCommonPackagesToInstall(
 
     if (selected && Array.isArray(selected)) {
         if (selected.find((s) => s.label === PackageManagement.enterPackageNames)) {
-            const filler = selected
-                .filter((s) => s.label !== PackageManagement.enterPackageNames)
-                .map((s) => s.id)
-                .join(' ');
+            const filtered = selected.filter((s) => s.label !== PackageManagement.enterPackageNames);
+            const filler = filtered.map((s) => s.id).join(' ');
             try {
                 const selections = await enterPackageManually(filler);
                 if (selections) {
@@ -220,7 +177,7 @@ export async function selectFromCommonPackagesToInstall(
                 return undefined;
             } catch (ex) {
                 if (ex === QuickInputButtons.Back) {
-                    return selectFromCommonPackagesToInstall(common, installed, selected);
+                    return selectFromCommonPackagesToInstall(common, installed, filtered);
                 }
                 return undefined;
             }

src/managers/common/utils.ts

@@ -1,5 +1,50 @@
 import * as os from 'os';
 import { PythonEnvironment } from '../../api';
+import { Uri } from 'vscode';
+
+export interface Installable {
+    /**
+     * The name of the package, requirements, lock files, or step name.
+     */
+    readonly name: string;
+
+    /**
+     * The name of the package, requirements, pyproject.toml or any other project file, etc.
+     */
+    readonly displayName: string;
+
+    /**
+     * Arguments passed to the package manager to install the package.
+     *
+     * @example
+     *  ['debugpy==1.8.7'] for `pip install debugpy==1.8.7`.
+     *  ['--pre', 'debugpy'] for `pip install --pre debugpy`.
+     *  ['-r', 'requirements.txt'] for `pip install -r requirements.txt`.
+     */
+    readonly args?: string[];
+
+    /**
+     * Installable group name, this will be used to group installable items in the UI.
+     *
+     * @example
+     *  `Requirements` for any requirements file.
+     *  `Packages` for any package.
+     */
+    readonly group?: string;
+
+    /**
+     * Description about the installable item. This can also be path to the requirements,
+     * version of the package, or any other project file path.
+     */
+    readonly description?: string;
+
+    /**
+     * External Uri to the package on pypi or docs.
+     * @example
+     *  https://pypi.org/project/debugpy/ for `debugpy`.
+     */
+    readonly uri?: Uri;
+}
 
 export function isWindows(): boolean {
     return process.platform === 'win32';
@@ -86,3 +131,10 @@ export function getLatest(collection: PythonEnvironment[]): PythonEnvironment |
     }
     return latest;
 }
+
+export function mergePackages(common: Installable[], installed: string[]): Installable[] {
+    const notInCommon = installed.filter((pkg) => !common.some((c) => c.name === pkg));
+    return common
+        .concat(notInCommon.map((pkg) => ({ name: pkg, displayName: pkg })))
+        .sort((a, b) => a.name.localeCompare(b.name));
+}

src/managers/conda/condaUtils.ts

@@ -33,12 +33,12 @@ import {
 import { getConfiguration } from '../../common/workspace.apis';
 import { getGlobalPersistentState, getWorkspacePersistentState } from '../../common/persistentState';
 import which from 'which';
-import { isWindows, shortVersion, sortEnvironments, untildify } from '../common/utils';
+import { Installable, isWindows, shortVersion, sortEnvironments, untildify } from '../common/utils';
 import { pickProject } from '../../common/pickers/projects';
 import { CondaStrings, PackageManagement, Pickers } from '../../common/localize';
 import { showErrorMessage } from '../../common/errors/utils';
 import { showInputBox, showQuickPick, showQuickPickWithButtons, withProgress } from '../../common/window.apis';
-import { Installable, selectFromCommonPackagesToInstall } from '../common/pickers';
+import { selectFromCommonPackagesToInstall } from '../common/pickers';
 import { quoteArgs } from '../../features/execution/execUtils';
 import { traceInfo } from '../../common/logging';