NOCH : Add shown customer IDs to the search results loaded event (cap at 20) (#61)

* First pass needs tests

* Updates

* Tweaks

Author: rubikzube

README.md

@@ -109,8 +109,8 @@ ConstructorIo.trackSearchSubmit("toothpicks", "tooth")
 ### Search Events
 
 ```kotlin
-// Track when search results are loaded into view (searchTerm, resultCount)
-ConstructorIo.trackSearchResultsLoaded("tooth", 789)
+// Track when search results are loaded into view (searchTerm, resultCount, customerIds of shown items)
+ConstructorIo.trackSearchResultsLoaded("tooth", 789, arrayOf("1234567-AB", "1234567-AB"))
 
 // Track when a search result is clicked (itemName, customerId, searchTerm, sectionName, resultId)
 ConstructorIo.trackSearchResultClick("Fashionable Toothpicks", "1234567-AB", "tooth", "Products", "179b8a0e-3799-4a31-be87-127b06871de2")

library/src/main/java/io/constructor/core/ConstructorIo.kt

@@ -266,16 +266,17 @@ object ConstructorIo {
      * Tracks search results loaded (a.k.a. search results viewed) events
      * @param term the term that results are displayed for, i.e. "Pumpkin"
      * @param resultCount the number of results for that term
+     * @param customerIds the customerIds of shown items
      */
-    fun trackSearchResultsLoaded(term: String, resultCount: Int) {
-        var completable = trackSearchResultsLoadedInternal(term, resultCount)
+    fun trackSearchResultsLoaded(term: String, resultCount: Int, customerIds: Array<String>? = null) {
+        var completable = trackSearchResultsLoadedInternal(term, resultCount, customerIds)
         disposable.add(completable.subscribeOn(Schedulers.io()).subscribe({}, {
             t -> e("Search Results Loaded error: ${t.message}")
         }))
     }
-    internal fun trackSearchResultsLoadedInternal(term: String, resultCount: Int): Completable {
+    internal fun trackSearchResultsLoadedInternal(term: String, resultCount: Int, customerIds: Array<String>? = null): Completable {
         preferenceHelper.getSessionId(sessionIncrementHandler)
-        return dataManager.trackSearchResultsLoaded(term, resultCount, arrayOf(
+        return dataManager.trackSearchResultsLoaded(term, resultCount, customerIds, arrayOf(
                 Constants.QueryConstants.ACTION to Constants.QueryValues.EVENT_SEARCH_RESULTS
         ))
     }

library/src/main/java/io/constructor/data/DataManager.kt

@@ -82,8 +82,8 @@ constructor(private val constructorApi: ConstructorApi, private val moshi: Moshi
         return constructorApi.trackSearchResultClick(term, itemName, customerId, params.toMap(), encodedParams.toMap())
     }
 
-    fun trackSearchResultsLoaded(term: String, resultCount: Int, params: Array<Pair<String, String>>): Completable {
-        return constructorApi.trackSearchResultsLoaded(term, resultCount, params.toMap())
+    fun trackSearchResultsLoaded(term: String, resultCount: Int, customerIds: Array<String>? = null, params: Array<Pair<String, String>>): Completable {
+        return constructorApi.trackSearchResultsLoaded(term, resultCount, customerIds?.take(60)?.joinToString(","), params.toMap())
     }
 
     fun trackInputFocus(term: String?, params: Array<Pair<String, String>>): Completable {

library/src/main/java/io/constructor/data/remote/ConstructorApi.kt

@@ -45,6 +45,7 @@ interface ConstructorApi {
     @GET(ApiPaths.URL_BEHAVIOR)
     fun trackSearchResultsLoaded(@Query("term") term: String,
                                  @Query("num_results") resultCount: Int,
+                                 @Query("customer_ids") customerIds: String?,
                                  @QueryMap params: Map<String, String>): Completable
 
     @GET(ApiPaths.URL_BEHAVIOR)

library/src/test/java/io/constructor/core/ConstructorIoIntegrationTest.kt

@@ -11,7 +11,7 @@ import org.junit.Before
 import org.junit.Rule
 import org.junit.Test
 
-class ConstructorIoTestIntegration {
+class ConstructorIoIntegrationTest {
 
     @Rule
     @JvmField val overrideSchedulersRule = RxSchedulersOverrideRule()

library/src/test/java/io/constructor/core/ConstructorIoTrackingTest.kt

@@ -18,7 +18,7 @@ import java.util.concurrent.TimeUnit
 import kotlin.test.assertEquals
 import kotlin.test.assertTrue
 
-class ConstructorIoTest {
+class ConstructorIoTrackingTest {
 
     @Rule
     @JvmField val overrideSchedulersRule = RxSchedulersOverrideRule()
@@ -213,6 +213,17 @@ class ConstructorIoTest {
         assert(request.path.startsWith(path))
     }
 
+    @Test
+    fun trackSearchResultLoadedWithCustomerIDs() {
+        val mockResponse = MockResponse().setResponseCode(204)
+        mockServer.enqueue(mockResponse)
+        val observer = ConstructorIo.trackSearchResultsLoadedInternal("titanic", 10, arrayOf("TIT-REP-1997", "QE2-REP-1969")).test()
+        observer.assertComplete()
+        val request = mockServer.takeRequest()
+        val path = "/behavior?term=titanic&num_results=10&customer_ids=TIT-REP-1997%2CQE2-REP-1969&action=search-results&key=copper-key&i=wacko-the-guid&ui=player-three&s=67&c=cioand-2.4.0&_dt=";
+        assert(request.path.startsWith(path))
+    }
+
     @Test
     fun trackSearchResultLoaded500() {
         val mockResponse = MockResponse().setResponseCode(500).setBody("Internal server error")