feat(participant): in-app notification to introduce users to copilot extension VSCODE-633 (#875)

alenakhineika · web-flow · commit d3d7b816f37e · 2024-11-22T14:14:42.000+01:00
* feat(participant): in-app notification to introduce users to copilot extension VSCODE-633 * feat: show copilot introduction only if survey not shown * feat: startupNotificationShown * docs: update comments
diff --git a/src/mdbExtensionController.ts b/src/mdbExtensionController.ts
@@ -72,6 +72,7 @@ export default class MDBExtensionController implements vscode.Disposable {
   _editDocumentCodeLensProvider: EditDocumentCodeLensProvider;
   _exportToLanguageCodeLensProvider: ExportToLanguageCodeLensProvider;
   _participantController: ParticipantController;
+  _startupNotificationShown = false;
 
   constructor(
     context: vscode.ExtensionContext,
@@ -166,6 +167,7 @@ export default class MDBExtensionController implements vscode.Disposable {
     this.registerCommands();
     this.showOverviewPageIfRecentlyInstalled();
     void this.showSurveyForEstablishedUsers();
+    void this.showCopilotIntroductionForEstablishedUsers();
   }
 
   registerCommands = (): void => {
@@ -909,23 +911,82 @@ export default class MDBExtensionController implements vscode.Disposable {
     }
   }
 
+  async showCopilotIntroductionForEstablishedUsers(): Promise<void> {
+    const copilotIntroductionShown =
+      this._storageController.get(
+        StorageVariables.GLOBAL_COPILOT_INTRODUCTION_SHOWN
+      ) === true;
+
+    // Show the toast when startup notifications have not been shown
+    // to the user yet and they have saved connections
+    // -> they haven't just started using this extension.
+    if (
+      this._startupNotificationShown ||
+      copilotIntroductionShown ||
+      !this._connectionStorage.hasSavedConnections()
+    ) {
+      return;
+    }
+
+    this._startupNotificationShown = true;
+
+    const action = 'Chat with @MongoDB';
+    const text =
+      'Generate queries, interact with documentation, and explore your database schema using the MongoDB Copilot extension. Give it a try!';
+    const result = await vscode.window.showInformationMessage(
+      text,
+      {},
+      {
+        title: action,
+      }
+    );
+
+    const copilot = vscode.extensions.getExtension('github.copilot-chat');
+    if (result?.title === action) {
+      await vscode.commands.executeCommand('workbench.action.chat.newChat');
+      await vscode.commands.executeCommand(
+        'workbench.action.chat.clearHistory'
+      );
+      await vscode.commands.executeCommand('workbench.action.chat.open', {
+        query: '@MongoDB',
+        isPartialQuery: true,
+      });
+      this._telemetryService.trackCopilotIntroductionClicked({
+        is_copilot_active: !!copilot?.isActive,
+      });
+    } else {
+      this._telemetryService.trackCopilotIntroductionDismissed({
+        is_copilot_active: !!copilot?.isActive,
+      });
+    }
+
+    // Whether action was taken or the prompt dismissed, we won't show this again.
+    void this._storageController.update(
+      StorageVariables.GLOBAL_COPILOT_INTRODUCTION_SHOWN,
+      true
+    );
+  }
+
   async showSurveyForEstablishedUsers(): Promise<void> {
     const surveyId = '9viN9wcbsC3zvHyg7';
 
     const hasBeenShownSurveyAlready =
       this._storageController.get(StorageVariables.GLOBAL_SURVEY_SHOWN) ===
       surveyId;
 
-    // Show the survey when it hasn't been show to the
-    // user yet, and they have saved connections
+    // Show the toast when startup notifications have not been shown
+    // to the user yet and they have saved connections
     // -> they haven't just started using this extension
     if (
+      this._startupNotificationShown ||
       hasBeenShownSurveyAlready ||
       !this._connectionStorage.hasSavedConnections()
     ) {
       return;
     }
 
+    this._startupNotificationShown = true;
+
     const action = 'Share your thoughts';
     const text = 'How can we make the MongoDB extension better for you?';
     const link = 'https://forms.gle/9viN9wcbsC3zvHyg7';
diff --git a/src/storage/storageController.ts b/src/storage/storageController.ts
@@ -7,6 +7,7 @@ export enum StorageVariables {
   // Only exists on globalState.
   GLOBAL_HAS_BEEN_SHOWN_INITIAL_VIEW = 'GLOBAL_HAS_BEEN_SHOWN_INITIAL_VIEW',
   GLOBAL_SURVEY_SHOWN = 'GLOBAL_SURVEY_SHOWN',
+  GLOBAL_COPILOT_INTRODUCTION_SHOWN = 'GLOBAL_COPILOT_INTRODUCTION_SHOWN',
   GLOBAL_SAVED_CONNECTIONS = 'GLOBAL_SAVED_CONNECTIONS',
   // Analytics user identify.
   GLOBAL_USER_ID = 'GLOBAL_USER_ID',
@@ -53,6 +54,7 @@ interface StorageVariableContents {
   [StorageVariables.GLOBAL_ANONYMOUS_ID]: string;
   [StorageVariables.GLOBAL_HAS_BEEN_SHOWN_INITIAL_VIEW]: boolean;
   [StorageVariables.GLOBAL_SURVEY_SHOWN]: string;
+  [StorageVariables.GLOBAL_COPILOT_INTRODUCTION_SHOWN]: boolean;
   [StorageVariables.GLOBAL_SAVED_CONNECTIONS]: ConnectionsFromStorage;
   [StorageVariables.WORKSPACE_SAVED_CONNECTIONS]: ConnectionsFromStorage;
   [StorageVariables.COPILOT_HAS_BEEN_SHOWN_WELCOME_MESSAGE]: boolean;
diff --git a/src/telemetry/telemetryService.ts b/src/telemetry/telemetryService.ts
@@ -126,6 +126,10 @@ export type ParticipantResponseProperties = {
   output_length: number;
 };
 
+export type CopilotIntroductionProperties = {
+  is_copilot_active: boolean;
+};
+
 export function chatResultFeedbackKindToTelemetryValue(
   kind: vscode.ChatResultFeedbackKind
 ): TelemetryFeedbackKind {
@@ -157,7 +161,8 @@ type TelemetryEventProperties =
   | ParticipantFeedbackProperties
   | ParticipantResponseFailedProperties
   | ParticipantPromptProperties
-  | ParticipantResponseProperties;
+  | ParticipantResponseProperties
+  | CopilotIntroductionProperties;
 
 export enum TelemetryEventTypes {
   PLAYGROUND_CODE_EXECUTED = 'Playground Code Executed',
@@ -181,6 +186,8 @@ export enum TelemetryEventTypes {
   PARTICIPANT_RESPONSE_FAILED = 'Participant Response Failed',
   PARTICIPANT_PROMPT_SUBMITTED = 'Participant Prompt Submitted',
   PARTICIPANT_RESPONSE_GENERATED = 'Participant Response Generated',
+  COPILOT_INTRODUCTION_CLICKED = 'Copilot Introduction Clicked',
+  COPILOT_INTRODUCTION_DISMISSED = 'Copilot Introduction Dismissed',
 }
 
 /**
@@ -475,4 +482,14 @@ export default class TelemetryService {
   trackCopilotParticipantResponse(props: ParticipantResponseProperties): void {
     this.track(TelemetryEventTypes.PARTICIPANT_RESPONSE_GENERATED, props);
   }
+
+  trackCopilotIntroductionClicked(props: CopilotIntroductionProperties): void {
+    this.track(TelemetryEventTypes.COPILOT_INTRODUCTION_CLICKED, props);
+  }
+
+  trackCopilotIntroductionDismissed(
+    props: CopilotIntroductionProperties
+  ): void {
+    this.track(TelemetryEventTypes.COPILOT_INTRODUCTION_DISMISSED, props);
+  }
 }
diff --git a/src/test/suite/mdbExtensionController.test.ts b/src/test/suite/mdbExtensionController.test.ts
