feat(chat): add /schema command handler VSCODE-571

package.json

@@ -99,6 +99,11 @@
             "name": "docs",
             "isSticky": true,
             "description": "Ask MongoDB-related questions and find answers in the official documentation."
+          },
+          {
+            "name": "schema",
+            "isSticky": true,
+            "description": "Analyze a collection's schema."
           }
         ]
       }
@@ -177,6 +182,10 @@
         "command": "mdb.selectCollectionWithParticipant",
         "title": "MongoDB: Select Collection with Participant"
       },
+      {
+        "command": "mdb.participantViewRawSchemaOutput",
+        "title": "MongoDB: View Raw Schema JSON Output"
+      },
       {
         "command": "mdb.connectWithParticipant",
         "title": "MongoDB: Change Active Connection with Participant"
@@ -747,6 +756,10 @@
           "command": "mdb.selectCollectionWithParticipant",
           "when": "false"
         },
+        {
+          "command": "mdb.participantViewRawSchemaOutput",
+          "when": "false"
+        },
         {
           "command": "mdb.connectWithParticipant",
           "when": "false"

src/commands/index.ts

@@ -82,6 +82,7 @@ enum EXTENSION_COMMANDS {
   CONNECT_WITH_PARTICIPANT = 'mdb.connectWithParticipant',
   SELECT_DATABASE_WITH_PARTICIPANT = 'mdb.selectDatabaseWithParticipant',
   SELECT_COLLECTION_WITH_PARTICIPANT = 'mdb.selectCollectionWithParticipant',
+  PARTICIPANT_OPEN_RAW_SCHEMA_OUTPUT = 'mdb.participantViewRawSchemaOutput',
 }
 
 export default EXTENSION_COMMANDS;

src/mdbExtensionController.ts

@@ -44,6 +44,7 @@ import { ConnectionStorage } from './storage/connectionStorage';
 import type StreamProcessorTreeItem from './explorer/streamProcessorTreeItem';
 import type { RunParticipantQueryCommandArgs } from './participant/participant';
 import ParticipantController from './participant/participant';
+import type { OpenSchemaCommandArgs } from './participant/prompts/schema';
 
 // This class is the top-level controller for our extension.
 // Commands which the extensions handles are defined in the function `activate`.
@@ -310,30 +311,34 @@ export default class MDBExtensionController implements vscode.Disposable {
     );
     this.registerCommand(
       EXTENSION_COMMANDS.CONNECT_WITH_PARTICIPANT,
-      (id?: string) =>
-        this._participantController.connectWithParticipant(
-          id ? decodeURIComponent(id) : id
-        )
+      (data: any) => {
+        return this._participantController.connectWithParticipant(data);
+      }
     );
     this.registerCommand(
       EXTENSION_COMMANDS.SELECT_DATABASE_WITH_PARTICIPANT,
-      (_data: string) => {
-        const data = JSON.parse(decodeURIComponent(_data));
-        return this._participantController.selectDatabaseWithParticipant({
-          chatId: data.chatId,
-          databaseName: data.databaseName,
-        });
+      (data: any) => {
+        return this._participantController.selectDatabaseWithParticipant(data);
       }
     );
     this.registerCommand(
       EXTENSION_COMMANDS.SELECT_COLLECTION_WITH_PARTICIPANT,
-      (_data: string) => {
-        const data = JSON.parse(decodeURIComponent(_data));
-        return this._participantController.selectCollectionWithParticipant({
-          chatId: data.chatId,
-          databaseName: data.databaseName,
-          collectionName: data.collectionName,
+      (data: any) => {
+        return this._participantController.selectCollectionWithParticipant(
+          data
+        );
+      }
+    );
+    this.registerCommand(
+      EXTENSION_COMMANDS.PARTICIPANT_OPEN_RAW_SCHEMA_OUTPUT,
+      async ({ schema }: OpenSchemaCommandArgs) => {
+        const document = await vscode.workspace.openTextDocument({
+          language: 'json',
+          content: schema,
         });
+        await vscode.window.showTextDocument(document, { preview: true });
+
+        return !!document;
       }
     );
   };

src/participant/chatMetadata.ts

@@ -20,6 +20,11 @@ export class ChatMetadataStore {
     return this._chats[chatId];
   }
 
+  // Exposed for stubbing in tests.
+  static createNewChatId(): string {
+    return uuidv4();
+  }
+
   static getChatIdFromHistoryOrNewChatId(
     history: ReadonlyArray<vscode.ChatRequestTurn | vscode.ChatResponseTurn>
   ): string {
@@ -32,6 +37,6 @@ export class ChatMetadataStore {
       }
     }
 
-    return uuidv4();
+    return ChatMetadataStore.createNewChatId();
   }
 }

src/participant/constants.ts

@@ -92,3 +92,9 @@ export function docsRequestChatResult(chatId: string): ChatResult {
     },
   };
 }
+
+export function schemaRequestChatResult(
+  history: ReadonlyArray<vscode.ChatRequestTurn | vscode.ChatResponseTurn>
+): ChatResult {
+  return createChatResult('schema', history);
+}

src/participant/markdown.ts

@@ -6,22 +6,14 @@ export function createMarkdownLink({
   name,
 }: {
   commandId: string;
-  data?:
-    | {
-        [field: string]: any;
-      }
-    | string;
+  // TODO: Create types for this data so we can also then use them on the extension
+  // controller when we parse the result.
+  data: {
+    [field: string]: any;
+  };
   name: string;
 }): vscode.MarkdownString {
-  const encodedData = data
-    ? encodeURIComponent(
-        `["${
-          typeof data === 'string'
-            ? data
-            : encodeURIComponent(JSON.stringify(data))
-        }"]`
-      )
-    : undefined;
+  const encodedData = encodeURIComponent(JSON.stringify(data));
   const commandQueryString = data ? `?${encodedData}` : '';
   const link = new vscode.MarkdownString(
     `- <a href="command:${commandId}${commandQueryString}">${name}</a>\n`