Add support for swift-service-lifecycle #55
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| //===----------------------------------------------------------------------===// | ||
| // | ||
| // This source file is part of the Swift HTTP Server open source project | ||
| // | ||
| // Copyright (c) 2026 Apple Inc. and the Swift HTTP Server project authors | ||
| // Licensed under Apache License v2.0 | ||
| // | ||
| // See LICENSE.txt for license information | ||
| // See CONTRIBUTORS.txt for the list of Swift HTTP Server project authors | ||
| // | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
| // | ||
| //===----------------------------------------------------------------------===// | ||
|
|
||
| /// A protocol for HTTP servers that support graceful shutdown. | ||
| public protocol GracefulShutdownService { | ||
| /// Initiates graceful shutdown of the HTTP server. | ||
| func beginGracefulShutdown() | ||
| } |
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 Server open source project | ||
| // | ||
| // Copyright (c) 2026 Apple Inc. and the Swift HTTP Server project authors | ||
| // Licensed under Apache License v2.0 | ||
| // | ||
| // See LICENSE.txt for license information | ||
| // See CONTRIBUTORS.txt for the list of Swift HTTP Server project authors | ||
| // | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
| // | ||
| //===----------------------------------------------------------------------===// | ||
|
|
||
| #if ServiceLifecycle | ||
| public import AsyncStreaming | ||
| public import HTTPTypes | ||
|
|
||
| @available(macOS 26.0, iOS 26.0, watchOS 26.0, tvOS 26.0, visionOS 26.0, *) | ||
| extension HTTPService | ||
| where | ||
| Handler == HTTPServerClosureRequestHandler< | ||
| Server.RequestReader, | ||
| Server.RequestReader.Underlying, | ||
| Server.ResponseWriter, | ||
| Server.ResponseWriter.Underlying | ||
| > | ||
| { | ||
| /// - Parameters: | ||
| /// - server: The underlying HTTPServer instance. | ||
| /// - serverHandler: The request handler closure. | ||
| public init( | ||
| server: Server, | ||
| serverHandler: | ||
| nonisolated(nonsending) @Sendable @escaping ( | ||
| _ request: HTTPRequest, | ||
| _ requestContext: HTTPRequestContext, | ||
| _ requestBodyAndTrailers: consuming sending Server.RequestReader, | ||
| _ responseSender: consuming sending HTTPResponseSender<Server.ResponseWriter> | ||
| ) async throws -> Void | ||
| ) { | ||
| self.server = server | ||
| self.serverHandler = HTTPServerClosureRequestHandler(handler: serverHandler) | ||
| } | ||
| } | ||
| #endif // ServiceLifecycle |
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,55 @@ | ||
| //===----------------------------------------------------------------------===// | ||
| // | ||
| // This source file is part of the Swift HTTP Server open source project | ||
| // | ||
| // Copyright (c) 2026 Apple Inc. and the Swift HTTP Server project authors | ||
| // Licensed under Apache License v2.0 | ||
| // | ||
| // See LICENSE.txt for license information | ||
| // See CONTRIBUTORS.txt for the list of Swift HTTP Server project authors | ||
| // | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
| // | ||
| //===----------------------------------------------------------------------===// | ||
|
|
||
| #if ServiceLifecycle | ||
| public import ServiceLifecycle | ||
|
|
||
| /// A wrapper over HTTPServer that integrates with ServiceLifecycle. | ||
| @available(macOS 26.0, iOS 26.0, watchOS 26.0, tvOS 26.0, visionOS 26.0, *) | ||
| public struct HTTPService< | ||
| Server: HTTPServer & GracefulShutdownService, | ||
| Handler: HTTPServerRequestHandler | ||
| >: Service | ||
| where | ||
| Server.RequestReader == Handler.RequestReader, | ||
| Server.ResponseWriter == Handler.ResponseWriter | ||
| { | ||
| let server: Server | ||
| let serverHandler: Handler | ||
|
|
||
| /// - Parameters: | ||
| /// - server: The underlying HTTPServer instance. | ||
| /// - serverHandler: The request handler that `server` will use. | ||
| public init( | ||
| server: Server, | ||
| serverHandler: Handler, | ||
| onGracefulShutdown gracefulShutdownHandler: @Sendable @escaping () -> Void = {} | ||
|
||
| ) { | ||
| self.server = server | ||
| self.serverHandler = serverHandler | ||
| } | ||
|
|
||
| /// Runs the HTTP server and handles graceful shutdown when signaled. | ||
| public func run() async throws { | ||
| try await withGracefulShutdownHandler( | ||
| operation: { | ||
| try await self.server.serve(handler: self.serverHandler) | ||
| }, | ||
| onGracefulShutdown: { | ||
| self.server.beginGracefulShutdown() | ||
| } | ||
| ) | ||
| } | ||
| } | ||
| #endif // ServiceLifecycle | ||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| //===----------------------------------------------------------------------===// | ||
| // | ||
| // This source file is part of the Swift HTTP Server open source project | ||
| // | ||
| // Copyright (c) 2026 Apple Inc. and the Swift HTTP Server project authors | ||
| // Licensed under Apache License v2.0 | ||
| // | ||
| // See LICENSE.txt for license information | ||
| // See CONTRIBUTORS.txt for the list of Swift HTTP Server project authors | ||
| // | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
| // | ||
| //===----------------------------------------------------------------------===// | ||
|
|
||
| #if ServiceLifecycle | ||
| public import HTTPServer | ||
| import HTTPTypes | ||
| import Logging | ||
| import NIOExtras | ||
|
|
||
| @available(macOS 26.0, iOS 26.0, watchOS 26.0, tvOS 26.0, visionOS 26.0, *) | ||
| extension NIOHTTPServer: GracefulShutdownService { | ||
| /// Initiates graceful shutdown of the HTTP server. | ||
| public func beginGracefulShutdown() { | ||
| self.close() | ||
| self.serverQuiescingHelper.initiateShutdown(promise: nil) | ||
| } | ||
| } | ||
| #endif // ServiceLifecycle |
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.
It'd be nice if we could also enable the ServiceLifecycle trait by default.
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.
The
ServiceLifecycletrait is now no longer needed;NIOHTTPServerdepends onswift-service-lifecycleby default.