Add telemetry when survey prompt is shown (#14940)

Author: karthiknadig

src/client/application/misc/joinMailingListPrompt.ts

@@ -58,6 +58,7 @@ export class JoinMailingListPrompt implements IExtensionSingleActivationService
 
     @swallowExceptions('Failed to display tip')
     private async showTip(promptContent: string) {
+        sendTelemetryEvent(EventName.JOIN_MAILING_LIST_PROMPT_DISPLAYED);
         const selection = await this.shell.showInformationMessage(
             promptContent,
             Common.bannerLabelYes(),

src/client/telemetry/constants.ts

@@ -79,6 +79,7 @@ export enum EventName {
     EXTENSION_SURVEY_PROMPT = 'EXTENSION_SURVEY_PROMPT',
     ACTIVATION_TIP_PROMPT = 'ACTIVATION_TIP_PROMPT',
     ACTIVATION_SURVEY_PROMPT = 'ACTIVATION_SURVEY_PROMPT',
+    JOIN_MAILING_LIST_PROMPT_DISPLAYED = 'JOIN_MAILING_LIST_PROMPT_DISPLAYED',
     JOIN_MAILING_LIST_PROMPT = 'JOIN_MAILING_LIST_PROMPT',
 
     PYTHON_LANGUAGE_SERVER_CURRENT_SELECTION = 'PYTHON_LANGUAGE_SERVER_CURRENT_SELECTION',

src/client/telemetry/index.ts

@@ -1388,6 +1388,10 @@ export interface IEventNamePropertyMapping {
     /**
      * Telemetry sent back when join mailing list prompt is shown.
      */
+    [EventName.JOIN_MAILING_LIST_PROMPT_DISPLAYED]: never | undefined;
+    /**
+     * Telemetry sent back when user selects an option from join mailing list prompt.
+     */
     [EventName.JOIN_MAILING_LIST_PROMPT]: {
         /**
          * Carries the selection of user when they are asked to join the mailing list.

src/test/application/misc/joinMailingListPrompt.unit.test.ts

@@ -17,7 +17,7 @@ import { Common } from '../../../client/common/utils/localize';
 import * as telemetry from '../../../client/telemetry';
 import { EventName } from '../../../client/telemetry/constants';
 
-suite('Interpreters - Interpreter Selection Tip', () => {
+suite('Join Mailing list Prompt Tests', () => {
     let joinMailingList: JoinMailingListPrompt;
     let appShell: IApplicationShell;
     let storage: IPersistentState<boolean>;
@@ -74,6 +74,7 @@ suite('Interpreters - Interpreter Selection Tip', () => {
 
         await joinMailingList.activate();
 
+        assert.ok(sendTelemetryStub.calledWithExactly(EventName.JOIN_MAILING_LIST_PROMPT_DISPLAYED));
         verify(appShell.showInformationMessage(anything(), Common.bannerLabelYes(), Common.bannerLabelNo())).once();
         verify(storage.updateValue(true)).once();
     });
@@ -86,6 +87,7 @@ suite('Interpreters - Interpreter Selection Tip', () => {
 
         await joinMailingList.activate();
 
+        assert.ok(sendTelemetryStub.calledWithExactly(EventName.JOIN_MAILING_LIST_PROMPT_DISPLAYED));
         verify(appShell.showInformationMessage(anything(), Common.bannerLabelYes(), Common.bannerLabelNo())).once();
         verify(storage.updateValue(true)).once();
     });
@@ -98,6 +100,7 @@ suite('Interpreters - Interpreter Selection Tip', () => {
 
         await joinMailingList.activate();
 
+        assert.ok(sendTelemetryStub.calledWithExactly(EventName.JOIN_MAILING_LIST_PROMPT_DISPLAYED));
         verify(appShell.showInformationMessage(anything(), Common.bannerLabelYes(), Common.bannerLabelNo())).once();
         verify(storage.updateValue(true)).once();
     });
@@ -113,6 +116,7 @@ suite('Interpreters - Interpreter Selection Tip', () => {
 
         await joinMailingList.activate();
 
+        assert.ok(sendTelemetryStub.calledWithExactly(EventName.JOIN_MAILING_LIST_PROMPT_DISPLAYED));
         verify(
             browserService.launch('https://aka.ms/python-vscode-mailinglist?m=test.sessionId&utm_source=vscode')
         ).once();
@@ -133,6 +137,7 @@ suite('Interpreters - Interpreter Selection Tip', () => {
 
         await joinMailingList.activate();
 
+        assert.ok(sendTelemetryStub.calledWithExactly(EventName.JOIN_MAILING_LIST_PROMPT_DISPLAYED));
         verify(storage.updateValue(true)).once();
         assert.ok(
             sendTelemetryStub.calledWithExactly(EventName.JOIN_MAILING_LIST_PROMPT, undefined, { selection: 'No' })
@@ -149,6 +154,7 @@ suite('Interpreters - Interpreter Selection Tip', () => {
 
         await joinMailingList.activate();
 
+        assert.ok(sendTelemetryStub.calledWithExactly(EventName.JOIN_MAILING_LIST_PROMPT_DISPLAYED));
         verify(storage.updateValue(true)).once();
         assert.ok(
             sendTelemetryStub.calledWithExactly(EventName.JOIN_MAILING_LIST_PROMPT, undefined, { selection: undefined })