Skip to content

Commit

Permalink
Merge pull request #688 from adobe/dev
Browse files Browse the repository at this point in the history 
Merge `staging` with `dev` for a patch
  • Loading branch information
@prudrabhat
prudrabhat authored Jun 20, 2024
2 parents 135dd43 + 83f5734 commit 449a92b
Show file tree
Hide file tree
Showing 2 changed files with 44 additions and 55 deletions.
35 changes: 12 additions & 23 deletions code/core/src/main/java/com/adobe/marketing/mobile/util/EventUtils.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,38 +22,27 @@ private const val KEY_DEBUG_EVENT_TYPE = "eventType"
private const val KEY_DEBUG_EVENT_SOURCE = "eventSource"

/**
* Returns the debug event type (identified by debug.eventType) from the event data if present, otherwise null.
* @return the debug event type if present, otherwise null
* The debug event type (identified by debug.eventType) from the event data if present, otherwise null
*/
fun Event.getDebugEventType(): String? {
val debugData = getDebugEventData() ?: return null
val debugEventType = debugData[KEY_DEBUG_EVENT_TYPE]
if (debugEventType !is String) return null

return debugEventType
}
val Event.debugEventType: String?
get() = debugEventData?.get(KEY_DEBUG_EVENT_TYPE) as? String

/**
* Returns the debug event source (identified by debug.eventSource) from the event data if present, otherwise null.
* @return the debug event source if present, otherwise null
* The debug event source (identified by debug.eventSource) from the event data if present, otherwise null.
*/
fun Event.getDebugEventSource(): String? {
val debugData = getDebugEventData() ?: return null
val debugEventSource = debugData[KEY_DEBUG_EVENT_SOURCE]
if (debugEventSource !is String) return null

return debugEventSource
}
val Event.debugEventSource: String?
get() = debugEventData?.get(KEY_DEBUG_EVENT_SOURCE) as? String

/**
* Returns the debug event data (identified by data.debug) from the event if present, otherwise null.
* @return the content of "debug" key within "Event.data" if present,
* null if the event is not a debug event or if the debug data does not exist
*/
private fun Event.getDebugEventData(): Map<String, Any?>? {
if (type != EventType.SYSTEM || source != EventSource.DEBUG) return null
private val Event.debugEventData: Map<String, Any?>?
get() {
if (type != EventType.SYSTEM || source != EventSource.DEBUG) return null

if (eventData == null) return null
if (eventData == null) return null

return DataReader.optTypedMap(Any::class.java, eventData, KEY_EVENT_DATA_DEBUG, null) ?: null
}
return DataReader.optTypedMap(Any::class.java, eventData, KEY_EVENT_DATA_DEBUG, null) ?: null
}
64 changes: 32 additions & 32 deletions code/core/src/test/java/com/adobe/marketing/mobile/util/EventUtilsTest.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,37 +26,37 @@ class EventUtilsTest {
}

@Test
fun `Test getDebugEventType returns null on non debug event`() {
fun `Test debugEventType returns null on non debug event`() {
val event = Event.Builder(TEST_EVENT_NAME, EventType.HUB, EventSource.REQUEST_CONTENT).build()

assertNull(event.getDebugEventType())
assertNull(event.debugEventType)
}

@Test
fun `Test getDebugEventType returns null on no eventData`() {
fun `Test debugEventType returns null on no eventData`() {
val event = Event.Builder(TEST_EVENT_NAME, TEST_EVENT_TYPE, TEST_EVENT_SOURCE).build()

assertNull(event.getDebugEventType())
assertNull(event.debugEventType)
}

@Test
fun `Test getDebugEventType returns null on no debug data`() {
fun `Test debugEventType returns null on no debug data`() {
val event = Event.Builder(TEST_EVENT_NAME, TEST_EVENT_TYPE, TEST_EVENT_SOURCE)
.setEventData(mapOf("key" to "value")).build()

assertNull(event.getDebugEventType())
assertNull(event.debugEventType)
}

@Test
fun `Test getDebugEventType returns null when debug is not a map`() {
fun `Test debugEventType returns null when debug is not a map`() {
val event = Event.Builder(TEST_EVENT_NAME, TEST_EVENT_TYPE, TEST_EVENT_SOURCE)
.setEventData(mapOf("debug" to "value")).build()

assertNull(event.getDebugEventType())
assertNull(event.debugEventType)
}

@Test
fun `Test getDebugEventType returns null on invalid debug key`() {
fun `Test debugEventType returns null on invalid debug key`() {
val event = Event.Builder(TEST_EVENT_NAME, TEST_EVENT_TYPE, TEST_EVENT_SOURCE)
.setEventData(
mapOf(
Expand All @@ -67,11 +67,11 @@ class EventUtilsTest {
)
).build()

assertNull(event.getDebugEventType())
assertNull(event.debugEventType)
}

@Test
fun `Test getDebugEventType returns null when key is absent`() {
fun `Test debugEventType returns null when key is absent`() {
val event = Event.Builder(TEST_EVENT_NAME, TEST_EVENT_TYPE, TEST_EVENT_SOURCE)
.setEventData(
mapOf(
Expand All @@ -81,11 +81,11 @@ class EventUtilsTest {
)
).build()

assertNull(event.getDebugEventType())
assertNull(event.debugEventType)
}

@Test
fun `Test getDebugEventType returns debug event type`() {
fun `Test debugEventType returns debug event type`() {
val event = Event.Builder(TEST_EVENT_NAME, TEST_EVENT_TYPE, TEST_EVENT_SOURCE)
.setEventData(
mapOf(
Expand All @@ -96,11 +96,11 @@ class EventUtilsTest {
)
).build()

assertEquals(EventType.RULES_ENGINE, event.getDebugEventType())
assertEquals(EventType.RULES_ENGINE, event.debugEventType)
}

@Test
fun `Test getDebugEventType returns null when debugEvent type is not a string`() {
fun `Test debugEventType returns null when debugEvent type is not a string`() {
val event = Event.Builder(TEST_EVENT_NAME, TEST_EVENT_TYPE, TEST_EVENT_SOURCE)
.setEventData(
mapOf(
Expand All @@ -111,41 +111,41 @@ class EventUtilsTest {
)
).build()

assertNull(event.getDebugEventType())
assertNull(event.debugEventType)
}

@Test
fun `Test getDebugEventSource returns null on non debug event`() {
fun `Test debugEventSource returns null on non debug event`() {
val event = Event.Builder(TEST_EVENT_NAME, EventType.HUB, EventSource.REQUEST_CONTENT).build()

assertNull(event.getDebugEventSource())
assertNull(event.debugEventSource)
}

@Test
fun `Test getDebugEventSource returns null on no eventData`() {
fun `Test debugEventSource returns null on no eventData`() {
val event = Event.Builder(TEST_EVENT_NAME, TEST_EVENT_TYPE, TEST_EVENT_SOURCE).build()

assertNull(event.getDebugEventSource())
assertNull(event.debugEventSource)
}

@Test
fun `Test getDebugEventSource returns null when debug is not a map`() {
fun `Test debugEventSource returns null when debug is not a map`() {
val event = Event.Builder(TEST_EVENT_NAME, TEST_EVENT_TYPE, TEST_EVENT_SOURCE)
.setEventData(mapOf("debug" to "value")).build()

assertNull(event.getDebugEventSource())
assertNull(event.debugEventSource)
}

@Test
fun `Test getDebugEventSource returns null on no debug data`() {
fun `Test debugEventSource returns null on no debug data`() {
val event = Event.Builder(TEST_EVENT_NAME, TEST_EVENT_TYPE, TEST_EVENT_SOURCE)
.setEventData(mapOf("key" to "value")).build()

assertNull(event.getDebugEventSource())
assertNull(event.debugEventSource)
}

@Test
fun `Test getDebugEventSource returns null on invalid debug key`() {
fun `Test debugEventSource returns null on invalid debug key`() {
val event = Event.Builder(TEST_EVENT_NAME, TEST_EVENT_TYPE, TEST_EVENT_SOURCE)
.setEventData(
mapOf(
Expand All @@ -156,11 +156,11 @@ class EventUtilsTest {
)
).build()

assertNull(event.getDebugEventSource())
assertNull(event.debugEventSource)
}

@Test
fun `Test getDebugEventSource returns debug event source`() {
fun `Test debugEventSource returns debug event source`() {
val event = Event.Builder(TEST_EVENT_NAME, TEST_EVENT_TYPE, TEST_EVENT_SOURCE)
.setEventData(
mapOf(
Expand All @@ -171,11 +171,11 @@ class EventUtilsTest {
)
).build()

assertEquals(EventSource.RESET_COMPLETE, event.getDebugEventSource())
assertEquals(EventSource.RESET_COMPLETE, event.debugEventSource)
}

@Test
fun `Test getDebugEventSource returns null when debugEvent source is not a string`() {
fun `Test debugEventSource returns null when debugEvent source is not a string`() {
val event = Event.Builder(TEST_EVENT_NAME, TEST_EVENT_TYPE, TEST_EVENT_SOURCE)
.setEventData(
mapOf(
Expand All @@ -186,11 +186,11 @@ class EventUtilsTest {
)
).build()

assertNull(event.getDebugEventSource())
assertNull(event.debugEventSource)
}

@Test
fun `Test getDebugEventSource returns null when key is absent`() {
fun `Test debugEventSource returns null when key is absent`() {
val event = Event.Builder(TEST_EVENT_NAME, TEST_EVENT_TYPE, TEST_EVENT_SOURCE)
.setEventData(
mapOf(
Expand All @@ -200,6 +200,6 @@ class EventUtilsTest {
)
).build()

assertNull(event.getDebugEventSource())
assertNull(event.debugEventSource)
}
}

0 comments on commit 449a92b

Please sign in to comment.