Merge pull request #1478 from OneSignal/identity_verification_callback

Fire jwt invalidated callback when receiving 401 errors

Author: nan-li

iOS_SDK/OneSignalDevApp/OneSignalDevApp/AppDelegate.h

@@ -31,7 +31,7 @@
 #import <UIKit/UIKit.h>
 #import <OneSignalFramework/OneSignalFramework.h>
 
-@interface AppDelegate : UIResponder <UIApplicationDelegate, OSNotificationPermissionObserver, OSInAppMessageLifecycleListener, OSPushSubscriptionObserver, OSNotificationLifecycleListener, OSInAppMessageClickListener, OSNotificationClickListener, OSUserStateObserver>
+@interface AppDelegate : UIResponder <UIApplicationDelegate, OSNotificationPermissionObserver, OSInAppMessageLifecycleListener, OSPushSubscriptionObserver, OSNotificationLifecycleListener, OSInAppMessageClickListener, OSNotificationClickListener, OSUserStateObserver, OSUserJwtInvalidatedListener>
 
 @property (strong, nonatomic) UIWindow *window;
 

iOS_SDK/OneSignalDevApp/OneSignalDevApp/AppDelegate.m

@@ -46,6 +46,10 @@ @implementation AppDelegate
 
 OneSignalNotificationCenterDelegate *_notificationDelegate;
 
+// ECM Should we ship these typedefs in OneSignalFramework.h to make them available to Objective C customers?
+typedef void (^JwtCompletionBlock)(NSString*);
+typedef void (^JwtExpiredBlock)(NSString *, JwtCompletionBlock);
+
 - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
 
 //    [FIRApp configure];
@@ -72,6 +76,7 @@ - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(
     [OneSignal.User addObserver:self];
     [OneSignal.Notifications addPermissionObserver:self];
     [OneSignal.InAppMessages addClickListener:self];
+    [OneSignal addUserJwtInvalidatedListener:self];
 
     NSLog(@"UNUserNotificationCenter.delegate: %@", UNUserNotificationCenter.currentNotificationCenter.delegate);
 
@@ -86,8 +91,8 @@ - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(
     return YES;
 }
 
-#define ONESIGNAL_APP_ID_DEFAULT @"STAGING_APP_HERE"
-#define ONESIGNAL_APP_ID_KEY_FOR_TESTING @"YOUR_APP_ID_HERE"
+#define ONESIGNAL_APP_ID_DEFAULT @"77e32082-ea27-42e3-a898-c72e141824ef"
+#define ONESIGNAL_APP_ID_KEY_FOR_TESTING @"77e32082-ea27-42e3-a898-c72e141824ef"
 
 + (NSString*)getOneSignalAppId {
     NSString* userDefinedAppId = [[NSUserDefaults standardUserDefaults] objectForKey:ONESIGNAL_APP_ID_KEY_FOR_TESTING];
@@ -121,6 +126,10 @@ - (void)onUserStateDidChangeWithState:(OSUserChangedState * _Nonnull)state {
     NSLog(@"Dev App onUserStateDidChangeWithState: %@", [state jsonRepresentation]);
 }
 
+- (void)onUserJwtInvalidatedWithEvent:(OSUserJwtInvalidatedEvent * _Nonnull)event {
+    NSLog(@"Dev App onUserJwtInvalidatedWithEvent: %@", [event jsonRepresentation]);
+}
+
 #pragma mark OSInAppMessageDelegate
 
 - (void)onClickInAppMessage:(OSInAppMessageClickEvent * _Nonnull)event {

iOS_SDK/OneSignalDevApp/OneSignalDevApp/SwiftTest.swift

@@ -28,10 +28,19 @@
 import Foundation
 import OneSignalFramework
 
-class SwiftTest: NSObject {
+class SwiftTest: NSObject, OSUserJwtInvalidatedListener {
+    func onUserJwtInvalidated(event: OSUserJwtInvalidatedEvent) {
+        print("event: \(event.jsonRepresentation())")
+        print("externalId: \(event.externalId)")
+    }
+
     func testSwiftUserModel() {
         let token1 = OneSignal.User.pushSubscription.token
         let token = OneSignal.User.pushSubscription.token
         OneSignal.Debug._dump()
+        OneSignal.login(externalId: "euid", token: "token")
+        OneSignal.updateUserJwt(externalId: "euid", token: "token")
+        OneSignal.addUserJwtInvalidatedListener(self)
+        OneSignal.removeUserJwtInvalidatedListener(self)
     }
 }

iOS_SDK/OneSignalDevApp/OneSignalDevApp/ViewController.m

@@ -197,14 +197,14 @@ - (IBAction)inAppMessagingSegmentedControlValueChanged:(UISegmentedControl *)sen
 - (IBAction)loginExternalUserId:(UIButton *)sender {
     NSString* externalUserId = self.externalUserIdTextField.text;
     NSString* token = self.tokenTextField.text;
-    NSLog(@"❌ Dev App: Logging in to external user ID %@ and token %@", externalUserId, token);
+    NSLog(@"Dev App: Logging in to external user ID %@ and token %@", externalUserId, token);
     [OneSignal login:externalUserId withToken:token];
 }
 
 - (IBAction)updateJwt:(id)sender {
     NSString* externalUserId = self.externalUserIdTextField.text;
     NSString* token = self.tokenTextField.text;
-    NSLog(@"❌ Dev App: updating JWT for external user ID %@ and token %@", externalUserId, token);
+    NSLog(@"Dev App: updating JWT for external user ID %@ and token %@", externalUserId, token);
     [OneSignal updateUserJwt:externalUserId withToken:token];
 }
 

iOS_SDK/OneSignalDevApp/OneSignalExample.xcodeproj/project.pbxproj

@@ -33,8 +33,8 @@
 // Networking
 #define OS_API_VERSION @"1"
 #define OS_API_ACCEPT_HEADER @"application/vnd.onesignal.v" OS_API_VERSION @"+json"
-#define OS_API_SERVER_URL @"https://api.staging.onesignal.com/"
-#define OS_IAM_WEBVIEW_BASE_URL @"https://staging.onesignal.com/"
+#define OS_API_SERVER_URL @"https://api.onesignal.com/"
+#define OS_IAM_WEBVIEW_BASE_URL @"https://onesignal.com/"
 
 // OneSignalUserDefault keys
 // String values start with "OSUD_" to maintain a level of uniqueness from other libs and app code
@@ -79,7 +79,6 @@
 #define OSUD_REQUIRES_USER_PRIVACY_CONSENT                                  @"OSUD_REQUIRES_USER_PRIVACY_CONSENT"
 
 /* Identity Verification */
-// TODO: JWT 🔐 Figure out the key below and may need to relate to existing key IOS_REQUIRES_USER_ID_AUTHENTICATION
 #define OSUD_USE_IDENTITY_VERIFICATION                                      @"OSUD_USE_IDENTITY_VERIFICATION"
 #define OS_JWT_BEARER_TOKEN                                                 @"OS_JWT_BEARER_TOKEN"
 #define OS_JWT_TOKEN_INVALID                                                @"OS_JWT_TOKEN_INVALID"
@@ -135,7 +134,7 @@
 #define IOS_USES_PROVISIONAL_AUTHORIZATION @"uses_provisional_auth"
 #define IOS_REQUIRES_EMAIL_AUTHENTICATION @"require_email_auth"
 #define IOS_REQUIRES_SMS_AUTHENTICATION @"require_sms_auth"
-#define IOS_REQUIRES_USER_ID_AUTHENTICATION @"require_user_id_auth" // TODO: JWT 🔐 Figure out the key, also think about needing to migrate this value
+#define IOS_JWT_REQUIRED @"jwt_required" // Returned by remote params
 #define IOS_RECEIVE_RECEIPTS_ENABLE @"receive_receipts_enable"
 #define IOS_OUTCOMES_V2_SERVICE_ENABLE @"v2_enabled"
 #define IOS_LOCATION_SHARED @"location_shared"
@@ -347,23 +346,28 @@ typedef enum {GET, POST, HEAD, PUT, DELETE, OPTIONS, CONNECT, TRACE, PATCH} HTTP
 #define OS_USER_EXECUTOR                                                    @"OS_USER_EXECUTOR"
 #define OS_USER_EXECUTOR_USER_REQUEST_QUEUE_KEY                             @"OS_USER_EXECUTOR_USER_REQUEST_QUEUE_KEY"
 #define OS_USER_EXECUTOR_TRANSFER_SUBSCRIPTION_REQUEST_QUEUE_KEY            @"OS_USER_EXECUTOR_TRANSFER_SUBSCRIPTION_REQUEST_QUEUE_KEY"
+#define OS_USER_EXECUTOR_PENDING_QUEUE_KEY                                  @"OS_USER_EXECUTOR_PENDING_QUEUE_KEY"
 
 // Identity Executor
 #define OS_IDENTITY_EXECUTOR                                                @"OS_IDENTITY_EXECUTOR"
 #define OS_IDENTITY_EXECUTOR_DELTA_QUEUE_KEY                                @"OS_IDENTITY_EXECUTOR_DELTA_QUEUE_KEY"
 #define OS_IDENTITY_EXECUTOR_ADD_REQUEST_QUEUE_KEY                          @"OS_IDENTITY_EXECUTOR_ADD_REQUEST_QUEUE_KEY"
 #define OS_IDENTITY_EXECUTOR_REMOVE_REQUEST_QUEUE_KEY                       @"OS_IDENTITY_EXECUTOR_REMOVE_REQUEST_QUEUE_KEY"
+#define OS_IDENTITY_EXECUTOR_PENDING_QUEUE_KEY                              @"OS_IDENTITY_EXECUTOR_PENDING_QUEUE_KEY"
 
 // Property Executor
 #define OS_PROPERTIES_EXECUTOR                                              @"OS_PROPERTIES_EXECUTOR"
 #define OS_PROPERTIES_EXECUTOR_DELTA_QUEUE_KEY                              @"OS_PROPERTIES_EXECUTOR_DELTA_QUEUE_KEY"
 #define OS_PROPERTIES_EXECUTOR_UPDATE_REQUEST_QUEUE_KEY                     @"OS_PROPERTIES_EXECUTOR_UPDATE_REQUEST_QUEUE_KEY"
+#define OS_PROPERTIES_EXECUTOR_PENDING_QUEUE_KEY                            @"OS_PROPERTIES_EXECUTOR_PENDING_QUEUE_KEY"
 
 // Subscription Executor
+#define OS_SUBSCRIPTION_EXECUTOR                                            @"OS_SUBSCRIPTION_EXECUTOR"
 #define OS_SUBSCRIPTION_EXECUTOR_DELTA_QUEUE_KEY                            @"OS_SUBSCRIPTION_EXECUTOR_DELTA_QUEUE_KEY"
 #define OS_SUBSCRIPTION_EXECUTOR_ADD_REQUEST_QUEUE_KEY                      @"OS_SUBSCRIPTION_EXECUTOR_ADD_REQUEST_QUEUE_KEY"
 #define OS_SUBSCRIPTION_EXECUTOR_REMOVE_REQUEST_QUEUE_KEY                   @"OS_SUBSCRIPTION_EXECUTOR_REMOVE_REQUEST_QUEUE_KEY"
 #define OS_SUBSCRIPTION_EXECUTOR_UPDATE_REQUEST_QUEUE_KEY                   @"OS_SUBSCRIPTION_EXECUTOR_UPDATE_REQUEST_QUEUE_KEY"
+#define OS_SUBSCRIPTION_EXECUTOR_PENDING_QUEUE_KEY                          @"OS_SUBSCRIPTION_EXECUTOR_PENDING_QUEUE_KEY"
 
 // Live Activies Executor
 #define OS_LIVE_ACTIVITIES_EXECUTOR_UPDATE_TOKENS_KEY                       @"OS_LIVE_ACTIVITIES_EXECUTOR_UPDATE_TOKENS_KEY"

iOS_SDK/OneSignalSDK/OneSignal.xcodeproj/project.pbxproj

@@ -87,7 +87,7 @@ + (OSUIApplicationReleaseMode) releaseMode {
     NSDictionary *entitlements = nil;
     NSDictionary *provision = [self getProvision];
     if (provision) {
-        // [OneSignalLog onesignalLog:ONE_S_LL_DEBUG message:[NSString stringWithFormat:@"provision: %@", provision]];
+        [OneSignalLog onesignalLog:ONE_S_LL_DEBUG message:[NSString stringWithFormat:@"provision: %@", provision]];
         entitlements = [provision objectForKey:@"Entitlements"];
     }
     else

iOS_SDK/OneSignalSDK/OneSignalCore/Source/OneSignalCommonDefines.h

@@ -250,7 +250,10 @@ - (void)initializeTriggerController {
 
 - (void)updateInAppMessagesFromCache {
     self.messages = [OneSignalUserDefaults.initStandard getSavedCodeableDataForKey:OS_IAM_MESSAGES_ARRAY defaultValue:[NSArray new]];
-    [self evaluateMessages];
+    // ECM THIS NEEDS TO RUN ON THE MAIN THREAD
+    dispatch_async(dispatch_get_main_queue(), ^{
+        [self evaluateMessages];
+    });
 }
 
 /**
@@ -323,11 +326,16 @@ - (void)getInAppMessagesFromServer {
         OSResponseStatusType responseType = [OSNetworkingUtils getResponseStatusType:error.code];
         if (responseType == OSResponseStatusUnauthorized) {
             shouldRetryGetInAppMessagesOnJwtUpdated = true;
+            [self handleUnauthroizedError:error externalId:alias.id];
         }
         [self updateInAppMessagesFromCache];
     }];
 }
 
+- (void)handleUnauthroizedError:(NSError*)error externalId:(NSString *)externalId {
+    [OneSignalUserManagerImpl.sharedInstance invalidateJwtForExternalIdWithExternalId:externalId error:error];
+}
+
 - (void)updateInAppMessagesFromServer:(NSArray<OSInAppMessageInternal *> *)newMessages {
     [OneSignalLog onesignalLog:ONE_S_LL_VERBOSE message:@"updateInAppMessagesFromServer"];
     self.messages = newMessages;
@@ -1146,7 +1154,6 @@ - (void)onPushSubscriptionDidChangeWithState:(OSPushSubscriptionChangedState * _
 
 #pragma mark OSUserStateObserver Methods
 - (void)onUserStateDidChangeWithState:(OSUserChangedState * _Nonnull)state {
-    NSLog(@"❌ OSMessagingController onUserStateDidChangeWithState: %@", [state jsonRepresentation]);
     if (state.current.onesignalId && shouldRetryGetInAppMessagesOnUserChange) {
         shouldRetryGetInAppMessagesOnUserChange = false;
         [self getInAppMessagesFromServer];
@@ -1159,7 +1166,6 @@ - (void)onRequiresUserAuthChangedFrom:(enum OSRequiresUserAuth)from to:(enum OSR
 }
 
 - (void)onJwtUpdatedWithExternalId:(NSString *)externalId token:(NSString *)token {
-    NSLog(@"❌ OSMessagingController onJwtUpdatedWithExternalId: %@ token: %@", externalId, token);
     if (![token  isEqual: OS_JWT_TOKEN_INVALID] && shouldRetryGetInAppMessagesOnJwtUpdated) {
         shouldRetryGetInAppMessagesOnJwtUpdated = false;
         [self getInAppMessagesFromServer];

iOS_SDK/OneSignalSDK/OneSignalCore/Source/OneSignalMobileProvision.m

@@ -64,8 +64,7 @@ public class OSUserJwtConfig {
                 return
             }
 
-            print("❌ OSUserJwtConfig.requiresUserAuth: changing from \(oldValue) to \(requiresUserAuth), firing \(changeNotifier)")
-
+            OneSignalLog.onesignalLog(.LL_VERBOSE, message: "OSUserJwtConfig.requiresUserAuth: changing from \(oldValue) to \(requiresUserAuth), firing listeners")
             // Persist new value
             OneSignalUserDefaults.initShared().saveInteger(forKey: OSUD_USE_IDENTITY_VERIFICATION, withValue: requiresUserAuth.rawValue)
 
@@ -93,9 +92,6 @@ public class OSUserJwtConfig {
 
     public init() {
         let rawValue = OneSignalUserDefaults.initShared().getSavedInteger(forKey: OSUD_USE_IDENTITY_VERIFICATION, defaultValue: OSRequiresUserAuth.unknown.rawValue)
-
-        print("❌ OSUserJwtConfig init(): \(String(describing: OSRequiresUserAuth(rawValue: rawValue))))")
-
         requiresUserAuth = OSRequiresUserAuth(rawValue: rawValue) ?? OSRequiresUserAuth.unknown
     }
 
@@ -104,7 +100,7 @@ public class OSUserJwtConfig {
     }
 
     public func onJwtTokenChanged(externalId: String, token: String?) {
-        print("❌ OSUserJwtConfig.onJwtTokenChanged \(externalId): \(token)")
+        OneSignalLog.onesignalLog(.LL_VERBOSE, message: "OSUserJwtConfig.onJwtTokenChanged for \(externalId) with token \(token ?? "nil"), firing listeners")
         changeNotifier.fire { listener in
             listener.onJwtUpdated(externalId: externalId, token: token)
         }