Add getters and observer for onesignal ID and external ID

[jennantilla]

Description

One Line Summary

Add getters for onesignal ID and external ID, and a user state observer to know when these values are changed.

Details

Motivation

From developer feedback and to support integration partners, we are exposing the onesignal ID and external ID with getters.

We also want to grant developers the ability to add observers that can be called when there is a change in user state.

Testing

Manual testing

Manually tested on:

• Pixel 7 Pro Emulator running Android 14
• iPhone 15 Pro running iOS 17.0.1

Tested adding observer for user state and calling new methods to access externalId and onesignalId. Ensured congruency between iOS and Android responses.

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 

Original review comments resolved; dismissing this stale review to request re-review

[jennantilla]

Reviewable status: 0 of 9 files reviewed, 3 unresolved discussions (waiting on @emawby, @jinliu9508, @jkasten2, @nan-li, and @shepherd-l)

---

MIGRATION_GUIDE.md line 226 at r1 (raw file):

Previously, nan-li (Nan) wrote…

Let's update this usage to await OneSignal.User.getOnesignalId() and await OneSignal.User.getExternalId() ?

Done.

---

www/UserNamespace.ts line 182 at r1 (raw file):

Previously, nan-li (Nan) wrote…

Let's add a callout in this method description, something like this that is in the native SDKs:

Important: When using the observer to retrieve the onesignalId, check the externalId as well to confirm the values are associated with the expected user.

I can see people just grabbing the onesignalId right away and it may not necessarily have fired for the user they were expecting.

Done.

[nan-li]

Everything looks good, the only callout is on the UserState object. If there's no external_id, it will fire with

{
  "current": {
    "onesignalId": "b22ad46f-b4c6-464d-8eb2-8225453f0524"
  }
}

You'll need to set null explicitly to the object in native so that it will become:

{
  "current": {
    "externalId": null,
    "onesignalId": "27757d1c-ea72-4cea-a4f8-ac1213e32a6d"
  }
}

[jennantilla]

Good catch, @nan-li! I've updated!

[nan-li]

Everything looks great, I just pulled logic into a helper method to translate values into null since they are used in multiple places. In this commit.

And did a rebase on user_model/main branch.

This is my testing scenario:

1. New app install, call getters for onesignal ID and external ID and see they are null.

    OneSignal.User.getOnesignalId().then(res => {
      console.log("getOnesignalId: " + res); // logs null
    });
    OneSignal.User.getExternalId().then(res => {
      console.log("getExternalId: " + res); // logs null
    });

2. Observer fires once the onesignal ID is received.

{
  "current": {
    "externalId": null,
    "onesignalId": "1234-abcd-1234-abcd-1234"
  }
}

3. Observer fires after calling login.

{
  "current": {
    "externalId": "my-euid",
    "onesignalId": "1234-abcd-1234-abcd-1234"
  }
}