Don't close the multipart sink when a part closes its stream - #9659
Open
iVamsi wants to merge 6 commits into
Open
Don't close the multipart sink when a part closes its stream#9659iVamsi wants to merge 6 commits into
iVamsi wants to merge 6 commits into
Conversation
Collaborator
|
This seems like it fixes a very specific variant of this bug, but not the whole class of bug. |
iVamsi
changed the title
Contributor
Author
|
@JakeWharton Yeah, gzip was just one body that closed the sink. Moved the fix to MultipartBody. |
JakeWharton
approved these changes
Aug 14, 2026
JakeWharton
left a comment
JakeWharton
left a comment
Collaborator
There was a problem hiding this comment.
Just some small tweaks
Comment on lines
+165
to
+170
| object : ForwardingSink(sink) { | ||
| override fun close() { | ||
| // GzipSink.close() writes the gzip footer, then closes whatever it wraps. | ||
| // Swallow that close so we can write the trailing CRLF and later parts. | ||
| } | ||
| }.buffer().use(body::writeTo) |
Collaborator
There was a problem hiding this comment.
Suggested change
| object : ForwardingSink(sink) { | |
| override fun close() { | |
| // GzipSink.close() writes the gzip footer, then closes whatever it wraps. | |
| // Swallow that close so we can write the trailing CRLF and later parts. | |
| } | |
| }.buffer().use(body::writeTo) | |
| class NoCloseSink(sink: Sink) : ForwardingSink(sink) { | |
| override fun close() {} | |
| } | |
| body.writeTo(NoCloseSink(sink).buffer()) |
Collaborator
There was a problem hiding this comment.
The use is pointless here, because it guarantees a close() call which we're already going out of our way to suppress.
Contributor
Author
There was a problem hiding this comment.
.buffer() adds a RealBufferedSink on top of NoCloseSink. .use closes it so the last segment is flushed. NoCloseSink.close() is still a no-op.
Without .use, 9 of 14 MultipartBodyTest tests failed.
| open fun contentLength(): Long = -1L | ||
|
|
||
| /** Writes the content of this request to [sink]. */ | ||
| /** Writes the content of this request to [sink]. This must not close [sink]. */ |
Collaborator
There was a problem hiding this comment.
Suggested change
| /** Writes the content of this request to [sink]. This must not close [sink]. */ | |
| /** Writes the content of this request to [sink]. This should not close [sink]. */ |
Either we guarantee this by crashing, or we relax the wording precisely because we are handling close appropriately.
Comment on lines
+293
to
+298
| assertThat(body.boundary).isEqualTo("123") | ||
| assertThat(body.type).isEqualTo(MultipartBody.MIXED) | ||
| assertThat(body.contentType().toString()) | ||
| .isEqualTo("multipart/mixed; boundary=123") | ||
| assertThat(body.parts.size).isEqualTo(2) | ||
| assertThat(body.contentLength()).isEqualTo(-1) |
Collaborator
There was a problem hiding this comment.
Suggested change
| assertThat(body.boundary).isEqualTo("123") | |
| assertThat(body.type).isEqualTo(MultipartBody.MIXED) | |
| assertThat(body.contentType().toString()) | |
| .isEqualTo("multipart/mixed; boundary=123") | |
| assertThat(body.parts.size).isEqualTo(2) | |
| assertThat(body.contentLength()).isEqualTo(-1) |
This is other test problems
Comment on lines
+316
to
+321
| assertThat(body.boundary).isEqualTo("123") | ||
| assertThat(body.type).isEqualTo(MultipartBody.MIXED) | ||
| assertThat(body.contentType().toString()) | ||
| .isEqualTo("multipart/mixed; boundary=123") | ||
| assertThat(body.parts.size).isEqualTo(2) | ||
| assertThat(body.contentLength()).isEqualTo(-1) |
Collaborator
There was a problem hiding this comment.
Suggested change
| assertThat(body.boundary).isEqualTo("123") | |
| assertThat(body.type).isEqualTo(MultipartBody.MIXED) | |
| assertThat(body.contentType().toString()) | |
| .isEqualTo("multipart/mixed; boundary=123") | |
| assertThat(body.parts.size).isEqualTo(2) | |
| assertThat(body.contentLength()).isEqualTo(-1) |
Other test problems
Comment on lines
+330
to
+345
| MultipartReader(boundary = "123", source = buffer).use { reader -> | ||
| val part1 = reader.nextPart()!! | ||
| val part1Body = | ||
| GzipSource(part1.body).use { | ||
| it.buffer().readUtf8() | ||
| } | ||
| assertThat(part1Body).isEqualTo("part1") | ||
|
|
||
| val part2 = reader.nextPart()!! | ||
| val part2Body = | ||
| GzipSource(part2.body).use { | ||
| it.buffer().readUtf8() | ||
| } | ||
| assertThat(part2Body).isEqualTo("part2") | ||
| assertThat(reader.nextPart()).isNull() | ||
| } |
Collaborator
There was a problem hiding this comment.
I would rather see this all replaced with a readUtf8() like the above test. We don't care about parsing, we care that the entire request was written.
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
2 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.
A request body closing its sink was also closing the stream that OkHttp was still writing to. In a multipart request, that meant the next part (or even the bytes after the first part) failed with IllegalStateException: closed.
The part still needs to finish its stream. This change lets it do that without closing the stream MultipartBody was handed.
Fixes #7692.