fixup: removed CustomEvent and updated comparison keys

- removed CustomEvent and immediately save custom event properties into a JSONObject
- renamed TrackEventOperation to TrackCustomEventOperation
- removed app_id in body
- fix comparison key to unique custom event key
- fix some test units to prevent them from failing

Author: jinliu9508

OneSignalSDK/onesignal/core/src/main/java/com/onesignal/core/internal/operations/impl/OperationModelStore.kt

@@ -14,7 +14,7 @@ import com.onesignal.user.internal.operations.RefreshUserOperation
 import com.onesignal.user.internal.operations.SetAliasOperation
 import com.onesignal.user.internal.operations.SetPropertyOperation
 import com.onesignal.user.internal.operations.SetTagOperation
-import com.onesignal.user.internal.operations.TrackEventOperation
+import com.onesignal.user.internal.operations.TrackCustomEventOperation
 import com.onesignal.user.internal.operations.TrackPurchaseOperation
 import com.onesignal.user.internal.operations.TrackSessionEndOperation
 import com.onesignal.user.internal.operations.TrackSessionStartOperation
@@ -62,7 +62,7 @@ internal class OperationModelStore(prefs: IPreferencesService) : ModelStore<Oper
                 UpdateUserOperationExecutor.TRACK_SESSION_START -> TrackSessionStartOperation()
                 UpdateUserOperationExecutor.TRACK_SESSION_END -> TrackSessionEndOperation()
                 UpdateUserOperationExecutor.TRACK_PURCHASE -> TrackPurchaseOperation()
-                CustomEventOperationExecutor.CUSTOM_EVENT -> TrackEventOperation()
+                CustomEventOperationExecutor.CUSTOM_EVENT -> TrackCustomEventOperation()
                 else -> throw Exception("Unrecognized operation: $operationName")
             }
 

OneSignalSDK/onesignal/core/src/main/java/com/onesignal/user/internal/UserManager.kt

@@ -12,7 +12,6 @@ import com.onesignal.debug.internal.logging.Logging
 import com.onesignal.user.IUserManager
 import com.onesignal.user.internal.backend.IdentityConstants
 import com.onesignal.user.internal.customEvents.ICustomEventController
-import com.onesignal.user.internal.customEvents.impl.CustomEvent
 import com.onesignal.user.internal.identity.IdentityModel
 import com.onesignal.user.internal.identity.IdentityModelStore
 import com.onesignal.user.internal.properties.PropertiesModel
@@ -257,7 +256,7 @@ internal open class UserManager(
             return
         }
 
-        _customEventController.sendCustomEvent(CustomEvent(name, properties))
+        _customEventController.sendCustomEvent(name, properties)
     }
 
     override fun onModelReplaced(

OneSignalSDK/onesignal/core/src/main/java/com/onesignal/user/internal/customEvents/ICustomEvent.kt

@@ -1,7 +1,6 @@
 package com.onesignal.user.internal.customEvents
 
 import com.onesignal.core.internal.operations.ExecutionResponse
-import com.onesignal.user.internal.customEvents.impl.CustomEvent
 import com.onesignal.user.internal.customEvents.impl.CustomEventMetadata
 
 /**
@@ -18,7 +17,8 @@ interface ICustomEventBackendService {
         onesignalId: String,
         externalId: String?,
         timestamp: Long,
-        customEvent: CustomEvent,
+        eventName: String,
+        eventProperties: String?,
         metadata: CustomEventMetadata,
     ): ExecutionResponse
 }

OneSignalSDK/onesignal/core/src/main/java/com/onesignal/user/internal/customEvents/ICustomEventBackendService.kt

@@ -1,7 +1,8 @@
 package com.onesignal.user.internal.customEvents
 
-import com.onesignal.user.internal.customEvents.impl.CustomEvent
-
 interface ICustomEventController {
-    fun sendCustomEvent(event: CustomEvent)
+    fun sendCustomEvent(
+        name: String,
+        properties: Map<String, Any>?,
+    )
 }

OneSignalSDK/onesignal/core/src/main/java/com/onesignal/user/internal/customEvents/ICustomEventController.kt

@@ -8,6 +8,7 @@ import com.onesignal.core.internal.operations.ExecutionResult
 import com.onesignal.user.internal.customEvents.ICustomEventBackendService
 import org.json.JSONArray
 import org.json.JSONObject
+import java.util.TimeZone
 
 internal class CustomEventBackendService(
     private val _httpClient: IHttpClient,
@@ -17,17 +18,25 @@ internal class CustomEventBackendService(
         onesignalId: String,
         externalId: String?,
         timestamp: Long,
-        customEvent: CustomEvent,
+        eventName: String,
+        eventProperties: String?,
         metadata: CustomEventMetadata,
     ): ExecutionResponse {
         val body = JSONObject()
-        body.put("name", customEvent.name)
-        body.put("app_id", appId)
+        body.put("name", eventName)
         body.put("onesignal_id", onesignalId)
         externalId?.let { body.put("external_id", it) }
-        body.put("timestamp", DateUtils.iso8601Format().format(timestamp))
+        body.put(
+            "timestamp",
+            DateUtils.iso8601Format().apply {
+                timeZone = TimeZone.getTimeZone("UTC")
+            }.format(
+                timestamp,
+            ),
+        )
+
+        val payload = eventProperties?.let { JSONObject(it) } ?: JSONObject()
 
-        val payload = customEvent.propertiesJson
         payload.put("os_sdk", metadata.toJSONObject())
 
         body.put("payload", payload)

OneSignalSDK/onesignal/core/src/main/java/com/onesignal/user/internal/customEvents/impl/CustomEvent.kt

@@ -5,23 +5,61 @@ import com.onesignal.core.internal.operations.IOperationRepo
 import com.onesignal.core.internal.time.ITime
 import com.onesignal.user.internal.customEvents.ICustomEventController
 import com.onesignal.user.internal.identity.IdentityModelStore
-import com.onesignal.user.internal.operations.TrackEventOperation
+import com.onesignal.user.internal.operations.TrackCustomEventOperation
+import org.json.JSONArray
+import org.json.JSONObject
 
 class CustomEventController(
     private val _identityModelStore: IdentityModelStore,
     private val _configModelStore: ConfigModelStore,
     private val _time: ITime,
     private val _opRepo: IOperationRepo,
 ) : ICustomEventController {
-    override fun sendCustomEvent(event: CustomEvent) {
+    override fun sendCustomEvent(
+        name: String,
+        properties: Map<String, Any>?,
+    ) {
         val op =
-            TrackEventOperation(
+            TrackCustomEventOperation(
                 _configModelStore.model.appId,
                 _identityModelStore.model.onesignalId,
                 _identityModelStore.model.externalId,
                 _time.currentTimeMillis,
-                event,
+                name,
+                properties?.let { mapToJson(it).toString() },
             )
         _opRepo.enqueue(op)
     }
+
+    /**
+     * Recursively convert a JSON-serializable map into a JSON-compatible format, handling
+     * nested Maps and Lists appropriately.
+     */
+    private fun mapToJson(map: Map<String, Any>): JSONObject {
+        val json = JSONObject()
+        for ((key, value) in map) {
+            json.put(key, convertToJson(value))
+        }
+        return json
+    }
+
+    private fun convertToJson(value: Any): Any {
+        return when (value) {
+            is Map<*, *> -> {
+                val subMap =
+                    value.entries
+                        .filter { it.key is String }
+                        .associate {
+                            it.key as String to convertToJson(it.value!!)
+                        }
+                mapToJson(subMap)
+            }
+            is List<*> -> {
+                val array = JSONArray()
+                value.forEach { array.put(convertToJson(it!!)) }
+                array
+            }
+            else -> value
+        }
+    }
 }

OneSignalSDK/onesignal/core/src/main/java/com/onesignal/user/internal/customEvents/impl/CustomEventBackendService.kt

@@ -3,10 +3,9 @@ package com.onesignal.user.internal.operations
 import com.onesignal.common.IDManager
 import com.onesignal.core.internal.operations.GroupComparisonType
 import com.onesignal.core.internal.operations.Operation
-import com.onesignal.user.internal.customEvents.impl.CustomEvent
 import com.onesignal.user.internal.operations.impl.executors.CustomEventOperationExecutor
 
-class TrackEventOperation() : Operation(CustomEventOperationExecutor.CUSTOM_EVENT) {
+class TrackCustomEventOperation() : Operation(CustomEventOperationExecutor.CUSTOM_EVENT) {
     /**
      * The OneSignal appId the custom event was created.
      */
@@ -45,28 +44,38 @@ class TrackEventOperation() : Operation(CustomEventOperationExecutor.CUSTOM_EVEN
         }
 
     /**
-     * The custom event instance containing the event name and properties.
+     * The name for the custom event.
      */
-    var event: CustomEvent
-        get() = getAnyProperty(::event.name) as CustomEvent
+    var eventName: String
+        get() = getStringProperty(::eventName.name)
         set(value) {
-            setAnyProperty(::event.name, value)
+            setAnyProperty(::eventName.name, value)
         }
 
-    override val createComparisonKey: String get() = "$appId.User.$onesignalId"
-    override val modifyComparisonKey: String get() = "$appId.User.$onesignalId.CustomEvent.$name"
+    /**
+     * The nullable properties for the custom event.
+     */
+    var eventProperties: String?
+        get() = getOptStringProperty(::eventProperties.name)
+        set(value) {
+            setOptStringProperty(::eventProperties.name, value)
+        }
+
+    override val createComparisonKey: String get() = "$appId.User.$onesignalId.CustomEvent.$eventName"
+    override val modifyComparisonKey: String get() = "$appId.User.$onesignalId.CustomEvent.$eventName"
 
     // TODO: no batching of custom events until finalized
     override val groupComparisonType: GroupComparisonType = GroupComparisonType.NONE
     override val canStartExecute: Boolean get() = !IDManager.isLocalId(onesignalId)
     override val applyToRecordId: String get() = onesignalId
 
-    constructor(appId: String, onesignalId: String, externalId: String?, timeStamp: Long, event: CustomEvent) : this() {
+    constructor(appId: String, onesignalId: String, externalId: String?, timeStamp: Long, eventName: String, eventProperties: String?) : this() {
         this.appId = appId
         this.onesignalId = onesignalId
         this.externalId = externalId
         this.timeStamp = timeStamp
-        this.event = event
+        this.eventName = eventName
+        this.eventProperties = eventProperties
     }
 
     override fun translateIds(map: Map<String, String>) {

OneSignalSDK/onesignal/core/src/main/java/com/onesignal/user/internal/customEvents/impl/CustomEventController.kt

@@ -13,7 +13,7 @@ import com.onesignal.core.internal.operations.IOperationExecutor
 import com.onesignal.core.internal.operations.Operation
 import com.onesignal.user.internal.customEvents.ICustomEventBackendService
 import com.onesignal.user.internal.customEvents.impl.CustomEventMetadata
-import com.onesignal.user.internal.operations.TrackEventOperation
+import com.onesignal.user.internal.operations.TrackCustomEventOperation
 
 internal class CustomEventOperationExecutor(
     private val _customEventBackendService: ICustomEventBackendService,
@@ -40,13 +40,14 @@ internal class CustomEventOperationExecutor(
 
         try {
             when (operation) {
-                is TrackEventOperation -> {
+                is TrackCustomEventOperation -> {
                     _customEventBackendService.sendCustomEvent(
                         operation.appId,
                         operation.onesignalId,
                         operation.externalId,
                         operation.timeStamp,
-                        operation.event,
+                        operation.eventName,
+                        operation.eventProperties,
                         eventMetadataJson,
                     )
                 }