Create environment proposed api

Author: karthiknadig

src/client/environmentApi.ts

@@ -31,6 +31,7 @@ import {
     ResolvedEnvironment,
     Resource,
 } from './apiTypes';
+import { buildEnvironmentCreationApi } from './pythonEnvironments/creation/createEnvApi';
 
 type ActiveEnvironmentChangeEvent = {
     resource: WorkspaceFolder | undefined;
@@ -253,6 +254,7 @@ export function buildEnvironmentApi(
             sendApiTelemetry('onDidChangeEnvironments');
             return onEnvironmentsChanged.event;
         },
+        ...buildEnvironmentCreationApi(),
     };
     return environmentApi;
 }

src/client/proposedApiTypes.ts

@@ -1,4 +1,8 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 
-export interface ProposedExtensionAPI {}
+export interface ProposedExtensionAPI {
+    /**
+     * Top level poposed APIs should go here.
+     */
+}

src/client/pythonEnvironments/creation/createEnvApi.ts

@@ -9,14 +9,15 @@ import { IInterpreterQuickPick } from '../../interpreter/configuration/types';
 import { getCreationEvents, handleCreateEnvironmentCommand } from './createEnvironment';
 import { condaCreationProvider } from './provider/condaCreationProvider';
 import { VenvCreationProvider } from './provider/venvCreationProvider';
+import { showInformationMessage } from '../../common/vscodeApis/windowApis';
+import { CreateEnv } from '../../common/utils/localize';
 import {
-    CreateEnvironmentExitedEventArgs,
-    CreateEnvironmentOptions,
     CreateEnvironmentProvider,
+    CreateEnvironmentOptions,
     CreateEnvironmentResult,
-} from './types';
-import { showInformationMessage } from '../../common/vscodeApis/windowApis';
-import { CreateEnv } from '../../common/utils/localize';
+    ProposedCreateEnvironmentAPI,
+    DidCreateEnvironmentParams,
+} from './proposed.createEnvApis';
 
 class CreateEnvironmentProviders {
     private _createEnvProviders: CreateEnvironmentProvider[] = [];
@@ -26,6 +27,9 @@ class CreateEnvironmentProviders {
     }
 
     public add(provider: CreateEnvironmentProvider) {
+        if (this._createEnvProviders.filter((p) => p.id === provider.id).length > 0) {
+            throw new Error(`Create Environment provider with id ${provider.id} already registered`);
+        }
         this._createEnvProviders.push(provider);
     }
 
@@ -63,15 +67,32 @@ export function registerCreateEnvironmentFeatures(
                 return handleCreateEnvironmentCommand(providers, options);
             },
         ),
-    );
-    disposables.push(registerCreateEnvironmentProvider(new VenvCreationProvider(interpreterQuickPick)));
-    disposables.push(registerCreateEnvironmentProvider(condaCreationProvider()));
-    disposables.push(
-        onCreateEnvironmentExited(async (e: CreateEnvironmentExitedEventArgs) => {
-            if (e.result?.path && e.options?.selectEnvironment) {
-                await interpreterPathService.update(e.result.uri, ConfigurationTarget.WorkspaceFolder, e.result.path);
-                showInformationMessage(`${CreateEnv.informEnvCreation} ${pathUtils.getDisplayName(e.result.path)}`);
+        registerCreateEnvironmentProvider(new VenvCreationProvider(interpreterQuickPick)),
+        registerCreateEnvironmentProvider(condaCreationProvider()),
+        onCreateEnvironmentExited(async (e: DidCreateEnvironmentParams) => {
+            if (e.path && e.options?.selectEnvironment) {
+                await interpreterPathService.update(e.uri, ConfigurationTarget.WorkspaceFolder, e.path);
+                showInformationMessage(`${CreateEnv.informEnvCreation} ${pathUtils.getDisplayName(e.path)}`);
             }
         }),
     );
 }
+
+export function buildEnvironmentCreationApi(): ProposedCreateEnvironmentAPI {
+    return {
+        onWillCreateEnvironment: onCreateEnvironmentStarted,
+        onDidCreateEnvironment: onCreateEnvironmentExited,
+        createEnvironment: async (
+            options?: CreateEnvironmentOptions | undefined,
+        ): Promise<CreateEnvironmentResult | undefined> => {
+            const providers = _createEnvironmentProviders.getAll();
+            try {
+                return await handleCreateEnvironmentCommand(providers, options);
+            } catch (err) {
+                return { error: err as Error };
+            }
+        },
+        registerCreateEnvironmentProvider: (provider: CreateEnvironmentProvider) =>
+            registerCreateEnvironmentProvider(provider),
+    };
+}

src/client/pythonEnvironments/creation/createEnvironment.ts

@@ -11,15 +11,15 @@ import {
 } from '../../common/vscodeApis/windowApis';
 import { traceError, traceVerbose } from '../../logging';
 import {
-    CreateEnvironmentExitedEventArgs,
     CreateEnvironmentOptions,
-    CreateEnvironmentProvider,
     CreateEnvironmentResult,
-    CreateEnvironmentStartedEventArgs,
-} from './types';
+    CreateEnvironmentProvider,
+    WillCreateEnvironmentParams,
+    DidCreateEnvironmentParams,
+} from './proposed.createEnvApis';
 
-const onCreateEnvironmentStartedEvent = new EventEmitter<CreateEnvironmentStartedEventArgs>();
-const onCreateEnvironmentExitedEvent = new EventEmitter<CreateEnvironmentExitedEventArgs>();
+const onCreateEnvironmentStartedEvent = new EventEmitter<WillCreateEnvironmentParams>();
+const onCreateEnvironmentExitedEvent = new EventEmitter<DidCreateEnvironmentParams>();
 
 let startedEventCount = 0;
 
@@ -32,14 +32,14 @@ function fireStartedEvent(options?: CreateEnvironmentOptions): void {
     startedEventCount += 1;
 }
 
-function fireExitedEvent(result?: CreateEnvironmentResult, options?: CreateEnvironmentOptions, error?: unknown): void {
-    onCreateEnvironmentExitedEvent.fire({ result, options, error });
+function fireExitedEvent(result?: CreateEnvironmentResult, options?: CreateEnvironmentOptions, error?: Error): void {
+    onCreateEnvironmentExitedEvent.fire({ ...result, options, error });
     startedEventCount -= 1;
 }
 
 export function getCreationEvents(): {
-    onCreateEnvironmentStarted: Event<CreateEnvironmentStartedEventArgs>;
-    onCreateEnvironmentExited: Event<CreateEnvironmentExitedEventArgs>;
+    onCreateEnvironmentStarted: Event<WillCreateEnvironmentParams>;
+    onCreateEnvironmentExited: Event<DidCreateEnvironmentParams>;
     isCreatingEnvironment: () => boolean;
 } {
     return {
@@ -54,7 +54,7 @@ async function createEnvironment(
     options: CreateEnvironmentOptions,
 ): Promise<CreateEnvironmentResult | undefined> {
     let result: CreateEnvironmentResult | undefined;
-    let err: unknown | undefined;
+    let err: Error | undefined;
     try {
         fireStartedEvent(options);
         result = await provider.createEnvironment(options);
@@ -65,7 +65,7 @@ async function createEnvironment(
                 return undefined;
             }
         }
-        err = ex;
+        err = ex as Error;
         throw err;
     } finally {
         fireExitedEvent(result, options, err);
@@ -185,11 +185,7 @@ export async function handleCreateEnvironmentCommand(
     const action = await MultiStepNode.run(envTypeStep);
     if (options?.showBackButton) {
         if (action === MultiStepAction.Back || action === MultiStepAction.Cancel) {
-            result = {
-                path: result?.path,
-                uri: result?.uri,
-                action: action === MultiStepAction.Back ? 'Back' : 'Cancel',
-            };
+            result = { action };
         }
     }
 

src/client/pythonEnvironments/creation/proposed.createEnvApis.ts

@@ -0,0 +1,161 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License
+
+import { Uri, Event, Disposable } from 'vscode';
+
+export type CreateEnvironmentUserActions = 'Back' | 'Cancel';
+export type CreateEnvironmentProviderId = string;
+
+/**
+ * Options used when creating a Python environment.
+ */
+export interface CreateEnvironmentOptions {
+    /**
+     * Default `true`. If `true`, the environment creation handler is expected to install packages.
+     */
+    installPackages?: boolean;
+
+    /**
+     * Default `true`. If `true`, the environment creation provider is expected to add the environment to ignore list
+     * for the source control.
+     */
+    ignoreSourceControl?: boolean;
+
+    /**
+     * Default `false`. If `true` the creation provider should show back button when showing QuickPick or QuickInput.
+     */
+    showBackButton?: boolean;
+
+    /**
+     * Default `true`. If `true`, the environment will be selected as the environment to be used for the workspace.
+     */
+    selectEnvironment?: boolean;
+}
+
+/**
+ * Params passed on `onWillCreateEnvironment` event handler.
+ */
+export interface WillCreateEnvironmentParams {
+    /**
+     * Options used to create a Python environment.
+     */
+    options: CreateEnvironmentOptions | undefined;
+}
+
+/**
+ * Params passed on `onDidCreateEnvironment` event handler.
+ */
+export interface DidCreateEnvironmentParams {
+    /**
+     * Options used to create the Python environment.
+     */
+    options?: CreateEnvironmentOptions;
+
+    /**
+     * Workspace Uri associated with the environment.
+     */
+    uri?: Uri;
+
+    /**
+     * Path to the executable python in the environment
+     */
+    path?: string;
+
+    /**
+     * User action that resulted in exit from the create environment flow.
+     */
+    action?: CreateEnvironmentUserActions;
+
+    /**
+     * Error if any occurred during environment creation.
+     */
+    error?: Error;
+}
+
+export interface CreateEnvironmentResult {
+    /**
+     * Workspace Uri associated with the environment.
+     */
+    uri?: Uri;
+
+    /**
+     * Path to the python executable in the environment.
+     */
+    path?: string;
+
+    /**
+     * User action that resulted in exit from the create environment flow.
+     */
+    action?: CreateEnvironmentUserActions;
+
+    /**
+     * Error if any occurred during environment creation.
+     */
+    error?: Error;
+}
+
+/**
+ * Extensions that want to contribute their own environment creation can do that by registering an object
+ * that implements this interface.
+ */
+export interface CreateEnvironmentProvider {
+    /**
+     * This API is called when user selects this provider from a QuickPick to select the type of environment
+     * user wants. This API is expected to show a QuickPick or QuickInput to get the user input and return
+     * the path to the Python executable in the environment.
+     *
+     * @param {CreateEnvironmentOptions} [options] Options used to create a Python environment.
+     *
+     * @returns a promise that resolves to the path to the
+     * Python executable in the environment. Or any action taken by the user, such as back or cancel.
+     */
+    createEnvironment(options?: CreateEnvironmentOptions): Promise<CreateEnvironmentResult | undefined>;
+
+    /**
+     * Unique ID for the creation provider, typically <ExtensionId>:<environment-type | guid>
+     */
+    id: CreateEnvironmentProviderId;
+
+    /**
+     * Display name for the creation provider.
+     */
+    name: string;
+
+    /**
+     * Description displayed to the user in the QuickPick to select environment provider.
+     */
+    description: string;
+
+    /**
+     * Tools used to manage this environment. e.g., ['conda']
+     */
+    tools?: string[];
+}
+
+export interface ProposedCreateEnvironmentAPI {
+    /**
+     * This API can be used to detect when the environment creation starts for any registered
+     * provider (including internal providers). This will also receive any options passed in
+     * or defaults used to create environment.
+     */
+    onWillCreateEnvironment: Event<WillCreateEnvironmentParams>;
+
+    /**
+     * This API can be used to detect when the environment provider exits for any registered
+     * provider (including internal providers). This will also receive created environment path,
+     * any errors, or user actions taken from the provider.
+     */
+    onDidCreateEnvironment: Event<DidCreateEnvironmentParams>;
+
+    /**
+     * This API will show a QuickPick to select an environment provider from available list of
+     * providers. Based on the selection the `createEnvironment` will be called on the provider.
+     */
+    createEnvironment(options: CreateEnvironmentOptions): Promise<CreateEnvironmentResult | undefined>;
+
+    /**
+     * This API should be called to register an environment creation provider. It returns
+     * a (@link Disposable} which can be used to remove the registration.
+     */
+    registerCreateEnvironmentProvider(provider: CreateEnvironmentProvider): Disposable;
+}

src/client/pythonEnvironments/creation/provider/condaCreationProvider.ts

@@ -5,12 +5,7 @@ import { CancellationToken, ProgressLocation, WorkspaceFolder } from 'vscode';
 import * as path from 'path';
 import { Commands, PVSC_EXTENSION_ID } from '../../../common/constants';
 import { traceError, traceLog } from '../../../logging';
-import {
-    CreateEnvironmentOptions,
-    CreateEnvironmentProgress,
-    CreateEnvironmentProvider,
-    CreateEnvironmentResult,
-} from '../types';
+import { CreateEnvironmentProgress } from '../types';
 import { pickWorkspaceFolder } from '../common/workspaceSelection';
 import { execObservable } from '../../../common/process/rawProcessApis';
 import { createDeferred } from '../../../common/utils/async';
@@ -28,6 +23,11 @@ import {
     CONDA_ENV_EXISTING_MARKER,
 } from './condaProgressAndTelemetry';
 import { splitLines } from '../../../common/stringUtils';
+import {
+    CreateEnvironmentOptions,
+    CreateEnvironmentResult,
+    CreateEnvironmentProvider,
+} from '../proposed.createEnvApis';
 
 function generateCommandArgs(version?: string, options?: CreateEnvironmentOptions): string[] {
     let addGitIgnore = true;

src/client/pythonEnvironments/creation/provider/venvCreationProvider.ts

@@ -9,12 +9,7 @@ import { execObservable } from '../../../common/process/rawProcessApis';
 import { createDeferred } from '../../../common/utils/async';
 import { Common, CreateEnv } from '../../../common/utils/localize';
 import { traceError, traceInfo, traceLog } from '../../../logging';
-import {
-    CreateEnvironmentOptions,
-    CreateEnvironmentProgress,
-    CreateEnvironmentProvider,
-    CreateEnvironmentResult,
-} from '../types';
+import { CreateEnvironmentProgress } from '../types';
 import { pickWorkspaceFolder } from '../common/workspaceSelection';
 import { IInterpreterQuickPick } from '../../../interpreter/configuration/types';
 import { EnvironmentType, PythonEnvironment } from '../../info';
@@ -25,6 +20,11 @@ import { VenvProgressAndTelemetry, VENV_CREATED_MARKER, VENV_EXISTING_MARKER } f
 import { showErrorMessageWithLogs } from '../common/commonUtils';
 import { IPackageInstallSelection, pickPackagesToInstall } from './venvUtils';
 import { InputFlowAction } from '../../../common/utils/multiStepInput';
+import {
+    CreateEnvironmentProvider,
+    CreateEnvironmentOptions,
+    CreateEnvironmentResult,
+} from '../proposed.createEnvApis';
 
 function generateCommandArgs(installInfo?: IPackageInstallSelection[], addGitIgnore?: boolean): string[] {
     const command: string[] = [createVenvScript()];