Fix unhandled Redis exception in the /api/server/health/ endpoint #7417
+10
−36
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
c1c04ef to
063b9ff
Compare
063b9ff to
0dae3f8
Compare
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## develop #7417 +/- ##
===========================================
- Coverage 83.46% 83.46% -0.01%
===========================================
Files 373 373
Lines 39760 39735 -25
Branches 3720 3721 +1
===========================================
- Hits 33187 33163 -24
+ Misses 6573 6572 -1
|
`CustomCacheBackend` does not handle `RedisError`, so if Redis is not responding, the backend will propagate the exception, and the endpoint will crash with a 500 response code. This problem has been fixed upstream in django-health-check 3.18, so just update to the latest version and remove our custom cache backend. The upstream version, unlike ours, doesn't handle `sqlite3.DatabaseError`, but we're not using SQLite for caching anymore, so I don't think it matters.
0dae3f8 to
c576bb4
Compare
|
@azhavoro Would you mind reviewing this? |
azhavoro
approved these changes
Feb 5, 2024
Merged
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.
Motivation and context
CustomCacheBackenddoes not handleRedisError, so if Redis is not responding, the backend will propagate the exception, and the endpoint will crash with a 500 response code.This problem has been fixed upstream in django-health-check 3.18, so just update to the latest version and remove our custom cache backend.
The upstream version, unlike ours, doesn't handle
sqlite3.DatabaseError, but we're not using SQLite for caching anymore, so I don't think it matters.How has this been tested?
I checked the endpoint with both working and non-working Redis.
Checklist
developbranch[ ] I have updated the documentation accordingly[ ] I have added tests to cover my changes[ ] I have linked related issues (see GitHub docs)[ ] I have increased versions of npm packages if it is necessary(cvat-canvas,
cvat-core,
cvat-data and
cvat-ui)
License
Feel free to contact the maintainers if that's a concern.