Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix halt_error to print message without prefix in raw mode (fix #1902) #2632

Merged
merged 2 commits into from
Jun 26, 2023
Merged

Fix halt_error to print message without prefix in raw mode (fix #1902) #2632

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
afdc922
Fix halt_error to print message without prefix (fix #1902)
itchyny Jun 26, 2023
d7839de
Fix halt_error to output the message in raw mode as documented
itchyny Jun 26, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions src/main.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -216,12 +216,14 @@ static int process(jq_state *jq, jv value, int flags, int dumpopts) {
jv_free(exit_code);
jv error_message = jq_get_error_message(jq);
if (jv_get_kind(error_message) == JV_KIND_STRING) {
fprintf(stderr, "jq: error: %s", jv_string_value(error_message));
// No prefix should be added to the output of `halt_error`.
fwrite(jv_string_value(error_message), 1,
jv_string_length_bytes(jv_copy(error_message)), stderr);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess we don't leak the jv copy here as jv_string_length_bytes free/unref? I will have to read up on how the ownership works for the jv type and functions, eg why does jv_string_value not free/unref?

} else if (jv_get_kind(error_message) == JV_KIND_NULL) {
// Halt with no output
} else if (jv_is_valid(error_message)) {
error_message = jv_dump_string(jv_copy(error_message), 0);
fprintf(stderr, "jq: error: %s\n", jv_string_value(error_message));
fprintf(stderr, "%s\n", jv_string_value(error_message));
} // else no message on stderr; use --debug-trace to see a message
fflush(stderr);
jv_free(error_message);
Expand Down
12 changes: 10 additions & 2 deletions tests/shtest
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -275,11 +275,19 @@ if [ -n "$($VALGRIND $Q $JQ -n 'halt_error(1)' 2>&1)" ]; then
echo "jq halt_error(1) had unexpected output" 1>&2
exit 1
fi
if [ -n "$($VALGRIND $Q $JQ -n '"xyz\n"|halt_error(1)' 2>/dev/null)" ]; then
if [ -n "$($VALGRIND $Q $JQ -n '"xyz\n" | halt_error(1)' 2>/dev/null)" ]; then
echo "jq halt_error(1) had unexpected output on stdout" 1>&2
exit 1
fi
if [ "$($VALGRIND $Q $JQ -n '"xyz\n"|halt_error(1)' 2>&1)" != "jq: error: xyz" ]; then
if [ "$($VALGRIND $Q $JQ -n '"xy" | halt_error(1)' 2>&1 || echo "z")" != "xyz" ]; then
echo "jq halt_error(1) had unexpected output" 1>&2
exit 1
fi
if [ "$($VALGRIND $Q $JQ -n '"x\u0000y\u0000z" | halt_error(1)' 2>&1 | tr '\0' '.')" != "x.y.z" ]; then
echo "jq halt_error(1) had unexpected output" 1>&2
exit 1
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems linux build is not happy about this:

+ /home/runner/work/jq/jq/tests/../jq -n halt_error(1)
+ [ 1 -ne 1 ]
+ /home/runner/work/jq/jq/tests/../jq -n halt_error(11)
+ [ 11 -ne 11 ]
+ /home/runner/work/jq/jq/tests/../jq -n halt_error(1)
+ [ -n  ]
+ /home/runner/work/jq/jq/tests/../jq -n "xyz\n" | halt_error(1)
+ [ -n  ]
+ /home/runner/work/jq/jq/tests/../jq -n "xy" | halt_error(1)
+ echo z
+ [ xyz != xyz ]
+ /home/runner/work/jq/jq/tests/../jq -n "x\u0000y\u0000z" | halt_error(1)
+ printf x\x00y\x00z
+ [ xyz != x\x00y\x00z ]
+ echo jq halt_error(1) had unexpected output
jq halt_error(1) had unexpected output
+ exit 1

Hmm zero bytes gone from LHS value? shell doing something?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, NUL bytes are trimmed in command substitution.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Aha, any idea why macOS build was fine?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

bash is old. It passes if Bash is 3.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 that explains things, great work!

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If necessary, \0 can be used instead of \x00. That would work in any version bash or POSIX-compliant shell.

fi
if [ "$($VALGRIND $Q $JQ -n '{"a":"xyz"} | halt_error(1)' 2>&1)" != '{"a":"xyz"}' ]; then
echo "jq halt_error(1) had unexpected output" 1>&2
exit 1
fi
Expand Down