Avoid double counting in stats out when writing to nested streams
#204
Conversation
This file contains 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
nhz2
commented
Apr 6, 2024
| changemode!(stream, :write) | ||
| if marginsize(stream.buffer1) == 0 && flushbuffer(stream) == 0 | ||
| return 0 |
There was a problem hiding this comment.
write will throw an error instead of returning 0 on failure.
nhz2
commented
Apr 7, 2024
src/stream.jl
Outdated
| buffer1 = stream.buffer1 | ||
| p = input | ||
| p_end = p + nbytes | ||
| while p < p_end && (marginsize(buffer1) > 0 || flushbuffer(stream) > 0) | ||
| while p < p_end | ||
| marginsize(buffer1) > 0 || flush_buffer1(stream) |
There was a problem hiding this comment.
flush_buffer1 must empty buffer1 or error, so this loop should make progress.
nhz2
commented
Apr 7, 2024
| @@ -595,9 +595,12 @@ function stats(stream::TranscodingStream) | |||
| out = transcoded_out - buffersize(buffer1) | |||
| elseif mode === :write | |||
| transcoded_in = buffer1.transcoded | |||
| transcoded_out = buffer2.transcoded | |||
There was a problem hiding this comment.
buffer2 is "owned" by the underlying stream if it is shared, so this stream shouldn't rely on buffer2.transcoding being the expected value.
|
@reallyasi9 Thank you for updating ZipStreams.jl for this fix. I'll merge this PR sometime next week unless there are other concerns. |
mkitti
approved these changes
May 28, 2024
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.
Here is an example of the bug this PR fixes:
Before this PR this would output 12 even though only 6 bytes were written to the underlying stream.