fix(codewhisperer): re-enable suggestion navigation in vscode 1.78+ #3471

leigaol · web-flow · commit c8377594c5c6 · 2023-05-17T08:30:26.000-07:00
Problem:
1. Suggestion navigation is no longer working when using VS Code 1.78+
2. Users need to hit Esc twice to clear/reject a code suggestion.

Root cause:
The dispose method of a inlineCompletionProvider used to clear the inline Completion widget, which allows us to update the widget whenever we want to by doing a dispose and doing another register with a new inlineCompletionProvider. However, after VS Code 1.78+, disposing the provider no longer clears the active inline completion widget, which is a regression because disposing a object should clear the states it created.


Solution:
Manually refresh the suggestion ghost text after each dispose of `inlineCompletionProvider` only for VS Code 1.78+.
diff --git a/.changes/next-release/Bug Fix-65050370-fd7c-49e6-86ba-00766572400c.json b/.changes/next-release/Bug Fix-65050370-fd7c-49e6-86ba-00766572400c.json
@@ -0,0 +1,4 @@
+{
+	"type": "Bug Fix",
+	"description": "CodeWhisperer: cannot navigate to next or previous code suggestion in VS Code 1.78+"
+}
diff --git a/package.json b/package.json
@@ -3175,7 +3175,7 @@
                 "command": "aws.codeWhisperer.rejectCodeSuggestion",
                 "key": "escape",
                 "mac": "escape",
-                "when": "editorTextFocus && CODEWHISPERER_SERVICE_ACTIVE"
+                "when": "inlineSuggestionVisible && !editorReadonly && CODEWHISPERER_ENABLED"
             },
             {
                 "command": "aws.codeWhisperer.rejectCodeSuggestion",
diff --git a/src/codewhisperer/models/constants.ts b/src/codewhisperer/models/constants.ts
@@ -97,7 +97,7 @@ export const supportedLanguages = [
     'sql',
 ] as const
 
-export type SupportedLanguage = typeof supportedLanguages[number]
+export type SupportedLanguage = (typeof supportedLanguages)[number]
 
 /**
  * Prompt
@@ -282,3 +282,5 @@ export const stopScanMessage =
 export const showScannedFilesMessage = 'Show Scanned Files'
 
 export const isClassifierEnabledKey = 'CODEWHISPERER_CLASSIFIER_TRIGGER_ENABLED'
+
+export const updateInlineLockKey = 'CODEWHISPERER_INLINE_UPDATE_LOCK_KEY'
diff --git a/src/codewhisperer/service/inlineCompletionService.ts b/src/codewhisperer/service/inlineCompletionService.ts
@@ -18,13 +18,16 @@ import { getLogger } from '../../shared/logger/logger'
 import { TelemetryHelper } from '../util/telemetryHelper'
 import { runtimeLanguageContext } from '../util/runtimeLanguageContext'
 import { Commands } from '../../shared/vscode/commands2'
-import { getPrefixSuffixOverlap } from '../util/commonUtil'
+import { getPrefixSuffixOverlap, isVscHavingRegressionInlineCompletionApi } from '../util/commonUtil'
 import globals from '../../shared/extensionGlobals'
 import { AuthUtil } from '../util/authUtil'
 import { shared } from '../../shared/utilities/functionUtils'
 import { ImportAdderProvider } from './importAdderProvider'
+import * as AsyncLock from 'async-lock'
+import { updateInlineLockKey } from '../models/constants'
 
 const performance = globalThis.performance ?? require('perf_hooks').performance
+const lock = new AsyncLock({ maxPending: 1 })
 
 export class CWInlineCompletionItemProvider implements vscode.InlineCompletionItemProvider {
     private activeItemIndex: number | undefined
@@ -219,8 +222,8 @@ const nextCommand = Commands.declare(
     }
 )
 
-const hideCommand = Commands.declare(
-    'editor.action.inlineSuggest.hide',
+const rejectCommand = Commands.declare(
+    'aws.codeWhisperer.rejectCodeSuggestion',
     (service: InlineCompletionService) => async () => {
         await service.clearInlineCompletionStates(vscode.window.activeTextEditor)
     }
@@ -234,15 +237,15 @@ export class InlineCompletionService {
     private _timer?: NodeJS.Timer
     private _showRecommendationTimer?: NodeJS.Timer
     private documentUri: vscode.Uri | undefined = undefined
-    private hide: vscode.Disposable
+    private reject: vscode.Disposable
     private next: vscode.Disposable
     private prev: vscode.Disposable
     private _isPaginationRunning = false
 
     constructor() {
         this.prev = prevCommand.register(this)
         this.next = nextCommand.register(this)
-        this.hide = hideCommand.register(this)
+        this.reject = rejectCommand.register(this)
         RecommendationHandler.instance.onDidReceiveRecommendation(e => {
             this.startShowRecommendationTimer()
         })
@@ -287,20 +290,20 @@ export class InlineCompletionService {
     private registerCommandOverrides() {
         this.prev = prevCommand.register(this)
         this.next = nextCommand.register(this)
-        this.hide = hideCommand.register(this)
+        this.reject = rejectCommand.register(this)
     }
 
     subscribeSuggestionCommands() {
         this.disposeCommandOverrides()
         this.registerCommandOverrides()
         globals.context.subscriptions.push(this.prev)
         globals.context.subscriptions.push(this.next)
-        globals.context.subscriptions.push(this.hide)
+        globals.context.subscriptions.push(this.reject)
     }
 
     private disposeCommandOverrides() {
         this.prev.dispose()
-        this.hide.dispose()
+        this.reject.dispose()
         this.next.dispose()
     }
 
@@ -347,6 +350,11 @@ export class InlineCompletionService {
             this.disposeInlineCompletion()
             vscode.commands.executeCommand('aws.codeWhisperer.refreshStatusBar')
             this.disposeCommandOverrides()
+            // fix a regression that requires user to hit Esc twice to clear inline ghost text
+            // because disposing a provider does not clear the UX
+            if (isVscHavingRegressionInlineCompletionApi()) {
+                await vscode.commands.executeCommand('editor.action.inlineSuggest.hide')
+            }
         } finally {
             this.clearRejectionTimer()
         }
@@ -360,7 +368,7 @@ export class InlineCompletionService {
         if (this.isSuggestionVisible()) {
             // to force refresh the visual cue so that the total recommendation count can be updated
             const index = this.inlineCompletionProvider?.getActiveItemIndex
-            await this.showRecommendation(index ? index : 0, true)
+            await this.showRecommendation(index ? index : 0, false)
             return
         }
         if (
@@ -440,34 +448,49 @@ export class InlineCompletionService {
         TelemetryHelper.instance.tryRecordClientComponentLatency(editor.document.languageId)
     }
 
-    async showRecommendation(indexShift: number, isFirstRecommendation: boolean = false) {
-        this.inlineCompletionProvider = new CWInlineCompletionItemProvider(
-            this.inlineCompletionProvider?.getActiveItemIndex,
-            indexShift
-        )
-        this.inlineCompletionProviderDisposable?.dispose()
-        // when suggestion is active, registering a new provider will let VS Code invoke inline API automatically
-        this.inlineCompletionProviderDisposable = vscode.languages.registerInlineCompletionItemProvider(
-            Object.assign([], CodeWhispererConstants.supportedLanguages),
-            this.inlineCompletionProvider
-        )
-        if (isFirstRecommendation) {
-            await vscode.commands.executeCommand(`editor.action.inlineSuggest.trigger`)
-            if (vscode.window.activeTextEditor) {
-                const languageContext = runtimeLanguageContext.getLanguageContext(
-                    vscode.window.activeTextEditor.document.languageId
-                )
-                telemetry.codewhisperer_perceivedLatency.emit({
-                    codewhispererRequestId: RecommendationHandler.instance.requestId,
-                    codewhispererSessionId: RecommendationHandler.instance.sessionId,
-                    codewhispererTriggerType: TelemetryHelper.instance.triggerType,
-                    codewhispererCompletionType: TelemetryHelper.instance.completionType,
-                    codewhispererLanguage: languageContext.language,
-                    duration: performance.now() - RecommendationHandler.instance.lastInvocationTime,
-                    passive: true,
-                    credentialStartUrl: TelemetryHelper.instance.startUrl,
-                })
+    async showRecommendation(indexShift: number, noSuggestionVisible: boolean = false) {
+        await lock.acquire(updateInlineLockKey, async () => {
+            const inlineCompletionProvider = new CWInlineCompletionItemProvider(
+                this.inlineCompletionProvider?.getActiveItemIndex,
+                indexShift
+            )
+            this.inlineCompletionProviderDisposable?.dispose()
+            // when suggestion is active, registering a new provider will let VS Code invoke inline API automatically
+            this.inlineCompletionProviderDisposable = vscode.languages.registerInlineCompletionItemProvider(
+                Object.assign([], CodeWhispererConstants.supportedLanguages),
+                inlineCompletionProvider
+            )
+            this.inlineCompletionProvider = inlineCompletionProvider
+
+            if (isVscHavingRegressionInlineCompletionApi() && !noSuggestionVisible) {
+                // fix a regression in new VS Code when disposing and re-registering
+                // a new provider does not auto refresh the inline suggestion widget
+                // by manually refresh it
+                await vscode.commands.executeCommand('editor.action.inlineSuggest.hide')
+                await vscode.commands.executeCommand('editor.action.inlineSuggest.trigger')
+            }
+            if (noSuggestionVisible) {
+                await vscode.commands.executeCommand(`editor.action.inlineSuggest.trigger`)
+                this.sendPerceivedLatencyTelemetry()
             }
+        })
+    }
+
+    private sendPerceivedLatencyTelemetry() {
+        if (vscode.window.activeTextEditor) {
+            const languageContext = runtimeLanguageContext.getLanguageContext(
+                vscode.window.activeTextEditor.document.languageId
+            )
+            telemetry.codewhisperer_perceivedLatency.emit({
+                codewhispererRequestId: RecommendationHandler.instance.requestId,
+                codewhispererSessionId: RecommendationHandler.instance.sessionId,
+                codewhispererTriggerType: TelemetryHelper.instance.triggerType,
+                codewhispererCompletionType: TelemetryHelper.instance.completionType,
+                codewhispererLanguage: languageContext.language,
+                duration: performance.now() - RecommendationHandler.instance.lastInvocationTime,
+                passive: true,
+                credentialStartUrl: TelemetryHelper.instance.startUrl,
+            })
         }
     }
 
diff --git a/src/codewhisperer/util/commonUtil.ts b/src/codewhisperer/util/commonUtil.ts
@@ -28,6 +28,11 @@ export function isInlineCompletionEnabled() {
     return semver.gte(vscode.version, '1.68.0') && getInlineSuggestEnabled() && !isCloud9()
 }
 
+// This is the VS Code version that started to have regressions in inline completion API
+export function isVscHavingRegressionInlineCompletionApi() {
+    return semver.gte(vscode.version, '1.78.0') && getInlineSuggestEnabled() && !isCloud9()
+}
+
 export function getFileExt(languageId: string) {
     switch (languageId) {
         case 'java':

-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +{
 +	"type": "Bug Fix",
 +	"description": "CodeWhisperer: cannot navigate to next or previous code suggestion in VS Code 1.78+"
 +}
Original file line number	Diff line number	Diff line change
`@@ -3175,7 +3175,7 @@`
`3175`	`3175`	`"command": "aws.codeWhisperer.rejectCodeSuggestion",`
`3176`	`3176`	`"key": "escape",`
`3177`	`3177`	`"mac": "escape",`
`3178`		`- "when": "editorTextFocus && CODEWHISPERER_SERVICE_ACTIVE"`
	`3178`	`+ "when": "inlineSuggestionVisible && !editorReadonly && CODEWHISPERER_ENABLED"`
`3179`	`3179`	`},`
`3180`	`3180`	`{`
`3181`	`3181`	`"command": "aws.codeWhisperer.rejectCodeSuggestion",`