Merge branch 'master' into MOB-6106-Application-Directory-for-json-file-storage

roninopf · web-flow · commit a87194849a1e · 2023-04-20T14:40:24.000-07:00
diff --git a/notification-extension/ITBNotificationServiceExtension.swift b/notification-extension/ITBNotificationServiceExtension.swift
@@ -4,15 +4,37 @@
 
 import UserNotifications
 
+public protocol ITBNotificationServiceExtensionDelegate {
+    func notificationServiceDidReceive(_ request: UNNotificationRequest, bestAttemptContent: UNMutableNotificationContent, contentHandler: @escaping (UNNotificationContent) -> Void)
+}
+
 @objc open class ITBNotificationServiceExtension: UNNotificationServiceExtension {
     var contentHandler: ((UNNotificationContent) -> Void)?
     var bestAttemptContent: UNMutableNotificationContent?
+    public static var itblNotificationDelegate: ITBNotificationServiceExtensionDelegate?
     
     @objc override open func didReceive(_ request: UNNotificationRequest,
                                         withContentHandler contentHandler: @escaping (UNNotificationContent) -> Void) {
         self.contentHandler = contentHandler
         bestAttemptContent = (request.content.mutableCopy() as? UNMutableNotificationContent)
         
+        if let itblNotificationDelegate = ITBNotificationServiceExtension.itblNotificationDelegate,
+           let bestAttemptContent = bestAttemptContent {
+            
+            let result = request.content.userInfo.contains {
+                guard let itbl = $0.key as? String else {
+                    print("Iterable SDK notification service extension: failed to cast JSON key to string")
+                    return false
+                }
+                return itbl == JsonKey.Payload.metadata
+            }
+            
+            if !result {
+                itblNotificationDelegate.notificationServiceDidReceive(request, bestAttemptContent: bestAttemptContent, contentHandler: contentHandler)
+                return
+            }
+        }
+        
         resolveCategory(from: request.content)
 
         retrieveAttachment(from: request.content)
diff --git a/swift-sdk/Constants.swift b/swift-sdk/Constants.swift
@@ -42,7 +42,6 @@ enum Const {
     }
     
     public enum UserDefault {
-        static let payloadKey = "itbl_payload_key"
         static let attributionInfoKey = "itbl_attribution_info_key"
         static let emailKey = "itbl_email"
         static let userIdKey = "itbl_userid"
@@ -52,7 +51,6 @@ enum Const {
         static let sdkVersion = "itbl_sdk_version"
         static let offlineMode = "itbl_offline_mode"
         
-        static let payloadExpiration = 24
         static let attributionInfoExpiration = 24
     }
     
@@ -63,7 +61,6 @@ enum Const {
             static let email = "itbl_email"
             static let userId = "itbl_userid"
             static let authToken = "itbl_auth_token"
-            static let lastPushPayloadAndExpiration = "itbl_last_push_payload_and_expiration"
         }
     }
     
diff --git a/swift-sdk/Internal/InternalIterableAPI.swift b/swift-sdk/Internal/InternalIterableAPI.swift
@@ -7,7 +7,14 @@ import UIKit
 
 final class InternalIterableAPI: NSObject, PushTrackerProtocol, AuthProvider {
     var apiKey: String
-    
+    var lastPushPayload: [AnyHashable: Any]? {
+        get {
+            _payloadData
+        } set {
+            setPayloadData(newValue)
+        }
+    }
+
     var email: String? {
         get {
             _email
@@ -46,10 +53,6 @@ final class InternalIterableAPI: NSObject, PushTrackerProtocol, AuthProvider {
                        appPackageName: Bundle.main.appPackageName ?? "")
     }
     
-    var lastPushPayload: [AnyHashable: Any]? {
-        localStorage.getLastPushPayload(dateProvider.currentDate)
-    }
-    
     var attributionInfo: IterableAttributionInfo? {
         get {
             localStorage.getAttributionInfo(currentDate: dateProvider.currentDate)
@@ -85,6 +88,7 @@ final class InternalIterableAPI: NSObject, PushTrackerProtocol, AuthProvider {
                                                                    urlDelegate: config.urlDelegate,
                                                                    urlOpener: urlOpener,
                                                                    allowedProtocols: config.allowedProtocols)
+        
         pending.onSuccess { attributionInfo in
             if let attributionInfo = attributionInfo {
                 self.attributionInfo = attributionInfo
@@ -100,6 +104,11 @@ final class InternalIterableAPI: NSObject, PushTrackerProtocol, AuthProvider {
     func removeDeviceAttribute(name: String) {
         deviceAttributes.removeValue(forKey: name)
     }
+
+    func setPayloadData(_ data: [AnyHashable: Any]?) {
+        ITBInfo()
+        _payloadData = data
+    }
     
     func setEmail(_ email: String?, authToken: String? = nil) {
         ITBInfo()
@@ -416,6 +425,7 @@ final class InternalIterableAPI: NSObject, PushTrackerProtocol, AuthProvider {
     private var deepLinkManager: DeepLinkManager
     
     private var _email: String?
+    private var _payloadData: [AnyHashable: Any]?
     private var _userId: String?
     
     /// the hex representation of this device token
@@ -537,15 +547,15 @@ final class InternalIterableAPI: NSObject, PushTrackerProtocol, AuthProvider {
     }
     
     private func save(pushPayload payload: [AnyHashable: Any]) {
-        let expiration = Calendar.current.date(byAdding: .hour,
-                                               value: Const.UserDefault.payloadExpiration,
-                                               to: dateProvider.currentDate)
-        localStorage.saveLastPushPayload(payload, withExpiration: expiration)
         
         if let metadata = IterablePushNotificationMetadata.metadata(fromLaunchOptions: payload) {
             if let templateId = metadata.templateId {
                 attributionInfo = IterableAttributionInfo(campaignId: metadata.campaignId, templateId: templateId, messageId: metadata.messageId)
             }
+
+            if !metadata.isGhostPush {
+                lastPushPayload = payload
+            }
         }
     }
     
diff --git a/swift-sdk/Internal/IterableKeychain.swift b/swift-sdk/Internal/IterableKeychain.swift
@@ -63,74 +63,10 @@ class IterableKeychain {
         }
     }
     
-    func getLastPushPayload(currentDate: Date) -> [AnyHashable: Any]? {
-        guard let payloadExpirationPair = getPayloadExpirationPairFromKeychain() else {
-            return nil
-        }
-        
-        if isLastPushPayloadExpired(expiration: payloadExpirationPair.expiration, currentDate: currentDate) {
-            removePayloadExpirationPairFromKeychain()
-            return nil
-        }
-        
-        return decodeJsonPayload(payloadExpirationPair.payload)
-    }
-    
-    func setLastPushPayload(_ payload: [AnyHashable: Any]?, withExpiration expiration: Date?) {
-        guard let payload = payload, JSONSerialization.isValidJSONObject(payload) else {
-            removePayloadExpirationPairFromKeychain()
-            return
-        }
-        
-        savePayloadExpirationPairToKeychain(payload: payload, expiration: expiration)
-    }
-    
     // MARK: - PRIVATE/INTERNAL
     
     private let wrapper: KeychainWrapper
     
-    private func getPayloadExpirationPairFromKeychain() -> (payload: Data, expiration: Date?)? {
-        // get the value from the keychain
-        guard let keychainValue = wrapper.data(forKey: Const.Keychain.Key.lastPushPayloadAndExpiration) else {
-            return nil
-        }
-        
-        // decode the payload/expiration pair
-        guard let payloadExpirationPair = try? JSONDecoder().decode(LastPushPayloadValue.self, from: keychainValue) else {
-            return nil
-        }
-        
-        // cast the payload as a JSON object
-        guard let lastPushPayloadJSON = try? JSONSerialization.jsonObject(with: payloadExpirationPair.payload, options: []) as? [AnyHashable: Any] else {
-            return nil
-        }
-        
-        guard let lastPushPayloadData = try? JSONSerialization.data(withJSONObject: lastPushPayloadJSON) else {
-            return nil
-        }
-        
-        return (payload: lastPushPayloadData, expiration: payloadExpirationPair.expiration)
-    }
-    
-    private func savePayloadExpirationPairToKeychain(payload: [AnyHashable: Any]?, expiration: Date?) {
-        guard let payload = payload else {
-            removePayloadExpirationPairFromKeychain()
-            return
-        }
-        
-        guard let payloadAsData = encodeJsonPayload(payload) else {
-            return
-        }
-        
-        let payloadExpirationPair = LastPushPayloadValue(payload: payloadAsData, expiration: expiration)
-        
-        guard let encodedPair = try? JSONEncoder().encode(payloadExpirationPair) else {
-            return
-        }
-        
-        wrapper.set(encodedPair, forKey: Const.Keychain.Key.lastPushPayloadAndExpiration)
-    }
-    
     private func encodeJsonPayload(_ json: [AnyHashable: Any]?) -> Data? {
         guard let json = json, JSONSerialization.isValidJSONObject(json) else {
             return nil
@@ -147,20 +83,4 @@ class IterableKeychain {
         return try? JSONSerialization.jsonObject(with: data) as? [AnyHashable: Any]
     }
     
-    private func removePayloadExpirationPairFromKeychain() {
-        wrapper.removeValue(forKey: Const.Keychain.Key.lastPushPayloadAndExpiration)
-    }
-    
-    private func isLastPushPayloadExpired(expiration: Date?, currentDate: Date) -> Bool {
-        guard let expiration = expiration else {
-            return false
-        }
-        
-        return !(expiration.timeIntervalSinceReferenceDate > currentDate.timeIntervalSinceReferenceDate)
-    }
-    
-    private struct LastPushPayloadValue: Codable {
-        let payload: Data
-        let expiration: Date?
-    }
 }
diff --git a/swift-sdk/Internal/IterableUserDefaults.swift b/swift-sdk/Internal/IterableUserDefaults.swift
@@ -78,33 +78,9 @@ class IterableUserDefaults {
         try? save(codable: attributionInfo, withKey: .attributionInfo, andExpiration: expiration)
     }
     
-    // migrated to IterableKeychain
-    func getPayload(currentDate: Date) -> [AnyHashable: Any]? {
-        (try? dict(withKey: .payload, currentDate: currentDate)) ?? nil
-    }
-    
-    // migrated to IterableKeychain
-    func save(payload: [AnyHashable: Any]?, withExpiration expiration: Date?) {
-        try? save(dict: payload, withKey: .payload, andExpiration: expiration)
-    }
     
     // MARK: data migration functions
     
-    func getLastPushPayloadExpirationPairForMigration() -> (payload: [AnyHashable: Any]?, expiration: Date?)? {
-        guard let encodedEnvelope = userDefaults.value(forKey: UserDefaultsKey.payload.value) as? Data else {
-            return nil
-        }
-        
-        do {
-            let envelope = try JSONDecoder().decode(Envelope.self, from: encodedEnvelope)
-            let decoded = try JSONSerialization.jsonObject(with: envelope.payload, options: []) as? [AnyHashable: Any]
-            
-            return (payload: decoded, envelope.expiration)
-        } catch {
-            return nil
-        }
-    }
-    
     func getAuthDataForMigration() -> (email: String?, userId: String?, authToken: String?) {
         return (email: email, userId: userId, authToken: authToken)
     }
@@ -212,8 +188,6 @@ class IterableUserDefaults {
         private init(value: String) {
             self.value = value
         }
-        
-        static let payload = UserDefaultsKey(value: Const.UserDefault.payloadKey)
         static let attributionInfo = UserDefaultsKey(value: Const.UserDefault.attributionInfoKey)
         static let email = UserDefaultsKey(value: Const.UserDefault.emailKey)
         static let userId = UserDefaultsKey(value: Const.UserDefault.userIdKey)
diff --git a/swift-sdk/Internal/LocalStorage.swift b/swift-sdk/Internal/LocalStorage.swift
@@ -75,22 +75,11 @@ struct LocalStorage: LocalStorageProtocol {
         iterableUserDefaults.save(attributionInfo: attributionInfo, withExpiration: expiration)
     }
     
-    func getLastPushPayload(_ currentDate: Date) -> [AnyHashable: Any]? {
-        return keychain.getLastPushPayload(currentDate: currentDate)
-    }
-    
-    func saveLastPushPayload(_ payload: [AnyHashable: Any]?, withExpiration expiration: Date?) {
-        keychain.setLastPushPayload(payload, withExpiration: expiration)
-    }
-    
     func upgrade() {
         ITBInfo()
         
         /// moves `email`, `userId`, and `authToken` from `UserDefaults` to `IterableKeychain`
         moveAuthDataFromUserDefaultsToKeychain()
-        
-        /// moves `lastPushPayload` from `UserDefaults` to `IterableKeychain`
-        moveLastPushPayloadFromUserDefaultsToKeychain()
     }
     
     // MARK: Private
@@ -131,13 +120,4 @@ struct LocalStorage: LocalStorageProtocol {
             ITBInfo("UPDATED: migrated authToken from UserDefaults to IterableKeychain")
         }
     }
-    
-    private func moveLastPushPayloadFromUserDefaultsToKeychain() {
-        if let (userDefaultLastPushPayload, expiration) = iterableUserDefaults.getLastPushPayloadExpirationPairForMigration() {
-            keychain.setLastPushPayload(userDefaultLastPushPayload, withExpiration: expiration)
-            iterableUserDefaults.save(payload: nil, withExpiration: nil)
-            
-            ITBInfo("UPDATED: migrated lastPushPayload from UserDefaults to IterableKeychain")
-        }
-    }
 }
diff --git a/swift-sdk/Internal/LocalStorageProtocol.swift b/swift-sdk/Internal/LocalStorageProtocol.swift
@@ -23,10 +23,6 @@ protocol LocalStorageProtocol {
     
     func save(attributionInfo: IterableAttributionInfo?, withExpiration expiration: Date?)
     
-    func getLastPushPayload(_ currentDate: Date) -> [AnyHashable: Any]?
-    
-    func saveLastPushPayload(_ payload: [AnyHashable: Any]?, withExpiration expiration: Date?)
-    
     func upgrade()
 }
 
diff --git a/tests/common/MockLocalStorage.swift b/tests/common/MockLocalStorage.swift
@@ -33,22 +33,6 @@ class MockLocalStorage: LocalStorageProtocol {
         attributionInfoExpiration = expiration
     }
     
-    func getLastPushPayload(_ currentDate: Date) -> [AnyHashable : Any]? {
-        guard !MockLocalStorage.isExpired(expiration: payloadExpiration, currentDate: currentDate) else {
-            return nil
-        }
-        
-        return payload
-    }
-    
-    func saveLastPushPayload(_ payload: [AnyHashable : Any]?, withExpiration expiration: Date?) {
-        self.payload = payload
-        payloadExpiration = expiration
-    }
-    
-    private var payload: [AnyHashable: Any]? = nil
-    private var payloadExpiration: Date? = nil
-    
     private var attributionInfo: IterableAttributionInfo? = nil
     private var attributionInfoExpiration: Date? = nil
     
diff --git a/tests/unit-tests/LocalStorageTests.swift b/tests/unit-tests/LocalStorageTests.swift
diff --git a/tests/unit-tests/NotificationResponseTests.swift b/tests/unit-tests/NotificationResponseTests.swift
