Add telemetry for "Python is not installed" prompt (#11163)

kimadeline · web-flow · commit 48ea30382bb7 · 2020-04-22T07:57:15.000-07:00
* Add telemetry item description
* News file
* Send telemetry if "no python installed" displayed
* Unit tests
* Undo unnecessary changes
* Change test name
diff --git a/news/1 Enhancements/10885.md b/news/1 Enhancements/10885.md
@@ -0,0 +1 @@
+Add telemetry for "Python is not installed" prompt.
diff --git a/src/client/application/diagnostics/checks/pythonInterpreter.ts b/src/client/application/diagnostics/checks/pythonInterpreter.ts
@@ -9,11 +9,19 @@ import '../../../common/extensions';
 import { IConfigurationService, IDisposableRegistry, Resource } from '../../../common/types';
 import { IInterpreterService } from '../../../interpreter/contracts';
 import { IServiceContainer } from '../../../ioc/types';
+import { sendTelemetryEvent } from '../../../telemetry';
+import { EventName } from '../../../telemetry/constants';
 import { BaseDiagnostic, BaseDiagnosticsService } from '../base';
 import { IDiagnosticsCommandFactory } from '../commands/types';
 import { DiagnosticCodes } from '../constants';
 import { DiagnosticCommandPromptHandlerServiceId, MessageCommandPrompt } from '../promptHandler';
-import { DiagnosticScope, IDiagnostic, IDiagnosticCommand, IDiagnosticHandlerService } from '../types';
+import {
+    DiagnosticScope,
+    IDiagnostic,
+    IDiagnosticCommand,
+    IDiagnosticHandlerService,
+    IDiagnosticMessageOnCloseHandler
+} from '../types';
 
 const messages = {
     [DiagnosticCodes.NoPythonInterpretersDiagnostic]:
@@ -91,7 +99,8 @@ export class InvalidPythonInterpreterService extends BaseDiagnosticsService {
                     return;
                 }
                 const commandPrompts = this.getCommandPrompts(diagnostic);
-                return messageService.handle(diagnostic, { commandPrompts, message: diagnostic.message });
+                const onClose = this.getOnCloseHandler(diagnostic);
+                return messageService.handle(diagnostic, { commandPrompts, message: diagnostic.message, onClose });
             })
         );
     }
@@ -125,4 +134,15 @@ export class InvalidPythonInterpreterService extends BaseDiagnosticsService {
             }
         }
     }
+    private getOnCloseHandler(diagnostic: IDiagnostic): IDiagnosticMessageOnCloseHandler | undefined {
+        if (diagnostic.code === DiagnosticCodes.NoPythonInterpretersDiagnostic) {
+            return (response?: string) => {
+                sendTelemetryEvent(EventName.PYTHON_NOT_INSTALLED_PROMPT, undefined, {
+                    selection: response ? 'Download' : 'Ignore'
+                });
+            };
+        }
+
+        return;
+    }
 }
diff --git a/src/client/application/diagnostics/promptHandler.ts b/src/client/application/diagnostics/promptHandler.ts
@@ -7,14 +7,15 @@ import { inject, injectable } from 'inversify';
 import { DiagnosticSeverity } from 'vscode';
 import { IApplicationShell } from '../../common/application/types';
 import { IServiceContainer } from '../../ioc/types';
-import { IDiagnostic, IDiagnosticCommand, IDiagnosticHandlerService } from './types';
+import { IDiagnostic, IDiagnosticCommand, IDiagnosticHandlerService, IDiagnosticMessageOnCloseHandler } from './types';
 
 export type MessageCommandPrompt = {
     commandPrompts: {
         prompt: string;
         command?: IDiagnosticCommand;
     }[];
     message?: string;
+    onClose?: IDiagnosticMessageOnCloseHandler;
 };
 
 export const DiagnosticCommandPromptHandlerServiceId = 'DiagnosticCommandPromptHandlerServiceId';
@@ -35,6 +36,9 @@ export class DiagnosticCommandPromptHandlerService implements IDiagnosticHandler
             diagnostic.severity,
             prompts
         );
+        if (options.onClose) {
+            options.onClose(response);
+        }
         if (!response) {
             return;
         }
diff --git a/src/client/application/diagnostics/types.ts b/src/client/application/diagnostics/types.ts
@@ -54,6 +54,8 @@ export interface IDiagnosticCommand {
     invoke(): Promise<void>;
 }
 
+export type IDiagnosticMessageOnCloseHandler = (response?: string) => void;
+
 export const IInvalidPythonPathInDebuggerService = Symbol('IInvalidPythonPathInDebuggerService');
 
 export interface IInvalidPythonPathInDebuggerService extends IDiagnosticsService {
diff --git a/src/client/telemetry/constants.ts b/src/client/telemetry/constants.ts
@@ -30,6 +30,7 @@ export enum EventName {
     PYTHON_INTERPRETER_ACTIVATION_FOR_TERMINAL = 'PYTHON_INTERPRETER_ACTIVATION_FOR_TERMINAL',
     TERMINAL_SHELL_IDENTIFICATION = 'TERMINAL_SHELL_IDENTIFICATION',
     PYTHON_INTERPRETER_ACTIVATE_ENVIRONMENT_PROMPT = 'PYTHON_INTERPRETER_ACTIVATE_ENVIRONMENT_PROMPT',
+    PYTHON_NOT_INSTALLED_PROMPT = 'PYTHON_NOT_INSTALLED_PROMPT',
     CONDA_INHERIT_ENV_PROMPT = 'CONDA_INHERIT_ENV_PROMPT',
     UNSAFE_INTERPRETER_PROMPT = 'UNSAFE_INTERPRETER_PROMPT',
     INSIDERS_RELOAD_PROMPT = 'INSIDERS_RELOAD_PROMPT',
diff --git a/src/client/telemetry/index.ts b/src/client/telemetry/index.ts
@@ -1050,6 +1050,20 @@ export interface IEventNamePropertyMapping {
          */
         selection: 'Yes' | 'No' | 'Ignore' | undefined;
     };
+    /**
+     * Telemetry event sent with details when the user clicks a button in the "Python is not installed" prompt.
+     * * `Prompt message` :- 'Python is not installed. Please download and install Python before using the extension.'
+     */
+    [EventName.PYTHON_NOT_INSTALLED_PROMPT]: {
+        /**
+         * `Download` When the 'Download' option is clicked
+         * `Ignore` When the prompt is dismissed
+         *
+         * @type {('Download' | 'Ignore' | undefined)}
+         */
+        selection: 'Download' | 'Ignore' | undefined;
+    };
+
     /**
      * Telemetry event sent with details when user clicks a button in the following prompt
      * `Prompt message` :- 'We noticed you are using Visual Studio Code Insiders. Would you like to use the Insiders build of the Python extension?'
diff --git a/src/test/application/diagnostics/checks/pythonInterpreter.unit.test.ts b/src/test/application/diagnostics/checks/pythonInterpreter.unit.test.ts
@@ -225,6 +225,7 @@ suite('Application Diagnostics - Checks Python Interpreter', () => {
             commandFactory.verifyAll();
             expect(messagePrompt).not.be.equal(undefined, 'Message prompt not set');
             expect(messagePrompt!.commandPrompts).to.be.deep.equal([{ prompt: 'Download', command: cmd }]);
+            expect(messagePrompt!.onClose).to.not.be.equal(undefined, 'onClose handler should be set.');
         });
         test('Handling no currently selected interpreter diagnostic should show select interpreter message', async () => {
             const diagnostic = new InvalidPythonInterpreterDiagnostic(
@@ -255,6 +256,7 @@ suite('Application Diagnostics - Checks Python Interpreter', () => {
             messageHandler.verifyAll();
             commandFactory.verifyAll();
             expect(messagePrompt).not.be.equal(undefined, 'Message prompt not set');
+            expect(messagePrompt!.onClose).be.equal(undefined, 'onClose handler should not be set.');
             expect(messagePrompt!.commandPrompts).to.be.deep.equal([
                 { prompt: 'Select Python Interpreter', command: cmd }
             ]);
@@ -288,6 +290,7 @@ suite('Application Diagnostics - Checks Python Interpreter', () => {
             messageHandler.verifyAll();
             commandFactory.verifyAll();
             expect(messagePrompt).not.be.equal(undefined, 'Message prompt not set');
+            expect(messagePrompt!.onClose).be.equal(undefined, 'onClose handler should not be set.');
             expect(messagePrompt!.commandPrompts).to.be.deep.equal([
                 { prompt: 'Select Python Interpreter', command: cmd }
             ]);
diff --git a/src/test/application/diagnostics/promptHandler.unit.test.ts b/src/test/application/diagnostics/promptHandler.unit.test.ts
@@ -5,6 +5,7 @@
 
 // tslint:disable:insecure-random max-func-body-length no-any
 
+import { expect } from 'chai';
 import * as typemoq from 'typemoq';
 import { DiagnosticSeverity } from 'vscode';
 import {
@@ -69,6 +70,70 @@ suite('Application Diagnostics - PromptHandler', () => {
             await promptHandler.handle(diagnostic);
             appShell.verifyAll();
         });
+        test(`Handling a diagnositic of severity '${severity.name}' should invoke the onClose handler`, async () => {
+            const diagnostic: IDiagnostic = {
+                code: '1' as any,
+                message: 'one',
+                scope: DiagnosticScope.Global,
+                severity: severity.value,
+                resource: undefined,
+                invokeHandler: 'default'
+            };
+            let onCloseHandlerInvoked = false;
+            const options: MessageCommandPrompt = {
+                commandPrompts: [{ prompt: 'Yes' }, { prompt: 'No' }],
+                message: 'Custom Message',
+                onClose: () => {
+                    onCloseHandlerInvoked = true;
+                }
+            };
+
+            switch (severity.value) {
+                case DiagnosticSeverity.Error: {
+                    appShell
+                        .setup((a) =>
+                            a.showErrorMessage(
+                                typemoq.It.isValue(options.message!),
+                                typemoq.It.isValue('Yes'),
+                                typemoq.It.isValue('No')
+                            )
+                        )
+                        .returns(() => Promise.resolve('Yes'))
+                        .verifiable(typemoq.Times.once());
+                    break;
+                }
+                case DiagnosticSeverity.Warning: {
+                    appShell
+                        .setup((a) =>
+                            a.showWarningMessage(
+                                typemoq.It.isValue(options.message!),
+                                typemoq.It.isValue('Yes'),
+                                typemoq.It.isValue('No')
+                            )
+                        )
+                        .returns(() => Promise.resolve('Yes'))
+                        .verifiable(typemoq.Times.once());
+                    break;
+                }
+                default: {
+                    appShell
+                        .setup((a) =>
+                            a.showInformationMessage(
+                                typemoq.It.isValue(options.message!),
+                                typemoq.It.isValue('Yes'),
+                                typemoq.It.isValue('No')
+                            )
+                        )
+                        .returns(() => Promise.resolve('Yes'))
+                        .verifiable(typemoq.Times.once());
+                    break;
+                }
+            }
+
+            await promptHandler.handle(diagnostic, options);
+            appShell.verifyAll();
+            expect(onCloseHandlerInvoked).to.equal(true, 'onClose handler should be called.');
+        });
         test(`Handling a diagnositic of severity '${severity.name}' should display a custom message with buttons`, async () => {
             const diagnostic: IDiagnostic = {
                 code: '1' as any,

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+Add telemetry for "Python is not installed" prompt.`
Original file line number	Diff line number	Diff line change
`@@ -54,6 +54,8 @@ export interface IDiagnosticCommand {`
`54`	`54`	`invoke(): Promise<void>;`
`55`	`55`	`}`
`56`	`56`
	`57`	`+export type IDiagnosticMessageOnCloseHandler = (response?: string) => void;`
	`58`	`+`
`57`	`59`	`export const IInvalidPythonPathInDebuggerService = Symbol('IInvalidPythonPathInDebuggerService');`
`58`	`60`
`59`	`61`	`export interface IInvalidPythonPathInDebuggerService extends IDiagnosticsService {`