fix(codewhisperer): closing symbol handling during typeahead #4257

Problem
Closing symbol is not handled correctly when there is typeahead because the recommendation passed in as the argument is "original" which doesn't factor in typeahead.

Solution
Pass in another range marker, effectiveRange which denotes the effective recommendation written by CodeWhisperer.

Author: Will-ShaoHua

.changes/next-release/Bug Fix-55510462-3473-4c65-a3f8-52f6a79e4a26.json

@@ -0,0 +1,4 @@
+{
+	"type": "Bug Fix",
+	"description": "CodeWhisperer not handling extra closing symbols (parenthesis, brackets, quotes) when user typeahead exists"
+}

src/codewhisperer/commands/onAcceptance.ts

@@ -39,7 +39,7 @@ export async function onAcceptance(acceptanceEntry: OnRecommendationAcceptanceEn
          * Mitigation to right context handling mainly for auto closing bracket use case
          */
         try {
-            await handleExtraBrackets(acceptanceEntry.editor, acceptanceEntry.recommendation, end, start)
+            await handleExtraBrackets(acceptanceEntry.editor, end, start)
         } catch (error) {
             getLogger().error(`${error} in handleAutoClosingBrackets`)
         }

src/codewhisperer/commands/onInlineAcceptance.ts

@@ -34,6 +34,7 @@ export const acceptSuggestion = Commands.declare(
     (context: ExtContext) =>
         async (
             range: vscode.Range,
+            effectiveRange: vscode.Range,
             acceptIndex: number,
             recommendation: string,
             requestId: string,
@@ -49,6 +50,7 @@ export const acceptSuggestion = Commands.declare(
                 {
                     editor,
                     range,
+                    effectiveRange,
                     acceptIndex,
                     recommendation,
                     requestId,
@@ -88,7 +90,7 @@ export async function onInlineAcceptance(
         try {
             // Do not handle extra bracket if there is a right context merge
             if (acceptanceEntry.recommendation === session.recommendations[acceptanceEntry.acceptIndex].content) {
-                await handleExtraBrackets(acceptanceEntry.editor, acceptanceEntry.recommendation, end, start)
+                await handleExtraBrackets(acceptanceEntry.editor, end, acceptanceEntry.effectiveRange.start)
             }
             await ImportAdderProvider.instance.onAcceptRecommendation(
                 acceptanceEntry.editor,

src/codewhisperer/models/model.ts

@@ -122,6 +122,7 @@ export interface AcceptedSuggestionEntry {
 export interface OnRecommendationAcceptanceEntry {
     readonly editor: vscode.TextEditor | undefined
     readonly range: vscode.Range
+    readonly effectiveRange: vscode.Range
     readonly acceptIndex: number
     readonly recommendation: string
     readonly requestId: string

src/codewhisperer/service/inlineCompletionItemProvider.ts

@@ -96,6 +96,7 @@ export class CWInlineCompletionItemProvider implements vscode.InlineCompletionIt
         if (!r.content.startsWith(prefix)) {
             return undefined
         }
+        const effectiveStart = document.positionAt(document.offsetAt(start) + prefix.length)
         const truncatedSuggestion = this.truncateOverlapWithRightContext(document, r.content, end)
         if (truncatedSuggestion.length === 0) {
             if (session.getSuggestionState(index) !== 'Showed') {
@@ -111,6 +112,7 @@ export class CWInlineCompletionItemProvider implements vscode.InlineCompletionIt
                 title: 'On acceptance',
                 arguments: [
                     new vscode.Range(start, end),
+                    new vscode.Range(effectiveStart, end),
                     index,
                     truncatedSuggestion,
                     this.requestId,

src/codewhisperer/util/closingBracketUtil.ts

@@ -30,15 +30,26 @@ const openToClose: bracketMapType = {
 }
 
 /**
- * @param endPosition: end position of the recommendation
- * @param startPosition: start position of the recommendation
+ * LeftContext | Recommendation | RightContext
+ * This function aims to resolve symbols which are redundant and need to be removed
+ * The high level logic is as followed
+ *   1. Pair non-paired closing symbols(parenthesis, brackets, quotes) existing in the "recommendation" with non-paired symbols existing in the "leftContext"
+ *   2. Remove non-paired closing symbols existing in the "rightContext"
+ * @param endPosition: end position of the effective recommendation written by CodeWhisperer
+ * @param startPosition: start position of the effective recommendation by CodeWhisperer
+ *
+ * for example given file context ('|' is where we trigger the service):
+ * anArray.pu|
+ * recommendation returned: "sh(element);"
+ * typeahead: "sh("
+ * the effective recommendation written by CodeWhisperer: "element);"
  */
 export async function handleExtraBrackets(
     editor: vscode.TextEditor,
-    recommendation: string,
     endPosition: vscode.Position,
     startPosition: vscode.Position
 ) {
+    const recommendation = editor.document.getText(new vscode.Range(startPosition, endPosition))
     const endOffset = editor.document.offsetAt(endPosition)
     const startOffset = editor.document.offsetAt(startPosition)
     const leftContext = editor.document.getText(

src/test/codewhisperer/commands/onAcceptance.test.ts

@@ -51,6 +51,7 @@ describe('onAcceptance', function () {
                 {
                     editor: mockEditor,
                     range: new vscode.Range(new vscode.Position(1, 0), new vscode.Position(1, 26)),
+                    effectiveRange: new vscode.Range(new vscode.Position(1, 0), new vscode.Position(1, 26)),
                     acceptIndex: 0,
                     recommendation: "print('Hello World!')",
                     requestId: '',
@@ -99,6 +100,7 @@ describe('onAcceptance', function () {
                 {
                     editor: mockEditor,
                     range: new vscode.Range(new vscode.Position(1, 0), new vscode.Position(1, 21)),
+                    effectiveRange: new vscode.Range(new vscode.Position(1, 0), new vscode.Position(1, 26)),
                     acceptIndex: 0,
                     recommendation: "print('Hello World!')",
                     requestId: '',

src/test/codewhisperer/commands/onInlineAcceptance.test.ts

@@ -38,6 +38,7 @@ describe('onInlineAcceptance', function () {
                 {
                     editor: mockEditor,
                     range: new vscode.Range(new vscode.Position(1, 0), new vscode.Position(1, 21)),
+                    effectiveRange: new vscode.Range(new vscode.Position(1, 0), new vscode.Position(1, 21)),
                     acceptIndex: 0,
                     recommendation: "print('Hello World!')",
                     requestId: '',
@@ -77,6 +78,7 @@ describe('onInlineAcceptance', function () {
                 {
                     editor: mockEditor,
                     range: new vscode.Range(new vscode.Position(1, 0), new vscode.Position(1, 21)),
+                    effectiveRange: new vscode.Range(new vscode.Position(1, 0), new vscode.Position(1, 21)),
                     acceptIndex: 0,
                     recommendation: "print('Hello World!')",
                     requestId: '',

src/test/codewhisperer/util/closingBracketUtil.test.ts

@@ -36,7 +36,7 @@ describe('closingBracketUtil', function () {
             assert.strictEqual(right, rightContext)
             assert.strictEqual(reco, recommendation)
 
-            await handleExtraBrackets(editor, recommendation, end, start)
+            await handleExtraBrackets(editor, end, start)
 
             assert.strictEqual(editor.document.getText(), expected)
         }