Add request context capability mechanism to HTTPServer#166
Open
ehaydenr wants to merge 3 commits into
Open
Conversation
Introduce HTTPServerCapability namespace with a base RequestContext protocol, mirroring the client-side HTTPClientCapability.RequestOptions pattern. Servers declare a RequestContext associated type that handlers can constrain to require specific capabilities (e.g. connection info, peer certificates) at compile time.
guoye-zhang
approved these changes
May 21, 2026
guoye-zhang
reviewed
May 21, 2026
| public protocol HTTPServerRequestHandler<RequestReader, ResponseWriter>: Sendable { | ||
| public protocol HTTPServerRequestHandler<RequestContext, RequestReader, ResponseWriter>: Sendable { | ||
| /// The type of the request context provided by the server. | ||
| associatedtype RequestContext: HTTPServerCapability.RequestContext |
Collaborator
There was a problem hiding this comment.
You'll need to redeclare ~Copyable, ~Escapable requirements here
guoye-zhang
reviewed
May 21, 2026
| /// ``` | ||
| @available(macOS 26.2, iOS 26.2, watchOS 26.2, tvOS 26.2, visionOS 26.2, *) | ||
| public struct HTTPServerClosureRequestHandler< | ||
| RequestContext: HTTPServerCapability.RequestContext, |
Collaborator
There was a problem hiding this comment.
& ~Copyable & ~Escapable
| public struct HTTPRequestContext: Sendable { | ||
| /// The default request context for HTTP server implementations. | ||
| @available(macOS 26.2, iOS 26.2, watchOS 26.2, tvOS 26.2, visionOS 26.2, *) | ||
| public struct HTTPRequestContext: HTTPServerCapability.RequestContext { |
Collaborator
There was a problem hiding this comment.
This type should be moved to swift-http-server?
Contributor
Author
There was a problem hiding this comment.
Moved to HTTPServerForTesting
| /// incoming HTTP connections and process requests using a ``HTTPServerRequestHandler``. | ||
| public protocol HTTPServer<RequestConcludingReader, ResponseConcludingWriter>: Sendable, ~Copyable, ~Escapable { | ||
| public protocol HTTPServer<RequestContext, RequestConcludingReader, ResponseConcludingWriter>: Sendable, ~Copyable, ~Escapable { | ||
| associatedtype RequestContext: HTTPServerCapability.RequestContext |
Collaborator
There was a problem hiding this comment.
~Copyable, ~Escapable
- Add ~Copyable, ~Escapable constraints to RequestContext associated types in HTTPServer, HTTPServerRequestHandler, and HTTPServerClosureRequestHandler - Add consuming ownership to requestContext parameters - Move HTTPRequestContext concrete type out of HTTPAPIs into the test server module
# Conflicts: # Sources/HTTPAPIs/Server/HTTPServerRequestHandler.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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Introduce HTTPServerCapability namespace with a base RequestContext protocol, mirroring the client-side HTTPClientCapability.RequestOptions pattern. Servers declare a RequestContext associated type that handlers can constrain to require specific capabilities (e.g. connection info, peer certificates) at compile time.
Motivation
Clean up the client/server asymmetry. Afford the server APIs the same generic mechanism for requiring server capabilities.
Modifications
Added HTTPServerCapability.RequestContext protocol.
Result
Middleware and request handlers can now require server capabilities
Test Plan
Added a basic unit test to demonstrate the pattern.