Unit tests and fixes from app testing

Author: Evan Masseau

sdk/forms/src/main/java/com/klaviyo/forms/bridge/CompanyObserver.kt

@@ -12,17 +12,18 @@ import com.klaviyo.forms.reInitializeInAppForms
  * to reload klaviyo.js for the new company
  */
 internal class CompanyObserver : JsBridgeObserver {
-    override val handshake: HandshakeSpec = HandshakeSpec(
-        type = "companyInitialization",
-        version = 1
-    )
+    /**
+     * At this time, company ID doesn't have a handshake spec because
+     * it only resets the webview, doesn't communicate with the onsite module
+     */
+    override val handshake: HandshakeSpec? = null
 
     override fun startObserver() = Registry.get<State>().onStateChange(::onStateChange)
 
     override fun stopObserver() = Registry.get<State>().offStateChange(::onStateChange)
 
     private fun onStateChange(key: Keyword?, oldValue: Any?) = when (key) {
-        StateKey.API_KEY -> Klaviyo.reInitializeInAppForms().also {
+        StateKey.API_KEY -> Klaviyo.reInitializeInAppForms().run {
             Registry.log.info(
                 "In-app forms reinitialized: company ID changed from $oldValue to ${Registry.get<State>().apiKey}"
             )

sdk/forms/src/main/java/com/klaviyo/forms/bridge/JsBridgeObserver.kt

@@ -6,8 +6,9 @@ package com.klaviyo.forms.bridge
 internal interface JsBridgeObserver {
     /**
      * HandshakeSpec indicating the type and version of messages this observer communicates into the webview
+     * Nullable because not all observers will have a handshake item (i.e. they don't communicate with onsite module)
      */
-    val handshake: HandshakeSpec
+    val handshake: HandshakeSpec?
 
     /**
      * Start observing events and passing data into the webview

sdk/forms/src/main/java/com/klaviyo/forms/bridge/JsBridgeObserverCollection.kt

@@ -12,7 +12,7 @@ internal interface JsBridgeObserverCollection {
     /**
      * Compiles the handshake data from all observers into a single list
      */
-    val handshake: List<HandshakeSpec> get() = observers.map { it.handshake }
+    val handshake: List<HandshakeSpec> get() = observers.mapNotNull { it.handshake }
 
     /**
      * Start all observers in the collection

sdk/forms/src/main/java/com/klaviyo/forms/bridge/KlaviyoObserverCollection.kt

@@ -6,6 +6,7 @@ package com.klaviyo.forms.bridge
 internal class KlaviyoObserverCollection : JsBridgeObserverCollection {
     override val observers: List<JsBridgeObserver> by lazy {
         listOf(
+            CompanyObserver(),
             LifecycleObserver(),
             ProfileObserver()
         )

sdk/forms/src/main/java/com/klaviyo/forms/bridge/LifecycleObserver.kt

@@ -14,7 +14,7 @@ internal class LifecycleObserver : JsBridgeObserver {
     private val sessionTimeoutMs: Long
         get() = Registry.get<InAppFormsConfig>().sessionTimeoutDuration * 1_000
 
-    override val handshake: HandshakeSpec = HandshakeSpec(
+    override val handshake: HandshakeSpec? = HandshakeSpec(
         type = "lifecycleEvent",
         version = 1
     )

sdk/forms/src/main/java/com/klaviyo/forms/bridge/ProfileObserver.kt

@@ -9,7 +9,7 @@ import com.klaviyo.core.Registry
  * Observe [State] in the analytics package to synchronize profile identifiers with the webview
  */
 internal class ProfileObserver : JsBridgeObserver {
-    override val handshake: HandshakeSpec = HandshakeSpec(
+    override val handshake: HandshakeSpec? = HandshakeSpec(
         type = "profileMutation",
         version = 1
     )

sdk/forms/src/test/java/com/klaviyo/forms/bridge/CompanyObserverTest.kt

@@ -0,0 +1,69 @@
+package com.klaviyo.forms.bridge
+
+import com.klaviyo.analytics.Klaviyo
+import com.klaviyo.analytics.model.Keyword
+import com.klaviyo.analytics.model.ProfileKey
+import com.klaviyo.analytics.model.StateKey
+import com.klaviyo.analytics.state.State
+import com.klaviyo.core.Registry
+import com.klaviyo.forms.reInitializeInAppForms
+import com.klaviyo.forms.webview.WebViewClient
+import io.mockk.every
+import io.mockk.mockk
+import io.mockk.mockkStatic
+import io.mockk.slot
+import io.mockk.unmockkAll
+import io.mockk.verify
+import org.junit.After
+import org.junit.Assert.assertEquals
+import org.junit.Before
+import org.junit.Test
+
+class CompanyObserverTest {
+    private val observerSlot = slot<(Keyword?, Any?) -> Unit>()
+    private val stateMock = mockk<State>(relaxed = true).apply {
+        every { onStateChange(capture(observerSlot)) } returns Unit
+        every { apiKey } returns "new_key"
+    }
+
+    private val mockWebViewClient = mockk<WebViewClient>(relaxed = true).apply {
+        every { destroyWebView() } returns this
+    }
+
+    @Before
+    fun setup() {
+        mockkStatic("com.klaviyo.forms.InAppFormsKt") // Mock the extension function
+        every { Klaviyo.reInitializeInAppForms() } returns Klaviyo
+        Registry.register<WebViewClient>(mockWebViewClient)
+        Registry.register<State>(stateMock)
+    }
+
+    @After
+    fun cleanup() {
+        Registry.unregister<WebViewClient>()
+        Registry.unregister<State>()
+        unmockkAll()
+    }
+
+    @Test
+    fun `handshake is correct`() = assertEquals(
+        null,
+        CompanyObserver().handshake
+    )
+
+    @Test
+    fun `startObserver attaches to state change`() {
+        CompanyObserver().startObserver()
+        assert(observerSlot.isCaptured)
+        observerSlot.captured.invoke(StateKey.API_KEY, "old_key")
+        verify { Klaviyo.reInitializeInAppForms() }
+    }
+
+    @Test
+    fun `observer ignores other keys`() {
+        CompanyObserver().startObserver()
+        assert(observerSlot.isCaptured)
+        observerSlot.captured.invoke(ProfileKey.CUSTOM("email"), "old_email")
+        verify(inverse = true) { Klaviyo.reInitializeInAppForms() }
+    }
+}