Confirmed deliveries fix for apps that upgrade

* Fixed confirm deliveries for those who have installed the app on an older SDK and upgrade to this one.
  - Fixed issue where we did not always save shared NSUserDefaults.
  - This also allows those who did not always have App Groups to get the values saved.
* Added test for adding missing shared keys
* NSUserDefaultsOverrider now supports suiteNames

Author: jkasten2

iOS_SDK/OneSignalSDK/Source/OneSignal.m

@@ -666,15 +666,19 @@ + (bool)initAppId:(NSString*)appId withSettings:(NSDictionary*)settings {
         initDone = false;
         let sharedUserDefaults = OneSignalUserDefaults.initShared;
 
-        // Save app_id to both standard and shared NSUserDefaults
         [standardUserDefaults saveStringForKey:NSUD_APP_ID withValue:app_id];
-        [sharedUserDefaults saveStringForKey:NSUD_APP_ID withValue:app_id];
 
         // Remove player_id from both standard and shared NSUserDefaults
         [standardUserDefaults removeValueForKey:USERID];
         [sharedUserDefaults removeValueForKey:USERID];
     }
 
+    // Always save app_id and player_id as it will not be present on shared if:
+    //   - Updating from an older SDK
+    //   - Updating to an app that didn't have App Groups setup before
+    [OneSignalUserDefaults.initShared saveStringForKey:NSUD_APP_ID withValue:app_id];
+    [OneSignalUserDefaults.initShared saveStringForKey:USERID withValue:self.currentSubscriptionState.userId];
+    
     // Invalid app ids reaching here will cause failure
     if (!app_id || ![[NSUUID alloc] initWithUUIDString:app_id]) {
        onesignal_Log(ONE_S_LL_FATAL, @"OneSignal AppId format is invalid.\nExample: 'b2f7f966-d8cc-11e4-bed1-df8f05be55ba'\n");

iOS_SDK/OneSignalSDK/UnitTests/Shadows/NSUserDefaultsOverrider.m

@@ -30,9 +30,19 @@
 
 static NSMutableDictionary* defaultsDictionary;
 
-@implementation NSUserDefaultsOverrider
+@implementation NSUserDefaultsOverrider {
+   NSString *suiteName;
+}
+
 + (void)load {
-    defaultsDictionary = [[NSMutableDictionary alloc] init];
+    defaultsDictionary = [NSMutableDictionary new];
+    
+    // Adding helpers to NSUserDefaults to be used internally
+    injectToProperClass(@selector(getObjectForKey:), @selector(getObjectForKey:), @[], [NSUserDefaultsOverrider class], [NSUserDefaults class]);
+    injectToProperClass(@selector(setObjectForKey:withValue:), @selector(setObjectForKey:withValue:), @[], [NSUserDefaultsOverrider class], [NSUserDefaults class]);
+    
+    // initWithSuiteName overrider
+    injectToProperClass(@selector(overrideInitWithSuiteName:), @selector(initWithSuiteName:), @[], [NSUserDefaultsOverrider class], [NSUserDefaults class]);
 
     // Sets
     injectToProperClass(@selector(overrideSetObject:forKey:), @selector(setObject:forKey:), @[], [NSUserDefaultsOverrider class], [NSUserDefaults class]);
@@ -50,59 +60,83 @@ + (void)load {
 }
 
 + (void)clearInternalDictionary {
-    defaultsDictionary = [[NSMutableDictionary alloc] init];
+    defaultsDictionary = [NSMutableDictionary new];
+}
+
+- (nullable instancetype)overrideInitWithSuiteName:(nullable NSString *)suitename {
+    suiteName = suitename;
+    return [self overrideInitWithSuiteName:suitename];
+}
+
+- (void)setObjectForKey:(NSString*)key withValue:(id)value {
+    if (!suiteName)
+        suiteName = @"default";
+    
+    if (!defaultsDictionary[suiteName])
+        defaultsDictionary[suiteName] = [NSMutableDictionary new];
+    
+    defaultsDictionary[suiteName][key] = value;
 }
 
 // Sets
 -(void)overrideSetObject:(id)value forKey:(NSString*)key {
-    defaultsDictionary[key] = value;
+    [self setObjectForKey:key withValue:value];
 }
 
 -(void)overrideSetString:(NSString*)value forKey:(NSString*)key {
-    defaultsDictionary[key] = value;
+   [self setObjectForKey:key withValue:value];
 }
 
 - (void)overrideSetDouble:(double)value forKey:(NSString*)key {
-    defaultsDictionary[key] = [NSNumber numberWithDouble:value];
+    [self setObjectForKey:key withValue:[NSNumber numberWithDouble:value]];
 }
 
 - (void)overrideSetBool:(BOOL)value forKey:(NSString*)key {
-    defaultsDictionary[key] = [NSNumber numberWithBool:value];
+    [self setObjectForKey:key withValue:[NSNumber numberWithBool:value]];
 }
 
 - (void)overrideSetInteger:(NSInteger)value forKey:(NSString*)key {
-    defaultsDictionary[key] = [NSNumber numberWithInteger:value];
+    [self setObjectForKey:key withValue:[NSNumber numberWithInteger:value]];
+}
+
+- (id)getObjectForKey:(NSString*)key {
+    if (!suiteName)
+        suiteName = @"default";
+    
+    if (!defaultsDictionary[suiteName])
+        defaultsDictionary[suiteName] = [NSMutableDictionary new];
+    
+    return defaultsDictionary[suiteName][key];
 }
 
 // Gets
 - (nullable id)overrideObjectForKey:(NSString*)key {
     if ([key isEqualToString:@"XCTIDEConnectionTimeout"])
         return [NSNumber numberWithInt:60];
 
-    return defaultsDictionary[key];
+    return [self getObjectForKey:key];
 }
 
 - (NSString*)overrideStringForKey:(NSString*)key {
-    return defaultsDictionary[key];
+    return [self getObjectForKey:key];
 }
 
 - (NSInteger)overrideIntegerForKey:(NSString*)key {
     if ([key isEqualToString:@"XCTIDEConnectionTimeout"])
         return 60.0;
 
-    return [defaultsDictionary[key] integerValue];
+    return [[self getObjectForKey:key] integerValue];
 }
 
 - (double)overrideDoubleForKey:(NSString*)key {
     if ([key isEqualToString:@"XCTIDEConnectionTimeout"])
         return 60.0;
 
-    return [defaultsDictionary[key] doubleValue];
+    return [[self getObjectForKey:key] doubleValue];
 }
 
 - (BOOL)overrideBoolForKey:(NSString*)key {
-    return [defaultsDictionary[key] boolValue];
+    return [[self getObjectForKey:key] boolValue];
 }
 
 @end
-

iOS_SDK/OneSignalSDK/UnitTests/UnitTests.m

@@ -45,6 +45,7 @@
 #import "OneSignalNotificationSettingsIOS10.h"
 #import "OSPermission.h"
 #import "OSNotificationPayload+Internal.h"
+#import "OneSignalUserDefaults.h"
 
 #import "TestHelperFunctions.h"
 #import "UnitTestAppDelegate.h"
@@ -1819,6 +1820,25 @@ - (void) testDidReceiveNotificationExtensionRequestDontOverrideCateogory {
     XCTAssertEqualObjects(content.attachments[0].URL.scheme, @"file");
 }
 
+
+- (void)testAddingSharedKeysIfMissing {
+    // 1. Init SDK as normal
+    [UnitTestCommonMethods initOneSignalAndThreadWait];
+    
+    // 2. Remove shared keys to simulate the state of coming from a pre-2.12.1 version
+    [OneSignalUserDefaults.initShared removeValueForKey:NSUD_APP_ID];
+    [OneSignalUserDefaults.initShared removeValueForKey:USERID];
+
+    // 3. Restart app
+    [UnitTestCommonMethods backgroundApp];
+    [UnitTestCommonMethods clearStateForAppRestart:self];
+    [UnitTestCommonMethods initOneSignalAndThreadWait];
+    
+    // 4. Ensure values are present again
+    XCTAssertNotNil([OneSignalUserDefaults.initShared getSavedSetForKey:NSUD_APP_ID defaultValue:nil]);
+    XCTAssertNotNil([OneSignalUserDefaults.initShared getSavedSetForKey:USERID defaultValue:nil]);
+}
+
 // iOS 10 - Notification Service Extension test - local file
 - (void) testDidReceiveNotificationExtensionRequestLocalFile {
     id userInfo = @{@"aps": @{