fix(utils): handle malformed JSON in JSONFileCache gracefully#3682
Open
armorbreak001 wants to merge 1 commit intoboto:developfrom
Open
fix(utils): handle malformed JSON in JSONFileCache gracefully#3682armorbreak001 wants to merge 1 commit intoboto:developfrom
armorbreak001 wants to merge 1 commit intoboto:developfrom
Conversation
When a cache file contains corrupted JSON (e.g. from a partial write or concurrent modification), JSONFileCache.__getitem__ now logs a warning with the parse error, removes the corrupted file to prevent repeated failures, and raises KeyError to treat it as a cache miss. Previously, a corrupted cache file would cause a cryptic KeyError showing only the cache key hash, with no indication of the root cause. Fixes boto#3106
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
When a cache file contains corrupted JSON (e.g., from a partial write or concurrent modification),
JSONFileCache.__getitem__previously raised a bareKeyErrorshowing only the cache key hash, giving users no indication of the root cause.This change splits the error handling in
__getitem__:OSError(file not found): raisesKeyErrorimmediately — normal cache missValueError/JSONDecodeError(malformed JSON): logs a warning with the file path and parse error, removes the corrupted file to prevent repeated failures on every call, then raisesKeyErrorso callers treat it as a cache miss and re-fetch credentialsThe corrupted file cleanup is important because without it, the same cryptic error repeats on every subsequent call until the user manually clears the cache directory.
Fixes #3106