Merge pull request #8066 from woocommerce/issue/8065-extract-jitm-query-params

Extract JITM query params encoder logic into a reusable class

Author: AnirudhBhat

WooCommerce/src/main/kotlin/com/woocommerce/android/ui/jitm/QueryParamsEncoder.kt

@@ -0,0 +1,19 @@
+package com.woocommerce.android.ui.jitm
+
+import com.woocommerce.android.BuildConfig
+import com.woocommerce.android.util.BuildConfigWrapper
+import java.net.URLEncoder
+import javax.inject.Inject
+
+class QueryParamsEncoder @Inject constructor(
+    private val buildConfigWrapper: BuildConfigWrapper
+) {
+    fun getEncodedQueryParams(): String {
+        val query = if (buildConfigWrapper.debug) {
+            "build_type=developer&platform=android&version=${BuildConfig.VERSION_NAME}"
+        } else {
+            "platform=android&version=${BuildConfig.VERSION_NAME}"
+        }
+        return URLEncoder.encode(query, Charsets.UTF_8.name())
+    }
+}

WooCommerce/src/main/kotlin/com/woocommerce/android/ui/mystore/MyStoreViewModel.kt

@@ -9,7 +9,6 @@ import androidx.lifecycle.SavedStateHandle
 import androidx.lifecycle.asLiveData
 import androidx.lifecycle.viewModelScope
 import com.woocommerce.android.AppPrefsWrapper
-import com.woocommerce.android.BuildConfig
 import com.woocommerce.android.R
 import com.woocommerce.android.analytics.AnalyticsEvent
 import com.woocommerce.android.analytics.AnalyticsTracker
@@ -21,6 +20,7 @@ import com.woocommerce.android.tools.NetworkStatus
 import com.woocommerce.android.tools.SelectedSite
 import com.woocommerce.android.ui.analytics.daterangeselector.AnalyticTimePeriod
 import com.woocommerce.android.ui.jitm.JitmTracker
+import com.woocommerce.android.ui.jitm.QueryParamsEncoder
 import com.woocommerce.android.ui.mystore.domain.GetStats
 import com.woocommerce.android.ui.mystore.domain.GetStats.LoadStatsResult.HasOrders
 import com.woocommerce.android.ui.mystore.domain.GetStats.LoadStatsResult.IsJetPackCPEnabled
@@ -63,7 +63,6 @@ import org.wordpress.android.fluxc.store.WooCommerceStore
 import org.wordpress.android.util.FormatUtils
 import org.wordpress.android.util.PhotonUtils
 import java.math.BigDecimal
-import java.net.URLEncoder
 import java.util.concurrent.TimeUnit
 import javax.inject.Inject
 
@@ -84,6 +83,7 @@ class MyStoreViewModel @Inject constructor(
     private val jitmStore: JitmStore,
     private val jitmTracker: JitmTracker,
     private val myStoreUtmProvider: MyStoreUtmProvider,
+    private val queryParamsEncoder: QueryParamsEncoder,
 ) : ScopedViewModel(savedState) {
     companion object {
         private const val DAYS_TO_REDISPLAY_JP_BENEFITS_BANNER = 5
@@ -148,21 +148,12 @@ class MyStoreViewModel @Inject constructor(
             val response = jitmStore.fetchJitmMessage(
                 selectedSite.get(),
                 JITM_MESSAGE_PATH,
-                getEncodedQueryParams(),
+                queryParamsEncoder.getEncodedQueryParams(),
             )
             populateResultToUI(response)
         }
     }
 
-    private fun getEncodedQueryParams(): String {
-        val query = if (BuildConfig.DEBUG) {
-            "build_type=developer&platform=android&version=${BuildConfig.VERSION_NAME}"
-        } else {
-            "platform=android&version=${BuildConfig.VERSION_NAME}"
-        }
-        return URLEncoder.encode(query, Charsets.UTF_8.name())
-    }
-
     private fun populateResultToUI(response: WooResult<Array<JITMApiResponse>>) {
         if (response.isError) {
             jitmTracker.trackJitmFetchFailure(UTM_SOURCE, response.error.type, response.error.message)

WooCommerce/src/test/kotlin/com/woocommerce/android/ui/mystore/MyStoreViewModelTest.kt

@@ -13,6 +13,7 @@ import com.woocommerce.android.model.UiString
 import com.woocommerce.android.tools.NetworkStatus
 import com.woocommerce.android.tools.SelectedSite
 import com.woocommerce.android.ui.jitm.JitmTracker
+import com.woocommerce.android.ui.jitm.QueryParamsEncoder
 import com.woocommerce.android.ui.mystore.MyStoreViewModel.Companion.UTM_SOURCE
 import com.woocommerce.android.ui.mystore.MyStoreViewModel.MyStoreEvent.OnJitmCtaClicked
 import com.woocommerce.android.ui.mystore.domain.GetStats
@@ -50,7 +51,6 @@ import org.wordpress.android.fluxc.network.rest.wpcom.wc.jitm.JITMCta
 import org.wordpress.android.fluxc.store.JitmStore
 import org.wordpress.android.fluxc.store.WCStatsStore.StatsGranularity
 import org.wordpress.android.fluxc.store.WooCommerceStore
-import java.net.URLEncoder
 import kotlin.test.assertTrue
 
 @ExperimentalCoroutinesApi
@@ -69,13 +69,17 @@ class MyStoreViewModelTest : BaseUnitTest() {
     private val jitmStore: JitmStore = mock()
     private val jitmTracker: JitmTracker = mock()
     private val utmProvider: MyStoreUtmProvider = mock()
+    private val queryParamsEncoder: QueryParamsEncoder = mock()
 
     private lateinit var sut: MyStoreViewModel
 
     @Before
     fun setup() = testBlocking {
         givenStatsLoadingResult(GetStats.LoadStatsResult.VisitorsStatsError)
         givenFetchTopPerformersResult(Result.failure(WooException(WOO_GENERIC_ERROR)))
+        whenever(queryParamsEncoder.getEncodedQueryParams()).thenReturn(
+            "build_type=developer&platform=android&version=${BuildConfig.VERSION_NAME}"
+        )
     }
 
     @Test
@@ -433,34 +437,6 @@ class MyStoreViewModelTest : BaseUnitTest() {
         }
     }
 
-    @Test
-    fun `when viewmodel init, then proper encoded query params are passed to fetch jitm`() {
-        testBlocking {
-            givenNetworkConnectivity(connected = true)
-            whenever(selectedSite.get()).thenReturn(SiteModel())
-            val captor = argumentCaptor<String>()
-
-            whenViewModelIsCreated()
-            verify(jitmStore).fetchJitmMessage(any(), any(), captor.capture())
-
-            if (BuildConfig.DEBUG) {
-                assertThat(captor.firstValue).isEqualTo(
-                    URLEncoder.encode(
-                        "build_type=developer&platform=android&version=${BuildConfig.VERSION_NAME}",
-                        Charsets.UTF_8.name()
-                    )
-                )
-            } else {
-                assertThat(captor.firstValue).isEqualTo(
-                    URLEncoder.encode(
-                        "platform=android&version=${BuildConfig.VERSION_NAME}",
-                        Charsets.UTF_8.name()
-                    )
-                )
-            }
-        }
-    }
-
     @Test
     fun `given store setup in US, when viewmodel init, then request for jitm with valid message path`() {
         testBlocking {
@@ -1382,6 +1358,7 @@ class MyStoreViewModelTest : BaseUnitTest() {
             jitmStore,
             jitmTracker,
             utmProvider,
+            queryParamsEncoder
         )
     }
 

WooCommerce/src/test/kotlin/com/woocommerce/android/util/QueryParamsEncoderTest.kt

@@ -0,0 +1,48 @@
+package com.woocommerce.android.util
+
+import com.woocommerce.android.BuildConfig
+import com.woocommerce.android.ui.jitm.QueryParamsEncoder
+import org.assertj.core.api.Assertions.assertThat
+import org.junit.Test
+import org.mockito.kotlin.mock
+import org.mockito.kotlin.whenever
+import java.net.URLEncoder
+
+class QueryParamsEncoderTest {
+    private val buildConfigWrapper: BuildConfigWrapper = mock()
+    private val queryParramsEncoder = QueryParamsEncoder(buildConfigWrapper)
+
+    @Test
+    fun `given debug build, when getEncodedQueryParams called, then proper encoded query params returned`() {
+        // GIVEN
+        whenever(buildConfigWrapper.debug).thenReturn(BuildConfig.DEBUG)
+
+        // WHEN
+        val encoderQueryParams = queryParramsEncoder.getEncodedQueryParams()
+
+        // THEN
+        assertThat(encoderQueryParams).isEqualTo(
+            URLEncoder.encode(
+                "build_type=developer&platform=android&version=${BuildConfig.VERSION_NAME}",
+                Charsets.UTF_8.name()
+            )
+        )
+    }
+
+    @Test
+    fun `given release build, when getEncodedQueryParams called, then proper encoded query params returned`() {
+        // GIVEN
+        whenever(buildConfigWrapper.debug).thenReturn(false)
+
+        // WHEN
+        val encoderQueryParams = queryParramsEncoder.getEncodedQueryParams()
+
+        // THEN
+        assertThat(encoderQueryParams).isEqualTo(
+            URLEncoder.encode(
+                "platform=android&version=${BuildConfig.VERSION_NAME}",
+                Charsets.UTF_8.name()
+            )
+        )
+    }
+}