fix: add debug mode in vscode (#2400)

Author: MaxKless

apps/vscode/package.json

@@ -796,11 +796,11 @@
           "default": "all",
           "description": "Controls which notifications are shown for Nx Cloud."
         },
-        "nxConsole.enableNxCopilotFeatures": {
+        "nxConsole.debugMode": {
           "type": "boolean",
           "default": false,
           "scope": "machine",
-          "description": "Enable Nx-specific copilot features (Experimental)."
+          "description": "Enable debug mode (internal)"
         }
       }
     },

libs/vscode/configuration/src/lib/configuration-keys.ts

@@ -14,7 +14,7 @@ export const GLOBAL_CONFIG_KEYS = [
   'showNodeVersionOnStartup',
   'nxWorkspacePath',
   'nxCloudNotifications',
-  'enableNxCopilotFeatures',
+  'debugMode',
 ] as const;
 
 export type GlobalConfig = {
@@ -33,7 +33,7 @@ export type GlobalConfig = {
   showNodeVersionOnStartup: boolean;
   nxWorkspacePath: string;
   nxCloudNotifications: 'all' | 'errors' | 'none';
-  enableNxCopilotFeatures: boolean;
+  debugMode: boolean;
 };
 
 /**

libs/vscode/copilot/src/lib/init-copilot.ts

@@ -7,7 +7,8 @@ import {
 import { openGenerateUIPrefilled } from '@nx-console/vscode-generate-ui-webview';
 import { EXECUTE_ARBITRARY_COMMAND } from '@nx-console/vscode-nx-commands-view';
 import { getGenerators, getNxWorkspace } from '@nx-console/vscode-nx-workspace';
-import { renderPrompt } from '@vscode/prompt-tsx';
+import { sendChatParticipantRequest } from '@vscode/chat-extension-utils';
+import { PromptElementAndProps } from '@vscode/chat-extension-utils/dist/toolsPrompt';
 import { readFile } from 'fs/promises';
 import type { TargetConfiguration } from 'nx/src/devkit-exports.js';
 import {
@@ -19,8 +20,7 @@ import {
   ChatResponseStream,
   commands,
   ExtensionContext,
-  LanguageModelChatMessage,
-  lm,
+  LanguageModelToolResult,
   MarkdownString,
   Uri,
 } from 'vscode';
@@ -51,20 +51,12 @@ const handler: ChatRequestHandler = async (
   token: CancellationToken
 ) => {
   const enableNxCopilotFeaturesSetting = GlobalConfigurationStore.instance.get(
-    'enableNxCopilotFeatures',
+    'debugMode',
     false
   );
 
   if (!enableNxCopilotFeaturesSetting) {
-    stream.markdown(
-      'The @nx copilot chat participant is experimental. To use it, please enable it in the settings.'
-    );
-
-    stream.button({
-      title: 'Enable Nx Copilot',
-      command: 'workbench.action.openSettings',
-      arguments: ['nxConsole.enableNxCopilotFeatures'],
-    });
+    stream.markdown('@nx is coming soon. Stay tuned!');
     return;
   }
   const workspacePath = getNxWorkspacePath();
@@ -75,7 +67,6 @@ const handler: ChatRequestHandler = async (
 
   const pmExec = (await getPackageManagerCommand(workspacePath)).exec;
 
-  let messages: LanguageModelChatMessage[];
   const baseProps: NxCopilotPromptProps = {
     userQuery: request.prompt,
     projectGraph: projectGraph,
@@ -84,91 +75,97 @@ const handler: ChatRequestHandler = async (
     packageManagerExecCommand: pmExec,
   };
 
+  let promptElementAndProps: PromptElementAndProps<
+    NxCopilotPrompt | GeneratePrompt
+  >;
+
   if (request.command === 'generate') {
     stream.progress('Retrieving generator schemas...');
 
-    const prompt = await renderPrompt(
-      GeneratePrompt,
-      {
+    promptElementAndProps = {
+      promptElement: GeneratePrompt,
+      props: {
         ...baseProps,
         generatorSchemas: await getGeneratorSchemas(),
       },
-      { modelMaxPromptTokens: request.model.maxInputTokens },
-      request.model
-    );
-    messages = prompt.messages;
+    };
   } else {
-    try {
-      const prompt = await renderPrompt(
-        NxCopilotPrompt,
-        baseProps,
-        { modelMaxPromptTokens: request.model.maxInputTokens },
-        request.model
-      );
-      messages = prompt.messages;
-    } catch (error) {
-      console.error('Error rendering prompt:', error);
-      stream.markdown(
-        'An error occurred while rendering the prompt. Please try again later.'
-      );
-      return;
-    }
+    promptElementAndProps = {
+      promptElement: NxCopilotPrompt,
+      props: baseProps,
+    };
   }
 
-  const chatResponse = await request.model.sendRequest(messages, {}, token);
+  const chatParticipantRequest = sendChatParticipantRequest(
+    request,
+    context,
+    {
+      prompt: promptElementAndProps,
+      responseStreamOptions: {
+        stream,
+      },
+      tools: [],
+    },
+    token
+  );
 
   const startMarker = new RegExp(`"""\\s*${pmExec}\\s+nx\\s*`);
   const endMarker = `"""`;
 
   let pendingText = '';
   let codeBuffer: string | null = null;
 
-  for await (const fragment of chatResponse.text) {
-    if (codeBuffer !== null) {
-      codeBuffer += fragment;
+  for await (const fragment of chatParticipantRequest.stream) {
+    if (fragment instanceof LanguageModelToolResult) {
+      stream.markdown(JSON.stringify(fragment));
+      continue;
     } else {
-      pendingText += fragment;
-    }
-
-    // Process when we're not in a code block: look for a start marker.
-    while (codeBuffer === null) {
-      const match = pendingText.match(startMarker);
-      const startIndex = match ? match.index : -1;
-      if (startIndex === -1) {
-        break;
-      }
-      if (startIndex > 0) {
-        stream.markdown(pendingText.slice(0, startIndex));
+      if (codeBuffer !== null) {
+        codeBuffer += fragment.value;
+      } else {
+        pendingText += fragment.value;
       }
-      // Switch to code mode.
-      codeBuffer = '';
-      pendingText = pendingText.slice(startIndex + match[0].length);
-      codeBuffer += pendingText;
-      pendingText = '';
-    }
 
-    // If we are in a code block, look for the end marker.
-    while (codeBuffer !== null) {
-      const endIndex = codeBuffer.indexOf(endMarker);
-      if (endIndex === -1) {
-        break;
+      // Process when we're not in a code block: look for a start marker.
+      while (codeBuffer === null) {
+        const match = pendingText.match(startMarker);
+        const startIndex = match ? match.index : -1;
+        if (startIndex === -1) {
+          break;
+        }
+        if (startIndex > 0) {
+          stream.markdown(pendingText.slice(0, startIndex));
+        }
+        // Switch to code mode.
+        codeBuffer = '';
+        pendingText = pendingText.slice(startIndex + match[0].length);
+        codeBuffer += pendingText;
+        pendingText = '';
       }
-      const codeSnippet = codeBuffer.slice(0, endIndex);
 
-      renderCommandSnippet(codeSnippet, stream, pmExec);
-      codeBuffer = codeBuffer.slice(endIndex + endMarker.length);
+      // If we are in a code block, look for the end marker.
+      while (codeBuffer !== null) {
+        const endIndex = codeBuffer.indexOf(endMarker);
+        if (endIndex === -1) {
+          break;
+        }
+        const codeSnippet = codeBuffer.slice(0, endIndex);
+
+        renderCommandSnippet(codeSnippet, stream, pmExec);
+        codeBuffer = codeBuffer.slice(endIndex + endMarker.length);
 
-      // switch back to normal mode.
-      pendingText += codeBuffer;
-      codeBuffer = null;
+        // switch back to normal mode.
+        pendingText += codeBuffer;
+        codeBuffer = null;
+      }
     }
   }
 
   if (codeBuffer === null && pendingText) {
     stream.markdown(pendingText);
   }
 
-  return;
+  return await chatParticipantRequest.result;
 };
 
 async function renderCommandSnippet(

package.json

@@ -23,6 +23,7 @@
     "@monodon/typescript-nx-imports-plugin": "0.2.0",
     "@open-wc/lit-helpers": "^0.6.0",
     "@vscode-elements/elements": "1.9.2-pre.1",
+    "@vscode/chat-extension-utils": "^0.0.0-alpha.5",
     "@vscode/codicons": "^0.0.36",
     "@vscode/webview-ui-toolkit": "^1.2.0",
     "@yarnpkg/fslib": "^3.0.0-rc.48",

yarn.lock

@@ -5157,6 +5157,15 @@ __metadata:
   languageName: node
   linkType: hard
 
+"@vscode/chat-extension-utils@npm:^0.0.0-alpha.5":
+  version: 0.0.0-alpha.5
+  resolution: "@vscode/chat-extension-utils@npm:0.0.0-alpha.5"
+  dependencies:
+    "@vscode/prompt-tsx": ^0.3.0-alpha.14
+  checksum: 20a182c54398d8985af47209dcb7efc6fef2eb47f25bfb13800d3c45546fe28042439386175264ff2b14a704d0601bc0a0a59fd146d2cdb8c331236be7982fc9
+  languageName: node
+  linkType: hard
+
 "@vscode/codicons@npm:^0.0.36":
   version: 0.0.36
   resolution: "@vscode/codicons@npm:0.0.36"
@@ -5171,7 +5180,7 @@ __metadata:
   languageName: node
   linkType: hard
 
-"@vscode/prompt-tsx@npm:^0.3.0-alpha.18":
+"@vscode/prompt-tsx@npm:^0.3.0-alpha.14, @vscode/prompt-tsx@npm:^0.3.0-alpha.18":
   version: 0.3.0-alpha.18
   resolution: "@vscode/prompt-tsx@npm:0.3.0-alpha.18"
   checksum: fd273d88c4b7dc0f6ffab3b1f0079b2e691a225bd38082d90eca046b9e500679e6f9b43411ca6db72203db150f5ab4cb36861730387455619c1cf309bac94283
@@ -13942,6 +13951,7 @@ __metadata:
     "@typescript-eslint/parser": 7.16.1
     "@typescript-eslint/utils": 7.16.1
     "@vscode-elements/elements": 1.9.2-pre.1
+    "@vscode/chat-extension-utils": ^0.0.0-alpha.5
     "@vscode/codicons": ^0.0.36
     "@vscode/prompt-tsx": ^0.3.0-alpha.18
     "@vscode/test-electron": ^2.1.5