Handle multi-byte decode errors in as_string/as_bytes#1721
Open
krrishapatel wants to merge 1 commit into
Open
Conversation
When tail -f reads an initial chunk from a log file, the byte boundary can split a multi-byte UTF-8 character (e.g. Korean). This causes the entire chunk to decode incorrectly. Add errors='replace' to encode/decode calls in compat.py so that incomplete byte sequences produce the Unicode replacement character instead of corrupting the rest of the output.
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.
Summary
When
tail -freads an initial chunk from a log file, the byte boundary can split a multi-byte UTF-8 character (e.g. Korean, Chinese, Japanese). This causesas_string()to either raiseUnicodeDecodeErroror corrupt the entire chunk.Adding
errors='replace'to theencode()/decode()calls incompat.pyensures that only the truncated character at the boundary shows as�, while the rest of the text decodes correctly.Fixes #1693
Changes
supervisor/compat.py: Adderrors='replace'to all encode/decode calls (both Python 2 and 3 branches)supervisor/tests/test_compat.py: New test file covering valid UTF-8, Korean text, and incomplete byte sequences