Replace event listener with FragmentDelegate class.

instacart · Dec 11, 2023 · 3444b40 · 3444b40
1 parent 46f395d
commit 3444b40
Show file tree

Hide file tree

Showing 4 changed files with 38 additions and 30 deletions.
diff --git a/formula-android/src/main/java/com/instacart/formula/android/FormulaFragment.kt b/formula-android/src/main/java/com/instacart/formula/android/FormulaFragment.kt
@@ -134,19 +134,13 @@ class FormulaFragment : Fragment(), BaseFormulaFragment<Any> {
         val environment = FormulaFragmentDelegate.fragmentEnvironment()
 
         try {
-            val start = SystemClock.uptimeMillis()
-            view.setOutput(output)
-            val end = SystemClock.uptimeMillis()
-
-
-            environment.eventListener?.onRendered(
-                fragmentId = fragmentId,
-                durationInMillis = end - start,
-            )
+            environment.fragmentDelegate.setOutput(fragmentId, output, view.setOutput)
 
             if (firstRender) {
+                val end = SystemClock.uptimeMillis()
+
                 firstRender = false
-                environment.eventListener?.onFirstModelRendered(
+                environment.fragmentDelegate.onFirstModelRendered(
                     fragmentId = fragmentId,
                     durationInMillis = end - (initializedAtMillis ?: SystemClock.uptimeMillis()),
                 )

diff --git a/formula-android/src/main/java/com/instacart/formula/android/FragmentEnvironment.kt b/formula-android/src/main/java/com/instacart/formula/android/FragmentEnvironment.kt
@@ -1,35 +1,54 @@
 package com.instacart.formula.android
 
+import android.view.LayoutInflater
+import android.view.ViewGroup
+
 data class FragmentEnvironment(
     val logger: (String) -> Unit = {},
     val onScreenError: (FragmentKey, Throwable) -> Unit = { _, it -> throw it },
-    val eventListener: EventListener? = null,
+    val fragmentDelegate: FragmentDelegate = FragmentDelegate(),
 ) {
 
     /**
      * Introspection API to track various formula fragment events and their performance.
      */
-    interface EventListener {
+    open class FragmentDelegate {
 
         /**
-         * Called after [FeatureFactory.initialize] is called.
+         * Instantiates the feature.
          */
-        fun onFeatureInitialized(fragmentId: FragmentId, durationInMillis: Long)
+        fun <DependenciesT, KeyT: FragmentKey> initializeFeature(
+            fragmentId: FragmentId,
+            factory: FeatureFactory<DependenciesT, KeyT>,
+            dependencies: DependenciesT,
+            key: KeyT,
+        ): Feature<*> {
+            return factory.initialize(dependencies, key)
+        }
 
         /**
-         * Called when [FormulaFragment] view is inflated.
+         * Called from [FormulaFragment.onCreateView] to instantiate the view.
          */
-        fun onViewInflated(fragmentId: FragmentId, durationInMillis: Long)
+        fun createView(
+            fragmentId: FragmentId,
+            viewFactory: ViewFactory<Any>,
+            inflater: LayoutInflater,
+            container: ViewGroup?,
+        ): FeatureView<Any> {
+            return viewFactory.create(inflater, container)
+        }
 
         /**
-         * Called after render model was applied to the [FeatureView].
+         * Called when we are ready to apply [output] to the view.
          */
-        fun onRendered(fragmentId: FragmentId, durationInMillis: Long)
+        fun setOutput(fragmentId: FragmentId, output: Any, applyOutputToView: (Any) -> Unit) {
+            applyOutputToView(output)
+        }
 
         /**
          * Called after first render model is rendered. The [durationInMillis] starts
          * when formula fragment is initialized and ends after first render model is applied.
          */
-        fun onFirstModelRendered(fragmentId: FragmentId, durationInMillis: Long)
+        fun onFirstModelRendered(fragmentId: FragmentId, durationInMillis: Long) = Unit
     }
 }
diff --git a/formula-android/src/main/java/com/instacart/formula/android/internal/FeatureBinding.kt b/formula-android/src/main/java/com/instacart/formula/android/internal/FeatureBinding.kt
@@ -34,13 +34,12 @@ internal class FeatureBinding<in Component, in Dependencies, in Key : FragmentKe
                             Action.onData(fragmentId).onEvent {
                                 transition {
                                     try {
-                                        val start = SystemClock.uptimeMillis()
                                         val dependencies = toDependencies(input.component)
-                                        val feature = feature.initialize(dependencies, key as Key)
-                                        val end = SystemClock.uptimeMillis()
-                                        input.environment.eventListener?.onFeatureInitialized(
+                                        val feature = input.environment.fragmentDelegate.initializeFeature(
                                             fragmentId = fragmentId,
-                                            durationInMillis = end - start,
+                                            factory = feature,
+                                            dependencies = dependencies,
+                                            key = key as Key,
                                         )
                                         input.onInitializeFeature(FeatureEvent.Init(fragmentId, feature))
                                     } catch (e: Exception) {

diff --git a/...ndroid/src/main/java/com/instacart/formula/android/internal/FormulaFragmentViewFactory.kt b/...ndroid/src/main/java/com/instacart/formula/android/internal/FormulaFragmentViewFactory.kt
@@ -1,6 +1,5 @@
 package com.instacart.formula.android.internal
 
-import android.os.SystemClock
 import android.view.LayoutInflater
 import android.view.ViewGroup
 import com.instacart.formula.android.FeatureView
@@ -20,7 +19,6 @@ internal class FormulaFragmentViewFactory(
 
     @Suppress("UNCHECKED_CAST")
     override fun create(inflater: LayoutInflater, container: ViewGroup?): FeatureView<Any> {
-        val start = SystemClock.uptimeMillis()
         val key = fragmentId.key
         val featureEvent = featureProvider.getFeature(fragmentId) ?: throw IllegalStateException("Could not find feature for $key.")
         val viewFactory = factory ?: when (featureEvent) {
@@ -35,9 +33,7 @@ internal class FormulaFragmentViewFactory(
             }
         }
         this.factory = viewFactory
-        val view = viewFactory.create(inflater, container)
-        val endTime = SystemClock.uptimeMillis()
-        environment.eventListener?.onViewInflated(fragmentId, endTime - start)
-        return view
+        val delegate = environment.fragmentDelegate
+        return delegate.createView(fragmentId, viewFactory, inflater, container)
     }
 }