Guard against indefinite caching #1554
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
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## develop #1554 +/- ##
===========================================
- Coverage 94.23% 94.23% -0.01%
===========================================
Files 1068 1068
Lines 39348 39403 +55
===========================================
+ Hits 37080 37131 +51
- Misses 2268 2272 +4 ☔ View full report in Codecov by Sentry. |
pi-sigma
requested changes
Jan 15, 2025
swrichards
force-pushed
the
guard-against-infinite-cache
branch
from
b59b1ac to
7f06f88
Compare
Because the timeout value for the ZGW caching is taken from the Django settings, it is not unthinkable that, due to some misconfiguration, the timeout value could end up being None. If this is passed as-is to the low-level Django caching backend, it will be interpreted as "cache forever", because the default kwarg of 60 would be overridden. This can lead to unexpected behavior, e.g. ZGW API objects appearing to be stale because the cache never expires. This commit makes sure an exception is raised if a non-integer value is provided.
swrichards
force-pushed
the
guard-against-infinite-cache
branch
from
7f06f88 to
da16897
Compare
pi-sigma
approved these changes
Jan 16, 2025
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.
Because the timeout value for the ZGW caching is taken from the Django settings, it is not unthinkable that, due to some misconfiguration, the timeout value could end up being None. If this is passed as-is to the low-level Django caching backend, it will be interpreted as "cache forever", because the default kwarg of 60 would be overridden. This can lead to unexpected behavior, e.g. ZGW API objects appearing to be stale because the cache never expires.
This commit makes this process more explicit by setting a default only if no timeout kwarg is provided, and also interpreting a timeout of "None" as a request for the default timeout, to fully prohibit "cache forever" scenarios.