fix: custom events now handle null object within the event properties

[jinliu9508]

Description

One Line Summary

Fix null value handling in JSON conversion for custom event properties to preserve null values in nested structures.

Details

Motivation

Custom event properties with null values were not preserved when converting to JSON. This prevented users from tracking events with null properties (e.g., someNull: null or nested nulls like someObject.ghi: null). The JSON conversion now preserves nulls by converting them to JSONObject.NULL, matching expected JSON behavior.

Scope

• Changed: JSONUtils.convertToJson() now converts null values to JSONObject.NULL instead of leaving them as-is
• Changed: Updated all related unit tests to verify null handling
• Added: Comprehensive test coverage for CustomEventController including null property scenarios
• Not changed: Other JSON conversion behavior remains the same; only null handling was modified

OPTIONAL - Other

The fix ensures that when convertToJson() encounters a null value, it returns JSONObject.NULL instead of null. This allows:

• Null values at the root level: {"someNull": null}
• Null values in nested objects: {"someObject": {"ghi": null}}
• Null values in arrays: [1, "2", {"abc": "123"}, null]
  All null values are properly serialized to JSON and can be deserialized back, maintaining data integrity throughout the conversion process.

Testing

Unit testing

Updated JSONUtilsTests.kt.
Added CustomEventControllerTests.kt.
All tests verify that null values are correctly converted to JSONObject.NULL and preserved in the final JSON output.

Manual testing

Tested with emulator Pixel 9 api 35
Used some example codes in MainApplicationKT.kt which tracks a custom event with the following structure:

val properties = mapOf(
    "someNum" to 123,
    "someFloat" to 3.14159,
    "someString" to "abc",
    "someBool" to true,
    "someObject" to mapOf(
        "abc" to "123",
        "nested" to mapOf("def" to "456"),
        "ghi" to null,  // null in nested object
    ),
    "someArray" to listOf(1, 2),
    "someMixedArray" to listOf(1, "2", mapOf("abc" to "123"), null),  // null in array
    "someNull" to null,  // null at root level
)

Verified that all null values are properly serialized and sent to the backend.

Affected code checklist

• Notifications
  • Display
  • Open
  • Push Processing
  • Confirm Deliveries
• Outcomes
• Sessions
• In-App Messaging
• REST API requests
• Public API changes

Checklist

Overview

• I have filled out all REQUIRED sections above
• PR does one thing
  • If it is hard to explain how any codes changes are related to each other then it most likely needs to be more than one PR
• Any Public API changes are explained in the PR details and conform to existing APIs

Testing

• I have included test coverage for these changes, or explained why they are not needed
• All automated tests pass, or I explained why that is not possible
• I have personally tested this on my device, or explained why that is not possible

Final pass

• Code is as readable as possible.
  • Simplify with less code, followed by splitting up code into well named functions and variables, followed by adding comments to the code.
• I have reviewed this PR myself, ensuring it meets each checklist item
  • WIP (Work In Progress) is ok, but explain what is still in progress and what you would like feedback on. Start the PR title with "WIP" to indicate this.

---

This change is 

[claude]

Code review

No issues found. Checked for bugs and CLAUDE.md compliance.

[abdulraqeeb33]

i am surprised how this passed detekt in the first place

[github-actions]

📊 Diff Coverage Report

Diff Coverage Report (Changed Lines Only)

Threshold: 80%

Changed Files Coverage

• ✅ JSONUtils.kt: 3/3 changed lines (100.0%) (6 changed lines)
• ❌ IUserManager.kt: 0/1 changed lines (0.0%) (1 changed lines)
  • ⚠️ Below threshold: 1 uncovered changed lines

Overall Coverage (Changed Lines Only)

3/4 changed lines covered (75.0%)

❌ Coverage Check Failed

Files below 80% threshold:

• IUserManager.kt: 0.0% (1 uncovered changed lines)

📥 View workflow run

[Copilot]

Pull request overview

This pull request fixes null value handling in JSON conversion for custom event properties to ensure null values are preserved throughout the serialization process.

Changes:

• Modified JSONUtils.convertToJson() to convert null values to JSONObject.NULL instead of leaving them as-is
• Updated type signatures from Map<String, Any> to Map<String, Any?> across the custom event interfaces and implementations to support null property values
• Added comprehensive test coverage for null handling in both JSONUtilsTests.kt and a new CustomEventControllerTests.kt file

Reviewed changes

Copilot reviewed 10 out of 10 changed files in this pull request and generated no comments.

Show a summary per file

File	Description
OneSignalSDK/onesignal/core/src/main/java/com/onesignal/common/JSONUtils.kt	Updated convertToJson() and mapToJson() to handle null values by converting them to JSONObject.NULL, and removed force-unwrap operators
OneSignalSDK/onesignal/core/src/test/java/com/onesignal/common/JSONUtilsTests.kt	Added comprehensive test cases for null value handling in maps, arrays, and nested structures
OneSignalSDK/onesignal/core/src/test/java/com/onesignal/user/internal/customEvents/impl/CustomEventControllerTests.kt	New test file with full test coverage for custom event controller including null property scenarios
OneSignalSDK/onesignal/core/src/main/java/com/onesignal/user/internal/customEvents/ICustomEventController.kt	Updated type signature to Map<String, Any?>? and added documentation
OneSignalSDK/onesignal/core/src/main/java/com/onesignal/user/internal/customEvents/impl/CustomEventController.kt	Updated type signature to Map<String, Any?>? and added class documentation
OneSignalSDK/onesignal/core/src/main/java/com/onesignal/user/IUserManager.kt	Updated type signature to Map<String, Any?>?
OneSignalSDK/onesignal/core/src/main/java/com/onesignal/user/internal/UserManager.kt	Updated type signature to Map<String, Any?>?
OneSignalSDK/onesignal/core/src/test/java/com/onesignal/user/internal/UserManagerTests.kt	Added null property to test case
OneSignalSDK/onesignal/core/src/main/java/com/onesignal/user/internal/operations/TrackCustomEventOperation.kt	Added class documentation
OneSignalSDK/onesignal/core/src/main/java/com/onesignal/user/internal/customEvents/impl/CustomEventMetadata.kt	Added class and method documentation

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[jinliu9508]

Runner failed with a test coverage for an interface. Merging now.