Add Sendable conformances (#57)

Author: ffried

.github/workflows/test.yml

@@ -8,7 +8,7 @@ on:
 
 jobs:
   unit-tests:
-    uses: vapor/ci/.github/workflows/run-unit-tests.yml@reusable-workflows
+    uses: vapor/ci/.github/workflows/run-unit-tests.yml@main
     with:
       with_coverage: true
       with_tsan: false

[email protected]

@@ -0,0 +1,29 @@
+// swift-tools-version:5.9
+import PackageDescription
+
+let package = Package(
+    name: "vapor-apns",
+    platforms: [
+       .macOS(.v13),
+       .iOS(.v16)
+    ],
+    products: [
+        .library(name: "VaporAPNS", targets: ["VaporAPNS"]),
+    ],
+    dependencies: [
+        .package(url: "https://github.com/swift-server-community/APNSwift.git", from: "5.0.0"),
+        .package(url: "https://github.com/vapor/vapor.git", from: "4.77.2"),
+    ],
+    targets: [
+        .target(name: "VaporAPNS", dependencies: [
+            .product(name: "APNS", package: "apnswift"),
+            .product(name: "Vapor", package: "vapor"),
+        ],
+        swiftSettings: [.enableExperimentalFeature("StrictConcurrency=complete")]),
+        .testTarget(name: "VaporAPNSTests", dependencies: [
+            .target(name: "VaporAPNS"),
+            .product(name: "XCTVapor", package: "vapor"),
+        ],
+        swiftSettings: [.enableExperimentalFeature("StrictConcurrency=complete")]),
+    ]
+)

Sources/VaporAPNS/APNSContainers.swift

@@ -1,47 +1,50 @@
 import Vapor
 import APNS
+#if canImport(Darwin)
 import Foundation
+#else
+// JSONEncoder / JSONDecoder is not Sendable in scf, but is in Darwin...
+// Import as `@preconcurrency` to fix warnings.
+@preconcurrency import Foundation
+#endif
 import NIO
 import NIOConcurrencyHelpers
 
 public typealias APNSGenericClient = APNSClient<JSONDecoder, JSONEncoder>
 
-public class APNSContainers {
-    public struct ID: Hashable, Codable {
+public final class APNSContainers: Sendable {
+    public struct ID: Sendable, Hashable, Codable {
         public let string: String
         public init(string: String) {
             self.string = string
         }
     }
 
-    public final class Container {
+    public final class Container: Sendable {
         public let configuration: APNSClientConfiguration
         public let client: APNSGenericClient
 
-         internal init(configuration: APNSClientConfiguration, client: APNSGenericClient) {
+        internal init(configuration: APNSClientConfiguration, client: APNSGenericClient) {
             self.configuration = configuration
             self.client = client
         }
     }
 
-    private var containers: [ID: Container]
-    private var defaultID: ID?
-    private var lock: NIOLock
+    private let storage: NIOLockedValueBox<(containers: [ID: Container], defaultID: ID?)>
 
     init() {
-        self.containers = [:]
-        self.lock = .init()
+        storage = .init((containers: [:], defaultID: nil))
     }
 
     public func syncShutdown() {
-        self.lock.lock()
-        defer { self.lock.unlock() }
-        do {
-            try containers.forEach { key, container in
-                try container.client.syncShutdown()
+        storage.withLockedValue {
+            do {
+                try $0.containers.values.forEach { container in
+                    try container.client.syncShutdown()
+                }
+            } catch {
+                fatalError("Could not shutdown APNS Containers")
             }
-        } catch {
-            fatalError("Could not shutdown APNS Containers")
         }
     }
 }
@@ -57,42 +60,40 @@ extension APNSContainers {
         as id: ID,
         isDefault: Bool? = nil
     ) {
-        self.lock.lock()
-        defer { self.lock.unlock() }
-
-        self.containers[id] = Container(
-            configuration: config,
-            client: APNSGenericClient(
+        storage.withLockedValue {
+            $0.containers[id] = Container(
                 configuration: config,
-                eventLoopGroupProvider: eventLoopGroupProvider,
-                responseDecoder: responseDecoder,
-                requestEncoder: requestEncoder,
-                byteBufferAllocator: byteBufferAllocator
+                client: APNSGenericClient(
+                    configuration: config,
+                    eventLoopGroupProvider: eventLoopGroupProvider,
+                    responseDecoder: responseDecoder,
+                    requestEncoder: requestEncoder,
+                    byteBufferAllocator: byteBufferAllocator
+                )
             )
-        )
 
-        if isDefault == true || (self.defaultID == nil && isDefault != false) {
-            self.defaultID = id
+            if isDefault == true || ($0.defaultID == nil && isDefault != false) {
+                $0.defaultID = id
+            }
         }
     }
 
     public func `default`(to id: ID) {
-        self.lock.lock()
-        defer { self.lock.unlock() }
-        self.defaultID = id
+        storage.withLockedValue {
+            $0.defaultID = id
+        }
     }
 
     public func container(for id: ID? = nil) -> APNSContainers.Container? {
-        self.lock.lock()
-        defer { self.lock.unlock() }
-        guard let id = id ?? self.defaultID else {
-            return nil
+        storage.withLockedValue {
+            guard let id = id ?? $0.defaultID else {
+                return nil
+            }
+            return $0.containers[id]
         }
-        return self.containers[id]
     }
 
     public var container: APNSContainers.Container? {
         container()
     }
 }
-

Sources/VaporAPNS/Application+APNS.swift

@@ -1,17 +1,12 @@
 import APNS
-import NIOConcurrencyHelpers
 import Vapor
 
 extension Application {
     public var apns: APNS {
         return .init(application: self)
     }
 
-    public struct APNS {
-
-        // Synchronize access across threads.
-        private var lock: NIOLock
-
+    public struct APNS: Sendable {
         struct ContainersKey: StorageKey, LockKey {
             typealias Value = APNSContainers
         }
@@ -49,7 +44,6 @@ extension Application {
 
         public init(application: Application) {
             self.application = application
-            self.lock = .init()
         }
     }
 }

Sources/VaporAPNS/Request+APNS.swift

@@ -6,4 +6,3 @@ extension Request {
         .init(application: self.application)
     }
 }
-