Merge pull request #312 from customerio/feature/message-inbox-mvp

feat: support for notification inbox

Author: mrehan27

android/build.gradle

@@ -59,7 +59,7 @@ android {
 dependencies {
     implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk7:$kotlin_version"
     // Customer.io SDK
-    def cioVersion = "4.15.2"
+    def cioVersion = "4.16.0"
     implementation "io.customer.android:datapipelines:$cioVersion"
     implementation "io.customer.android:messaging-push-fcm:$cioVersion"
     implementation "io.customer.android:messaging-in-app:$cioVersion"

android/src/main/kotlin/io/customer/customer_io/messaginginapp/CustomerIOInAppMessaging.kt

@@ -2,17 +2,21 @@ package io.customer.customer_io.messaginginapp
 
 import android.app.Activity
 import io.customer.customer_io.bridge.NativeModuleBridge
+import io.customer.customer_io.bridge.nativeMapArgs
 import io.customer.customer_io.bridge.nativeNoArgs
-import io.customer.customer_io.messaginginapp.InlineInAppMessageViewFactory
 import io.customer.customer_io.utils.getAs
 import io.customer.messaginginapp.MessagingInAppModuleConfig
 import io.customer.messaginginapp.ModuleMessagingInApp
 import io.customer.messaginginapp.di.inAppMessaging
+import io.customer.messaginginapp.gist.data.model.InboxMessage
+import io.customer.messaginginapp.gist.data.model.response.InboxMessageFactory
+import io.customer.messaginginapp.inbox.NotificationInbox
 import io.customer.messaginginapp.type.InAppEventListener
 import io.customer.messaginginapp.type.InAppMessage
 import io.customer.sdk.CustomerIO
 import io.customer.sdk.CustomerIOBuilder
 import io.customer.sdk.core.di.SDKComponent
+import io.customer.sdk.core.util.Logger
 import io.customer.sdk.data.model.Region
 import io.flutter.embedding.engine.plugins.FlutterPlugin
 import io.flutter.embedding.engine.plugins.activity.ActivityAware
@@ -31,13 +35,33 @@ internal class CustomerIOInAppMessaging(
     override val moduleName: String = "InAppMessaging"
     override val flutterCommunicationChannel: MethodChannel =
         MethodChannel(pluginBinding.binaryMessenger, "customer_io_messaging_in_app")
+    private val logger: Logger = SDKComponent.logger
+    private val inAppMessagingModule: ModuleMessagingInApp?
+        get() = runCatching { CustomerIO.instance().inAppMessaging() }.getOrNull()
     private var activity: WeakReference<Activity>? = null
     private val binaryMessenger = pluginBinding.binaryMessenger
     private val platformViewRegistry = pluginBinding.platformViewRegistry
 
+    // Dedicated lock for inbox listener setup to avoid blocking other operations
+    private val inboxListenerLock = Any()
+    private val inboxChangeListener = FlutterNotificationInboxChangeListener.instance
+    private var isInboxChangeListenerSetup = false
+
+    /**
+     * Returns NotificationInbox instance if available, null otherwise, logging error on failure.
+     * Note: Notification Inbox is only available after SDK is initialized.
+     */
+    private fun requireInboxInstance(): NotificationInbox? {
+        val inbox = inAppMessagingModule?.inbox()
+        if (inbox == null) {
+            logger.error("Notification Inbox is not available. Ensure CustomerIO SDK is initialized.")
+        }
+        return inbox
+    }
+
     override fun onAttachedToEngine() {
         super.onAttachedToEngine()
-        
+
         // Register the platform view factory for inline in-app messages
         platformViewRegistry.registerViewFactory(
             "customer_io_inline_in_app_message_view",
@@ -61,15 +85,26 @@ internal class CustomerIOInAppMessaging(
         this.activity = null
     }
 
+    override fun onDetachedFromEngine() {
+        clearInboxChangeListener()
+        super.onDetachedFromEngine()
+    }
+
     override fun onMethodCall(call: MethodCall, result: MethodChannel.Result) {
         when (call.method) {
             "dismissMessage" -> call.nativeNoArgs(result, ::dismissMessage)
+            "subscribeToInboxMessages" -> setupInboxChangeListener(call, result)
+            "getInboxMessages" -> getInboxMessages(call, result)
+            "markInboxMessageOpened" -> call.nativeMapArgs(result, ::markInboxMessageOpened)
+            "markInboxMessageUnopened" -> call.nativeMapArgs(result, ::markInboxMessageUnopened)
+            "markInboxMessageDeleted" -> call.nativeMapArgs(result, ::markInboxMessageDeleted)
+            "trackInboxMessageClicked" -> call.nativeMapArgs(result, ::trackInboxMessageClicked)
             else -> super.onMethodCall(call, result)
         }
     }
 
     private fun dismissMessage() {
-        CustomerIO.instance().inAppMessaging().dismissMessage()
+        inAppMessagingModule?.dismissMessage()
     }
 
     /**
@@ -102,6 +137,135 @@ internal class CustomerIOInAppMessaging(
         )
         builder.addCustomerIOModule(module)
     }
+
+    /**
+     * Sets up the inbox change listener to receive real-time updates.
+     * This method can be called multiple times safely and will only set up the listener once.
+     * Note: Inbox must be available (SDK initialized) before this can succeed.
+     */
+    private fun setupInboxChangeListener(call: MethodCall, result: MethodChannel.Result) {
+        synchronized(inboxListenerLock) {
+            // Only set up once to avoid duplicate listeners
+            if (isInboxChangeListenerSetup) {
+                result.success(true)
+                return
+            }
+
+            val inbox = requireInboxInstance() ?: run {
+                result.error("INBOX_NOT_AVAILABLE", "Notification Inbox is not available. Ensure CustomerIO SDK is initialized.", null)
+                return
+            }
+
+            inboxChangeListener.setEventEmitter(
+                emitter = { data ->
+                    runOnMainThread {
+                        flutterCommunicationChannel.invokeMethod("inboxMessagesChanged", data)
+                    }
+                }
+            )
+            inbox.addChangeListener(inboxChangeListener)
+            isInboxChangeListenerSetup = true
+            logger.debug("NotificationInboxChangeListener set up successfully")
+            result.success(true)
+        }
+    }
+
+    private fun clearInboxChangeListener() {
+        synchronized(inboxListenerLock) {
+            if (!isInboxChangeListenerSetup) {
+                return
+            }
+            requireInboxInstance()?.removeChangeListener(inboxChangeListener)
+            inboxChangeListener.clearEventEmitter()
+            isInboxChangeListenerSetup = false
+        }
+    }
+
+    private fun getInboxMessages(call: MethodCall, result: MethodChannel.Result) {
+        val inbox = requireInboxInstance() ?: run {
+            result.error("INBOX_NOT_AVAILABLE", "Notification Inbox is not available. Ensure CustomerIO SDK is initialized.", null)
+            return
+        }
+
+        // Extract topic parameter if provided
+        val args = call.arguments as? Map<String, Any>
+        val topic = args?.get("topic") as? String
+
+        // Fetch messages with topic filter
+        // Using async callback avoids blocking main thread (prevents ANR/deadlocks)
+        inbox.fetchMessages(topic) { fetchResult ->
+            runOnMainThread {
+                fetchResult.onSuccess { messages ->
+                    result.success(messages.map { it.toMap() })
+                }.onFailure { error ->
+                    logger.error("Failed to get inbox messages: ${error.message}")
+                    result.error("FETCH_ERROR", error.message, null)
+                }
+            }
+        }
+    }
+
+    private fun markInboxMessageOpened(params: Map<String, Any>) {
+        val message = params.getAs<Map<String, Any>>("message")
+
+        performInboxMessageAction(message) { inbox, inboxMessage ->
+            inbox.markMessageOpened(inboxMessage)
+        }
+    }
+
+    private fun markInboxMessageUnopened(params: Map<String, Any>) {
+        val message = params.getAs<Map<String, Any>>("message")
+
+        performInboxMessageAction(message) { inbox, inboxMessage ->
+            inbox.markMessageUnopened(inboxMessage)
+        }
+    }
+
+    private fun markInboxMessageDeleted(params: Map<String, Any>) {
+        val message = params.getAs<Map<String, Any>>("message")
+
+        performInboxMessageAction(message) { inbox, inboxMessage ->
+            inbox.markMessageDeleted(inboxMessage)
+        }
+    }
+
+    private fun trackInboxMessageClicked(params: Map<String, Any>) {
+        val message = params.getAs<Map<String, Any>>("message")
+        val actionName = params.getAs<String>("actionName")
+
+        performInboxMessageAction(message) { inbox, inboxMessage ->
+            inbox.trackMessageClicked(inboxMessage, actionName)
+        }
+    }
+
+    /**
+     * Runs block on main/UI thread. Uses activity's runOnUiThread if available,
+     * otherwise falls back to Handler(Looper.getMainLooper()).post
+     */
+    private fun runOnMainThread(block: () -> Unit) {
+        val currentActivity = activity?.get()
+        if (currentActivity != null) {
+            currentActivity.runOnUiThread(block)
+        } else {
+            // Activity is null - use main looper directly
+            android.os.Handler(android.os.Looper.getMainLooper()).post(block)
+        }
+    }
+
+    /**
+     * Helper to validate inbox instance and message data before performing a message action.
+     * Throws exceptions if inbox is unavailable or message data is invalid.
+     */
+    private fun performInboxMessageAction(
+        message: Map<String, Any>?,
+        action: (NotificationInbox, InboxMessage) -> Unit,
+    ) {
+        val inbox = requireInboxInstance()
+            ?: throw IllegalStateException("Notification Inbox is not available. Ensure CustomerIO SDK is initialized.")
+        val inboxMessage = message?.let { InboxMessageFactory.fromMap(it) }
+            ?: throw IllegalArgumentException("Invalid message data: $message")
+        action(inbox, inboxMessage)
+    }
 }
 
 class CustomerIOInAppEventListener(private val invokeMethod: (String, Any?) -> Unit) :
@@ -142,4 +306,4 @@ class CustomerIOInAppEventListener(private val invokeMethod: (String, Any?) -> U
             )
         )
     }
-}
+}

android/src/main/kotlin/io/customer/customer_io/messaginginapp/FlutterNotificationInboxChangeListener.kt

@@ -0,0 +1,38 @@
+package io.customer.customer_io.messaginginapp
+
+import io.customer.messaginginapp.gist.data.model.InboxMessage
+import io.customer.messaginginapp.inbox.NotificationInboxChangeListener
+
+class FlutterNotificationInboxChangeListener private constructor() :
+    NotificationInboxChangeListener {
+
+    // Event emitter function to send events to Flutter layer
+    private var eventEmitter: ((Map<String, Any?>) -> Unit)? = null
+
+    // Sets the event emitter function and message converter
+    internal fun setEventEmitter(emitter: ((Map<String, Any?>) -> Unit)?) {
+        this.eventEmitter = emitter
+    }
+
+    // Clears the event emitter to prevent memory leaks
+    internal fun clearEventEmitter() {
+        this.eventEmitter = null
+    }
+
+    private fun emitMessagesUpdate(messages: List<InboxMessage>) {
+        // Get the emitter and converter, return early if not set
+        val emitter = eventEmitter ?: return
+
+        val payload = mapOf("messages" to messages.map { it.toMap() })
+        emitter.invoke(payload)
+    }
+
+    override fun onMessagesChanged(messages: List<InboxMessage>) {
+        emitMessagesUpdate(messages)
+    }
+
+    companion object {
+        // Singleton instance with public visibility for direct access
+        val instance: FlutterNotificationInboxChangeListener by lazy { FlutterNotificationInboxChangeListener() }
+    }
+}

android/src/main/kotlin/io/customer/customer_io/messaginginapp/NotificationInboxExtensions.kt

@@ -0,0 +1,18 @@
+package io.customer.customer_io.messaginginapp
+
+import io.customer.messaginginapp.gist.data.model.InboxMessage
+
+// Extension functions for InboxMessage serialization
+internal fun InboxMessage.toMap(): Map<String, Any?> {
+    return mapOf(
+        "queueId" to queueId,
+        "deliveryId" to deliveryId,
+        "expiry" to expiry?.time,
+        "sentAt" to sentAt.time,
+        "topics" to topics,
+        "type" to type,
+        "opened" to opened,
+        "priority" to priority,
+        "properties" to properties
+    )
+}

apps/amiapp_flutter/lib/src/app.dart

@@ -10,6 +10,7 @@ import 'data/screen.dart';
 import 'screens/attributes.dart';
 import 'screens/dashboard.dart';
 import 'screens/events.dart';
+import 'screens/inbox_messages.dart';
 import 'screens/inline_messages.dart';
 import 'screens/login.dart';
 import 'screens/settings.dart';
@@ -144,6 +145,11 @@ class _AmiAppState extends State<AmiApp> {
               path: Screen.inlineMessages.path,
               builder: (context, state) => const InlineMessagesScreen(),
             ),
+            GoRoute(
+              name: Screen.inboxMessages.name,
+              path: Screen.inboxMessages.path,
+              builder: (context, state) => const InboxMessagesScreen(),
+            ),
           ],
         ),
       ],

apps/amiapp_flutter/lib/src/data/screen.dart

@@ -11,7 +11,8 @@ enum Screen {
   deviceAttributes(name: 'Custom Device Attribute', path: 'attributes/device'),
   profileAttributes(
       name: 'Custom Profile Attribute', path: 'attributes/profile'),
-  inlineMessages(name: 'Inline Messages Test', path: 'inline-messages');
+  inlineMessages(name: 'Inline Messages Test', path: 'inline-messages'),
+  inboxMessages(name: 'Inbox Messages', path: 'inbox-messages');
 
   const Screen({
     required this.name,

apps/amiapp_flutter/lib/src/screens/dashboard.dart

@@ -303,6 +303,7 @@ enum _ActionItem {
   deviceAttributes,
   profileAttributes,
   inlineMessages,
+  inboxMessages,
   showPushPrompt,
   showLocalPush,
   signOut,
@@ -321,6 +322,8 @@ extension _ActionNames on _ActionItem {
         return 'Set Profile Attribute';
       case _ActionItem.inlineMessages:
         return 'Test Inline Messages';
+      case _ActionItem.inboxMessages:
+        return 'Inbox Messages';
       case _ActionItem.showPushPrompt:
         return 'Show Push Prompt';
       case _ActionItem.showLocalPush:
@@ -342,6 +345,8 @@ extension _ActionNames on _ActionItem {
         return 'Profile Attribute Button';
       case _ActionItem.inlineMessages:
         return 'Inline Messages Button';
+      case _ActionItem.inboxMessages:
+        return 'Inbox Messages Button';
       case _ActionItem.showPushPrompt:
         return 'Show Push Prompt Button';
       case _ActionItem.showLocalPush:
@@ -363,6 +368,8 @@ extension _ActionNames on _ActionItem {
         return Screen.profileAttributes;
       case _ActionItem.inlineMessages:
         return Screen.inlineMessages;
+      case _ActionItem.inboxMessages:
+        return Screen.inboxMessages;
       case _ActionItem.showPushPrompt:
         return null;
       case _ActionItem.showLocalPush: