Repository navigation
docs(integrity): xxHash3-64 checksum covers the payload only, not format (LAB-4212) - #456
Conversation
…mat (LAB-4212) rust-serialization.md now names the digest's input (the uncompressed payload) and states that the envelope's format field sits outside it, pointing to the Deserialization failed entry for how AutoSerializer validates format. Two comments and one test docstring no longer call format_id verified. No behaviour change.
|
Warning Review limit reachedYou've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository. Next included review available in 59 minutes. View limit detailsLimit details: You’ve used the included review currently available. Review configuration: ⚙️ Run configurationConfiguration used: Repository: cachekit-io/cachekit-py/.coderabbit.yaml Review profile: ASSERTIVE Plan: Advanced Run ID: 📒 Files selected for processing (3)
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. Comment |
Code Review Completed! 🔥The code review was successfully completed based on your current configurations. Kody Guide: Usage and ConfigurationInteracting with Kody
Providing Context (Files & MCPs)Add these hints in your PR description (or a comment) to unlock deeper checks:
Current Kody ConfigurationReview OptionsThe following review options are enabled or disabled:
|
…AB-4212) The xxHash3-64 section now says which values carry the envelope checksum: integrity-off values carry none, and the NumPy and Arrow routes use their own prefix. The format sentence now states what AutoSerializer accepts and links what still gets through. Comment and docstring wording trimmed. No behaviour change.
Code Review Completed! 🔥The code review was successfully completed based on your current configurations. Kody Guide: Usage and ConfigurationInteracting with Kody
Providing Context (Files & MCPs)Add these hints in your PR description (or a comment) to unlock deeper checks:
Current Kody ConfigurationReview OptionsThe following review options are enabled or disabled:
|
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
Documents what the ByteStorage xxHash3-64 checksum actually covers: the uncompressed payload only. The envelope's
formatfield sits outside the digest. Docs and comments only; no behaviour change.docs/features/rust-serialization.md› "xxHash3-64 Integrity": names the digest's input, states thatformatis outside it (a rottedformatpasses the checksum), and points to Deserialization failed indocs/error-codes.mdfor howAutoSerializervalidatesformatinstead.auto_serializer.py: two comments no longer call the envelope'sformat_id"verified"; they now say the checksum does not cover it, matching thedeserializedocstring ("NEITHER copy is verified").tests/unit/test_auto_serializer_mutation_and_corruption.py: a class docstring reworded the same way.Remaining hits of
grep -rn -i -E "verified[^.]{0,20}format" src/cachekit/serializers/ tests/unit/test_auto_serializer_mutation_and_corruption.py:src/cachekit/serializers/auto_serializer.py:871— "failed to decode inside a verified envelope (format=…)". "Verified" attaches to the envelope, whose payload passed the checksum. Accurate; kept.make quick-checkpasses locally.Closes LAB-4212