-
Notifications
You must be signed in to change notification settings - Fork 14
Switch HTTPClient response handler from a closure to a protocol #158
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
guoye-zhang
wants to merge
2
commits into
apple:main
Choose a base branch
from
guoye-zhang:response-handler
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
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
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
34 changes: 34 additions & 0 deletions
34
Sources/HTTPAPIs/Client/HTTPClientClosureResponseHandler.swift
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| //===----------------------------------------------------------------------===// | ||
| // | ||
| // This source file is part of the Swift HTTP API Proposal open source project | ||
| // | ||
| // Copyright (c) 2026 Apple Inc. and the Swift HTTP API Proposal project authors | ||
| // Licensed under Apache License v2.0 | ||
| // | ||
| // See LICENSE.txt for license information | ||
| // | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
| // | ||
| //===----------------------------------------------------------------------===// | ||
|
|
||
| @available(macOS 26.2, iOS 26.2, watchOS 26.2, tvOS 26.2, visionOS 26.2, *) | ||
| public struct HTTPClientClosureResponseHandler<ResponseConcludingReader, Return: ~Copyable>: HTTPClientResponseHandler, ~Copyable | ||
| where | ||
| ResponseConcludingReader: ConcludingAsyncReader & ~Copyable & SendableMetatype, | ||
| ResponseConcludingReader.Underlying: ~Copyable, | ||
| ResponseConcludingReader.Underlying.ReadElement == UInt8, | ||
| ResponseConcludingReader.FinalElement == HTTPFields? | ||
| { | ||
| private let handler: (HTTPResponse, consuming ResponseConcludingReader) async throws -> Return | ||
|
|
||
| public init(handler: @escaping (HTTPResponse, consuming ResponseConcludingReader) async throws -> Return) { | ||
| self.handler = handler | ||
| } | ||
|
|
||
| public func handleInformational(response: HTTPResponse) async throws { | ||
| } | ||
|
|
||
| public func handle(response: HTTPResponse, responseBodyAndTrailers: consuming ResponseConcludingReader) async throws -> Return { | ||
| try await self.handler(response, responseBodyAndTrailers) | ||
| } | ||
| } |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| //===----------------------------------------------------------------------===// | ||
| // | ||
| // This source file is part of the Swift HTTP API Proposal open source project | ||
| // | ||
| // Copyright (c) 2026 Apple Inc. and the Swift HTTP API Proposal project authors | ||
| // Licensed under Apache License v2.0 | ||
| // | ||
| // See LICENSE.txt for license information | ||
| // | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
| // | ||
| //===----------------------------------------------------------------------===// | ||
|
|
||
| @available(macOS 26.2, iOS 26.2, watchOS 26.2, tvOS 26.2, visionOS 26.2, *) | ||
| public protocol HTTPClientResponseHandler: ~Copyable { | ||
| associatedtype ResponseConcludingReader: ConcludingAsyncReader, ~Copyable, SendableMetatype | ||
| where | ||
| ResponseConcludingReader.Underlying: ~Copyable, | ||
| ResponseConcludingReader.Underlying.ReadElement == UInt8, | ||
| ResponseConcludingReader.FinalElement == HTTPFields? | ||
| associatedtype Return: ~Copyable | ||
|
|
||
| func handleInformational(response: HTTPResponse) async throws | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. What do we expect a user to do in here? Is this just for them to observe it? Can they take any action on an informational response? |
||
|
|
||
| func handle(response: HTTPResponse, responseBodyAndTrailers: consuming ResponseConcludingReader) async throws -> Return | ||
| } | ||
46 changes: 46 additions & 0 deletions
46
Sources/HTTPAPIs/Client/HTTPClientTransformedResponseHandler.swift
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,46 @@ | ||
| //===----------------------------------------------------------------------===// | ||
| // | ||
| // This source file is part of the Swift HTTP API Proposal open source project | ||
| // | ||
| // Copyright (c) 2026 Apple Inc. and the Swift HTTP API Proposal project authors | ||
| // Licensed under Apache License v2.0 | ||
| // | ||
| // See LICENSE.txt for license information | ||
| // | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
| // | ||
| //===----------------------------------------------------------------------===// | ||
|
|
||
| @available(macOS 26.2, iOS 26.2, watchOS 26.2, tvOS 26.2, visionOS 26.2, *) | ||
| package struct HTTPClientTransformedResponseHandler<OtherHandler: HTTPClientResponseHandler & ~Copyable, ResponseConcludingReader>: | ||
| HTTPClientResponseHandler, ~Copyable | ||
| where | ||
| OtherHandler.ResponseConcludingReader: ~Copyable, | ||
| OtherHandler.ResponseConcludingReader.Underlying: ~Copyable, | ||
| OtherHandler.Return: ~Copyable, | ||
| ResponseConcludingReader: ConcludingAsyncReader & ~Copyable & SendableMetatype, | ||
| ResponseConcludingReader.Underlying: ~Copyable, | ||
| ResponseConcludingReader.Underlying.ReadElement == UInt8, | ||
| ResponseConcludingReader.FinalElement == HTTPFields? | ||
| { | ||
| package typealias Return = OtherHandler.Return | ||
|
|
||
| private let other: OtherHandler | ||
| private let transform: @Sendable (consuming ResponseConcludingReader) -> OtherHandler.ResponseConcludingReader | ||
|
|
||
| package init( | ||
| other: consuming OtherHandler, | ||
| transform: @escaping @Sendable (consuming ResponseConcludingReader) -> OtherHandler.ResponseConcludingReader | ||
| ) { | ||
| self.other = other | ||
| self.transform = transform | ||
| } | ||
|
|
||
| package func handleInformational(response: HTTPResponse) async throws { | ||
| try await self.other.handleInformational(response: response) | ||
| } | ||
|
|
||
| package func handle(response: HTTPResponse, responseBodyAndTrailers: consuming ResponseConcludingReader) async throws -> Return { | ||
| try await self.other.handle(response: response, responseBodyAndTrailers: self.transform(responseBodyAndTrailers)) | ||
| } | ||
| } |
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
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
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
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
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I was not able to get it to work with primary associated types due to
SuppressedAssociatedTypesWithDefaultsrequiring ~Copyable forResponseHandler.ResponseConcludingReader