Correctly set the value of decode.bytes to bytes used.#179
Open
ckcr4lyf wants to merge 4 commits into
Open
Conversation
There was a problem hiding this comment.
Pull request overview
This PR fixes bencode.decode.bytes to report the number of bytes actually consumed by decoding the first bencoded value (instead of the full input length), aligning behavior with the abstract-encoding contract and enabling correct offsetting into trailing binary data.
Changes:
- Update
lib/decode.jsto setdecode.bytesfromdecode.positionafter decoding completes. - Add a new test file to assert
decode.byteswith trailing data / multiple concatenated bencoded values.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
lib/decode.js |
Sets decode.bytes to the consumed-byte cursor (decode.position) after decode.next() runs. |
test/decode.length.test.js |
Adds tests asserting decode.bytes when extra data follows the decoded value. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| list: [1, 2, 3, 4, 'string', 5, {}] | ||
| } | ||
| const result = bencode.encode(someData) | ||
| bencode.decode(Buffer.from(result).toString() + 'RANDOM_JUNK_DATA') |
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.
What is the purpose of this pull request? (put an "X" next to item)
[ ] Documentation update
[X] Bug fix
[ ] New feature
[ ] Other, please explain:
What changes did you make? (Give an overview)
After decoding is complete, update the value of
decode.bytestodecode.positionto reflect the number of bytes usedWhich issue (if any) does this pull request address?
#178
Is there anything you'd like reviewers to focus on?
The original spec is here: https://github.com/mafintosh/abstract-encoding/ , the README for this project says it is "compatible", I would think this includes this property.
This might be slightly related / affect #61, since this strictly assumes we try and parse a single bencoded piece of data (e.g. two consecutive integers like
i123ei123eare technically separate).This PR becomes important when trying to bencode e.g. the response for a
ut_metadatarequest (https://www.rasterbar.com/products/libtorrent/extension_protocol.html) , since the bencoded data is immediately followed by the binary metadata piece, so returning the number of bytes consumed enables offsetting into the binary data accurately.A workaround I am using right now is to call
encodingLengthon the decoded data to determine how many bytes it would've been, but obviously this is wasteful.