feat: consistent response format for hackney 3.x#822
Merged
Conversation
This is a breaking change that makes HTTP response handling consistent
across all protocols (HTTP/1.1, HTTP/2, HTTP/3).
Changes:
- Body is now always returned directly: {ok, Status, Headers, Body}
- The with_body option is deprecated and ignored
- Added HTTP/2 async request support
- Deprecated body/1, body/2, stream_body/1 functions
- Updated documentation and migration guide
- Updated all tests to work with the new API
Breaking changes:
- {ok, S, H, Pid} = hackney:get(URL) -> {ok, S, H, Body} = hackney:get(URL)
- hackney:body(Pid) no longer needed - body is in response
- For incremental streaming, use async mode instead of stream_body/1
These functions are no longer needed since body is now always returned
directly in the response tuple {ok, Status, Headers, Body}.
For incremental streaming, use async mode instead:
{ok, Ref} = hackney:get(URL, [], <<>>, [async]),
receive {hackney_response, Ref, {status, S, _}} -> ... end.
Functions removed:
- body/1, body/2: Body is now in response tuple
- stream_body/1: Use async mode for streaming
- skip_body/1: No longer needed when body auto-returns
Add HTTP/3 handler for peername operation in hackney_conn.erl. When h3_conn is defined, delegates to hackney_quic:peername/1 to retrieve the peer address for QUIC connections.
Add HTTP/3 handler for sockname operation in hackney_conn.erl. When h3_conn is defined, delegates to hackney_quic:sockname/1 to retrieve the local socket address for QUIC connections.
Add HTTP/3 handler for peercert operation in hackney_conn.erl.
Returns {error, not_supported} since QUIC/HTTP3 does not expose
the peer certificate through this API.
Add HTTP/3 handler for setopts operation in hackney_conn.erl. When h3_conn is defined, delegates to hackney_quic:setopts/2 to set socket options for QUIC connections.
Breaking changes: - Response body returned directly in tuple for all protocols - Removed deprecated body/1, body/2, stream_body/1, skip_body/1 - Auth headers stripped on cross-host redirects (CVE-2018-1000007) See guides/MIGRATION.md for upgrade instructions.
- Add "Manual Connection Management" section to http_guide.md covering hackney:connect, hackney:send_request, and hackney:close - Document protocol detection with hackney_conn:get_protocol - Include comparison table for HTTP/1.1 vs HTTP/2 behavior - Update http2_guide.md to use hackney:send_request instead of hackney_conn:request for consistency
- Update Mix dependency example to ~> 3.0 in README.md and GETTING_STARTED.md - Update design.md title to reflect current version - Update TODO.md to show completed 2.0 roadmap items
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.
Summary
{ok, Status, Headers, Body}with_bodyoption (always behaves aswith_body = true)body/1,body/2,skip_body/1,stream_body/1Breaking Changes
{ok, S, H, Pid} = hackney:get(URL){ok, S, H, Body} = hackney:get(URL){ok, Body} = hackney:body(Pid)with_bodyoptionstream_body/1for incremental readsMigration
Before (2.x):
{ok, 200, Headers, Pid} = hackney:get(URL), {ok, Body} = hackney:body(Pid).After (3.x):
{ok, 200, Headers, Body} = hackney:get(URL).For streaming (async mode):
{ok, Ref} = hackney:get(URL, [], <<>>, [async]), receive {hackney_response, Ref, {status, 200, _}} -> ok end, receive {hackney_response, Ref, {headers, Headers}} -> ok end, receive {hackney_response, Ref, Chunk} -> process(Chunk) end.