-
Notifications
You must be signed in to change notification settings - Fork 301
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Command: register missing commands when unifiedPrompts is enabled (#5768
) CLOSE https://linear.app/sourcegraph/issue/QA-81 Currently, some commands unrelated to the chat commands are not registered when unified prompts feature is enabled, which I believe is unintentional. This PR add some documentations around some cody commands, and refactor the logic to make it clear what the new unified prompts commands are during the command registeration. This PR also fixes the issue where the generate unit test command was unintentionally removed when the unified prompts feature is enabled. ## Test plan <!-- Required. See https://docs-legacy.sourcegraph.com/dev/background-information/testing_principles. --> Manual Testing: Sign into S2 where the feature flag is enabled for all users.  1. In the Cody Commands menu, search for the following commands to make sure they are working: - Auto Edit - Generate Unit Test 2. Open the Terminal panel and highlight some text, right click to select "Ask Cody to Explain" to verify a Chat panel is opened with the selected text appended.  Before this change, none of these commands were working because they were not registered when the unified prompts feature flag is enabled. ## Changelog <!-- OPTIONAL; info at https://www.notion.so/sourcegraph/Writing-a-changelog-entry-dd997f411d524caabf0d8d38a24a878c --> Command: Fixed an issue where some commands (`Auto-Edit` and `Cody Explain Terminal Output`) were not registered when the unified prompt feature flag is enabled.
- Loading branch information
Showing
4 changed files
with
177 additions
and
47 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,114 @@ | ||
| import { type ContextItem, DefaultChatCommands, logDebug, logError, ps } from '@sourcegraph/cody-shared' | ||
| import { wrapInActiveSpan } from '@sourcegraph/cody-shared' | ||
| import { telemetryRecorder } from '@sourcegraph/cody-shared' | ||
| import type { ChatCommandResult } from '../../CommandResult' | ||
| import { getEditor } from '../../editor/active-editor' | ||
| import { getContextFileFromCursor } from '../context/selection' | ||
| import type { CodyCommandArgs } from '../types' | ||
| import { type ExecuteChatArguments, executeChat } from './ask' | ||
|
|
||
| import type { Span } from '@opentelemetry/api' | ||
| import { isUriIgnoredByContextFilterWithNotification } from '../../cody-ignore/context-filter' | ||
| import { getContextFilesForUnitTestCommand } from '../context/unit-test-file' | ||
| import { selectedCodePromptWithExtraFiles } from './index' | ||
|
|
||
| /** | ||
| * Generates the prompt and context files with arguments for the '/test' command in Chat. | ||
| * | ||
| * Context: Test files, current selection, and current file | ||
| */ | ||
| async function unitTestCommand( | ||
| span: Span, | ||
| args?: Partial<CodyCommandArgs> | ||
| ): Promise<ExecuteChatArguments> { | ||
| let prompt = ps`Review the shared code context and configurations to identify the test framework and libraries in use. Then, generate a suite of multiple unit tests for the functions in <selected> using the detected test framework and libraries. Be sure to import the function being tested. Follow the same patterns as any shared context. Only add packages, imports, dependencies, and assertions if they are used in the shared code. Pay attention to the file path of each shared context to see if test for <selected> already exists. If one exists, focus on generating new unit tests for uncovered cases. If none are detected, import common unit test libraries for {languageName}. Focus on validating key functionality with simple and complete assertions. Only include mocks if one is detected in the shared code. Before writing the tests, identify which test libraries and frameworks to import, e.g. 'No new imports needed - using existing libs' or 'Importing test framework that matches shared context usage' or 'Importing the defined framework', etc. Then briefly summarize test coverage and any limitations. At the end, enclose the full completed code for the new unit tests, including all necessary imports, in a single markdown codeblock. No fragments or TODO. The new tests should validate expected functionality and cover edge cases for <selected> with all required imports, including importing the function being tested. Do not repeat existing tests.` | ||
|
|
||
| if (args?.additionalInstruction) { | ||
| prompt = ps`${prompt} ${args.additionalInstruction}` | ||
| } | ||
|
|
||
| const editor = getEditor()?.active | ||
| const document = editor?.document | ||
| const contextItems: ContextItem[] = [] | ||
|
|
||
| if (document) { | ||
| try { | ||
| const cursorContext = await getContextFileFromCursor() | ||
| if (cursorContext === null) { | ||
| throw new Error( | ||
| 'Selection content is empty. Please select some code to generate tests for.' | ||
| ) | ||
| } | ||
|
|
||
| const sharedContext = await getContextFilesForUnitTestCommand(document.uri).catch(error => { | ||
| logError('executeNewTestCommand', 'failed to fetch context', { verbose: error }) | ||
| return [] | ||
| }) | ||
|
|
||
| prompt = prompt.replaceAll('<selected>', selectedCodePromptWithExtraFiles(cursorContext, [])) | ||
|
|
||
| if (sharedContext.length > 0) { | ||
| prompt = prompt.replaceAll( | ||
| 'the shared code', | ||
| selectedCodePromptWithExtraFiles(sharedContext[0], sharedContext.slice(1)) | ||
| ) | ||
| } | ||
|
|
||
| contextItems.push(cursorContext) | ||
| contextItems.push(...sharedContext) | ||
| } catch (error) { | ||
| logError('testCommand', 'failed to fetch context', { verbose: error }) | ||
| } | ||
| } | ||
|
|
||
| return { | ||
| text: prompt, | ||
| contextItems, | ||
| source: args?.source, | ||
| submitType: 'user-newchat', | ||
| command: DefaultChatCommands.Test, | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Executes the /test command for generating unit tests in Chat for selected code. | ||
| * | ||
| * NOTE: Currently used by agent until inline test command is added to agent. | ||
| */ | ||
| export async function executeTestChatCommand( | ||
| args?: Partial<CodyCommandArgs> | ||
| ): Promise<ChatCommandResult | undefined> { | ||
| return wrapInActiveSpan('command.test-chat', async span => { | ||
| span.setAttribute('sampled', true) | ||
|
|
||
| const editor = getEditor() | ||
| if ( | ||
| editor.active && | ||
| (await isUriIgnoredByContextFilterWithNotification(editor.active.document.uri, 'test')) | ||
| ) { | ||
| return | ||
| } | ||
|
|
||
| logDebug('executeTestEditCommand', 'executing', { args }) | ||
| telemetryRecorder.recordEvent('cody.command.test', 'executed', { | ||
| metadata: { | ||
| useCodebaseContex: 0, | ||
| }, | ||
| interactionID: args?.requestID, | ||
| privateMetadata: { | ||
| requestID: args?.requestID, | ||
| source: args?.source, | ||
| traceId: span.spanContext().traceId, | ||
| }, | ||
| billingMetadata: { | ||
| product: 'cody', | ||
| category: 'core', | ||
| }, | ||
| }) | ||
|
|
||
| return { | ||
| type: 'chat', | ||
| session: await executeChat(await unitTestCommand(span, args)), | ||
| } | ||
| }) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters