Make RequestsClient thread-safe
#531
Merged
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
It came up in #526 that our implementation isn't quite thread-safe. *Most* HTTP clients are by virtue of the fact that their underlying libraries are, but the recommended client, `RequestsClient` for the Requests library, creates and reuses only a single session for all the requests it makes. The Requests maintainers are non-committal when it comes to the thread safety of a session, but the general sentiment of its userbase is that sessions are not thread safe. Here we tweak the `RequestsClient` implementation so that we create one session per thread by leveraging Python's thread-local storage. Unfortunately, this implementation still leaves a pitfall in that if you explicitly pass in a session in, it will get used between all threads. The ideal thing to do here I think would be to probably not accept a session object anymore, but that'd be a breaking change. One possibility is that we could start warning about the use of the session parameter, but for the time being I've opted to just leave this as a known problem (given that hopefully this patch will still be a strict improvement).
|
Released as 2.20.1. |
|
Thanks OB! |
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.
It came up in #526 that our implementation isn't quite thread-safe.
Most HTTP clients are by virtue of the fact that their underlying
libraries are, but the recommended client,
RequestsClientfor theRequests library, creates and reuses only a single session for all the
requests it makes.
The Requests maintainers are non-committal when it comes to the thread
safety of a session, but the general sentiment of its userbase is that
sessions are not thread safe.
Here we tweak the
RequestsClientimplementation so that we create onesession per thread by leveraging Python's thread-local storage.
Unfortunately, this implementation still leaves a pitfall in that if you
explicitly pass in a session in, it will get used between all threads.
The ideal thing to do here I think would be to probably not accept a
session object anymore, but that'd be a breaking change. One possibility
is that we could start warning about the use of the session parameter,
but for the time being I've opted to just leave this as a known problem
(given that hopefully this patch will still be a strict improvement).
Note this will conflict with #530, but rebasing either branch should be
simple.
r? @ob-stripe
cc @jameshageman-stripe
cc @stripe/api-libraries