Add toJSONObject method to OSInAppMessage

[nan-li]

Description

One Line Summary

Add JSON stringifier to the public OSInAppMessage class and refactor JSON stringifier for internal OSInAppMessageInternal class to return JSON key of "messageId" instead of "id".

Details

Motivation

We want the public OSInAppMessage to have a toJSONObject method for the wrappers to use. This JSON Object only has one item of "messageId". Since IAMs have the property messageId and our documentation refer to messageId, this key was chosen over "id".

The need for this method first arose when adding the InAppMessage Lifecycle Handler to React Native.
We also modified the OSInAppMessageInternal class's toJSONObject to return a JSON key of "messageId" instead of "id" for clarity and consistency to the public class.

Background Context

Previously, the current OSInAppMessageInternal class was named OSInAppMessage before being refactored into an internal InAppMessage class and a public InAppMessage class.

OSInOSInAppMessageInternal extends OSInAppMessage

Worth noting, "id" is expected instead of "messageId" when parsing JSON from the backend, so it is used in the constructor.

Scope

We didn't use any InAppMessage toJSONObject in SDK code, except in unit tests (see below) and those are removed now. The existing OSInAppMessageInternal toJSONObject method was package-private (made public in this PR) so users couldn't have used this method prior to this PR. This means changing the JSON key from "id" to "messageId" has no public API changes (but introduces a new method to the public).

Currently, all of the OSInAppMessage objects are actually OSInAppMessageInternal objects. We don't create any superclass OSInAppMessage objects in the existing codebase. This means when a user calls OSInAppMessage.toJSONObject(), they will receive the results of OSInAppMessageInternal.toJSONObject().

Testing

Unit testing

Some unit tests were creating an IAM based off the JSON of another IAM by calling its toJSONObject().
With the above changes, some tests in InAppMessageIntegrationTests broke because IAM constructors expect "id" instead of "messageId" when parsing the JSON, so we need to replace that with "id" for creating an IAM.

Added method:

convertIAMtoJSONObject(OSInAppMessageInternal inAppMessage)

• just replaces key "messageId" with "id"
• refactored unit test code to use this method instead of toJSONObject()

Removed a constructor:

OSTestInAppMessageInternal(OSInAppMessageInternal inAppMessage)

• this constructor passed the JSON from inAppMessage.toJSONObject()
• instead, use convertIAMtoJSONObject and pass this JSON into constructor

Added test:

testInAppMessageInternalToJSONObject_messageId

• tests OSInAppMessageInternal (not OSInAppMessage)
• only tests for "messageId", the primary focus

Manual testing

✅ Tested by calling OSInAppMessage.toJSONObject() in demo app:

• Android 11 Emulator
• Android 12 Emulator

Example of the JSON

{
  "messageId": "abe479ed-dc54-4446-898a-a82b67cfd5aa",
  "variants": {"all":{"default":"2a8934de-d3c1-4734-8b7c-796cd691456b"}},
  "displayDuration": 0,
  "redisplay": {"limit":1,"delay":0},"triggers":[],
  "has_liquid": false
}

✅ Tested in react-native-onesignal via the InAppMessageLifecycleHandler by logging the message and message.messageId

• When a user logs the message object, they receive the entire JSON object above, not just the messageId

Affected code checklist

• Notifications
  • Display
  • Open
  • Push Processing
  • Confirm Deliveries
• Outcomes
• Sessions
• In-App Messaging
• REST API requests
• Public API changes - exposes a new method (will update documentation)

Checklist

Overview

• I have filled out all REQUIRED sections above
• PR does one thing
• 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.
• I have reviewed this PR myself, ensuring it meets each checklist item

---

This change is 

[jkasten2]

Reviewed 2 of 2 files at r1, all commit messages.
Reviewable status: complete! all files reviewed, all discussions resolved (waiting on @nan-li)

[nan-li]

Reviewable status: 0 of 5 files reviewed, 1 unresolved discussion (waiting on @Jeasmine and @jkasten2)

---

OneSignalSDK/onesignal/src/main/java/com/onesignal/OSInAppMessage.java, line 55 at r1 (raw file):

Previously, nan-li (Nan) wrote…

Ah ok! I have seen that practice but didn't realize it is preferred.

Done!

[jkasten2]

Reviewed 5 of 5 files at r2, all commit messages.
Reviewable status: all files reviewed, 1 unresolved discussion (waiting on @emawby, @Jeasmine, and @rgomezp)