Fix async race #1656
Merged
Fix async race #1656
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
There may still be data data in the channel when the job exits. Conversely, the exit callback may be called after the channel is closed. To handle both situations, only call callbacks with exit status and all the messages once the job has exited and the channel has been closed. Replace the error_info_cb and custom_cb keys with a single new key, complete.
Only return the necessary callbacks from go#job#Spawn. Data that's needed during the execution of the callbacks is wrapped in a closure instead. Do not allow the caller to provide an exit_cb or close_cb; there are no current use cases that do so, and further changes would need to be made to ensure that the complete handler would be called if only one of exit_cb or close_cb were called.
Codecov Report
@@ Coverage Diff @@
## master #1656 +/- ##
==========================================
+ Coverage 21.73% 22.05% +0.31%
==========================================
Files 53 53
Lines 4173 4217 +44
==========================================
+ Hits 907 930 +23
- Misses 3266 3287 +21
Continue to review full report at Codecov.
|
|
I've marked this as WIP, because I've discovered a problem with guru. I'll remove the label once it's fixed. |
|
The problem I was encountering wasn't related to these changes. |
arp242
approved these changes
Jan 28, 2018
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.
Eliminate race conditions that were possible in vim8 job handling.
Most jobs were only handling the
exit_cbhandler for job options. To make sure that all messages are handled,close_cbhas to be hooked up and coordinated withexit_cb, because there is no guarantee about which order they will be called in.Refactor
autoload/go/job.vimto call the caller-provided callbacks only after the job has exited and channel has been closed so that the actual exit status and all messages can be provided. I also took this opportunity to clean up and simplifygo#job#Spawnso that there's only one callback called when the job completes instead of two and so that the return value only exposes the callbacks that are needed by the caller.Refactor
autoload/go/guru.vimto account for the fact that it's possible thatexit_cbmay be called afterclose_cb.Refactor all other async jobs to coordinate calling functions that should be called only after the job's exit status is known and all the channel is closed.
Because this touched so much code, I tried to make each of the commits focused on a single area of improvement. You may find it much easier to review each commit rather than reviewing them all at once.
Closes #1440