fix: powershell script update by querying $profile

Author: karthiknadig

.vscode/launch.json

@@ -30,7 +30,7 @@
             "program": "${workspaceFolder}/node_modules/mocha/bin/_mocha",
             "skipFiles": ["<node_internals>/**"],
             "outFiles": ["${workspaceFolder}/out/**/*.js", "!${workspaceFolder}/**/node_modules**/*"],
-            "preLaunchTask": "tasks: watch-tests"
+            "preLaunchTask": "${defaultBuildTask}"
         },
         {
             "name": "Extension Tests",
@@ -41,7 +41,7 @@
                 "--extensionTestsPath=${workspaceFolder}/out/test/"
             ],
             "outFiles": ["${workspaceFolder}/out/**/*.js", "${workspaceFolder}/dist/**/*.js"],
-            "preLaunchTask": "tasks: watch-tests"
+            "preLaunchTask": "${defaultBuildTask}"
         }
     ]
 }

.vscode/tasks.json

@@ -11,10 +11,6 @@
             "presentation": {
                 "reveal": "never",
                 "group": "watchers"
-            },
-            "group": {
-                "kind": "build",
-                "isDefault": true
             }
         },
         {
@@ -25,13 +21,20 @@
             "presentation": {
                 "reveal": "never",
                 "group": "watchers"
-            },
-            "group": "build"
+            }
         },
         {
-            "label": "tasks: watch-tests",
+            "label": "tasks: build",
             "dependsOn": ["npm: watch", "npm: watch-tests"],
-            "problemMatcher": []
+            "problemMatcher": [],
+            "presentation": {
+                "reveal": "never",
+                "group": "watchers"
+            },
+            "group": {
+                "kind": "build",
+                "isDefault": true
+            }
         },
         {
             "type": "npm",

src/common/commands.ts

@@ -0,0 +1,3 @@
+export namespace Commands {
+    export const viewLogs = 'python-envs.viewLogs';
+}

src/common/errors/utils.ts

@@ -1,6 +1,7 @@
 import * as stackTrace from 'stack-trace';
-import { commands, LogOutputChannel, window } from 'vscode';
+import { commands, LogOutputChannel } from 'vscode';
 import { Common } from '../localize';
+import { showErrorMessage, showWarningMessage } from '../window.apis';
 
 export function parseStack(ex: Error) {
     if (ex.stack && Array.isArray(ex.stack)) {
@@ -10,8 +11,8 @@ export function parseStack(ex: Error) {
     return stackTrace.parse.call(stackTrace, ex);
 }
 
-export async function showErrorMessage(message: string, log?: LogOutputChannel) {
-    const result = await window.showErrorMessage(message, Common.viewLogs);
+export async function showErrorMessageWithLogs(message: string, log?: LogOutputChannel) {
+    const result = await showErrorMessage(message, Common.viewLogs);
     if (result === Common.viewLogs) {
         if (log) {
             log.show();
@@ -21,8 +22,8 @@ export async function showErrorMessage(message: string, log?: LogOutputChannel)
     }
 }
 
-export async function showWarningMessage(message: string, log?: LogOutputChannel) {
-    const result = await window.showWarningMessage(message, Common.viewLogs);
+export async function showWarningMessageWithLogs(message: string, log?: LogOutputChannel) {
+    const result = await showWarningMessage(message, Common.viewLogs);
     if (result === Common.viewLogs) {
         if (log) {
             log.show();

src/common/localize.ts

@@ -1,4 +1,5 @@
 import { l10n } from 'vscode';
+import { Commands } from './commands';
 
 export namespace Common {
     export const recommended = l10n.t('Recommended');
@@ -147,10 +148,20 @@ export namespace EnvViewStrings {
 
 export namespace ShellStartupActivationStrings {
     export const shellStartupScriptEditPrompt = l10n.t(
-        'To support `shellStartup` we need to modify your shell profile. Do you want to proceed?',
+        'To support Python Terminal activation using `shellStartup` we need to modify your shell profile. Do you want to proceed?',
     );
+    export const updatingTheseProfiles = l10n.t('Updating these profiles');
     export const updateScript = l10n.t('Update Shell Profile');
     export const revertToCommandActivation = l10n.t(
         'Auto Shell Activation type set to "command", due to removing shell startup from profile.',
     );
+    export const envCollectionDescription = l10n.t('Environment variables for shell activation');
+    export const shellStartupScriptEditComplete = l10n.t(
+        'Shell startup profile updated. See [logs](command:{0})',
+        Commands.viewLogs,
+    );
+    export const shellStartupScriptEditFailed = l10n.t(
+        'Failed to update shell startup profile. See [logs](command:{0})',
+        Commands.viewLogs,
+    );
 }

src/common/utils/pythonPath.ts

@@ -1,9 +1,9 @@
 import { Uri, Progress, CancellationToken } from 'vscode';
 import { PythonEnvironment } from '../../api';
 import { InternalEnvironmentManager } from '../../internal.api';
-import { showErrorMessage } from '../errors/utils';
 import { traceVerbose, traceError } from '../logging';
 import { PYTHON_EXTENSION_ID } from '../constants';
+import { showErrorMessage } from '../window.apis';
 
 const priorityOrder = [
     `${PYTHON_EXTENSION_ID}:pyenv`,

src/common/window.apis.ts

@@ -301,6 +301,21 @@ export function showInformationMessage<T extends MessageItem>(
     return window.showInformationMessage(message, options, ...items);
 }
 
+export function showErrorMessage<T extends string>(message: string, ...items: T[]): Thenable<T | undefined>;
+export function showErrorMessage<T extends MessageItem>(message: string, ...items: T[]): Thenable<T | undefined>;
+export function showErrorMessage<T extends string>(
+    message: string,
+    options: MessageOptions,
+    ...items: T[]
+): Thenable<T | undefined>;
+export function showErrorMessage<T extends MessageItem>(
+    message: string,
+    options: MessageOptions,
+    ...items: T[]
+): Thenable<T | undefined> {
+    return window.showErrorMessage(message, options, ...items);
+}
+
 export function showWarningMessage(message: string, ...items: string[]): Thenable<string | undefined> {
     return window.showWarningMessage(message, ...items);
 }

src/features/creators/autoFindProjects.ts

@@ -1,10 +1,9 @@
 import * as path from 'path';
 import { Uri } from 'vscode';
-import { showQuickPickWithButtons } from '../../common/window.apis';
+import { showErrorMessage, showQuickPickWithButtons } from '../../common/window.apis';
 import { ProjectCreatorString } from '../../common/localize';
 import { PythonProject, PythonProjectCreator, PythonProjectCreatorOptions } from '../../api';
 import { PythonProjectManager } from '../../internal.api';
-import { showErrorMessage } from '../../common/errors/utils';
 import { findFiles } from '../../common/workspace.apis';
 
 function getUniqueUri(uris: Uri[]): {

src/features/envCommands.ts

@@ -41,8 +41,8 @@ import { pickProject, pickProjectMany } from '../common/pickers/projects';
 import { TerminalManager } from './terminal/terminalManager';
 import { runInTerminal } from './terminal/runInTerminal';
 import { quoteArgs } from './execution/execUtils';
-import { showErrorMessage } from '../common/errors/utils';
-import { activeTextEditor } from '../common/window.apis';
+import {} from '../common/errors/utils';
+import { activeTextEditor, showErrorMessage } from '../common/window.apis';
 import { clipboardWriteText } from '../common/env.apis';
 
 export async function refreshManagerCommand(context: unknown): Promise<void> {

src/features/terminal/startup/activateUsingShellStartup.ts

@@ -6,7 +6,7 @@ import { DidChangeEnvironmentEventArgs } from '../../../api';
 import { EnvironmentManagers } from '../../../internal.api';
 import { traceError, traceInfo } from '../../../common/logging';
 import { ShellStartupActivationStrings } from '../../../common/localize';
-import { showInformationMessage } from '../../../common/window.apis';
+import { showErrorMessage, showInformationMessage } from '../../../common/window.apis';
 
 export interface ShellStartupActivationManager extends Disposable {
     initialize(): Promise<void>;
@@ -21,6 +21,7 @@ export class ShellStartupActivationManagerImpl implements ShellStartupActivation
         private readonly shellStartupProviders: ShellStartupProvider[],
         private readonly em: EnvironmentManagers,
     ) {
+        this.envCollection.description = ShellStartupActivationStrings.envCollectionDescription;
         this.disposables.push(
             onDidChangeConfiguration((e: ConfigurationChangeEvent) => {
                 this.handleConfigurationChange(e);
@@ -93,9 +94,10 @@ export class ShellStartupActivationManagerImpl implements ShellStartupActivation
         const autoActType = getAutoActivationType();
         if (autoActType === 'shellStartup') {
             if (await this.isSetupRequired()) {
+                const shells = this.shellStartupProviders.map((provider) => provider.name).join(', ');
                 const result = await showInformationMessage(
                     ShellStartupActivationStrings.shellStartupScriptEditPrompt,
-                    { modal: true },
+                    { modal: true, detail: `${ShellStartupActivationStrings.updatingTheseProfiles}: ${shells}` },
                     ShellStartupActivationStrings.updateScript,
                 );
 
@@ -143,7 +145,25 @@ export class ShellStartupActivationManagerImpl implements ShellStartupActivation
     }
 
     public async updateStartupScripts(): Promise<void> {
-        await Promise.all(this.shellStartupProviders.map((provider) => provider.setupScripts()));
+        const results = await Promise.all(
+            this.shellStartupProviders.map(async (provider) => {
+                const result = await provider.setupScripts();
+                if (!result) {
+                    traceError(`Failed to setup shell startup scripts for ${provider.name}`);
+                }
+                return result;
+            }),
+        );
+
+        const success = results.every((result) => result);
+
+        // Intentionally not awaiting this message. We don’t need a response here, and awaiting here for user response can
+        // block setting up rest of the startup activation.
+        if (success) {
+            showInformationMessage(ShellStartupActivationStrings.shellStartupScriptEditComplete);
+        } else {
+            showErrorMessage(ShellStartupActivationStrings.shellStartupScriptEditFailed);
+        }
     }
 
     public async cleanupStartupScripts(): Promise<void> {