Bring back telemetry for prompt

Author: Kartik Raj

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

@@ -14,10 +14,18 @@ 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';
 import { Common } from '../../../common/utils/localize';
 import { Commands } from '../../../common/constants';
 import { IWorkspaceService } from '../../../common/application/types';
+import { sendTelemetryEvent } from '../../../telemetry';
+import { EventName } from '../../../telemetry/constants';
 
 const localize: nls.LocalizeFunc = nls.loadMessageBundle();
 
@@ -125,7 +133,8 @@ export class InvalidPythonInterpreterService extends BaseDiagnosticsService {
                     return;
                 }
                 const commandPrompts = this.getCommandPrompts(diagnostic);
-                await messageService.handle(diagnostic, { commandPrompts, message: diagnostic.message });
+                const onClose = getOnCloseHandler(diagnostic);
+                await messageService.handle(diagnostic, { commandPrompts, message: diagnostic.message, onClose });
             }),
         );
     }
@@ -143,3 +152,14 @@ export class InvalidPythonInterpreterService extends BaseDiagnosticsService {
         ];
     }
 }
+
+function 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 undefined;
+}

src/client/telemetry/constants.ts

@@ -26,6 +26,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',
     ENVFILE_VARIABLE_SUBSTITUTION = 'ENVFILE_VARIABLE_SUBSTITUTION',
     ENVFILE_WORKSPACE = 'ENVFILE_WORKSPACE',

src/client/telemetry/index.ts

@@ -1318,6 +1318,24 @@ 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.'
+     */
+    /* __GDPR__
+       "python_not_installed_prompt" : {
+          "selection" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "owner": "karrtikr" }
+       }
+     */
+    [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 when the experiments service is initialized for the first time.
      */

src/test/application/diagnostics/checks/pythonInterpreter.unit.test.ts

@@ -182,7 +182,7 @@ suite('Application Diagnostics - Checks Python Interpreter', () => {
             settings.verifyAll();
             interpreterService.verifyAll();
         });
-        test('Handling no interpreters diagnostic should return download link', async () => {
+        test('Handling no interpreters diagnostic should return select interpreter cmd', async () => {
             const diagnostic = new InvalidPythonInterpreterDiagnostic(
                 DiagnosticCodes.NoPythonInterpretersDiagnostic,
                 undefined,
@@ -219,6 +219,7 @@ suite('Application Diagnostics - Checks Python Interpreter', () => {
                     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 () => {
@@ -254,41 +255,7 @@ suite('Application Diagnostics - Checks Python Interpreter', () => {
             expect(messagePrompt!.commandPrompts).to.be.deep.equal([
                 { prompt: Common.selectPythonInterpreter, command: cmd },
             ]);
-        });
-        test('Handling no interpreters diagnostic should return select interpreter cmd', async () => {
-            const diagnostic = new InvalidPythonInterpreterDiagnostic(
-                DiagnosticCodes.InvalidPythonInterpreterDiagnostic,
-                undefined,
-                workspaceService.object,
-            );
-            const cmd = ({} as any) as IDiagnosticCommand;
-            let messagePrompt: MessageCommandPrompt | undefined;
-            messageHandler
-                .setup((i) => i.handle(typemoq.It.isValue(diagnostic), typemoq.It.isAny()))
-                .callback((_d, p: MessageCommandPrompt) => (messagePrompt = p))
-                .returns(() => Promise.resolve())
-                .verifiable(typemoq.Times.once());
-            commandFactory
-                .setup((f) =>
-                    f.createCommand(
-                        typemoq.It.isAny(),
-                        typemoq.It.isObjectWith<CommandOption<'executeVSCCommand', CommandsWithoutArgs>>({
-                            type: 'executeVSCCommand',
-                        }),
-                    ),
-                )
-                .returns(() => cmd)
-                .verifiable(typemoq.Times.once());
-
-            await diagnosticService.handle([diagnostic]);
-
-            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 },
-            ]);
         });
         test('Handling an empty diagnostic should not show a message nor return a command', async () => {
             const diagnostics: IDiagnostic[] = [];