Activate banner prompt for Pylance (#12817)

* Fix path

* Actually fix settings

* Add news

* Add test

* Format

* Suppress 'jediEnabled' removal

* Drop survey first launch threshold

* Remove LS experiments

* Frequency + tests

* Fix test

* Update message to match spec

* Open workspace for extension rather than changing setting

* Fix localization string

* Show banners asynchronously

* Add experiments

* Formatting

* Typo

* Put back verifyAll

* Remove obsolete experiments, add Pylance

* Suppress experiment if Pylance is installed

* PR feedback

Co-authored-by: Jake Bailey <[email protected]>

Author: Mikhail Arkhipov

experiments.json

@@ -65,18 +65,6 @@
         "min": 0,
         "max": 0
     },
-    {
-        "name": "LS - enabled",
-        "salt": "LS",
-        "min": 0,
-        "max": 4
-    },
-    {
-        "name": "LS - control",
-        "salt": "LS",
-        "min": 20,
-        "max": 24
-    },
     {
         "name": "UseTerminalToGetActivatedEnvVars - experiment",
         "salt": "UseTerminalToGetActivatedEnvVars",

package.json

@@ -1827,7 +1827,6 @@
                     "default": [],
                     "items": {
                         "enum": [
-                            "LS - enabled",
                             "AlwaysDisplayTestExplorer - experiment",
                             "ShowExtensionSurveyPrompt - enabled",
                             "Reload - experiment",
@@ -1841,6 +1840,7 @@
                             "DeprecatePythonPath - experiment",
                             "RunByLine - experiment",
                             "EnableTrustedNotebooks",
+                            "tryPylance",
                             "All"
                         ]
                     },
@@ -1852,7 +1852,6 @@
                     "default": [],
                     "items": {
                         "enum": [
-                            "LS - enabled",
                             "AlwaysDisplayTestExplorer - experiment",
                             "ShowExtensionSurveyPrompt - enabled",
                             "Reload - experiment",
@@ -1866,6 +1865,7 @@
                             "DeprecatePythonPath - experiment",
                             "RunByLine - experiment",
                             "EnableTrustedNotebooks",
+                            "tryPylance",
                             "All"
                         ]
                     },

package.nls.json

@@ -109,6 +109,9 @@
     "python.snippet.launch.django.label": "Python: Django",
     "python.snippet.launch.flask.label": "Python: Flask",
     "python.snippet.launch.pyramid.label": "Python: Pyramid Application",
+    "LanguageService.proposePylanceMessage": "Try out a new faster, feature-rich language server for Python by Microsoft, Pylance! Install the extension now.",
+    "LanguageService.tryItNow": "Try it now",
+    "LanguageService.remindMeLater": "Remind me later",
     "LanguageService.bannerLabelYes": "Yes, take survey now",
     "LanguageService.bannerLabelNo": "No, thanks",
     "LanguageService.lsFailedToStart": "We encountered an issue starting the Language Server. Reverting to the alternative, Jedi. Check the Python output panel for details.",

src/client/activation/activationService.ts

@@ -9,12 +9,10 @@ import { LSNotSupportedDiagnosticServiceId } from '../application/diagnostics/ch
 import { IDiagnosticsService } from '../application/diagnostics/types';
 import { IApplicationShell, ICommandManager, IWorkspaceService } from '../common/application/types';
 import { STANDARD_OUTPUT_CHANNEL } from '../common/constants';
-import { LSControl, LSEnabled } from '../common/experiments/groups';
 import { traceError } from '../common/logger';
 import {
     IConfigurationService,
     IDisposableRegistry,
-    IExperimentsManager,
     IOutputChannel,
     IPersistentStateFactory,
     IPythonSettings,
@@ -58,8 +56,7 @@ export class LanguageServerExtensionActivationService
 
     constructor(
         @inject(IServiceContainer) private serviceContainer: IServiceContainer,
-        @inject(IPersistentStateFactory) private stateFactory: IPersistentStateFactory,
-        @inject(IExperimentsManager) private readonly abExperiments: IExperimentsManager
+        @inject(IPersistentStateFactory) private stateFactory: IPersistentStateFactory
     ) {
         this.workspaceService = this.serviceContainer.get<IWorkspaceService>(IWorkspaceService);
         this.interpreterService = this.serviceContainer.get<IInterpreterService>(IInterpreterService);
@@ -175,17 +172,6 @@ export class LanguageServerExtensionActivationService
      * @returns `true` if user is using jedi, `false` if user is using language server
      */
     public useJedi(): boolean {
-        // Check if `languageServer` setting is missing (default configuration).
-        if (this.isJediUsingDefaultConfiguration(this.resource)) {
-            // If user is assigned to an experiment (i.e. use LS), return false.
-            if (this.abExperiments.inExperiment(LSEnabled)) {
-                return false;
-            }
-            // Send telemetry if user is in control group
-            this.abExperiments.sendTelemetryIfInExperiment(LSControl);
-            return true; // Do use Jedi as it is default.
-        }
-        // Configuration is non-default, so `languageServer` should be present.
         const configurationService = this.serviceContainer.get<IConfigurationService>(IConfigurationService);
         const lstType = configurationService.getSettings(this.resource).languageServer;
         return lstType === LanguageServerType.Jedi;

src/client/activation/languageServer/activator.ts

@@ -1,13 +1,15 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 
-import { inject, injectable } from 'inversify';
+import { inject, injectable, named } from 'inversify';
 import * as path from 'path';
 
 import { IWorkspaceService } from '../../common/application/types';
+import { isTestExecution } from '../../common/constants';
 import { traceDecorators } from '../../common/logger';
 import { IFileSystem } from '../../common/platform/types';
-import { IConfigurationService, Resource } from '../../common/types';
+import { BANNER_NAME_PROPOSE_LS, IConfigurationService, IPythonExtensionBanner, Resource } from '../../common/types';
+import { PythonInterpreter } from '../../pythonEnvironments/info';
 import { LanguageServerActivatorBase } from '../common/activatorBase';
 import { ILanguageServerDownloader, ILanguageServerFolderService, ILanguageServerManager } from '../types';
 
@@ -27,11 +29,21 @@ export class DotNetLanguageServerActivator extends LanguageServerActivatorBase {
         @inject(IFileSystem) fs: IFileSystem,
         @inject(ILanguageServerDownloader) lsDownloader: ILanguageServerDownloader,
         @inject(ILanguageServerFolderService) languageServerFolderService: ILanguageServerFolderService,
-        @inject(IConfigurationService) configurationService: IConfigurationService
+        @inject(IConfigurationService) configurationService: IConfigurationService,
+        @inject(IPythonExtensionBanner)
+        @named(BANNER_NAME_PROPOSE_LS)
+        private proposePylancePopup: IPythonExtensionBanner
     ) {
         super(manager, workspace, fs, lsDownloader, languageServerFolderService, configurationService);
     }
 
+    public async start(resource: Resource, interpreter?: PythonInterpreter): Promise<void> {
+        if (!isTestExecution()) {
+            this.proposePylancePopup.showBanner().ignoreErrors();
+        }
+        return super.start(resource, interpreter);
+    }
+
     @traceDecorators.error('Failed to ensure language server is available')
     public async ensureLanguageServerIsAvailable(resource: Resource): Promise<void> {
         const languageServerFolderPath = await this.ensureLanguageServerFileIsAvailable(resource, 'mscorlib.dll');

src/client/activation/node/languageServerFolderService.ts

@@ -8,14 +8,13 @@ import { inject, injectable } from 'inversify';
 import * as path from 'path';
 import { SemVer } from 'semver';
 import { IWorkspaceService } from '../../common/application/types';
+import { PYLANCE_EXTENSION_ID } from '../../common/constants';
 import { NugetPackage } from '../../common/nuget/types';
 import { IConfigurationService, IExtensions, Resource } from '../../common/types';
 import { IServiceContainer } from '../../ioc/types';
 import { LanguageServerFolderService } from '../common/languageServerFolderService';
 import { FolderVersionPair, ILanguageServerFolderService, NodeLanguageServerFolder } from '../types';
 
-export const PylanceExtensionName = 'ms-python.vscode-pylance';
-
 class FallbackNodeLanguageServerFolderService extends LanguageServerFolderService {
     constructor(serviceContainer: IServiceContainer) {
         super(serviceContainer, NodeLanguageServerFolder);
@@ -101,7 +100,7 @@ export class NodeLanguageServerFolderService implements ILanguageServerFolderSer
             return undefined;
         }
 
-        const extension = this.extensions.getExtension<ILSExtensionApi>(PylanceExtensionName);
+        const extension = this.extensions.getExtension<ILSExtensionApi>(PYLANCE_EXTENSION_ID);
         if (!extension) {
             return undefined;
         }

src/client/activation/none/activator.ts

@@ -1,6 +1,6 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
-import { injectable } from 'inversify';
+import { inject, injectable, named } from 'inversify';
 import {
     CancellationToken,
     CodeLens,
@@ -20,7 +20,8 @@ import {
     TextDocument,
     WorkspaceEdit
 } from 'vscode';
-import { Resource } from '../../common/types';
+import { isTestExecution } from '../../common/constants';
+import { BANNER_NAME_PROPOSE_LS, IPythonExtensionBanner, Resource } from '../../common/types';
 import { PythonInterpreter } from '../../pythonEnvironments/info';
 import { ILanguageServerActivator } from '../types';
 
@@ -33,8 +34,16 @@ import { ILanguageServerActivator } from '../types';
  */
 @injectable()
 export class NoLanguageServerExtensionActivator implements ILanguageServerActivator {
-    // tslint:disable-next-line: no-empty
-    public async start(_resource: Resource, _interpreter?: PythonInterpreter): Promise<void> {}
+    constructor(
+        @inject(IPythonExtensionBanner)
+        @named(BANNER_NAME_PROPOSE_LS)
+        private proposePylancePopup: IPythonExtensionBanner
+    ) {}
+    public async start(_resource: Resource, _interpreter?: PythonInterpreter): Promise<void> {
+        if (!isTestExecution()) {
+            this.proposePylancePopup.showBanner().ignoreErrors();
+        }
+    }
     // tslint:disable-next-line: no-empty
     public dispose(): void {}
     // tslint:disable-next-line: no-empty

src/client/activation/serviceRegistry.ts

@@ -12,7 +12,7 @@ import {
 import { DataScienceSurveyBanner } from '../datascience/dataScienceSurveyBanner';
 import { InteractiveShiftEnterBanner } from '../datascience/shiftEnterBanner';
 import { IServiceManager } from '../ioc/types';
-import { ProposeLanguageServerBanner } from '../languageServices/proposeLanguageServerBanner';
+import { ProposePylanceBanner } from '../languageServices/proposeLanguageServerBanner';
 import { AATesting } from './aaTesting';
 import { ExtensionActivationManager } from './activationManager';
 import { LanguageServerExtensionActivationService } from './activationService';
@@ -86,7 +86,7 @@ export function registerTypes(serviceManager: IServiceManager, languageServerTyp
 
     serviceManager.addSingleton<IPythonExtensionBanner>(
         IPythonExtensionBanner,
-        ProposeLanguageServerBanner,
+        ProposePylanceBanner,
         BANNER_NAME_PROPOSE_LS
     );
     serviceManager.addSingleton<IPythonExtensionBanner>(

src/client/common/application/applicationEnvironment.ts

@@ -88,4 +88,7 @@ export class ApplicationEnvironment implements IApplicationEnvironment {
         const version = parse(this.packageJson.version);
         return !version || version.prerelease.length > 0 ? 'insiders' : 'stable';
     }
+    public get uriScheme(): string {
+        return vscode.env.uriScheme;
+    }
 }

src/client/common/application/types.ts

@@ -1024,6 +1024,10 @@ export interface IApplicationEnvironment {
      * The version of the editor.
      */
     readonly vscodeVersion: string;
+    /**
+     * The custom uri scheme the editor registers to in the operating system.
+     */
+    readonly uriScheme: string;
 }
 
 export const IWebPanelMessageListener = Symbol('IWebPanelMessageListener');

src/client/common/constants.ts

@@ -15,6 +15,7 @@ export const PYTHON_ALLFILES = [{ language: PYTHON_LANGUAGE }];
 
 export const PVSC_EXTENSION_ID = 'ms-python.python';
 export const CODE_RUNNER_EXTENSION_ID = 'formulahendry.code-runner';
+export const PYLANCE_EXTENSION_ID = 'ms-python.vscode-pylance';
 export const AppinsightsKey = 'AIF-d9b70cd4-b9f9-4d70-929b-a071c400b217';
 
 export namespace Commands {

src/client/common/experiments/groups.ts

@@ -1,6 +1,3 @@
-export const LSControl = 'LS - control';
-export const LSEnabled = 'LS - enabled';
-
 // Experiment to check whether to always display the test explorer.
 export enum AlwaysDisplayTestExplorerGroups {
     control = 'AlwaysDisplayTestExplorer - control',
@@ -99,3 +96,8 @@ export enum RemoveKernelToolbarInInteractiveWindow {
 export enum EnableTrustedNotebooks {
     experiment = 'EnableTrustedNotebooks'
 }
+
+// Experiment to offer switch to Pylance language server
+export enum TryPylance {
+    experiment = 'tryPylance'
+}

src/client/common/types.ts

@@ -528,7 +528,7 @@ export interface IPythonExtensionBanner {
     readonly enabled: boolean;
     showBanner(): Promise<void>;
 }
-export const BANNER_NAME_PROPOSE_LS: string = 'ProposeLS';
+export const BANNER_NAME_PROPOSE_LS: string = 'ProposePylance';
 export const BANNER_NAME_DS_SURVEY: string = 'DSSurveyBanner';
 export const BANNER_NAME_INTERACTIVE_SHIFTENTER: string = 'InteractiveShiftEnterBanner';
 

src/client/common/utils/localize.ts

@@ -101,6 +101,13 @@ export namespace AttachProcess {
 }
 
 export namespace LanguageService {
+    export const proposePylanceMessage = localize(
+        'LanguageService.proposePylanceMessage',
+        'Try out a new faster, feature-rich language server for Python by Microsoft, Pylance! Install the extension now.'
+    );
+    export const tryItNow = localize('LanguageService.tryItNow', 'Try it now');
+    export const remindMeLater = localize('LanguageService.remindMeLater', 'Remind me later');
+
     export const bannerLabelYes = localize('LanguageService.bannerLabelYes', 'Yes, take survey now');
     export const bannerLabelNo = localize('LanguageService.bannerLabelNo', 'No, thanks');
     export const lsFailedToStart = localize(