Implement API key caching and update documentation #242
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
- Introduced API key caching using the CacheMixin class to improve performance. - Added cache checks before querying the database for API key validity. - Connected post-save and post-delete signals to AbstractAPIKey descendants to manage cache invalidation. - Included tests for the new caching mechanism. - Updated 'docs/guide.md' with API key caching instructions.
AlexIvanchyk
force-pushed
the
feature/add-caching
branch
from
b01f709
to
25c6809
Compare
Codecov Report
❗ Your organization is not using the GitHub App Integration. As a result you may experience degraded service beginning May 15th. Please install the GitHub App Integration for your organization. Read more. @@ Coverage Diff @@
## master #242 +/- ##
==========================================
Coverage 100.00% 100.00%
==========================================
Files 24 27 +3
Lines 593 718 +125
==========================================
+ Hits 593 718 +125
📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
- Introduced API key caching using the CacheMixin class to improve performance. - Added cache checks before querying the database for API key validity. - Connected post-save and post-delete signals to AbstractAPIKey descendants to manage cache invalidation. - Included tests for the new caching mechanism. - Updated 'docs/guide.md' with API key caching instructions. - Provide an optional setting for caching, letting users with stringent security concerns disable this feature as needed.
- Introduced a new test case where an exception is raised if CacheMixin is used when no model is defined. This ensures that a useful error message is displayed if a developer forgets to set the model attribute when using CacheMixin. - Added a new test case to ensure that cache invalidation is properly implemented. This tests the invalidate_cache function of CacheMixin to ensure it is effectively removing the corresponding cache entry as needed.
|
Hi @AlexIvanchyk, Given that we went with SHA512 hashing via #244, I will kindly close this pull request. I want to express many thanks for moving the issue forward and discussing ideas as well as this implementation PR. I'm sure this will be of useful reference if caching is brought up in the future. Cheers! |
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.
#173