Fixed a resource leak in PackedAtlasSerializer #215
Merged
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
matthieun
approved these changes
Sep 13, 2018
There was a problem hiding this comment.
@lucaspcram This testing makes me jealous! Really nice! Thanks!
MikeGost
reviewed
Sep 13, 2018
| */ | ||
| private static class TraceableByteArrayResource extends AbstractWritableResource | ||
| { | ||
| private static final Logger logger = LoggerFactory.getLogger(ByteArrayResource.class); |
There was a problem hiding this comment.
Should this be TraceableByteArrayResource.class here?
There was a problem hiding this comment.
Indeed it should... Correcting it in another PR. We don't want logs being misdirected.
| TraceableByteArrayResource() | ||
| { | ||
| this.array = new ByteArray(Long.MAX_VALUE); | ||
| this.array.setName("ByteArrayResource"); |
There was a problem hiding this comment.
Here it technically should but I don't think it matters, since it's just metadata. But your nit above definitely matters. Correcting that now. I'll correct this too because why not.
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.
Description:
Previously, the
determineAtlasLoadFormatmethod would cause a resource leak when it failed to get the format correct on the first try. This was becausedetermineAtlasLoadFormattried reading the atlas metadata, but then failed fast and did not close the resource it used to read that metadata. This has been remedied by adding a try-with-resources to thedeserializeSingleFieldmethod, which gets called in all cases of metadata deserialization. The resource will now be closed properly even on failures.Potential Impact:
This has no downstream performance or API impacts.
Unit Test Approach:
The test
testResourceClosureOnInvalidLoadFormathas been added toPackedAtlasSerializerTest. It confirms that the correct number of resource closures occurs.Test Results:
Unit test now passes.
In doubt: Contributing Guidelines