Repository navigation
fix(ui): emit parseable layout JSON for malformed UTF-8 - #2913
Conversation
The layout writer now combines YYJSON_WRITE_ALLOW_INVALID_UNICODE with YYJSON_WRITE_ESCAPE_UNICODE, replacing malformed bytes with escaped U+FFFD characters and escaping valid non-ASCII text. A regression test checks strict parsing, replacement characters, valid Unicode round trips, and escaping alongside quotes, backslashes, and newlines. It also covers empty layouts, optional fields, and non-finite numeric values. Fixes DeusData#2907 Signed-off-by: Matt Van Horn <[email protected]>
|
Thanks for opening this — it has been seen, and it is queued. This note is automated, but it is not a brush-off: it exists so you know where your PR stands instead of having to guess from silence. Current review status: working through a backlog. What that means for this PR, concretely:
Things that will genuinely speed it up whenever review does happen:
If this fixes a bug, a reproduction we can run is worth more than a description of the symptom. Thanks for contributing, and sorry in advance for the wait. |
Rewrap the yyjson_mut_write_opts call in cbm_layout_to_json to the repository clang-format style. Whitespace only; the generated code is unchanged. Signed-off-by: Martin Vogel <[email protected]>
Signed-off-by: Martin Vogel <[email protected]>
|
Thank you, Matt - this is a really nice fix. You found the exact mismatch: the layout writer let malformed UTF-8 through with ALLOW_INVALID_UNICODE, and handle_layout then re-read that same string with a strict parser, so a single badly encoded heading was enough to turn the whole Galaxy/Architecture request into "JSON parse failed". Pairing ALLOW_INVALID_UNICODE with ESCAPE_UNICODE is the documented yyjson way to get U+FFFD instead of raw bytes, and it is the smallest change that makes the writer and the reader agree. We checked it against every class of broken input we could think of (lone continuation bytes, truncated 2/3/4-byte sequences, overlong forms including an overlong NUL, UTF-16 surrogates and CESU-8 pairs, code points above U+10FFFF, 5- and 6-byte forms, 0xFE/0xFF) and pushed each one through the same steps handle_layout takes. All of them now come back as strict, valid JSON with U+FFFD in place of the bad bytes, while valid text (accents, CJK, emoji, U+10FFFF, BOM, U+2028/2029) still decodes byte for byte and the final /api/layout body is unchanged for valid input. Your new test fails on main at the strict re-read and passes with your change, so it really pins the bug - and covering quotes, backslashes and newlines right next to the bad bytes, plus the empty layout and NaN/Inf cases, is exactly the kind of coverage that keeps this from coming back. We pushed two small commits on top of your branch:
Nothing else changed. If you push to this branch again, please pull first so these commits are not lost. Thanks again for the careful work - we will merge as soon as CI is green on the new head. |
|
Merged - thank you very much, Matt! Galaxy and Architecture now get strict, valid JSON from /api/layout even when a heading or label contains malformed UTF-8: the bad bytes come back as U+FFFD instead of failing the whole request. Thanks again for the precise diagnosis and the thorough test. |
|
Appreciate the quick merge, @DeusData. With malformed UTF-8 now escaped to U+FFFD, the layout JSON should parse cleanly again and Galaxy and Architecture can draw the graph. |
What does this PR do?
Galaxy and Architecture can fail to draw the graph when layout text contains malformed UTF-8. The layout request returns HTTP 500 with "JSON parse failed". cbm_layout_to_json allowed invalid Unicode, which copied malformed UTF-8 bytes into its output. handle_layout then parsed that output with strict yyjson_read settings and rejected it.
The layout writer now combines YYJSON_WRITE_ALLOW_INVALID_UNICODE with YYJSON_WRITE_ESCAPE_UNICODE, replacing malformed bytes with escaped U+FFFD characters and escaping valid non-ASCII text. A regression test checks strict parsing, replacement characters, valid Unicode round trips, and escaping alongside quotes, backslashes, and newlines. It also covers empty layouts, optional fields, and non-finite numeric values.
Ran
./scripts/test.shlocally on macOS; it was still building the grammar objects when it hit its 599 second time limit, so it reported no test result.Lint (
scripts/lint.sh,scripts/ci/lint-mem.sh) was not run locally.I did not run the new test against the unfixed writer, so this PR does not yet show it failing on the base branch.
Fixes #2907
Checklist
git commit -s) — required, CI rejectsunsigned commits (DCO, see CONTRIBUTING.md)
make -f Makefile.cbm test)make -f Makefile.cbm lint-ci)AI was used for assistance.