feat: support for large in-app messages

messaginginapp/api/messaginginapp.api

@@ -402,6 +402,10 @@ public final class io/customer/messaginginapp/state/InAppMessagingAction$SetUser
 	public fun toString ()Ljava/lang/String;
 }
 
+public final class io/customer/messaginginapp/state/InAppMessagingActionKt {
+	public static final fun shouldMarkMessageAsShown (Lio/customer/messaginginapp/state/InAppMessagingAction;)Z
+}
+
 public final class io/customer/messaginginapp/state/InAppMessagingManager {
 	public fun <init> ()V
 	public fun <init> (Lio/customer/messaginginapp/gist/presentation/GistListener;)V

messaginginapp/src/main/java/io/customer/messaginginapp/gist/GistEnvironment.kt

@@ -10,7 +10,7 @@
     DEV {
         override fun getGistQueueApiUrl() = "https://gist-queue-consumer-api.cloud.dev.gist.build"
         override fun getEngineApiUrl() = "https://engine.api.dev.gist.build"
-        override fun getGistRendererUrl() = "https://renderer.gist.build/2.0"
+        override fun getGistRendererUrl() = "https://renderer.gist.build/beta"
     },
 
     LOCAL {

messaginginapp/src/main/java/io/customer/messaginginapp/gist/presentation/GistView.kt

@@ -52,7 +52,7 @@
     fun setup(message: Message) {
         logger.debug("GistView setup: $message")
         currentMessage = message
         currentMessage?.let { message ->
             val engineWebConfiguration = EngineWebConfiguration(
                 siteId = store.siteId,
                 dataCenter = store.dataCenter,
@@ -116,12 +116,16 @@
                         try {
                             shouldLogAction = false
                             logger.debug("Dismissing from system action: $action")
-                            inAppMessagingManager.dispatch(InAppMessagingAction.DismissMessage(message = message, shouldLog = false))
                             val intent = Intent(Intent.ACTION_VIEW)
                             intent.data = Uri.parse(action)
                             intent.flags =
                                 Intent.FLAG_ACTIVITY_NEW_TASK or Intent.FLAG_ACTIVITY_CLEAR_TOP or Intent.FLAG_ACTIVITY_SINGLE_TOP
                             startActivity(context, intent, null)
+
+                            // launch system action first otherwise there is a possibility
+                            // that due to lifecycle change and message still being in queue to be displayed
+                            // the message will be displayed again, putting GistActivity before the system action in stack
+                            inAppMessagingManager.dispatch(InAppMessagingAction.DismissMessage(message = message, shouldLog = false))
                         } catch (e: ActivityNotFoundException) {
                             logger.debug("System action not handled: $action")
                         }

messaginginapp/src/main/java/io/customer/messaginginapp/gist/presentation/engine/EngineWebView.kt

@@ -5,7 +5,6 @@
 import android.graphics.Color
 import android.net.http.SslError
 import android.util.AttributeSet
-import android.util.Base64
 import android.webkit.SslErrorHandler
 import android.webkit.WebResourceError
 import android.webkit.WebResourceRequest
@@ -23,7 +22,6 @@
 import io.customer.messaginginapp.gist.utilities.ElapsedTimer
 import io.customer.messaginginapp.state.InAppMessagingState
 import io.customer.sdk.core.di.SDKComponent
-import java.io.UnsupportedEncodingException
 import java.util.Timer
 import java.util.TimerTask
 
@@ -77,83 +75,75 @@
     @SuppressLint("SetJavaScriptEnabled")
     fun setup(configuration: EngineWebConfiguration) {
         setupTimeout()
-        val jsonString = Gson().toJson(configuration)
-        encodeToBase64(jsonString)?.let { options ->
-            elapsedTimer.start("Engine render for message: ${configuration.messageId}")
-            val messageUrl =
-                "${state.environment.getGistRendererUrl()}/index.html?options=$options"
-            logger.debug("Rendering message with URL: $messageUrl")
-            webView?.let {
-                it.loadUrl(messageUrl)
-                it.settings.javaScriptEnabled = true
-                it.settings.allowFileAccess = true
-                it.settings.allowContentAccess = true
-                it.settings.domStorageEnabled = true
-                it.settings.textZoom = 100
-                it.setBackgroundColor(Color.TRANSPARENT)
-
-                findViewTreeLifecycleOwner()?.lifecycle?.addObserver(this) ?: run {
-                    logger.error("Lifecycle owner not found, attaching interface to WebView manually")
-                    engineWebViewInterface.attach(webView = it)
-                }
+        elapsedTimer.start("Engine render for message: ${configuration.messageId}")
+        val messageData = mapOf("options" to configuration)
+        val jsonString = Gson().toJson(messageData)
+        val messageUrl =
+            "${state.environment.getGistRendererUrl()}/index.html"
+        logger.debug("Rendering message with URL: $messageUrl")
+        webView?.let {
+            it.settings.javaScriptEnabled = true
+            it.settings.allowFileAccess = true
+            it.settings.allowContentAccess = true
+            it.settings.domStorageEnabled = true
+            it.settings.textZoom = 100
+            it.setBackgroundColor(Color.TRANSPARENT)
+
+            findViewTreeLifecycleOwner()?.lifecycle?.addObserver(this) ?: run {
+                logger.error("Lifecycle owner not found, attaching interface to WebView manually")
+                engineWebViewInterface.attach(webView = it)
+            }
 
-                it.webViewClient = object : WebViewClient() {
-                    override fun onPageFinished(view: WebView, url: String?) {
-                        view.loadUrl("javascript:window.parent.postMessage = function(message) {window.${EngineWebViewInterface.JAVASCRIPT_INTERFACE_NAME}.postMessage(JSON.stringify(message))}")
+            it.webViewClient = object : WebViewClient() {
+                override fun onPageFinished(view: WebView, url: String?) {
+                    val script = """
+                    window.postMessage($jsonString, '*');
+                """.trim()
+                    view.evaluateJavascript(script) { result ->
+                        logger.debug("JavaScript execution result: $result")
                     }
+                }
 
-                    override fun shouldOverrideUrlLoading(view: WebView, url: String): Boolean {
-                        return !url.startsWith("https://code.gist.build")
-                    }
+                override fun shouldOverrideUrlLoading(view: WebView, url: String): Boolean {
+                    return !url.startsWith("https://code.gist.build")
+                }
 
-                    override fun onReceivedError(
-                        view: WebView?,
-                        errorCod: Int,
-                        description: String,
-                        failingUrl: String?
-                    ) {
-                        listener?.error()
-                    }
+                override fun onReceivedError(
+                    view: WebView?,
+                    errorCod: Int,
+                    description: String,
+                    failingUrl: String?
+                ) {
+                    listener?.error()
+                }
 
-                    override fun onReceivedHttpError(
-                        view: WebView?,
-                        request: WebResourceRequest?,
-                        errorResponse: WebResourceResponse?
-                    ) {
-                        listener?.error()
-                    }
+                override fun onReceivedHttpError(
+                    view: WebView?,
+                    request: WebResourceRequest?,
+                    errorResponse: WebResourceResponse?
+                ) {
+                    listener?.error()
+                }
 
-                    override fun onReceivedError(
-                        view: WebView?,
-                        request: WebResourceRequest?,
-                        error: WebResourceError?
-                    ) {
-                        listener?.error()
-                    }
+                override fun onReceivedError(
+                    view: WebView?,
+                    request: WebResourceRequest?,
+                    error: WebResourceError?
+                ) {
+                    listener?.error()
+                }
 
-                    override fun onReceivedSslError(
-                        view: WebView?,
-                        handler: SslErrorHandler?,
-                        error: SslError?
-                    ) {
-                        listener?.error()
-                    }
+                override fun onReceivedSslError(
+                    view: WebView?,
+                    handler: SslErrorHandler?,
+                    error: SslError?
+                ) {
+                    listener?.error()
                 }
             }
-        } ?: run {
-            listener?.error()
-        }
-    }
 
-    private fun encodeToBase64(text: String): String? {
-        val data: ByteArray?
-        try {
-            data = text.toByteArray(charset("UTF-8"))
-        } catch (ex: UnsupportedEncodingException) {
-            logger.debug("Unsupported encoding exception")
-            return null
+            it.loadUrl(messageUrl)
         }
-        return Base64.encodeToString(data, Base64.URL_SAFE)
     }
 
     private fun setupTimeout() {

messaginginapp/src/main/java/io/customer/messaginginapp/state/InAppMessageReducer.kt

@@ -12,20 +12,39 @@
 
         is InAppMessagingAction.ProcessMessageQueue -> state.copy(messagesInQueue = action.messages.toSet())
         is InAppMessagingAction.SetPollingInterval -> state.copy(pollInterval = action.interval)
-        is InAppMessagingAction.DismissMessage -> state.copy(currentMessageState = MessageState.Dismissed(action.message))
         is InAppMessagingAction.EngineAction.MessageLoadingFailed -> state.copy(currentMessageState = MessageState.Dismissed(action.message))
         is InAppMessagingAction.LoadMessage -> state.copy(currentMessageState = MessageState.Loading(action.message))
         is InAppMessagingAction.Reset -> InAppMessagingState(siteId = state.siteId, dataCenter = state.dataCenter, environment = state.environment)
         is InAppMessagingAction.DisplayMessage -> {
             action.message.queueId?.let { queueId ->
+                // If the message should be tracked shown when it is displayed, add the queueId to shownMessageQueueIds.
+                val shownMessageQueueIds = if (action.shouldMarkMessageAsShown()) {
+                    state.shownMessageQueueIds + queueId
+                } else {
+                    state.shownMessageQueueIds
+                }
+
                 state.copy(
                     currentMessageState = MessageState.Displayed(action.message),
-                    shownMessageQueueIds = state.shownMessageQueueIds + queueId,
+                    shownMessageQueueIds = shownMessageQueueIds,
                     messagesInQueue = state.messagesInQueue.filterNot { it.queueId == queueId }.toSet()
                 )
             } ?: state
         }
 
+        is InAppMessagingAction.DismissMessage -> {
+            var shownMessageQueueIds = state.shownMessageQueueIds
+            // If the message should be tracked shown when it is dismissed, add the queueId to shownMessageQueueIds.
+            if (action.shouldMarkMessageAsShown() && action.message.queueId != null) {
+                shownMessageQueueIds = shownMessageQueueIds + action.message.queueId
+            }
+
+            state.copy(
+                currentMessageState = MessageState.Dismissed(action.message),
+                shownMessageQueueIds = shownMessageQueueIds
+            )
+        }
+
         else -> state
     }
     val changes = state.diff(newState)

messaginginapp/src/main/java/io/customer/messaginginapp/state/InAppMessagingAction.kt

@@ -24,3 +24,19 @@ sealed class InAppMessagingAction {
     object ClearMessageQueue : InAppMessagingAction()
     object Reset : InAppMessagingAction()
 }
+
+fun InAppMessagingAction.shouldMarkMessageAsShown(): Boolean {
+    return when (this) {
+        is InAppMessagingAction.DisplayMessage -> {
+            // Mark the message as shown if it's not persistent
+            !message.gistProperties.persistent
+        }
+
+        is InAppMessagingAction.DismissMessage -> {
+            // Mark the message as shown if it's persistent and should be logged and dismissed via close action only
+            message.gistProperties.persistent && shouldLog && viaCloseAction
+        }
+
+        else -> false
+    }
+}

messaginginapp/src/main/java/io/customer/messaginginapp/state/InAppMessagingMiddlewares.kt

@@ -45,18 +45,23 @@
 }
 
 private fun handleMessageDismissal(action: InAppMessagingAction.DismissMessage, next: (Any) -> Any) {
-    if (action.shouldLog) {
-        if (action.viaCloseAction) {
-            SDKComponent.gistQueue.logView(action.message)
-        }
+    // Log message close only if message should be tracked as shown on dismiss action
+    if (action.shouldMarkMessageAsShown()) {
+        SDKComponent.logger.debug("Persistent message dismissed, logging view for message: ${action.message}, shouldLog: ${action.shouldLog}, viaCloseAction: ${action.viaCloseAction}")
+        SDKComponent.gistQueue.logView(action.message)
+    } else {
+        SDKComponent.logger.debug("Message dismissed, not logging view for message: ${action.message}, shouldLog: ${action.shouldLog}, viaCloseAction: ${action.viaCloseAction}")
     }
     next(action)
 }
 
 private fun handleMessageDisplay(action: InAppMessagingAction.DisplayMessage, next: (Any) -> Any) {
-    val gistProperties = action.message.gistProperties
-    if (!gistProperties.persistent) {
+    // Log message view only if message should be tracked as shown on display action
+    if (action.shouldMarkMessageAsShown()) {
+        SDKComponent.logger.debug("Message shown, logging view for message: ${action.message}")
         SDKComponent.gistQueue.logView(action.message)
+    } else {
+        SDKComponent.logger.debug("Persistent message shown, not logging view for message: ${action.message}")
     }
     next(action)
 }