custom prompts: add intro and new context type (#255)

abeatrix · web-flow · commit 801a1229a5ff · 2023-07-14T19:20:31.000Z
This PR adds new context types to the custom prompts feature. Users can specify what type of context to include when building their recipe: ``` export interface CodyPromptContext { codebase: boolean openTabs?: boolean currentDir?: boolean excludeSelection?: boolean } ``` Add intro to My Prompts and button to create cody.json file in current workspace: ![image](https://github.com/sourcegraph/cody/assets/68532117/5f54f69a-675d-4d05-aa34-b2c715c97420)
diff --git a/.vscode/cody.json b/.vscode/cody.json
@@ -0,0 +1,36 @@
+{
+  "description": "This file is used for building custom workspace recipes for Cody by Sourcegraph.",
+  "recipes": {
+    "Spell Checker": {
+      "prompt": "Spell check the selected code and let me know if I have any typos or non-standard usage.",
+      "context": {
+        "codebase": false
+      }
+    },
+    "Refactor Code": {
+      "prompt": "Suggest ways to refactor the selected code to improve readability and maintainability",
+      "context": {
+        "currentDir": true
+      }
+    },
+    "Compare Files in Opened Tabs": {
+      "prompt": "Compare the code from the shared files and explain how they are related",
+      "context": {
+        "openTabs": true,
+        "excludeSelection": true
+      }
+    },
+    "GH Search: Deploy Repoes not owned by Sourcegraph": {
+      "prompt": "What are the names of repositories that are used for deploying Sourcegraph, but is not directly owned by Sourcegraph?",
+      "command": "gh",
+      "args": ["search", "repos", "sourcegraph", "deploy"],
+      "note": "You must have gh command installed and authenticated to use this recipe"
+    },
+    "Last Git Commit Info": {
+      "prompt": "Who made the last commit to this repository and what did they change?",
+      "command": "git",
+      "args": ["log", "-1"],
+      "note": "You must have git command installed and authenticated to use this recipe"
+    }
+  }
+}
diff --git a/lib/shared/src/chat/recipes/helpers.ts b/lib/shared/src/chat/recipes/helpers.ts
@@ -62,7 +62,7 @@ export function getFileExtension(fileName: string): string {
 // ex. Remove  `tags:` that Cody sometimes include in the returned content
 // It also removes all spaces before a new line to keep the indentations
 export function contentSanitizer(text: string): string {
-    let output = text.trimEnd().replace(/<\/selection>$/, '')
+    let output = text.replace(/<\/selection>\s$/, '')
     const tagsIndex = text.indexOf('tags:')
     if (tagsIndex !== -1) {
         // NOTE: 6 is the length of `tags:` + 1 space
diff --git a/lib/shared/src/chat/recipes/my-prompt.ts b/lib/shared/src/chat/recipes/my-prompt.ts
@@ -27,7 +27,7 @@ export class MyPrompt implements Recipe {
         // Match human input with key from promptStore to get prompt text when there is none
         let promptText = humanInput || this.promptStore.get(humanInput) || null
         if (!promptText) {
-            await vscode.window.showErrorMessage('Please enter a valid for the recipe.')
+            await vscode.window.showErrorMessage('Please enter a valid prompt for the recipe.')
             return null
         }
 
@@ -37,7 +37,7 @@ export class MyPrompt implements Recipe {
         const commandOutput = context.editor.controllers?.prompt.get()
         if (commandOutput) {
             // promptText += `\n${commandOutput}\n`
-            promptText += 'Please refer to the command output when answering my quesiton.'
+            promptText += 'Please refer to the command output or the code I am looking at to answer my quesiton.'
         }
 
         // Add selection file name as display when available
@@ -67,67 +67,96 @@ export class MyPrompt implements Recipe {
         commandOutput?: string | null
     ): Promise<ContextMessage[]> {
         const contextMessages: ContextMessage[] = []
-
-        const isCodebaseContextRequired = editor.controllers?.prompt.get('context')
-        if (isCodebaseContextRequired) {
-            await vscode.window.showInformationMessage('Codebase is not required.')
+        const contextConfig = editor.controllers?.prompt.get('context')
+        const isCodebaseContextRequired = contextConfig
+            ? (JSON.parse(contextConfig) as CodyPromptContext)
+            : defaultCodyPromptContext
+        // Codebase context is not included by default
+        if (isCodebaseContextRequired.codebase) {
             const codebaseContextMessages = await codebaseContext.getContextMessages(text, {
                 numCodeResults: 12,
                 numTextResults: 3,
             })
             contextMessages.push(...codebaseContextMessages)
-
-            // Create context messages from open tabs
-            if (contextMessages.length < 10) {
-                contextMessages.push(...MyPrompt.getEditorOpenTabsContext())
-            }
         }
-
+        // Create context messages from open tabs
+        if (isCodebaseContextRequired.openTabs) {
+            const openTabsContext = await MyPrompt.getEditorOpenTabsContext()
+            contextMessages.push(...openTabsContext)
+        }
+        // Create context messages from current directory
+        if (isCodebaseContextRequired.currentDir) {
+            const currentDirContext = await MyPrompt.getCurrentDirContext()
+            contextMessages.push(...currentDirContext)
+        }
         // Add selected text as context when available
-        if (selection?.selectedText) {
+        if (selection?.selectedText && !isCodebaseContextRequired.excludeSelection) {
             contextMessages.push(...ChatQuestion.getEditorSelectionContext(selection))
         }
-
         // Create context messages from terminal output if any
         if (commandOutput) {
             contextMessages.push(...MyPrompt.getTerminalOutputContext(commandOutput))
         }
-
         return contextMessages.slice(-12)
     }
 
     // Get context from current editor open tabs
-    public static getEditorOpenTabsContext(): ContextMessage[] {
+    public static async getEditorOpenTabsContext(): Promise<ContextMessage[]> {
         const contextMessages: ContextMessage[] = []
-        // Skip the current active tab (which is already included in selection context), files in currentDir, and non-file tabs
-        const openTabs = vscode.window.visibleTextEditors
-        for (const tab of openTabs) {
-            if (tab === vscode.window.activeTextEditor || tab.document.uri.scheme !== 'file') {
+        // Get a list of the open tabs
+        const openTabs = vscode.window.tabGroups.all
+        const files = openTabs.flatMap(group => group.tabs.map(tab => tab.input)) as vscode.TabInputText[]
+        for (const doc of files) {
+            if (doc.uri.scheme !== 'file') {
                 continue
             }
-            const fileName = tab.document.fileName
-            const truncatedContent = truncateText(tab.document.getText(), MAX_CURRENT_FILE_TOKENS)
-            const contextMessage = getContextMessageWithResponse(
+            const fileName = vscode.workspace.asRelativePath(doc.uri.fsPath)
+            // remove workspace root path from fileName
+            const fileContent = await vscode.workspace.openTextDocument(doc.uri)
+            const truncatedContent = truncateText(fileContent.getText(), MAX_CURRENT_FILE_TOKENS)
+            const docAsMessage = getContextMessageWithResponse(
                 populateCurrentEditorContextTemplate(truncatedContent, fileName),
-                {
-                    fileName,
-                }
+                { fileName }
             )
-            contextMessages.push(...contextMessage)
+            contextMessages.push(...docAsMessage)
         }
         return contextMessages
     }
 
-    // Get display text for human
-    private getHumanDisplayText(humanChatInput: string, fileName: string): string {
-        return humanChatInput + InlineTouch.displayPrompt + fileName
-    }
-
     public static getTerminalOutputContext(output: string): ContextMessage[] {
         const truncatedContent = truncateText(output, MAX_CURRENT_FILE_TOKENS)
         return [
             { speaker: 'human', text: populateTerminalOutputContextTemplate(truncatedContent) },
             { speaker: 'assistant', text: 'OK.' },
         ]
     }
+
+    // Create Context from Current Directory of Active Document
+    public static async getCurrentDirContext(): Promise<ContextMessage[]> {
+        // get current document file path
+        const currentDoc = vscode.window.activeTextEditor?.document
+        if (!currentDoc) {
+            return []
+        }
+        return InlineTouch.getEditorDirContext(currentDoc.fileName.replace(/\/[^/]+$/, ''))
+    }
+
+    // Get display text for human
+    private getHumanDisplayText(humanChatInput: string, fileName: string): string {
+        return humanChatInput + InlineTouch.displayPrompt + fileName
+    }
+}
+
+export interface CodyPromptContext {
+    codebase: boolean
+    openTabs?: boolean
+    currentDir?: boolean
+    excludeSelection?: boolean
+}
+
+export const defaultCodyPromptContext: CodyPromptContext = {
+    codebase: false,
+    openTabs: false,
+    currentDir: false,
+    excludeSelection: false,
 }
diff --git a/vscode/CHANGELOG.md b/vscode/CHANGELOG.md
@@ -9,12 +9,14 @@ Starting from `0.2.0`, Cody is using `major.EVEN_NUMBER.patch` for release versi
 ### Added
 
 - Added support for the CMD+K hotkey to clear the code chat history. [pull/245](https://github.com/sourcegraph/cody/pull/245)
+- [Internal Only] `Custom Recipe` is available for S2 internal users for testing purpose. [pull/81](https://github.com/sourcegraph/cody/pull/81)
 
 ### Fixed
 
 - Fixed a bug that caused messages to disappear when signed-in users encounter an authentication error. [pull/201](https://github.com/sourcegraph/cody/pull/201)
 - Inline Chat: Since last version, running Inline Fixups would add an additional `</selection>` tag to the end of the code edited by Cody, which has now been removed. [pull/182](https://github.com/sourcegraph/cody/pull/182)
 - Chat Command: Fixed an issue where /r(est) had a trailing space. [pull/245](https://github.com/sourcegraph/cody/pull/245)
+- Inline Fixups: Fixed a regression where Cody's inline fixup suggestions were not properly replacing the user's selection. [pull/70](https://github.com/sourcegraph/cody/pull/70)
 
 ### Changed
 
diff --git a/vscode/resources/bin/cody.json b/vscode/resources/bin/cody.json
@@ -0,0 +1,36 @@
+{
+  "description": "This file is used for building custom workspace recipes for Cody by Sourcegraph.",
+  "recipes": {
+    "Spell Checker": {
+      "prompt": "Spell check the selected code and let me know if I have any typos or non-standard usage.",
+      "context": {
+        "codebase": false
+      }
+    },
+    "Refactor Code": {
+      "prompt": "Suggest ways to refactor the selected code to improve readability and maintainability",
+      "context": {
+        "currentDir": true
+      }
+    },
+    "Compare Files in Opened Tabs": {
+      "prompt": "Compare the code from the shared files and explain how they are related",
+      "context": {
+        "openTabs": true,
+        "excludeSelection": true
+      }
+    },
+    "GH Search: Deploy Repoes not owned by Sourcegraph": {
+      "prompt": "What are the names of repositories that are used for deploying Sourcegraph, but is not directly owned by Sourcegraph?",
+      "command": "gh",
+      "args": ["search", "repos", "sourcegraph", "deploy"],
+      "note": "You must have gh command installed and authenticated to use this recipe"
+    },
+    "Last Git Commit Info": {
+      "prompt": "Who made the last commit to this repository and what did they change?",
+      "command": "git",
+      "args": ["log", "-1"],
+      "note": "You must have git command installed and authenticated to use this recipe"
+    }
+  }
+}
diff --git a/vscode/src/chat/ChatViewProvider.ts b/vscode/src/chat/ChatViewProvider.ts
@@ -717,11 +717,42 @@ export class ChatViewProvider implements vscode.WebviewViewProvider, vscode.Disp
             return
         }
         // Create a new recipe
-        if (title === 'new') {
+        if (title === 'add') {
             await this.editor.controllers.prompt.add()
             await this.sendMyPrompts()
             return
         }
+        // Clear all recipes stored in user global storage
+        if (title === 'clear') {
+            await this.editor.controllers.prompt.clear()
+            await this.sendMyPrompts()
+            return
+        }
+        if (title === 'new-workspace-example-file') {
+            if (!this.currentWorkspaceRoot) {
+                void vscode.window.showErrorMessage('Could not find workspace path.')
+                return
+            }
+            try {
+                // copy the cody.json file from the extension path and move it to the workspace root directory
+                // Find the fsPath of the cody.json example file from the this.rgPath
+                const extensionPath = this.rgPath.slice(0, Math.max(0, this.rgPath.lastIndexOf('/')))
+                const extensionUri = vscode.Uri.parse(extensionPath)
+                const codyJsonPath = vscode.Uri.joinPath(extensionUri, 'cody.json')
+                const bytes = await vscode.workspace.fs.readFile(codyJsonPath)
+                const decoded = new TextDecoder('utf-8').decode(bytes)
+                const workspaceUri = vscode.Uri.parse(this.currentWorkspaceRoot)
+                const workspaceCodyJsonPath = vscode.Uri.joinPath(workspaceUri, '.vscode/cody.json')
+                const workspaceEditor = new vscode.WorkspaceEdit()
+                workspaceEditor.createFile(workspaceCodyJsonPath, { ignoreIfExists: false })
+                workspaceEditor.insert(workspaceCodyJsonPath, new vscode.Position(0, 0), decoded)
+                await vscode.workspace.applyEdit(workspaceEditor)
+                await vscode.window.showTextDocument(workspaceCodyJsonPath)
+            } catch (error) {
+                void vscode.window.showErrorMessage(`Could not create a new cody.json file: ${error}`)
+            }
+            return
+        }
         this.showTab('chat')
         // Get prompt details from controller by title then execute
         const prompt = this.editor.controllers.prompt.find(title)
diff --git a/vscode/src/my-cody/MyPromptController.ts b/vscode/src/my-cody/MyPromptController.ts
@@ -1,5 +1,6 @@
 import * as vscode from 'vscode'
 
+import { CodyPromptContext, defaultCodyPromptContext } from '@sourcegraph/cody-shared/src/chat/recipes/my-prompt'
 import { Message } from '@sourcegraph/cody-shared/src/sourcegraph-api'
 
 import { isInternalUser } from '../chat/protocol'
@@ -15,10 +16,7 @@ interface CodyPrompt {
     prompt: string
     command?: string
     args?: string[]
-    context?: {
-        codebase: boolean
-        openTabs?: boolean
-    }
+    context?: CodyPromptContext
     type?: CodyPromptType
 }
 
@@ -73,6 +71,10 @@ export class MyPromptController {
     // getter for the promptInProgress
     public get(type?: string): string | null {
         if (type === 'context') {
+            const contextConfig = this.myPromptInProgress?.context
+            return JSON.stringify(contextConfig || defaultCodyPromptContext)
+        }
+        if (type === 'codebase') {
             return this.myPromptInProgress?.context?.codebase ? 'codebase' : null
         }
         // return the terminal output from the last command run
@@ -145,15 +147,27 @@ export class MyPromptController {
         this.myPromptStore = await this.builder.get()
     }
 
+    public async clear(): Promise<void> {
+        if (!this.builder.userPromptsSize) {
+            void vscode.window.showInformationMessage(
+                'No User Recipes to remove. If you want to remove Workspace Recipes, please remove the .vscode/cody.json file from your repository.'
+            )
+        }
+        await this.context.globalState.update(MY_CODY_PROMPTS_KEY, null)
+    }
+
     public async add(): Promise<void> {
         // Get the prompt name and prompt description from the user using the input box with 2 steps
         const promptName = await vscode.window.showInputBox({
             title: 'Creating a new custom recipe...',
-            prompt: 'What is the name for the new recipe?',
+            prompt: 'Enter an unique name for the new recipe.',
             placeHolder: 'e,g. Vulnerability Scanner',
             validateInput: (input: string) => {
-                if (!input) {
-                    return 'Please enter a prompt name.'
+                if (!input || input === 'add' || input === 'clear') {
+                    return 'Please enter a valid name for the recipe.'
+                }
+                if (this.myPromptStore.has(input)) {
+                    return 'A recipe with the same name already exists. Please enter a different name.'
                 }
                 return
             },
@@ -180,7 +194,7 @@ export class MyPromptController {
         const promptCommand = await vscode.window.showInputBox({
             title: 'Creating a new custom recipe...',
             prompt: '[Optional] Add a terminal command for the recipe to run from your current workspace. The output will be shared with Cody as context for the prompt. (The added command must work on your local machine.)',
-            placeHolder: 'e,g. node your-script.js, git describe --long, etc.',
+            placeHolder: 'e,g. node your-script.js, git describe --long, cat src/file-name.js etc.',
         })
         if (promptCommand) {
             const commandParts = promptCommand.split(' ')
@@ -201,6 +215,8 @@ class MyRecipesBuilder {
     public myPromptsMap = new Map<string, CodyPrompt>()
     public idSet = new Set<string>()
 
+    public userPromptsSize = 0
+
     public codebase: string | null = null
 
     constructor(private globalState: vscode.Memento, private workspaceRoot: string | null) {}
@@ -211,7 +227,8 @@ class MyRecipesBuilder {
         this.idSet = new Set<string>()
         // user prompts
         const storagePrompts = this.getPromptsFromExtensionStorage()
-        this.build(storagePrompts, 'user')
+        const storagePromptsMap = this.build(storagePrompts, 'user')
+        this.userPromptsSize = storagePromptsMap?.size || 0
         // workspace prompts
         const wsPrompts = await this.getPromptsFromWorkspace(this.workspaceRoot)
         this.build(wsPrompts, 'workspace')
diff --git a/vscode/src/services/DecorationProvider.ts b/vscode/src/services/DecorationProvider.ts
@@ -90,7 +90,7 @@ export class DecorationProvider {
      */
     public setState(status: CodyTaskState, newRange: vscode.Range): void {
         this.status = status
-        this.range = new vscode.Range(newRange.start.line, 0, Math.max(0, newRange.end.line - 1), 0)
+        this.range = new vscode.Range(newRange.start.line, 0, Math.max(0, newRange.end.line), 0)
         this.decorate()
         this._onDidChange.fire()
     }
diff --git a/vscode/webviews/Recipes.module.css b/vscode/webviews/Recipes.module.css
@@ -16,6 +16,13 @@
     justify-content: space-between;
     align-items: center;
 
-    font-size: 1rem;
+    font-size: 0.8rem;
     font-weight: bold;
 }
+
+.recipes-notes {
+    display: flex;
+    align-items: center;
+    margin: 0.1rem 0;
+    font-size: small;
+}
diff --git a/vscode/webviews/Recipes.tsx b/vscode/webviews/Recipes.tsx

Original file line number	Diff line number	Diff line change
`@@ -90,7 +90,7 @@ export class DecorationProvider {`
`90`	`90`	`*/`
`91`	`91`	`public setState(status: CodyTaskState, newRange: vscode.Range): void {`
`92`	`92`	`this.status = status`
`93`		`- this.range = new vscode.Range(newRange.start.line, 0, Math.max(0, newRange.end.line - 1), 0)`
	`93`	`+ this.range = new vscode.Range(newRange.start.line, 0, Math.max(0, newRange.end.line), 0)`
`94`	`94`	`this.decorate()`
`95`	`95`	`this._onDidChange.fire()`
`96`	`96`	`}`