feat: Add experimental commit message generator (#2306)

RXminuS · umpox · abeatrix · web-flow · commit 80dbffa0bb0e · 2024-02-13T09:30:23.000Z
## Description Adds a CTA in the Git SCM input to generate a commit message with Cody https://github.com/sourcegraph/cody/assets/9516420/96d18bff-9300-4220-8382-5d2d2a682749 ## Test Plan Staged only: 1. Make changes to a branch 2. Stage only some changes 3. Generate commit message, check that it matches staged changes All: 1. Make changes to a branch 2. Do not stage any changes 3. Generate commit message, check that it matches all changes --------- Co-authored-by: Tom Ross <tom@umpox.com> Co-authored-by: Beatrix <68532117+abeatrix@users.noreply.github.com> Co-authored-by: Danny Tuppeny <danny@tuppeny.com>
diff --git a/lib/shared/src/configuration.ts b/lib/shared/src/configuration.ts
@@ -46,6 +46,7 @@ export interface Configuration {
     /**
      * Experimental
      */
+    experimentalCommitMessage: boolean
     experimentalGuardrails: boolean
     experimentalSymfContext: boolean
     experimentalTracing: boolean
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/vscode/CHANGELOG.md b/vscode/CHANGELOG.md
@@ -6,6 +6,8 @@ This is a log of all notable changes to Cody for VS Code. [Unreleased] changes a
 
 ### Added
 
+- Cody can now generate commit messages from your changes. Triggered through the input field in the VS Code "Source Control" sidebar. [pull/2306](https://github.com/sourcegraph/cody/pull/2306)
+
 ### Fixed
 
 ### Changed
diff --git a/vscode/package.json b/vscode/package.json
@@ -848,6 +848,12 @@
                     "markdownDescription": "Enable OpenTelemetry tracing",
                     "default": false
                 },
+                "cody.experimental.commitMessage": {
+                    "order": 99,
+                    "type": "boolean",
+                    "default": true,
+                    "markdownDescription": "Adds a button to the SCM input field to generate a relevant commit message for the current changes."
+                },
                 "cody.debug.enable": {
                     "order": 99,
                     "type": "boolean",
@@ -1074,6 +1080,7 @@
         "lru-cache": "^10.0.0",
         "mkdirp": "^3.0.1",
         "os-browserify": "^0.3.0",
+        "parse-diff": "^0.11.1",
         "socks-proxy-agent": "^8.0.1",
         "unzipper": "^0.10.14",
         "uuid": "^9.0.0",
diff --git a/vscode/src/chat/ContextProvider.ts b/vscode/src/chat/ContextProvider.ts
@@ -38,6 +38,7 @@ export type Config = Pick<
     | 'useContext'
     | 'codeActions'
     | 'experimentalGuardrails'
+    | 'experimentalCommitMessage'
     | 'commandCodeLenses'
     | 'experimentalSimpleChatContext'
     | 'experimentalSymfContext'
diff --git a/vscode/src/configuration.test.ts b/vscode/src/configuration.test.ts
@@ -41,6 +41,8 @@ describe('getConfiguration', () => {
                         return true
                     case 'cody.experimental.guardrails':
                         return true
+                    case 'cody.experimental.commitMessage':
+                        return true
                     case 'cody.codeActions.enabled':
                         return true
                     case 'cody.commandHints.enabled':
@@ -123,6 +125,7 @@ describe('getConfiguration', () => {
             experimentalSymfContext: true,
             experimentalTracing: true,
             editorTitleCommandIcon: true,
+            experimentalCommitMessage: true,
             experimentalGuardrails: true,
             codeActions: true,
             commandHints: true,
diff --git a/vscode/src/configuration.ts b/vscode/src/configuration.ts
@@ -118,6 +118,7 @@ export function getConfiguration(
         internalUnstable: getHiddenSetting('internal.unstable', isTesting),
 
         autocompleteExperimentalGraphContext,
+        experimentalCommitMessage: getHiddenSetting('experimental.commitMessage', true),
         experimentalSimpleChatContext: getHiddenSetting('experimental.simpleChatContext', true),
         experimentalSymfContext: getHiddenSetting('experimental.symfContext', true),
 
diff --git a/vscode/src/extension.common.ts b/vscode/src/extension.common.ts
@@ -16,6 +16,7 @@ import { ExtensionApi } from './extension-api'
 import type { LocalEmbeddingsConfig, LocalEmbeddingsController } from './local-context/local-embeddings'
 import type { SymfRunner } from './local-context/symf'
 import { start } from './main'
+import type { CommitMessageProvider } from './scm/CommitMessageProvider'
 import type { OpenTelemetryService } from './services/open-telemetry/OpenTelemetryService.node'
 import { captureException, type SentryService } from './services/sentry/sentry'
 import type { CommandsProvider } from './commands/services/provider'
@@ -38,6 +39,7 @@ export interface PlatformContext {
     createOpenTelemetryService?: (
         config: Pick<ConfigurationWithAccessToken, 'serverEndpoint' | 'experimentalTracing'>
     ) => OpenTelemetryService
+    createCommitMessageProvider?: Constructor<typeof CommitMessageProvider>
     onConfigurationChange?: (configuration: Configuration) => void
 }
 
diff --git a/vscode/src/extension.node.ts b/vscode/src/extension.node.ts
@@ -13,6 +13,7 @@ import {
 import { SymfRunner } from './local-context/symf'
 import { OpenTelemetryService } from './services/open-telemetry/OpenTelemetryService.node'
 import { NodeSentryService } from './services/sentry/sentry.node'
+import { CommitMessageProvider } from './scm/CommitMessageProvider'
 import { CommandsProvider } from './commands/services/provider'
 /**
  * Activation entrypoint for the VS Code extension when running VS Code as a desktop app
@@ -39,6 +40,7 @@ export function activate(context: vscode.ExtensionContext): Promise<ExtensionApi
         createBfgRetriever: () => new BfgRetriever(context),
         createSentryService: (...args) => new NodeSentryService(...args),
         createOpenTelemetryService: (...args) => new OpenTelemetryService(...args),
+        createCommitMessageProvider: (...args) => new CommitMessageProvider(...args),
 
         onConfigurationChange: setCustomAgent,
     })
diff --git a/vscode/src/main.ts b/vscode/src/main.ts
@@ -35,7 +35,8 @@ import type { PlatformContext } from './extension.common'
 import { configureExternalServices } from './external-services'
 import { logDebug, logError } from './log'
 import { showSetupNotification } from './notifications/setup-notification'
-import { gitAPIinit } from './repository/repositoryHelpers'
+import type { CommitMessageProvider } from './scm/CommitMessageProvider'
+import { gitAPIinit, gitAPI as getGitAPI } from './repository/repositoryHelpers'
 import { SearchViewProvider } from './search/SearchViewProvider'
 import { AuthProvider } from './services/AuthProvider'
 import { showFeedbackSupportQuickPick } from './services/FeedbackOptions'
@@ -122,9 +123,9 @@ const register = async (
     disposables.push(manageDisplayPathEnvInfoForExtension())
 
     // Set codyignore list on git extension startup
-    const gitAPI = await gitAPIinit()
-    if (gitAPI) {
-        disposables.push(gitAPI)
+    const gitApiDisposable = await gitAPIinit()
+    if (gitApiDisposable) {
+        disposables.push(gitApiDisposable)
     }
 
     const isExtensionModeDevOrTest =
@@ -219,6 +220,14 @@ const register = async (
         guardrails
     )
 
+    const gitApi = getGitAPI()
+    let commitMessageProvider: CommitMessageProvider | null = null
+    if (gitApi && platform.createCommitMessageProvider) {
+        commitMessageProvider = platform.createCommitMessageProvider({ chatClient, editor, gitApi })
+        commitMessageProvider.onConfigurationChange(initialConfig)
+        disposables.push(commitMessageProvider)
+    }
+
     const ghostHintDecorator = new GhostHintDecorator(authProvider)
     const editorManager = new EditManager({
         chat: chatClient,
@@ -243,6 +252,7 @@ const register = async (
         externalServicesOnDidConfigurationChange(newConfig)
         promises.push(configureEventsInfra(newConfig, isExtensionModeDevOrTest))
         platform.onConfigurationChange?.(newConfig)
+        commitMessageProvider?.onConfigurationChange(newConfig)
         symfRunner?.setSourcegraphAuth(newConfig.serverEndpoint, newConfig.accessToken)
         enterpriseContextFactory.clientConfigurationDidChange()
         promises.push(
diff --git a/vscode/src/repository/builtinGitExtension.d.ts b/vscode/src/repository/builtinGitExtension.d.ts
@@ -129,6 +129,10 @@ export interface LogOptions {
     /** Max number of log entries to retrieve. If not specified, the default is 32. */
     readonly maxEntries?: number
     readonly path?: string
+    /** A commit range, such as "0a47c67f0fb52dd11562af48658bc1dff1d75a38..0bb4bdea78e1db44d728fd6894720071e303304f" */
+    readonly range?: string
+    readonly reverse?: boolean
+    readonly sortByAuthorDate?: boolean
 }
 
 export interface CommitOptions {
@@ -217,6 +221,7 @@ export interface Repository {
     deleteBranch(name: string, force?: boolean): Promise<void>
     getBranch(name: string): Promise<Branch>
     getBranches(query: BranchQuery, cancellationToken?: CancellationToken): Promise<Ref[]>
+    getBranchBase(name: string): Promise<Branch | undefined>
     setBranchUpstream(name: string, upstream: string): Promise<void>
 
     getRefs(query: RefQuery, cancellationToken?: CancellationToken): Promise<Ref[]>
@@ -307,6 +312,16 @@ export interface BranchProtectionProvider {
     provideBranchProtection(): BranchProtection[]
 }
 
+export interface CommitMessageProvider {
+    readonly title: string
+    readonly icon?: Uri | { light: Uri; dark: Uri } | ThemeIcon
+    provideCommitMessage(
+        repository: Repository,
+        changes: string[],
+        cancellationToken?: CancellationToken
+    ): Promise<string | undefined>
+}
+
 export type APIState = 'uninitialized' | 'initialized'
 
 export interface PublishEvent {
@@ -334,6 +349,7 @@ export interface API {
     registerPostCommitCommandsProvider(provider: PostCommitCommandsProvider): Disposable
     registerPushErrorHandler(handler: PushErrorHandler): Disposable
     registerBranchProtectionProvider(root: Uri, provider: BranchProtectionProvider): Disposable
+    registerCommitMessageProvider?(provider: CommitMessageProvider): Disposable
 }
 
 export interface GitExtension {
diff --git a/vscode/src/scm/CommitMessageProvider.ts b/vscode/src/scm/CommitMessageProvider.ts
diff --git a/vscode/src/testutils/mocks.ts b/vscode/src/testutils/mocks.ts
diff --git a/vscode/test/e2e/commit-message.test.ts b/vscode/test/e2e/commit-message.test.ts
