Fix issues around plist->json conversion & nil values (#862)

bsneed · web-flow · commit 9ce3779529d3 · 2020-02-11T15:07:09.000-08:00
* Fixing a crash from plist-&gt;json conversion where result is not actually a dictionary.

* Made code flow the same as non-conversion.

* Set compatibility to 10.0.

* Fixed issues around setting nil values even though they are expected.
diff --git a/Analytics.xcodeproj/project.pbxproj b/Analytics.xcodeproj/project.pbxproj
@@ -866,7 +866,7 @@
 				GCC_WARN_UNINITIALIZED_AUTOS = YES_AGGRESSIVE;
 				GCC_WARN_UNUSED_FUNCTION = YES;
 				GCC_WARN_UNUSED_VARIABLE = YES;
-				IPHONEOS_DEPLOYMENT_TARGET = 10.1;
+				IPHONEOS_DEPLOYMENT_TARGET = 10.0;
 				MTL_ENABLE_DEBUG_INFO = YES;
 				ONLY_ACTIVE_ARCH = YES;
 				SDKROOT = iphoneos;
@@ -919,7 +919,7 @@
 				GCC_WARN_UNINITIALIZED_AUTOS = YES_AGGRESSIVE;
 				GCC_WARN_UNUSED_FUNCTION = YES;
 				GCC_WARN_UNUSED_VARIABLE = YES;
-				IPHONEOS_DEPLOYMENT_TARGET = 10.1;
+				IPHONEOS_DEPLOYMENT_TARGET = 10.0;
 				MTL_ENABLE_DEBUG_INFO = NO;
 				SDKROOT = iphoneos;
 				SWIFT_OPTIMIZATION_LEVEL = "-Owholemodule";
diff --git a/Analytics/Classes/Internal/SEGFileStorage.m b/Analytics/Classes/Internal/SEGFileStorage.m
@@ -51,6 +51,13 @@ - (void)resetAll
 - (void)setData:(NSData *)data forKey:(NSString *)key
 {
     NSURL *url = [self urlForKey:key];
+    
+    // a nil value was supplied, remove the storage for said key.
+    if (data == nil) {
+        [[NSFileManager defaultManager] removeItemAtURL:url error:nil];
+        return;
+    }
+    
     if (self.crypto) {
         NSData *encryptedData = [self.crypto encrypt:data];
         [encryptedData writeToURL:url atomically:YES];
@@ -80,40 +87,38 @@ - (NSData *)dataForKey:(NSString *)key
     return data;
 }
 
-- (NSDictionary *)dictionaryForKey:(NSString *)key
+- (nullable NSDictionary *)dictionaryForKey:(NSString *)key
 {
     return [self jsonForKey:key];
 }
 
-- (void)setDictionary:(NSDictionary *)dictionary forKey:(NSString *)key
+- (void)setDictionary:(nullable NSDictionary *)dictionary forKey:(NSString *)key
 {
     [self setJSON:dictionary forKey:key];
 }
 
-- (NSArray *)arrayForKey:(NSString *)key
+- (nullable NSArray *)arrayForKey:(NSString *)key
 {
     return [self jsonForKey:key];
 }
 
-- (void)setArray:(NSArray *)array forKey:(NSString *)key
+- (void)setArray:(nullable NSArray *)array forKey:(NSString *)key
 {
     [self setJSON:array forKey:key];
 }
 
-- (NSString *)stringForKey:(NSString *)key
+- (nullable NSString *)stringForKey:(NSString *)key
 {
-    // unlike plists, we can't have stray values, they need to be
-    // in a dictionary or array container.
     NSDictionary *data = [self jsonForKey:key];
-    return data[key];
+    if (data) {
+        return data[key];
+    }
+    return nil;
 }
 
-- (void)setString:(NSString *)string forKey:(NSString *)key
+- (void)setString:(nullable NSString *)string forKey:(NSString *)key
 {
-    // unlike plists, we can't have stray values, they need to be
-    // in a dictionary or array container.
-    NSDictionary *data = @{key: string};
-    [self setJSON:data forKey:key];
+    [self setJSON:string forKey:key];
 }
 
 
@@ -148,31 +153,39 @@ - (id _Nullable)jsonForKey:(NSString *)key
         result = [self jsonFromData:data needsConversion:&needsConversion];
         if (needsConversion) {
             [self setJSON:result forKey:key];
+            // maybe a little repetitive, but we want to recreate the same path it would
+            // take if it weren't being converted.
+            data = [self dataForKey:key];
+            result = [self jsonFromData:data needsConversion:&needsConversion];
         }
     }
     return result;
 }
 
-- (void)setJSON:(id _Nonnull)plist forKey:(NSString *)key
+- (void)setJSON:(id _Nonnull)json forKey:(NSString *)key
 {
     NSDictionary *dict = nil;
     
     // json doesn't allow stand alone values like plist (previous storage format) does so
     // we need to massage it a little.
-    if ([plist isKindOfClass:[NSDictionary class]] || [plist isKindOfClass:[NSArray class]]) {
-        dict = plist;
-    } else {
-        dict = @{key: plist};
+    if (json) {
+        if ([json isKindOfClass:[NSDictionary class]] || [json isKindOfClass:[NSArray class]]) {
+            dict = json;
+        } else {
+            dict = @{key: json};
+        }
     }
     
     NSData *data = [self dataFromJSON:dict];
-    if (data) {
-        [self setData:data forKey:key];
-    }
+    [self setData:data forKey:key];
 }
 
 - (NSData *_Nullable)dataFromJSON:(id)json
 {
+    if (json == nil) {
+        return nil;
+    }
+    
     NSError *error = nil;
     NSData *data = [NSJSONSerialization dataWithJSONObject:json options:0 error:&error];
     if (error) {
diff --git a/Analytics/Classes/Internal/SEGStorage.h b/Analytics/Classes/Internal/SEGStorage.h
@@ -15,16 +15,16 @@
 - (void)removeKey:(NSString *_Nonnull)key;
 - (void)resetAll;
 
-- (void)setData:(NSData *_Nonnull)data forKey:(NSString *_Nonnull)key;
+- (void)setData:(NSData *_Nullable)data forKey:(NSString *_Nonnull)key;
 - (NSData *_Nullable)dataForKey:(NSString *_Nonnull)key;
 
-- (void)setDictionary:(NSDictionary *_Nonnull)dictionary forKey:(NSString *_Nonnull)key;
+- (void)setDictionary:(NSDictionary *_Nullable)dictionary forKey:(NSString *_Nonnull)key;
 - (NSDictionary *_Nullable)dictionaryForKey:(NSString *_Nonnull)key;
 
-- (void)setArray:(NSArray *_Nonnull)array forKey:(NSString *_Nonnull)key;
+- (void)setArray:(NSArray *_Nullable)array forKey:(NSString *_Nonnull)key;
 - (NSArray *_Nullable)arrayForKey:(NSString *_Nonnull)key;
 
-- (void)setString:(NSString *_Nonnull)string forKey:(NSString *_Nonnull)key;
+- (void)setString:(NSString *_Nullable)string forKey:(NSString *_Nonnull)key;
 - (NSString *_Nullable)stringForKey:(NSString *_Nonnull)key;
 
 // Number and Booleans are intentionally omitted at the moment because they are not needed
diff --git a/Analytics/Classes/Internal/SEGUserDefaultsStorage.m b/Analytics/Classes/Internal/SEGUserDefaultsStorage.m
@@ -46,6 +46,16 @@ - (void)resetAll
     [self.defaults synchronize];
 }
 
+- (void)setObject:(id)object forKey:(NSString *)key
+{
+    // pass through for NSUserDefaults to remove keys if supplied a nil value.
+    if (object) {
+        [self.defaults setObject:object forKey:key];
+    } else {
+        [self.defaults removeObjectForKey:key];
+    }
+}
+
 - (void)setData:(NSData *)data forKey:(NSString *)key
 {
     key = [self namespacedKey:key];
@@ -54,7 +64,7 @@ - (void)setData:(NSData *)data forKey:(NSString *)key
         return;
     }
     NSData *encryptedData = [self.crypto encrypt:data];
-    [self.defaults setObject:encryptedData forKey:key];
+    [self setObject:encryptedData forKey:key];
 }
 
 - (NSData *)dataForKey:(NSString *)key
@@ -84,7 +94,7 @@ - (void)setDictionary:(NSDictionary *)dictionary forKey:(NSString *)key
 {
     if (!self.crypto) {
         key = [self namespacedKey:key];
-        [self.defaults setObject:dictionary forKey:key];
+        [self setObject:dictionary forKey:key];
         return;
     }
     [self setPlist:dictionary forKey:key];
@@ -103,7 +113,7 @@ - (void)setArray:(NSArray *)array forKey:(NSString *)key
 {
     if (!self.crypto) {
         key = [self namespacedKey:key];
-        [self.defaults setObject:array forKey:key];
+        [self setObject:array forKey:key];
         return;
     }
     [self setPlist:array forKey:key];
@@ -122,7 +132,7 @@ - (void)setString:(NSString *)string forKey:(NSString *)key
 {
     if (!self.crypto) {
         key = [self namespacedKey:key];
-        [self.defaults setObject:string forKey:key];
+        [self setObject:string forKey:key];
         return;
     }
     [self setPlist:string forKey:key];

Original file line number	Diff line number	Diff line change
`@@ -51,6 +51,13 @@ - (void)resetAll`
`51`	`51`	`- (void)setData:(NSData )data forKey:(NSString )key`
`52`	`52`	`{`
`53`	`53`	`NSURL *url = [self urlForKey:key];`
	`54`	`+`
	`55`	`+ // a nil value was supplied, remove the storage for said key.`
	`56`	`+ if (data == nil) {`
	`57`	`+ [[NSFileManager defaultManager] removeItemAtURL:url error:nil];`
	`58`	`+ return;`
	`59`	`+ }`
	`60`	`+`
`54`	`61`	`if (self.crypto) {`
`55`	`62`	`NSData *encryptedData = [self.crypto encrypt:data];`
`56`	`63`	`[encryptedData writeToURL:url atomically:YES];`
`@@ -80,40 +87,38 @@ - (NSData )dataForKey:(NSString )key`
`80`	`87`	`return data;`
`81`	`88`	`}`
`82`	`89`
`83`		`-- (NSDictionary )dictionaryForKey:(NSString )key`
	`90`	`+- (nullable NSDictionary )dictionaryForKey:(NSString )key`
`84`	`91`	`{`
`85`	`92`	`return [self jsonForKey:key];`
`86`	`93`	`}`
`87`	`94`
`88`		`-- (void)setDictionary:(NSDictionary )dictionary forKey:(NSString )key`
	`95`	`+- (void)setDictionary:(nullable NSDictionary )dictionary forKey:(NSString )key`
`89`	`96`	`{`
`90`	`97`	`[self setJSON:dictionary forKey:key];`
`91`	`98`	`}`
`92`	`99`
`93`		`-- (NSArray )arrayForKey:(NSString )key`
	`100`	`+- (nullable NSArray )arrayForKey:(NSString )key`
`94`	`101`	`{`
`95`	`102`	`return [self jsonForKey:key];`
`96`	`103`	`}`
`97`	`104`
`98`		`-- (void)setArray:(NSArray )array forKey:(NSString )key`
	`105`	`+- (void)setArray:(nullable NSArray )array forKey:(NSString )key`
`99`	`106`	`{`
`100`	`107`	`[self setJSON:array forKey:key];`
`101`	`108`	`}`
`102`	`109`
`103`		`-- (NSString )stringForKey:(NSString )key`
	`110`	`+- (nullable NSString )stringForKey:(NSString )key`
`104`	`111`	`{`
`105`		`- // unlike plists, we can't have stray values, they need to be`
`106`		`- // in a dictionary or array container.`
`107`	`112`	`NSDictionary *data = [self jsonForKey:key];`
`108`		`- return data[key];`
	`113`	`+ if (data) {`
	`114`	`+ return data[key];`
	`115`	`+ }`
	`116`	`+ return nil;`
`109`	`117`	`}`
`110`	`118`
`111`		`-- (void)setString:(NSString )string forKey:(NSString )key`
	`119`	`+- (void)setString:(nullable NSString )string forKey:(NSString )key`
`112`	`120`	`{`
`113`		`- // unlike plists, we can't have stray values, they need to be`
`114`		`- // in a dictionary or array container.`
`115`		`- NSDictionary *data = @{key: string};`
`116`		`- [self setJSON:data forKey:key];`
	`121`	`+ [self setJSON:string forKey:key];`
`117`	`122`	`}`
`118`	`123`
`119`	`124`
`@@ -148,31 +153,39 @@ - (id _Nullable)jsonForKey:(NSString *)key`
`148`	`153`	`result = [self jsonFromData:data needsConversion:&needsConversion];`
`149`	`154`	`if (needsConversion) {`
`150`	`155`	`[self setJSON:result forKey:key];`
	`156`	`+ // maybe a little repetitive, but we want to recreate the same path it would`
	`157`	`+ // take if it weren't being converted.`
	`158`	`+ data = [self dataForKey:key];`
	`159`	`+ result = [self jsonFromData:data needsConversion:&needsConversion];`
`151`	`160`	`}`
`152`	`161`	`}`
`153`	`162`	`return result;`
`154`	`163`	`}`
`155`	`164`
`156`		`-- (void)setJSON:(id _Nonnull)plist forKey:(NSString *)key`
	`165`	`+- (void)setJSON:(id _Nonnull)json forKey:(NSString *)key`
`157`	`166`	`{`
`158`	`167`	`NSDictionary *dict = nil;`
`159`	`168`
`160`	`169`	`// json doesn't allow stand alone values like plist (previous storage format) does so`
`161`	`170`	`// we need to massage it a little.`
`162`		`- if ([plist isKindOfClass:[NSDictionary class]] \|\| [plist isKindOfClass:[NSArray class]]) {`
`163`		`- dict = plist;`
`164`		`- } else {`
`165`		`- dict = @{key: plist};`
	`171`	`+ if (json) {`
	`172`	`+ if ([json isKindOfClass:[NSDictionary class]] \|\| [json isKindOfClass:[NSArray class]]) {`
	`173`	`+ dict = json;`
	`174`	`+ } else {`
	`175`	`+ dict = @{key: json};`
	`176`	`+ }`
`166`	`177`	`}`
`167`	`178`
`168`	`179`	`NSData *data = [self dataFromJSON:dict];`
`169`		`- if (data) {`
`170`		`- [self setData:data forKey:key];`
`171`		`- }`
	`180`	`+ [self setData:data forKey:key];`
`172`	`181`	`}`
`173`	`182`
`174`	`183`	`- (NSData *_Nullable)dataFromJSON:(id)json`
`175`	`184`	`{`
	`185`	`+ if (json == nil) {`
	`186`	`+ return nil;`
	`187`	`+ }`
	`188`	`+`
`176`	`189`	`NSError *error = nil;`
`177`	`190`	`NSData *data = [NSJSONSerialization dataWithJSONObject:json options:0 error:&error];`
`178`	`191`	`if (error) {`
Original file line number	Diff line number	Diff line change
`@@ -46,6 +46,16 @@ - (void)resetAll`
`46`	`46`	`[self.defaults synchronize];`
`47`	`47`	`}`
`48`	`48`
	`49`	`+- (void)setObject:(id)object forKey:(NSString *)key`
	`50`	`+{`
	`51`	`+ // pass through for NSUserDefaults to remove keys if supplied a nil value.`
	`52`	`+ if (object) {`
	`53`	`+ [self.defaults setObject:object forKey:key];`
	`54`	`+ } else {`
	`55`	`+ [self.defaults removeObjectForKey:key];`
	`56`	`+ }`
	`57`	`+}`
	`58`	`+`
`49`	`59`	`- (void)setData:(NSData )data forKey:(NSString )key`
`50`	`60`	`{`
`51`	`61`	`key = [self namespacedKey:key];`
`@@ -54,7 +64,7 @@ - (void)setData:(NSData )data forKey:(NSString )key`
`54`	`64`	`return;`
`55`	`65`	`}`
`56`	`66`	`NSData *encryptedData = [self.crypto encrypt:data];`
`57`		`- [self.defaults setObject:encryptedData forKey:key];`
	`67`	`+ [self setObject:encryptedData forKey:key];`
`58`	`68`	`}`
`59`	`69`
`60`	`70`	`- (NSData )dataForKey:(NSString )key`
`@@ -84,7 +94,7 @@ - (void)setDictionary:(NSDictionary )dictionary forKey:(NSString )key`
`84`	`94`	`{`
`85`	`95`	`if (!self.crypto) {`
`86`	`96`	`key = [self namespacedKey:key];`
`87`		`- [self.defaults setObject:dictionary forKey:key];`
	`97`	`+ [self setObject:dictionary forKey:key];`
`88`	`98`	`return;`
`89`	`99`	`}`
`90`	`100`	`[self setPlist:dictionary forKey:key];`
`@@ -103,7 +113,7 @@ - (void)setArray:(NSArray )array forKey:(NSString )key`
`103`	`113`	`{`
`104`	`114`	`if (!self.crypto) {`
`105`	`115`	`key = [self namespacedKey:key];`
`106`		`- [self.defaults setObject:array forKey:key];`
	`116`	`+ [self setObject:array forKey:key];`
`107`	`117`	`return;`
`108`	`118`	`}`
`109`	`119`	`[self setPlist:array forKey:key];`
`@@ -122,7 +132,7 @@ - (void)setString:(NSString )string forKey:(NSString )key`
`122`	`132`	`{`
`123`	`133`	`if (!self.crypto) {`
`124`	`134`	`key = [self namespacedKey:key];`
`125`		`- [self.defaults setObject:string forKey:key];`
	`135`	`+ [self setObject:string forKey:key];`
`126`	`136`	`return;`
`127`	`137`	`}`
`128`	`138`	`[self setPlist:string forKey:key];`