Tolerate structural whitespace in EEBUS JSON#100
Open
kirollosnct wants to merge 1 commit into
Open
Conversation
JsonFromEEBUSJson unwraps the EEBUS array-of-single-key-objects encoding via exact byte-sequence replacements. Any RFC 8259 structural whitespace around JSON tokens defeated those matches, leaving the outer array intact so the downstream json.Unmarshal failed. Normalise the input with json.Compact before the replacements. Compact is string-aware, so whitespace inside string values is preserved; invalid JSON falls back to the raw bytes so behaviour is no worse than before. The NUL trim moves ahead of Compact since a trailing 0x00 is invalid JSON. Add whitespace-tolerance tests covering all four whitespace characters around structural tokens, whitespace inside string values, and a pretty-printed real datagram.
|
coverage: 93.032% (+0.04%) from 92.993% — fix/json-whitespace-tolerance into dev |
Comment on lines
+18
to
+21
| var compacted bytes.Buffer | ||
| if err := json.Compact(&compacted, data); err == nil { | ||
| data = compacted.Bytes() | ||
| } |
Contributor
There was a problem hiding this comment.
if err != nil (i.e. if the input is not valid JSON), should we just return data here without running the replacements first?
I guess it doesn't really matter since we'll throw an error when unmarshalling anyway but it might be nice to have a comment here describing what happens if/when Compact fails.
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
3 participants
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.
JsonFromEEBUSJson unwraps the EEBUS array-of-single-key-objects encoding via exact byte-sequence replacements. Any RFC 8259 structural whitespace around JSON tokens defeated those matches, leaving the outer array intact so the downstream json.Unmarshal failed.
Normalise the input with json.Compact before the replacements. Compact is string-aware, so whitespace inside string values is preserved; invalid JSON falls back to the raw bytes so behaviour is no worse than before. The NUL trim moves ahead of Compact since a trailing 0x00 is invalid JSON.
Add whitespace-tolerance tests covering all four whitespace characters around structural tokens, whitespace inside string values, and a pretty-printed real datagram.
Fixes #97.