Split up cached SDK versions for migration purposes

* Each module will own its migration and a separate cached SDK version to determine if it should do a migration.
* This change is made because it is possible for one module to migrate while another has not yet, and caching the same SDK version will affect the second module's future migration when it reads the version from cache.
* For example, this is currently a bug as of 5.2.9:
- The extension can receive a notification during the time an app is updated without the app being initialized/launched before. This path calls a migration in the outcomes module. When the outcomes module is done migrating, it caches the new SDK version, overriding the previous cached version.
- The next time the app starts up, in app messages may need to migrate but it is using the new SDK version that is cached by outcomes above, and skip a necessary migration.

Author: nan-li

iOS_SDK/OneSignalSDK/OneSignalCore/Source/OneSignalCommonDefines.h

@@ -96,8 +96,15 @@
 #define OSUD_CACHED_RECEIVED_IAM_IDS                                        @"OSUD_CACHED_RECEIVED_IAM_IDS"
 #define OSUD_CACHED_UNATTRIBUTED_UNIQUE_OUTCOME_EVENTS_SENT                 @"CACHED_UNATTRIBUTED_UNIQUE_OUTCOME_EVENTS_SENT"                   // * OSUD_CACHED_UNATTRIBUTED_UNIQUE_OUTCOME_EVENTS_SENT
 #define OSUD_CACHED_ATTRIBUTED_UNIQUE_OUTCOME_EVENT_NOTIFICATION_IDS_SENT   @"CACHED_ATTRIBUTED_UNIQUE_OUTCOME_EVENT_NOTIFICATION_IDS_SENT"     // * OSUD_CACHED_ATTRIBUTED_UNIQUE_OUTCOME_EVENT_NOTIFICATION_IDS_SENT
+
 // Migration
-#define OSUD_CACHED_SDK_VERSION                                             @"OSUD_CACHED_SDK_VERSION"
+/// Value used by all modules prior to 5.2.10
+#define OSUD_LEGACY_CACHED_SDK_VERSION_FOR_MIGRATION                @"OSUD_CACHED_SDK_VERSION"
+/// Values added in 5.2.10 for each module to own its own migration
+#define OSUD_CACHED_SDK_VERSION_FOR_CORE                            @"OSUD_CACHED_SDK_VERSION_FOR_CORE"
+#define OSUD_CACHED_SDK_VERSION_FOR_OUTCOMES                        @"OSUD_CACHED_SDK_VERSION_FOR_OUTCOMES"
+#define OSUD_CACHED_SDK_VERSION_FOR_IAM                             @"OSUD_CACHED_SDK_VERSION_FOR_IAM"
+
 // Time Tracking
 #define OSUD_APP_LAST_CLOSED_TIME                                           @"GT_LAST_CLOSED_TIME"                                              // * OSUD_APP_LAST_CLOSED_TIME
 #define OSUD_UNSENT_ACTIVE_TIME                                             @"GT_UNSENT_ACTIVE_TIME"                                            // * OSUD_UNSENT_ACTIVE_TIME

iOS_SDK/OneSignalSDK/OneSignalInAppMessages/Controller/OSInAppMessageMigrationController.m

@@ -34,14 +34,15 @@ @implementation OSInAppMessageMigrationController
 +(void)migrate {
     [self migrateIAMRedisplayCache];
     [self migrateToOSInAppMessageInternal];
+    [self saveCurrentSDKVersion];
 }
 
 // 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];
+    long sdkVersion = [OneSignalUserDefaults.initShared getSavedIntegerForKey:OSUD_CACHED_SDK_VERSION_FOR_IAM defaultValue:0];
     if (sdkVersion >= iamRedisplayCacheFixVersion)
         return;
 
@@ -71,7 +72,7 @@ + (void)migrateIAMRedisplayCache {
 // We must set the new class name to the unarchiver to avoid crashing
 + (void)migrateToOSInAppMessageInternal {
     let nameChangeVersion = 30700;
-    long sdkVersion = [OneSignalUserDefaults.initShared getSavedIntegerForKey:OSUD_CACHED_SDK_VERSION defaultValue:0];
+    long sdkVersion = [OneSignalUserDefaults.initShared getSavedIntegerForKey:OSUD_CACHED_SDK_VERSION_FOR_IAM defaultValue:0];
     [NSKeyedUnarchiver setClass:[OSInAppMessageInternal class] forClassName:@"OSInAppMessage"];
     if (sdkVersion < nameChangeVersion) {
         [OneSignalLog onesignalLog:ONE_S_LL_DEBUG message:[NSString stringWithFormat:@"Migrating OSInAppMessage from version: %ld", sdkVersion]];
@@ -88,5 +89,9 @@ + (void)migrateToOSInAppMessageInternal {
     }
 }
 
++ (void)saveCurrentSDKVersion {
+    int currentVersion = [ONESIGNAL_VERSION intValue];
+    [OneSignalUserDefaults.initShared saveIntegerForKey:OSUD_CACHED_SDK_VERSION_FOR_IAM withValue:currentVersion];
+}
 
 @end

iOS_SDK/OneSignalSDK/OneSignalOutcomes/OSOutcomes.m

@@ -60,7 +60,7 @@ + (void)migrate {
 + (void)migrateToVersion_02_14_00_AndGreater {
     let influenceVersion = 21400;
     let uniqueCacheOutcomeVersion = 21403;
-    long sdkVersion = [OneSignalUserDefaults.initShared getSavedIntegerForKey:OSUD_CACHED_SDK_VERSION defaultValue:0];
+    long sdkVersion = [OneSignalUserDefaults.initShared getSavedIntegerForKey:OSUD_CACHED_SDK_VERSION_FOR_OUTCOMES defaultValue:0];
     if (sdkVersion < influenceVersion) {
         [OneSignalLog onesignalLog:ONE_S_LL_DEBUG message:[NSString stringWithFormat:@"Migrating OSIndirectNotification from version: %ld", sdkVersion]];
 
@@ -85,7 +85,7 @@ + (void)migrateToVersion_02_14_00_AndGreater {
 }
 + (void)saveCurrentSDKVersion {
     let currentVersion = [ONESIGNAL_VERSION intValue];
-    [OneSignalUserDefaults.initShared saveIntegerForKey:OSUD_CACHED_SDK_VERSION withValue:currentVersion];
+    [OneSignalUserDefaults.initShared saveIntegerForKey:OSUD_CACHED_SDK_VERSION_FOR_OUTCOMES withValue:currentVersion];
 }
 
 #pragma mark Session namespace