fix(binarycodec): propagate error from write_length_encoded instead of panicking - #343
Open
e-desouza wants to merge 2 commits into
Open
fix(binarycodec): propagate error from write_length_encoded instead of panicking#343e-desouza wants to merge 2 commits into
e-desouza wants to merge 2 commits into
Conversation
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #343 +/- ##
==========================================
+ Coverage 86.71% 86.73% +0.01%
==========================================
Files 252 252
Lines 32630 32645 +15
==========================================
+ Hits 28296 28314 +18
+ Misses 4334 4331 -3
Flags with carried forward coverage won't be shown. Click here to find out more.
🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
Pull request overview
This PR fixes a panic in the XRPL binary codec serializer by making VL-length encoding (write_length_encoded) return an error when the input exceeds MAX_LENGTH_VALUE rather than calling unwrap() and panicking. This improves robustness when serializing large variable-length fields and aligns behavior with XRPLCoreResult-based error handling across the codec.
Changes:
- Changed
Serialization::{write_length_encoded, write_field_and_value}to returnXRPLCoreResult<&Self>and propagated errors via?instead of panicking. - Updated downstream call site(s) to use
?for propagation and updated doc examples tounwrap()in doctest context. - Added a regression test ensuring oversized VL values return
InvalidVariableLengthTooLargeinstead of panicking.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| src/core/binarycodec/types/mod.rs | Propagates write_field_and_value failures from STObject serialization using ?. |
| src/core/binarycodec/binary_wrappers.rs | Makes length-encoded writes fallible (Result), replaces unwrap() with ?, updates tests/docs, and adds regression coverage for oversized inputs. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
445
to
453
| let mut byte_object: Vec<u8> = Vec::new(); | ||
| if encode_value { | ||
| // write value to byte_object | ||
| byte_object.extend_from_slice(value); | ||
| } | ||
| // TODO Handle unwrap better | ||
| let length_prefix = _encode_variable_length_prefix(&byte_object.len()).unwrap(); | ||
| let length_prefix = _encode_variable_length_prefix(&byte_object.len())?; | ||
|
|
||
| self.extend_from_slice(&length_prefix); | ||
| self.extend_from_slice(&byte_object); |
Comment on lines
388
to
392
| /// let mut test_bytes: Vec<u8> = [0, 17, 34].to_vec(); | ||
| /// let mut serializer: BinarySerializer = BinarySerializer::new(); | ||
| /// | ||
| /// serializer.write_length_encoded(&mut test_bytes, true); | ||
| /// serializer.write_length_encoded(&mut test_bytes, true).unwrap(); | ||
| /// assert_eq!(expected, serializer); |
…f unwrap (#268) Replace the `.unwrap()` on `_encode_variable_length_prefix` in `write_length_encoded` with `?`, changing the return type from `&Self` to `XRPLCoreResult<&Self>`. Propagate the Result through `write_field_and_value` and its call site in `STObject::try_from_value`. Adds a regression test that asserts an `Err` is returned when the value length exceeds `MAX_LENGTH_VALUE` (918744 bytes) rather than panicking at runtime.
…ngth_encoded Compute the length prefix directly from value.len() instead of copying into an intermediate Vec<u8> first. write value straight into self when encode_value is true, removing one allocation and one copy per call. Also drop the unnecessary mut binding and &mut borrow in the doc example — the method signature takes &[u8] and never mutates the input.
e-desouza
force-pushed
the
fix/issue-268-serializer-unwrap
branch
from
July 15, 2026 16:41
4bdcf7b to
214f7d5
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why
BinarySerializer::write_length_encodedreturned&Self(infallible) and called_encode_variable_length_prefix(...).unwrap(). When a caller serialized a VL-encoded field larger thanMAX_LENGTH_VALUE(918,744 bytes), this panicked instead of returning an error. The method contained a// TODO Handle unwrap bettercomment acknowledging the gap.Fixes #268.
What changed
write_length_encodedandwrite_field_and_valuesignatures changed from-> &Selfto-> XRPLCoreResult<&Self>..unwrap()replaced with?; callers updated to propagate with?..unwrap()in the example context.How to validate
Regression test
test_write_length_encoded_too_large_returns_errorverifiesErr(InvalidVariableLengthTooLarge { max: 918744 })is returned instead of a panic.Note:
Serializationis apubtrait; this is a breaking API change. Downstream crates implementing the trait must update their signatures. Recommend a version bump.