Add "Default" LS setting, which picks between Jedi/Pylance #16139

jakebailey · 2021-05-04T20:31:25Z

Adds a new "Default" setting, which implies Pylance when Pylance installed, otherwise uses jedi (plus/minus the LSP experiment).

For https://github.com/microsoft/vscode-python-internalbacklog/issues/176.

jakebailey · 2021-05-04T20:31:41Z

package.json

                        "Jedi",
                        "JediLSP",
                        "Pylance",
                        "Microsoft",
                        "None"
                    ],
-                    "default": "Jedi",
+                    "default": "Default",


Should I remove this change now?

Seems fine for now, why do you think this needs to be removed?

This one can probably stay regardless, but the other code makes Pylance the default (and IDK when we want to actually flip that switch; this PR or another.

I think we'll be fine; hopefully #16069 will be merged before this one, we can then merge default-language-server in main (PR here), and then when this PR makes it in default-language-server we can hold off on merging it in main again until we're good to go.

jakebailey · 2021-05-04T20:32:02Z

package.json

@@ -1225,13 +1225,14 @@
                "python.languageServer": {
                    "type": "string",
                    "enum": [
+                        "Default",


I think this block could use an enumDescriptions to define the semantics of each of these.

Here you go: #16141

jakebailey · 2021-05-04T20:33:52Z

src/client/common/configSettings.ts

@@ -167,7 +167,7 @@ export class PythonSettings implements IPythonSettings {
        private readonly experimentsManager?: IExperimentsManager,
        private readonly interpreterPathService?: IInterpreterPathService,
        private readonly interpreterSecurityService?: IInterpreterSecurityService,
-        private readonly defaultJedi?: IDefaultLanguageServer,
+        private readonly defaultLS?: IDefaultLanguageServer,


The meaning of IDefaultLanguageServer has changed to return what "Default" will mean; before it also checked the user's settings, which was too much. This file is what actually determines the final result.

jakebailey · 2021-05-04T20:34:25Z

src/client/common/configSettings.ts

+            userLS === 'Default' ||
+            !Object.values(LanguageServerType).includes(userLS as LanguageServerType)
+        ) {
+            ls = this.defaultLS?.defaultLSType ?? LanguageServerType.Jedi;


defaultLS can be undefined, so I had to hardcode some default here, but I'm honestly not sure under which conditions this can be the case.

Since you removed the condition in setDefaultLanguageServer I don't see why it would ever be undefined either, unless this instance gets added before setDefaultLanguageServer is called?

I tried making it required, and hit a bunch of places that simply don't have access to the data needed, so IDK what's going on there.

jakebailey · 2021-05-04T20:36:27Z

src/client/activation/common/defaultlanguageServer.ts

+    experimentService: IExperimentService,
+    extensions: IExtensions,
+): Promise<PotentialDefault> {
+    if (extensions.getExtension<ILSExtensionApi>(PYLANCE_EXTENSION_ID)) {


I would have liked to call activate here and figure out of Pylance is functional or not, but Pylance hard deps on Python, and this means that activate will block forever due to the cycle.

We'll have to rely on later checks to fallback to Jedi.

src/client/activation/common/defaultlanguageServer.ts

kimadeline · 2021-05-04T21:22:34Z

package.json

                        "Jedi",
                        "JediLSP",
                        "Pylance",
                        "Microsoft",
                        "None"
                    ],
-                    "default": "Jedi",
+                    "default": "Default",


Seems fine for now, why do you think this needs to be removed?

kimadeline · 2021-05-04T22:44:12Z

Added @karthiknadig because he did the JediLSP work

…new-default-ls-setting

jakebailey · 2021-05-04T23:48:20Z

We'll probably want to change

vscode-python/src/client/activation/activationService.ts

Lines 236 to 241 in fb6b722

    
           if (serverType === LanguageServerType.JediLSP && interpreter && interpreter.version) { 
        
               if (interpreter.version.major < 3 || (interpreter.version.major === 3 && interpreter.version.minor < 6)) { 
        
                   sendTelemetryEvent(EventName.JEDI_FALLBACK); 
        
                   serverType = LanguageServerType.Jedi; 
        
               } 
        
           }

to also do the check for Pylance, since we don't do python 2 either... But I'll have to check the implications of this because I hacked the refcounting system to only have one instance of pylance at any given time.

Is Python 2 going away anytime soon? :)

jakebailey · 2021-05-05T00:48:20Z

Fixed the title; no idea why it did that.

kimadeline · 2021-05-05T18:37:46Z

What happened

jakebailey · 2021-05-05T18:46:29Z

GH really did not like that. I'll have to rebase and resend.

karrtikr

LGTM otherwise.

karrtikr · 2021-05-05T18:48:02Z

src/client/common/configSettings.ts

+        if (
+            !userLS ||
+            userLS === 'Default' ||
+            !Object.values(LanguageServerType).includes(userLS as LanguageServerType)


Not sure what this condition signifies. Does this mean if user has selected an invalid LS value, we select the default LS in those cases?

Correct. We can't trust user values from enums, so this checks for invalid ones and then selects the default if they are present. That's sort of the problem with the VS code settings API; it's too easy to make mistakes.

karrtikr · 2021-05-05T18:52:13Z

src/client/activation/common/defaultlanguageServer.ts

+import { ILSExtensionApi } from '../node/languageServerFolderService';
+import { LanguageServerType } from '../types';
+
+export type PotentialDefault = LanguageServerType.Jedi | LanguageServerType.JediLSP | LanguageServerType.Node;


Need not be exported.

Good catch; this should be with IDefaultLanguageServer.

jakebailey added 3 commits May 4, 2021 13:21

Add Default LS setting

02c5127

Remove unused code

45b6420

Remove debug log

b4c90b4

jakebailey requested a review from kimadeline May 4, 2021 20:31

jakebailey commented May 4, 2021

View reviewed changes

github-actions bot assigned kimadeline May 4, 2021

github-actions bot requested a review from karrtikr May 4, 2021 21:13

jakebailey changed the title ~~Bundle Pylance as part of an extension pack (not a hard dependency) (#16077)~~ Bundle Pylance as part of an extension pack (not a hard dependency) May 4, 2021

kimadeline reviewed May 4, 2021

View reviewed changes

kimadeline added skip package*.json package.json and package-lock.json don't both need updating no-changelog No news entry required labels May 4, 2021

Restore tryGet

c3d461d

kimadeline requested a review from karthiknadig May 4, 2021 22:43

Merge remote-tracking branch 'upstream/default-language-server' into …

8cbfde9

…new-default-ls-setting

jakebailey changed the title ~~Bundle Pylance as part of an extension pack (not a hard dependency)~~ Add "Default" LS setting, which picks between Jedi/Pylance May 5, 2021

kimadeline closed this May 5, 2021

kimadeline deleted the branch microsoft:default-language-server May 5, 2021 18:28

jakebailey mentioned this pull request May 5, 2021

Add "Default" LS setting, which picks between Jedi/Pylance #16155

Merged

karrtikr approved these changes May 5, 2021

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add "Default" LS setting, which picks between Jedi/Pylance #16139

Add "Default" LS setting, which picks between Jedi/Pylance #16139

jakebailey commented May 4, 2021 •

edited

Loading

jakebailey May 4, 2021

kimadeline May 4, 2021

jakebailey May 4, 2021

kimadeline May 4, 2021 •

edited

Loading

jakebailey May 4, 2021

kimadeline May 4, 2021

jakebailey May 4, 2021

jakebailey May 4, 2021

kimadeline May 4, 2021

jakebailey May 4, 2021

jakebailey May 4, 2021

kimadeline May 4, 2021

kimadeline commented May 4, 2021

jakebailey commented May 4, 2021

jakebailey commented May 5, 2021

kimadeline commented May 5, 2021

jakebailey commented May 5, 2021

karrtikr left a comment

karrtikr May 5, 2021

jakebailey May 5, 2021

karrtikr May 5, 2021

jakebailey May 5, 2021

Add "Default" LS setting, which picks between Jedi/Pylance #16139

Add "Default" LS setting, which picks between Jedi/Pylance #16139

Conversation

jakebailey commented May 4, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kimadeline May 4, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kimadeline commented May 4, 2021

jakebailey commented May 4, 2021

jakebailey commented May 5, 2021

kimadeline commented May 5, 2021

jakebailey commented May 5, 2021

karrtikr left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jakebailey commented May 4, 2021 •

edited

Loading

kimadeline May 4, 2021 •

edited

Loading