set preloading tag on instrumentation event (#117)

Author: kiftio

lib/src/main/java/com/shopify/checkoutsheetkit/CheckoutWebView.kt

@@ -42,6 +42,7 @@ internal class CheckoutWebView(context: Context, attributeSet: AttributeSet? = n
     override val recoverErrors = true
     override val variant = "standard"
     override val cspSchema = CheckoutBridge.SCHEMA_VERSION_NUMBER
+    var isPreload = false
 
     private val checkoutBridge = CheckoutBridge(CheckoutWebViewEventProcessor(NoopEventProcessor()))
     private var loadComplete = false
@@ -95,6 +96,7 @@ internal class CheckoutWebView(context: Context, attributeSet: AttributeSet? = n
 
     fun loadCheckout(url: String, isPreload: Boolean) {
         initLoadTime = System.currentTimeMillis()
+        this.isPreload = isPreload
         Handler(Looper.getMainLooper()).post {
             val headers = if (isPreload) mutableMapOf("Sec-Purpose" to "prefetch") else mutableMapOf()
             loadUrl(url, headers)
@@ -114,7 +116,10 @@ internal class CheckoutWebView(context: Context, attributeSet: AttributeSet? = n
             val timeToLoad = System.currentTimeMillis() - initLoadTime
             checkoutBridge.sendMessage(view, CheckoutBridge.SDKOperation.Instrumentation(
                 InstrumentationPayload(
-                    "checkout_finished_loading", timeToLoad, histogram, mapOf()
+                    name= "checkout_finished_loading",
+                    value= timeToLoad,
+                    type = histogram,
+                    tags = mapOf("preloading" to isPreload.toString()),
                 )
             ))
             getEventProcessor().onCheckoutViewLoadComplete()

lib/src/test/java/com/shopify/checkoutsheetkit/CheckoutWebViewTest.kt

@@ -43,6 +43,7 @@ import org.robolectric.Robolectric
 import org.robolectric.RobolectricTestRunner
 import org.robolectric.Shadows.shadowOf
 import org.robolectric.shadows.ShadowLooper
+import java.util.regex.Pattern
 
 @RunWith(RobolectricTestRunner::class)
 class CheckoutWebViewTest {
@@ -140,6 +141,40 @@ class CheckoutWebViewTest {
         }
     }
 
+    @Test
+    fun `records checkout_finished_loading instrumentation event on page finished - preloading`() {
+        withPreloadingEnabled {
+            val isPreload = true
+            val view = CheckoutWebView.cacheableCheckoutView(URL, activity, isPreload)
+            val shadow = shadowOf(view)
+            shadow.webViewClient.onPageFinished(view, URL)
+
+            val regex = Pattern.compile(
+                @Suppress("MaxLineLength")
+                """.*\.dispatchMessage\('instrumentation', \{"detail":\{"name":"checkout_finished_loading","value":\d*,"type":"histogram","tags":\{"preloading":"true"}}}\).*""",
+                Pattern.DOTALL
+            )
+            assertThat(shadow.lastEvaluatedJavascript).matches(regex)
+        }
+    }
+
+    @Test
+    fun `records checkout_finished_loading instrumentation event on page finished - presenting`() {
+        withPreloadingEnabled {
+            val isPreload = false
+            val view = CheckoutWebView.cacheableCheckoutView(URL, activity, isPreload)
+            val shadow = shadowOf(view)
+            shadow.webViewClient.onPageFinished(view, URL)
+
+            val regex = Pattern.compile(
+                @Suppress("MaxLineLength")
+                """.*\.dispatchMessage\('instrumentation', \{"detail":\{"name":"checkout_finished_loading","value":\d*,"type":"histogram","tags":\{"preloading":"false"}}}\).*""",
+                Pattern.DOTALL
+            )
+            assertThat(shadow.lastEvaluatedJavascript).matches(regex)
+        }
+    }
+
     @Test
     fun `does not send prefetch header for preloads`() {
         val isPreload = false