bugfix: Fix eventstream partial read #3165
Merged
Conversation
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
…eamIterator Previously, readAndHashBytes() assumed that a single call to $stream->read($num) would return the full payload length. However, PSR-7 allows partial reads, and this behavior occurs in practice with non-seekable streams (e.g., cURL). This caused CRC mismatches and truncated payloads in streamed responses, especially for large final chunks, such as those returned by Bedrock's RetrieveAndGenerateStream API. This change updates readAndHashBytes() to read in a loop until all expected bytes are received or EOF is reached, ensuring proper CRC calculation and full payload integrity.
wilsones-berkeley
changed the title
- Add mocked events with proper headers and payload in order to test events that carry checksum calculation and make sure the whole processing works as expected.
Contributor
|
Hi @wilsones-berkeley, thank you so much for this contribution. The fix you have proposed is totally valid! |
yenfryherrerafeliz
approved these changes
Nov 28, 2025
stobrien89
requested changes
Nov 29, 2025
Member
stobrien89
left a comment
stobrien89
left a comment
There was a problem hiding this comment.
Just one test change requested, and some new files needing a newline appended. Otherwise looks good!
tests/Api/Parser/NonSeekableStreamDecodingEventStreamIteratorTest.php
Outdated
Show resolved
Hide resolved
Co-authored-by: Sean O'Brien <[email protected]>
stobrien89
approved these changes
Dec 1, 2025
Member
stobrien89
left a comment
stobrien89
left a comment
There was a problem hiding this comment.
Still seeing the newline warnings I commented on before. Otherwise, looks good- thanks for the contribution @wilsones-berkeley!
yenfryherrerafeliz
force-pushed
the
fix-eventstream-partial-read
branch
from
38e5362 to
a6839ac
Compare
Contributor
|
Running integ tets: Running smoke tests: |
Add empty lines at the end of file.
yenfryherrerafeliz
force-pushed
the
fix-eventstream-partial-read
branch
from
a6839ac to
4150dd3
Compare
1 task
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 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.
Issue #, if available
#3110
Description of changes:
This pull request fixes a bug in
NonSeekableStreamDecodingEventStreamIteratorwherereadAndHashBytes()assumed that the underlying stream would always return the full number of requested bytes in a singleread() call.In cases where the stream returns fewer bytes (e.g., partial reads from network streams or large payloads), this could result in truncated payloads and CRC mismatches.
The fix updates
readAndHashBytes()to:A new unit test
testReadAndHashBytesHandlesPartialReadshas been added to verify this behavior by simulating a non-seekable stream that returns partial data in eachread()call.All tests pass with
make test.By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.