fix(utils): use unshift in byteStream unwrap#3507
Merged
Merged
Conversation
Add a try-catch around sendData() in processSendQueue() to catch StreamStateError when the underlying transport closes between a drain event and the send attempt. This prevents the error from propagating as an uncaught exception. Also add a writeStatus guard in continueSendingOnDrain to skip processing when the stream has fully closed. Fixes libp2p#3415
Demonstrates that byteStream unwrap appends its buffered bytes after data already queued on the underlying stream, corrupting byte order.
# Conflicts: # packages/utils/src/abstract-message-stream.ts # packages/utils/test/stream-utils-test.spec.ts
push appends, so any bytes already buffered on the underlying stream end up ahead of the byteStream's older leftover bytes. unshift prepends and keeps the FIFO order.
tabcat
changed the title
dozyio
approved these changes
May 15, 2026
Merged
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
3 participants
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.
Description
byteStreamunwrap callsstream.push(readBuffer)which appends. If theunderlying stream's
readBufferis non-empty at unwrap time, thebyteStream's older leftover bytes end up after the newer ones, corrupting
the byte order seen by the next consumer.
This happens when:
dispatchReadBuffer()short-circuits andincoming bytes accumulate in
stream.readBufferinstead of reachingthe byteStream listener;
stream.push(...)and thenunwrap()on the sametick, since
pushdefers dispatch viasetTimeout.Switching to
stream.unshift(readBuffer)prepends, preserving FIFO order.Notes & open questions
The added test reproduces the paused-stream trigger deterministically.
The synchronous-
pushtrigger reduces to the same root cause and iscovered by the same fix.
Change checklist