SWIFT-1438 Change concurrency minimum macOS version from 12 to 10.15.0 (#721)

atultw · kmahar · web-flow · commit 62eaa144f305 · 2022-02-18T15:17:52.000-05:00
Co-authored-by: Kaitlin Mahar &lt;kaitlinmahar@gmail.com&gt;
diff --git a/Package.swift b/Package.swift
@@ -1,4 +1,14 @@
 // swift-tools-version:5.1
+
+///  To avoid breaking Swift 5.1 compatibility, only require newer NIO versions when we need NIO's concurrency APIs.
+func getMinNIOVersion() -> PackageDescription.Package.Dependency.Requirement {
+#if compiler(>=5.5.2) && canImport(_Concurrency)
+    return .upToNextMajor(from: "2.36.0")
+#else
+    return .upToNextMajor(from: "2.15.0")
+#endif
+}
+
 import PackageDescription
 let package = Package(
     name: "mongo-swift-driver",
@@ -11,7 +21,7 @@ let package = Package(
     ],
     dependencies: [
         .package(url: "https://github.com/Quick/Nimble.git", .upToNextMajor(from: "8.0.0")),
-        .package(url: "https://github.com/apple/swift-nio", .upToNextMajor(from: "2.15.0")),
+        .package(url: "https://github.com/apple/swift-nio", getMinNIOVersion()),
         .package(url: "https://github.com/mongodb/swift-bson", .upToNextMajor(from: "3.0.0"))
     ],
     targets: [
diff --git a/Sources/MongoSwift/AsyncAwait/ChangeStream+AsyncSequence.swift b/Sources/MongoSwift/AsyncAwait/ChangeStream+AsyncSequence.swift
@@ -1,6 +1,6 @@
-#if compiler(>=5.5) && canImport(_Concurrency)
+#if compiler(>=5.5.2) && canImport(_Concurrency)
 /// Extension to `ChangeStream` to support async/await APIs.
-@available(macOS 12, *)
+@available(macOS 10.15.0, *)
 extension ChangeStream: AsyncSequence, AsyncIteratorProtocol {
     public typealias AsyncIterator = ChangeStream
 
diff --git a/Sources/MongoSwift/AsyncAwait/ClientSession+AsyncAwait.swift b/Sources/MongoSwift/AsyncAwait/ClientSession+AsyncAwait.swift
@@ -1,6 +1,6 @@
-#if compiler(>=5.5) && canImport(_Concurrency)
+#if compiler(>=5.5.2) && canImport(_Concurrency)
 /// Extension to `ClientSession` to support async/await APIs.
-@available(macOS 12, *)
+@available(macOS 10.15.0, *)
 extension ClientSession {
     /**
      * Starts a multi-document transaction for all subsequent operations in this session.
diff --git a/Sources/MongoSwift/AsyncAwait/MongoClient+AsyncAwait.swift b/Sources/MongoSwift/AsyncAwait/MongoClient+AsyncAwait.swift
@@ -1,6 +1,6 @@
-#if compiler(>=5.5) && canImport(_Concurrency)
+#if compiler(>=5.5.2) && canImport(_Concurrency)
 /// Extension to `MongoClient` to support async/await APIs.
-@available(macOS 12, *)
+@available(macOS 10.15.0, *)
 extension MongoClient {
     /**
      * Closes this `MongoClient`, closing all connections to the server and cleaning up internal state.
diff --git a/Sources/MongoSwift/AsyncAwait/MongoCollection+AsyncAwait.swift b/Sources/MongoSwift/AsyncAwait/MongoCollection+AsyncAwait.swift
@@ -1,6 +1,6 @@
-#if compiler(>=5.5) && canImport(_Concurrency)
+#if compiler(>=5.5.2) && canImport(_Concurrency)
 /// Extension to `MongoCollection` to support async/await APIs.
-@available(macOS 12, *)
+@available(macOS 10.15.0, *)
 extension MongoCollection {
     /**
      * Drops this collection from its parent database.
diff --git a/Sources/MongoSwift/AsyncAwait/MongoCollection+ChangeStreams+AsyncAwait.swift b/Sources/MongoSwift/AsyncAwait/MongoCollection+ChangeStreams+AsyncAwait.swift
@@ -1,6 +1,6 @@
-#if compiler(>=5.5) && canImport(_Concurrency)
+#if compiler(>=5.5.2) && canImport(_Concurrency)
 /// Extension to `MongoCollection` to support async/await change stream APIs.
-@available(macOS 12, *)
+@available(macOS 10.15.0, *)
 extension MongoCollection {
     /**
      * Starts a `ChangeStream` on a collection. The `CollectionType` will be associated with the `fullDocument`
diff --git a/Sources/MongoSwift/AsyncAwait/MongoCollection+FindAndModify+AsyncAwait.swift b/Sources/MongoSwift/AsyncAwait/MongoCollection+FindAndModify+AsyncAwait.swift
@@ -1,6 +1,6 @@
-#if compiler(>=5.5) && canImport(_Concurrency)
+#if compiler(>=5.5.2) && canImport(_Concurrency)
 /// Extension to `MongoCollection` to support async/await find and modify APIs.
-@available(macOS 12, *)
+@available(macOS 10.15.0, *)
 extension MongoCollection {
     /**
      * Finds a single document and deletes it, returning the original.
diff --git a/Sources/MongoSwift/AsyncAwait/MongoCollection+Indexes+AsyncAwait.swift b/Sources/MongoSwift/AsyncAwait/MongoCollection+Indexes+AsyncAwait.swift
@@ -1,6 +1,6 @@
-#if compiler(>=5.5) && canImport(_Concurrency)
+#if compiler(>=5.5.2) && canImport(_Concurrency)
 /// Extension to `MongoCollection` to support async/await index management APIs.
-@available(macOS 12, *)
+@available(macOS 10.15.0, *)
 extension MongoCollection {
     /**
      * Creates an index over the collection for the provided keys with the provided options.
diff --git a/Sources/MongoSwift/AsyncAwait/MongoCollection+Read+AsyncAwait.swift b/Sources/MongoSwift/AsyncAwait/MongoCollection+Read+AsyncAwait.swift
@@ -1,6 +1,6 @@
-#if compiler(>=5.5) && canImport(_Concurrency)
+#if compiler(>=5.5.2) && canImport(_Concurrency)
 /// Extension to `MongoCollection` to support async/await read APIs.
-@available(macOS 12, *)
+@available(macOS 10.15.0, *)
 extension MongoCollection {
     /**
      * Finds the documents in this collection which match the provided filter.
diff --git a/Sources/MongoSwift/AsyncAwait/MongoCollection+Write+AsyncAwait.swift b/Sources/MongoSwift/AsyncAwait/MongoCollection+Write+AsyncAwait.swift
@@ -1,6 +1,6 @@
-#if compiler(>=5.5) && canImport(_Concurrency)
+#if compiler(>=5.5.2) && canImport(_Concurrency)
 /// Extension to `MongoCollection` to support async/await write APIs.
-@available(macOS 12, *)
+@available(macOS 10.15.0, *)
 extension MongoCollection {
     /**
      * Encodes the provided value to BSON and inserts it. If the value is missing an identifier, one will be generated
diff --git a/Sources/MongoSwift/AsyncAwait/MongoCursor+AsyncSequence.swift b/Sources/MongoSwift/AsyncAwait/MongoCursor+AsyncSequence.swift
@@ -1,6 +1,6 @@
-#if compiler(>=5.5) && canImport(_Concurrency)
+#if compiler(>=5.5.2) && canImport(_Concurrency)
 /// Extension to `MongoCursor` to support async/await APIs.
-@available(macOS 12, *)
+@available(macOS 10.15.0, *)
 extension MongoCursor: AsyncSequence, AsyncIteratorProtocol {
     public typealias AsyncIterator = MongoCursor
 
diff --git a/Sources/MongoSwift/AsyncAwait/MongoDatabase+AsyncAwait.swift b/Sources/MongoSwift/AsyncAwait/MongoDatabase+AsyncAwait.swift
@@ -1,6 +1,6 @@
-#if compiler(>=5.5) && canImport(_Concurrency)
+#if compiler(>=5.5.2) && canImport(_Concurrency)
 /// Extension to `MongoDatabase` to support async/await APIs.
-@available(macOS 12, *)
+@available(macOS 10.15.0, *)
 extension MongoDatabase {
     /**
      *   Drops this database.
diff --git a/Sources/MongoSwift/ChangeStream.swift b/Sources/MongoSwift/ChangeStream.swift
@@ -284,7 +284,7 @@ public class ChangeStream<T: Codable>: CursorProtocol {
         }
     }
 
-#if compiler(>=5.5) && canImport(_Concurrency)
+#if compiler(>=5.5.2) && canImport(_Concurrency)
     /// When concurrency is available, we can ensure change streams are always cleaned up properly.
     deinit {
         // We can't do this with an @available check on the method; see https://bugs.swift.org/browse/SR-15537.
diff --git a/Sources/MongoSwift/ClientSession.swift b/Sources/MongoSwift/ClientSession.swift
@@ -79,8 +79,8 @@ public final class ClientSession {
             }
         }
 
-#if compiler(>=5.5) && canImport(_Concurrency)
-        @available(macOS 12, *)
+#if compiler(>=5.5.2) && canImport(_Concurrency)
+        @available(macOS 10.15.0, *)
         fileprivate func cleanup(using client: MongoClient, on eventLoop: EventLoop?) async throws {
             try await self.cleanup(using: client, on: eventLoop).get()
         }
@@ -333,7 +333,7 @@ public final class ClientSession {
 
     /// Cleans up internal state.
     deinit {
-#if compiler(>=5.5) && canImport(_Concurrency)
+#if compiler(>=5.5.2) && canImport(_Concurrency)
         if #available(macOS 12, *) {
             // Pull out all necessary values into new references to avoid referencing `self` within the `Task`, since
             // the `Task` is going to outlive `self`.
diff --git a/Sources/MongoSwift/MongoCursor.swift b/Sources/MongoSwift/MongoCursor.swift
@@ -268,7 +268,7 @@ public class MongoCursor<T: Codable>: CursorProtocol {
         }
     }
 
-#if compiler(>=5.5) && canImport(_Concurrency)
+#if compiler(>=5.5.2) && canImport(_Concurrency)
     /// When concurrency is available, we can ensure cursors are always cleaned up properly.
     deinit {
         // We can't do this with an @available check on the method; see https://bugs.swift.org/browse/SR-15537.
diff --git a/Sources/MongoSwift/Operations/Operation.swift b/Sources/MongoSwift/Operations/Operation.swift
@@ -100,8 +100,8 @@ internal class OperationExecutor {
         self.threadPool.runIfActive(eventLoop: eventLoop ?? self.eventLoopGroup.next(), body)
     }
 
-#if compiler(>=5.5) && canImport(_Concurrency)
-    @available(macOS 12, *)
+#if compiler(>=5.5.2) && canImport(_Concurrency)
+    @available(macOS 10.15.0, *)
     internal func execute<T>(on eventLoop: EventLoop?, _ body: @escaping () throws -> T) async throws -> T {
         try await self.execute(on: eventLoop, body).get()
     }
diff --git a/Tests/MongoSwiftTests/AsyncAwaitTestUtils.swift b/Tests/MongoSwiftTests/AsyncAwaitTestUtils.swift
@@ -1,4 +1,4 @@
-#if compiler(>=5.5) && canImport(_Concurrency)
+#if compiler(>=5.5.2) && canImport(_Concurrency)
 
 import Foundation
 import MongoSwift
@@ -7,7 +7,7 @@ import TestsCommon
 import XCTest
 
 /// Temporary utility function until XCTest supports `async` tests.
-@available(macOS 12, *)
+@available(macOS 10.15.0, *)
 func testAsync(_ block: @escaping () async throws -> Void) {
     let group = DispatchGroup()
     group.enter()
@@ -22,7 +22,7 @@ func testAsync(_ block: @escaping () async throws -> Void) {
     group.wait()
 }
 
-@available(macOS 12, *)
+@available(macOS 10.15.0, *)
 extension Task where Success == Never, Failure == Never {
     ///  Helper taken from https://www.hackingwithswift.com/quick-start/concurrency/how-to-make-a-task-sleep to support
     /// configuring with seconds rather than nanoseconds.
@@ -34,7 +34,7 @@ extension Task where Success == Never, Failure == Never {
 
 /// Asserts that the provided block returns true within the specified timeout. Nimble's `toEventually` can only be used
 /// rom the main testing thread which is too restrictive for our purposes testing the async/await APIs.
-@available(macOS 12, *)
+@available(macOS 10.15.0, *)
 func assertIsEventuallyTrue(
     description: String,
     timeout: TimeInterval = 5,
@@ -51,7 +51,7 @@ func assertIsEventuallyTrue(
     XCTFail("Expected condition \"\(description)\" to be true within \(timeout) seconds, but was not")
 }
 
-@available(macOS 12, *)
+@available(macOS 10.15.0, *)
 extension MongoSwiftTestCase {
     internal func withTestClient<T>(
         _ uri: String = MongoSwiftTestCase.getConnectionString().description,
@@ -94,7 +94,7 @@ extension MongoSwiftTestCase {
     // swiftlint:enable large_tuple
 }
 
-@available(macOS 12, *)
+@available(macOS 10.15.0, *)
 extension MongoClient {
     internal func serverVersion() async throws -> ServerVersion {
         let reply = try await self.db("admin").runCommand(
diff --git a/Tests/MongoSwiftTests/AsyncAwaitTests.swift b/Tests/MongoSwiftTests/AsyncAwaitTests.swift
@@ -1,4 +1,4 @@
-#if compiler(>=5.5) && canImport(_Concurrency) && os(Linux)
+#if compiler(>=5.5.2) && canImport(_Concurrency) && os(Linux)
 // TODO: SWIFT-1421 remove this comment and the os(Linux) check above. if the described bug is not fixed, we'll need to
 // adjust our macOS < 12 testing to skip these tests by providing a filter to `swift test`.
 // we shouldn't have to check the operating system here, but there is a bug currently where on older macOS versions
@@ -13,7 +13,7 @@ import NIOConcurrencyHelpers
 import TestsCommon
 import XCTest
 
-@available(macOS 12, *)
+@available(macOS 10.15.0, *)
 final class AsyncAwaitTests: MongoSwiftTestCase {
     func testMongoClient() throws {
         testAsync {
@@ -195,7 +195,7 @@ final class AsyncAwaitTests: MongoSwiftTestCase {
     }
 }
 
-@available(macOS 12, *)
+@available(macOS 10.15.0, *)
 final class MongoCursorAsyncAwaitTests: MongoSwiftTestCase {
     func testAsyncSequenceConformance() throws {
         testAsync {
@@ -298,7 +298,7 @@ final class MongoCursorAsyncAwaitTests: MongoSwiftTestCase {
     }
 }
 
-@available(macOS 12, *)
+@available(macOS 10.15.0, *)
 final class ChangeStreamAsyncAwaitTests: MongoSwiftTestCase {
     func testIteration() throws {
         testAsync {
