Merge pull request #1589 from OneSignal/fix/live_activities_caching

fix: live activities uncaches correctly

Author: nan-li

iOS_SDK/OneSignalSDK/OneSignalLiveActivities/Source/Executors/OSLiveActivitiesExecutor.swift

@@ -48,8 +48,9 @@ class RequestCache {
     init(cacheKey: String, ttl: TimeInterval) {
         self.cacheKey = cacheKey
         self.ttl = ttl
-        self.items = OneSignalUserDefaults.initShared()
-            .getSavedCodeableData(forKey: cacheKey, defaultValue: nil) as? [String: OSLiveActivityRequest] ?? [String: OSLiveActivityRequest]()
+        let cached = OneSignalUserDefaults.initShared().getSavedCodeableData(forKey: cacheKey, defaultValue: nil)
+        // for safe-casting to the protocol, the intermediary cast to AnyObject is necessary
+        self.items = cached as? [String: AnyObject] as? [String: OSLiveActivityRequest] ?? [String: OSLiveActivityRequest]()
         OneSignalLog.onesignalLog(.LL_VERBOSE, message: "OneSignal.LiveActivities initialized token cache \(self): \(items)")
     }
 

iOS_SDK/OneSignalSDK/OneSignalLiveActivities/Source/Requests/OSRequestRemoveStartToken.swift

@@ -78,14 +78,13 @@ class OSRequestRemoveStartToken: OneSignalRequest, OSLiveActivityRequest, OSLive
     required init?(coder: NSCoder) {
         guard
             let key = coder.decodeObject(forKey: "key") as? String,
-            let requestSuccessful = coder.decodeObject(forKey: "requestSuccessful") as? Bool,
             let timestamp = coder.decodeObject(forKey: "timestamp") as? Date
         else {
             // Log error
             return nil
         }
         self.key = key
-        self.requestSuccessful = requestSuccessful
+        self.requestSuccessful = coder.decodeBool(forKey: "requestSuccessful")
         super.init()
         self.timestamp = timestamp
     }

iOS_SDK/OneSignalSDK/OneSignalLiveActivities/Source/Requests/OSRequestRemoveUpdateToken.swift

@@ -79,14 +79,13 @@ class OSRequestRemoveUpdateToken: OneSignalRequest, OSLiveActivityRequest, OSLiv
     required init?(coder: NSCoder) {
         guard
             let key = coder.decodeObject(forKey: "key") as? String,
-            let requestSuccessful = coder.decodeObject(forKey: "requestSuccessful") as? Bool,
             let timestamp = coder.decodeObject(forKey: "timestamp") as? Date
         else {
             // Log error
             return nil
         }
         self.key = key
-        self.requestSuccessful = requestSuccessful
+        self.requestSuccessful = coder.decodeBool(forKey: "requestSuccessful")
         super.init()
         self.timestamp = timestamp
     }

iOS_SDK/OneSignalSDK/OneSignalLiveActivitiesTests/OSLiveActivitiesExecutorTests.swift

@@ -223,6 +223,38 @@ final class OSLiveActivitiesExecutorTests: XCTestCase {
         XCTAssertTrue(mockClient.executedRequests[0] == request)
     }
 
+    func testRequestsUncacheCorrectly() throws {
+        /* Setup */
+        let mockClient = MockOneSignalClient()
+        OneSignalCoreImpl.setSharedClient(mockClient)
+        let mockDispatchQueue = MockDispatchQueue()
+        let executor1 = OSLiveActivitiesExecutor(requestDispatch: mockDispatchQueue)
+
+        /* When */
+        let setStartToken = OSRequestSetStartToken(key: "key-setStartToken", token: "my-token")
+        let removeStartToken = OSRequestRemoveStartToken(key: "key-removeStartToken")
+        let setUpdateToken = OSRequestSetUpdateToken(key: "key-setUpdateToken", token: "my-token")
+        let removeUpdateToken = OSRequestRemoveUpdateToken(key: "key-removeUpdateToken")
+
+        executor1.append(setStartToken)
+        executor1.append(removeStartToken)
+        executor1.append(setUpdateToken)
+        executor1.append(removeUpdateToken)
+        mockDispatchQueue.waitForDispatches(4)
+
+        // create a new executor which will uncache requests
+        let executor2 = OSLiveActivitiesExecutor(requestDispatch: MockDispatchQueue())
+
+        /* Then */
+        XCTAssertEqual(executor2.startTokens.items.count, 2)
+        XCTAssertTrue(executor2.startTokens.items["key-setStartToken"] is OSRequestSetStartToken)
+        XCTAssertTrue(executor2.startTokens.items["key-removeStartToken"] is OSRequestRemoveStartToken)
+
+        XCTAssertEqual(executor2.updateTokens.items.count, 2)
+        XCTAssertTrue(executor2.updateTokens.items["key-setUpdateToken"] is OSRequestSetUpdateToken)
+        XCTAssertTrue(executor2.updateTokens.items["key-removeUpdateToken"] is OSRequestRemoveUpdateToken)
+    }
+
     func testSetStartRequestNotExecutedWithSameActivityTypeAndToken() throws {
         /* Setup */
         let mockDispatchQueue = MockDispatchQueue()