fix: validate string lengths before allocation and body reads

[jinzhongjia]

Summary by CodeRabbit

• Bug Fixes

  • Improved memory cleanup for deeply nested and complex payloads, including arrays, maps, strings, binary data, and extensions.
  • Cleanup now completes reliably when memory allocation fails, helping prevent leaks during error handling and parser failures.

• Documentation

  • Added security architecture guidance describing allocation-free payload cleanup under exhausted allocator conditions.
  • Updated the corresponding Chinese documentation.

[coderabbitai]

Warning

Review limit reached

Next included review available in 46 minutes.

Check out review usage here.

View limit details

Limit details: You’ve used the included review currently available.

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

Learn how review limits work.

Review configuration:

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Advanced

Run ID: 3ed682ef-0f7c-4a7f-a214-391e3aa2cd96

📥 Commits

Reviewing files that changed from the base of the PR and between 62336f8 and e6b2492.

📒 Files selected for processing (4)

• README.md
• README_CN.md
• src/msgpack.zig
• src/test.zig

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Advanced

Run ID: e9ebe29b-5ff3-4766-8c8d-5421e0ac40fc

📥 Commits

Reviewing files that changed from the base of the PR and between 6d9ef09 and 62336f8.

📒 Files selected for processing (4)

• README.md
• README_CN.md
• src/msgpack.zig
• src/test.zig

Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review.

---

📝 Walkthrough

Walkthrough

Payload.free now uses an intrusive, allocation-free worklist to clean nested arrays and maps iteratively. Tests cover deep and wide payloads under simulated out-of-memory conditions, including parser cleanup. English and Chinese documentation describe this behavior.

Changes

Payload cleanup

Layer / File(s)	Summary
Intrusive payload cleanup src/msgpack.zig, README.md, README_CN.md	Payload.free traverses nested arrays and maps without recursion or auxiliary allocation. The documentation records this behavior.
Out-of-memory cleanup validation src/test.zig	Tests verify cleanup for deeply nested payloads, wide arrays, maps with container keys, and parser failures after a completed wide child.

Priority: ➖ Normal

Estimated code review effort: 3 (Moderate) | ~25 minutes

Change: Bug fix

Merge Risk: ⚪ Minimal · up to 62336

No merge-blocking behavior issue is identified from the available evidence.

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Title check	⚠️ Warning	The title describes string-length validation before allocation and body reads, but the changes add an allocation-free iterative implementation of Payload.free and OOM cleanup tests. The title is unr…	Replace the title with a concise description of the Payload.free iterative, allocation-free cleanup implementation and its out-of-memory cleanup tests.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

Full details: Title check

Explanation

The title describes string-length validation before allocation and body reads, but the changes add an allocation-free iterative implementation of Payload.free and OOM cleanup tests. The title is unrelated to the main changes.

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch fix/validate-string-length-before-allocation

Warning

Git: CodeRabbit could not clone the repository, so clone-backed analysis was skipped and this review may be incomplete. Verify repository clone access, such as SSH credentials, before requesting another full review. If clone access is intentionally unavailable, use path_filters to narrow the review scope.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}