Handling Queued Events #94
Merged
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
dhavalshreyas
requested review from
AquaGeek,
bencochran,
rjrjr and
zach-klippenstein
rjrjr
reviewed
Feb 24, 2021
|
|
||
| case .queued: | ||
| fatalError("[\(WorkflowType.self)] Action sent to pipe while already in the `queueing` state.") | ||
| fatalError("[\(WorkflowType.self)] Action sent to pipe while in the `pending` state.") |
Contributor
There was a problem hiding this comment.
I thought this PR was to eliminate this error?
Contributor
Author
There was a problem hiding this comment.
Yeah, this should not be possible, however the .pending state will continue to exist. fatal ensures we don't hit this spot.
rjrjr
approved these changes
Feb 24, 2021
AquaGeek
approved these changes
Feb 24, 2021
Collaborator
AquaGeek
left a comment
AquaGeek
left a comment
There was a problem hiding this comment.
Have we run this against the tests in the monorepo?
Contributor
Author
Yes, all green. |
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.
Queued Events
Queued Events are events sent to the
Sinksynchronously whileScreens are being updated. Wequeuethem up and are applied after theScreenupdate operation.Issues
Our existing implementation of
Queuedevents handling has a few issues:Workflownode can handle only one event, if another event is sent, wefatalErrorwith aAction sent to pipe while in the pending state.message.Workflownodes have events queued, only one of them will be handled, the rest are silently dropped.enablingand handlingEventPipeswhile handlingqueuedevents, the Workflow tree can get into an inconsistent state and sometimes leads to a crash.Solution
To solve this issue, in this PR, we are not queueing events in the
SubtreeManager, instead we schedule the event to be delivered to theEventPipeasynchronously. This fixes the issues outlined above.