Merge pull request #442 from Iterable/MOB-2419-in-app-priority

roninopf · web-flow · commit ef2c76c9f1b0 · 2021-01-22T11:51:48.000-08:00
[MOB-2419] in-app priority
diff --git a/swift-sdk.xcodeproj/project.pbxproj b/swift-sdk.xcodeproj/project.pbxproj
@@ -16,6 +16,7 @@
 		5531CDAE22A9C992000D05E2 /* ClassExtensionsTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 5531CDAD22A9C992000D05E2 /* ClassExtensionsTests.swift */; };
 		5536781F2576FF9000DB3652 /* IterableUtilTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 5536781E2576FF9000DB3652 /* IterableUtilTests.swift */; };
 		556FB1EA244FAF6A00EDF6BD /* InAppPresenter.swift in Sources */ = {isa = PBXBuildFile; fileRef = 556FB1E9244FAF6A00EDF6BD /* InAppPresenter.swift */; };
+		55705A6925A78BF3009BDEE2 /* InAppPriorityTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 55705A6825A78BF3009BDEE2 /* InAppPriorityTests.swift */; };
 		557AE6BF24A56E5E00B57750 /* Auth.swift in Sources */ = {isa = PBXBuildFile; fileRef = 557AE6BE24A56E5E00B57750 /* Auth.swift */; };
 		5585DF8F22A73390000A32B9 /* IterableInboxViewControllerTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 5585DF8E22A73390000A32B9 /* IterableInboxViewControllerTests.swift */; };
 		55B3119B251015CF0056E4FC /* AuthManager.swift in Sources */ = {isa = PBXBuildFile; fileRef = 55298B222501A5AB00190BAE /* AuthManager.swift */; };
@@ -367,6 +368,7 @@
 		5531CDAD22A9C992000D05E2 /* ClassExtensionsTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ClassExtensionsTests.swift; sourceTree = "<group>"; };
 		5536781E2576FF9000DB3652 /* IterableUtilTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = IterableUtilTests.swift; sourceTree = "<group>"; };
 		556FB1E9244FAF6A00EDF6BD /* InAppPresenter.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = InAppPresenter.swift; sourceTree = "<group>"; };
+		55705A6825A78BF3009BDEE2 /* InAppPriorityTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; name = InAppPriorityTests.swift; path = "tests/swift-sdk-swift-tests/in-app-tests/InAppPriorityTests.swift"; sourceTree = SOURCE_ROOT; };
 		557AE6BE24A56E5E00B57750 /* Auth.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = Auth.swift; sourceTree = "<group>"; };
 		5585DF8E22A73390000A32B9 /* IterableInboxViewControllerTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = IterableInboxViewControllerTests.swift; sourceTree = "<group>"; };
 		5585DF9022A877E6000A32B9 /* IterableInboxViewControllerUITests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = IterableInboxViewControllerUITests.swift; sourceTree = "<group>"; };
@@ -687,12 +689,13 @@
 		557059B125A691D1009BDEE2 /* in-app-tests */ = {
 			isa = PBXGroup;
 			children = (
+				ACC3FD9D2536D7A30004A2E0 /* InAppFilePersistenceTests.swift */,
 				AC750A49234CD67900561902 /* InAppHelperTests.swift */,
 				AC6FDD8B20F56309005D811E /* InAppParsingTests.swift */,
 				55B37FED229F59290042F13A /* InAppPersistenceTests.swift */,
 				55CC257A2462064F00A77FD5 /* InAppPresenterTests.swift */,
+				55705A6825A78BF3009BDEE2 /* InAppPriorityTests.swift */,
 				ACA8D1A821965B7D001B1332 /* InAppTests.swift */,
-				ACC3FD9D2536D7A30004A2E0 /* InAppFilePersistenceTests.swift */,
 			);
 			path = "in-app-tests";
 			sourceTree = "<group>";
@@ -1815,6 +1818,7 @@
 				AC89661E2124FBCE0051A6CD /* IterableAutoRegistrationTests.swift in Sources */,
 				ACA8D1A921965B7D001B1332 /* InAppTests.swift in Sources */,
 				00B6FACC210E8484007535CF /* APNSTypeCheckerTests.swift in Sources */,
+				55705A6925A78BF3009BDEE2 /* InAppPriorityTests.swift in Sources */,
 				AC8F35A2239806B500302994 /* InboxViewControllerViewModelTests.swift in Sources */,
 				AC995F9A2166EEB50099A184 /* CommonMocks.swift in Sources */,
 				5585DF8F22A73390000A32B9 /* IterableInboxViewControllerTests.swift in Sources */,
diff --git a/swift-sdk/Constants.swift b/swift-sdk/Constants.swift
@@ -56,6 +56,15 @@ public enum Const {
         static let payloadExpiration = 24
         static let attributionInfoExpiration = 24
     }
+    
+    enum PriorityLevel {
+        static let critical = 100.0
+        static let high = 200.0
+        static let medium = 300.0
+        static let low = 400.0
+        
+        static let unassigned = 300.5
+    }
 }
 
 public protocol JsonKeyValueRepresentable {
@@ -106,6 +115,7 @@ public enum JsonKey: String, JsonKeyRepresentable {
     case inAppLocation = "location"
     case clickedUrl
     case read
+    case priorityLevel
     
     case inboxSessionStart
     case inboxSessionEnd
diff --git a/swift-sdk/Internal/InAppManager+Functions.swift b/swift-sdk/Internal/InAppManager+Functions.swift
@@ -69,7 +69,10 @@ struct MessagesProcessor {
     }
     
     private func getFirstProcessableTriggeredMessage() -> IterableInAppMessage? {
-        messagesMap.values.filter(MessagesProcessor.isProcessableTriggeredMessage).first
+        messagesMap.values
+            .filter(MessagesProcessor.isProcessableTriggeredMessage)
+            .sorted { $0.priorityLevel < $1.priorityLevel }
+            .first
     }
     
     private static func isProcessableTriggeredMessage(_ message: IterableInAppMessage) -> Bool {
diff --git a/swift-sdk/Internal/InAppManager.swift b/swift-sdk/Internal/InAppManager.swift
@@ -219,7 +219,7 @@ class InAppManager: NSObject, IterableInternalInAppManagerProtocol {
             .map { self.processMergedMessages(appIsReady: appIsReady, mergeMessagesResult: $0) }
     }
     
-    // messages are new messages coming from the server
+    /// `messages` are new messages coming from the server
     private func mergeMessages(_ messages: [IterableInAppMessage]) -> MergeMessagesResult {
         MessagesObtainedHandler(messagesMap: messagesMap, messages: messages).handle()
     }
@@ -231,7 +231,7 @@ class InAppManager: NSObject, IterableInternalInAppManagerProtocol {
             messagesMap = mergeMessagesResult.messagesMap
         }
         
-        // track in app delivery
+        // track in-app delivery
         mergeMessagesResult.deliveredMessages.forEach {
             _ = apiClient?.track(inAppDelivery: InAppMessageContext.from(message: $0, location: nil))
         }
diff --git a/swift-sdk/Internal/InAppMessageParser.swift b/swift-sdk/Internal/InAppMessageParser.swift
@@ -103,6 +103,7 @@ struct InAppMessageParser {
         let createdAt = parseTime(withKey: .inboxCreatedAt, fromJson: json)
         let expiresAt = parseTime(withKey: .inboxExpiresAt, fromJson: json)
         let read = json[JsonKey.read.jsonKey] as? Bool ?? false
+        let priorityLevel = json[JsonKey.priorityLevel.jsonKey] as? Double ?? Const.PriorityLevel.unassigned
         
         return .success(IterableInAppMessage(messageId: messageId,
                                              campaignId: campaignId,
@@ -113,7 +114,8 @@ struct InAppMessageParser {
                                              saveToInbox: saveToInbox,
                                              inboxMetadata: inboxMetadata,
                                              customPayload: customPayload,
-                                             read: read))
+                                             read: read,
+                                             priorityLevel: priorityLevel))
     }
     
     private static func parseTime(withKey key: JsonKey, fromJson json: [AnyHashable: Any]) -> Date? {
diff --git a/swift-sdk/Internal/InAppPersistence.swift b/swift-sdk/Internal/InAppPersistence.swift
@@ -234,6 +234,7 @@ extension IterableInAppMessage: Codable {
         case read
         case trigger
         case content
+        case priorityLevel
     }
     
     enum ContentCodingKeys: String, CodingKey {
@@ -265,6 +266,7 @@ extension IterableInAppMessage: Codable {
         
         let trigger = (try? container.decode(IterableInAppTrigger.self, forKey: .trigger)) ?? .undefinedTrigger
         let content = IterableInAppMessage.decodeContent(from: container)
+        let priorityLevel = (try? container.decode(Double.self, forKey: .priorityLevel)) ?? Const.PriorityLevel.unassigned
         
         self.init(messageId: messageId,
                   campaignId: campaignId,
@@ -275,7 +277,8 @@ extension IterableInAppMessage: Codable {
                   saveToInbox: saveToInbox,
                   inboxMetadata: inboxMetadata,
                   customPayload: customPayload,
-                  read: read)
+                  read: read,
+                  priorityLevel: priorityLevel)
         
         self.didProcessTrigger = didProcessTrigger
         self.consumed = consumed
@@ -294,6 +297,7 @@ extension IterableInAppMessage: Codable {
         try? container.encode(didProcessTrigger, forKey: .didProcessTrigger)
         try? container.encode(consumed, forKey: .consumed)
         try? container.encode(read, forKey: .read)
+        try? container.encode(priorityLevel, forKey: .priorityLevel)
         
         if let inboxMetadata = inboxMetadata {
             try? container.encode(inboxMetadata, forKey: .inboxMetadata)
diff --git a/swift-sdk/Internal/RequestProcessorUtil.swift b/swift-sdk/Internal/RequestProcessorUtil.swift
@@ -24,7 +24,7 @@ struct RequestProcessorUtil {
             } else if error.httpStatusCode == 401, error.iterableCode == JsonValue.Code.badApiKey {
                 ITBError(error.reason)
             }
-
+            
             if let onFailure = onFailure {
                 onFailure(error.reason, error.data)
             } else {
diff --git a/swift-sdk/IterableMessaging.swift b/swift-sdk/IterableMessaging.swift
@@ -194,6 +194,9 @@ public extension Notification.Name {
         saveToInbox && trigger.type == .never
     }
     
+    /// the urgency level of this message (nil will be treated as `unassigned` when displaying this message)
+    public var priorityLevel: Double
+    
     // MARK: - Private/Internal
     
     init(messageId: String,
@@ -205,7 +208,8 @@ public extension Notification.Name {
          saveToInbox: Bool = false,
          inboxMetadata: IterableInboxMetadata? = nil,
          customPayload: [AnyHashable: Any]? = nil,
-         read: Bool = false) {
+         read: Bool = false,
+         priorityLevel: Double = Const.PriorityLevel.unassigned) {
         self.messageId = messageId
         self.campaignId = campaignId
         self.trigger = trigger
@@ -216,5 +220,6 @@ public extension Notification.Name {
         self.inboxMetadata = inboxMetadata
         self.customPayload = customPayload
         self.read = read
+        self.priorityLevel = priorityLevel
     }
 }
diff --git a/tests/common/CommonExtensions.swift b/tests/common/CommonExtensions.swift
@@ -126,7 +126,7 @@ extension IterableAPI {
                                      localStorage: LocalStorageProtocol = MockLocalStorage(),
                                      inAppFetcher: InAppFetcherProtocol = MockInAppFetcher(),
                                      inAppDisplayer: InAppDisplayerProtocol = MockInAppDisplayer(),
-                                     inAppPersister: InAppPersistenceProtocol = MockInAppPesister(),
+                                     inAppPersister: InAppPersistenceProtocol = MockInAppPersister(),
                                      urlOpener: UrlOpenerProtocol = MockUrlOpener(),
                                      applicationStateProvider: ApplicationStateProviderProtocol = UIApplication.shared,
                                      notificationCenter: NotificationCenterProtocol = NotificationCenter.default,
@@ -169,7 +169,7 @@ extension IterableAPIInternal {
                                                         localStorage: LocalStorageProtocol = MockLocalStorage(),
                                                         inAppFetcher: InAppFetcherProtocol = MockInAppFetcher(),
                                                         inAppDisplayer: InAppDisplayerProtocol = MockInAppDisplayer(),
-                                                        inAppPersister: InAppPersistenceProtocol = MockInAppPesister(),
+                                                        inAppPersister: InAppPersistenceProtocol = MockInAppPersister(),
                                                         urlOpener: UrlOpenerProtocol = MockUrlOpener(),
                                                         applicationStateProvider: ApplicationStateProviderProtocol = UIApplication.shared,
                                                         notificationCenter: NotificationCenterProtocol = NotificationCenter.default,
diff --git a/tests/common/CommonMocks.swift b/tests/common/CommonMocks.swift
@@ -458,7 +458,7 @@ class MockNotificationCenter: NotificationCenterProtocol {
     private var observers = [Observer]()
 }
 
-class MockInAppPesister: InAppPersistenceProtocol {
+class MockInAppPersister: InAppPersistenceProtocol {
     private var messages = [IterableInAppMessage]()
     
     func getMessages() -> [IterableInAppMessage] {
diff --git a/tests/swift-sdk-swift-tests/in-app-tests/InAppPriorityTests.swift b/tests/swift-sdk-swift-tests/in-app-tests/InAppPriorityTests.swift
@@ -0,0 +1,119 @@
+//
+//  Copyright © 2021 Iterable. All rights reserved.
+//
+
+import XCTest
+
+@testable import IterableSDK
+
+class InAppPriorityTests: XCTestCase {
+//    func testDisplayingCriticalPriorityLevel() {
+//        let condition1 = expectation(description: "in-app displayer didn't show or succeed")
+//        
+//        let messageIdWithCritical = "4"
+//        
+//        let messages = [
+//            getMessageWithPriority("1", Const.PriorityLevel.low),
+//            getMessageWithPriority("2", Const.PriorityLevel.high),
+//            getMessageWithPriority("3", Const.PriorityLevel.medium),
+//            getMessageWithPriority(messageIdWithCritical, Const.PriorityLevel.critical)
+//        ]
+//        
+//        let mockInAppFetcher = MockInAppFetcher()
+//        let mockInAppDisplayer = MockInAppDisplayer()
+//
+//        mockInAppDisplayer.onShow.onSuccess { message in
+//            mockInAppDisplayer.click(url: URL(string: "https://iterable.com")!)
+//            
+//            XCTAssertEqual(message.messageId, messageIdWithCritical)
+//            
+//            condition1.fulfill()
+//        }
+//        
+//        let internalAPI = IterableAPIInternal.initializeForTesting(inAppFetcher: mockInAppFetcher,
+//                                                                   inAppDisplayer: mockInAppDisplayer)
+//        
+//        mockInAppFetcher.mockMessagesAvailableFromServer(internalApi: internalAPI, messages: messages)
+//        
+//        wait(for: [condition1], timeout: testExpectationTimeout)
+//    }
+    
+    func testGetMessagesWithOutOfOrderPriorityLevels() {
+        let condition1 = expectation(description: "in-app messages never fetched")
+        
+        let messages = [
+            getMessageWithPriority("0", Const.PriorityLevel.critical), // a decoy message that will get dropped by the fetcher
+            getMessageWithPriority("1", Const.PriorityLevel.critical),
+            getMessageWithPriority("2", Const.PriorityLevel.low),
+            getMessageWithPriority("3", Const.PriorityLevel.high),
+            getMessageWithPriority("4", Const.PriorityLevel.medium)
+        ]
+        
+        let mockInAppFetcher = MockInAppFetcher()
+        
+        let internalAPI = IterableAPIInternal.initializeForTesting(inAppFetcher: mockInAppFetcher)
+        
+        mockInAppFetcher.mockMessagesAvailableFromServer(internalApi: internalAPI, messages: messages).onSuccess { _ in
+            let originalMessages = messages.dropFirst()
+            let processedMessages = internalAPI.inAppManager.getMessages()
+            
+            XCTAssertEqual(originalMessages.map { $0.messageId }, processedMessages.map { $0.messageId })
+            
+            condition1.fulfill()
+        }
+        
+        wait(for: [condition1], timeout: testExpectationTimeout)
+    }
+    
+    func testMessageWithNoPriorityTreatedAsDefaultLevel() {
+        let condition1 = expectation(description: "In-App Displayer didn't get called")
+        
+        let messageIdForNoPriority = "2"
+        
+        let messages = [getMessageWithPriority("1", Const.PriorityLevel.low),
+                        getEmptyMessage(messageIdForNoPriority)]
+        
+        let mockInAppFetcher = MockInAppFetcher(messages: messages)
+        let mockInAppDisplayer = MockInAppDisplayer()
+        
+        mockInAppDisplayer.onShow.onSuccess { message in
+            XCTAssertEqual(message.messageId, messageIdForNoPriority)
+            
+            condition1.fulfill()
+        }
+        
+        _ = IterableAPIInternal.initializeForTesting(inAppFetcher: mockInAppFetcher,
+                                                     inAppDisplayer: mockInAppDisplayer)
+        
+        wait(for: [condition1], timeout: testExpectationTimeout)
+    }
+    
+    func testInAppMessagePriorityPersistence() {
+        let messages = [
+            getMessageWithPriority("1", Const.PriorityLevel.critical),
+            getMessageWithPriority("2", Const.PriorityLevel.low),
+            getMessageWithPriority("3", Const.PriorityLevel.high),
+            getMessageWithPriority("4", Const.PriorityLevel.medium)
+        ]
+        
+        let mockInAppFetcher = MockInAppFetcher(messages: messages)
+        let mockInAppPersister = MockInAppPersister()
+        
+        _ = IterableAPIInternal.initializeForTesting(inAppFetcher: mockInAppFetcher,
+                                                     inAppPersister: mockInAppPersister)
+        
+        XCTAssertEqual(messages.map { $0.priorityLevel }, mockInAppPersister.getMessages().map { $0.priorityLevel })
+    }
+    
+    // MARK: - Private
+    
+    private let emptyInAppContent = IterableHtmlInAppContent(edgeInsets: .zero, html: "")
+    
+    private func getMessageWithPriority(_ id: String = "", _ level: Double = Const.PriorityLevel.unassigned) -> IterableInAppMessage {
+        return IterableInAppMessage(messageId: id, campaignId: nil, content: emptyInAppContent, priorityLevel: level)
+    }
+    
+    private func getEmptyMessage(_ id: String = "") -> IterableInAppMessage {
+        return IterableInAppMessage(messageId: id, campaignId: nil, content: emptyInAppContent)
+    }
+}
diff --git a/tests/swift-sdk-swift-tests/in-app-tests/InAppTests.swift b/tests/swift-sdk-swift-tests/in-app-tests/InAppTests.swift
@@ -127,7 +127,7 @@ class InAppTests: XCTestCase {
     
     func testAutoShowInAppMultipleWithOrdering() {
         let expectation0 = expectation(description: "testAutoShowInAppMultiple")
-        expectation0.expectedFulfillmentCount = 3 // three times
+        expectation0.expectedFulfillmentCount = 3
         let expectation1 = expectation(description: "testAutoShowInAppMultiple, first")
         let expectation2 = expectation(description: "testAutoShowInAppMultiple, second")
         let expectation3 = expectation(description: "testAutoShowInAppMultiple, third")
@@ -379,7 +379,7 @@ class InAppTests: XCTestCase {
         
         XCTAssertEqual(internalApi.inAppManager.getMessages().count, 0)
     }
-
+    
     func testShowInAppWithNoConsume() {
         let expectation1 = expectation(description: "testShowInAppWithConsume")
         let expectation2 = expectation(description: "url opened")
@@ -467,7 +467,7 @@ class InAppTests: XCTestCase {
             }
         }
         
-        wait(for: [expectation1, expectation2/*, expectation3*/], timeout: testExpectationTimeout)
+        wait(for: [expectation1, expectation2], timeout: testExpectationTimeout)
         XCTAssertEqual(internalApi.inAppManager.getMessages().count, 0)
     }
     

Original file line number	Diff line number	Diff line change
`@@ -69,7 +69,10 @@ struct MessagesProcessor {`
`69`	`69`	`}`
`70`	`70`
`71`	`71`	`private func getFirstProcessableTriggeredMessage() -> IterableInAppMessage? {`
`72`		`- messagesMap.values.filter(MessagesProcessor.isProcessableTriggeredMessage).first`
	`72`	`+ messagesMap.values`
	`73`	`+ .filter(MessagesProcessor.isProcessableTriggeredMessage)`
	`74`	`+ .sorted { $0.priorityLevel < $1.priorityLevel }`
	`75`	`+ .first`
`73`	`76`	`}`
`74`	`77`
`75`	`78`	`private static func isProcessableTriggeredMessage(_ message: IterableInAppMessage) -> Bool {`
Original file line number	Diff line number	Diff line change
`@@ -219,7 +219,7 @@ class InAppManager: NSObject, IterableInternalInAppManagerProtocol {`
`219`	`219`	`.map { self.processMergedMessages(appIsReady: appIsReady, mergeMessagesResult: $0) }`
`220`	`220`	`}`
`221`	`221`
`222`		`- // messages are new messages coming from the server`
	`222`	+ /// `messages` are new messages coming from the server
`223`	`223`	`private func mergeMessages(_ messages: [IterableInAppMessage]) -> MergeMessagesResult {`
`224`	`224`	`MessagesObtainedHandler(messagesMap: messagesMap, messages: messages).handle()`
`225`	`225`	`}`
`@@ -231,7 +231,7 @@ class InAppManager: NSObject, IterableInternalInAppManagerProtocol {`
`231`	`231`	`messagesMap = mergeMessagesResult.messagesMap`
`232`	`232`	`}`
`233`	`233`
`234`		`- // track in app delivery`
	`234`	`+ // track in-app delivery`
`235`	`235`	`mergeMessagesResult.deliveredMessages.forEach {`
`236`	`236`	`_ = apiClient?.track(inAppDelivery: InAppMessageContext.from(message: $0, location: nil))`
`237`	`237`	`}`
Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,7 @@ struct RequestProcessorUtil {`
`24`	`24`	`} else if error.httpStatusCode == 401, error.iterableCode == JsonValue.Code.badApiKey {`
`25`	`25`	`ITBError(error.reason)`
`26`	`26`	`}`
`27`		`-`
	`27`	`+`
`28`	`28`	`if let onFailure = onFailure {`
`29`	`29`	`onFailure(error.reason, error.data)`
`30`	`30`	`} else {`
Original file line number	Diff line number	Diff line change
`@@ -458,7 +458,7 @@ class MockNotificationCenter: NotificationCenterProtocol {`
`458`	`458`	`private var observers = [Observer]()`
`459`	`459`	`}`
`460`	`460`
`461`		`-class MockInAppPesister: InAppPersistenceProtocol {`
	`461`	`+class MockInAppPersister: InAppPersistenceProtocol {`
`462`	`462`	`private var messages = [IterableInAppMessage]()`
`463`	`463`
`464`	`464`	`func getMessages() -> [IterableInAppMessage] {`