feat: expose immutable Headers map view - #900
Open
sylvesterkaczmarek wants to merge 2 commits into
Open
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.
Summary
Expose the SDK's existing immutable header representation as
Headers.asMap()and document the value guarantees ofHeaders.values(...).Addresses the header-conversion portion of #664.
Problem
Custom
HttpClientimplementations commonly need to adapt SDK headers into another HTTP library. Today that requires a two-step traversal:Internally,
Headersalready stores exactly the desiredMap<String, List<String>>, with case-insensitive name lookup and immutable value lists. The public API does not expose that representation directly.The issue discussion also notes an undocumented guarantee: names returned by
names()always have at least one value, whilevalues(name)returns an empty list only for an absent header.Change
Add:
asMap()returns the same immutable, case-insensitive representation held by theHeadersinstance. It does not copy or flatten multi-valued headers.Also document the
values(name)absent/present behaviour.Regression coverage
Added focused tests verifying that the returned map:
Scope
Headers.kt: 13 additionsValidation
The branch is based on current upstream
mainat81134d727946fb84cc48db98e6c8c53c8a8d22aband is 0 commits behind upstream.Risk
Low. This is an additive API over the immutable data structure already stored by
Headers; existing behaviour is unchanged.