Correct the docstring and implementation of AuthMetadataPlugin #22471
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
lidizheng
added
kind/bug
lang/Python
priority/P2
release notes: yes
|
@gnossen PTAL |
|
@lidizheng This switches the |
|
@gnossen The Cython spawned thread will be blocked. For sync Python, if an HTTP request will block, it have to block on a certain thread. I think it might be a viable way to ensure the RPC caller is not blocked by the plugin callback. If the plugin callback never finished (blocked forever or not calling the supplied callback), the RPC won't be proceed due to pending metadata. But other RPC features still works, like timeout. |
gnossen
approved these changes
Mar 25, 2020
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
The docstring of AuthMetadataPlugin has created confusion for our end users googleapis/google-auth-library-python#351. Our current implementation spawns a dedicated thread each time the AuthMetadataPlugin is invoked. It doesn't block the caller of the RPC. I confirmed the behavior by twitching our credentials example.
Also, this PR removed the thread pool in the plugin class to be consistent with the docstring and googleapis/google-auth-library-python#467.
CC @busunkim96