Cleanup environment discovery types (microsoft#19268)

Kartik Raj · web-flow · commit ef79f92622c5 · 2022-06-08T16:47:18.000-07:00
diff --git a/src/client/pythonEnvironments/base/info/envKind.ts b/src/client/pythonEnvironments/base/info/envKind.ts
@@ -12,10 +12,8 @@ export function getKindDisplayName(kind: PythonEnvKind): string {
     for (const [candidate, value] of [
         // Note that Unknown is excluded here.
         [PythonEnvKind.System, 'system'],
-        [PythonEnvKind.MacDefault, 'mac default'],
         [PythonEnvKind.WindowsStore, 'windows store'],
         [PythonEnvKind.Pyenv, 'pyenv'],
-        [PythonEnvKind.CondaBase, 'conda'],
         [PythonEnvKind.Poetry, 'poetry'],
         [PythonEnvKind.Custom, 'custom'],
         // For now we treat OtherGlobal like Unknown.
@@ -58,7 +56,6 @@ export function getKindDisplayName(kind: PythonEnvKind): string {
 export function getPrioritizedEnvKinds(): PythonEnvKind[] {
     return [
         PythonEnvKind.Pyenv,
-        PythonEnvKind.CondaBase,
         PythonEnvKind.Conda,
         PythonEnvKind.WindowsStore,
         PythonEnvKind.Pipenv,
@@ -68,7 +65,6 @@ export function getPrioritizedEnvKinds(): PythonEnvKind[] {
         PythonEnvKind.VirtualEnv,
         PythonEnvKind.OtherVirtual,
         PythonEnvKind.OtherGlobal,
-        PythonEnvKind.MacDefault,
         PythonEnvKind.System,
         PythonEnvKind.Custom,
         PythonEnvKind.Unknown,
diff --git a/src/client/pythonEnvironments/base/info/index.ts b/src/client/pythonEnvironments/base/info/index.ts
@@ -12,11 +12,9 @@ export enum PythonEnvKind {
     Unknown = 'unknown',
     // "global"
     System = 'global-system',
-    MacDefault = 'global-mac-default',
     WindowsStore = 'global-windows-store',
     Pyenv = 'global-pyenv',
-    CondaBase = 'global-conda-base',
-    Poetry = 'global-poetry',
+    Poetry = 'poetry',
     Custom = 'global-custom',
     OtherGlobal = 'global-other',
     // "virtual"
diff --git a/src/client/pythonEnvironments/base/locators/composite/envsReducer.ts b/src/client/pythonEnvironments/base/locators/composite/envsReducer.ts
@@ -6,6 +6,7 @@ import { Event, EventEmitter } from 'vscode';
 import { traceVerbose } from '../../../../logging';
 import { PythonEnvKind } from '../../info';
 import { areSameEnv } from '../../info/env';
+import { getPrioritizedEnvKinds } from '../../info/envKind';
 import {
     BasicEnvInfo,
     ILocator,
@@ -144,50 +145,8 @@ function resolveEnvCollision(oldEnv: BasicEnvInfo, newEnv: BasicEnvInfo): BasicE
 function sortEnvInfoByPriority(...envs: BasicEnvInfo[]): BasicEnvInfo[] {
     // TODO: When we consolidate the PythonEnvKind and EnvironmentType we should have
     // one location where we define priority.
-    const envKindByPriority: PythonEnvKind[] = getPrioritizedEnvironmentKind();
+    const envKindByPriority: PythonEnvKind[] = getPrioritizedEnvKinds();
     return envs.sort(
         (a: BasicEnvInfo, b: BasicEnvInfo) => envKindByPriority.indexOf(a.kind) - envKindByPriority.indexOf(b.kind),
     );
 }
-
-/**
- * Gets a prioritized list of environment types for identification.
- * @returns {PythonEnvKind[]} : List of environments ordered by identification priority
- *
- * Remarks: This is the order of detection based on how the various distributions and tools
- * configure the environment, and the fall back for identification.
- * Top level we have the following environment types, since they leave a unique signature
- * in the environment or * use a unique path for the environments they create.
- *  1. Pyenv (pyenv can also be a conda env or venv, but should be activated as a venv)
- *  2. Conda
- *  3. Windows Store
- *  4. PipEnv
- *  5. Poetry
- *
- * Next level we have the following virtual environment tools. The are here because they
- * are consumed by the tools above, and can also be used independently.
- *  1. venv
- *  2. virtualenvwrapper
- *  3. virtualenv
- *
- * Last category is globally installed python, or system python.
- */
-function getPrioritizedEnvironmentKind(): PythonEnvKind[] {
-    return [
-        PythonEnvKind.Pyenv,
-        PythonEnvKind.CondaBase,
-        PythonEnvKind.Conda,
-        PythonEnvKind.WindowsStore,
-        PythonEnvKind.Pipenv,
-        PythonEnvKind.Poetry,
-        PythonEnvKind.Venv,
-        PythonEnvKind.VirtualEnvWrapper,
-        PythonEnvKind.VirtualEnv,
-        PythonEnvKind.OtherVirtual,
-        PythonEnvKind.OtherGlobal,
-        PythonEnvKind.MacDefault,
-        PythonEnvKind.System,
-        PythonEnvKind.Custom,
-        PythonEnvKind.Unknown,
-    ];
-}
diff --git a/src/client/pythonEnvironments/legacyIOC.ts b/src/client/pythonEnvironments/legacyIOC.ts
@@ -27,11 +27,9 @@ const convertedKinds = new Map(
     Object.entries({
         [PythonEnvKind.OtherGlobal]: EnvironmentType.Global,
         [PythonEnvKind.System]: EnvironmentType.System,
-        [PythonEnvKind.MacDefault]: EnvironmentType.System,
         [PythonEnvKind.WindowsStore]: EnvironmentType.WindowsStore,
         [PythonEnvKind.Pyenv]: EnvironmentType.Pyenv,
         [PythonEnvKind.Conda]: EnvironmentType.Conda,
-        [PythonEnvKind.CondaBase]: EnvironmentType.Conda,
         [PythonEnvKind.VirtualEnv]: EnvironmentType.VirtualEnv,
         [PythonEnvKind.Pipenv]: EnvironmentType.Pipenv,
         [PythonEnvKind.Poetry]: EnvironmentType.Poetry,
diff --git a/src/test/pythonEnvironments/base/info/envKind.unit.test.ts b/src/test/pythonEnvironments/base/info/envKind.unit.test.ts
@@ -10,10 +10,8 @@ import { getKindDisplayName, getPrioritizedEnvKinds } from '../../../../client/p
 const KIND_NAMES: [PythonEnvKind, string][] = [
     // We handle PythonEnvKind.Unknown separately.
     [PythonEnvKind.System, 'system'],
-    [PythonEnvKind.MacDefault, 'macDefault'],
     [PythonEnvKind.WindowsStore, 'winStore'],
     [PythonEnvKind.Pyenv, 'pyenv'],
-    [PythonEnvKind.CondaBase, 'condaBase'],
     [PythonEnvKind.Poetry, 'poetry'],
     [PythonEnvKind.Custom, 'customGlobal'],
     [PythonEnvKind.OtherGlobal, 'otherGlobal'],
diff --git a/src/test/pythonEnvironments/base/locatorUtils.unit.test.ts b/src/test/pythonEnvironments/base/locatorUtils.unit.test.ts
@@ -79,7 +79,7 @@ suite('Python envs locator utils - getQueryFilter', () => {
 
     suite('kinds', () => {
         test('match none', () => {
-            const query: PythonLocatorQuery = { kinds: [PythonEnvKind.MacDefault] };
+            const query: PythonLocatorQuery = { kinds: [PythonEnvKind.Poetry] };
 
             const filter = getQueryFilter(query);
             const filtered = envs.filter(filter);
