Fixed issue where non-serializable types would get into payload (#937)

Co-authored-by: Brandon Sneed <[email protected]>

Author: bsneed

Analytics/Internal/SEGUtils.h

@@ -62,6 +62,10 @@ NSString *_Nullable SEGIDFA(void);
 
 NSString *SEGEventNameForScreenTitle(NSString *title);
 
+@interface NSJSONSerialization (Serializable)
++ (BOOL)isOfSerializableType:(id)obj;
+@end
+
 // Deep copy and check NSCoding conformance
 @protocol SEGSerializableDeepCopy <NSObject>
 -(id _Nullable) serializableMutableDeepCopy;

Analytics/Internal/SEGUtils.m

@@ -559,6 +559,20 @@ static id SEGCoerceJSONObject(id obj)
 }
 
 
+@implementation NSJSONSerialization(Serializable)
++ (BOOL)isOfSerializableType:(id)obj
+{
+    if ([obj isKindOfClass:[NSArray class]] ||
+        [obj isKindOfClass:[NSDictionary class]] ||
+        [obj isKindOfClass:[NSString class]] ||
+        [obj isKindOfClass:[NSNumber class]] ||
+        [obj isKindOfClass:[NSNull class]])
+        return YES;
+    return NO;
+}
+@end
+
+
 @implementation NSDictionary(SerializableDeepCopy)
 
 - (id)serializableDeepCopy:(BOOL)mutable
@@ -569,11 +583,12 @@ - (id)serializableDeepCopy:(BOOL)mutable
         id aValue = [self objectForKey:key];
         id theCopy = nil;
 
-        if (![aValue conformsToProtocol:@protocol(NSCoding)]) {
+        if (![NSJSONSerialization isOfSerializableType:aValue]) {
+            NSString *className = NSStringFromClass([aValue class]);
 #ifdef DEBUG
-            NSAssert(FALSE, @"key `%@` doesn't conform to NSCoding and can't be serialized for delivery.", key);
+            NSAssert(FALSE, @"key `%@` is a %@ and can't be serialized for delivery.", key, className);
 #else
-            SEGLog(@"key `%@` doesn't conform to NSCoding and can't be serialized for delivery.", key);
+            SEGLog(@"key `%@` is a %@ and can't be serializaed for delivery.", key, className);
             // simply leave it out since we can't encode it anyway.
             continue;
 #endif
@@ -617,16 +632,17 @@ -(id)serializableDeepCopy:(BOOL)mutable
     for (id aValue in self) {
         id theCopy = nil;
 
-        if (![aValue conformsToProtocol:@protocol(NSCoding)]) {
+        if (![NSJSONSerialization isOfSerializableType:aValue]) {
+            NSString *className = NSStringFromClass([aValue class]);
 #ifdef DEBUG
-            NSAssert(FALSE, @"type `%@` doesn't conform to NSCoding and can't be serialized for delivery.", NSStringFromClass([aValue class]));
+            NSAssert(FALSE, @"found a %@ which can't be serialized for delivery.", className);
 #else
-            SEGLog(@"type `%@` doesn't conform to NSCoding and can't be serialized for delivery.", NSStringFromClass([aValue class]));
+            SEGLog(@"found a %@ which can't be serializaed for delivery.", className);
             // simply leave it out since we can't encode it anyway.
             continue;
 #endif
         }
-        
+
         if ([aValue conformsToProtocol:@protocol(SEGSerializableDeepCopy)]) {
             theCopy = [aValue serializableDeepCopy:mutable];
         } else if ([aValue conformsToProtocol:@protocol(NSCopying)]) {

AnalyticsTests/SerializationTests.m

@@ -9,6 +9,10 @@
 #import <XCTest/XCTest.h>
 @import Analytics;
 
+@interface NSJSONSerialization (Serializable)
++ (BOOL)isOfSerializableType:(id)obj;
+@end
+
 @protocol SEGSerializableDeepCopy <NSObject>
 -(id _Nullable) serializableDeepCopy;
 @end
@@ -52,4 +56,20 @@ - (void)testDeepCopyAndConformance {
     XCTAssertThrows([nonserializable serializableDeepCopy]);
 }
 
+- (void)testDateIssue {
+    NSDate *date = [NSDate date];
+    NSString *test = @"test";
+
+    XCTAssertFalse([NSJSONSerialization isOfSerializableType:date]);
+    XCTAssertTrue([NSJSONSerialization isOfSerializableType:test]);
+
+    NSDictionary *nonserializable = @{@"test": date};
+    NSDictionary *serializable = @{@"test": @1};
+    XCTAssertThrows([nonserializable serializableDeepCopy]);
+    XCTAssertNoThrow([serializable serializableDeepCopy]);
+    
+    nonserializable = @{@"test": @[date]};
+    XCTAssertThrows([nonserializable serializableDeepCopy]);
+}
+
 @end

Podfile.lock

@@ -13,4 +13,4 @@ SPEC CHECKSUMS:
 
 PODFILE CHECKSUM: b1320b7107926418d81b6d48a9c864abdf9c3eaf
 
-COCOAPODS: 1.9.3
+COCOAPODS: 1.9.1