[L-09] M3 Audit

[ericnordelo]

JSON-escapes custom type and member names before hashing and safely escapes generated debug output.

Summary by CodeRabbit

• Bug Fixes

  • Improved type-hash handling for names containing quotes, backslashes, braces, control characters, and null bytes.
  • Prevented malformed generated formatting output when special characters appear in type or member names.

• Tests

  • Added coverage for special-character escaping in struct names, member names, and enum variants.

[coderabbitai]

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 56dd5e89-6169-4064-ad84-c27edb508528

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

• 🔍 Trigger review

Walkthrough

Type-hash generation now JSON-escapes type and member names, including control characters. Debug output also escapes backslashes and braces. Unit and snapshot tests cover these cases.

Changes

Type-hash escaping

Layer / File(s)	Summary
JSON encoding for type-hash names packages/macros/src/attribute/type_hash/parser.rs, packages/macros/src/tests/test_type_hash.rs	Type and member names use JSON string encoding. Tests cover quotes, backslashes, control characters, null bytes, struct names, member names, and enum variants.
Generated debug output escaping packages/macros/src/attribute/type_hash/definition.rs	Debug type-hash strings now escape backslashes and braces before interpolation into generated Rust formatting code.

Estimated code review effort: 2 (Simple) | ~10 minutes

Poem

I’m a rabbit guarding names in code,
With escaped paths along the road.
Quotes and braces hop safely through,
Backslashes behave as rabbits do.
Tests shine bright in snapshots new.

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Title check	❓ Inconclusive	The title identifies an audit but does not describe the main change: adding JSON escaping for type and member names and generated debug output.	Use a specific title such as "Escape type-hash names and debug output".

✅ 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.
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.

✨ Finishing Touches

📝 Generate docstrings

• Create stacked PR
• Commit on current branch

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch fix/m3-audit-L-09

---

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

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

[immrsd]

@coderabbitai review

[coderabbitai]

✅ Action performed

Review finished.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

[immrsd]

LGTM