Adjust implementation for async connect method (#8)

# Adjust implementation for async connect method ## ♻️ Current situation & Problem The latest beta release of SpeziBluetooth changed the peripherals connect method to be async throws allowing use to await till the device is fully connected and propagating any connection errors. This requires some slight modifications to SpeziDevices resolved with this PR. ## ⚙️ Release Notes * Update to SpeziBluetooth 3.0 Beta 2 ## 📚 Documentation -- ## ✅ Testing Verified against existing test suite. ## 📝 Code of Conduct & Contributing Guidelines By submitting creating this pull request, you agree to follow our [Code of Conduct](https://github.com/StanfordSpezi/.github/blob/main/CODE_OF_CONDUCT.md) and [Contributing Guidelines](https://github.com/StanfordSpezi/.github/blob/main/CONTRIBUTING.md): - [x] I agree to follow the [Code of Conduct](https://github.com/StanfordSpezi/.github/blob/main/CODE_OF_CONDUCT.md) and [Contributing Guidelines](https://github.com/StanfordSpezi/.github/blob/main/CONTRIBUTING.md).
StanfordSpezi · Jul 24, 2024 · 6fc18b2 · 6fc18b2
1 parent ac008a4
commit 6fc18b2
Show file tree

Hide file tree

Showing 6 changed files with 91 additions and 26 deletions.
diff --git a/Package.swift b/Package.swift
@@ -36,7 +36,7 @@ let package = Package(
         .package(url: "https://github.com/StanfordSpezi/SpeziFoundation", from: "1.1.1"),
         .package(url: "https://github.com/StanfordSpezi/Spezi.git", from: "1.4.0"),
         .package(url: "https://github.com/StanfordSpezi/SpeziViews.git", from: "1.5.0"),
-        .package(url: "https://github.com/StanfordSpezi/SpeziBluetooth", exact: "3.0.0-beta.1"),
+        .package(url: "https://github.com/StanfordSpezi/SpeziBluetooth", exact: "3.0.0-beta.2"),
         .package(url: "https://github.com/StanfordSpezi/SpeziNetworking", from: "2.1.1"),
         .package(url: "https://github.com/StanfordBDHG/XCTestExtensions.git", .upToNextMinor(from: "0.4.12"))
     ] + swiftLintPackage(),
@@ -52,7 +52,8 @@ let package = Package(
                 .product(name: "Spezi", package: "Spezi")
             ],
             swiftSettings: [
-                swiftConcurrency
+                swiftConcurrency,
+                .enableUpcomingFeature("InferSendableFromCaptures")
             ],
             plugins: [] + swiftLintPlugin()
         ),
@@ -68,7 +69,8 @@ let package = Package(
                 .process("Resources")
             ],
             swiftSettings: [
-                swiftConcurrency
+                swiftConcurrency,
+                .enableUpcomingFeature("InferSendableFromCaptures")
             ],
             plugins: [] + swiftLintPlugin()
         ),
@@ -83,7 +85,8 @@ let package = Package(
                 .process("Resources")
             ],
             swiftSettings: [
-                swiftConcurrency
+                swiftConcurrency,
+                .enableUpcomingFeature("InferSendableFromCaptures")
             ],
             plugins: [] + swiftLintPlugin()
         ),
@@ -98,7 +101,8 @@ let package = Package(
                 .product(name: "XCTestExtensions", package: "XCTestExtensions")
             ],
             swiftSettings: [
-                swiftConcurrency
+                swiftConcurrency,
+                .enableUpcomingFeature("InferSendableFromCaptures")
             ],
             plugins: [] + swiftLintPlugin()
         ),
@@ -111,7 +115,8 @@ let package = Package(
                 .product(name: "XCTestExtensions", package: "XCTestExtensions")
             ],
             swiftSettings: [
-                swiftConcurrency
+                swiftConcurrency,
+                .enableUpcomingFeature("InferSendableFromCaptures")
             ],
             plugins: [] + swiftLintPlugin()
         )

diff --git a/Sources/SpeziDevices/PairedDevices.swift b/Sources/SpeziDevices/PairedDevices.swift
@@ -336,7 +336,15 @@ public final class PairedDevices: @unchecked Sendable {
 
         pendingConnectionAttempts[device.id] = Task {
             await previousTask?.value // make sure its ordered
-            await device.connect()
+            do {
+                try await device.connect()
+            } catch {
+                guard !Task.isCancelled else {
+                    return
+                }
+                logger.warning("Failed connection attempt for device \(device.label). Retrying ...")
+                connectionAttempt(for: device)
+            }
         }
     }
 
@@ -394,27 +402,48 @@ extension PairedDevices {
             throw DevicePairingError.invalidState
         }
 
-        await device.connect()
-
         let id = device.id
-        let timeoutHandler = { @Sendable @MainActor in
+
+        // race timeout against the tasks below
+        async let _ = await withTimeout(of: timeout) { @MainActor in
             _ = self.ongoingPairings.removeValue(forKey: id)?.signalTimeout()
         }
 
-        async let _ = withTimeout(of: timeout, perform: timeoutHandler)
+        try await withThrowingDiscardingTaskGroup { group in
+            // connect task
+            group.addTask { @MainActor in
+                do {
+                    try await device.connect()
+                } catch {
+                    if error is CancellationError {
+                        self.ongoingPairings.removeValue(forKey: id)?.signalCancellation()
+                    }
 
-        try await withTaskCancellationHandler {
-            try await withCheckedThrowingContinuation { continuation in
-                ongoingPairings[id] = PairingContinuation(continuation)
+                    throw error
+                }
             }
-        } onCancel: {
-            Task { @MainActor [weak device] in
-                ongoingPairings.removeValue(forKey: id)?.signalCancellation()
-                await device?.disconnect()
+
+            // pairing task
+            group.addTask { @MainActor in
+                try await withTaskCancellationHandler {
+                    try await withCheckedThrowingContinuation { continuation in
+                        self.ongoingPairings[id] = PairingContinuation(continuation)
+                    }
+                } onCancel: {
+                    Task { @MainActor [weak device] in
+                        self.ongoingPairings.removeValue(forKey: id)?.signalCancellation()
+                        await device?.disconnect()
+                    }
+                }
             }
         }
 
-        // if cancelled the continuation throws an CancellationError
+
+        // the task group above should exit with a CancellationError anyways, but safe to double check here
+        guard !Task.isCancelled else {
+            throw CancellationError()
+        }
+
         await registerPairedDevice(device)
     }
 

diff --git a/Tests/SpeziDevicesTests/PairedDevicesTests.swift b/Tests/SpeziDevicesTests/PairedDevicesTests.swift
@@ -83,7 +83,7 @@ final class PairedDevicesTests: XCTestCase {
         }()
 
 
-        await device.connect()
+        try await device.connect()
         try await Task.sleep(for: .seconds(1.1))
         XCTAssertEqual(device.state, .connected)
 
@@ -113,7 +113,7 @@ final class PairedDevicesTests: XCTestCase {
         }
         device.$nearby.inject(true)
 
-        await device.connect()
+        try await device.connect()
         try await XCTAssertThrowsErrorAsync(await devices.pair(with: device)) { error in
             XCTAssertEqual(try XCTUnwrap(error as? DevicePairingError), .invalidState)
         }

diff --git a/Tests/UITests/TestApp/BluetoothViewsTest.swift b/Tests/UITests/TestApp/BluetoothViewsTest.swift
@@ -41,7 +41,7 @@ struct BluetoothViewsTest: View {
         Task {
             switch device.state {
             case .disconnected, .disconnecting:
-                await device.connect()
+                try await device.connect()
             case .connecting, .connected:
                 await device.disconnect()
             }

diff --git a/Tests/UITests/TestApp/DevicesTestView.swift b/Tests/UITests/TestApp/DevicesTestView.swift
@@ -38,6 +38,8 @@ struct DevicesTestView: View {
     @State private var weightScale = OmronWeightScale.createMockDevice(manufacturerData: .omronManufacturerData(mode: .transferMode))
     @State private var bloodPressureCuff = OmronBloodPressureCuff.createMockDevice(manufacturerData: .omronManufacturerData(mode: .transferMode))
 
+    @State private var viewState: ViewState = .idle
+
     var body: some View {
         NavigationStack {
             DevicesView(appName: "Example", pairingHint: "Enable pairing mode on the device.")
@@ -47,10 +49,10 @@ struct DevicesTestView: View {
                             device.isInPairingMode = true
                             device.$advertisementData.inject(AdvertisementData()) // trigger onChange advertisement
                         }
-                        AsyncButton {
-                            await device.connect()
-                            await weightScale.connect()
-                            await bloodPressureCuff.connect()
+                        AsyncButton(state: $viewState) {
+                            try await device.connect()
+                            try await weightScale.connect()
+                            try await bloodPressureCuff.connect()
                         } label: {
                             Label("Connect", systemImage: "cable.connector")
                         }
@@ -77,6 +79,7 @@ struct DevicesTestView: View {
                     }
                 }
         }
+            .viewStateAlert(state: $viewState)
             .onAppear {
                 guard !didRegister else {
                     return

diff --git a/Tests/UITests/UITests.xcodeproj/xcshareddata/xcschemes/TestApp.xcscheme b/Tests/UITests/UITests.xcodeproj/xcshareddata/xcschemes/TestApp.xcscheme
@@ -34,6 +34,34 @@
                ReferencedContainer = "container:UITests.xcodeproj">
             </BuildableReference>
          </BuildActionEntry>
+         <BuildActionEntry
+            buildForTesting = "YES"
+            buildForRunning = "NO"
+            buildForProfiling = "NO"
+            buildForArchiving = "NO"
+            buildForAnalyzing = "NO">
+            <BuildableReference
+               BuildableIdentifier = "primary"
+               BlueprintIdentifier = "SpeziOmron"
+               BuildableName = "SpeziOmron"
+               BlueprintName = "SpeziOmron"
+               ReferencedContainer = "container:../..">
+            </BuildableReference>
+         </BuildActionEntry>
+         <BuildActionEntry
+            buildForTesting = "YES"
+            buildForRunning = "NO"
+            buildForProfiling = "NO"
+            buildForArchiving = "NO"
+            buildForAnalyzing = "NO">
+            <BuildableReference
+               BuildableIdentifier = "primary"
+               BlueprintIdentifier = "SpeziDevicesUI"
+               BuildableName = "SpeziDevicesUI"
+               BlueprintName = "SpeziDevicesUI"
+               ReferencedContainer = "container:../..">
+            </BuildableReference>
+         </BuildActionEntry>
       </BuildActionEntries>
    </BuildAction>
    <TestAction