Add experiment to implicitly use environment variables for environment activation (#20651)

Author: Kartik Raj

.eslintignore

@@ -146,7 +146,6 @@ src/client/interpreter/configuration/services/workspaceUpdaterService.ts
 src/client/interpreter/configuration/services/workspaceFolderUpdaterService.ts
 src/client/interpreter/helpers.ts
 src/client/interpreter/virtualEnvs/condaInheritEnvPrompt.ts
-src/client/interpreter/activation/service.ts
 src/client/interpreter/display/index.ts
 
 src/client/api.ts

package-lock.json

@@ -19,6 +19,7 @@
     "publisher": "ms-python",
     "enabledApiProposals": [
         "quickPickSortByLabel",
+        "envShellEvent",
         "testObserver"
     ],
     "author": {
@@ -40,7 +41,7 @@
         "theme": "dark"
     },
     "engines": {
-        "vscode": "^1.75.0-20230123"
+        "vscode": "^1.76.0"
     },
     "keywords": [
         "python",
@@ -426,12 +427,14 @@
                         "enum": [
                             "All",
                             "pythonSurveyNotification",
-                            "pythonPromptNewToolsExt"
+                            "pythonPromptNewToolsExt",
+                            "pythonTerminalEnvVarActivation"
                         ],
                         "enumDescriptions": [
                             "%python.experiments.All.description%",
                             "%python.experiments.pythonSurveyNotification.description%",
-                            "%python.experiments.pythonPromptNewToolsExt.description%"
+                            "%python.experiments.pythonPromptNewToolsExt.description%",
+                            "%python.experiments.pythonTerminalEnvVarActivation.description%"
                         ]
                     },
                     "scope": "machine",
@@ -445,12 +448,14 @@
                         "enum": [
                             "All",
                             "pythonSurveyNotification",
-                            "pythonPromptNewToolsExt"
+                            "pythonPromptNewToolsExt",
+                            "pythonTerminalEnvVarActivation"
                         ],
                         "enumDescriptions": [
                             "%python.experiments.All.description%",
                             "%python.experiments.pythonSurveyNotification.description%",
-                            "%python.experiments.pythonPromptNewToolsExt.description%"
+                            "%python.experiments.pythonPromptNewToolsExt.description%",
+                            "%python.experiments.pythonTerminalEnvVarActivation.description%"
                         ]
                     },
                     "scope": "machine",
@@ -1868,7 +1873,7 @@
         "@types/stack-trace": "0.0.29",
         "@types/tmp": "^0.0.33",
         "@types/uuid": "^8.3.4",
-        "@types/vscode": "^1.74.0",
+        "@types/vscode": "^1.75.0",
         "@types/which": "^2.0.1",
         "@types/winreg": "^1.2.30",
         "@types/xml2js": "^0.4.2",

package.json

@@ -37,6 +37,7 @@
     "python.experiments.All.description": "Combined list of all experiments.",
     "python.experiments.pythonSurveyNotification.description": "Denotes the Python Survey Notification experiment.",
     "python.experiments.pythonPromptNewToolsExt.description": "Denotes the Python Prompt New Tools Extension experiment.",
+    "python.experiments.pythonTerminalEnvVarActivation.description": "Enables use of environment variables to activate terminals instead of sending activation commands.",
     "python.formatting.autopep8Args.description": "Arguments passed in. Each argument is a separate item in the array.",
     "python.formatting.autopep8Path.description": "Path to autopep8, you can use a custom version of autopep8 by modifying this setting to include the full path.",
     "python.formatting.blackArgs.description": "Arguments passed in. Each argument is a separate item in the array.",

package.nls.json

@@ -7,6 +7,7 @@ import { inject, injectable } from 'inversify';
 import * as path from 'path';
 import { parse } from 'semver';
 import * as vscode from 'vscode';
+import { traceError } from '../../logging';
 import { Channel } from '../constants';
 import { IPlatformService } from '../platform/types';
 import { ICurrentProcess, IPathUtils } from '../types';
@@ -70,19 +71,22 @@ export class ApplicationEnvironment implements IApplicationEnvironment {
     public get extensionName(): string {
         return this.packageJson.displayName;
     }
-    /**
-     * At the time of writing this API, the vscode.env.shell isn't officially released in stable version of VS Code.
-     * Using this in stable version seems to throw errors in VSC with messages being displayed to the user about use of
-     * unstable API.
-     * Solution - log and suppress the errors.
-     * @readonly
-     * @type {(string)}
-     * @memberof ApplicationEnvironment
-     */
+
     public get shell(): string {
         return vscode.env.shell;
     }
 
+    public get onDidChangeShell(): vscode.Event<string> {
+        try {
+            return vscode.env.onDidChangeShell;
+        } catch (ex) {
+            traceError('Failed to get onDidChangeShell API', ex);
+            // `onDidChangeShell` is a proposed API at the time of writing this, so wrap this in a try...catch
+            // block in case the API is removed or changed.
+            return new vscode.EventEmitter<string>().event;
+        }
+    }
+
     public get packageJson(): any {
         return require('../../../../package.json');
     }

src/client/common/application/applicationEnvironment.ts

@@ -1048,6 +1048,10 @@ export interface IApplicationEnvironment {
      * @memberof IApplicationShell
      */
     readonly shell: string;
+    /**
+     * An {@link Event} which fires when the default shell changes.
+     */
+    readonly onDidChangeShell: Event<string>;
     /**
      * Gets the vscode channel (whether 'insiders' or 'stable').
      */

src/client/common/application/types.ts

@@ -6,3 +6,7 @@ export enum ShowExtensionSurveyPrompt {
 export enum ShowToolsExtensionPrompt {
     experiment = 'pythonPromptNewToolsExt',
 }
+
+export enum TerminalEnvVarActivation {
+    experiment = 'pythonTerminalEnvVarActivation',
+}

src/client/common/experiments/groups.ts

@@ -0,0 +1,21 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+'use strict';
+
+import { workspace } from 'vscode';
+import { isTestExecution } from '../constants';
+import { IExperimentService } from '../types';
+import { TerminalEnvVarActivation } from './groups';
+
+export function inTerminalEnvVarExperiment(experimentService: IExperimentService): boolean {
+    if (workspace.workspaceFile && !isTestExecution()) {
+        // Don't run experiment in multi-root workspaces for now, requires work on VSCode:
+        // https://github.com/microsoft/vscode/issues/171173
+        return false;
+    }
+    if (!experimentService.inExperimentSync(TerminalEnvVarActivation.experiment)) {
+        return false;
+    }
+    return true;
+}

src/client/common/experiments/helpers.ts

@@ -7,11 +7,11 @@ import { inject, injectable } from 'inversify';
 import { traceLog } from '../../logging';
 import { IWorkspaceService } from '../application/types';
 import { isCI, isTestExecution } from '../constants';
-import { Logging } from '../utils/localize';
 import { getOSType, getUserHomeDir, OSType } from '../utils/platform';
 import { IProcessLogger, SpawnOptions } from './types';
 import { escapeRegExp } from 'lodash';
 import { replaceAll } from '../stringUtils';
+import { identifyShellFromShellPath } from '../terminal/shellDetectors/baseShellDetector';
 
 @injectable()
 export class ProcessLogger implements IProcessLogger {
@@ -27,8 +27,11 @@ export class ProcessLogger implements IProcessLogger {
             ? [fileOrCommand, ...args].map((e) => e.trimQuotes().toCommandArgumentForPythonExt()).join(' ')
             : fileOrCommand;
         const info = [`> ${this.getDisplayCommands(command)}`];
-        if (options && options.cwd) {
-            info.push(`${Logging.currentWorkingDirectory} ${this.getDisplayCommands(options.cwd)}`);
+        if (options?.cwd) {
+            info.push(`cwd: ${this.getDisplayCommands(options.cwd)}`);
+        }
+        if (typeof options?.shell === 'string') {
+            info.push(`shell: ${identifyShellFromShellPath(options?.shell)}`);
         }
 
         info.forEach((line) => {

src/client/common/process/logger.ts

@@ -5,7 +5,8 @@
 
 import { inject, injectable, multiInject } from 'inversify';
 import { Terminal } from 'vscode';
-import { IConfigurationService } from '../../types';
+import { inTerminalEnvVarExperiment } from '../../experiments/helpers';
+import { IConfigurationService, IExperimentService } from '../../types';
 import { ITerminalActivationHandler, ITerminalActivator, ITerminalHelper, TerminalActivationOptions } from '../types';
 import { BaseTerminalActivator } from './base';
 
@@ -17,6 +18,7 @@ export class TerminalActivator implements ITerminalActivator {
         @inject(ITerminalHelper) readonly helper: ITerminalHelper,
         @multiInject(ITerminalActivationHandler) private readonly handlers: ITerminalActivationHandler[],
         @inject(IConfigurationService) private readonly configurationService: IConfigurationService,
+        @inject(IExperimentService) private readonly experimentService: IExperimentService,
     ) {
         this.initialize();
     }
@@ -37,7 +39,8 @@ export class TerminalActivator implements ITerminalActivator {
         options?: TerminalActivationOptions,
     ): Promise<boolean> {
         const settings = this.configurationService.getSettings(options?.resource);
-        const activateEnvironment = settings.terminal.activateEnvironment;
+        const activateEnvironment =
+            settings.terminal.activateEnvironment && !inTerminalEnvVarExperiment(this.experimentService);
         if (!activateEnvironment || options?.hideFromUser) {
             return false;
         }