add a future-returning shutdown method (#626)

Co-authored-by: Johannes Weiss <johannes@jweiss.io>

Author: weissi

Sources/AsyncHTTPClient/AsyncAwait/HTTPClient+shutdown.swift

@@ -12,6 +12,8 @@
 //
 //===----------------------------------------------------------------------===//
 
+import NIOCore
+
 #if compiler(>=5.5.2) && canImport(_Concurrency)
 
 extension HTTPClient {

Sources/AsyncHTTPClient/HTTPClient.swift

@@ -213,6 +213,28 @@ public class HTTPClient {
     }
     #endif
 
+    /// Shuts down the ``HTTPClient`` and releases its resources.
+    ///
+    /// - note: You cannot use this method if you sharted the ``HTTPClient`` with
+    ///         ``init(eventLoopGroupProvider: .createNew)`` because that will shut down the ``EventLoopGroup`` the
+    ///         returned future would run in.
+    public func shutdown() -> EventLoopFuture<Void> {
+        switch self.eventLoopGroupProvider {
+        case .shared(let group):
+            let promise = group.any().makePromise(of: Void.self)
+            self.shutdown(queue: .global()) { error in
+                if let error = error {
+                    promise.fail(error)
+                } else {
+                    promise.succeed(())
+                }
+            }
+            return promise.futureResult
+        case .createNew:
+            preconditionFailure("Cannot use the shutdown() method which returns a future when owning the EventLoopGroup. Please use the one of the other shutdown methods.")
+        }
+    }
+
     private func shutdownEventLoop(queue: DispatchQueue, _ callback: @escaping ShutdownCallback) {
         self.stateLock.withLock {
             switch self.eventLoopGroupProvider {

Tests/AsyncHTTPClientTests/HTTPClientTests+XCTest.swift

@@ -143,6 +143,7 @@ extension HTTPClientTests {
             ("testConnectionPoolSizeConfigValueIsRespected", testConnectionPoolSizeConfigValueIsRespected),
             ("testRequestWithHeaderTransferEncodingIdentityDoesNotFail", testRequestWithHeaderTransferEncodingIdentityDoesNotFail),
             ("testMassiveDownload", testMassiveDownload),
+            ("testShutdownWithFutures", testShutdownWithFutures),
         ]
     }
 }

Tests/AsyncHTTPClientTests/HTTPClientTests.swift

@@ -3463,4 +3463,9 @@ class HTTPClientTests: XCTestCase {
         XCTAssertEqual(response?.version, .http1_1)
         XCTAssertEqual(response?.body?.readableBytes, 10_000)
     }
+
+    func testShutdownWithFutures() {
+        let httpClient = HTTPClient(eventLoopGroupProvider: .shared(self.clientGroup))
+        XCTAssertNoThrow(try httpClient.shutdown().wait())
+    }
 }