feat: [M3-8722] - Improve weblish retry behavior #11067
Open
Conversation
This file contains 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
* automatically reconnect weblish sessions that have disconnected * … unless it fails rapidly (more than 3 times in a 1 minute window) * … in which case show an error screen with as much information as we can provide * … where the error screen includes a button to try again. * focus the terminal element when starting (which is generally helpful but also prevents _losing_ focus after a reconnect) Previously, a failure would often just result in a spinning circle forever.
plisiecki1
requested review from
hana-akamai and
cpathipa
and removed request for
a team
|
Coverage Report: ❌ |
hana-akamai
reviewed
Oct 9, 2024
…Error`. Break the `formatError` logic into two separate function that compute the two parts of the output, and then the main function just appends them. Adopt the preferred `const x = () =>` syntax in lieu of `function x()` syntax.
…s as its own, separate interface.
…iable as suggested in code review.
…d of `class` for `RetryLimiter`.
hana-akamai
reviewed
Oct 9, 2024
* Remove comments for obvious fields * `actionButton` => `actionButtonProps` * Combine `try` cases when parsing errors
hana-akamai
reviewed
Oct 16, 2024
* Add spaces around `=>` types. * Remove unnecessary `Optional Action Button` comment. * Refactor error handling using new `ParsePotentialLishErrorString` and `LishErrorInterface`. This centralizes all of the code to check structure and type of errors in one place. This may also prove using for future improvements to graphical lish. * Flatten websocket `close` handler logic from if-if-else-else structure to if-return-if-return-return.
hana-akamai
reviewed
Oct 16, 2024
hana-akamai
reviewed
Oct 17, 2024
Comment on lines
69
to
90
| { | ||
| const reason = parsed?.reason; | ||
| if (parsed?.type === "error" && typeof reason === "string") { | ||
| return { | ||
| reason: reason, | ||
| grn: grn, | ||
| formatted: reason + grnFormatted, | ||
| isExpired: reason.toLowerCase() === "your session has expired." | ||
| }; | ||
| } | ||
| } | ||
| { | ||
| const reason = parsed?.errors?.[0]?.reason; | ||
| if (typeof reason === "string") { | ||
| return { | ||
| reason: reason, | ||
| grn: grn, | ||
| formatted: `Error code: ${reason}${grnFormatted}`, | ||
| isExpired: reason === "expired" | ||
| }; | ||
| } | ||
| } |
There was a problem hiding this comment.
What's the difference between these two cases?
There was a problem hiding this comment.
The error may take one of two different formats. {"type":"error","reason":"..."} or {"errors":[{"reason":"..."}]}. The "expired" case can occur with either format, but the message to check is slightly different. The formatting is also slightly different because the first form tends to output descriptive errors, whereas the second from outputs one-word codes. (Currently, only the second form sends grn trace information, but I wanted to leave the option of adding it to the first, so the grn is currently handled outside of those two cases.)
* Remove second error format: It turns out that it will not be too difficult to make all of the errors follow the same basic format, so we don't need two separate parsers. Yay!
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description 📝
Previously, a failure would often just result in a spinning circle forever.
Changes 🔄
List any change relevant to the reviewer.
Lish.tsxwhich may also be useful for similar enhancements to graphical lish (glish) in the future.socketto be mutable and nullable so it can be updated when reconnecting.origSocketlocal variable is used to ensure that “stale” events are properly ignored.closehandler, which also eliminates the potential for console output that too closely matches an "expired" error being interpreted as an error and breaking the session immediately.Target release date 🗓️
TBD.
Preview 📷
How to test 🧪
Prerequisites
Running linode(s).
Reproduction steps
Launch a lish session for a machine, type
^a d kill <enter>. The session will exit and show a spinning circle.Verification steps
^a d kill <enter>. The session will reconnect.As an Author I have considered 🤔
Check all that apply