Fix for LIB-1416 & Github #846

Analytics/Classes/Internal/SEGAnalyticsUtils.h

@@ -5,6 +5,9 @@ NS_ASSUME_NONNULL_BEGIN
 
 NSString *GenerateUUIDString(void);
 
+// Validation Utils
+BOOL serializableDictionaryTypes(NSDictionary *dict);
+
 // Date Utils
 NSString *iso8601FormattedString(NSDate *date);
 
@@ -33,4 +36,16 @@ NSString *_Nullable SEGIDFA(void);
 
 NSString *SEGEventNameForScreenTitle(NSString *title);
 
+// Deep copy and check NSCoding conformance
+@protocol SEGSerializableDeepCopy <NSObject>
+-(id _Nullable) serializableDeepCopy;
+@end
+
+@interface NSDictionary(SerializableDeepCopy) <SEGSerializableDeepCopy>
+@end
+
+@interface NSArray(SerializableDeepCopy) <SEGSerializableDeepCopy>
+@end
+
+
 NS_ASSUME_NONNULL_END

Analytics/Classes/Internal/SEGAnalyticsUtils.m

@@ -160,31 +160,12 @@ static id SEGCoerceJSONObject(id obj)
     return [obj description];
 }
 
-static void AssertDictionaryTypes(id dict)
-{
-#ifdef DEBUG
-    assert([dict isKindOfClass:[NSDictionary class]]);
-    for (id key in dict) {
-        assert([key isKindOfClass:[NSString class]]);
-        id value = dict[key];
-
-        assert([value isKindOfClass:[NSString class]] ||
-               [value isKindOfClass:[NSNumber class]] ||
-               [value isKindOfClass:[NSNull class]] ||
-               [value isKindOfClass:[NSArray class]] ||
-               [value isKindOfClass:[NSDictionary class]] ||
-               [value isKindOfClass:[NSDate class]] ||
-               [value isKindOfClass:[NSURL class]]);
-    }
-#endif
-}
-
 NSDictionary *SEGCoerceDictionary(NSDictionary *dict)
 {
     // make sure that a new dictionary exists even if the input is null
     dict = dict ?: @{};
     // assert that the proper types are in the dictionary
-    AssertDictionaryTypes(dict);
+    dict = [dict serializableDeepCopy];
     // coerce urls, and dates to the proper format
     return SEGCoerceJSONObject(dict);
 }
@@ -214,3 +195,75 @@ static void AssertDictionaryTypes(id dict)
 {
     return [[NSString alloc] initWithFormat:@"Viewed %@ Screen", title];
 }
+
+
+@implementation NSDictionary(SerializableDeepCopy)
+
+- (NSDictionary *)serializableDeepCopy
+{
+    NSMutableDictionary *returnDict = [[NSMutableDictionary alloc] initWithCapacity:self.count];
+    NSArray *keys = [self allKeys];
+    for (id key in keys) {
+        id aValue = [self objectForKey:key];
+        id theCopy = nil;
+
+        if (![aValue conformsToProtocol:@protocol(NSCoding)]) {
+#ifdef DEBUG
+            NSAssert(FALSE, @"key `%@` doesn't conform to NSCoding and can't be serialized for delivery.", key);
+#else
+            SEGLog(@"key `%@` doesn't conform to NSCoding and can't be serialized for delivery.", key);
+            // simply leave it out since we can't encode it anyway.
+            continue;
+#endif
+        }
+
+        if ([aValue conformsToProtocol:@protocol(SEGSerializableDeepCopy)]) {
+            theCopy = [aValue serializableDeepCopy];
+        } else if ([aValue conformsToProtocol:@protocol(NSCopying)]) {
+            theCopy = [aValue copy];
+        } else {
+            theCopy = aValue;
+        }
+
+        [returnDict setValue:theCopy forKey:key];
+  }
+
+  return [returnDict copy];
+}
+
+@end
+
+
+@implementation NSArray(SerializableDeepCopy)
+
+-(NSArray *)serializableDeepCopy
+{
+    NSMutableArray *returnArray = [[NSMutableArray alloc] initWithCapacity:self.count];
+
+    for (id aValue in self) {
+        id theCopy = nil;
+
+        if (![aValue conformsToProtocol:@protocol(NSCoding)]) {
+#ifdef DEBUG
+            NSAssert(FALSE, @"type `%@` doesn't conform to NSCoding and can't be serialized for delivery.", NSStringFromClass([aValue class]));
+#else
+            SEGLog(@"type `%@` doesn't conform to NSCoding and can't be serialized for delivery.", NSStringFromClass([aValue class]));
+            // simply leave it out since we can't encode it anyway.
+            continue;
+#endif
+        }
+
+        if ([aValue conformsToProtocol:@protocol(SEGSerializableDeepCopy)]) {
+            theCopy = [aValue serializableDeepCopy];
+        } else if ([aValue conformsToProtocol:@protocol(NSCopying)]) {
+            theCopy = [aValue copy];
+        } else {
+            theCopy = aValue;
+        }
+        [returnArray addObject:theCopy];
+    }
+
+    return [returnArray copy];
+}
+
+@end

Analytics/Classes/Internal/SEGFileStorage.m

@@ -146,12 +146,19 @@ - (void)setPlist:(id _Nonnull)plist forKey:(NSString *)key
 - (NSData *_Nullable)dataFromPlist:(nonnull id)plist
 {
     NSError *error = nil;
-    NSData *data = [NSPropertyListSerialization dataWithPropertyList:plist
-                                                              format:NSPropertyListXMLFormat_v1_0
-                                                             options:0
-                                                               error:&error];
-    if (error) {
-        SEGLog(@"Unable to serialize data from plist object", error, plist);
+    NSData *data = nil;
+    // Temporary just-in-case fix for issue #846; Follow-on PR to move away from plist storage.
+    @try {
+        data = [NSPropertyListSerialization dataWithPropertyList:plist
+                                                          format:NSPropertyListXMLFormat_v1_0
+                                                         options:0
+                                                           error:&error];
+    } @catch (NSException *e) {
+        SEGLog(@"Unable to serialize data from plist object; Exception: %@, plist: %@", e, plist);
+    } @finally {
+        if (error) {
+            SEGLog(@"Unable to serialize data from plist object; Error: %@, plist: %@", error, plist);
+        }
     }
     return data;
 }