Defer tooltip experiment history until render confirmation (#35)

Author: VictorB00

nubrick/src/main/kotlin/io/nubrick/nubrick/component/trigger.kt

@@ -29,7 +29,7 @@ import kotlinx.serialization.json.Json
 internal class TriggerViewModel(
     internal val container: Container,
     internal val user: NubrickUser,
-    private val onTooltip: ((data: String) -> Unit)? = null,
+    private val onTooltip: ((data: String, experimentId: String) -> Unit)? = null,
 ) : ViewModel() {
     private val ignoreFirstUserEventToForegroundEvent = mutableStateOf(true)
     internal val modalStacks = mutableStateListOf<UIRootBlock>()
@@ -75,13 +75,15 @@ internal class TriggerViewModel(
         }
         GlobalScope.launch(Dispatchers.IO) {
             self.container.handleNubrickEvent(event)
-            self.container.fetchTriggerContent(event.name, kinds).onSuccess { (kind, block) ->
+            self.container.fetchTriggerContent(event.name, kinds).onSuccess { triggerContent ->
+                val kind = triggerContent.kind
+                val block = triggerContent.block
                 if (kind == ExperimentKind.TOOLTIP) {
                     self.onTooltip?.let { callback ->
                         val jsonString = Json.encodeToString(UIBlock.encode(block))
                         // Flutter MethodChannel requires calls on the main thread
                         GlobalScope.launch(Dispatchers.Main) {
-                            callback(jsonString)
+                            callback(jsonString, triggerContent.experimentId)
                         }
                     }
                 } else {

nubrick/src/main/kotlin/io/nubrick/nubrick/data/container.kt

@@ -27,6 +27,12 @@ internal data class ExtractedVariant(
     val variant: ExperimentVariant,
 )
 
+internal data class TriggerContent(
+    val experimentId: String,
+    val kind: ExperimentKind,
+    val block: UIBlock,
+)
+
 class NotFoundException : Exception("Not found")
 class FailedToDecodeException : Exception("Failed to decode")
 class SkipHttpRequestException : Exception("Skip http request")
@@ -53,8 +59,9 @@ internal interface Container {
     ): Result<JsonElement>
 
     suspend fun fetchEmbedding(experimentId: String, componentId: String? = null): Result<UIBlock>
-    suspend fun fetchTriggerContent(trigger: String, kinds: List<ExperimentKind>): Result<Pair<ExperimentKind, UIBlock>>
+    suspend fun fetchTriggerContent(trigger: String, kinds: List<ExperimentKind>): Result<TriggerContent>
     suspend fun fetchRemoteConfig(experimentId: String): Result<ExperimentVariant>
+    fun appendExperimentHistory(experimentId: String)
 
     fun storeNativeCrash(throwable: Throwable)
     fun sendFlutterCrash(crashEvent: TrackCrashEvent)
@@ -182,7 +189,11 @@ internal class ContainerImpl(
                 variantId = variantId
             )
         )
-        this.databaseRepository.appendExperimentHistory(extracted.experimentId)
+        // Tooltip is a Flutter-only flow. Persist tooltip history only after
+        // Flutter confirms the tooltip actually started rendering.
+        if (extracted.kind != ExperimentKind.TOOLTIP) {
+            this.databaseRepository.appendExperimentHistory(extracted.experimentId)
+        }
         val componentId = extractComponentId(extracted.variant) ?: return Result.failure(NotFoundException())
         val component =
             this.componentRepository.fetchComponent(extracted.experimentId, componentId).getOrElse {
@@ -191,7 +202,7 @@ internal class ContainerImpl(
         return Result.success(component)
     }
 
-    override suspend fun fetchTriggerContent(trigger: String, kinds: List<ExperimentKind>): Result<Pair<ExperimentKind, UIBlock>> {
+    override suspend fun fetchTriggerContent(trigger: String, kinds: List<ExperimentKind>): Result<TriggerContent> {
         // send the user track event and save it to database
         this.trackRepository.trackEvent(TrackUserEvent(trigger))
         this.databaseRepository.appendUserEvent(trigger)
@@ -213,13 +224,23 @@ internal class ContainerImpl(
                 variantId = variantId
             )
         )
-        this.databaseRepository.appendExperimentHistory(extracted.experimentId)
+        // Tooltip is a Flutter-only flow. Persist tooltip history only after
+        // Flutter confirms the tooltip actually started rendering.
+        if (extracted.kind != ExperimentKind.TOOLTIP) {
+            this.databaseRepository.appendExperimentHistory(extracted.experimentId)
+        }
         val componentId = extractComponentId(extracted.variant) ?: return Result.failure(NotFoundException())
         val component =
             this.componentRepository.fetchComponent(extracted.experimentId, componentId).getOrElse {
                 return Result.failure(it)
             }
-        return Result.success(extracted.kind to component)
+        return Result.success(
+            TriggerContent(
+                experimentId = extracted.experimentId,
+                kind = extracted.kind,
+                block = component,
+            )
+        )
     }
 
     override suspend fun fetchRemoteConfig(experimentId: String): Result<ExperimentVariant> {
@@ -241,6 +262,10 @@ internal class ContainerImpl(
         return Result.success(extracted.variant)
     }
 
+    override fun appendExperimentHistory(experimentId: String) {
+        this.databaseRepository.appendExperimentHistory(experimentId)
+    }
+
     private fun extractVariant(
         configs: ExperimentConfigs,
         kinds: List<ExperimentKind>,

nubrick/src/main/kotlin/io/nubrick/nubrick/sdk.kt

@@ -135,7 +135,7 @@ fun NubrickProvider(
 class NubrickClient private constructor(
     private val config: Config,
     context: Context,
-    onTooltip: ((data: String) -> Unit)? = null,
+    onTooltip: ((data: String, experimentId: String) -> Unit)? = null,
 ) {
     private val db: SQLiteDatabase
     val user: NubrickUser
@@ -145,7 +145,11 @@ class NubrickClient private constructor(
 
     companion object {
         @FlutterBridgeApi
-        fun create(config: Config, context: Context, onTooltip: (data: String) -> Unit): NubrickClient {
+        fun create(
+            config: Config,
+            context: Context,
+            onTooltip: (data: String, experimentId: String) -> Unit
+        ): NubrickClient {
             return NubrickClient(config, context, onTooltip)
         }
     }
@@ -188,7 +192,7 @@ class NubrickExperiment {
         user: NubrickUser,
         db: SQLiteDatabase,
         context: Context,
-        onTooltip: ((data: String) -> Unit)? = null,
+        onTooltip: ((data: String, experimentId: String) -> Unit)? = null,
     ) {
         this.container = ContainerImpl(
             config = config.copy(onEvent = { event ->
@@ -225,6 +229,12 @@ class NubrickExperiment {
         this.container.sendFlutterCrash(crashEvent)
     }
 
+    @FlutterBridgeApi
+    fun appendTooltipExperimentHistory(experimentId: String) {
+        if (experimentId.isEmpty()) return
+        this.container.appendExperimentHistory(experimentId)
+    }
+
     @Composable
     fun Overlay() {
         Trigger(trigger = this.trigger)