Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature: Identity Verification iOS Implementation #1038

Open
wants to merge 10 commits into
base: main
Choose a base branch
from

Conversation

jennantilla
Copy link
Contributor

@jennantilla jennantilla commented Dec 19, 2024

Description

One Line Summary

Implement identity verification functionality to our Cordova SDK.

NOTE: this is a new PR. For previous discussion please see #1033

Details

Implement identity verification functionality to our Cordova SDK with JWT (JSON Web Token) that manage a specific User, their Subscriptions, and Identities, if enabled using OneSignal dashboard.

Motivation

The OneSignal Identity Verification feature only exists today for the Player model; we want to add this functionality to the User Model SDKs.

Scope

This PR only encapsulates changes to the Cordova wrapper and iOS bridge. A future PR will include Android implementation.

Testing

Manual testing

Testing was done with the iOS beta release v. 5.3.0-beta-01. Another round of testing will be completed when out of pre-release.

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 Reviewable

- Token added as parameter to login
- updateUserJwt
- UserJwtInvalidatedEvent
- Add & Remove Listener methods
- new methods updateUserJwt and addUserJwtInvalidatedListener added to the bridge
- Make it clear that null must be passed to native layer
- Explicitly add that this class conforms to OSUserJwtInvalidatedListener protocol
@jennantilla jennantilla requested a review from nan-li December 19, 2024 19:44
Copy link
Contributor

@nan-li nan-li left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, let's change the base to another branch instead of main before merging

login(externalId: string): void {
window.cordova.exec(function () { }, function () { }, "OneSignalPush", "login", [externalId]);
login(externalId: string, jwtToken?: string): void {
// if no jwt token, pass null
Copy link
Contributor

@nan-li nan-li Dec 26, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

// if no jwt token, pass null

Is this comment accurate?

@nan-li nan-li self-requested a review December 26, 2024 03:07
bool first = addUserJwtInvalidatedListenerCallbackId == nil;
addUserJwtInvalidatedListenerCallbackId = command.callbackId;
if (first) {
[OneSignal addUserJwtInvalidatedListener:self];
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't see (void)onUserJwtInvalidatedWithEvent in this PR. Were you able to test the invalidated callback firing?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants