Repository navigation
fix(cpp): escape control characters in tsfile-cli table output - #974
Merged
ColinLeeo merged 2 commits intoOct 8, 2026
Merged
Conversation
The readable 'table' format emitted string cells verbatim, so an embedded newline split one logical record across multiple physical lines and other control characters rendered invisibly. Downstream line-based consumers then misparsed the output with no error. Render backslash, newline, carriage return and tab as the two-character literals \\, \n, \r and \t, and every other non-printable control byte (C0 controls plus DEL) as \uXXXX. CSV and NDJSON output are unchanged. Add unit coverage for the new table_escape() helper (named controls, unicode escapes, DEL boundary, UTF-8 passthrough, column alignment) and a CLI end-to-end test asserting exact table/csv/ndjson output for cells that embed control characters.
Contributor
There was a problem hiding this comment.
🟢 Approval recommended
The implementation is focused, consistent with the stated behavior, and covered by unit and end-to-end tests.
0 open findings
What changed in this PR
Escapes control bytes in human-readable C++ CLI table output while preserving CSV and NDJSON behavior.
Changes:
- Adds
table_escape()and applies it to table cells and headers. - Updates column-width calculations for escaped content.
- Adds unit and end-to-end coverage for controls, UTF-8, and alignment.
| File | Description |
|---|---|
cpp/tools/format/output_format.h |
Declares table_escape(). |
cpp/tools/format/output_format.cc |
Implements and applies table escaping. |
cpp/test/tools/output_format_test.cc |
Tests escaping and alignment. |
cpp/test/tools/model_format_e2e_test.cc |
Verifies exact CLI output formats. |
cpp/test/tools/cli_test_util.h |
Adds a control-character fixture. |
🧠 Review effort: Balanced
Give feedback about Copilot approvals in this survey to enter a drawing for a $150 gift card.
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.
The readable 'table' format emitted string cells verbatim, so an embedded newline split one logical record across multiple physical lines and other control characters rendered invisibly. Downstream line-based consumers then misparsed the output with no error.
Render backslash, newline, carriage return and tab as the two-character literals \, \n, \r and \t, and every other non-printable control byte (C0 controls plus DEL) as \uXXXX. CSV and NDJSON output are unchanged.
Add unit coverage for the new table_escape() helper (named controls, unicode escapes, DEL boundary, UTF-8 passthrough, column alignment) and a CLI end-to-end test asserting exact table/csv/ndjson output for cells that embed control characters.