Cherry pick inhertEnv and disable debug adapter experiment into release (#8129)

Author: karthiknadig

experiments.json

@@ -32,26 +32,26 @@
     {
         "name": "DebugAdapterFactory - control",
         "salt": "DebugAdapterFactory",
-        "min": 80,
-        "max": 90
+        "min": 0,
+        "max": 0
     },
     {
         "name": "DebugAdapterFactory - experiment",
         "salt": "DebugAdapterFactory",
-        "min": 10,
-        "max": 20
+        "min": 0,
+        "max": 0
     },
     {
         "name": "PtvsdWheels37 - control",
         "salt": "DebugAdapterFactory",
-        "min": 87,
-        "max": 90
+        "min": 0,
+        "max": 0
     },
     {
         "name": "PtvsdWheels37 - experiment",
         "salt": "DebugAdapterFactory",
-        "min": 10,
-        "max": 13
+        "min": 0,
+        "max": 0
     },
     {
         "name": "LS - enabled",

news/2 Fixes/7836.md

@@ -0,0 +1 @@
+Do not use the PTVSD package version in the folder name for the wheel experiment.

package.nls.json

@@ -121,10 +121,11 @@
     "Experiments.inGroup": "User belongs to experiment group '{0}'",
     "Interpreters.RefreshingInterpreters": "Refreshing Python Interpreters",
     "Interpreters.LoadingInterpreters": "Loading Python Interpreters",
-    "Interpreters.condaInheritEnvMessage": "We noticed you're using a conda environment. If you are experiencing issues with this environment in the integrated terminal, we suggest the \"terminal.integrated.inheritEnv\" setting to be changed to false. Would you like to update this setting?",
+    "Interpreters.condaInheritEnvMessage": "We noticed you're using a conda environment. If you are experiencing issues with this environment in the integrated terminal, we recommend that you let the Python extension change \"terminal.integrated.inheritEnv\" to false in your user settings.",
     "Logging.CurrentWorkingDirectory": "cwd:",
     "Common.doNotShowAgain": "Do not show again",
     "Common.reload": "Reload",
+    "Common.moreInfo": "More Info",
     "OutputChannelNames.languageServer": "Python Language Server",
     "OutputChannelNames.python": "Python",
     "OutputChannelNames.pythonTest": "Python Test Log",

pythonFiles/install_ptvsd.py

@@ -40,7 +40,10 @@ def install_ptvsd():
         # Download only if it's a 3.7 wheel.
         if not wheel_info["python_version"].endswith(("37", "3.7")):
             continue
-        filename = wheel_info["filename"].rpartition(".")[0]  # Trim the file extension.
+
+        # Trim the file extension and remove the ptvsd version from the folder name.
+        filename = wheel_info["filename"].rpartition(".")[0]
+        filename = filename.replace(f"{version}-", "")
         ptvsd_path = path.join(PYTHONFILES, filename)
 
         with urllib.request.urlopen(wheel_info["url"]) as wheel_response:

pythonFiles/ptvsd_folder_name.py

@@ -6,11 +6,9 @@
 
 ROOT = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
 PYTHONFILES = os.path.join(ROOT, "pythonFiles", "lib", "python")
-REQUIREMENTS = os.path.join(ROOT, "requirements.txt")
 
 sys.path.insert(0, PYTHONFILES)
 
-from packaging.requirements import Requirement
 from packaging.tags import sys_tags
 
 sys.path.remove(PYTHONFILES)
@@ -19,23 +17,9 @@
 def ptvsd_folder_name():
     """Return the folder name for the bundled PTVSD wheel compatible with the new debug adapter."""
 
-    with open(REQUIREMENTS, "r", encoding="utf-8") as reqsfile:
-        for line in reqsfile:
-            pkgreq = Requirement(line)
-            if pkgreq.name == "ptvsd":
-                specs = pkgreq.specifier
-                try:
-                    spec, = specs
-                    version = spec.version
-                except:
-                    # Fallpack to use base PTVSD path.
-                    print(PYTHONFILES, end="")
-                    return
-                break
-
     try:
         for tag in sys_tags():
-            folder_name = f"ptvsd-{version}-{tag.interpreter}-{tag.abi}-{tag.platform}"
+            folder_name = f"ptvsd-{tag.interpreter}-{tag.abi}-{tag.platform}"
             folder_path = os.path.join(PYTHONFILES, folder_name)
             if os.path.exists(folder_path):
                 print(folder_path, end="")

pythonFiles/tests/__init__.py

@@ -10,4 +10,3 @@
 DEBUG_ADAPTER_ROOT = os.path.join(SRC_ROOT, "debug_adapter")
 
 PYTHONFILES = os.path.join(SRC_ROOT, "lib", "python")
-REQUIREMENTS = os.path.join(PROJECT_ROOT, "requirements.txt")

pythonFiles/tests/debug_adapter/test_ptvsd_folder_name.py

@@ -15,64 +15,36 @@
 from packaging.tags import sys_tags
 from ptvsd_folder_name import ptvsd_folder_name
 
-from .. import PYTHONFILES, REQUIREMENTS
-
-
-def open_requirements_with_ptvsd():
-    return patch(
-        "ptvsd_folder_name.open", mock_open(read_data="jedi==0.15.1\nptvsd==5.0.0")
-    )
-
-
-def open_requirements_without_ptvsd():
-    return patch("ptvsd_folder_name.open", mock_open(read_data="jedi==0.15.1\n"))
+from .. import PYTHONFILES
 
 
 class TestPtvsdFolderName:
     """Unit tests for the script retrieving the PTVSD folder name for the PTVSD wheels experiment."""
 
-    def test_requirement_exists_folder_exists(self, capsys):
+    def test_folder_exists(self, capsys):
         # Return the first constructed folder path as existing.
 
         patcher = patch("os.path.exists")
         mock_exists = patcher.start()
         mock_exists.side_effect = lambda p: True
         tag = next(sys_tags())
-        folder = "ptvsd-5.0.0-{}-{}-{}".format(tag.interpreter, tag.abi, tag.platform)
+        folder = "ptvsd-{}-{}-{}".format(tag.interpreter, tag.abi, tag.platform)
 
-        with open_requirements_with_ptvsd():
-            ptvsd_folder_name()
+        ptvsd_folder_name()
 
         patcher.stop()
         expected = os.path.join(PYTHONFILES, folder)
         captured = capsys.readouterr()
         assert captured.out == expected
 
-    def test_ptvsd_requirement_once(self):
-        reqs = [
-            line
-            for line in open(REQUIREMENTS, "r", encoding="utf-8")
-            if re.match("ptvsd==", line)
-        ]
-        assert len(reqs) == 1
-
-    def test_no_ptvsd_requirement(self, capsys):
-        with open_requirements_without_ptvsd() as p:
-            ptvsd_folder_name()
-
-        expected = PYTHONFILES
-        captured = capsys.readouterr()
-        assert captured.out == expected
-
     def test_no_wheel_folder(self, capsys):
         # Return none of of the constructed paths as existing,
         # ptvsd_folder_name() should return the path to default ptvsd.
         patcher = patch("os.path.exists")
         mock_no_exist = patcher.start()
         mock_no_exist.side_effect = lambda p: False
 
-        with open_requirements_with_ptvsd() as p:
-            ptvsd_folder_name()
+        ptvsd_folder_name()
 
         patcher.stop()
         expected = PYTHONFILES

pythonFiles/tests/debug_adapter/test_ptvsd_folder_name_functional.py

@@ -13,22 +13,15 @@
 import subprocess
 
 from packaging.requirements import Requirement
-from .. import PYTHONFILES, REQUIREMENTS, SRC_ROOT
+from .. import PYTHONFILES, SRC_ROOT
 
 ARGV = ["python", os.path.join(SRC_ROOT, "ptvsd_folder_name.py")]
-PREFIX = "ptvsd=="
-
-with open(REQUIREMENTS, "r", encoding="utf-8") as reqsfile:
-    for line in reqsfile:
-        if line.startswith(PREFIX):
-            VERSION = line[len(PREFIX) :].strip()
-            break
 
 
 def ptvsd_paths(*platforms):
     paths = set()
     for platform in platforms:
-        folder = "ptvsd-{}-cp37-cp37m-{}".format(VERSION, platform)
+        folder = "ptvsd-cp37-cp37m-{}".format(platform)
         paths.add(os.path.join(PYTHONFILES, folder))
     return paths
 

src/client/common/utils/localize.ts

@@ -33,6 +33,7 @@ export namespace Common {
     export const notNow = localize('Common.notNow', 'Not now');
     export const doNotShowAgain = localize('Common.doNotShowAgain', 'Do not show again');
     export const reload = localize('Common.reload', 'Reload');
+    export const moreInfo = localize('Common.moreInfo', 'More Info');
 }
 
 export namespace LanguageService {
@@ -60,7 +61,7 @@ export namespace Experiments {
 export namespace Interpreters {
     export const loading = localize('Interpreters.LoadingInterpreters', 'Loading Python Interpreters');
     export const refreshing = localize('Interpreters.RefreshingInterpreters', 'Refreshing Python Interpreters');
-    export const condaInheritEnvMessage = localize('Interpreters.condaInheritEnvMessage', 'We noticed you\'re using a conda environment. If you are experiencing issues with this environment in the integrated terminal, we suggest the \"terminal.integrated.inheritEnv\" setting to be changed to false. Would you like to update this setting?');
+    export const condaInheritEnvMessage = localize('Interpreters.condaInheritEnvMessage', 'We noticed you\'re using a conda environment. If you are experiencing issues with this environment in the integrated terminal, we recommend that you let the Python extension change \"terminal.integrated.inheritEnv\" to false in your user settings.');
     export const environmentPromptMessage = localize('Interpreters.environmentPromptMessage', 'We noticed a new virtual environment has been created. Do you want to select it for the workspace folder?');
     export const selectInterpreterTip = localize('Interpreters.selectInterpreterTip', 'Tip: you can change the Python interpreter used by the Python extension by clicking on the Python version in the status bar');
 }

src/client/interpreter/virtualEnvs/condaInheritEnvPrompt.ts

@@ -6,8 +6,9 @@ import { ConfigurationTarget, Uri } from 'vscode';
 import { IExtensionActivationService } from '../../activation/types';
 import { IApplicationShell, IWorkspaceService } from '../../common/application/types';
 import { traceDecorators, traceError } from '../../common/logger';
-import { IPersistentStateFactory } from '../../common/types';
-import { InteractiveShiftEnterBanner, Interpreters } from '../../common/utils/localize';
+import { IPlatformService } from '../../common/platform/types';
+import { IBrowserService, IPersistentStateFactory } from '../../common/types';
+import { Common, InteractiveShiftEnterBanner, Interpreters } from '../../common/utils/localize';
 import { sendTelemetryEvent } from '../../telemetry';
 import { EventName } from '../../telemetry/constants';
 import { IInterpreterService, InterpreterType } from '../contracts';
@@ -19,10 +20,12 @@ export class CondaInheritEnvPrompt implements IExtensionActivationService {
     constructor(
         @inject(IInterpreterService) private readonly interpreterService: IInterpreterService,
         @inject(IWorkspaceService) private readonly workspaceService: IWorkspaceService,
+        @inject(IBrowserService) private browserService: IBrowserService,
         @inject(IApplicationShell) private readonly appShell: IApplicationShell,
         @inject(IPersistentStateFactory) private readonly persistentStateFactory: IPersistentStateFactory,
+        @inject(IPlatformService) private readonly platformService: IPlatformService,
         @optional() public hasPromptBeenShownInCurrentSession: boolean = false
-    ) { }
+    ) {}
 
     public async activate(resource: Uri): Promise<void> {
         this.initializeInBackground(resource).ignoreErrors();
@@ -43,8 +46,8 @@ export class CondaInheritEnvPrompt implements IExtensionActivationService {
         if (!notificationPromptEnabled.value) {
             return;
         }
-        const prompts = [InteractiveShiftEnterBanner.bannerLabelYes(), InteractiveShiftEnterBanner.bannerLabelNo()];
-        const telemetrySelections: ['Yes', 'No'] = ['Yes', 'No'];
+        const prompts = [InteractiveShiftEnterBanner.bannerLabelYes(), InteractiveShiftEnterBanner.bannerLabelNo(), Common.moreInfo()];
+        const telemetrySelections: ['Yes', 'No', 'More Info'] = ['Yes', 'No', 'More Info'];
         const selection = await this.appShell.showInformationMessage(Interpreters.condaInheritEnvMessage(), ...prompts);
         sendTelemetryEvent(EventName.CONDA_INHERIT_ENV_PROMPT, undefined, { selection: selection ? telemetrySelections[prompts.indexOf(selection)] : undefined });
         if (!selection) {
@@ -54,6 +57,8 @@ export class CondaInheritEnvPrompt implements IExtensionActivationService {
             await this.workspaceService.getConfiguration('terminal').update('integrated.inheritEnv', false, ConfigurationTarget.Global);
         } else if (selection === prompts[1]) {
             await notificationPromptEnabled.updateValue(false);
+        } else if (selection === prompts[2]) {
+            this.browserService.launch('https://aka.ms/AA66i8f');
         }
     }
 
@@ -62,6 +67,9 @@ export class CondaInheritEnvPrompt implements IExtensionActivationService {
         if (this.hasPromptBeenShownInCurrentSession) {
             return false;
         }
+        if (this.platformService.isWindows) {
+            return false;
+        }
         const interpreter = await this.interpreterService.getActiveInterpreter(resource);
         if (!interpreter || interpreter.type !== InterpreterType.Conda) {
             return false;