Fix UserDefault UniqueOutcome decodable clases migration

  * Add OSUniqueOutcomeNotification migration to OSCachedUniqueOutcome

Author: Jeasmine

iOS_SDK/OneSignalSDK/OneSignal.xcodeproj/project.pbxproj

@@ -99,6 +99,7 @@
 		7A880F322404AE7B0081F5E8 /* OSInAppMessagePushPrompt.m in Sources */ = {isa = PBXBuildFile; fileRef = 7A880F302404AE7B0081F5E8 /* OSInAppMessagePushPrompt.m */; };
 		7A880F332404AE7B0081F5E8 /* OSInAppMessagePushPrompt.m in Sources */ = {isa = PBXBuildFile; fileRef = 7A880F302404AE7B0081F5E8 /* OSInAppMessagePushPrompt.m */; };
 		7A9173A2231971E5007848FA /* OneSignalReceiveReceiptsController.m in Sources */ = {isa = PBXBuildFile; fileRef = 7A9173A1231971E5007848FA /* OneSignalReceiveReceiptsController.m */; };
+		7A94D8E1249ABF0000E90B40 /* OSUniqueOutcomeNotification.m in Sources */ = {isa = PBXBuildFile; fileRef = 7A94D8E0249ABF0000E90B40 /* OSUniqueOutcomeNotification.m */; };
 		7AA2848A2406FC6400C25D76 /* OSInAppMessageTag.m in Sources */ = {isa = PBXBuildFile; fileRef = 7A1F2D8E2406EFC5007799A9 /* OSInAppMessageTag.m */; };
 		7AA2848B2406FC6500C25D76 /* OSInAppMessageTag.m in Sources */ = {isa = PBXBuildFile; fileRef = 7A1F2D8E2406EFC5007799A9 /* OSInAppMessageTag.m */; };
 		7AAA60662485D0310004FADE /* OSMigrationController.h in Headers */ = {isa = PBXBuildFile; fileRef = 7AAA60652485D0090004FADE /* OSMigrationController.h */; };
@@ -497,6 +498,8 @@
 		7A880F302404AE7B0081F5E8 /* OSInAppMessagePushPrompt.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = OSInAppMessagePushPrompt.m; sourceTree = "<group>"; };
 		7A9173A1231971E5007848FA /* OneSignalReceiveReceiptsController.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = OneSignalReceiveReceiptsController.m; sourceTree = "<group>"; };
 		7A9173A3231971F8007848FA /* OneSignalReceiveReceiptsController.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = OneSignalReceiveReceiptsController.h; sourceTree = "<group>"; };
+		7A94D8E0249ABF0000E90B40 /* OSUniqueOutcomeNotification.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = OSUniqueOutcomeNotification.m; sourceTree = "<group>"; };
+		7A94D8E2249ABF0C00E90B40 /* OSUniqueOutcomeNotification.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = OSUniqueOutcomeNotification.h; sourceTree = "<group>"; };
 		7AAA60652485D0090004FADE /* OSMigrationController.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = OSMigrationController.h; sourceTree = "<group>"; };
 		7AAA60672485D0420004FADE /* OSMigrationController.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = OSMigrationController.m; sourceTree = "<group>"; };
 		7ABAF9D02457C3570074DFA0 /* CommonAsserts.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = CommonAsserts.h; sourceTree = "<group>"; };
@@ -831,6 +834,8 @@
 			children = (
 				7A5A8186248990DA002E07C8 /* OSIndirectNotification.h */,
 				7A5A8184248990CD002E07C8 /* OSIndirectNotification.m */,
+				7A94D8E2249ABF0C00E90B40 /* OSUniqueOutcomeNotification.h */,
+				7A94D8E0249ABF0000E90B40 /* OSUniqueOutcomeNotification.m */,
 			);
 			path = Models;
 			sourceTree = "<group>";
@@ -1642,6 +1647,7 @@
 			isa = PBXSourcesBuildPhase;
 			buildActionMask = 2147483647;
 			files = (
+				7A94D8E1249ABF0000E90B40 /* OSUniqueOutcomeNotification.m in Sources */,
 				7A1232B2235E1BE6002B6CE3 /* OneSignalUserDefaults.m in Sources */,
 				7AF8FDBD2332A5C200A19245 /* OSIndirectInfluence.m in Sources */,
 				7A880F2D23FB45FB0081F5E8 /* OSInAppMessageOutcome.m in Sources */,

iOS_SDK/OneSignalSDK/Source/OSMigrationController.m

@@ -28,14 +28,17 @@ of this software and associated documentation files (the "Software"), to deal
 #import <Foundation/Foundation.h>
 #import "OSMigrationController.h"
 #import "OSInfluenceDataRepository.h"
+#import "OSOutcomeEventsCache.h"
 #import "OSIndirectInfluence.h"
+#import "OSCachedUniqueOutcome.h"
 #import "OneSignal.h"
 #import "OneSignalUserDefaults.h"
 #import "OneSignalCommonDefines.h"
 #import "OneSignalHelper.h"
 
 @interface OneSignal ()
 + (OSInfluenceDataRepository *)influenceDataRepository;
++ (OSOutcomeEventsCache *)outcomeEventsCache;
 @end
 
 @implementation OSMigrationController
@@ -50,15 +53,25 @@ - (void)migrate {
  */
 - (void)migrateToVersion_02_14_00_AndGreater {
     let influenceVersion = 21400;
+    let uniqueCacheOutcomeVersion = 21403;
     let sdkVersion = [OneSignalUserDefaults.initShared getSavedIntegerForKey:OSUD_CACHED_SDK_VERSION defaultValue:0];
     if (sdkVersion < influenceVersion) {
-        [OneSignal onesignal_Log:ONE_S_LL_DEBUG message:[NSString stringWithFormat:@"Migrating from version : %d", sdkVersion]];
+        [OneSignal onesignal_Log:ONE_S_LL_DEBUG message:[NSString stringWithFormat:@"Migrating OSIndirectNotification from version: %d", sdkVersion]];
 
         [NSKeyedUnarchiver setClass:[OSIndirectInfluence class] forClassName:@"OSIndirectNotification"];
         NSArray<OSIndirectInfluence *> * indirectInfluenceData = [[OneSignal influenceDataRepository] lastNotificationsReceivedData];
         if (indirectInfluenceData)
             [[OneSignal influenceDataRepository] saveNotifications:indirectInfluenceData];
     }
+    
+    if (sdkVersion < uniqueCacheOutcomeVersion) {
+        [OneSignal onesignal_Log:ONE_S_LL_DEBUG message:[NSString stringWithFormat:@"Migrating OSUniqueOutcomeNotification from version: %d", sdkVersion]];
+        
+        [NSKeyedUnarchiver setClass:[OSCachedUniqueOutcome class] forClassName:@"OSUniqueOutcomeNotification"];
+        NSArray<OSCachedUniqueOutcome *> * attributedCacheUniqueOutcomeEvents = [[OneSignal outcomeEventsCache] getAttributedUniqueOutcomeEventSent];
+        if (attributedCacheUniqueOutcomeEvents)
+            [[OneSignal outcomeEventsCache] saveAttributedUniqueOutcomeEventNotificationIds:attributedCacheUniqueOutcomeEvents];
+    }
 }
 
 - (void)saveCurrentSDKVersion {

iOS_SDK/OneSignalSDK/Source/OneSignal.m

@@ -390,6 +390,8 @@ + (OSSessionManager*)sessionManager {
 
 static OSOutcomeEventsCache *_outcomeEventsCache;
 + (OSOutcomeEventsCache *)outcomeEventsCache {
+    if (!_outcomeEventsCache)
+        _outcomeEventsCache = [[OSOutcomeEventsCache alloc] init];
     return _outcomeEventsCache;
 }
 
@@ -588,8 +590,7 @@ + (id)initWithLaunchOptions:(NSDictionary*)launchOptions
     initializationTime = [NSDate date];
 
     // Outcomes init
-    _outcomeEventsCache = [[OSOutcomeEventsCache alloc] init];
-    _outcomeEventFactory = [[OSOutcomeEventsFactory alloc] initWithCache:_outcomeEventsCache];
+    _outcomeEventFactory = [[OSOutcomeEventsFactory alloc] initWithCache:OneSignal.outcomeEventsCache];
     _outcomeEventsController = [[OneSignalOutcomeEventsController alloc] initWithSessionManager:OneSignal.sessionManager outcomeEventsFactory:_outcomeEventFactory];
 
     if (appId && mShareLocation)

iOS_SDK/OneSignalSDK/UnitTests/MigrationTests.m

@@ -28,8 +28,11 @@
 #import <XCTest/XCTest.h>
 #import "OSMigrationController.h"
 #import "OSInfluenceDataRepository.h"
+#import "OSOutcomeEventsCache.h"
 #import "OSIndirectInfluence.h"
 #import "OSIndirectNotification.h"
+#import "OSCachedUniqueOutcome.h"
+#import "OSUniqueOutcomeNotification.h"
 #import "OneSignalHelper.h"
 #import "UnitTestCommonMethods.h"
 #import "OneSignalUserDefaults.h"
@@ -42,13 +45,15 @@ @interface MigrationTests : XCTestCase
 @implementation MigrationTests {
     OSMigrationController *migrationController;
     OSInfluenceDataRepository *dataRepository;
+    OSOutcomeEventsCache *outcomesCache;
 }
 
 - (void)setUp {
     [super setUp];
     [UnitTestCommonMethods beforeEachTest:self];
     migrationController = [OSMigrationController new];
     dataRepository = [OSInfluenceDataRepository new];
+    outcomesCache = [OSOutcomeEventsCache new];
 }
 
 - (void)testNoIndirectInfluenceDataAvailableToMigrate {
@@ -120,4 +125,76 @@ - (void)testIndirectInfluenceToIndirectInfluenceMigration {
     XCTAssertEqual([[OneSignal sdk_version_raw] intValue], sdkVersionAfterMigration);
 }
 
+- (void)testNoAttributedUniqueOutcomeDataAvailableToMigrate {
+    NSArray *uniqueOutcomes = [outcomesCache getAttributedUniqueOutcomeEventSent];
+    NSInteger sdkVersion = [OneSignalUserDefaults.initShared getSavedIntegerForKey:OSUD_CACHED_SDK_VERSION defaultValue:0];
+    XCTAssertNil(uniqueOutcomes);
+    XCTAssertEqual(0, sdkVersion);
+    [migrationController migrate];
+    
+    NSArray *uniqueOutcomesAfterMigration = [outcomesCache getAttributedUniqueOutcomeEventSent];
+    XCTAssertNil(uniqueOutcomesAfterMigration);
+    
+    NSInteger sdkVersionAfterMigration = [OneSignalUserDefaults.initShared getSavedIntegerForKey:OSUD_CACHED_SDK_VERSION defaultValue:0];
+    XCTAssertEqual([[OneSignal sdk_version_raw] intValue], sdkVersionAfterMigration);
+}
+
+- (void)testUniqueOutcomeNotificationToCacheUniqueOutcomeMigration {
+    NSString *notificationId = @"1234-5678-1234-5678-1234";
+    NSString *outcome = @"test";
+    NSNumber *timestamp = @(10);
+    OSUniqueOutcomeNotification *uniqueOutcome = [[OSUniqueOutcomeNotification alloc] initWithParamsNotificationId:outcome notificationId:notificationId timestamp:timestamp];
+    NSMutableArray *uniqueOutcomes = [NSMutableArray new];
+    [uniqueOutcomes addObject:uniqueOutcome];
+
+    [outcomesCache saveAttributedUniqueOutcomeEventNotificationIds:uniqueOutcomes];
+
+    NSArray *lastUniqueOutcomeSaved = [outcomesCache getAttributedUniqueOutcomeEventSent];
+    NSInteger sdkVersion = [OneSignalUserDefaults.initShared getSavedIntegerForKey:OSUD_CACHED_SDK_VERSION defaultValue:0];
+    XCTAssertEqual(1, [lastUniqueOutcomeSaved count]);
+    XCTAssertEqual(0, sdkVersion);
+    
+    [migrationController migrate];
+
+    NSArray *lastUniqueOutcomeAfterMigration = [outcomesCache getAttributedUniqueOutcomeEventSent];
+    XCTAssertEqual(1, [lastUniqueOutcomeAfterMigration count]);
+
+    OSCachedUniqueOutcome *cachedUniqueOutcome = [lastUniqueOutcomeAfterMigration objectAtIndex:0];
+    XCTAssertTrue([cachedUniqueOutcome.uniqueId isEqualToString:notificationId]);
+    XCTAssertEqual(cachedUniqueOutcome.channel, NOTIFICATION);
+    XCTAssertEqual([timestamp intValue], [cachedUniqueOutcome.timestamp intValue]);
+    
+    NSInteger sdkVersionAfterMigration = [OneSignalUserDefaults.initShared getSavedIntegerForKey:OSUD_CACHED_SDK_VERSION defaultValue:0];
+    XCTAssertEqual([[OneSignal sdk_version_raw] intValue], sdkVersionAfterMigration);
+}
+
+- (void)testCachedUniqueOutcomeToCachedUniqueOutcomeMigration {
+    NSString *notificationId = @"1234-5678-1234-5678-1234";
+    NSString *outcome = @"test";
+    NSNumber *timestamp = @(10);
+    OSCachedUniqueOutcome *cachedUniqueOutcome = [[OSCachedUniqueOutcome alloc] initWithParamsName:outcome uniqueId:notificationId timestamp:timestamp channel:NOTIFICATION];
+    NSMutableArray *cacheUniqueOutcomes = [NSMutableArray new];
+    [cacheUniqueOutcomes addObject:cachedUniqueOutcome];
+    
+    [outcomesCache saveAttributedUniqueOutcomeEventNotificationIds:cacheUniqueOutcomes];
+    NSArray *lastCachedUniqueOutcomes = [outcomesCache getAttributedUniqueOutcomeEventSent];
+    NSInteger sdkVersion = [OneSignalUserDefaults.initShared getSavedIntegerForKey:OSUD_CACHED_SDK_VERSION defaultValue:0];
+    XCTAssertEqual(1, [lastCachedUniqueOutcomes count]);
+    XCTAssertEqual(0, sdkVersion);
+    
+    [migrationController migrate];
+
+    NSArray<OSCachedUniqueOutcome *> *lastCachedUniqueOutcomesAfterMigration = [outcomesCache getAttributedUniqueOutcomeEventSent];
+    XCTAssertEqual(1, [lastCachedUniqueOutcomesAfterMigration count]);
+
+    OSCachedUniqueOutcome *cachedUniqueOutcomeAfterMigration = [lastCachedUniqueOutcomesAfterMigration objectAtIndex:0];
+    XCTAssertTrue([cachedUniqueOutcomeAfterMigration.name isEqualToString:outcome]);
+    XCTAssertTrue([cachedUniqueOutcomeAfterMigration.uniqueId isEqualToString:notificationId]);
+    XCTAssertEqual(NOTIFICATION, cachedUniqueOutcomeAfterMigration.channel);
+    XCTAssertEqual([timestamp intValue], [cachedUniqueOutcomeAfterMigration.timestamp intValue]);
+    
+    NSInteger sdkVersionAfterMigration = [OneSignalUserDefaults.initShared getSavedIntegerForKey:OSUD_CACHED_SDK_VERSION defaultValue:0];
+    XCTAssertEqual([[OneSignal sdk_version_raw] intValue], sdkVersionAfterMigration);
+}
+
 @end

iOS_SDK/OneSignalSDK/UnitTests/Models/OSUniqueOutcomeNotification.h

@@ -0,0 +1,36 @@
+/**
+ Modified MIT License
+
+ Copyright 2019 OneSignal
+
+ Permission is hereby granted, free of charge, to any person obtaining a copy
+ of this software and associated documentation files (the "Software"), to deal
+ in the Software without restriction, including without limitation the rights
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ copies of the Software, and to permit persons to whom the Software is
+ furnished to do so, subject to the following conditions:
+
+ 1. The above copyright notice and this permission notice shall be included in
+ all copies or substantial portions of the Software.
+
+ 2. All copies of substantial portions of the Software may only be used in connection
+ with services provided by OneSignal.
+
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ THE SOFTWARE.
+ */
+
+@interface OSUniqueOutcomeNotification : NSObject
+
+@property (nonatomic, readonly) NSString *name;
+@property (nonatomic, readonly) NSString *notificationId;
+@property (nonatomic, readonly) NSNumber *timestamp; // seconds
+
+- (id)initWithParamsNotificationId:(NSString *)name notificationId:(NSString *)notificationId timestamp:(NSNumber *)timestamp;
+
+@end

iOS_SDK/OneSignalSDK/UnitTests/Models/OSUniqueOutcomeNotification.m

@@ -0,0 +1,71 @@
+/**
+ Modified MIT License
+
+ Copyright 2019 OneSignal
+
+ Permission is hereby granted, free of charge, to any person obtaining a copy
+ of this software and associated documentation files (the "Software"), to deal
+ in the Software without restriction, including without limitation the rights
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ copies of the Software, and to permit persons to whom the Software is
+ furnished to do so, subject to the following conditions:
+
+ 1. The above copyright notice and this permission notice shall be included in
+ all copies or substantial portions of the Software.
+
+ 2. All copies of substantial portions of the Software may only be used in connection
+ with services provided by OneSignal.
+
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ THE SOFTWARE.
+ */
+
+#import <Foundation/Foundation.h>
+#import "OSUniqueOutcomeNotification.h"
+
+@implementation OSUniqueOutcomeNotification
+
+- (id)initWithParamsNotificationId:(NSString *)name notificationId:(NSString *)notificationId timestamp:(NSNumber *)timestamp {
+    _name = name;
+    _notificationId = notificationId;
+    _timestamp = timestamp;
+    return self;
+}
+
+- (void)encodeWithCoder:(NSCoder *)encoder {
+    [encoder encodeObject:_name forKey:@"name"];
+    [encoder encodeObject:_notificationId forKey:@"notificationId"];
+    [encoder encodeInteger:[_timestamp integerValue] forKey:@"timestamp"];
+}
+
+- (id)initWithCoder:(NSCoder *)decoder {
+    if (self = [super init]) {
+        _name = [decoder decodeObjectForKey:@"name"];
+        _notificationId = [decoder decodeObjectForKey:@"notificationId"];
+        _timestamp = [NSNumber numberWithLong:[decoder decodeIntegerForKey:@"timestamp"]];
+    }
+    return self;
+}
+
+- (NSString *)description {
+    return [NSString stringWithFormat:@"Name: %@ Notification Id: %@ Timestamp: %@", _name, _notificationId, _timestamp];
+}
+
+- (BOOL)isEqual:(OSUniqueOutcomeNotification *)other {
+    NSString *key = [NSString stringWithFormat:@"%@_%@", _name, _notificationId];
+    NSString *otherKey = [NSString stringWithFormat:@"%@_%@", other.name, other.notificationId];
+    return [key isEqualToString:otherKey];
+}
+
+- (NSUInteger)hash {
+    return [_notificationId hash];
+}
+
+@end
+
+