This repository has been archived by the owner on Apr 26, 2024. It is now read-only.
provide ability to cache boto client instances directly and on S3Bucket
#369
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
zzstoatzz
changed the title
S3Bucket
zzstoatzz
commented
Jan 18, 2024
desertaxle
reviewed
Jan 19, 2024
prefect_aws/s3.py
Outdated
Comment on lines
428
to
435
| cache_client: bool = Field( | ||
| default=False, | ||
| description=( | ||
| "If True, the S3 client will be cached. This is useful for " | ||
| "performance, but could cause issues if the S3 client is used " | ||
| "in multi-threaded environments." | ||
| ), | ||
| ) |
There was a problem hiding this comment.
I think this toggle makes more sense on the AwsCredentials class since it's closer to where the client is instantiated and allows other consumers of AwsCredentials to use the toggle.
Also, do you know what issues client caching can cause in multi-threaded environments and if we can mitigate those issues? I'd prefer to not expose this toggle if we don't have to.
tests/test_credentials.py
Outdated
|
|
||
|
|
||
| @pytest.mark.parametrize("client_type", [member.value for member in ClientType]) | ||
| def test_get_client_cached(client_type): |
There was a problem hiding this comment.
Can you add a test that ensures that changing some configuration on an AwsCredentials instance after instantiation and fetching a client causes a cache miss?
5 tasks
1 task
5 tasks
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.
closes #332
This PR introduces an enhanced default caching strategy for boto client instances within our
AwsCredentialsandMinIOCredentialsclasses.lru_cachemechanism, keyed on the credentials context (ctx) and client type.__hash__method ofAwsCredentialsandMinIOCredentialsis based on the combination of these fields, ensuring that any changes to the credentials object results in a different hash and thus a new cache entry._LOCK), which synchronizes access to theget_clientfunction, preventing race conditions in multi-threaded environments.thanks to @mattiamatrix for doing the bulk of this work