Add a drop safe async version of scope guard - #5910
Open
jsdt wants to merge 1 commit into
Open
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
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 of Changes
This is a change to make sure our client cleanup is drop safe. Our previous code had:
This has an race condition, because if the client task were cancelled immediately after
ws_client_actor_inner(&mut client.0, options, ws, sendrx).await;, then we would stop runningws_client_teardownon the first deferred task. To make sure we always run that cleanup to completion, we need to run it inside a tokio::spawn. We could fix it with a spawn, but I added a helper that works like scopeguard::guard for async cleanup functions. I'm actually surprised that we don't seem to do this pattern anywhere else.Rollback safety impact
None.
Expected complexity level and risk
Testing
This has some unit tests for the new guard.