Document Basic auth header caching, guard against stale copies#2286
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
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.
Motivation:
#2267 introduced
Realm.getBasicAuthHeader()to cache the computed HTTP Basic authorization header on immutableRealminstances. Two follow-ups remained: its Javadoc did not clarify that it always generates a Basic header regardless of the configuredAuthScheme, and there was no test verifying that the cached header is scoped to eachRealminstance rather than shared across instances.Modification:
Update the
Realm.getBasicAuthHeader()Javadoc to explicitly document that it always encodes credentials as a Basic authorization header, regardless of the configured scheme. Add a test verifying that two distinctRealminstances with identical credentials produce equal but distinct cached header instances.Result:
The behavior of
Realm.getBasicAuthHeader()is now explicitly documented, and its per-instance caching is protected by a regression test against accidental cache sharing.