fix(tonic): make Streaming Sync again
#2293
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
The boxed `Decoder` inside `Streaming` need not be `Sync` since hyperium#804. Unfortunately, that makes `Streaming` non-`Sync`, meaning that all the generated `tonic` futures cannot be awaited in `Sync` futures. In fact, the only times we use the `Decoder`, we have a `&mut` unique reference to it, so we are guaranteed not to require synchronization. The `sync_wrapper` crate encodes this reasoning, allowing us to safely make the `Streaming` type `Sync` regardless of whether the contained `Decoder` is `Sync` or not.
tottoto
approved these changes
Jun 5, 2025
LucioFranco
approved these changes
Jun 20, 2025
|
Thanks |
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.
Motivation
The boxed
DecoderandBodyinsideStreamingneed not beSyncsince #804. Unfortunately, that makesStreamingnon-Sync, meaning that all the generatedtonicfutures cannot be awaited inSyncfutures, i.e. it regresses #81.Solution
In fact, the only times we use
self.decoderorself.body, we have a&mutunique reference to it, so we are guaranteed not to require synchronization.The
sync_wrappercrate encodes this reasoning, allowing us to safely make theStreamingtypeSyncregardless of whether the containedDecoderandBodyareSyncor not.