Skip to content

fix: Add enum value to hash ecommerce event attributes #169

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Mansi-mParticle wants to merge 6 commits into
base: development
Choose a base branch
from
Open

fix: Add enum value to hash ecommerce event attributes #169

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
44965b6
fix: Add enum value to hash ecommerce event attributes
Mansi-mParticle Jul 10, 2024
edf1408
Update the logic based on feedback
Mansi-mParticle Jul 18, 2024
f932c03
Address review comment
Mansi-mParticle Jul 19, 2024
50902e2
change variable name
Mansi-mParticle Jul 19, 2024
fd439ba
fix unit test case
Mansi-mParticle Jul 19, 2024
c162935
add custom attributes
Mansi-mParticle Jul 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions src/main/kotlin/com/mparticle/kits/AppboyKit.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,11 @@ open class AppboyKit : KitIntegration(), AttributeListener, CommerceListener,
val brazePropertiesSetter = BrazePropertiesSetter(properties, enableTypeDetection)
event.customAttributeStrings?.let { it ->
for ((key, value) in it) {
newAttributes[key] = brazePropertiesSetter.parseValue(key, value)
try {
newAttributes[key] = brazePropertiesSetter.parseValue(key, value)
} catch (e: Exception) {
Logger.warning("Exception while parsing custom attributes $e")
}
}
}
Braze.getInstance(context).logCustomEvent(event.eventName, properties)
Expand All @@ -152,7 +156,11 @@ open class AppboyKit : KitIntegration(), AttributeListener, CommerceListener,
event.customAttributeStrings?.let { it ->
for ((key, attributeValue) in it) {
val hashedKey =
KitUtils.hashForFiltering(event.eventType.value.toString() + event.eventName + key)
if (event.eventName.contains("eCommerce")) {
Comment thread
Mansi-mParticle marked this conversation as resolved.
Outdated
KitUtils.hashForFiltering(event.eventType.value.toString() + key.trim())
} else {
KitUtils.hashForFiltering(event.eventType.value.toString() + event.eventName.trim() + key.trim())
}

configuration.eventAttributesAddToUser?.get(hashedKey)?.let {
value.addToCustomAttributeArray(it, attributeValue)
Expand Down
4 changes: 4 additions & 0 deletions src/test/kotlin/com/braze/Braze.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,10 @@ class Braze {
events.clear()
}

fun clearBrazeUser(){
currentUser.customUserAttributes.clear()
currentUser.customAttributeArray.clear()
}
val currentUser = BrazeUser()

@JvmStatic
Expand Down
205 changes: 205 additions & 0 deletions src/test/kotlin/com/mparticle/kits/AppboyKitTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,8 @@ import org.junit.Before
import org.junit.Test
import org.mockito.Mock
import org.mockito.Mockito
import org.mockito.Mockito.mock
import org.mockito.Mockito.`when`
import org.mockito.MockitoAnnotations
import java.math.BigDecimal
import java.util.Calendar
Expand All @@ -46,6 +48,7 @@ class AppboyKitTests {
MockitoAnnotations.initMocks(this)
Braze.clearPurchases()
Braze.clearEvents()
Braze.clearBrazeUser()
MParticle.setInstance(Mockito.mock(MParticle::class.java))
Mockito.`when`(MParticle.getInstance()!!.Identity()).thenReturn(
Mockito.mock(
Expand Down Expand Up @@ -567,6 +570,208 @@ class AppboyKitTests {
Assert.assertEquals(emptyAttributes, properties)
}

@Test
fun testCustomAttributes() {
val kit = MockAppboyKit()
val currentUser = braze.currentUser

val product: Product = Product.Builder("La Enchilada", "13061043670", 12.5)
.quantity(1.0)
.build()

val txAttributes = TransactionAttributes()
.setRevenue(product.totalAmount)

kit.configuration = MockKitConfiguration()
val customAttributes: MutableMap<String, String> = HashMap()
customAttributes["currentLocationLongitude"] = "2.1811267"
customAttributes["country"] = "ES"
customAttributes["deliveryLocationLatitude"] = "41.4035798"
customAttributes["appVersion"] = "5.201.0"
customAttributes["city"] = "BCN"
customAttributes["deviceId"] = "1104442582"
customAttributes["platform"] = "android"
customAttributes["isAuthorized"] = "true"
val commerceEvent: CommerceEvent = CommerceEvent.Builder(Product.ADD_TO_CART, product)
.currency("EUR")
.customAttributes(customAttributes)
.transactionAttributes(txAttributes)
.build()

val jsonObject = JSONObject()
val mapValue = JSONObject()
mapValue.put("-844012960", "test")
val eassObject = JSONObject()
eassObject.put("eaa", mapValue)

jsonObject.put("hs", eassObject)
val mockSparseBooleanArray = mock(SparseBooleanArray::class.java)

`when`(mockSparseBooleanArray.size()).thenReturn(0)
`when`(mTypeFilters!!.size()).thenReturn(0) // Example mock behavior

var kitConfiguration = MockKitConfiguration.createKitConfiguration(jsonObject)
kit.configuration = kitConfiguration

kit.logEvent(commerceEvent)
Assert.assertEquals(1, braze.events.size.toLong())
Assert.assertEquals(1, currentUser.getCustomAttribute().size.toLong())
var outputKey = ""
for (keys in currentUser.getCustomAttribute().keys) {
outputKey = keys
break
}
Assert.assertEquals("test", outputKey)

}

@Test
fun testCustomAttributes_log_event() {
val kit = MockAppboyKit()
val currentUser = braze.currentUser

kit.configuration = MockKitConfiguration()

val jsonObject = JSONObject()
val mapValue = JSONObject()
//this is hash for event attribute i.e combination of eventType + eventName + attribute key
mapValue.put("888169310", "testEvent")
val eassObject = JSONObject()
eassObject.put("eaa", mapValue)

jsonObject.put("hs", eassObject)
val mockSparseBooleanArray = mock(SparseBooleanArray::class.java)

`when`(mockSparseBooleanArray.size()).thenReturn(0)
`when`(mTypeFilters!!.size()).thenReturn(0) // Example mock behavior

var kitConfiguration = MockKitConfiguration.createKitConfiguration(jsonObject)
kit.configuration = kitConfiguration
val customAttributes: MutableMap<String, String> = HashMap()
customAttributes["destination"] = "Shop"
val event = MPEvent.Builder("AndroidTEST", MParticle.EventType.Navigation)
.customAttributes(customAttributes)
.build()
val instance = MParticle.getInstance()
instance?.logEvent(event)
kit.logEvent(event)
Assert.assertEquals(1, braze.events.size.toLong())
Assert.assertEquals(1, currentUser.getCustomAttribute().size.toLong())
var outputKey = ""
for (keys in currentUser.getCustomAttribute().keys) {
outputKey = keys
break
}
Assert.assertEquals("testEvent", outputKey)
}

@Test
fun testCustomAttributes_remove_attributes() {
val kit = MockAppboyKit()
val currentUser = braze.currentUser
kit.configuration = MockKitConfiguration()
val product: Product = Product.Builder("La Enchilada", "13061043670", 12.5)
.quantity(1.0)
.build()

val txAttributes = TransactionAttributes()
.setRevenue(product.totalAmount)


val customAttributes: MutableMap<String, String> = HashMap()
customAttributes["currentLocationLongitude"] = "2.1811267"
customAttributes["country"] = "ES"
customAttributes["deliveryLocationLatitude"] = "41.4035798"
customAttributes["appVersion"] = "5.201.0"
customAttributes["city"] = "BCN"
customAttributes["deviceId"] = "1104442582"
customAttributes["platform"] = "android"
customAttributes["isAuthorized"] = "true"
val commerceEvent: CommerceEvent = CommerceEvent.Builder(Product.ADD_TO_CART, product)
.currency("EUR")
.customAttributes(customAttributes)
.transactionAttributes(txAttributes)
.build()


val jsonObject = JSONObject()
val mapValue = JSONObject()
//this is hash for event attribute i.e combination of eventType + eventName + attribute key
mapValue.put("-844012960", "test")
val eassObject = JSONObject()
eassObject.put("eaa", mapValue)
eassObject.put("ear", mapValue)
jsonObject.put("hs", eassObject)
val mockSparseBooleanArray = mock(SparseBooleanArray::class.java)

`when`(mockSparseBooleanArray.size()).thenReturn(0)
`when`(mTypeFilters!!.size()).thenReturn(0) // Example mock behavior

var kitConfiguration = MockKitConfiguration.createKitConfiguration(jsonObject)
kit.configuration = kitConfiguration

kit.logEvent(commerceEvent)

Assert.assertEquals(1, braze.events.size.toLong())
Assert.assertEquals(0, currentUser.getCustomAttribute().size.toLong())

}



@Test
fun testCustomAttributes_add_customUserAttribute() {
val kit = MockAppboyKit()
val currentUser = braze.currentUser
kit.configuration = MockKitConfiguration()
val product: Product = Product.Builder("La Enchilada", "13061043670", 12.5)
.quantity(1.0)
.build()

val txAttributes = TransactionAttributes()
.setRevenue(product.totalAmount)


val customAttributes: MutableMap<String, String> = HashMap()
customAttributes["currentLocationLongitude"] = "2.1811267"
customAttributes["country"] = "ES"
customAttributes["deliveryLocationLatitude"] = "41.4035798"
customAttributes["appVersion"] = "5.201.0"
customAttributes["city"] = "BCN"
customAttributes["deviceId"] = "1104442582"
customAttributes["platform"] = "android"
customAttributes["isAuthorized"] = "true"
val commerceEvent: CommerceEvent = CommerceEvent.Builder(Product.ADD_TO_CART, product)
.currency("EUR")
.customAttributes(customAttributes)
.transactionAttributes(txAttributes)
.build()


val jsonObject = JSONObject()
val mapValue = JSONObject()
//this is hash for event attribute i.e combination of eventType + eventName + attribute key
mapValue.put("-844012960", "test")
val eassObject = JSONObject()
eassObject.put("eaa", mapValue)
eassObject.put("eas", mapValue)

jsonObject.put("hs", eassObject)
val mockSparseBooleanArray = mock(SparseBooleanArray::class.java)

`when`(mockSparseBooleanArray.size()).thenReturn(0)
`when`(mTypeFilters!!.size()).thenReturn(0) // Example mock behavior

var kitConfiguration = MockKitConfiguration.createKitConfiguration(jsonObject)
kit.configuration = kitConfiguration

kit.logEvent(commerceEvent)

Assert.assertEquals(1, braze.events.size.toLong())
Assert.assertEquals(1, currentUser.getCustomUserAttribute().size)

}

// @Test
// fun testPromotion() {
// val emptyAttributes = HashMap<String, String>()
Expand Down