Skip to content

Commit 20d6bd3

Browse files
nan-licursoragent
andcommitted
feat: [PR8] demo app Identity Verification UI
Exercises the Identity Verification surface end to end: log in with a token, watch a token be rejected and supply a replacement through the invalidated listener, and see how the SDK behaves while the requirement is still unknown. Co-authored-by: Cursor <cursoragent@cursor.com>
1 parent 1bf0c81 commit 20d6bd3

8 files changed

Lines changed: 257 additions & 22 deletions

File tree

‎examples/demo/App.xcodeproj/project.pbxproj‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@
4242
5B959D44AB09CB821C00AFBF /* ContentView.swift in Sources */ = {isa = PBXBuildFile; fileRef = 35F726E64F9B6817F917227C /* ContentView.swift */; };
4343
5F4B7EC8437D1A8D80DF7674 /* NotificationService.swift in Sources */ = {isa = PBXBuildFile; fileRef = A20B46F63592FC67B655BEB8 /* NotificationService.swift */; };
4444
638B81D9DA5FD8636BB038B0 /* OneSignalUser.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = EF49509A218369322ECFA3B9 /* OneSignalUser.framework */; };
45+
673E0146B4B27EB81FCF50DA /* LoginUserDialog.swift in Sources */ = {isa = PBXBuildFile; fileRef = 3DD26AED9EA84B0308C1BFE8 /* LoginUserDialog.swift */; };
4546
674995A7A55C13341317E19B /* OSDialog.swift in Sources */ = {isa = PBXBuildFile; fileRef = D261D46C404E325CBA87A9E0 /* OSDialog.swift */; };
4647
68BC99D15FDCB26EB35EBB07 /* OneSignalLocation.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = FE9834773C437CC373607693 /* OneSignalLocation.framework */; };
4748
6E3E040FD8A750248E70E46F /* AppModels.swift in Sources */ = {isa = PBXBuildFile; fileRef = 7EA9D80191548D49F09D30B3 /* AppModels.swift */; };
@@ -324,6 +325,7 @@
324325
38138523A8A81A60A77800CA /* NotificationSender.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = NotificationSender.swift; sourceTree = "<group>"; };
325326
3A654457BF0A55B54220E669 /* RemoveMultiDialog.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = RemoveMultiDialog.swift; sourceTree = "<group>"; };
326327
3B81D7E1A7EB9BB4466C768F /* SendPushSection.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SendPushSection.swift; sourceTree = "<group>"; };
328+
3DD26AED9EA84B0308C1BFE8 /* LoginUserDialog.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = LoginUserDialog.swift; sourceTree = "<group>"; };
327329
3FD8258E807E6672642A32E6 /* UserFetchService.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = UserFetchService.swift; sourceTree = "<group>"; };
328330
4072202943CA64D2CBC38CB5 /* MultiPairInputDialog.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = MultiPairInputDialog.swift; sourceTree = "<group>"; };
329331
4078B5F096680AFA83D1CB85 /* OutcomesSection.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = OutcomesSection.swift; sourceTree = "<group>"; };
@@ -512,6 +514,7 @@
512514
2D959B1636916DAEE5FE6278 /* CustomNotificationDialog.swift */,
513515
5984B93007C6B85AFE09045A /* KeyValueRow.swift */,
514516
280B23B41935EAB89C8C6FCB /* ListWidgets.swift */,
517+
3DD26AED9EA84B0308C1BFE8 /* LoginUserDialog.swift */,
515518
4072202943CA64D2CBC38CB5 /* MultiPairInputDialog.swift */,
516519
D261D46C404E325CBA87A9E0 /* OSDialog.swift */,
517520
D54B9DAAEDBE67B73893C522 /* OutcomeDialog.swift */,
@@ -828,6 +831,7 @@
828831
7D2BA9022E77B00205453467 /* LiveActivityController.swift in Sources */,
829832
DBDA727D6317A3CCC73A1699 /* LiveActivitySection.swift in Sources */,
830833
B3AE701075398C6A369DBBE0 /* LocationSection.swift in Sources */,
834+
673E0146B4B27EB81FCF50DA /* LoginUserDialog.swift in Sources */,
831835
E3725231A3FD5F5A88BAA758 /* MultiPairInputDialog.swift in Sources */,
832836
4C18E3D284BB28BD846162F3 /* NotificationSender.swift in Sources */,
833837
674995A7A55C13341317E19B /* OSDialog.swift in Sources */,

‎examples/demo/App/Models/AppModels.swift‎

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,7 @@ enum AddItemType {
8080
case tag
8181
case trigger
8282
case externalUserId
83+
case updateUserJwt
8384

8485
var title: String {
8586
switch self {
@@ -89,12 +90,13 @@ enum AddItemType {
8990
case .tag: return "Add Tag"
9091
case .trigger: return "Add Trigger"
9192
case .externalUserId: return "Login User"
93+
case .updateUserJwt: return "Update User JWT"
9294
}
9395
}
9496

9597
var requiresKeyValue: Bool {
9698
switch self {
97-
case .alias, .tag, .trigger: return true
99+
case .alias, .tag, .trigger, .updateUserJwt: return true
98100
case .email, .sms, .externalUserId: return false
99101
}
100102
}
@@ -103,6 +105,7 @@ enum AddItemType {
103105
switch self {
104106
case .alias: return "Label"
105107
case .tag, .trigger: return "Key"
108+
case .updateUserJwt: return "External User Id"
106109
default: return "Key"
107110
}
108111
}
@@ -114,6 +117,7 @@ enum AddItemType {
114117
case .sms: return "Phone Number"
115118
case .tag, .trigger: return "Value"
116119
case .externalUserId: return "External User Id"
120+
case .updateUserJwt: return "JWT Token"
117121
}
118122
}
119123

@@ -141,6 +145,7 @@ enum AddItemType {
141145
case .tag: return "tag"
142146
case .trigger: return "trigger"
143147
case .externalUserId: return "login_user_id"
148+
case .updateUserJwt: return "update_jwt"
144149
}
145150
}
146151

@@ -152,6 +157,7 @@ enum AddItemType {
152157
case .alias: return "alias_label_input"
153158
case .tag: return "tag_key_input"
154159
case .trigger: return "trigger_key_input"
160+
case .updateUserJwt: return "update_jwt_external_id_input"
155161
default: return "\(accessibilityKey)_key_input"
156162
}
157163
}
@@ -165,6 +171,7 @@ enum AddItemType {
165171
case .alias: return "alias_id_input"
166172
case .tag: return "tag_value_input"
167173
case .trigger: return "trigger_value_input"
174+
case .updateUserJwt: return "update_jwt_token_input"
168175
default: return "\(accessibilityKey)_input"
169176
}
170177
}

‎examples/demo/App/Services/OneSignalService.swift‎

Lines changed: 33 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -96,16 +96,39 @@ final class OneSignalService {
9696

9797
// MARK: - User
9898

99-
func login(externalId: String) {
99+
func login(externalId: String, jwtToken: String? = nil) {
100100
prefs.setExternalUserId(externalId)
101-
OneSignal.login(externalId)
101+
// Persist for the demo REST fetch only; cold start does not call login/updateUserJwt with it.
102+
prefs.setSessionJwtToken(jwtToken)
103+
if let jwtToken = jwtToken {
104+
OneSignal.login(externalId: externalId, token: jwtToken)
105+
} else {
106+
OneSignal.login(externalId)
107+
}
108+
}
109+
110+
func updateUserJwt(externalId: String, token: String) {
111+
prefs.setSessionJwtToken(token)
112+
OneSignal.updateUserJwt(externalId: externalId, token: token)
102113
}
103114

104115
func logout() {
105116
prefs.setExternalUserId(nil)
117+
prefs.setSessionJwtToken(nil)
106118
OneSignal.logout()
107119
}
108120

121+
// MARK: - Identity Verification (demo REST fetch)
122+
123+
/// Demo toggle for addressing the REST user fetch by `external_id`. Persisted across launches.
124+
var useIdentityVerification: Bool {
125+
get { prefs.getUseIdentityVerification() }
126+
set { prefs.setUseIdentityVerification(newValue) }
127+
}
128+
129+
/// JWT from the last login / updateUserJwt. Used by the demo REST fetch only — not auto-fed to the SDK on cold start.
130+
var sessionJwtToken: String? { prefs.getSessionJwtToken() }
131+
109132
// MARK: - Aliases
110133

111134
func addAlias(label: String, id: String) { OneSignal.User.addAlias(label: label, id: id) }
@@ -222,6 +245,14 @@ final class OneSignalService {
222245
OneSignal.Notifications.addPermissionObserver(observer)
223246
}
224247

248+
func addUserJwtInvalidatedListener(_ listener: OSUserJwtInvalidatedListener) {
249+
OneSignal.addUserJwtInvalidatedListener(listener)
250+
}
251+
252+
func removeUserJwtInvalidatedListener(_ listener: OSUserJwtInvalidatedListener) {
253+
OneSignal.removeUserJwtInvalidatedListener(listener)
254+
}
255+
225256
func addNotificationClickListener(_ listener: OSNotificationClickListener) {
226257
OneSignal.Notifications.addClickListener(listener)
227258
}

‎examples/demo/App/Services/PreferencesService.swift‎

Lines changed: 25 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,9 @@
2828
import Foundation
2929

3030
/// `UserDefaults`-backed cache for state the demo restores across cold launches:
31-
/// consent flags, IAM paused, location shared, and the last-logged-in external
32-
/// user id. Mirrors the Capacitor demo's `PreferencesService` so the iOS demo
33-
/// re-feeds these into the SDK during initialization.
31+
/// consent flags, IAM paused, location shared, the last-logged-in external user id,
32+
/// the Identity Verification toggle, and the demo REST JWT. The JWT is only for the
33+
/// demo's `/users` fetch — it is not automatically passed to `login` / `updateUserJwt`.
3434
final class PreferencesService {
3535

3636
static let shared = PreferencesService()
@@ -47,6 +47,8 @@ final class PreferencesService {
4747
static let iamPaused = "onesignal.demo.iamPaused"
4848
static let locationShared = "onesignal.demo.locationShared"
4949
static let externalUserId = "onesignal.demo.externalUserId"
50+
static let useIdentityVerification = "onesignal.demo.useIdentityVerification"
51+
static let sessionJwtToken = "onesignal.demo.sessionJwtToken"
5052
}
5153

5254
// MARK: - Consent
@@ -83,4 +85,24 @@ final class PreferencesService {
8385
defaults.removeObject(forKey: Key.externalUserId)
8486
}
8587
}
88+
89+
// MARK: - Identity Verification (demo REST fetch)
90+
91+
func getUseIdentityVerification() -> Bool { defaults.bool(forKey: Key.useIdentityVerification) }
92+
func setUseIdentityVerification(_ value: Bool) { defaults.set(value, forKey: Key.useIdentityVerification) }
93+
94+
func getSessionJwtToken() -> String? {
95+
guard let value = defaults.string(forKey: Key.sessionJwtToken), !value.isEmpty else {
96+
return nil
97+
}
98+
return value
99+
}
100+
101+
func setSessionJwtToken(_ value: String?) {
102+
if let value = value, !value.isEmpty {
103+
defaults.set(value, forKey: Key.sessionJwtToken)
104+
} else {
105+
defaults.removeObject(forKey: Key.sessionJwtToken)
106+
}
107+
}
86108
}

‎examples/demo/App/Services/UserFetchService.swift‎

Lines changed: 23 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,17 +27,36 @@
2727

2828
import Foundation
2929

30-
/// Reads the OneSignal /users API to hydrate aliases / tags / channels in the demo
30+
/// Reads the OneSignal /users API to hydrate aliases / tags / channels in the demo.
3131
final class UserFetchService {
3232
static let shared = UserFetchService()
3333
private init() {}
3434

35-
func fetchUser(appId: String, onesignalId: String) async -> UserData? {
36-
let urlString = "https://api.onesignal.com/apps/\(appId)/users/by/onesignal_id/\(onesignalId)"
37-
guard let url = URL(string: urlString) else { return nil }
35+
/// Fetches by `onesignal_id` (unsigned) or `external_id` (Bearer when `jwt` is set).
36+
func fetchUser(
37+
appId: String,
38+
aliasLabel: String,
39+
aliasValue: String,
40+
jwt: String? = nil
41+
) async -> UserData? {
42+
guard !aliasValue.isEmpty else { return nil }
43+
44+
// Path-encode so external_ids with reserved characters don't misroute the GET.
45+
var allowed = CharacterSet.urlPathAllowed
46+
allowed.remove(charactersIn: "/")
47+
guard
48+
let encodedAlias = aliasValue.addingPercentEncoding(withAllowedCharacters: allowed),
49+
let url = URL(string: "https://api.onesignal.com/apps/\(appId)/users/by/\(aliasLabel)/\(encodedAlias)")
50+
else {
51+
return nil
52+
}
3853

3954
var request = URLRequest(url: url)
4055
request.httpMethod = "GET"
56+
request.setValue("application/json", forHTTPHeaderField: "Accept")
57+
if let jwt = jwt {
58+
request.setValue("Bearer \(jwt)", forHTTPHeaderField: "Authorization")
59+
}
4160

4261
do {
4362
let (data, response) = try await URLSession.shared.data(for: request)

‎examples/demo/App/ViewModels/OneSignalViewModel.swift‎

Lines changed: 61 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,7 @@ final class OneSignalViewModel: ObservableObject {
4343

4444
@Published var externalUserId: String?
4545
@Published var aliases: [KeyValueItem] = []
46+
@Published var useIdentityVerification: Bool = false
4647

4748
// MARK: - Push
4849

@@ -99,14 +100,20 @@ final class OneSignalViewModel: ObservableObject {
99100
self.appId = service.appId
100101
self.consentRequired = service.consentRequired
101102
self.consentGiven = service.consentGiven
103+
self.useIdentityVerification = service.useIdentityVerification
102104
self.externalUserId = service.externalId ?? prefs.getExternalUserId()
103105
self.hasNotificationPermission = service.hasNotificationPermission
104106
refreshState()
105107
setupObservers()
106108

107109
TooltipService.shared.loadIfNeeded()
108110

109-
if service.onesignalId != nil {
111+
// Demo REST hydrate only — does not call login / updateUserJwt with a cached JWT.
112+
if useIdentityVerification {
113+
if externalUserId != nil || service.externalId != nil {
114+
Task { await fetchUserDataFromApi() }
115+
}
116+
} else if service.onesignalId != nil {
110117
Task { await fetchUserDataFromApi() }
111118
}
112119
}
@@ -119,19 +126,43 @@ final class OneSignalViewModel: ObservableObject {
119126
isInAppMessagesPaused = service.isInAppMessagesPaused
120127
isLocationShared = service.isLocationShared
121128
hasNotificationPermission = service.hasNotificationPermission
122-
externalUserId = service.externalId
129+
externalUserId = service.externalId ?? prefs.getExternalUserId()
123130

124131
let sdkTags = service.getTags()
125132
tags = sdkTags.map { KeyValueItem(key: $0.key, value: $0.value) }
126133
}
127134

128135
func fetchUserDataFromApi() async {
129-
guard let onesignalId = service.onesignalId else { return }
136+
let aliasLabel: String
137+
let aliasValue: String
138+
let jwt: String?
139+
140+
if useIdentityVerification {
141+
guard let externalId = externalUserId ?? service.externalId, !externalId.isEmpty else {
142+
return
143+
}
144+
aliasLabel = "external_id"
145+
aliasValue = externalId
146+
jwt = service.sessionJwtToken
147+
} else {
148+
guard let onesignalId = service.onesignalId, !onesignalId.isEmpty else {
149+
return
150+
}
151+
aliasLabel = "onesignal_id"
152+
aliasValue = onesignalId
153+
jwt = nil
154+
}
155+
130156
requestSequence &+= 1
131157
let captured = requestSequence
132158
isLoading = true
133159

134-
let userData = await UserFetchService.shared.fetchUser(appId: appId, onesignalId: onesignalId)
160+
let userData = await UserFetchService.shared.fetchUser(
161+
appId: appId,
162+
aliasLabel: aliasLabel,
163+
aliasValue: aliasValue,
164+
jwt: jwt
165+
)
135166

136167
// Drop the result if a newer fetch has started while this one was in flight.
137168
guard captured == requestSequence else { return }
@@ -166,21 +197,35 @@ final class OneSignalViewModel: ObservableObject {
166197

167198
// MARK: - User
168199

169-
func login(externalId: String) {
200+
func login(externalId: String, jwtToken: String? = nil) {
170201
let trimmed = externalId.trimmingCharacters(in: .whitespacesAndNewlines)
171202
guard !trimmed.isEmpty else { return }
172203
isLoading = true
173-
service.login(externalId: trimmed)
204+
service.login(externalId: trimmed, jwtToken: jwtToken)
174205
externalUserId = trimmed
175206
clearUserData()
176207
}
177208

209+
func updateUserJwt(externalId: String, token: String) {
210+
let trimmedId = externalId.trimmingCharacters(in: .whitespacesAndNewlines)
211+
let trimmedToken = token.trimmingCharacters(in: .whitespacesAndNewlines)
212+
guard !trimmedId.isEmpty, !trimmedToken.isEmpty else { return }
213+
service.updateUserJwt(externalId: trimmedId, token: trimmedToken)
214+
print("[OneSignal] Updated JWT for: \(trimmedId)")
215+
}
216+
178217
func logout() {
179218
service.logout()
180219
externalUserId = nil
181220
clearUserData()
182221
}
183222

223+
func setUseIdentityVerification(_ enabled: Bool) {
224+
useIdentityVerification = enabled
225+
service.useIdentityVerification = enabled
226+
print("[OneSignal] Identity verification \(enabled ? "enabled" : "disabled")")
227+
}
228+
184229
private func clearUserData() {
185230
aliases.removeAll()
186231
emails.removeAll()
@@ -445,12 +490,17 @@ final class OneSignalViewModel: ObservableObject {
445490
service.addPushSubscriptionObserver(observers)
446491
service.addUserObserver(observers)
447492
service.addPermissionObserver(observers)
493+
service.addUserJwtInvalidatedListener(observers)
448494
}
449495
}
450496

451497
// MARK: - Observer Bridge
452498

453-
private final class Observers: NSObject, OSPushSubscriptionObserver, OSUserStateObserver, OSNotificationPermissionObserver {
499+
private final class Observers: NSObject,
500+
OSPushSubscriptionObserver,
501+
OSUserStateObserver,
502+
OSNotificationPermissionObserver,
503+
OSUserJwtInvalidatedListener {
454504
weak var viewModel: OneSignalViewModel?
455505

456506
func onPushSubscriptionDidChange(state: OSPushSubscriptionChangedState) {
@@ -472,4 +522,8 @@ private final class Observers: NSObject, OSPushSubscriptionObserver, OSUserState
472522
viewModel?.isPushEnabled = OneSignal.User.pushSubscription.optedIn
473523
}
474524
}
525+
526+
func onUserJwtInvalidated(event: OSUserJwtInvalidatedEvent) {
527+
print("[OneSignal] JWT invalidated for externalId: \(event.externalId)")
528+
}
475529
}

0 commit comments

Comments
 (0)