Structured JSON error envelope + status propagation to scripts/pipe by notxvilka · Pull Request #6578 · rizinorg/rizin

notxvilka · 2026-06-29T15:09:39Z

Your checklist for this pull request

I've read the guidelines for contributing to this repository.
I made sure to follow the project's coding style.
I've documented every RZ_API function and struct this PR changes.
I've added tests that prove my changes are effective (required for changes to RZ_API).
I've updated the Rizin book with the relevant information (if needed).
I've used AI tools to generate fully or partially these code changes and I'm sure the changes are not copyrighted by somebody else.

Detailed description

Largely mechanistic change of adding an envelope and optionally reporting status for JSON commands, covering the A1 of the "AI issue" - machine detectable errors: #6543

Test plan

Ci is green

Closing issues

Partially addresses #6543

codecov · 2026-06-29T16:25:21Z

Codecov Report

❌ Patch coverage is 72.32143% with 31 lines in your changes missing coverage. Please review.
✅ Project coverage is 49.94%. Comparing base (155ead6) to head (3166169).

Files with missing lines	Patch %	Lines
librz/core/cmd/cmd_api.c	66.15%	17 Missing and 5 partials ⚠️
librz/core/cmd/cmd.c	73.91%	4 Missing and 2 partials ⚠️
librz/core/cmd_descs/cmd_descs.c	50.00%	0 Missing and 2 partials ⚠️
librz/main/rizin.c	94.11%	0 Missing and 1 partial ⚠️

Additional details and impacted files

Files with missing lines	Coverage Δ
librz/core/cconfig.c	`80.29% <100.00%> (+0.01%)`	⬆️
librz/core/core.c	`60.56% <100.00%> (+0.02%)`	⬆️
librz/include/rz_cmd.h	`71.42% <ø> (ø)`
librz/main/rizin.c	`50.05% <94.11%> (+0.25%)`	⬆️
librz/core/cmd_descs/cmd_descs.c	`50.63% <50.00%> (-0.01%)`	⬇️
librz/core/cmd/cmd.c	`64.95% <73.91%> (+0.09%)`	⬆️
librz/core/cmd/cmd_api.c	`67.92% <66.15%> (-0.12%)`	⬇️

... and 8 files with indirect coverage changes

Continue to review full report in Codecov by Harness.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 155ead6...3166169. Read the comment docs.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

* Add the `rz_cmd_status_tostring` API that maps an `RzCmdStatus` to a stable, machine-readable string (`OK`, `WRONG_ARGS`, `ERROR`, `INVALID`, `NONEXISTINGCMD`, `EXIT`). * Record the status of every executed command in a new `RzCore.last_cmd_status` field, so consumers driving Rizin can read back whether the command that just ran succeeded or failed. Co-authored-by agent: Claude/claude-opus-4-8

* Turn the root `_` (last output) command into a "Last command introspection" group and add a `_s`/`_sj` subcommand that prints the status of the previously executed command from `RzCore.last_cmd_status`. * `_s` prints the stable status code while `_sj` reports it as a JSON object together with the integer code from `rz_cmd_status2int`, so an agent driving Rizin over rzpipe can query success or failure explicitly. Co-authored-by agent: Claude/claude-opus-4-8

When a command is invoked in a JSON output mode and the `cfg.json.status` config is enabled, emit a machine-readable status object on stdout after the command's own output, so a consumer driving Rizin over rzpipe or `rizin -c` can reliably tell success from failure (and a failure from an empty-but-successful result). The envelope is reported consistently for every command, so the trailing object is always present and only its `error` field changes: `{"error":null}` on success and `{"error":{"code":"WRONG_ARGS","message":"...","command":"afl"}}` on failure. * Gate the behavior behind the new `cfg.json.status` config (default `false`). Reporting the envelope for every JSON command changes their output, so keeping it opt-in preserves the current behavior while letting agents enable structured status reporting. * The error object reuses `rz_cmd_status_tostring` for the stable `code` and reports the canonical command name without the mode suffix. Co-authored-by agent: Claude/claude-opus-4-8

Optionally make `rizin -q`/`-c`/`-i` exit with a non-zero process code when a command fails, so that shells and CI can detect errors instead of always seeing a successful exit. * Gate the behavior behind the new `cfg.exit.errorcode` config (default `false`) to preserve the historical behavior of always exiting with 0 in batch mode. * `run_commands` now reports whether any executed command returned a failing status (non-OK and non-EXIT); the process exit code is set to 1 from that result only when the config is enabled. A `q`/quit request is treated as success. Co-authored-by agent: Claude/claude-opus-4-8

Rot127

Just those nitpicks I found on a second look.

Rot127 · 2026-07-16T14:57:36Z

+		pj_ko(pj, "error");
+		pj_ks(pj, "code", rz_cmd_status_tostring(status));
+		pj_ks(pj, "message", cmd_status_message(status));
+		pj_ks(pj, "command", cmd_name);


Also adding the arguments here would be helpful. Because one of the errors is "wring arguments".

Rot127 · 2026-07-16T14:58:50Z

 	core->vmode = false;
 	core->lastcmd = NULL;
 	core->cmdlog = NULL;
+	core->last_cmd_status = RZ_CMD_STATUS_OK;


Suggested change

core->last_cmd_status = RZ_CMD_STATUS_OK;

core->last_cmd_status = RZ_CMD_STATUS_INVALID;

Or not? Because there was no command which ran before. So it is not in a valid state.

Rot127 · 2026-07-16T15:00:08Z

 		}
 		if (ret < 0 || (ret == 0 && quiet)) {
 			rz_cons_flush();
 			return false;


had_error is not updated here and above

Rot127 · 2026-07-16T15:03:09Z

+NAME=batch exit code zero on successful command
+FILE==
+ARGS=-e cfg.exit.errorcode=true
+CMDS=s 0
+EXPECT=
+RUN
+
+NAME=batch exit code zero on quit
+FILE==
+ARGS=-e cfg.exit.errorcode=true
+CMDS=q
+EXPECT=
+RUN


Better make EXIT_STATUS=0 explicit

notxvilka added this to the 1.0.0 milestone Jun 29, 2026

notxvilka requested review from Rot127, b1llow, kazarmy, ret2libc, thestr4ng3r and wargio as code owners June 29, 2026 15:09

github-actions Bot added rizin rz-test API RzCore AI/LLM Partially or fully AI generated. Critical thinking is advised! labels Jun 29, 2026

wargio reviewed Jun 29, 2026

View reviewed changes

Comment thread test/db/cmd/cmd_error_reporting

Rot127 requested changes Jun 29, 2026

View reviewed changes

Comment thread librz/core/cmd/cmd.c Outdated

Comment thread librz/core/cconfig.c Outdated

Comment thread librz/main/rizin.c Outdated

Comment thread librz/main/rizin.c Outdated

notxvilka force-pushed the asan-error-envelope branch from e9101a2 to 0bd1e7d Compare June 30, 2026 14:08

notxvilka requested review from Rot127 and wargio June 30, 2026 14:09

notxvilka mentioned this pull request Jun 30, 2026

Fix memory leaks across arch, core, and util #6581

Merged

6 tasks

notxvilka force-pushed the asan-error-envelope branch from 0bd1e7d to d5656e6 Compare July 2, 2026 03:28

notxvilka mentioned this pull request Jul 2, 2026

Fix memory leaks in arch and core #6590

Merged

6 tasks

notxvilka force-pushed the asan-error-envelope branch from d5656e6 to 08eef46 Compare July 4, 2026 05:37

notxvilka mentioned this pull request Jul 4, 2026

Fix memory leaks in bin, type parser, core meta and debug #6594

Merged

6 tasks

notxvilka force-pushed the asan-error-envelope branch from 08eef46 to 4d6ff66 Compare July 4, 2026 18:57

notxvilka mentioned this pull request Jul 5, 2026

Fix memory leaks in the dmi command's module lookup #6598

Open

6 tasks

XVilka added 4 commits July 5, 2026 23:45

notxvilka force-pushed the asan-error-envelope branch from 4d6ff66 to 3166169 Compare July 5, 2026 19:46

Rot127 requested changes Jul 16, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Structured JSON error envelope + status propagation to scripts/pipe #6578

Structured JSON error envelope + status propagation to scripts/pipe #6578
notxvilka wants to merge 4 commits into
devfrom
asan-error-envelope

notxvilka commented Jun 29, 2026

Uh oh!

Uh oh!

codecov Bot commented Jun 29, 2026 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Rot127 left a comment

Uh oh!

Rot127 Jul 16, 2026

Uh oh!

Rot127 Jul 16, 2026

Uh oh!

Rot127 Jul 16, 2026

Uh oh!

Rot127 Jul 16, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

	core->last_cmd_status = RZ_CMD_STATUS_OK;
	core->last_cmd_status = RZ_CMD_STATUS_INVALID;

Uh oh!

Uh oh!

Conversation

notxvilka commented Jun 29, 2026

Uh oh!

Uh oh!

codecov Bot commented Jun 29, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Rot127 left a comment

Choose a reason for hiding this comment

Uh oh!

Rot127 Jul 16, 2026

Choose a reason for hiding this comment

Uh oh!

Rot127 Jul 16, 2026

Choose a reason for hiding this comment

Uh oh!

Rot127 Jul 16, 2026

Choose a reason for hiding this comment

Uh oh!

Rot127 Jul 16, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

codecov Bot commented Jun 29, 2026 •

edited

Loading