Creating migration for Dictionary -> CodeableData for the redisplay dict

If the OS_IAM_REDISPLAY_CACHE is successfully read as Codeable data we don't need to migrate. If that fails try to read it as a dictionary and then save it as Codeable data. If that also fails then clear the cache because we cannot determine what data type was stored for the key.

Author: emawby

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 = 30203;
+    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 sdkVersionRaw] intValue];
     [OneSignalUserDefaults.initShared saveIntegerForKey:OSUD_CACHED_SDK_VERSION withValue:currentVersion];