|
| 1 | +import * as vscode from "vscode"; |
| 2 | + |
| 3 | +import { Command } from "./common"; |
| 4 | +import { Workspace } from "./workspace"; |
| 5 | + |
| 6 | +const CHAT_AGENT_ID = "rubyLsp.chatAgent"; |
| 7 | +const DESIGN_PROMPT = ` |
| 8 | + You are a domain driven design and Ruby on Rails expert. |
| 9 | + The user will provide you with details about their Rails application. |
| 10 | + The user will ask you to help model a single specific concept. |
| 11 | + Your job is to suggest a model name and attributes to model that concept. |
| 12 | + Include all Rails \`generate\` commands in a single Markdown shell code block at the end. |
| 13 | + The \`generate\` commands should ONLY include the type of generator and arguments, not the \`rails generate\` part |
| 14 | + (e.g.: \`model User name:string\` but not \`rails generate model User name:string\`). |
| 15 | + NEVER include commands to migrate the database as part of the code block. |
| 16 | +`.trim(); |
| 17 | + |
| 18 | +export class ChatAgent implements vscode.Disposable { |
| 19 | + private readonly agent: vscode.ChatParticipant; |
| 20 | + private readonly showWorkspacePick: () => Promise<Workspace | undefined>; |
| 21 | + |
| 22 | + constructor( |
| 23 | + context: vscode.ExtensionContext, |
| 24 | + showWorkspacePick: () => Promise<Workspace | undefined>, |
| 25 | + ) { |
| 26 | + this.agent = vscode.chat.createChatParticipant( |
| 27 | + CHAT_AGENT_ID, |
| 28 | + this.handler.bind(this), |
| 29 | + ); |
| 30 | + this.agent.iconPath = vscode.Uri.joinPath(context.extensionUri, "icon.png"); |
| 31 | + this.showWorkspacePick = showWorkspacePick; |
| 32 | + } |
| 33 | + |
| 34 | + dispose() { |
| 35 | + this.agent.dispose(); |
| 36 | + } |
| 37 | + |
| 38 | + // Handle a new chat message or command |
| 39 | + private async handler( |
| 40 | + request: vscode.ChatRequest, |
| 41 | + context: vscode.ChatContext, |
| 42 | + stream: vscode.ChatResponseStream, |
| 43 | + token: vscode.CancellationToken, |
| 44 | + ) { |
| 45 | + if (this.withinConversation("design", request, context)) { |
| 46 | + return this.runDesignCommand(request, context, stream, token); |
| 47 | + } |
| 48 | + |
| 49 | + stream.markdown( |
| 50 | + "Please indicate which command you would like to use for our chat.", |
| 51 | + ); |
| 52 | + return { metadata: { command: "" } }; |
| 53 | + } |
| 54 | + |
| 55 | + // Logic for the domain driven design command |
| 56 | + private async runDesignCommand( |
| 57 | + request: vscode.ChatRequest, |
| 58 | + context: vscode.ChatContext, |
| 59 | + stream: vscode.ChatResponseStream, |
| 60 | + token: vscode.CancellationToken, |
| 61 | + ) { |
| 62 | + const previousInteractions = this.previousInteractions(context); |
| 63 | + const messages = [ |
| 64 | + vscode.LanguageModelChatMessage.User(`User prompt: ${request.prompt}`), |
| 65 | + vscode.LanguageModelChatMessage.User(DESIGN_PROMPT), |
| 66 | + vscode.LanguageModelChatMessage.User( |
| 67 | + `Previous interactions with the user: ${previousInteractions}`, |
| 68 | + ), |
| 69 | + ]; |
| 70 | + const workspace = await this.showWorkspacePick(); |
| 71 | + |
| 72 | + // On the first interaction with the design command, we gather the application's schema and include it as part of |
| 73 | + // the prompt |
| 74 | + if (request.command && workspace) { |
| 75 | + const schema = await this.schema(workspace); |
| 76 | + |
| 77 | + if (schema) { |
| 78 | + messages.push( |
| 79 | + vscode.LanguageModelChatMessage.User( |
| 80 | + `Existing application schema: ${schema}`, |
| 81 | + ), |
| 82 | + ); |
| 83 | + } |
| 84 | + } |
| 85 | + |
| 86 | + try { |
| 87 | + // Select the LLM model |
| 88 | + const [model] = await vscode.lm.selectChatModels({ |
| 89 | + vendor: "copilot", |
| 90 | + family: "gpt-4-turbo", |
| 91 | + }); |
| 92 | + |
| 93 | + stream.progress("Designing the models for the requested concept..."); |
| 94 | + const chatResponse = await model.sendRequest(messages, {}, token); |
| 95 | + |
| 96 | + let response = ""; |
| 97 | + for await (const fragment of chatResponse.text) { |
| 98 | + // Maybe show the buttons here and display multiple shell blocks? |
| 99 | + stream.markdown(fragment); |
| 100 | + response += fragment; |
| 101 | + } |
| 102 | + |
| 103 | + const match = /(?<=```shell)[^.$]*(?=```)/.exec(response); |
| 104 | + |
| 105 | + if (workspace && match && match[0]) { |
| 106 | + // The shell code block includes all of the `rails generate` commands. We need to strip out the `rails generate` |
| 107 | + // from all of them since our commands only accept from the generator forward |
| 108 | + const commandList = match[0] |
| 109 | + .trim() |
| 110 | + .split("\n") |
| 111 | + .map((command) => { |
| 112 | + return command.replace(/\s*(bin\/rails|rails) generate\s*/, ""); |
| 113 | + }); |
| 114 | + |
| 115 | + stream.button({ |
| 116 | + command: Command.RailsGenerate, |
| 117 | + title: "Generate with Rails", |
| 118 | + arguments: [commandList, workspace], |
| 119 | + }); |
| 120 | + |
| 121 | + stream.button({ |
| 122 | + command: Command.RailsDestroy, |
| 123 | + title: "Revert previous generation", |
| 124 | + arguments: [commandList, workspace], |
| 125 | + }); |
| 126 | + } |
| 127 | + } catch (err) { |
| 128 | + this.handleError(err, stream); |
| 129 | + } |
| 130 | + |
| 131 | + return { metadata: { command: "design" } }; |
| 132 | + } |
| 133 | + |
| 134 | + private async schema(workspace: Workspace) { |
| 135 | + try { |
| 136 | + const content = await vscode.workspace.fs.readFile( |
| 137 | + vscode.Uri.joinPath(workspace.workspaceFolder.uri, "db/schema.rb"), |
| 138 | + ); |
| 139 | + return content.toString(); |
| 140 | + } catch (error) { |
| 141 | + // db/schema.rb doesn't exist |
| 142 | + } |
| 143 | + |
| 144 | + try { |
| 145 | + const content = await vscode.workspace.fs.readFile( |
| 146 | + vscode.Uri.joinPath(workspace.workspaceFolder.uri, "db/structure.sql"), |
| 147 | + ); |
| 148 | + return content.toString(); |
| 149 | + } catch (error) { |
| 150 | + // db/structure.sql doesn't exist |
| 151 | + } |
| 152 | + |
| 153 | + return undefined; |
| 154 | + } |
| 155 | + |
| 156 | + // Returns `true` if the current or any previous interactions with the chat match the given `command`. Useful for |
| 157 | + // ensuring that the user can continue chatting without having to re-type the desired command multiple times |
| 158 | + private withinConversation( |
| 159 | + command: string, |
| 160 | + request: vscode.ChatRequest, |
| 161 | + context: vscode.ChatContext, |
| 162 | + ) { |
| 163 | + return ( |
| 164 | + request.command === command || |
| 165 | + (!request.command && |
| 166 | + context.history.some( |
| 167 | + (entry) => |
| 168 | + entry instanceof vscode.ChatRequestTurn && |
| 169 | + entry.command === command, |
| 170 | + )) |
| 171 | + ); |
| 172 | + } |
| 173 | + |
| 174 | + // Default error handling |
| 175 | + private handleError(err: any, stream: vscode.ChatResponseStream) { |
| 176 | + if (err instanceof vscode.LanguageModelError) { |
| 177 | + if ( |
| 178 | + err.cause instanceof Error && |
| 179 | + err.cause.message.includes("off_topic") |
| 180 | + ) { |
| 181 | + stream.markdown( |
| 182 | + "Sorry, I can only help you with Ruby related questions", |
| 183 | + ); |
| 184 | + } |
| 185 | + } else { |
| 186 | + throw err; |
| 187 | + } |
| 188 | + } |
| 189 | + |
| 190 | + // Get the content of all previous interactions (including requests and responses) as a string |
| 191 | + private previousInteractions(context: vscode.ChatContext): string { |
| 192 | + let history = ""; |
| 193 | + |
| 194 | + context.history.forEach((entry) => { |
| 195 | + if (entry instanceof vscode.ChatResponseTurn) { |
| 196 | + if (entry.participant === CHAT_AGENT_ID) { |
| 197 | + let content = ""; |
| 198 | + |
| 199 | + entry.response.forEach((part) => { |
| 200 | + if (part instanceof vscode.ChatResponseMarkdownPart) { |
| 201 | + content += part.value.value; |
| 202 | + } |
| 203 | + }); |
| 204 | + |
| 205 | + history += `Response: ${content}`; |
| 206 | + } |
| 207 | + } else { |
| 208 | + history += `Request: ${entry.prompt}`; |
| 209 | + } |
| 210 | + }); |
| 211 | + |
| 212 | + return history; |
| 213 | + } |
| 214 | +} |
0 commit comments