Document that BodyState.STOP may carry the final bytes#2255
Merged
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
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.
Motivation:
PR #2232 changed
MultipartBody.transferTo()to returnSTOPon the same call that writes the body's final bytes, meaningSTOPmay still be accompanied by unread data in the target buffer. However,BodyState.STOPis currently documented as meaning "nothing to read," andAuthenticatorUtils'sauth-intloop assumes this behavior, which would truncate such a body (currently unreachable because multipart bodies do not use this path).Modification:
Update the
Body.transferTo()andBodyState.STOPdocumentation to clarify thatSTOPmay accompany the final bytes and that consumers must drain the target buffer before stopping. Add a comment in theauth-intloop documenting its assumption.Result:
The
STOP-with-data contract is explicitly documented, and the existing assumption inAuthenticatorUtilsis clearly identified. Documentation only; no behavioral changes.