fix: close streams in LoggerContextAdmin.setConfigLocationUri#4218
Open
SebTardif wants to merge 2 commits into
Open
fix: close streams in LoggerContextAdmin.setConfigLocationUri#4218SebTardif wants to merge 2 commits into
SebTardif wants to merge 2 commits into
Conversation
ConfigurationSource(InputStream, File/URL) leaves stream ownership with the caller. Buffer configuration bytes into a Source-backed ConfigurationSource and close the FileInputStream/URL stream before ConfigurationFactory runs so failed or successful JMX reconfigure paths do not leak descriptors. Signed-off-by: Sebastien Tardif <sebtardif@ncf.ca>
Signed-off-by: Sebastien Tardif <sebtardif@ncf.ca>
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.
What Problem This Solves
LoggerContextAdmin.setConfigLocationUriopened aFileInputStreamor URL stream and passed it toConfigurationSource(InputStream, File/URL). That constructor documents that the caller owns the stream. On some failure paths before the configuration parser closes the stream, the descriptor can leak. Same theme as the ConfigurationSource URL leak work in #4127.Evidence
Failure scenario
Fix
Buffer the configuration into memory with try-with-resources, then construct a
ConfigurationSource(Source, byte[], lastModified)that owns aByteArrayInputStream.Red-green / tests
Result: 3 tests pass (valid file reconfigure,
file:URL form, blank rejection).Summary
setConfigLocationUriLoggerContextAdminSetConfigLocationUriTest