test(protocol): correct the decode-bounds header on where the envelope is verified (LAB-3479) - #151
Conversation
…e is verified (LAB-3479) The header claimed cachekit-core already verifies the ByteStorage envelope against decode-bounds.json. It did not: core ByteStorage::retrieve had no pre-scan. cachekit-io/cachekit-core#80 adds it and runs the vectors in core CI; this repo's pinned core 0.6.0 does not carry it, so unpack gains the guard on the core bump. Comment-only.
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:
|
|
Navigate logical layers of code changes, visualize relationships, and explore their blast radius. Warning Review limit reachedNext included review available in 48 minutes. View limit detailsLimit 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. Review configuration: ⚙️ Run configurationConfiguration used: Repository: cachekit-io/cachekit-ts/.coderabbit.yaml Review profile: ASSERTIVE Plan: Advanced Run ID: 📒 Files selected for processing (1)
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Repository: cachekit-io/cachekit-ts/.coderabbit.yaml Review profile: ASSERTIVE Plan: Advanced Run ID: 📒 Files selected for processing (1)
Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review. WalkthroughThe test documentation now states that the pinned ChangesTest documentation
Priority: ⬇️ Low Estimated code review effort: 1 (Trivial) | ~2 minutes Change: Other Merge Risk: ⚪ Minimal · up to This PR only clarifies test documentation and does not change runtime behavior or dependency versions, so it is ready to merge. Architecture SummaryArchitecture risk: 🔵 Low · up to The change affects 1 system. Changed systems: Architecture concerns Review detailsSystems and components
Before / after behavior
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
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 |
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
Core runs decode-bounds.json 1.1.0, newer than the copy vendored here. Comment-only.
222afe1
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:
|
Summary
This PR corrects a documentation comment in the header of
packages/cachekit/test/protocol/decode-bounds.protocol.test.ts. There are no code, test logic, or public API changes.What changed
The old header said the ByteStorage envelope "is verified against the same vectors" in cachekit-core. That was inaccurate. The new header states:
unpackbinding or wasm. It is not decoded in this package.ByteStorage::retrieveand runs the decode-bounds vectors through it in core CI.unpackgets the guard only when the pin moves to a core release that includes it.Scope and impact
unpack(NAPI) and the wasm path are named in the comment only as references.b75adac4).Note on wording
The existing PR description says both
unpack(NAPI) and the wasm path gain the guard after the pin update. The updated comment only saysunpackgains the guard; it mentions wasm only as a way to reach the Rust decoder. Aligning the two may be worthwhile if the wasm path is also expected to pick up the pre-scan.Related
ByteStorage::retrieveThis PR corrects a single header comment in
packages/cachekit/test/protocol/decode-bounds.protocol.test.ts. There are no functional, test-logic, or public API changes.The comment previously said that cachekit-core#80 runs "these vectors" through the envelope pre-scan in core CI. That implied core CI uses the same decode-bounds vectors vendored in this repository.
The revised wording says core CI instead runs the protocol's
decode-bounds.jsonversion 1.1.0 throughByteStorage::retrieve. That version is newer than the copy vendored here.The rest of the header is unchanged:
unpack/ wasm).unpackgains the guard only when the pin moves to a core release that includes it.Summary by CodeRabbit
unpack. This protection will be available when the dependency is updated to a release that contains it. No behavior changes are included in this update.