fix: prevent mutation of original dict when record.msg is a dict#66
Open
gaoflow wants to merge 1 commit into
Open
fix: prevent mutation of original dict when record.msg is a dict#66gaoflow wants to merge 1 commit into
gaoflow wants to merge 1 commit into
Conversation
When record.msg is used as a dict log message, the format() method assigned it by reference to message_dict. Subsequent mutations to message_dict (adding exc_info, stack_info) would leak into the caller's original dict. Fix by copying the dict immediately so the original is never modified.
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
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.
Summary
When
record.msgis a dict (used as a structured log message), theformat()method assigns it tomessage_dictby reference. Subsequent mutations tomessage_dict-- such as injectingexc_infoorstack_info-- leak into the caller's original dict, causing unexpected side effects.Reproduction
Fix
Use
record.msg.copy()instead of a direct reference, so the original dict remains untouched.Tests
All 135 existing tests pass.
(This contribution was made under my direction and I take full responsibility for its correctness.)