feat: fetch in-app messages on new profile identification (#794)

customerio · Aug 21, 2024 · 13032c6 · 13032c6
1 parent 46bda24
commit 13032c6
Show file tree

Hide file tree

Showing 7 changed files with 26 additions and 0 deletions.
diff --git a/Sources/MessagingInApp/Gist/EngineWeb/EngineWeb.swift b/Sources/MessagingInApp/Gist/EngineWeb/EngineWeb.swift
@@ -75,6 +75,7 @@ public class EngineWeb: NSObject {
     }
 
     public func cleanEngineWeb() {
+        Logger.instance.debug(message: "Cleaning EngineWeb")
         webView.removeFromSuperview()
         webView.configuration.userContentController.removeAllUserScripts()
         webView.configuration.userContentController.removeScriptMessageHandler(forName: "gist")

diff --git a/Sources/MessagingInApp/Gist/Gist.swift b/Sources/MessagingInApp/Gist/Gist.swift
@@ -32,6 +32,7 @@ public class Gist: GistDelegate {
 
     public func setUserToken(_ userToken: String) {
         UserManager().setUserToken(userToken: userToken)
+        messageQueueManager.fetchUserMessagesFromRemoteQueue()
     }
 
     public func clearUserToken() {

diff --git a/Sources/MessagingInApp/Gist/Managers/MessageManager.swift b/Sources/MessagingInApp/Gist/Managers/MessageManager.swift
@@ -50,6 +50,8 @@ class MessageManager: EngineWebDelegate {
     }
 
     private func loadModalMessage() {
+        Logger.instance.debug(message: "Loading modal message with id: \(currentMessage.messageId), messageLoaded: \(messageLoaded)")
+
         if messageLoaded {
             modalViewManager = ModalViewManager(gistView: gistView, position: messagePosition)
             modalViewManager?.showModalView { [weak self] in
@@ -61,6 +63,8 @@ class MessageManager: EngineWebDelegate {
     }
 
     func dismissMessage(completionHandler: (() -> Void)? = nil) {
+        Logger.instance.debug(message: "Dismissing message with id: \(currentMessage.messageId)")
+
         if let modalViewManager = modalViewManager {
             modalViewManager.dismissModalView { [weak self] in
                 guard let self = self else { return }
@@ -71,6 +75,8 @@ class MessageManager: EngineWebDelegate {
     }
 
     func removePersistentMessage() {
+        Logger.instance.debug(message: "Removing persistent message with id: \(currentMessage.messageId)")
+
         if currentMessage.gistProperties.persistent == true {
             Logger.instance.debug(message: "Persistent message dismissed, logging view")
             Gist.shared.logMessageView(message: currentMessage)

diff --git a/Sources/MessagingInApp/Gist/Managers/MessageQueueManager.swift b/Sources/MessagingInApp/Gist/Managers/MessageQueueManager.swift
@@ -11,6 +11,7 @@ class MessageQueueManager {
         queueTimer?.invalidate()
         queueTimer = nil
 
+        Logger.instance.debug(message: "Scheduling fetch messages after interval \(interval) with skipQueueCheck \(skipQueueCheck)")
         queueTimer = Timer.scheduledTimer(
             timeInterval: interval,
             target: self,
@@ -23,6 +24,7 @@ class MessageQueueManager {
             // Since on app launch there's a short period where the applicationState is still set to "background"
             // We wait 1 second for the app to become active before checking for messages.
             DispatchQueue.main.asyncAfter(deadline: .now() + 1) {
+                Logger.instance.info(message: "Fetching user messages on setup")
                 self.fetchUserMessages()
             }
         }
@@ -61,11 +63,17 @@ class MessageQueueManager {
 
     private func addMessageToLocalStore(message: Message) {
         guard let queueId = message.queueId else {
+            Logger.instance.debug(message: "Message has no queueId, skipping.")
             return
         }
         localMessageStore.updateValue(message, forKey: queueId)
     }
 
+    func fetchUserMessagesFromRemoteQueue() {
+        Logger.instance.debug(message: "Fetching user messages from remote queue")
+        fetchUserMessages()
+    }
+
     @objc
     private func fetchUserMessages() {
         if UIApplication.shared.applicationState != .background {
@@ -78,9 +86,11 @@ class MessageQueueManager {
                             Logger.instance.info(message: "No changes to remote queue")
                         case .success(let responses):
                             guard let responses else {
+                                Logger.instance.error(message: "No responses found in remote queue")
                                 return
                             }
                             // To prevent us from showing expired / revoked messages, clear user messages from local queue.
+                            Logger.instance.info(message: "Clearing local store with \(self.localMessageStore.count) messages")
                             self.clearUserMessagesFromLocalStore()
                             Logger.instance.info(message: "Gist queue service found \(responses.count) new messages")
                             for queueMessage in responses {
@@ -128,6 +138,7 @@ class MessageQueueManager {
             Gist.shared.embedMessage(message: message, elementId: elementId)
             return
         } else {
+            Logger.instance.info(message: "Showing message with position \(position)")
             _ = Gist.shared.showMessage(message, position: position)
         }
     }

diff --git a/Sources/MessagingInApp/Gist/Managers/ModalViewManager.swift b/Sources/MessagingInApp/Gist/Managers/ModalViewManager.swift
@@ -19,6 +19,7 @@ class ModalViewManager {
     }
 
     func showModalView(completionHandler: @escaping () -> Void) {
+        Logger.instance.debug(message: "Showing modal view")
         viewController.view.isHidden = true
         window = getUIWindow()
         window.rootViewController = viewController
@@ -43,13 +44,15 @@ class ModalViewManager {
             UIView.animate(withDuration: 0.1, delay: 0, options: [.curveEaseIn], animations: {
                 self.viewController.view.backgroundColor = UIColor.black.withAlphaComponent(0.2)
             }, completion: nil)
+            Logger.instance.debug(message: "Modal view shown")
             completionHandler()
         })
 
         viewController.view.isHidden = false
     }
 
     func dismissModalView(completionHandler: @escaping () -> Void) {
+        Logger.instance.debug(message: "Dismissing modal view")
         var finalPosition: CGFloat = 0
         switch position {
         case .top:
@@ -69,6 +72,7 @@ class ModalViewManager {
                 self.window?.isHidden = false
                 self.viewController.removeFromParent()
                 self.window = nil
+                Logger.instance.debug(message: "Modal view dismissed")
                 completionHandler()
             })
         })

diff --git a/Sources/MessagingInApp/Gist/Managers/UserManager.swift b/Sources/MessagingInApp/Gist/Managers/UserManager.swift
@@ -9,10 +9,12 @@ class UserManager {
     }
 
     func setUserToken(userToken: String) {
+        Logger.instance.info(message: "User token set: \(userToken)")
         defaults.set(userToken, forKey: userTokenKey)
     }
 
     func clearUserToken() {
+        Logger.instance.info(message: "User token cleared")
         defaults.removeObject(forKey: userTokenKey)
     }
 }
diff --git a/Sources/MessagingInApp/MessagingInAppImplementation.swift b/Sources/MessagingInApp/MessagingInAppImplementation.swift
@@ -28,6 +28,7 @@ class MessagingInAppImplementation: MessagingInAppInstance {
     }
 
     func initialize() {
+        logger.debug("initializing in-app messaging with region: \(region)")
         inAppProvider.initialize(siteId: siteId, region: region, delegate: self, enableLogging: logLevel == .debug)
 
         // if identifier is already present, set the userToken again so in case if the customer was already identified and