grpc/client: fix trait bounds on channel credentials to avoid double Arcing#2694
Open
arjan-bal wants to merge 1 commit into
Open
grpc/client: fix trait bounds on channel credentials to avoid double Arcing#2694arjan-bal wants to merge 1 commit into
arjan-bal wants to merge 1 commit into
Conversation
acd5dfa to
2172784
Compare
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.
Background
The channel constructor currently accepts an
Arc<C>because the credentials might be reused to create "out of band" (OOB) channels (e.g., to an RLS server). If we accepted raw credentials and wrapped them inside the constructor instead, creating an OOB channel would result in a second, redundantArcwrapper, leading to unnecessary pointer indirection and reference counting.Problem
Passing an
Arc<dyn DynChannelCredentials>toChannel::newcurrently fails to compile, even if we add animpl ChannelCredentials for dyn DynChannelCredentials.This happens because the generic type parameter
CinChannel::newhas an implicitSizedbound, which trait objects likedyn DynChannelCredentialsdo not satisfy.Fix
This PR introduces an opaque wrapper struct,
SharedChannelCredentials, and updates the channel constructor to acceptimpl Into<SharedChannelCredentials>.Specifically, this change:
From<Arc<C>>implementation to convert any validArc<C: ChannelCredentials>intoSharedChannelCredentials.ChannelCredentialstrait directly onSharedChannelCredentialsso it can be used seamlessly.This resolves the compilation error while preserving the optimization against double-
Arcing. An existingSharedChannelCredentialsobject can be passed directly to an OOB channel; calling.into()on it is essentially a no-op, securely reusing the existing reference count.