Add survey for MPLS usage (#16403)

Author: jakebailey

package.nls.json

@@ -95,6 +95,7 @@
     "ExtensionSurveyBanner.bannerLabelYes": "Yes, take survey now",
     "ExtensionSurveyBanner.bannerLabelNo": "No, thanks",
     "ExtensionSurveyBanner.maybeLater": "Maybe later",
+    "ExtensionSurveyBanner.mplsMessage": "Can you please take 2 minutes to tell us about your experience using the Microsoft Python Language Server?",
     "ExtensionChannels.installingInsidersMessage": "Installing Insiders... ",
     "ExtensionChannels.installingStableMessage": "Installing Stable... ",
     "ExtensionChannels.installationCompleteMessage": "complete.",

src/client/activation/serviceRegistry.ts

@@ -59,6 +59,11 @@ import {
     LanguageServerType,
 } from './types';
 import { JediLanguageServerActivator } from './jedi/activator';
+import { IDiagnosticsService } from '../application/diagnostics/types';
+import {
+    MPLSSurveyDiagnosticService,
+    MPLSSurveyDiagnosticServiceId,
+} from '../application/diagnostics/checks/mplsSurvey';
 
 export function registerTypes(serviceManager: IServiceManager, languageServerType: LanguageServerType): void {
     serviceManager.addSingleton<ILanguageServerCache>(ILanguageServerCache, LanguageServerExtensionActivationService);
@@ -109,6 +114,11 @@ export function registerTypes(serviceManager: IServiceManager, languageServerTyp
             DotNetLanguageServerPackageService,
         );
         registerDotNetTypes(serviceManager);
+        serviceManager.addSingleton<IDiagnosticsService>(
+            IDiagnosticsService,
+            MPLSSurveyDiagnosticService,
+            MPLSSurveyDiagnosticServiceId,
+        );
     } else if (languageServerType === LanguageServerType.Node) {
         serviceManager.add<ILanguageServerAnalysisOptions>(
             ILanguageServerAnalysisOptions,

src/client/application/diagnostics/checks/mplsSurvey.ts

@@ -0,0 +1,102 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+// eslint-disable-next-line max-classes-per-file
+import { inject, named } from 'inversify';
+import { DiagnosticSeverity, UIKind } from 'vscode';
+import * as querystring from 'querystring';
+import { IDisposableRegistry, Resource } from '../../../common/types';
+import { ExtensionSurveyBanner } from '../../../common/utils/localize';
+import { IServiceContainer } from '../../../ioc/types';
+import { BaseDiagnostic, BaseDiagnosticsService } from '../base';
+import { DiagnosticCodes } from '../constants';
+import { DiagnosticCommandPromptHandlerServiceId, MessageCommandPrompt } from '../promptHandler';
+import { DiagnosticScope, IDiagnostic, IDiagnosticHandlerService } from '../types';
+import { IApplicationEnvironment } from '../../../common/application/types';
+import { IPlatformService } from '../../../common/platform/types';
+import { IDiagnosticsCommandFactory } from '../commands/types';
+
+export class MPLSSurveyDiagnostic extends BaseDiagnostic {
+    constructor(message: string, resource: Resource) {
+        super(
+            DiagnosticCodes.MPLSSurveyDiagnostic,
+            message,
+            DiagnosticSeverity.Information,
+            DiagnosticScope.Global,
+            resource,
+        );
+    }
+}
+
+export const MPLSSurveyDiagnosticServiceId = 'MPLSSurveyDiagnosticServiceId';
+
+export class MPLSSurveyDiagnosticService extends BaseDiagnosticsService {
+    constructor(
+        @inject(IServiceContainer) serviceContainer: IServiceContainer,
+        @inject(IDiagnosticHandlerService)
+        @named(DiagnosticCommandPromptHandlerServiceId)
+        protected readonly messageService: IDiagnosticHandlerService<MessageCommandPrompt>,
+        @inject(IDisposableRegistry) disposableRegistry: IDisposableRegistry,
+        @inject(IApplicationEnvironment) private appEnvironment: IApplicationEnvironment,
+        @inject(IPlatformService) private platformService: IPlatformService,
+    ) {
+        super([DiagnosticCodes.MPLSSurveyDiagnostic], serviceContainer, disposableRegistry, true);
+    }
+
+    public async diagnose(resource: Resource): Promise<IDiagnostic[]> {
+        if (this.appEnvironment.uiKind === UIKind?.Web) {
+            return [];
+        }
+
+        return [new MPLSSurveyDiagnostic(ExtensionSurveyBanner.mplsMessage(), resource)];
+    }
+
+    protected async onHandle(diagnostics: IDiagnostic[]): Promise<void> {
+        if (diagnostics.length === 0 || !this.canHandle(diagnostics[0])) {
+            return;
+        }
+
+        const diagnostic = diagnostics[0];
+        if (await this.filterService.shouldIgnoreDiagnostic(diagnostic.code)) {
+            return;
+        }
+
+        const commandFactory = this.serviceContainer.get<IDiagnosticsCommandFactory>(IDiagnosticsCommandFactory);
+
+        await this.messageService.handle(diagnostic, {
+            commandPrompts: [
+                {
+                    prompt: ExtensionSurveyBanner.bannerLabelYes(),
+                    command: {
+                        diagnostic,
+                        invoke: () => this.launchSurvey(diagnostic),
+                    },
+                },
+                {
+                    prompt: ExtensionSurveyBanner.maybeLater(),
+                },
+                {
+                    prompt: ExtensionSurveyBanner.bannerLabelNo(),
+                    command: commandFactory.createCommand(diagnostic, {
+                        type: 'ignore',
+                        options: DiagnosticScope.Global,
+                    }),
+                },
+            ],
+        });
+    }
+
+    private async launchSurvey(diagnostic: IDiagnostic) {
+        const query = querystring.stringify({
+            o: encodeURIComponent(this.platformService.osType), // platform
+            v: encodeURIComponent(this.appEnvironment.vscodeVersion),
+            e: encodeURIComponent(this.appEnvironment.packageJson.version), // extension version
+            m: encodeURIComponent(this.appEnvironment.sessionId),
+        });
+        const url = `https://aka.ms/mpls-experience-survey?${query}`;
+
+        const commandFactory = this.serviceContainer.get<IDiagnosticsCommandFactory>(IDiagnosticsCommandFactory);
+        await commandFactory.createCommand(diagnostic, { type: 'ignore', options: DiagnosticScope.Global }).invoke();
+        await commandFactory.createCommand(diagnostic, { type: 'launch', options: url }).invoke();
+    }
+}

src/client/application/diagnostics/constants.ts

@@ -20,4 +20,5 @@ export enum DiagnosticCodes {
     ConfigPythonPathDiagnostic = 'ConfigPythonPathDiagnostic',
     UpgradeCodeRunnerDiagnostic = 'UpgradeCodeRunnerDiagnostic',
     PylanceDefaultDiagnostic = 'PylanceDefaultDiagnostic',
+    MPLSSurveyDiagnostic = 'MPLSSurveyDiagnostic',
 }

src/client/common/utils/localize.ts

@@ -411,6 +411,10 @@ export namespace ExtensionSurveyBanner {
     export const bannerLabelYes = localize('ExtensionSurveyBanner.bannerLabelYes', 'Yes, take survey now');
     export const bannerLabelNo = localize('ExtensionSurveyBanner.bannerLabelNo', 'No, thanks');
     export const maybeLater = localize('ExtensionSurveyBanner.maybeLater', 'Maybe later');
+    export const mplsMessage = localize(
+        'ExtensionSurveyBanner.mplsMessage',
+        'Can you please take 2 minutes to tell us about your experience using the Microsoft Python Language Server?',
+    );
 }
 
 export namespace Products {