feat: opt-in via the initial chat participant message VSCODE-568

src/mdbExtensionController.ts

@@ -109,6 +109,7 @@ export default class MDBExtensionController implements vscode.Disposable {
       new PlaygroundDiagnosticsCodeActionProvider();
     this._participantController = new ParticipantController({
       connectionController: this._connectionController,
+      storageController: this._storageController,
     });
     this._playgroundController = new PlaygroundController({
       connectionController: this._connectionController,

src/participant/participant.ts

@@ -3,6 +3,8 @@ import * as vscode from 'vscode';
 import { createLogger } from '../logging';
 import type ConnectionController from '../connectionController';
 import EXTENSION_COMMANDS from '../commands';
+import type { StorageController } from '../storage';
+import { StorageVariables } from '../storage';
 
 const log = createLogger('participant');
 
@@ -38,14 +40,18 @@ export class ParticipantController {
   _participant?: vscode.ChatParticipant;
   _chatResult: ChatResult;
   _connectionController: ConnectionController;
+  _storageController: StorageController;
 
   constructor({
     connectionController,
+    storageController,
   }: {
     connectionController: ConnectionController;
+    storageController: StorageController;
   }) {
     this._chatResult = { metadata: { command: '' } };
     this._connectionController = connectionController;
+    this._storageController = storageController;
   }
 
   createParticipant(context: vscode.ExtensionContext) {
@@ -311,6 +317,23 @@ export class ParticipantController {
     stream: vscode.ChatResponseStream,
     token: vscode.CancellationToken
   ): Promise<ChatResult> {
+    const hasBeenShownWelcomeMessageAlready = !!this._storageController.get(
+      StorageVariables.COPILOT_HAS_BEEN_SHOWN_WELCOME_MESSAGE
+    );
+
+    if (!hasBeenShownWelcomeMessageAlready) {
+      stream.markdown(
+        vscode.l10n.t(`
+  Welcome to MongoDB Participant!\n\n
+  Interact with your MongoDB clusters and generate MongoDB-related code more efficiently with intelligent AI-powered feature, available today in the MongoDB extension.\n\n
+  Please see our [FAQ](https://www.mongodb.com/docs/generative-ai-faq/) for more information.`)
+      );
+      void this._storageController.update(
+        StorageVariables.COPILOT_HAS_BEEN_SHOWN_WELCOME_MESSAGE,
+        true
+      );
+    }
+
     if (request.command === 'query') {
       this._chatResult = await this.handleQueryRequest({
         request,

src/storage/storageController.ts

@@ -12,6 +12,7 @@ export enum StorageVariables {
   GLOBAL_ANONYMOUS_ID = 'GLOBAL_ANONYMOUS_ID',
   // Only exists on workspaceState.
   WORKSPACE_SAVED_CONNECTIONS = 'WORKSPACE_SAVED_CONNECTIONS',
+  COPILOT_HAS_BEEN_SHOWN_WELCOME_MESSAGE = 'COPILOT_HAS_BEEN_SHOWN_WELCOME_MESSAGE',
 }
 
 // Typically variables default to 'GLOBAL' scope.
@@ -52,6 +53,7 @@ interface StorageVariableContents {
   [StorageVariables.GLOBAL_HAS_BEEN_SHOWN_INITIAL_VIEW]: boolean;
   [StorageVariables.GLOBAL_SAVED_CONNECTIONS]: ConnectionsFromStorage;
   [StorageVariables.WORKSPACE_SAVED_CONNECTIONS]: ConnectionsFromStorage;
+  [StorageVariables.COPILOT_HAS_BEEN_SHOWN_WELCOME_MESSAGE]: boolean;
 }
 type StoredVariableName = keyof StorageVariableContents;
 type StoredItem<T extends StoredVariableName> = StorageVariableContents[T];

src/test/suite/editors/playgroundController.test.ts

@@ -92,6 +92,7 @@ suite('Playground Controller Test Suite', function () {
     );
     testParticipantController = new ParticipantController({
       connectionController: testConnectionController,
+      storageController: testStorageController,
     });
     testPlaygroundController = new PlaygroundController({
       connectionController: testConnectionController,

src/test/suite/editors/playgroundSelectedCodeActionProvider.test.ts

@@ -59,6 +59,7 @@ suite('Playground Selected CodeAction Provider Test Suite', function () {
 
       testParticipantController = new ParticipantController({
         connectionController: testConnectionController,
+        storageController: testStorageController,
       });
 
       sandbox.replace(

src/test/suite/language/languageServerController.test.ts

@@ -71,6 +71,7 @@ suite('Language Server Controller Test Suite', () => {
     );
     testParticipantController = new ParticipantController({
       connectionController: testConnectionController,
+      storageController: testStorageController,
     });
     testPlaygroundController = new PlaygroundController({
       connectionController: testConnectionController,