fix(amazonq): Don't show inline completions when a edit is displayed #7839

floralph · 2025-08-07T18:22:17Z

Problem

Inline completion suggestions were being shown even when edit suggestions were active, creating a confusing user experience where both types of suggestions could appear simultaneously.

Solution

Added conflict prevention logic in provideInlineCompletionItems() to check for active edit suggestions using the existing aws.amazonq.editSuggestionActive context flag
Created isEditSuggestionActive() method to encapsulate context checking
Implemented DISCARD telemetry for completion suggestions that can't be shown due to active edits
Added unit tests covering the new functionality, including edge cases for mixed suggestion types and items without IDs
Updated displayImage.ts to properly set/unset the context flag when edit suggestions are displayed/cleared
The solution ensures only one type of suggestion is active at a time while maintaining telemetry compliance and following existing codebase patterns.

Treat all work as PUBLIC. Private feature/x branches will not be squash-merged at release time.
Your code changes must meet the guidelines in CONTRIBUTING.md.
License: I confirm that my contribution is made under the terms of the Apache 2.0 license.

amazon-inspector-ohio · 2025-08-07T18:22:22Z

⏳ I'm reviewing this pull request for security vulnerabilities and code quality issues. I'll provide an update when I'm done

github-actions · 2025-08-07T18:22:34Z

This pull request implements a feat or fix, so it must include a changelog entry (unless the fix is for an unreleased feature). Review the changelog guidelines.
- Note: beta or "experiment" features that have active users should announce fixes in the changelog.
- If this is not a feature or fix, use an appropriate type from the title guidelines. For example, telemetry-only changes should use the telemetry type.

amazon-inspector-ohio · 2025-08-07T18:22:53Z

✅ I finished the code review, and didn't find any security or code quality issues.

andrewyuq · 2025-08-07T18:39:59Z

packages/amazonq/src/app/inline/completion.ts

+            if (this.isEditSuggestionActive()) {
+                // Emit DISCARD telemetry for completion suggestions that can't be shown due to active edit
+                for (const item of items) {
+                    if (!item.isInlineEdit && item.itemId) {
+                        const params: LogInlineCompletionSessionResultsParams = {
+                            sessionId: session.sessionId,
+                            completionSessionResult: {
+                                [item.itemId]: {
+                                    seen: false,
+                                    accepted: false,
+                                    discarded: true,
+                                },
+                            },
+                            firstCompletionDisplayLatency: session.firstCompletionDisplayLatency,
+                            totalSessionDisplayTime: performance.now() - session.requestStartTime,
+                        }
+                        this.languageClient.sendNotification(this.logSessionResultMessageName, params)
+                    }
+                }


For UTD we only want to send 1 event for trigger (especially for completion suggestions)
all the items in this completion are discarded we can just send a list of items in completionSessionResult and only one call of this.languageClient.sendNotification(this.logSessionResultMessageName, params)

yep we only need 1 call of logSessionResult per trigger

Updated code to batch completionSessionResult and only send telemetry once.

leigaol · 2025-08-07T18:45:13Z

packages/amazonq/src/app/inline/completion.ts

+     */
+    public isCompletionActive(): boolean {
+        const session = this.sessionManager.getActiveSession()
+        return session !== undefined && session.displayed && !session.suggestions.some((item) => item.isInlineEdit)


session.displayed is a flag that indicates if a session has ever been displayed or not. There is an edge case when it is displayed but user did not reject it, instead moved cursor around or kept typing, in that case, the session.display is true but nothing is rendered on screen.

await vscode.commands.executeCommand(aws.amazonq.checkInlineSuggestionVisibility) is the real method to check if anything is rendered on screen or not because this command is defined under a context variable of VS Code and it only runs if inline suggest is visible

Fixed as suggested.

leigaol · 2025-08-07T18:48:03Z

packages/amazonq/src/app/inline/completion.ts

+     * Check if an edit suggestion is currently active
+     */
+    private isEditSuggestionActive(): boolean {
+        return getContext('aws.amazonq.editSuggestionActive') || false


getContext does not necessarily work due to vs code limitations

/**

Returns the value of a context key set via {@link setContext} wrapper for this session.

Warning: this does not guarantee the state of the context key in vscode because it may have

been set via vscode.commands.executeCommand('setContext'). It has no connection the

context keys stored in vscode itself because an API for this is not exposed.
*/
export function getContext(key: contextKey): any {
return contextMap[key]
}

Fixed - The command approach I tried had reliability issues with when clause evaluation. I ended up using a simple boolean property synchronized with setContext calls instead.

andrewyuq · 2025-08-08T11:35:34Z

packages/amazonq/src/app/inline/completion.ts

+            // Check if an edit suggestion is currently active - if so, discard completion suggestions
+            if (this.isEditSuggestionActive()) {
+                this.batchDiscardTelemetryForEditSuggestion(items, session)
+                this.sessionManager.clear()
+                logstr += `- completion suggestions discarded due to active edit suggestion`
+                return []
+            }
+


A newer edit suggestion arriving from the server. In such cases, the currently displayed edit suggestion is hidden from the user with a DISCARD state, and replaced with the newer edit suggestion.

+1,

if (isEditSuggestionActive && !isInlineEdit) { return }

the other way i think you can also do

if (!isTriggerByDeletion && !request.partialResultToken && !isEditSuggestionActive) { promise.push(completionPromise) }

here in recommendationService https://github.com/aws/aws-toolkit-vscode/blob/master/packages/amazonq/src/app/inline/recommendationService.ts#L135-L141

I think since the only scenario where 2 overlapping suggestion will happen is , correct me if i'm wrong ralph

when there is an Edit being shown

the Edit is not dismissed by users

users again start typing and trigger "Completion"

by doing this, "Completion" is not even fired and you dont even need to consider those suggestion states

Implemented Will's second solution - added !EditSuggestionState.isEditSuggestionActive() to the condition in recommendationService.ts

we can remove this

// Check if an edit suggestion is currently active - if so, discard completion suggestions if (this.isEditSuggestionActive()) { this.batchDiscardTelemetryForEditSuggestion(items, session) this.sessionManager.clear() logstr += `- completion suggestions discarded due to active edit suggestion` return [] }

ow it will preventing

A newer edit suggestion arriving from the server. In such cases, the currently displayed edit suggestion is hidden from the user with a DISCARD state, and replaced with the newer edit suggestion.

leigaol · 2025-08-08T18:51:25Z

packages/amazonq/src/app/inline/completion.ts

+            await vscode.commands.executeCommand('aws.amazonq.checkInlineSuggestionVisibility')
+            return true
+        } catch {
+            return false


have you managed to get into this catch block?

I've implemented your timestamp-based solution using performance.now() in the checkInlineSuggestionVisibility()
method and checking if it was called within the last 50ms.

Resolved conflict in displayImage.ts by keeping both completion check and patch validation logic

…ction

- Add lastVisibleTime property to CodeWhispererSession - Update checkInlineSuggestionVisibility to record timestamp - Replace try/catch with timestamp comparison in isCompletionActive - Addresses Lei's concern about catch block never executing

…check - Update tests to use lastVisibleTime property in mock sessions - Replace try/catch test logic with timestamp-based assertions - Test both recent timestamp (returns true) and old timestamp (returns false) scenarios

…ider - Remove downstream edit suggestion active check since completion requests are now prevented entirely in recommendationService when edit is active - Remove unused isEditSuggestionActive method and EditSuggestionState import - Remove obsolete tests for deleted functionality - Addresses Will's feedback about redundant code after implementing Solution 2

andrewyuq · 2025-08-09T01:33:22Z

packages/amazonq/src/app/inline/completion.ts

+        // Use VS Code command to check if inline suggestion is actually visible on screen
+        // This command only executes when inlineSuggestionVisible context is true
+        await vscode.commands.executeCommand('aws.amazonq.checkInlineSuggestionVisibility')
+        const isInlineSuggestionVisible = performance.now() - session.lastVisibleTime < 50


This workaround was provided by leigaol@ due to not being able to use getContext in VSC extensions.

…ws#7839) ## Problem Inline completion suggestions were being shown even when edit suggestions were active, creating a confusing user experience where both types of suggestions could appear simultaneously. ## Solution 1. Added conflict prevention logic in provideInlineCompletionItems() to check for active edit suggestions using the existing aws.amazonq.editSuggestionActive context flag 1. Created isEditSuggestionActive() method to encapsulate context checking 1. Implemented DISCARD telemetry for completion suggestions that can't be shown due to active edits 1. Added unit tests covering the new functionality, including edge cases for mixed suggestion types and items without IDs 1. Updated displayImage.ts to properly set/unset the context flag when edit suggestions are displayed/cleared 1. The solution ensures only one type of suggestion is active at a time while maintaining telemetry compliance and following existing codebase patterns. --- Treat all work as PUBLIC. Private feature/x branches will not be squash-merged at release time. Your code changes must meet the guidelines in [CONTRIBUTING.md](https://github.com/aws/aws-toolkit-vscode/blob/master/CONTRIBUTING.md#guidelines). License: I confirm that my contribution is made under the terms of the Apache 2.0 license.

fix(amazonq): Don't show inline completions when a edit is displayed

ac4c778

floralph requested a review from a team as a code owner August 7, 2025 18:22

andrewyuq approved these changes Aug 7, 2025

View reviewed changes

andrewyuq requested changes Aug 7, 2025

View reviewed changes

leigaol reviewed Aug 7, 2025

View reviewed changes

floralph added 3 commits August 7, 2025 23:02

fix(amazonq): batch telemetry for edits

ade8208

fix(amazonq): use command approach in isCompletionActive

fdf6178

fix(amazonq): isEditSuggestionActive to use boolean flag

c1f9a0e

floralph requested review from Will-ShaoHua, andrewyuq and leigaol August 8, 2025 07:33

Merge branch 'master' into floralph/nep-bug-fix

e4c0cbc

andrewyuq reviewed Aug 8, 2025

View reviewed changes

Will-ShaoHua previously approved these changes Aug 8, 2025

View reviewed changes

Will-ShaoHua self-requested a review August 8, 2025 17:13

leigaol reviewed Aug 8, 2025

View reviewed changes

fix(amazonq): don't call completions when edits active

aabf20f

floralph dismissed Will-ShaoHua’s stale review via aabf20f August 8, 2025 23:57

floralph added 7 commits August 8, 2025 17:01

Merge branch 'master' into floralph/nep-bug-fix

beff023

Resolved conflict in displayImage.ts by keeping both completion check and patch validation logic

refactor: extract duplicate telemetry params creation into helper fun…

f06ad9f

…ction

fix: replace forEach with for...of loop to satisfy ESLint rule

a155f08

Merge branch 'master' into floralph/nep-bug-fix

ddefe0f

floralph requested a review from andrewyuq August 9, 2025 01:09

floralph requested a review from leigaol August 9, 2025 01:10

Will-ShaoHua approved these changes Aug 9, 2025

View reviewed changes

leigaol approved these changes Aug 9, 2025

View reviewed changes

andrewyuq reviewed Aug 9, 2025

View reviewed changes

andrewyuq approved these changes Aug 9, 2025

View reviewed changes

floralph merged commit 14611c3 into master Aug 9, 2025
45 of 46 checks passed

floralph deleted the floralph/nep-bug-fix branch August 9, 2025 01:37

fix(amazonq): Don't show inline completions when a edit is displayed #7839

fix(amazonq): Don't show inline completions when a edit is displayed #7839

Uh oh!

Conversation

floralph commented Aug 7, 2025

Problem

Solution

Uh oh!

amazon-inspector-ohio bot commented Aug 7, 2025

Uh oh!

github-actions bot commented Aug 7, 2025

Uh oh!

amazon-inspector-ohio bot commented Aug 7, 2025

Uh oh!

andrewyuq Aug 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

floralph Aug 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Will-ShaoHua Aug 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

andrewyuq Aug 7, 2025 •

edited

Loading

floralph Aug 8, 2025 •

edited

Loading

Will-ShaoHua Aug 8, 2025 •

edited

Loading