Document InputStream ownership#1361
Merged
Merged
Conversation
Clarify that JSON parsing closes input streams. Test closure after successful and failed parsing.
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
1 participant
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.
Document that
Json.parse(InputStream)andJson.tryParse(InputStream)close the supplied stream, including when parsing fails.Add close-tracking JVM tests covering successful and failed parsing.
Background Context
#1277 lets Jackson create the parser internally. Jackson closes that parser after every outcome and, with its default configuration, also closes the underlying input stream.
The previous test used
ByteArrayInputStream, whoseclose()method has no observable effect. A close-tracking stream now verifies the documented lifecycle explicitly.This also aligns the documented JVM behavior with the existing Scala.js and Scala Native implementations.