Hitesh/1.34.2 patch release (#5524)

## Context
Cherry-pick
Autocomplete Logging: The PR fixes the contextCandidates logged in the
inlineCompletionItemContext.
[pull/5507](#5507)


## Test plan
Updated version and changelog

lib/shared/src/completions/types.ts

@@ -2,6 +2,7 @@ import type * as vscode from 'vscode'
 import type { URI } from 'vscode-uri'
 
 export interface AutocompleteFileContextSnippet {
+    identifier: string
     uri: URI
     startLine: number
     endLine: number

vscode/CHANGELOG.md

@@ -10,6 +10,17 @@ This is a log of all notable changes to Cody for VS Code. [Unreleased] changes a
 
 ### Changed
 
+
+## 1.34.2
+
+### Added
+
+### Fixed
+
+- Autocomplete Logging: The PR fixes the contextCandidates logged in the inlineCompletionItemContext. [pull/5507](https://github.com/sourcegraph/cody/pull/5507)
+
+### Changed
+
 ## 1.34.1
 
 ### Added

vscode/package.json

@@ -3,7 +3,7 @@
   "name": "cody-ai",
   "private": true,
   "displayName": "Cody: AI Coding Assistant with Autocomplete & Chat",
-  "version": "1.34.1",
+  "version": "1.34.2",
   "publisher": "sourcegraph",
   "license": "Apache-2.0",
   "icon": "resources/cody.png",

vscode/src/completions/context/context-mixer.test.ts

@@ -88,12 +88,14 @@ describe('ContextMixer', () => {
                 createMockStrategy([
                     [
                         {
+                            identifier: 'jaccard-similarity',
                             uri: testFileUri('foo.ts'),
                             content: 'function foo() {}',
                             startLine: 0,
                             endLine: 0,
                         },
                         {
+                            identifier: 'jaccard-similarity',
                             uri: testFileUri('bar.ts'),
                             content: 'function bar() {}',
                             startLine: 0,
@@ -107,12 +109,14 @@ describe('ContextMixer', () => {
                 {
                     fileName: 'foo.ts',
                     content: 'function foo() {}',
+                    identifier: 'jaccard-similarity',
                     startLine: 0,
                     endLine: 0,
                 },
                 {
                     fileName: 'bar.ts',
                     content: 'function bar() {}',
+                    identifier: 'jaccard-similarity',
                     startLine: 0,
                     endLine: 0,
                 },
@@ -142,12 +146,14 @@ describe('ContextMixer', () => {
                 createMockStrategy([
                     [
                         {
+                            identifier: 'jaccard-similarity',
                             uri: testFileUri('foo.ts'),
                             content: 'function foo1() {}',
                             startLine: 0,
                             endLine: 0,
                         },
                         {
+                            identifier: 'jaccard-similarity',
                             uri: testFileUri('bar.ts'),
                             content: 'function bar1() {}',
                             startLine: 0,
@@ -157,18 +163,21 @@ describe('ContextMixer', () => {
 
                     [
                         {
+                            identifier: 'jaccard-similarity',
                             uri: testFileUri('foo.ts'),
                             content: 'function foo3() {}',
                             startLine: 10,
                             endLine: 10,
                         },
                         {
+                            identifier: 'jaccard-similarity',
                             uri: testFileUri('foo.ts'),
                             content: 'function foo1() {}\nfunction foo2() {}',
                             startLine: 0,
                             endLine: 1,
                         },
                         {
+                            identifier: 'jaccard-similarity',
                             uri: testFileUri('bar.ts'),
                             content: 'function bar1() {}\nfunction bar2() {}',
                             startLine: 0,
@@ -188,32 +197,37 @@ describe('ContextMixer', () => {
                   "content": "function foo1() {}",
                   "endLine": 0,
                   "fileName": "foo.ts",
+                  "identifier": "jaccard-similarity",
                   "startLine": 0,
                 },
                 {
                   "content": "function foo1() {}
               function foo2() {}",
                   "endLine": 1,
                   "fileName": "foo.ts",
+                  "identifier": "jaccard-similarity",
                   "startLine": 0,
                 },
                 {
                   "content": "function bar1() {}",
                   "endLine": 0,
                   "fileName": "bar.ts",
+                  "identifier": "jaccard-similarity",
                   "startLine": 0,
                 },
                 {
                   "content": "function bar1() {}
               function bar2() {}",
                   "endLine": 1,
                   "fileName": "bar.ts",
+                  "identifier": "jaccard-similarity",
                   "startLine": 0,
                 },
                 {
                   "content": "function foo3() {}",
                   "endLine": 10,
                   "fileName": "foo.ts",
+                  "identifier": "jaccard-similarity",
                   "startLine": 10,
                 },
               ]
@@ -260,12 +274,14 @@ describe('ContextMixer', () => {
                     createMockStrategy([
                         [
                             {
+                                identifier: 'jaccard-similarity',
                                 uri: testFileUri('foo.ts'),
                                 content: 'function foo1() {}',
                                 startLine: 0,
                                 endLine: 0,
                             },
                             {
+                                identifier: 'jaccard-similarity',
                                 uri: testFileUri('foo/bar.ts'),
                                 content: 'function bar1() {}',
                                 startLine: 0,
@@ -274,18 +290,21 @@ describe('ContextMixer', () => {
                         ],
                         [
                             {
+                                identifier: 'jaccard-similarity',
                                 uri: testFileUri('test/foo.ts'),
                                 content: 'function foo3() {}',
                                 startLine: 10,
                                 endLine: 10,
                             },
                             {
+                                identifier: 'jaccard-similarity',
                                 uri: testFileUri('foo.ts'),
                                 content: 'function foo1() {}\nfunction foo2() {}',
                                 startLine: 0,
                                 endLine: 1,
                             },
                             {
+                                identifier: 'jaccard-similarity',
                                 uri: testFileUri('example/bar.ts'),
                                 content: 'function bar1() {}\nfunction bar2() {}',
                                 startLine: 0,
@@ -322,12 +341,14 @@ describe('ContextMixer', () => {
                     createMockStrategy([
                         [
                             {
+                                identifier: 'jaccard-similarity',
                                 uri: testFileUri('foo.ts'),
                                 content: 'function foo1() {}',
                                 startLine: 0,
                                 endLine: 0,
                             },
                             {
+                                identifier: 'jaccard-similarity',
                                 uri: testFileUri('foo/bar.ts'),
                                 content: 'function bar1() {}',
                                 startLine: 0,
@@ -336,18 +357,21 @@ describe('ContextMixer', () => {
                         ],
                         [
                             {
+                                identifier: 'jaccard-similarity',
                                 uri: testFileUri('test/foo.ts'),
                                 content: 'function foo3() {}',
                                 startLine: 10,
                                 endLine: 10,
                             },
                             {
+                                identifier: 'jaccard-similarity',
                                 uri: testFileUri('foo.ts'),
                                 content: 'function foo1() {}\nfunction foo2() {}',
                                 startLine: 0,
                                 endLine: 1,
                             },
                             {
+                                identifier: 'jaccard-similarity',
                                 uri: testFileUri('example/bar.ts'),
                                 content: 'function bar1() {}\nfunction bar2() {}',
                                 startLine: 0,

vscode/src/completions/context/context-mixer.ts

@@ -61,6 +61,7 @@ export interface ContextSummary {
 export interface GetContextResult {
     context: AutocompleteContextSnippet[]
     logSummary: ContextSummary
+    rankedContextCandidates: AutocompleteContextSnippet[]
 }
 
 /**
@@ -90,6 +91,7 @@ export class ContextMixer implements vscode.Disposable {
                     duration: 0,
                     retrieverStats: {},
                 },
+                rankedContextCandidates: [],
             }
         }
 
@@ -172,6 +174,7 @@ export class ContextMixer implements vscode.Disposable {
         return {
             context: mixedContext,
             logSummary,
+            rankedContextCandidates: Array.from(fusedResults),
         }
     }
 

vscode/src/completions/context/retrievers/bfg/bfg-retriever.ts

@@ -9,14 +9,15 @@ import { captureException } from '../../../../services/sentry/sentry'
 import type { ContextRetriever, ContextRetrieverOptions } from '../../../types'
 
 import type { AutocompleteContextSnippet } from '@sourcegraph/cody-shared'
+import { RetrieverIdentifier } from '../../utils'
 import {
     getLastNGraphContextIdentifiersFromDocument,
     getLastNGraphContextIdentifiersFromString,
 } from '../graph/identifiers'
 import { type SimpleRepository, inferGitRepository } from './simple-git'
 
 export class BfgRetriever implements ContextRetriever {
-    public identifier = 'bfg'
+    public identifier = RetrieverIdentifier.BfgRetriever
     private loadedBFG: Promise<MessageHandler>
     private bfgIndexingPromise = Promise.resolve<void>(undefined)
     private awaitIndexing: boolean
@@ -235,6 +236,7 @@ export class BfgRetriever implements ContextRetriever {
             // Convert BFG snippets to match the format expected on the client.
             const symbols = (response.symbols || []).map(contextSnippet => ({
                 ...contextSnippet,
+                identifier: RetrieverIdentifier.BfgRetriever,
                 uri: vscode.Uri.from({ scheme: 'file', path: contextSnippet.fileName }),
             })) satisfies Omit<AutocompleteContextSnippet, 'startLine' | 'endLine'>[]
 

vscode/src/completions/context/retrievers/jaccard-similarity/bestJaccardMatch.test.ts

@@ -127,12 +127,14 @@ describe('bestJaccardMatch', () => {
             score: 1,
             content: 'foo\nbar\nbaz',
             endLine: 2,
+            identifier: 'jaccard-similarity',
             startLine: 0,
         })
         expect(bestJaccardMatches('bar\nquux', matchText, 4, MAX_MATCHES)[0]).toEqual({
             score: 0.5,
             content: 'bar\nbaz\nqux\nquux',
             endLine: 4,
+            identifier: 'jaccard-similarity',
             startLine: 1,
         })
         expect(
@@ -146,6 +148,7 @@ describe('bestJaccardMatch', () => {
             score: 0.3,
             startLine: 4,
             endLine: 9,
+            identifier: 'jaccard-similarity',
             content: ['quux', 'quuz', 'corge', 'grault', 'garply', 'waldo'].join('\n'),
         })
     })
@@ -206,6 +209,7 @@ describe('bestJaccardMatch', () => {
                       'foo',
                       'bar',",
             "endLine": 4,
+            "identifier": "jaccard-similarity",
             "score": 0.14285714285714285,
             "startLine": 0,
           }
@@ -216,6 +220,7 @@ describe('bestJaccardMatch', () => {
         expect(bestJaccardMatches('foo', 'foo', 10, MAX_MATCHES)[0]).toEqual({
             content: 'foo',
             endLine: 0,
+            identifier: 'jaccard-similarity',
             score: 1,
             startLine: 0,
         })

vscode/src/completions/context/retrievers/jaccard-similarity/bestJaccardMatch.ts

@@ -1,9 +1,11 @@
 import { LRUCache } from 'lru-cache'
 import winkUtils from 'wink-nlp-utils'
+import { RetrieverIdentifier } from '../../utils'
 
 const MAX_STEM_CACHE_SIZE = 30000
 
 export interface JaccardMatch {
+    identifier: string
     score: number
     content: string
     startLine: number
@@ -67,6 +69,7 @@ export function bestJaccardMatches(
     // Initialize the result set with the first window
     const windows: JaccardMatch[] = [
         {
+            identifier: RetrieverIdentifier.JaccardSimilarityRetriever,
             score: jaccardSimilarity(targetWordCounts, windowWordCounts, intersectionWordCounts),
             content: lines.slice(firstWindowStart, firstWindowEnd + 1).join('\n'),
             startLine: firstWindowStart,
@@ -118,6 +121,7 @@ export function bestJaccardMatches(
         const startLine = i
         const endLine = i + windowSize - 1
         windows.push({
+            identifier: RetrieverIdentifier.JaccardSimilarityRetriever,
             score,
             content: lines.slice(startLine, endLine + 1).join('\n'),
             startLine,

vscode/src/completions/context/retrievers/jaccard-similarity/jaccard-similarity-retriever.ts

@@ -8,7 +8,7 @@ import { type DocumentHistory, VSCodeDocumentHistory } from './history'
 import { FeatureFlag, isDefined } from '@sourcegraph/cody-shared'
 import { completionProviderConfig } from '../../../completion-provider-config'
 import { lastNLines } from '../../../text-processing'
-import { type ShouldUseContextParams, shouldBeUsedAsContext } from '../../utils'
+import { RetrieverIdentifier, type ShouldUseContextParams, shouldBeUsedAsContext } from '../../utils'
 import { type CachedRerieverOptions, CachedRetriever } from '../cached-retriever'
 import { type JaccardMatch, bestJaccardMatches } from './bestJaccardMatch'
 
@@ -47,7 +47,7 @@ export class JaccardSimilarityRetriever extends CachedRetriever implements Conte
         this.maxMatchesPerFile = options.maxMatchesPerFile ?? MAX_MATCHES_PER_FILE
     }
 
-    public identifier = 'jaccard-similarity'
+    public identifier = RetrieverIdentifier.JaccardSimilarityRetriever
     private history = new VSCodeDocumentHistory()
 
     public async doRetrieval({

vscode/src/completions/context/retrievers/lsp-light/lsp-light-retriever.ts

@@ -10,6 +10,7 @@ import {
 } from '../../../../graph/lsp/symbol-context-snippets'
 import { SupportedLanguage } from '../../../../tree-sitter/grammars'
 import type { ContextRetriever, ContextRetrieverOptions } from '../../../types'
+import { RetrieverIdentifier } from '../../utils'
 import { getLastNGraphContextIdentifiersFromDocument } from '../graph/identifiers'
 
 const SUPPORTED_LANGUAGES = new Set([
@@ -26,7 +27,7 @@ const RECURSION_LIMIT = 3
 const IDENTIFIERS_TO_RESOLVE = 1
 
 export class LspLightRetriever implements ContextRetriever {
-    public identifier = 'lsp-light'
+    public identifier = RetrieverIdentifier.LspLightRetriever
     private disposables: vscode.Disposable[] = []
     private isCacheDisabled = IS_LSP_LIGHT_CACHE_DISABLED
 

vscode/src/completions/context/retrievers/recent-edits/recent-edits-retriever.ts

@@ -4,7 +4,7 @@ import type { AutocompleteContextSnippet } from '@sourcegraph/cody-shared'
 import * as vscode from 'vscode'
 import { getLanguageConfig } from '../../../../tree-sitter/language'
 import type { ContextRetriever, ContextRetrieverOptions } from '../../../types'
-import { type ShouldUseContextParams, shouldBeUsedAsContext } from '../../utils'
+import { RetrieverIdentifier, type ShouldUseContextParams, shouldBeUsedAsContext } from '../../utils'
 
 interface TrackedDocument {
     content: string
@@ -24,7 +24,7 @@ export class RecentEditsRetriever implements vscode.Disposable, ContextRetriever
     // We use a map from the document URI to the set of tracked completions inside that document to
     // improve performance of the `onDidChangeTextDocument` event handler.
     private trackedDocuments: Map<string, TrackedDocument> = new Map()
-    public identifier = 'recent-edits'
+    public identifier = RetrieverIdentifier.RecentEditsRetriever
     private disposables: vscode.Disposable[] = []
 
     constructor(
@@ -54,6 +54,7 @@ export class RecentEditsRetriever implements vscode.Disposable, ContextRetriever
             ).toString()
             const autocompleteSnippet = {
                 uri: diff.uri,
+                identifier: RetrieverIdentifier.RecentEditsRetriever,
                 content,
             } satisfies Omit<AutocompleteContextSnippet, 'startLine' | 'endLine'>
             autocompleteContextSnippets.push(autocompleteSnippet)