feat: do not show modal message if change screens and page rule enabled

Makefile

@@ -10,7 +10,7 @@ generate:
 	./binny sourcery --sources Sources/MessagingPush --templates Sources/Templates --output Sources/MessagingPush/autogenerated --args imports=CioInternalCommon
 	./binny sourcery --sources Sources/MessagingPushAPN --templates Sources/Templates --output Sources/MessagingPushAPN/autogenerated --args imports=CioMessagingPush-CioInternalCommon
 	./binny sourcery --sources Sources/MessagingPushFCM --templates Sources/Templates --output Sources/MessagingPushFCM/autogenerated --args imports=CioMessagingPush-CioInternalCommon
-	./binny sourcery --sources Sources/MessagingInApp --templates Sources/Templates --output Sources/MessagingInApp/autogenerated --args imports=CioInternalCommon
+	./binny sourcery --sources Sources/MessagingInApp --templates Sources/Templates --output Sources/MessagingInApp/autogenerated --args imports=CioInternalCommon-UIKit
 	./binny sourcery --sources Sources/Migration --templates Sources/Templates --output Sources/Migration/autogenerated --args imports=CioInternalCommon
 
 

Sources/MessagingInApp/Gist/EngineWeb/EngineWeb.swift

@@ -1,3 +1,4 @@
+import CioInternalCommon
 import Foundation
 import UIKit
 import WebKit
@@ -12,7 +13,13 @@ public protocol EngineWebDelegate: AnyObject {
     func error()
 }
 
-public class EngineWeb: NSObject {
+protocol EngineWebInstance: AutoMockable {
+    var delegate: EngineWebDelegate? { get set }
+    var view: UIView { get }
+    func cleanEngineWeb()
+}
+
+public class EngineWeb: NSObject, EngineWebInstance {
     private var _currentRoute = ""
     private var _timeoutTimer: Timer?
     private var _elapsedTimer = ElapsedTimer()

Sources/MessagingInApp/Gist/EngineWeb/EngineWebProvider.swift

@@ -0,0 +1,14 @@
+import CioInternalCommon
+import Foundation
+
+// Allows us to mock EngineWeb instances for testing.
+protocol EngineWebProvider {
+    func getEngineWebInstance(configuration: EngineWebConfiguration) -> EngineWebInstance
+}
+
+// sourcery: InjectRegisterShared = "EngineWebProvider"
+class EngineWebProviderImpl: EngineWebProvider {
+    func getEngineWebInstance(configuration: EngineWebConfiguration) -> EngineWebInstance {
+        EngineWeb(configuration: configuration)
+    }
+}

Sources/MessagingInApp/Gist/Gist.swift

@@ -28,6 +28,14 @@
         _ = Gist.shared.getMessageView(Message(messageId: ""))
     }
 
+    // For testing to reset the singleton state
+    func reset() {
+        clearUserToken()
+        messageQueueManager = MessageQueueManager()
+        messageManagers = []
+        RouteManager.clearCurrentRoute()
+    }
+
     // MARK: User
 
     public func setUserToken(_ userToken: String) {
@@ -46,6 +54,11 @@
     }
 
     public func setCurrentRoute(_ currentRoute: String) {
+        if RouteManager.getCurrentRoute() == currentRoute {
+            return // ignore request, route has not changed.
+        }
+
+        cancelLoadingModalMessage()
         RouteManager.setCurrentRoute(currentRoute)
         messageQueueManager.fetchUserMessagesFromLocalStore()
     }
@@ -126,6 +139,41 @@
             }
     }
 
+    // If someone sets a page rule on a message, they want the message to show on that screen. Because messages can take multiple seconds to finish rendering, there is a chance that
+    // a user navigates away fron a screen when the rendering finishes. To fix this, cancel showing a modal message if a message is still loading.
+    //
+    // Like dismiss message, but does not call event listener.
+    // Dismiss the currently shown message, if there is one, and then remove message manager allowing us to show a message again in the future.
+    func cancelLoadingModalMessage() {
+        guard let messageManagerToCancel = getModalMessageManager() else {
+            return // no message being shown or loading.
+        }
+        let currentMessage = messageManagerToCancel.currentMessage
+
+        if messageManagerToCancel.isShowingMessage {
+            // The modal is already visible, don't cancel it.
+            // This can prevent an infinite loop scenario:
+            // * page rule changed and that triggers showing a Modal
+            // * Modal message is displayed on screen
+            // * Modal being displayed triggers an auto screenview tracking event. This triggers a SDK page route change
+            // * Request to cancel modal message
+            // * Back to the foreground screen that originally triggered showing a Modal message...repeat...
+            return
+        }
+
+        guard currentMessage.gistProperties.routeRule != nil else {
+            // The message does not have page rules setup so do not cancel showing it. Let it proceed.
+            return
+        }
+
+        Logger.instance.debug(message: "Cancelled showing message with id: \(currentMessage.messageId). Will try to show message again in future.")
+
+        removeMessageManager(instanceId: currentMessage.instanceId) // allows us to display a message in the future. Important to do this immediately instead of waiting for current message to dismiss.
+
+        // dismiss to smoothly transition off screen.
+        messageManagerToCancel.cancelShowingMessage()
+    }
+
     // Message Manager
 
     private func createMessageManager(siteId: String, message: Message) -> MessageManager {
@@ -135,7 +183,7 @@
         return messageManager
     }
 
-    private func getModalMessageManager() -> MessageManager? {
+    func getModalMessageManager() -> MessageManager? {
         messageManagers.first(where: { !$0.isMessageEmbed })
     }
 

Sources/MessagingInApp/Gist/Managers/MessageManager.swift

@@ -1,3 +1,4 @@
+import CioInternalCommon
 import Foundation
 import UIKit
 
@@ -6,17 +7,18 @@
 }
 
 class MessageManager: EngineWebDelegate {
-    private var engine: EngineWeb?
+    private var engine: EngineWebInstance
     private let siteId: String
     private var messagePosition: MessagePosition = .top
-    private var messageLoaded = false
+    var messageLoaded = false
     private var modalViewManager: ModalViewManager?
     var isMessageEmbed = false
     let currentMessage: Message
     var gistView: GistView!
     private var currentRoute: String
     private var elapsedTimer = ElapsedTimer()
     weak var delegate: GistDelegate?
+    private let engineWebProvider: EngineWebProvider = DIGraphShared.shared.engineWebProvider
 
     init(siteId: String, message: Message) {
         self.siteId = siteId
@@ -32,11 +34,17 @@
             properties: message.toEngineRoute().properties
         )
 
-        self.engine = EngineWeb(configuration: engineWebConfiguration)
-        if let engine = engine {
-            engine.delegate = self
-            self.gistView = GistView(message: currentMessage, engineView: engine.view)
+        self.engine = engineWebProvider.getEngineWebInstance(configuration: engineWebConfiguration)
+        engine.delegate = self
+        self.gistView = GistView(message: currentMessage, engineView: engine.view)
+    }
+
+    var isShowingMessage: Bool {
+        guard let modalViewManager = modalViewManager else {
+            return false
         }
+
+        return modalViewManager.isShowingMessage
     }
 
     func showMessage(position: MessagePosition) {
@@ -60,6 +68,16 @@
         }
     }
 
+    func cancelShowingMessage() {
+        if messageLoaded {
+            return // if message has already finished loading, do not cancel. Keep it shown.
+        }
+
+        engine.delegate = nil // to make sure we do not get a callback when message loaded and we try to show it.
+
+        dismissMessage() // to gracefully animate the removal of modal from UI if it began to show before.
+    }
+
     func dismissMessage(completionHandler: (() -> Void)? = nil) {
         if let modalViewManager = modalViewManager {
             modalViewManager.dismissModalView { [weak self] in
@@ -82,7 +100,7 @@
 
         // Cleaning after engine web is bootstrapped and all assets downloaded.
         if currentMessage.messageId == "" {
-            engine?.cleanEngineWeb()
+            engine.cleanEngineWeb()
         }
     }
 
@@ -223,8 +241,7 @@
     }
 
     deinit {
-        engine?.cleanEngineWeb()
-        engine = nil
+        engine.cleanEngineWeb()
     }
 
     private func showNewMessage(url: URL) {

Sources/MessagingInApp/Gist/Managers/MessageQueueManager.swift

@@ -28,6 +28,10 @@
         }
     }
 
+    deinit {
+        queueTimer?.invalidate()
+    }
+
     func fetchUserMessagesFromLocalStore() {
         Logger.instance.info(message: "Checking local store with \(localMessageStore.count) messages")
         let sortedMessages = localMessageStore.sorted {
@@ -44,7 +48,7 @@
             }
         }
         sortedMessages.forEach { message in
-            handleMessage(message: message.value)
+            showMessageIfMeetsCriteria(message: message.value)
         }
     }
 
@@ -59,11 +63,13 @@
         localMessageStore.removeValue(forKey: queueId)
     }
 
-    private func addMessageToLocalStore(message: Message) {
-        guard let queueId = message.queueId else {
-            return
+    func addMessagesToLocalStore(messages: [Message]) {
+        messages.forEach { message in
+            guard let queueId = message.queueId else {
+                return
+            }
+            localMessageStore.updateValue(message, forKey: queueId)
         }
-        localMessageStore.updateValue(message, forKey: queueId)
     }
 
     @objc
@@ -80,13 +86,10 @@
                             guard let responses else {
                                 return
                             }
-                            // To prevent us from showing expired / revoked messages, clear user messages from local queue.
-                            self.clearUserMessagesFromLocalStore()
+
                             Logger.instance.info(message: "Gist queue service found \(responses.count) new messages")
-                            for queueMessage in responses {
-                                let message = queueMessage.toMessage()
-                                self.handleMessage(message: message)
-                            }
+
+                            self.processFetchResponse(responses.map { $0.toMessage() })
                         case .failure(let error):
                             Logger.instance.error(message: "Error fetching messages from Gist queue service. \(error.localizedDescription)")
                         }
@@ -99,7 +102,18 @@
         }
     }
 
-    private func handleMessage(message: Message) {
+    func processFetchResponse(_ fetchedMessages: [Message]) {
+        // To prevent us from showing expired / revoked messages, reset the local queue with the latest queue from the backend service.
+        // The backend service is the single-source-of-truth for in-app messages for each user.
+        clearUserMessagesFromLocalStore()
+        addMessagesToLocalStore(messages: fetchedMessages)
+
+        for message in fetchedMessages {
+            showMessageIfMeetsCriteria(message: message)
+        }
+    }
+
+    private func showMessageIfMeetsCriteria(message: Message) {
         // Skip shown messages
         if let queueId = message.queueId, Gist.shared.shownMessageQueueIds.contains(queueId) {
             Logger.instance.info(message: "Message with queueId: \(queueId) already shown, skipping.")
@@ -114,12 +128,11 @@
                 let range = NSRange(location: 0, length: Gist.shared.getCurrentRoute().utf16.count)
                 if regex.firstMatch(in: Gist.shared.getCurrentRoute(), options: [], range: range) == nil {
                     Logger.instance.debug(message: "Current route is \(Gist.shared.getCurrentRoute()), needed \(cleanRouteRule)")
-                    addMessageToLocalStore(message: message)
-                    return
+                    return // exit early to not show the message since page rule doesnt match
                 }
             } else {
                 Logger.instance.info(message: "Problem processing route rule message regex: \(cleanRouteRule)")
-                return
+                return // exit early to not show the message since we cannot parse the page rule for message.
             }
         }
 

Sources/MessagingInApp/Gist/Managers/ModalViewManager.swift

@@ -7,9 +7,12 @@ public enum MessagePosition: String {
 }
 
 class ModalViewManager {
-    var window: UIWindow!
+    var window: UIWindow?
     var viewController: GistModalViewController!
     var position: MessagePosition
+    var isShowingMessage: Bool {
+        window != nil
+    }
 
     init(gistView: GistView, position: MessagePosition) {
         self.viewController = GistModalViewController()
@@ -21,8 +24,8 @@ class ModalViewManager {
     func showModalView(completionHandler: @escaping () -> Void) {
         viewController.view.isHidden = true
         window = getUIWindow()
-        window.rootViewController = viewController
-        window.isHidden = false
+        window?.rootViewController = viewController
+        window?.isHidden = false
         var finalPosition: CGFloat = 0
 
         switch position {
@@ -69,6 +72,7 @@ class ModalViewManager {
                 self.window?.isHidden = false
                 self.viewController.removeFromParent()
                 self.window = nil
+
                 completionHandler()
             })
         })

Sources/MessagingInApp/MessagingInApp.swift

@@ -43,6 +43,7 @@ public class MessagingInApp: ModuleTopLevelObject<MessagingInAppInstance>, Messa
 
     static func resetTestEnvironment() {
         shared = MessagingInApp()
+        Gist.shared.reset()
     }
     #endif
 

Sources/MessagingInApp/autogenerated/AutoDependencyInjection.generated.swift

@@ -4,6 +4,7 @@
 
 import CioInternalCommon
 import Foundation
+import UIKit
 
 /**
  ######################################################
@@ -54,13 +55,26 @@ extension DIGraphShared {
     func testDependenciesAbleToResolve() -> Int {
         var countDependenciesResolved = 0
 
+        _ = engineWebProvider
+        countDependenciesResolved += 1
+
         _ = inAppProvider
         countDependenciesResolved += 1
 
         return countDependenciesResolved
     }
 
     // Handle classes annotated with InjectRegisterShared
+    // EngineWebProvider
+    var engineWebProvider: EngineWebProvider {
+        getOverriddenInstance() ??
+            newEngineWebProvider
+    }
+
+    private var newEngineWebProvider: EngineWebProvider {
+        EngineWebProviderImpl()
+    }
+
     // InAppProvider
     var inAppProvider: InAppProvider {
         getOverriddenInstance() ??

Sources/MessagingInApp/autogenerated/AutoLenses.generated.swift

@@ -4,6 +4,7 @@
 
 import CioInternalCommon
 import Foundation
+import UIKit
 
 /**
  ######################################################