Factor error-handling out of poll method #1187
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
This method has gotten awfully long and tangly. Here's a first step on giving it some more organized structure.
This logic pairs closely with _maybeReportToUserTransientError, so pulling it out lets that logic live nearer each other.
This is basically a form of error reporting.
Now the `poll` method itself is a lot more focused on the overall structure of how polling works.
This takes it a bit farther in squeezing out details that aren't part of the main picture of what this method is doing. At this point the main remaining thing that feels like clutter is all the `if (_disposed) return;` lines. But I don't have any ideas at the moment for a better way to handle those.
PIG208
reviewed
Dec 21, 2024
| /// See also: | ||
| /// * [_handlePollRequestError], which handles certain errors | ||
| /// and causes them not to reach this method. | ||
| Future<void> _handlePollError(Object error) async { |
There was a problem hiding this comment.
Since this helper becomes the only user of _unexpectedErrorBackoffMachine, would it be better to move that BackoffMachine here?
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.
This is a follow-up to #1063 — it's very lightly revised from commits that were in my draft branch leading to that PR, and which I left out at the time because the PR was getting long and complex enough already.
In this PR, factoring this logic out of the [UpdateMachine.poll] method isn't for the sake of deduplicating anything: the methods the logic gets moved into are still private helpers tuned specifically for the needs of that method. But it allows that method to get quite a lot shorter, so its overall structure is more apparent. And it also allows each of the two phases of error-handling to be read in a bit more of a self-contained context, by having them in their own methods.