Merge pull request #896 from OneSignal/fix/2.x.x-NSUserDefaults-crash-fix

2.X.X NSUserDefaults crash fix

Author: emawby

iOS_SDK/OneSignalSDK/Source/OSMessagingController.m

@@ -200,7 +200,7 @@ - (void)deleteOldRedisplayedInAppMessages {
             [newRedisplayDictionary removeObjectForKey:messageId];
         }
 
-        [OneSignalUserDefaults.initStandard saveDictionaryForKey:OS_IAM_REDISPLAY_DICTIONARY withValue:newRedisplayDictionary];
+        [OneSignalUserDefaults.initStandard saveCodeableDataForKey:OS_IAM_REDISPLAY_DICTIONARY withValue:newRedisplayDictionary];
     }
 }
 

iOS_SDK/OneSignalSDK/Source/OSMigrationController.m

@@ -34,6 +34,7 @@ of this software and associated documentation files (the "Software"), to deal
 #import "OneSignal.h"
 #import "OneSignalUserDefaults.h"
 #import "OneSignalCommonDefines.h"
+#import "OSInAppMessagingDefines.h"
 #import "OneSignalHelper.h"
 
 @interface OneSignal ()
@@ -45,6 +46,7 @@ @implementation OSMigrationController
 
 - (void)migrate {
     [self migrateToVersion_02_14_00_AndGreater];
+    [self migrateIAMRedisplayCache];
     [self saveCurrentSDKVersion];
 }
 
@@ -78,6 +80,36 @@ - (void)migrateToVersion_02_14_00_AndGreater {
     }
 }
 
+// Devices could potentially have bad data in the OS_IAM_REDISPLAY_DICTIONARY
+// that was saved as a dictionary and not CodeableData. Try to detect if that is the case
+// and save it is as CodeableData instead.
+- (void)migrateIAMRedisplayCache {
+    let iamRedisplayCacheFixVersion = 21604;
+    long sdkVersion = [OneSignalUserDefaults.initShared getSavedIntegerForKey:OSUD_CACHED_SDK_VERSION defaultValue:0];
+    if (sdkVersion >= iamRedisplayCacheFixVersion)
+        return;
+    
+    @try {
+        __unused NSMutableDictionary *redisplayDict =[[NSMutableDictionary alloc] initWithDictionary:[OneSignalUserDefaults.initStandard
+                                                        getSavedCodeableDataForKey:OS_IAM_REDISPLAY_DICTIONARY
+                                                        defaultValue:[NSMutableDictionary new]]];
+    } @catch (NSException *exception) {
+        @try {
+            // The redisplay IAMs might have been saved as a dictionary.
+            // Try to read them as a dictionary and then save them as a codeable.
+            NSMutableDictionary *redisplayDict = [[NSMutableDictionary alloc] initWithDictionary:[OneSignalUserDefaults.initStandard
+                                                                    getSavedDictionaryForKey:OS_IAM_REDISPLAY_DICTIONARY
+                                                                    defaultValue:[NSMutableDictionary new]]];
+            [OneSignalUserDefaults.initStandard saveCodeableDataForKey:OS_IAM_REDISPLAY_DICTIONARY
+                                                                    withValue:redisplayDict];
+        } @catch (NSException *exception) {
+            //Clear the cached redisplay dictionary of bad data
+            [OneSignalUserDefaults.initStandard saveCodeableDataForKey:OS_IAM_REDISPLAY_DICTIONARY
+                                                                    withValue:nil];
+        }
+    }
+}
+
 - (void)saveCurrentSDKVersion {
     let currentVersion = [[OneSignal sdk_version_raw] intValue];
     [OneSignalUserDefaults.initShared saveIntegerForKey:OSUD_CACHED_SDK_VERSION withValue:currentVersion];

iOS_SDK/OneSignalSDK/UnitTests/InAppMessagingIntegrationTests.m

@@ -522,7 +522,7 @@ - (void)testIAMWithNoTriggersDisplayOnePerSession_Redisplay {
 
     message.displayStats.lastDisplayTime = firstInterval - delay;
     // Save IAM for redisplay
-    [OneSignalUserDefaults.initStandard saveDictionaryForKey:OS_IAM_REDISPLAY_DICTIONARY withValue:redisplayedInAppMessages];
+    [OneSignalUserDefaults.initStandard saveCodeableDataForKey:OS_IAM_REDISPLAY_DICTIONARY withValue:redisplayedInAppMessages];
     // Set data for redisplay
     [OSMessagingControllerOverrider setMessagesForRedisplay:redisplayedInAppMessages];
     // Save IAM for dismiss
@@ -658,11 +658,11 @@ - (void)testIAMRemoveFromCache_Redisplay {
     [redisplayedInAppMessages setObject:message2 forKey:message2.messageId];
 
     [OSMessagingControllerOverrider setMessagesForRedisplay:redisplayedInAppMessages];
-    [standardUserDefaults saveDictionaryForKey:OS_IAM_REDISPLAY_DICTIONARY withValue:redisplayedInAppMessages];
-    
+    [standardUserDefaults saveCodeableDataForKey:OS_IAM_REDISPLAY_DICTIONARY withValue:redisplayedInAppMessages];
+
     [self initOneSignalWithInAppMessage:message];
-    
-    let redisplayMessagesCache = [standardUserDefaults getSavedDictionaryForKey:OS_IAM_REDISPLAY_DICTIONARY defaultValue:nil];
+
+    NSMutableDictionary *redisplayMessagesCache = [standardUserDefaults getSavedCodeableDataForKey:OS_IAM_REDISPLAY_DICTIONARY defaultValue:nil];
     XCTAssertTrue([redisplayMessagesCache objectForKey:message1.messageId]);
     XCTAssertFalse([redisplayMessagesCache objectForKey:message2.messageId]);
 }

iOS_SDK/OneSignalSDK/UnitTests/MigrationTests.m

@@ -37,6 +37,10 @@
 #import "UnitTestCommonMethods.h"
 #import "OneSignalUserDefaults.h"
 #import "OneSignalCommonDefines.h"
+#import "OSInAppMessagingDefines.h"
+#import "OneSignalUserDefaults.h"
+#import "OSInAppMessage.h"
+#import "OSInAppMessagingHelpers.h"
 #import "CommonAsserts.h"
 
 @interface MigrationTests : XCTestCase
@@ -237,4 +241,55 @@ - (void)testCachedUniqueOutcomeToCachedUniqueOutcomeMigration {
     XCTAssertEqual([[OneSignal sdk_version_raw] intValue], sdkVersionAfterMigration);
 }
 
+- (void)testIAMCachedEmptyDictionaryToCachedCodeableMigration {
+    NSDictionary<NSString *, OSInAppMessage *>*emptyDict = [NSMutableDictionary new];
+    [OneSignalUserDefaults.initStandard saveDictionaryForKey:OS_IAM_REDISPLAY_DICTIONARY withValue:emptyDict];
+    
+    [migrationController migrate];
+}
+
+- (void)testIAMCachedDictionaryToCachedCodeableMigration {
+    NSMutableDictionary <NSString *, OSInAppMessage *> *emptyDict = [NSMutableDictionary new];
+    
+    [OneSignalUserDefaults.initStandard saveDictionaryForKey:OS_IAM_REDISPLAY_DICTIONARY withValue:emptyDict];
+    
+    [migrationController migrate];
+    
+    NSDictionary<NSString *, OSInAppMessage *>*retrievedDict = [OneSignalUserDefaults.initStandard
+                                                                getSavedCodeableDataForKey:OS_IAM_REDISPLAY_DICTIONARY defaultValue:nil];
+    XCTAssertEqualObjects(emptyDict, retrievedDict);
+}
+
+- (void)testIAMCachedCodeableMigration {
+    let limit = 5;
+    let delay = 60;
+    let message = [OSInAppMessageTestHelper testMessageWithRedisplayLimit:limit delay:@(delay)];
+    message.isDisplayedInSession = true;
+    NSMutableDictionary <NSString *, OSInAppMessage *> *redisplayedInAppMessages = [NSMutableDictionary new];
+    [redisplayedInAppMessages setObject:message forKey:message.messageId];
+    
+    [OneSignalUserDefaults.initStandard saveCodeableDataForKey:OS_IAM_REDISPLAY_DICTIONARY withValue:redisplayedInAppMessages];
+    
+    [migrationController migrate];
+    
+    NSDictionary<NSString *, OSInAppMessage *>*retrievedDict = [OneSignalUserDefaults.initStandard
+                                                                getSavedCodeableDataForKey:OS_IAM_REDISPLAY_DICTIONARY defaultValue:nil];
+    XCTAssertEqualObjects(redisplayedInAppMessages, retrievedDict);
+}
+
+- (void)testIAMNilCacheToNilMigration {
+    
+    [OneSignalUserDefaults.initStandard saveDictionaryForKey:OS_IAM_REDISPLAY_DICTIONARY withValue:nil];
+    
+    [migrationController migrate];
+    
+    NSDictionary<NSString *, OSInAppMessage *>*retrievedDict = [OneSignalUserDefaults.initStandard
+                                                                getSavedCodeableDataForKey:OS_IAM_REDISPLAY_DICTIONARY defaultValue:nil];
+    XCTAssertNil(retrievedDict);
+}
+
+
+
+
+
 @end