fix(log): simplify JSON log serialization for invalid UTF-8#61166
Draft
joshtrichards wants to merge 1 commit into
Draft
fix(log): simplify JSON log serialization for invalid UTF-8#61166joshtrichards wants to merge 1 commit into
joshtrichards wants to merge 1 commit into
Conversation
Signed-off-by: Josh <josh.t.richards@gmail.com>
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
Make
LogDetails::logDetailsAsJSON()best-effort and deterministic by lettingjson_encode()handle malformed UTF-8 directly.Instead of probing strings and attempting to guess their original encoding with
mb_detect_encoding()/mb_convert_encoding(), this change:JSON_INVALID_UTF8_SUBSTITUTEto sanitize invalid byte sequencesJSON_PARTIAL_OUTPUT_ON_ERRORas a defensive fallback for loggingWhy
This code path is used for logging, so the priority is to emit usable JSON rather than fail or spend extra work trying to recover the original encoding (which can't be done reliably anyhow - so this is a more "honest" implementation).
The implementation is simpler and should be faster in both the common case (valid UTF-8) and the less common case (invalid UTF-8) by avoiding per-field encoding checks and encoding detection/conversion.
Notes
Checklist
3. to review, feature component)stable32)AI (if applicable)