refactor(auth): dont manual refresh auth webview on hide #6836
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Problem: We have an explicit force refresh of the auth webview when it is shown/hidden. There is not an obvious reason why we do this. This causes problems since we expect that show/hiding of the webview does not trigger any functional changes since we have configured the webview to continue running even while hidden. This means that our handlers for auth changes are still running even when auth is hidden. For my specific issue, by force reloading the webview on every show/hide it triggered the webview loading code each time, causing webview telemetry events to be triggered more than expected. Solution: Remove the force reload line. With this change we can move the edge case handling code which throttled the telemetry emitted when it was triggered on every hide/show. I've done manual testing and have not noted any obvious regressions to the expected user flow. Signed-off-by: nkomonen-amazon <[email protected]>
|
Contributor
Author
|
/runIntegrationTests |
jpinkney-aws
approved these changes
Mar 25, 2025
Contributor
jpinkney-aws
left a comment
jpinkney-aws
left a comment
There was a problem hiding this comment.
I wonder if we originally had this because our super old auth flow needed a way to be reset if the webview was closed/opened? For some reason I vaguely remember something about that. Regardless its probably not relevant now
Contributor
Author
|
@jpinkney-aws that sounds accurate. Right now we have some event listeners that will force the UI to refresh on change of the auth connection, and separately if the user happens to log in/out we will change from the auth to chat view regardless of the explicit webview refresh. So as you said it doesn't seem relevant anymore! |
Hweinstock
pushed a commit
to Hweinstock/aws-toolkit-vscode
that referenced
this pull request
Mar 26, 2025
## Problem: We have an explicit force refresh of the auth webview when it is shown/hidden. There is not an obvious reason why we do this. This causes problems since we expect that show/hiding of the webview does not trigger any functional changes since we have configured the webview to continue running even while hidden. This means that our handlers for auth changes are still running even when auth is hidden. For my specific issue, by force reloading the webview on every show/hide it triggered the webview loading code each time, causing webview telemetry events to be triggered more than expected. ## Solution: Remove the force reload line. With this change we can move the edge case handling code which throttled the telemetry emitted when it was triggered on every hide/show. I've done manual testing and have not noted any obvious regressions to the expected user flow. --- - 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. Signed-off-by: nkomonen-amazon <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Problem:
We have an explicit force refresh of the auth webview when it is shown/hidden. There is not an obvious reason why we do this.
This causes problems since we expect that show/hiding of the webview does not trigger any functional changes since we have configured the webview to continue running even while hidden. This means that our handlers for auth changes are still running even when auth is hidden.
For my specific issue, by force reloading the webview on every show/hide it triggered the webview loading code each time, causing webview telemetry events to be triggered more than expected.
Solution:
Remove the force reload line. With this change we can move the edge case handling code which throttled the telemetry emitted when it was triggered on every hide/show.
I've done manual testing and have not noted any obvious regressions to the expected user flow.
feature/xbranches will not be squash-merged at release time.