Commit 91dfd35

authored

Adopt the new shared HTTP client (#13)

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. #13

1 parent 95bb2f8 commit 91dfd35Copy full SHA for 91dfd35

File tree

2 files changed

+11

-19

lines changed

Package.swift
Sources/OpenAPIAsyncHTTPClient
- AsyncHTTPClientTransport.swift

2 files changed

+11

-19

lines changed

`‎Package.swift`

Lines changed: 2 additions & 2 deletions

Original file line number	Diff line number	Diff line change
`@@ -38,8 +38,8 @@ let package = Package(`
`38`	`38`	`),`
`39`	`39`	`],`
`40`	`40`	`dependencies: [`
`41`		`- .package(url: "https://github.com/apple/swift-nio", from: "2.51.0"),`
`42`		`- .package(url: "https://github.com/swift-server/async-http-client.git", from: "1.17.0"),`
	`41`	`+ .package(url: "https://github.com/apple/swift-nio", from: "2.58.0"),`
	`42`	`+ .package(url: "https://github.com/swift-server/async-http-client.git", from: "1.19.0"),`
`43`	`43`	`.package(url: "https://github.com/apple/swift-openapi-runtime", .upToNextMinor(from: "0.1.3")),`
`44`	`44`	`.package(url: "https://github.com/apple/swift-docc-plugin", from: "1.0.0"),`
`45`	`45`	`],`

`‎Sources/OpenAPIAsyncHTTPClient/AsyncHTTPClientTransport.swift`

Lines changed: 9 additions & 17 deletions

Original file line number	Diff line number	Diff line change
`@@ -30,23 +30,9 @@ import protocol Foundation.LocalizedError`
`30`	`30`	`///`
`31`	`31`	`/// ### Use the AsyncHTTPClient transport`
`32`	`32`	`///`
`33`		`-/// Create the underlying HTTP client:`
	`33`	`+/// Instantiate the transport:`
`34`	`34`	`///`
`35`		`-/// let httpClient = HTTPClient(eventLoopGroupProvider: .createNew)`
`36`		`-///`
`37`		`-/// Either store a reference to the client elsewhere and shut it down during`
`38`		`-/// cleanup, or add a defer block if the client is only used in the current`
`39`		`-/// scope:`
`40`		`-///`
`41`		`-/// defer {`
`42`		`-/// try! httpClient.syncShutdown()`
`43`		`-/// }`
`44`		`-///`
`45`		`-/// Instantiate the transport and provide the HTTP client to it:`
`46`		`-///`
`47`		`-/// let transport = AsyncHTTPClientTransport(`
`48`		`-/// configuration: .init(client: httpClient)`
`49`		`-/// )`
	`35`	`+/// let transport = AsyncHTTPClientTransport()`
`50`	`36`	`///`
`51`	`37`	`/// Create the base URL of the server to call using your client. If the server`
`52`	`38`	`/// URL was defined in the OpenAPI document, you find a generated method for it`
`@@ -68,6 +54,12 @@ import protocol Foundation.LocalizedError`
`68`	`54`	`///`
`69`	`55`	`/// let response = try await client.checkHealth(.init())`
`70`	`56`	`/// // ...`
	`57`	`+///`
	`58`	`+/// ### Provide a custom Client`
	`59`	`+///`
	`60`	+/// The ``AsyncHTTPClientTransport/Configuration-swift.struct`` type allows you
	`61`	+/// to provide a custom `HTTPClient` and tweak behaviors such as the default
	`62`	`+/// timeout.`
`71`	`63`	`public struct AsyncHTTPClientTransport: ClientTransport {`
`72`	`64`
`73`	`65`	`/// A set of configuration values for the AsyncHTTPClient transport.`
`@@ -83,7 +75,7 @@ public struct AsyncHTTPClientTransport: ClientTransport {`
`83`	`75`	`/// - Parameters:`
`84`	`76`	`/// - client: The underlying client used to perform HTTP operations.`
`85`	`77`	`/// - timeout: The request timeout, defaults to 1 minute.`
`86`		`- public init(client: HTTPClient, timeout: TimeAmount = .minutes(1)) {`
	`78`	`+ public init(client: HTTPClient=.init(), timeout: TimeAmount = .minutes(1)) {`
`87`	`79`	`self.client = client`
`88`	`80`	`self.timeout = timeout`
`89`	`81`	`}`

0 commit comments

Comments

(0)

Navigation Menu

Search code, repositories, users, issues, pull requests...

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Commit 91dfd35

File tree

2 files changed

2 files changed

`‎Package.swift`

`‎Sources/OpenAPIAsyncHTTPClient/AsyncHTTPClientTransport.swift`

0 commit comments