BaseEncoding: Make encodingStream().close() idempotent#8183
Open
nickita-khylkouski wants to merge 1 commit intogoogle:masterfrom
Open
BaseEncoding: Make encodingStream().close() idempotent#8183nickita-khylkouski wants to merge 1 commit intogoogle:masterfrom
nickita-khylkouski wants to merge 1 commit intogoogle:masterfrom
Conversation
The OutputStream returned by encodingStream() violated the Closeable.close() contract: calling close() multiple times would write additional encoded data to the underlying Writer. This adds a boolean closed field and synchronized methods to track stream state, making close() idempotent and causing write()/flush() to throw IOException after close. Fixes google#5284
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.
Summary
boolean closedfield to theOutputStreamreturned byencodingStream()write(),flush(), andclose()synchronizedper @cpovirk's guidanceclose()returns early if already closed (idempotent)write()/flush()throwIOExceptionafter close, matchingAppendableWriterandCharSequenceReaderpatternsMotivation
BaseEncoding.encodingStream().close()violates theCloseable.close()contract which states: "If the stream is already closed then invoking this method has no effect."Calling
close()twice writes additional encoded data to the underlying Writer:This is problematic because double-close is common due to try-with-resources blocks and wrapping streams that close their underlying streams.
Fixes #5284
Testing
BaseEncodingTest:testEncodingStreamCloseIsIdempotent— verifies close() twice doesn't change outputtestEncodingStreamWriteAfterClose— verifies write() throws IOException after closetestEncodingStreamFlushAfterClose— verifies flush() throws IOException after closeBaseEncodingTestpass (./mvnw test -pl guava-tests -Dtest=BaseEncodingTest)IOExceptiontoReflectionFreeAssertThrowsto support the new test assertions