bugfix: Unique caches for simple_cache_middleware instances #2979
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
fselmo
added a commit
to fselmo/web3.py
that referenced
this pull request
Jun 5, 2023
fselmo
force-pushed
the
bugfix-simple-cache-unique-cache-per-instance
branch
from
29aed4f to
9c32974
Compare
At present, if the ``simple_cache_middleware`` is imported and added to multiple instances of ``Web3``, these instances end up sharing a cache. This happens because the middleware is only constructed once and where we instantiate the cache if it is ``None`` is in the ``construct_simple_cache_middleware`` method. By moving the cache instantiation into the actual ``simple_cache_middleware``, we ensure that with each call to ``simple_cache_middleware``, a fresh cache will be instantiated if the ``cache`` was ``None`` to begin with.
fselmo
force-pushed
the
bugfix-simple-cache-unique-cache-per-instance
branch
from
9c32974 to
e0f1786
Compare
reedsa
reviewed
Jun 6, 2023
pacrob
approved these changes
Jun 6, 2023
I updated the documentation for now and made sure it was up to date (it was poor to begin with and not up to date). I think I'm not understanding what makes this stand out from other middlewares and needs its own explanation other than the doc description. Maybe we create a ticket to better highlight that request and it becomes as separate PR? |
reedsa
approved these changes
Jun 6, 2023
7 tasks
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.
What was wrong?
closes #2977
How was it fixed?
For undefined
cachearguments to*construct_simple_cache_middlewaremethods, only create the cache at the middleware definition, not at the constructor method. This makes sure that a fresh cache is created each time the middleware is called (once for each instance). This was previously the case and I believe I broke it when we refactored the LRU cache out of this middleware.Tests added inspired by @cygnusv
Todo:
Cute Animal Picture