Handle SaltDeserializationError in grains cache loading#68674
Open
sheagcraig wants to merge 4 commits intosaltstack:masterfrom
Open
Handle SaltDeserializationError in grains cache loading#68674sheagcraig wants to merge 4 commits intosaltstack:masterfrom
sheagcraig wants to merge 4 commits intosaltstack:masterfrom
Conversation
Fix a bug where corrupted grains cache files cause unhandled SaltDeserializationError exceptions. When msgpack encounters corrupted cache data, it raises msgpack.exceptions.ExtraData, which is wrapped in SaltDeserializationError by salt.payload.load(). Previously, _load_cached_grains() only caught OSError, allowing the exception to propagate and cause CRITICAL errors. This fix adds SaltDeserializationError to the exception handler, treating corrupted cache the same as missing cache: return None, regenerate grains, and overwrite the corrupted cache file. Changes: - Add SaltDeserializationError to imports in salt/loader/__init__.py - Update exception handler in _load_cached_grains() to catch both OSError and SaltDeserializationError Impact: - Automatic recovery from corrupted grains cache - No manual intervention required - Fully backward compatible Fixes: Issue with corrupted grains cache causing minion connection failures
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.
What does this PR do?
Fix for #68678
What issues does this PR fix or reference?
Fixes a bug where corrupted grains cache files cause unhandled
SaltDeserializationError exceptions.
When msgpack encounters corrupted cache data, it raises
msgpack.exceptions.ExtraData, which is wrapped in
SaltDeserializationError by salt.payload.load(). Previously,
_load_cached_grains() only caught OSError, allowing the
exception to propagate and cause CRITICAL errors.
This fix adds SaltDeserializationError to the exception handler,
treating corrupted cache the same as missing cache: return None,
regenerate grains, and overwrite the corrupted cache file.
Previous Behavior
Only OSError was handled, so the SaltDeserializationError would cause a CRITICAL failure.
New Behavior
If the grains cache is corrupt and won't deserialize, catch the exception and
return None, which is a signal to callers to refresh the grains.
Merge requirements satisfied?
[NOTICE] Bug fixes or features added to Salt require tests.
Commits signed with GPG?
Yes