HDDS-15529: Switched minimum/maximum description in ContainerInfo.java javadoc for OPEN/CLOSED containers usedBytes#10580
Open
rnblough wants to merge 2 commits into
Open
HDDS-15529: Switched minimum/maximum description in ContainerInfo.java javadoc for OPEN/CLOSED containers usedBytes#10580rnblough wants to merge 2 commits into
rnblough wants to merge 2 commits into
Conversation
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.
What changes were proposed in this pull request?
The javadoc comments in ContainerInfo.java describes the usedBytes values being the opposite of the implementation in AbstractContainerReportHandler.java. This is literal and exact - ContainerInfo.java reports the maximum of values listed over OPEN container replicas and minimum of values over CLOSED container replicas; AbstractContainerReportHandler implements the opposite relationship in the actual values reported:
if (containerInfo.getState().equals(HddsProtos.LifeCycleState.OPEN)) {
// Open containers are generally growing in key count and size, the
// overall size should be the min of all reported replicas.
return Math.min(lastValue, thisValue);
} else {
// Containers which are not open can only shrink in size, so use the
// largest values reported.
return Math.max(lastValue, thisValue);
}
The fix is trivial - I swapped the words 'minimum' and 'maximum' in ContainerInfo.java in order to have the description match the implementation.
What is the link to the Apache JIRA
https://issues.apache.org/jira/browse/HDDS-15529
How was this patch tested?
Default branch build. Corrected a comment section, no operational impact.