implements new Storage API for handleEventsForBackgroundURLSession

Author: Brennan Stehling

Amplify/Categories/Storage/StorageCategory+ClientBehavior.swift

@@ -53,8 +53,9 @@ extension StorageCategory: StorageCategoryBehavior {
         try await plugin.list(options: options)
     }
 
-    public func handleBackgroundEvents(identifier: String) async -> Bool {
-        await plugin.handleBackgroundEvents(identifier: identifier)
+    @discardableResult
+    public func handleEventsForBackgroundURLSession(identifier: String) async -> Bool {
+        await plugin.handleEventsForBackgroundURLSession(identifier: identifier)
     }
 
 }

Amplify/Categories/Storage/StorageCategoryBehavior.swift

@@ -88,6 +88,7 @@ public protocol StorageCategoryBehavior {
     /// Handles background events which are related to URLSession
     /// - Parameter identifier: identifier
     /// - Returns: returns true if the identifier is handled by Amplify
-    func handleBackgroundEvents(identifier: String) async -> Bool
+    @discardableResult
+    func handleEventsForBackgroundURLSession(identifier: String) async -> Bool
 
 }

AmplifyPlugins/Storage/Sources/AWSS3StoragePlugin/AWSS3StoragePlugin+AsyncClientBehavior.swift

@@ -119,10 +119,8 @@ extension AWSS3StoragePlugin {
         return try await taskAdapter.value
     }
 
-    public func handleBackgroundEvents(identifier: String) async -> Bool {
-        await withCheckedContinuation { (continuation: CheckedContinuation<Bool, Never>) in
-            StorageBackgroundEventsRegistry.handleBackgroundEvents(identifier: identifier, continuation: continuation)
-        }
+    public func handleEventsForBackgroundURLSession(identifier: String) async -> Bool {
+        await StorageBackgroundEventsRegistry.handleEventsForBackgroundURLSession(identifier: identifier)
     }
 
 }

AmplifyPlugins/Storage/Sources/AWSS3StoragePlugin/Support/Internal/StorageBackgroundEventsRegistry.swift

@@ -22,11 +22,11 @@ class StorageBackgroundEventsRegistry {
     ///   - identifier: session identifier
     ///   - completionHandler: completion handler
     /// - Returns: indicates if the identifier was registered and will be handled
-    static func handleBackgroundEvents(identifier: String, continuation: StorageBackgroundEventsContinuation) {
-        if self.identifier == identifier {
+    static func handleEventsForBackgroundURLSession(identifier: String) async -> Bool {
+        guard self.identifier == identifier else { return false }
+
+        return await withCheckedContinuation { (continuation: CheckedContinuation<Bool, Never>) in
             self.continuation = continuation
-        } else {
-            continuation.resume(returning: false)
         }
     }
 

AmplifyPlugins/Storage/Sources/AWSS3StoragePlugin/Support/Internal/StorageServiceSessionDelegate.swift

@@ -53,7 +53,7 @@ extension StorageServiceSessionDelegate: URLSessionDelegate {
     func urlSessionDidFinishEvents(forBackgroundURLSession session: URLSession) {
         logURLSessionActivity("Session did finish background events")
 
-        if let identifier = storageService?.identifier,
+        if let identifier = session.configuration.identifier,
            let continuation = StorageBackgroundEventsRegistry.getContinuation(for: identifier) {
             // Must be run on main thread as covered by Apple Developer docs.
             Task { @MainActor in

AmplifyPlugins/Storage/Tests/AWSS3StoragePluginTests/Support/Internal/StorageBackgroundEventsRegistryTests.swift

@@ -21,29 +21,21 @@ class StorageBackgroundEventsRegistryTests: XCTestCase {
         let done = asyncExpectation(description: "done", expectedFulfillmentCount: 2)
 
         Task {
-            let handled = await withCheckedContinuation { (continuation: CheckedContinuation<Bool, Never>) in
-                StorageBackgroundEventsRegistry.handleBackgroundEvents(identifier: identifier, continuation: continuation)
-                Task {
-                    await done.fulfill()
-                }
-            }
+            let handled = await StorageBackgroundEventsRegistry.handleEventsForBackgroundURLSession(identifier: identifier)
+            await done.fulfill()
             XCTAssertTrue(handled)
         }
 
         Task {
-            let otherHandled = await withCheckedContinuation { (continuation: CheckedContinuation<Bool, Never>) in
-                StorageBackgroundEventsRegistry.handleBackgroundEvents(identifier: otherIdentifier, continuation: continuation)
-                Task {
-                    await done.fulfill()
-                }
-            }
+            let otherHandled = await StorageBackgroundEventsRegistry.handleEventsForBackgroundURLSession(identifier: otherIdentifier)
+            await done.fulfill()
             XCTAssertFalse(otherHandled)
         }
 
-        await waitForExpectations([done])
-
         handleEvents(for: identifier)
         handleEvents(for: otherIdentifier)
+
+        await waitForExpectations([done])
     }
 
     func testHandlingUnregisteredIdentifier() async throws {
@@ -54,12 +46,8 @@ class StorageBackgroundEventsRegistryTests: XCTestCase {
         let done = asyncExpectation(description: "done")
 
         Task {
-            let handled = await withCheckedContinuation { (continuation: CheckedContinuation<Bool, Never>) in
-                StorageBackgroundEventsRegistry.handleBackgroundEvents(identifier: identifier, continuation: continuation)
-                Task {
-                    await done.fulfill()
-                }
-            }
+            let handled = await StorageBackgroundEventsRegistry.handleEventsForBackgroundURLSession(identifier: identifier)
+            await done.fulfill()
             XCTAssertFalse(handled)
         }
 
@@ -70,6 +58,7 @@ class StorageBackgroundEventsRegistryTests: XCTestCase {
     func handleEvents(for identifier: String) {
         if let continuation = StorageBackgroundEventsRegistry.getContinuation(for: identifier) {
             continuation.resume(returning: true)
+            StorageBackgroundEventsRegistry.removeContinuation(for: identifier)
         }
     }
 

AmplifyTestCommon/Mocks/MockStorageCategoryPlugin.swift

@@ -176,7 +176,7 @@ class MockStorageCategoryPlugin: MessageReporter, StorageCategoryPlugin {
         return try await taskAdapter.value
     }
 
-    func handleBackgroundEvents(identifier: String) async -> Bool {
+    func handleEventsForBackgroundURLSession(identifier: String) async -> Bool {
         false
     }
 

AmplifyTests/CategoryTests/Hub/AmplifyOperationHubTests.swift

@@ -217,7 +217,7 @@ class MockDispatchingStoragePlugin: StorageCategoryPlugin {
         return operation
     }
 
-    func handleBackgroundEvents(identifier: String) async -> Bool {
+    func handleEventsForBackgroundURLSession(identifier: String) async -> Bool {
         false
     }