[REM-3440] Viewable impressions tracking #167
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| package io.constructor.data.model.common | ||
|
|
||
| import com.squareup.moshi.Json | ||
| import com.squareup.moshi.JsonClass | ||
| import java.io.Serializable | ||
|
|
||
| @JsonClass(generateAdapter = true) | ||
| data class ResultsImpressionItem( | ||
| @Json(name = "item_id") val itemId: String, | ||
| @Json(name = "item_name") val itemName: String, | ||
| @Json(name = "variation_id") val variationId: String? = null, | ||
| @Json(name = "sl_campaign_id") val slCampaignId: String? = null, | ||
| @Json(name = "sl_campaign_owner") val slCampaignOwner: String? = null | ||
| ) : Serializable | ||
|
constructor-claude-bedrock[bot] marked this conversation as resolved.
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| package io.constructor.data.model.tracking | ||
|
|
||
| import com.squareup.moshi.Json | ||
| import com.squareup.moshi.JsonClass | ||
| import io.constructor.data.model.common.ResultsImpressionItem | ||
| import java.io.Serializable | ||
|
|
||
| @JsonClass(generateAdapter = true) | ||
| data class ResultsImpressionViewRequestBody( | ||
| @Json(name = "items") val items: List<ResultsImpressionItem>, | ||
| @Json(name = "search_term") val searchTerm: String?, | ||
| @Json(name = "filter_name") val filterName: String?, | ||
| @Json(name = "filter_value") val filterValue: String?, | ||
| @Json(name = "analytics_tags") val analyticsTags: Map<String, String>?, | ||
| @Json(name = "beacon") val beacon: Boolean = true, | ||
| @Json(name = "c") val c: String, | ||
| @Json(name = "i") val i: String, | ||
| @Json(name = "s") val s: Int, | ||
| @Json(name = "key") val key: String, | ||
| @Json(name = "ui") val ui: String?, | ||
| @Json(name = "us") val us: List<String?>, | ||
|
There was a problem hiding this comment. Important Issue: The |
||
| @Json(name = "_dt") val _dt: Long? | ||
|
constructor-claude-bedrock[bot] marked this conversation as resolved.
constructor-claude-bedrock[bot] marked this conversation as resolved.
|
||
| ) : Serializable | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,168 @@ | ||
| package io.constructor.core | ||
|
|
||
| import android.content.Context | ||
| import io.constructor.data.local.PreferencesHelper | ||
| import io.constructor.data.memory.ConfigMemoryHolder | ||
| import io.constructor.data.model.common.ResultsImpressionItem | ||
| import io.constructor.test.createTestDataManager | ||
| import io.constructor.util.RxSchedulersOverrideRule | ||
| import io.mockk.every | ||
| import io.mockk.mockk | ||
| import okhttp3.mockwebserver.MockResponse | ||
| import okhttp3.mockwebserver.MockWebServer | ||
| import okhttp3.mockwebserver.RecordedRequest | ||
| import org.junit.After | ||
| import org.junit.Before | ||
| import org.junit.Rule | ||
| import org.junit.Test | ||
| import java.net.SocketTimeoutException | ||
| import java.util.concurrent.TimeUnit | ||
| import kotlin.test.assertEquals | ||
|
|
||
| class ConstructorIoResultsImpressionViewTrackingTest { | ||
|
|
||
| @Rule | ||
| @JvmField | ||
| val overrideSchedulersRule = RxSchedulersOverrideRule() | ||
|
|
||
| private lateinit var mockServer: MockWebServer | ||
| private var constructorIo = ConstructorIo | ||
| private val ctx = mockk<Context>() | ||
| private val preferencesHelper = mockk<PreferencesHelper>() | ||
| private val configMemoryHolder = mockk<ConfigMemoryHolder>() | ||
|
|
||
| @Before | ||
| fun setup() { | ||
| mockServer = MockWebServer() | ||
| mockServer.start() | ||
|
|
||
| every { ctx.applicationContext } returns ctx | ||
|
|
||
| every { preferencesHelper.apiKey } returns "copper-key" | ||
| every { preferencesHelper.id } returns "wacko-the-guid" | ||
| every { preferencesHelper.serviceUrl } returns mockServer.hostName | ||
| every { preferencesHelper.port } returns mockServer.port | ||
| every { preferencesHelper.scheme } returns "http" | ||
| every { preferencesHelper.defaultItemSection } returns "Products" | ||
| every { preferencesHelper.getSessionId(any(), any()) } returns 67 | ||
|
|
||
| every { configMemoryHolder.autocompleteResultCount } returns null | ||
| every { configMemoryHolder.defaultAnalyticsTags } returns mapOf("appVersion" to "123", "appPlatform" to "Android") | ||
| every { configMemoryHolder.userId } returns "player-three" | ||
| every { configMemoryHolder.testCellParams } returns emptyList() | ||
| every { configMemoryHolder.segments } returns emptyList() | ||
|
|
||
| val config = ConstructorIoConfig("dummyKey") | ||
| val dataManager = createTestDataManager(preferencesHelper, configMemoryHolder) | ||
|
|
||
| constructorIo.testInit(ctx, config, dataManager, preferencesHelper, configMemoryHolder) | ||
| } | ||
|
|
||
| @After | ||
| fun tearDown() { | ||
| mockServer.shutdown() | ||
| } | ||
|
|
||
| @Test | ||
| fun trackResultsImpressionView() { | ||
|
constructor-claude-bedrock[bot] marked this conversation as resolved.
constructor-claude-bedrock[bot] marked this conversation as resolved.
constructor-claude-bedrock[bot] marked this conversation as resolved.
There was a problem hiding this comment. Suggestion: There is no test for the empty-items guard behavior. A test like @Test
fun trackResultsImpressionViewWithEmptyItems() {
val observer = ConstructorIo.trackResultsImpressionViewInternal(emptyList()).test()
observer.assertComplete()
val request = mockServer.takeRequest(1, TimeUnit.SECONDS)
assertNull(request) // no request should be made
} |
||
| val mockResponse = MockResponse().setResponseCode(204) | ||
| mockServer.enqueue(mockResponse) | ||
|
|
||
| val items = listOf( | ||
| ResultsImpressionItem("item-1", "Item One"), | ||
| ResultsImpressionItem("item-2", "Item Two", variationId = "var-2") | ||
| ) | ||
| val observer = ConstructorIo.trackResultsImpressionViewInternal(items).test() | ||
| observer.assertComplete() | ||
| val request = awaitRequest() | ||
| assertEquals("POST", request.method) | ||
| assert(request.path!!.startsWith("/v2/behavioral_action/impression_view")) | ||
|
|
||
| val requestBody = getRequestBody(request) | ||
| assertEquals("true", requestBody["beacon"]) | ||
| assertEquals("wacko-the-guid", requestBody["i"]) | ||
| assertEquals("67", requestBody["s"]) | ||
| assert(requestBody["items"]!!.contains("item_id:item-1")) | ||
|
There was a problem hiding this comment. Suggestion: The item assertions use |
||
| assert(requestBody["items"]!!.contains("item_name:Item One")) | ||
| assert(requestBody["items"]!!.contains("item_id:item-2")) | ||
| assert(requestBody["items"]!!.contains("variation_id:var-2")) | ||
| } | ||
|
|
||
| @Test | ||
| fun trackResultsImpressionViewWithSearchTerm() { | ||
| val mockResponse = MockResponse().setResponseCode(204) | ||
| mockServer.enqueue(mockResponse) | ||
|
|
||
| val items = listOf(ResultsImpressionItem("item-1", "Item One", slCampaignId = "camp-1", slCampaignOwner = "owner-a")) | ||
| val observer = ConstructorIo.trackResultsImpressionViewInternal(items, searchTerm = "shoes").test() | ||
| observer.assertComplete() | ||
| val request = awaitRequest() | ||
|
|
||
| val requestBody = getRequestBody(request) | ||
| assertEquals("shoes", requestBody["search_term"]) | ||
| assert(requestBody["items"]!!.contains("sl_campaign_id:camp-1")) | ||
| assert(requestBody["items"]!!.contains("sl_campaign_owner:owner-a")) | ||
| } | ||
|
|
||
| @Test | ||
| fun trackResultsImpressionViewWithFilters() { | ||
| val mockResponse = MockResponse().setResponseCode(204) | ||
| mockServer.enqueue(mockResponse) | ||
|
|
||
| val items = listOf(ResultsImpressionItem("item-1", "Item One")) | ||
| val observer = ConstructorIo.trackResultsImpressionViewInternal(items, filterName = "category_id", filterValue = "shoes-123").test() | ||
| observer.assertComplete() | ||
| val request = awaitRequest() | ||
|
|
||
| val requestBody = getRequestBody(request) | ||
| assertEquals("category_id", requestBody["filter_name"]) | ||
| assertEquals("shoes-123", requestBody["filter_value"]) | ||
| } | ||
|
|
||
| @Test | ||
| fun trackResultsImpressionViewWithAnalyticsTags() { | ||
| val mockResponse = MockResponse().setResponseCode(204) | ||
| mockServer.enqueue(mockResponse) | ||
|
|
||
| val items = listOf(ResultsImpressionItem("item-1", "Item One")) | ||
| val observer = ConstructorIo.trackResultsImpressionViewInternal(items, analyticsTags = mapOf("test" to "test1", "appVersion" to "150")).test() | ||
| observer.assertComplete() | ||
| val request = awaitRequest() | ||
|
|
||
| val requestBody = getRequestBody(request) | ||
| assertEquals("{appVersion:150,appPlatform:Android,test:test1}", requestBody["analytics_tags"]) | ||
| } | ||
|
|
||
| @Test | ||
| fun trackResultsImpressionView500() { | ||
| val mockResponse = MockResponse().setResponseCode(500).setBody("Internal server error") | ||
| mockServer.enqueue(mockResponse) | ||
|
|
||
| val items = listOf(ResultsImpressionItem("item-1", "Item One")) | ||
| val observer = ConstructorIo.trackResultsImpressionViewInternal(items).test() | ||
| observer.assertError { true } | ||
| val request = awaitRequest() | ||
| assert(request.path!!.startsWith("/v2/behavioral_action/impression_view")) | ||
| } | ||
|
|
||
| @Test | ||
| fun trackResultsImpressionViewTimeout() { | ||
| val mockResponse = MockResponse() | ||
| .setResponseCode(500) | ||
| .setBody("Internal server error") | ||
| .setBodyDelay(5, TimeUnit.SECONDS) | ||
| mockServer.enqueue(mockResponse) | ||
|
|
||
| val items = listOf(ResultsImpressionItem("item-1", "Item One")) | ||
| val observer = ConstructorIo.trackResultsImpressionViewInternal(items).test() | ||
| observer.awaitDone(6, TimeUnit.SECONDS) | ||
| observer.assertError(SocketTimeoutException::class.java) | ||
| val request = awaitRequest() | ||
| assert(request.path!!.startsWith("/v2/behavioral_action/impression_view")) | ||
| } | ||
|
|
||
| private fun awaitRequest(): RecordedRequest { | ||
| return mockServer.takeRequest(1, TimeUnit.SECONDS) | ||
| ?: throw AssertionError("Expected request but timed out") | ||
| } | ||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.