swift-server/swift-openapi-async-http-client
1
0
Fork 0
mirror of https://github.com/swift-server/swift-openapi-async-http-client.git synced 2026-05-03 07:42:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

Adopt the new shared HTTP client (#13)

Browse Source 
Adopt the new shared HTTP client

### Motivation

Now that SwiftNIO/AsyncHTTPClient have a singleton variant of the `EventLoopGroup`, which allows creating an `HTTPClient` without any argument, let's simplify the initializer of the transport to take advantage of it - bringing it in line with the URLSession transport.

### Modifications

Default the HTTPClient to a new one with a default event loop group, and remove the mandatory shutdown call.

### Result

Adopters can more easily create the AHC transport.

### Test Plan

N/A


Reviewed by: dnadoba, glbrntt

Builds:
     ✔︎ pull request validation (5.8) - Build finished. 
     ✔︎ pull request validation (5.9) - Build finished. 
     ✔︎ pull request validation (nightly) - Build finished. 
     ✔︎ pull request validation (soundness) - Build finished. 

https://github.com/swift-server/swift-openapi-async-http-client/pull/13
This commit is contained in:
Honza Dvorsky
2023-08-29 14:45:24 +02:00
committed by GitHub
parent 95bb2f8456
commit 91dfd35092
2 changed files with 11 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Sources/OpenAPIAsyncHTTPClient/AsyncHTTPClientTransport.swift
+9 -17
View File
@@ -30,23 +30,9 @@ import protocol Foundation.LocalizedError
///
/// ### Use the AsyncHTTPClient transport
///
/// Create the underlying HTTP client:
/// Instantiate the transport:
///
/// let httpClient = HTTPClient(eventLoopGroupProvider: .createNew)
///
/// Either store a reference to the client elsewhere and shut it down during
/// cleanup, or add a defer block if the client is only used in the current
/// scope:
///
/// defer {
/// try! httpClient.syncShutdown()
/// }
///
/// Instantiate the transport and provide the HTTP client to it:
///
/// let transport = AsyncHTTPClientTransport(
/// configuration: .init(client: httpClient)
/// )
/// let transport = AsyncHTTPClientTransport()
///
/// Create the base URL of the server to call using your client. If the server
/// URL was defined in the OpenAPI document, you find a generated method for it
@@ -68,6 +54,12 @@ import protocol Foundation.LocalizedError
///
/// let response = try await client.checkHealth(.init())
/// // ...
///
/// ### Provide a custom Client
///
/// The ``AsyncHTTPClientTransport/Configuration-swift.struct`` type allows you
/// to provide a custom `HTTPClient` and tweak behaviors such as the default
/// timeout.
public struct AsyncHTTPClientTransport: ClientTransport {
/// A set of configuration values for the AsyncHTTPClient transport.
@@ -83,7 +75,7 @@ public struct AsyncHTTPClientTransport: ClientTransport {
/// - Parameters:
/// - client: The underlying client used to perform HTTP operations.
/// - timeout: The request timeout, defaults to 1 minute.
public init(client: HTTPClient, timeout: TimeAmount = .minutes(1)) {
public init(client: HTTPClient = .init(), timeout: TimeAmount = .minutes(1)) {
self.client = client
self.timeout = timeout
}