Fix: Prevent autocompletion from triggering incorrectly within words #15030

eneufeld · 2025-02-25T08:27:45Z

What it does

This commit fixes an issue where autocompletion would incorrectly trigger when typing a variable character '#' in the middle of words (e.g., "Hello#").

Changes:

Removed '#' from trigger characters in the variable argument completion provider
Improved boundary detection in the variable argument picker to prevent triggering when '#' appears within words
Added better context validation to ensure completion only happens in appropriate cases
Fixed the implementation to maintain correct functionality for legitimate variable references like "#file:"
Refactored code to remove code duplication

The fix ensures that autocompletion is only triggered in intended contexts while preserving all existing functionality. Fixed #15028

How to test

In the chat Input view test different cases:

starting with ~, @ or # should trigger the autocompletion
continuing after a variable selection via #file with a : should trigger the argument selection
typing Foo~, Foo@ or Foo# should not trigger the autocompletion
typing Foo ~, Foo @ or Foo # should trigger the autocompletion

Follow-ups

Breaking changes

This PR introduces breaking changes and requires careful review. If yes, the breaking changes section in the changelog has been updated.

Attribution

Review checklist

As an author, I have thoroughly tested my changes and carefully followed the review guidelines

Reminder for reviewers

As a reviewer, I agree to behave in accordance with the review guidelines

planger

Thanks for this improvement! It indeed is a good idea to avoid triggering a code completion if the trigger character is not the beginning of the word.

However, there are a few cases that are not covered / broken now as far as I tested:

We should also skip requesting completions for provideVariableWithArgCompletions. Currently the file suggestions still show up if the user enters abc#re and then types Ctr+Space.
It looks like there are no direct argument suggestions anymore from the file provider via provideVariableWithArgCompletions after typing #. On master it worked to trigger the completion with # and then directly start typing a file name (at least after character 3-4). Note that it still works when canceling the suggestions and retrigger them manually with Ctrl+space.
The argument picker isn't triggered anymore after completing a variable with arguments, e.g. #file. On master this would insert #file: and trigger the argument picker via the quick input.

As a side note: The implementation of the completion providers in this class was always a bit brittle a. I had to fix a few bugs here lately. This was mainly because the implementation of the completion providers relied a lot on the trigger characters instead of focusing on the current text at the position. The user can trigger an autocompletion at any time manually and it should always be complete, not just if the autocompletion is triggered by the trigger character. I aimed at improving the situation a bit with #15018, but I feel that it still is somewhat brittle and inconsistent (triggered suggestions vs manual Ctrl+space). Probably because the computed range doesn't always fit with the suggestions.

planger · 2025-02-26T14:04:54Z

packages/ai-chat-ui/src/browser/chat-view-language-contribution.ts

@@ -31,6 +31,17 @@ const VARIABLE_RESOLUTION_CONTEXT = { context: 'chat-input-autocomplete' };
 const VARIABLE_ARGUMENT_PICKER_COMMAND = 'trigger-variable-argument-picker';
 const VARIABLE_ADD_CONTEXT_COMMAND = 'add-context-variable';

+// Define a consistent interface for completion sources


Suggested change

// Define a consistent interface for completion sources

Imho this comment doesn't add a lot of information

planger · 2025-02-26T14:05:02Z

packages/ai-chat-ui/src/browser/chat-view-language-contribution.ts

-        monaco.languages.registerCompletionItemProvider(CHAT_VIEW_LANGUAGE_ID, {
-            triggerCharacters: [PromptText.AGENT_CHAR],
-            provideCompletionItems: (model, position, _context, _token): ProviderResult<monaco.languages.CompletionList> => this.provideAgentCompletions(model, position),
+        // Register all completion providers


Suggested change

// Register all completion providers

Imho this comment doesn't add a lot of information

planger · 2025-02-26T14:05:10Z

packages/ai-chat-ui/src/browser/chat-view-language-contribution.ts

+    }
+
+    protected registerCompletionProviders(): void {
+        // Register standard completion providers


Suggested change

// Register standard completion providers

Imho this comment doesn't add a lot of information

planger · 2025-02-26T14:05:32Z

packages/ai-chat-ui/src/browser/chat-view-language-contribution.ts

+        // Register standard completion providers
+        this.registerStandardCompletionProvider({
+            triggerCharacter: PromptText.AGENT_CHAR,
+            getItems: () => this.agentService.getAgents(), // Use function to fetch the latest items


Suggested change

getItems: () => this.agentService.getAgents(), // Use function to fetch the latest items

getItems: () => this.agentService.getAgents(),

Imho this comment doesn't add a lot of information

planger · 2025-02-26T14:05:42Z

packages/ai-chat-ui/src/browser/chat-view-language-contribution.ts

+
+        this.registerStandardCompletionProvider({
+            triggerCharacter: PromptText.VARIABLE_CHAR,
+            getItems: () => this.variableService.getVariables(), // Use function to fetch the latest items


Suggested change

getItems: () => this.variableService.getVariables(), // Use function to fetch the latest items

getItems: () => this.variableService.getVariables(),

planger · 2025-02-26T14:05:54Z

packages/ai-chat-ui/src/browser/chat-view-language-contribution.ts

+
+        this.registerStandardCompletionProvider({
+            triggerCharacter: PromptText.FUNCTION_CHAR,
+            getItems: () => this.toolInvocationRegistry.getAllFunctions(), // Use function to fetch the latest items


Suggested change

getItems: () => this.toolInvocationRegistry.getAllFunctions(), // Use function to fetch the latest items

getItems: () => this.toolInvocationRegistry.getAllFunctions(),

planger · 2025-02-26T14:06:17Z

packages/ai-chat-ui/src/browser/chat-view-language-contribution.ts

        });
+
+        // Register the variable argument completion provider (special case)


Suggested change

// Register the variable argument completion provider (special case)

Imho this comment is rather confusing out of context

eneufeld · 2025-02-27T00:03:54Z

@planger thank you for the review and the improvement suggestions. I updated the code and the provideVariableWithArgCompletions should now also work as expected

planger

Thanks for the revision! Looks much better. The regression no 3 I mentioned in my previous comment still persists. I quickly debugged the code and marked the causing line. We need to account for the : that we add to variables with mandatory arguments.

Thank you!

planger · 2025-02-27T09:11:29Z

packages/ai-chat-ui/src/browser/chat-view-language-contribution.ts

+        const wordInfo = model.getWordUntilPosition(position);
+
+        // Only trigger if current word starts with #, followed by actual text
+        if (!wordInfo.word.startsWith(PromptText.VARIABLE_CHAR) || wordInfo.word.length <= 1) {


This prevents the regression no 3 I mentioned before. The word is actually empty, because we end with a : if the variable has mandatory arguments. So we would actually need to check if the character at the position is PromptText.VARIABLE_SEPARATOR_CHAR (see code below on line 246 etc.).

planger

Thank you, now case 3 works again. However, I'm afraid the manual auto-completion after the : is know broken. Try typing #file: and then type Ctrl-space.

This commit fixes an issue where autocompletion would incorrectly trigger when typing a variable character '#' in the middle of words (e.g., "Hello#"). Changes: - Removed '#' from trigger characters in the variable argument completion provider - Improved boundary detection in the variable argument picker to prevent triggering when '#' appears within words - Added better context validation to ensure completion only happens in appropriate cases - Fixed the implementation to maintain correct functionality for legitimate variable references like "#file:" The fix ensures that autocompletion is only triggered in intended contexts while preserving all existing functionality. Fixed eclipse-theia#15028

eneufeld · 2025-03-01T09:30:32Z

Thank you, now case 3 works again. However, I'm afraid the manual auto-completion after the : is know broken. Try typing #file: and then type Ctrl-space.

I can't reproduce your error, or I don't understand it:

So when I type #fil I can select the #file entry which completes it to #file: and then triggers the selection at the top. I can abort it using escape key and then trigger the autocompletion using ctrl+space and get the autocompletion in place again.

planger · 2025-03-01T20:23:57Z

Thank you, now case 3 works again. However, I'm afraid the manual auto-completion after the : is know broken. Try typing #file: and then type Ctrl-space.

I can't reproduce your error, or I don't understand it:

So when I type #fil I can select the #file entry which completes it to #file: and then triggers the selection at the top. I can abort it using escape key and then trigger the autocompletion using ctrl+space and get the autocompletion in place again.

Right, the behavior I'm referring to happens if you just type (no auto-completion) #file:. This should trigger a suggestion on the : which shows the possible arguments of the file variable.

On master this works but seemed to stop working in this PR. Let me know if you're having troubles to reproduce this.

eneufeld · 2025-03-03T09:34:48Z

I still can't reproduce it:

planger

I think your latest force-push actually fixed it. I tested it and now it looks like all use cases work fine.

JonasHelming requested a review from planger February 26, 2025 09:49

planger requested changes Feb 26, 2025

View reviewed changes

eneufeld force-pushed the fix/GH-15028 branch from 8770084 to 85d7165 Compare February 27, 2025 00:02

planger self-requested a review February 27, 2025 09:03

planger requested changes Feb 27, 2025

View reviewed changes

eneufeld force-pushed the fix/GH-15028 branch from 85d7165 to 97a63a5 Compare February 28, 2025 12:50

eneufeld requested a review from planger February 28, 2025 14:09

planger requested changes Feb 28, 2025

View reviewed changes

improved the different cases

7520ab5

eneufeld force-pushed the fix/GH-15028 branch from 97a63a5 to 7520ab5 Compare March 1, 2025 09:31

planger approved these changes Mar 3, 2025

View reviewed changes

eneufeld merged commit 14908a2 into eclipse-theia:master Mar 3, 2025
10 of 11 checks passed

eneufeld deleted the fix/GH-15028 branch March 3, 2025 16:38

github-actions bot added this to the 1.60.0 milestone Mar 3, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix: Prevent autocompletion from triggering incorrectly within words #15030

Fix: Prevent autocompletion from triggering incorrectly within words #15030

eneufeld commented Feb 25, 2025

planger left a comment

planger Feb 26, 2025

planger Feb 26, 2025

planger Feb 26, 2025

planger Feb 26, 2025

planger Feb 26, 2025

planger Feb 26, 2025

planger Feb 26, 2025

eneufeld commented Feb 27, 2025

planger left a comment

planger Feb 27, 2025

planger left a comment

eneufeld commented Mar 1, 2025

planger commented Mar 1, 2025

eneufeld commented Mar 3, 2025

planger left a comment

	getItems: () => this.agentService.getAgents(), // Use function to fetch the latest items
	getItems: () => this.agentService.getAgents(),

	getItems: () => this.variableService.getVariables(), // Use function to fetch the latest items
	getItems: () => this.variableService.getVariables(),

	getItems: () => this.toolInvocationRegistry.getAllFunctions(), // Use function to fetch the latest items
	getItems: () => this.toolInvocationRegistry.getAllFunctions(),

		});

		// Register the variable argument completion provider (special case)

Fix: Prevent autocompletion from triggering incorrectly within words #15030

Fix: Prevent autocompletion from triggering incorrectly within words #15030

Conversation

eneufeld commented Feb 25, 2025

What it does

How to test

Follow-ups

Breaking changes

Attribution

Review checklist

Reminder for reviewers

planger left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

eneufeld commented Feb 27, 2025

planger left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

planger left a comment

Choose a reason for hiding this comment

eneufeld commented Mar 1, 2025

planger commented Mar 1, 2025

eneufeld commented Mar 3, 2025

planger left a comment

Choose a reason for hiding this comment