feat(amazonq): enable pinned context and rules management #5845

avi-alpert · 2025-06-20T15:59:24Z

Types of changes

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)

Description

This PR enables the pinned context feature in Amazon Q chat. Equivalent vs code PR: aws/aws-toolkit-vscode#7493

Key Changes

1. Override selectionChanged in TextDocumentServiceHandler.kt

• Sends ACTIVE_EDITOR_CHANGED_NOTIFICATION notification to server when file editor selection changes
• Purpose: When server receives ACTIVE_EDITOR_CHANGED_NOTIFICATION, it sends a sendPinnedContext message back to the client so the "Active file" pinned context item shows the path of the active file

2. New Message Types and Commands

Pinned Context Support:
• CHAT_PINNED_CONTEXT_ADD - Sent to server when user adds item to pinned context
• CHAT_PINNED_CONTEXT_REMOVE - Sent to server when user remove item from pinned context
• CHAT_SEND_PINNED_CONTEXT - Sent to client with list of pinned context items & current active file info
• ACTIVE_EDITOR_CHANGED_NOTIFICATION - Notify server when active file changes

Rules Management:
• LIST_RULES_REQUEST_METHOD - Sent to server to retrieve available workspace rules
• RULE_CLICK_REQUEST_METHOD - Sent to server to handle workspace rule opt in/opt out

3. Client Capabilities Enhancement

• Updated ExtendedClientMetadata to include pinnedContextEnabled: true capability. This is the feature flag that enables the pinned context feature to be displayed in client.
• Enhanced CreatePromptParams to support rule creation with isRule parameter. This enables rule creation with the existing CreatePrompt message
• Updated addTab in quick actions handler to clear promptTopBarTitle. This prevents pinned context tab from staying visible when user clicks /dev, /doc, etc

4. Dependency Updates

• Updated @aws/mynah-ui from 4.30.3 to 4.35.5
• Updated @aws/chat-client from 0.1.4 to 0.1.18

Checklist

My code follows the code style of this project
I have added tests to cover my changes
A short description of the change has been added to the CHANGELOG if the change is customer-facing in the IDE.
I have added metrics for my changes (if required)

License

I confirm that my contribution is made under the terms of the Apache 2.0 license.

...ains-community/src/software/aws/toolkits/jetbrains/services/amazonq/lsp/AmazonQChatServer.kt

...rc/software/aws/toolkits/jetbrains/services/amazonq/lsp/editor/ActiveEditorChangeListener.kt

manodnyab · 2025-06-20T18:58:19Z

...munity/src/software/aws/toolkits/jetbrains/services/amazonq/lsp/AmazonQLanguageClientImpl.kt

+        val chatManager = ChatCommunicationManager.getInstance(project)
+
+        // Get the active text editor and create text document identifier
+        val editor = FileEditorManager.getInstance(project).selectedTextEditor


Would recommend creating utils for this since the same util is being used while sending chat prompts in LspEditorUtils

this behaves differently from when we send chat prompt, since here we want to send the relative path to the active file. the only common call is FileEditorManager.getInstance(project).selectedTextEditor

we will eventually need to ban selectedTextEditor but that can be done later

manodnyab · 2025-06-20T19:01:12Z

...munity/src/software/aws/toolkits/jetbrains/services/amazonq/lsp/AmazonQLanguageClientImpl.kt

+        // Get the active text editor and create text document identifier
+        val editor = FileEditorManager.getInstance(project).selectedTextEditor
+        val textDocument = editor?.let {
+            TextDocumentIdentifier(it.virtualFile.path)


We are sending the URI in chat prompt, maybe we can follow the same implementation here, re: the comment above

manodnyab · 2025-06-20T19:06:32Z

...ains-community/src/software/aws/toolkits/jetbrains/services/amazonq/lsp/AmazonQLspService.kt

                }
+
+                // Register active editor change listener
+                val executor = java.util.concurrent.Executors.newSingleThreadScheduledExecutor { r ->


Can this be handled as part of TextDocumentServiceHandler?

Oh great! Im gonna try getting rid of the new ActiveEditorChangeListener.kt I added and just adding an override in TextDocumentServiceHandler

manodnyab · 2025-06-20T19:07:15Z

...rc/software/aws/toolkits/jetbrains/services/amazonq/lsp/editor/ActiveEditorChangeListener.kt

+
+    private fun handleActiveEditorChange(file: VirtualFile?, editor: Editor?) {
+        // Cancel any pending notification
+        debounceTask?.cancel(false)


Curious, does this handle the case when multiple windows are opened for the same project?

Looks like its only invoked for files in the primary window. but not worried about it

https://youtrack.jetbrains.com/issue/IJPL-26901/FileEditorManagerListener-fails-to-send-selectionChanged-for-files-opened-in-second-window?_gl=1*13thc5k*_gcl_au*ODM2Nzc5OTcxLjE3NDYwNDk4Njk.*FPAU*ODM2Nzc5OTcxLjE3NDYwNDk4Njk.*_ga*MTY4ODY0OTQzMC4xNzIxODM3ODg5*_ga_9J976DJZ68*czE3NTA0NTQ2NDEkbzI0JGcwJHQxNzUwNDU0NjQxJGo2MCRsMCRoMA..

...munity/src/software/aws/toolkits/jetbrains/services/amazonq/lsp/AmazonQLanguageClientImpl.kt

plugins/amazonq/mynah-ui/package.json

rli · 2025-06-23T20:02:46Z

...munity/src/software/aws/toolkits/jetbrains/services/amazonq/lsp/AmazonQLanguageClientImpl.kt

 * Concrete implementation of [AmazonQLanguageClient] to handle messages sent from server
 */
 class AmazonQLanguageClientImpl(private val project: Project) : AmazonQLanguageClient {
+    private val chatManager = ChatCommunicationManager.getInstance(project)


services should be lazy init

Suggested change

private val chatManager = ChatCommunicationManager.getInstance(project)

private val chatManager

get() = ChatCommunicationManager.getInstance(project)

rli · 2025-06-23T20:03:30Z

...munity/src/software/aws/toolkits/jetbrains/services/amazonq/lsp/AmazonQLanguageClientImpl.kt

+                mutableParams["textDocument"] = textDocument
+                mutableParams
+            }
+            else -> mapOf(


will it ever hit this case or is it always a map?

rli · 2025-06-23T20:06:24Z

...ty/tst/software/aws/toolkits/jetbrains/services/amazonq/lsp/AmazonQLanguageClientImplTest.kt

+    private val mockChatManager = mockk<ChatCommunicationManager>(relaxed = true)
+    private val sut: AmazonQLanguageClientImpl
+
+    init {


is this still needed with the proposed getter change? prefer ProjectExtension/replaceService over mocking projects and getService() calls

rli · 2025-06-23T21:01:19Z

...-community/src/software/aws/toolkits/jetbrains/services/amazonq/lsp/AmazonQLanguageClient.kt

+    @JsonNotification(CHAT_SEND_PINNED_CONTEXT)
+    fun sendPinnedContext(params: LSPAny): CompletableFuture<Unit>
+
+    @JsonNotification(CHAT_PINNED_CONTEXT_ADD)
+    fun pinnedContextAdd(params: LSPAny): CompletableFuture<Unit>
+
+    @JsonNotification(CHAT_PINNED_CONTEXT_REMOVE)
+    fun pinnedContextRemove(params: LSPAny): CompletableFuture<Unit>


Suggested change

@JsonNotification(CHAT_SEND_PINNED_CONTEXT)

fun sendPinnedContext(params: LSPAny): CompletableFuture<Unit>

@JsonNotification(CHAT_PINNED_CONTEXT_ADD)

fun pinnedContextAdd(params: LSPAny): CompletableFuture<Unit>

@JsonNotification(CHAT_PINNED_CONTEXT_REMOVE)

fun pinnedContextRemove(params: LSPAny): CompletableFuture<Unit>

@JsonNotification(CHAT_SEND_PINNED_CONTEXT)

fun sendPinnedContext(params: LSPAny)

@JsonNotification(CHAT_PINNED_CONTEXT_ADD)

fun pinnedContextAdd(params: LSPAny)

@JsonNotification(CHAT_PINNED_CONTEXT_REMOVE)

fun pinnedContextRemove(params: LSPAny)

avi-alpert force-pushed the aalpert/pinned-context branch from ef1abbd to d738646 Compare June 20, 2025 15:59

github-advanced-security bot found potential problems Jun 20, 2025

View reviewed changes

avi-alpert marked this pull request as ready for review June 20, 2025 17:45

avi-alpert requested review from a team as code owners June 20, 2025 17:45

manodnyab reviewed Jun 20, 2025

View reviewed changes

avi-alpert requested a review from manodnyab June 20, 2025 21:18

manodnyab reviewed Jun 21, 2025

View reviewed changes

...munity/src/software/aws/toolkits/jetbrains/services/amazonq/lsp/AmazonQLanguageClientImpl.kt Outdated Show resolved Hide resolved

avi-alpert requested a review from manodnyab June 22, 2025 18:52

samgst-amazon reviewed Jun 23, 2025

View reviewed changes

plugins/amazonq/mynah-ui/package.json Show resolved Hide resolved

manodnyab approved these changes Jun 23, 2025

View reviewed changes

rli reviewed Jun 23, 2025

View reviewed changes

avi-alpert added 9 commits June 23, 2025 19:50

feat(amazonq): enable pinned context and rules management

f3ef8a9

deps(amazonq): update @aws/chat-client

8bfd8b6

fix: address code scanning comments

f4fbd17

fix: remove unused imports

d278cd6

fix: remove ActiveEditorChangeListener

31bc9ad

fix: failing detekt test

33e4c6c

fix: reuse ChatCommunicationManager instance

69bbdce

fix: failing unit test and detekt failure

2c5762a

fix: respond to PR comments

7eb55a4

avi-alpert force-pushed the aalpert/pinned-context branch from 9fd6d13 to 7eb55a4 Compare June 23, 2025 23:51

rli approved these changes Jun 24, 2025

View reviewed changes

jngyuamz approved these changes Jun 24, 2025

View reviewed changes

rli merged commit d6fdf6a into aws:main Jun 24, 2025
10 of 12 checks passed

	private val chatManager = ChatCommunicationManager.getInstance(project)
	private val chatManager
	get() = ChatCommunicationManager.getInstance(project)

feat(amazonq): enable pinned context and rules management #5845

feat(amazonq): enable pinned context and rules management #5845

Uh oh!

Conversation

avi-alpert commented Jun 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Types of changes

Description

Key Changes

1. Override selectionChanged in TextDocumentServiceHandler.kt

2. New Message Types and Commands

3. Client Capabilities Enhancement

4. Dependency Updates

Checklist

License

Uh oh!

Uh oh!

Uh oh!

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!

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!

5 participants

avi-alpert commented Jun 20, 2025 •

edited

Loading