Introduce ViewRouter Component by taldekar · Pull Request #337 · aws/amazon-q-eclipse

taldekar · 2025-01-28T19:36:14Z

Issue #335

Description of changes:
Introduced a ViewRouter component to determine which view to display based on an order of resolution logic.

Open Questions:

Checks to determine browser compatibility and UI asset availability needs to be implemented, but which components should be responsible for this requires some more thought.

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

* Add functionality for hot subscribers that track latest event * Add test to ensure event stream isolation * Fix missing subscription disposal in test * Use autoConnect to implicitly manage stream connection

shruti0085 · 2025-01-30T21:31:02Z

+    @ParameterizedTest
+    @MethodSource("provideStateSource")
+    void testActiveViewResolutionBasedOnPluginState(final LspState lspState, final AuthState authState,
+            final ViewId activeViewId) {


can this be renamed to "expectedActiveViewId"?
Is there a way to do an assertion on what is expected and what is the actual active view ?

I'll update the name. Changing this to an assertion is possible using ArgumentCaptors like so. Should I transition to this approach. I've verified that verify calls on the mock fail if the ViewIds are not what is expected. The ViewRouter doesn't really expose any methods to retrieve the activeView, so assertions are a bit difficult.

shruti0085 · 2025-01-30T21:31:37Z

+        RxJavaPlugins.setComputationSchedulerHandler(scheduler -> Schedulers.trampoline());
+
+        publishSubject = PublishSubject.create();
+        authStateObservable = publishSubject.ofType(AuthState.class);


Do any of the observables need disposal?

I don't believe so, but I'll verify this.

Observables do not need to be disposed. But on a related note I did add functionality to track any subscriptions in the event broker and added a method that can be used to dispose off them.

What would be a example of a use case where we would want to dispose off a subscription?
By disposing observable I was talking about the situation when we want to stop listening for a certain event. By disposing off a subscription I am unclear what exactly that does?

Disposing off the subscription basically cancels it. So we stop listening to events. Observables are the stream of data, and those don't need to be disposed. For the ViewContainer component, before the check to see if the parent composite is disposed, if we didn't dispose the listener then it would try to call update child view when the parent composite was disposed and error out. Cases like these it would make sense to dispose of the listener.

shruti0085 · 2025-01-31T18:33:52Z

+        RxJavaPlugins.setComputationSchedulerHandler(scheduler -> Schedulers.trampoline());
+
+        publishSubject = PublishSubject.create();
+        authStateObservable = publishSubject.ofType(AuthState.class);


What would be a example of a use case where we would want to dispose off a subscription?
By disposing observable I was talking about the situation when we want to stop listening for a certain event. By disposing off a subscription I am unclear what exactly that does?

…st state (#342)

This reverts commit 374e549.

This reverts commit 13c55ac.

* improved handling of lsp failure state * add static mock to lsp connection test case * Integrate Event Broker in LspStatusManager * Add ViewRouter POC * Fix code formatting bug * Add method to retrieve observables * Add listeners for combined state streams and view update request * Add listeners for combined state streams and view update request * Add listeners for combined state streams and view update request * Add functionality for hot event streams that track latest event (#340) * Add functionality for hot subscribers that track latest event * Add test to ensure event stream isolation * Fix missing subscription disposal in test * Use autoConnect to implicitly manage stream connection * Remove active view update request listener * Add ViewRouter tests * Remove public constructor * Remove public constructor and unused event in tests * Add comments * Add documentation for EventBroker * Remove ViewRouter initialization * Remove LspInitializingView from ID enum * Add documentation for ViewRouter * Refactor and enhance EventBroker tests * Refactor ViewRouter tests for clarity * Remove PluginState class into separate file * Add documentation to subscription management logic * Add support for notifying multiple late-subscribers over time of latest state (#342) * Remove CODE_REFERENCE_VIEW * Rename newActiveViewId to newActiveView * Rename ViewId class to AmazonQViewType * Revert "Integrate Event Broker in LspStatusManager" This reverts commit 374e549. * Revert "improved handling of lsp failure state" This reverts commit 13c55ac. * Refactor EventBroker and enhance tests (#343) --------- Co-authored-by: Nicolas Borges <nickdb@amazon.com>

…382) * improved handling of lsp failure state (#309) * Introduce ViewRouter Component (#337) * improved handling of lsp failure state * add static mock to lsp connection test case * Integrate Event Broker in LspStatusManager * Add ViewRouter POC * Fix code formatting bug * Add method to retrieve observables * Add listeners for combined state streams and view update request * Add listeners for combined state streams and view update request * Add listeners for combined state streams and view update request * Add functionality for hot event streams that track latest event (#340) * Add functionality for hot subscribers that track latest event * Add test to ensure event stream isolation * Fix missing subscription disposal in test * Use autoConnect to implicitly manage stream connection * Remove active view update request listener * Add ViewRouter tests * Remove public constructor * Remove public constructor and unused event in tests * Add comments * Add documentation for EventBroker * Remove ViewRouter initialization * Remove LspInitializingView from ID enum * Add documentation for ViewRouter * Refactor and enhance EventBroker tests * Refactor ViewRouter tests for clarity * Remove PluginState class into separate file * Add documentation to subscription management logic * Add support for notifying multiple late-subscribers over time of latest state (#342) * Remove CODE_REFERENCE_VIEW * Rename newActiveViewId to newActiveView * Rename ViewId class to AmazonQViewType * Revert "Integrate Event Broker in LspStatusManager" This reverts commit 374e549. * Revert "improved handling of lsp failure state" This reverts commit 13c55ac. * Refactor EventBroker and enhance tests (#343) --------- Co-authored-by: Nicolas Borges <nickdb@amazon.com> * Introduce View Container and base view components (#338) * Add Browser Provider component (#357) * Pass populated AWS_CA_BUNDLE env var to Flare (#341) * Add UI notification to alert user of deprecated manifest version (#312) * Add webview dependency missing logic to ViewRouter * Revert commit 'Add UI notification to alert user of deprecated manifest version' * Revert 'Pass populated AWS_CA_BUNDLE env var to Flare' --------- Co-authored-by: Jonathan Breedlove <breedloj@amazon.com> Co-authored-by: Nicolas <nborges.aws@gmail.com> * Add Webview Asset Providers (#358) * Pass populated AWS_CA_BUNDLE env var to Flare (#341) * Add UI notification to alert user of deprecated manifest version (#312) * Add webview dependency missing logic to ViewRouter * Revert commit 'Add UI notification to alert user of deprecated manifest version' * Revert 'Pass populated AWS_CA_BUNDLE env var to Flare' * Rebase changes from Browser Provider PR * Fix ViewRouter --------- Co-authored-by: Jonathan Breedlove <breedloj@amazon.com> Co-authored-by: Nicolas <nborges.aws@gmail.com> * Integrate browser based views in ViewContainer (#359) * Pass populated AWS_CA_BUNDLE env var to Flare (#341) * Add UI notification to alert user of deprecated manifest version (#312) * Revert commit 'Add UI notification to alert user of deprecated manifest version' * Revert 'Pass populated AWS_CA_BUNDLE env var to Flare' * Rebase changes from Browser Provider PR * Fix ViewRouter * Integrate browser based views in ViewContainer * Fix checkstyle issues * Fix AmazonQBrowserProvider tests * Fix bug due to display sync exec call * Add semaphore locking to container to prevent race conditions * Add browser focus handling * Add state checking methods to LspState * Clean up code * Remove unnecessary parent assignment from chat webview * Refactor ViewVisibilityManager to default to one view * Add accidentally removed telemetry emissions * Update plugin descriptor (#360) * Move semaphore locking/unlocking to try/finally block --------- Co-authored-by: Jonathan Breedlove <breedloj@amazon.com> Co-authored-by: Nicolas <nborges.aws@gmail.com> * Separate Chat and Toolkit Login web view asset state event stream (#361) * Pass populated AWS_CA_BUNDLE env var to Flare (#341) * Add UI notification to alert user of deprecated manifest version (#312) * Revert commit 'Add UI notification to alert user of deprecated manifest version' * Revert 'Pass populated AWS_CA_BUNDLE env var to Flare' * Rebase changes from Browser Provider PR * Fix ViewRouter * Integrate browser based views in ViewContainer * Fix checkstyle issues * Fix AmazonQBrowserProvider tests * Fix bug due to display sync exec call * Add semaphore locking to container to prevent race conditions * Add browser focus handling * Separate Chat and Toolkit Login webview asset event stream * Separate Chat and Toolkit Login webview asset event stream * Add state checking methods to LspState * Clean up code * Remove unnecessary parent assignment from chat webview * Refactor ViewVisibilityManager to default to one view * Add accidentally removed telemetry emissions * Fix issue in a comment due to stash * Update AssetProviders to publish state everytime content is fetched * Update plugin descriptor (#360) * Remove business logic from asset provider constructors * Remove redundant methods to check state --------- Co-authored-by: Jonathan Breedlove <breedloj@amazon.com> Co-authored-by: Nicolas <nborges.aws@gmail.com> * Refactor view actions and move setup code to base view (#370) * Refactor actions and move to base view * Improve disposal logic * Fix minor bugs * Fix minor bugs * Remove unnecessary BaseView class (#371) * Remove LspStatusManager (#365) * Remove LspStatusManager * Refactor browser provider (#366) * Move publishing browser status to Activator * Fix potential memory visibility bug (#367) * Fix thread visibility bug * Fix thread visibility bug * Remove chat asset provider (#368) * Fix thread visibility bug * Remove ChatAssetProvider * Fix bugs in ViewRefactor feature branch (#362) * Remove redundant state check method * Fix bugs in view refactor branch * Fix checkstyle issues * Make webview asset provider disposal more selective * Reset content on dispose * Redirect old views to point to the ViewContainer (#380) * Redirect old view IDs to point to ViewContainer * Redirect old view IDs to point to ViewContainer * Auto detection of proxy settings * Make keystore custom cert injection additive * Introduce ViewRouter Component (#337) * improved handling of lsp failure state * add static mock to lsp connection test case * Integrate Event Broker in LspStatusManager * Add ViewRouter POC * Fix code formatting bug * Add method to retrieve observables * Add listeners for combined state streams and view update request * Add listeners for combined state streams and view update request * Add listeners for combined state streams and view update request * Add functionality for hot event streams that track latest event (#340) * Add functionality for hot subscribers that track latest event * Add test to ensure event stream isolation * Fix missing subscription disposal in test * Use autoConnect to implicitly manage stream connection * Remove active view update request listener * Add ViewRouter tests * Remove public constructor * Remove public constructor and unused event in tests * Add comments * Add documentation for EventBroker * Remove ViewRouter initialization * Remove LspInitializingView from ID enum * Add documentation for ViewRouter * Refactor and enhance EventBroker tests * Refactor ViewRouter tests for clarity * Remove PluginState class into separate file * Add documentation to subscription management logic * Add support for notifying multiple late-subscribers over time of latest state (#342) * Remove CODE_REFERENCE_VIEW * Rename newActiveViewId to newActiveView * Rename ViewId class to AmazonQViewType * Revert "Integrate Event Broker in LspStatusManager" This reverts commit 374e549. * Revert "improved handling of lsp failure state" This reverts commit 13c55ac. * Refactor EventBroker and enhance tests (#343) --------- Co-authored-by: Nicolas Borges <nickdb@amazon.com> * Add Browser Provider component (#357) * Pass populated AWS_CA_BUNDLE env var to Flare (#341) * Add UI notification to alert user of deprecated manifest version (#312) * Add webview dependency missing logic to ViewRouter * Revert commit 'Add UI notification to alert user of deprecated manifest version' * Revert 'Pass populated AWS_CA_BUNDLE env var to Flare' --------- Co-authored-by: Jonathan Breedlove <breedloj@amazon.com> Co-authored-by: Nicolas <nborges.aws@gmail.com> * Add Webview Asset Providers (#358) * Pass populated AWS_CA_BUNDLE env var to Flare (#341) * Add UI notification to alert user of deprecated manifest version (#312) * Add webview dependency missing logic to ViewRouter * Revert commit 'Add UI notification to alert user of deprecated manifest version' * Revert 'Pass populated AWS_CA_BUNDLE env var to Flare' * Rebase changes from Browser Provider PR * Fix ViewRouter --------- Co-authored-by: Jonathan Breedlove <breedloj@amazon.com> Co-authored-by: Nicolas <nborges.aws@gmail.com> * Integrate browser based views in ViewContainer (#359) * Pass populated AWS_CA_BUNDLE env var to Flare (#341) * Add UI notification to alert user of deprecated manifest version (#312) * Revert commit 'Add UI notification to alert user of deprecated manifest version' * Revert 'Pass populated AWS_CA_BUNDLE env var to Flare' * Rebase changes from Browser Provider PR * Fix ViewRouter * Integrate browser based views in ViewContainer * Fix checkstyle issues * Fix AmazonQBrowserProvider tests * Fix bug due to display sync exec call * Add semaphore locking to container to prevent race conditions * Add browser focus handling * Add state checking methods to LspState * Clean up code * Remove unnecessary parent assignment from chat webview * Refactor ViewVisibilityManager to default to one view * Add accidentally removed telemetry emissions * Update plugin descriptor (#360) * Move semaphore locking/unlocking to try/finally block --------- Co-authored-by: Jonathan Breedlove <breedloj@amazon.com> Co-authored-by: Nicolas <nborges.aws@gmail.com> * Merge main into feature/viewRefactor * Refactor asset providers (#383) * Refactor asset provider to handle JS asset setup * Move progress listener for flicker bug out of asset providers * Pre-fetch assets to publish asset state on event broker * Consolidate events into their own package (#385) * Refactor asset provider to handle JS asset setup * Move events to their own package * Move progress listener for flicker bug out of asset providers * Clean up code * Refactor asset provider interface (#386) * Refactor asset provider interface * Update initialize method to only fire once * Trigger LSP configuration pull on preference update (#388) * Open Flare version constraint (#389) * Bump version to 1.0.4-SNAPSHOT * Add dropdown menu on top level Q toolbar icon * Add item for opening Q Chat * Introduce ViewRouter Component (#337) * improved handling of lsp failure state * add static mock to lsp connection test case * Integrate Event Broker in LspStatusManager * Add ViewRouter POC * Fix code formatting bug * Add method to retrieve observables * Add listeners for combined state streams and view update request * Add listeners for combined state streams and view update request * Add listeners for combined state streams and view update request * Add functionality for hot event streams that track latest event (#340) * Add functionality for hot subscribers that track latest event * Add test to ensure event stream isolation * Fix missing subscription disposal in test * Use autoConnect to implicitly manage stream connection * Remove active view update request listener * Add ViewRouter tests * Remove public constructor * Remove public constructor and unused event in tests * Add comments * Add documentation for EventBroker * Remove ViewRouter initialization * Remove LspInitializingView from ID enum * Add documentation for ViewRouter * Refactor and enhance EventBroker tests * Refactor ViewRouter tests for clarity * Remove PluginState class into separate file * Add documentation to subscription management logic * Add support for notifying multiple late-subscribers over time of latest state (#342) * Remove CODE_REFERENCE_VIEW * Rename newActiveViewId to newActiveView * Rename ViewId class to AmazonQViewType * Revert "Integrate Event Broker in LspStatusManager" This reverts commit 374e549. * Revert "improved handling of lsp failure state" This reverts commit 13c55ac. * Refactor EventBroker and enhance tests (#343) --------- Co-authored-by: Nicolas Borges <nickdb@amazon.com> * Add Browser Provider component (#357) * Pass populated AWS_CA_BUNDLE env var to Flare (#341) * Add UI notification to alert user of deprecated manifest version (#312) * Add webview dependency missing logic to ViewRouter * Revert commit 'Add UI notification to alert user of deprecated manifest version' * Revert 'Pass populated AWS_CA_BUNDLE env var to Flare' --------- Co-authored-by: Jonathan Breedlove <breedloj@amazon.com> Co-authored-by: Nicolas <nborges.aws@gmail.com> * Add Webview Asset Providers (#358) * Pass populated AWS_CA_BUNDLE env var to Flare (#341) * Add UI notification to alert user of deprecated manifest version (#312) * Add webview dependency missing logic to ViewRouter * Revert commit 'Add UI notification to alert user of deprecated manifest version' * Revert 'Pass populated AWS_CA_BUNDLE env var to Flare' * Rebase changes from Browser Provider PR * Fix ViewRouter --------- Co-authored-by: Jonathan Breedlove <breedloj@amazon.com> Co-authored-by: Nicolas <nborges.aws@gmail.com> * Integrate browser based views in ViewContainer (#359) * Pass populated AWS_CA_BUNDLE env var to Flare (#341) * Add UI notification to alert user of deprecated manifest version (#312) * Revert commit 'Add UI notification to alert user of deprecated manifest version' * Revert 'Pass populated AWS_CA_BUNDLE env var to Flare' * Rebase changes from Browser Provider PR * Fix ViewRouter * Integrate browser based views in ViewContainer * Fix checkstyle issues * Fix AmazonQBrowserProvider tests * Fix bug due to display sync exec call * Add semaphore locking to container to prevent race conditions * Add browser focus handling * Add state checking methods to LspState * Clean up code * Remove unnecessary parent assignment from chat webview * Refactor ViewVisibilityManager to default to one view * Add accidentally removed telemetry emissions * Update plugin descriptor (#360) * Move semaphore locking/unlocking to try/finally block --------- Co-authored-by: Jonathan Breedlove <breedloj@amazon.com> Co-authored-by: Nicolas <nborges.aws@gmail.com> * Refactor view actions and move setup code to base view (#370) * Refactor actions and move to base view * Improve disposal logic * Fix minor bugs * Fix minor bugs * Auto detection of proxy settings * Integrate browser based views in ViewContainer (#359) * Pass populated AWS_CA_BUNDLE env var to Flare (#341) * Add UI notification to alert user of deprecated manifest version (#312) * Revert commit 'Add UI notification to alert user of deprecated manifest version' * Revert 'Pass populated AWS_CA_BUNDLE env var to Flare' * Rebase changes from Browser Provider PR * Fix ViewRouter * Integrate browser based views in ViewContainer * Fix checkstyle issues * Fix AmazonQBrowserProvider tests * Fix bug due to display sync exec call * Add semaphore locking to container to prevent race conditions * Add browser focus handling * Add state checking methods to LspState * Clean up code * Remove unnecessary parent assignment from chat webview * Refactor ViewVisibilityManager to default to one view * Add accidentally removed telemetry emissions * Update plugin descriptor (#360) * Move semaphore locking/unlocking to try/finally block --------- Co-authored-by: Jonathan Breedlove <breedloj@amazon.com> Co-authored-by: Nicolas <nborges.aws@gmail.com> * Refactor asset providers (#383) * Refactor asset provider to handle JS asset setup * Move progress listener for flicker bug out of asset providers * Pre-fetch assets to publish asset state on event broker * Integrate AmazonQCommonActions change * Integrate AmazonQCommonActions change * Remove duplicate events * Fix global drop-down visibility bug * Fix UdateUtil bug * Fix UdateUtil bug * Fix missing imports * Improve timing of early startup activity (#393) (#394) * Improve timing of early startup activity * Fix unit test Co-authored-by: Jonathan Breedlove <breedloj@amazon.com> Co-authored-by: Ishan Taldekar <taldekar@amazon.com> * Remove unused imports * Fix Event Broker subscription disposal bug (#392) (#395) * Fix Event Broker subscription disposal bug * Add null check Co-authored-by: Ishan Taldekar <taldekar@amazon.com> * Remove dispose method * Remove redundant classes --------- Co-authored-by: Nicolas <nborges.aws@gmail.com> Co-authored-by: Nicolas Borges <nickdb@amazon.com> Co-authored-by: Jonathan Breedlove <breedloj@amazon.com> Co-authored-by: aws-toolkit-automation <43144436+aws-toolkit-automation@users.noreply.github.com>

nborges-aws and others added 5 commits January 27, 2025 17:24

improved handling of lsp failure state

13c55ac

add static mock to lsp connection test case

548a9da

Integrate Event Broker in LspStatusManager

374e549

Add ViewRouter POC

6a9f8d3

Fix code formatting bug

d1746a4

taldekar requested a review from shruti0085 January 28, 2025 19:42

nborges-aws mentioned this pull request Jan 28, 2025

Introduce View Container and base view components #338

Merged

taldekar changed the base branch from main to nickdb/lspErrorHandling January 29, 2025 14:19

taldekar added 3 commits January 29, 2025 09:59

Add method to retrieve observables

091b6e9

Add listeners for combined state streams and view update request

fa11959

Add listeners for combined state streams and view update request

f934e6c

taldekar requested a review from breedloj January 29, 2025 15:04

taldekar added 3 commits January 29, 2025 10:15

Add listeners for combined state streams and view update request

a095805

Add functionality for hot event streams that track latest event (#340)

4ad24a1

* Add functionality for hot subscribers that track latest event * Add test to ensure event stream isolation * Fix missing subscription disposal in test * Use autoConnect to implicitly manage stream connection

Remove active view update request listener

d8b62b4

breedloj approved these changes Jan 30, 2025

View reviewed changes

taldekar added 4 commits January 30, 2025 14:37

Add ViewRouter tests

eca096f

Remove public constructor

d1096a6

Remove public constructor and unused event in tests

24f9c21

Add comments

eb53a8c

shruti0085 reviewed Jan 30, 2025

View reviewed changes

Comment thread plugin/src/software/aws/toolkits/eclipse/amazonq/views/router/ViewRouter.java Outdated

shruti0085 reviewed Jan 30, 2025

View reviewed changes

taldekar added 8 commits January 30, 2025 18:55

Add documentation for EventBroker

fb1600e

Remove ViewRouter initialization

da7b9f9

Remove LspInitializingView from ID enum

6cea24d

Add documentation for ViewRouter

17c0ebb

Refactor and enhance EventBroker tests

f4da1d3

Refactor ViewRouter tests for clarity

65c07f7

Remove PluginState class into separate file

9f01b0b

Add documentation to subscription management logic

ebdbcbf

taldekar requested a review from shruti0085 January 31, 2025 00:14

shruti0085 reviewed Jan 31, 2025

View reviewed changes

taldekar added 4 commits January 31, 2025 15:09

Add support for notifying multiple late-subscribers over time of late…

0276e79

…st state (#342)

Remove CODE_REFERENCE_VIEW

78d7439

Rename newActiveViewId to newActiveView

77fc653

Rename ViewId class to AmazonQViewType

581b0eb

shruti0085 approved these changes Jan 31, 2025

View reviewed changes

taldekar changed the base branch from nickdb/lspErrorHandling to feature/viewRefactor January 31, 2025 21:21

taldekar added 4 commits January 31, 2025 16:33

Revert "Integrate Event Broker in LspStatusManager"

b395464

This reverts commit 374e549.

Revert "improved handling of lsp failure state"

c49a354

This reverts commit 13c55ac.

Refactor EventBroker and enhance tests (#343)

4ed1bf1

Merge branch 'feature/viewRefactor' into taldekar/ViewRouter

3b95fcd

taldekar merged commit f975e6f into feature/viewRefactor Feb 4, 2025

taldekar deleted the taldekar/ViewRouter branch February 4, 2025 21:27

Conversation

taldekar commented Jan 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

shruti0085 Jan 30, 2025

Choose a reason for hiding this comment

Uh oh!

taldekar Jan 30, 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!

shruti0085 Jan 30, 2025

Choose a reason for hiding this comment

Uh oh!

taldekar Jan 30, 2025

Choose a reason for hiding this comment

Uh oh!

taldekar Jan 30, 2025

Choose a reason for hiding this comment

Uh oh!

shruti0085 Jan 31, 2025

Choose a reason for hiding this comment

Uh oh!

taldekar Jan 31, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

shruti0085 Jan 31, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

taldekar commented Jan 28, 2025 •

edited

Loading

taldekar Jan 30, 2025 •

edited

Loading