Fix deprecation warnings by consolidating coding calls (#5131)

mikehaney24 · web-flow · commit 4ee328874744 · 2020-03-17T19:06:05.000-07:00
* Fix deprecation warnings by consolidating coding calls Fixes #5086 * Fix all NSSecureCoding references * Fix changed API usage
diff --git a/GoogleDataTransport/GDTCORLibrary/GDTCORPlatform.m b/GoogleDataTransport/GDTCORLibrary/GDTCORPlatform.m
@@ -93,7 +93,8 @@ GDTCORNetworkMobileSubtype GDTCORNetworkMobileSubTypeMessage() {
   if (networkCurrentRadioAccessTechnologyDict.count) {
     networkCurrentRadioAccessTechnology = networkCurrentRadioAccessTechnologyDict.allValues[0];
   }
-#else
+#else  // TARGET_OS_MACCATALYST
+#if defined(__IPHONE_12_0) && __IPHONE_OS_VERSION_MAX_ALLOWED >= 120000
   if (@available(iOS 12.0, *)) {
     NSDictionary<NSString *, NSString *> *networkCurrentRadioAccessTechnologyDict =
         networkInfo.serviceCurrentRadioAccessTechnology;
@@ -103,9 +104,11 @@ GDTCORNetworkMobileSubtype GDTCORNetworkMobileSubTypeMessage() {
       networkCurrentRadioAccessTechnology = networkCurrentRadioAccessTechnologyDict.allValues[0];
     }
   } else {
-    networkCurrentRadioAccessTechnology = networkInfo.currentRadioAccessTechnology;
+#else   // defined(__IPHONE_12_0) && __IPHONE_OS_VERSION_MAX_ALLOWED >= 120000
+  networkCurrentRadioAccessTechnology = networkInfo.currentRadioAccessTechnology;
+#endif  // // defined(__IPHONE_12_0) && __IPHONE_OS_VERSION_MAX_ALLOWED >= 120000
   }
-#endif
+#endif  // TARGET_OS_MACCATALYST
   if (networkCurrentRadioAccessTechnology) {
     NSNumber *networkMobileSubtype =
         CTRadioAccessTechnologyToNetworkSubTypeMessage[networkCurrentRadioAccessTechnology];
@@ -118,6 +121,80 @@ GDTCORNetworkMobileSubtype GDTCORNetworkMobileSubTypeMessage() {
 #endif
 }
 
+NSData *_Nullable GDTCOREncodeArchive(id<NSSecureCoding> obj,
+                                      NSString *archivePath,
+                                      NSError *_Nullable *error) {
+  NSData *resultData;
+#if (defined(__IPHONE_11_0) && __IPHONE_OS_VERSION_MAX_ALLOWED >= 110000) || \
+    (defined(__MAC_10_13) && MAC_OS_X_VERSION_MAX_ALLOWED >= 101300) ||      \
+    (defined(__TVOS_11_0) && __TV_OS_VERSION_MAX_ALLOWED >= 110000) ||       \
+    (defined(__WATCHOS_4_0) && __WATCH_OS_VERSION_MAX_ALLOWED >= 040000) ||  \
+    (defined(TARGET_OS_MACCATALYST) && TARGET_OS_MACCATALYST)
+  if (@available(macOS 10.13, iOS 11.0, tvOS 11.0, watchOS 4, *)) {
+    resultData = [NSKeyedArchiver archivedDataWithRootObject:obj
+                                       requiringSecureCoding:YES
+                                                       error:error];
+    BOOL result = [resultData writeToFile:archivePath atomically:YES];
+    result = result;  // To get rid of the warning.
+    GDTCORLogDebug(@"Attempt to write archive. successful:%@ path:%@", result, archivePath);
+  } else {
+#endif
+    BOOL result = NO;
+    @try {
+#pragma clang diagnostic push
+#pragma clang diagnostic ignored "-Wdeprecated-declarations"
+      resultData = [NSKeyedArchiver archivedDataWithRootObject:obj];
+#pragma clang diagnostic pop
+      result = [resultData writeToFile:archivePath atomically:YES];
+    } @catch (NSException *exception) {
+      NSString *errorString =
+          [NSString stringWithFormat:@"An exception was thrown during encoding: %@", exception];
+      *error = [NSError errorWithDomain:NSCocoaErrorDomain
+                                   code:-1
+                               userInfo:@{NSLocalizedFailureReasonErrorKey : errorString}];
+    }
+    GDTCORLogDebug(@"Attempt to write archive. successful:%@ path:%@", result, archivePath);
+  }
+  return resultData;
+}
+
+id<NSSecureCoding> _Nullable GDTCORDecodeArchive(Class archiveClass,
+                                                 NSString *_Nullable archivePath,
+                                                 NSData *_Nullable archiveData,
+                                                 NSError *_Nullable *error) {
+  id<NSSecureCoding> unarchivedObject = nil;
+#if (defined(__IPHONE_11_0) && __IPHONE_OS_VERSION_MAX_ALLOWED >= 110000) || \
+    (defined(__MAC_10_13) && MAC_OS_X_VERSION_MAX_ALLOWED >= 101300) ||      \
+    (defined(__TVOS_11_0) && __TV_OS_VERSION_MAX_ALLOWED >= 110000) ||       \
+    (defined(__WATCHOS_4_0) && __WATCH_OS_VERSION_MAX_ALLOWED >= 040000) ||  \
+    (defined(TARGET_OS_MACCATALYST) && TARGET_OS_MACCATALYST)
+  if (@available(macOS 10.13, iOS 11.0, tvOS 11.0, watchOS 4, *)) {
+    NSData *data = archiveData ? archiveData : [NSData dataWithContentsOfFile:archivePath];
+    if (data) {
+      unarchivedObject = [NSKeyedUnarchiver unarchivedObjectOfClass:archiveClass
+                                                           fromData:data
+                                                              error:error];
+    }
+  } else {
+#endif
+    @try {
+      NSData *archivedData =
+          archiveData ? archiveData : [NSData dataWithContentsOfFile:archivePath];
+#pragma clang diagnostic push
+#pragma clang diagnostic ignored "-Wdeprecated-declarations"
+      unarchivedObject = [NSKeyedUnarchiver unarchiveObjectWithData:archivedData];
+#pragma clang diagnostic pop
+    } @catch (NSException *exception) {
+      NSString *errorString =
+          [NSString stringWithFormat:@"An exception was thrown during encoding: %@", exception];
+      *error = [NSError errorWithDomain:NSCocoaErrorDomain
+                                   code:-1
+                               userInfo:@{NSLocalizedFailureReasonErrorKey : errorString}];
+    }
+  }
+  return unarchivedObject;
+}
+
 @interface GDTCORApplication ()
 /**
  Private flag to match the existing `readonly` public flag. This will be accurate for all platforms,
diff --git a/GoogleDataTransport/GDTCORLibrary/GDTCORStorage.m b/GoogleDataTransport/GDTCORLibrary/GDTCORStorage.m
@@ -129,16 +129,10 @@ - (void)storeEvent:(GDTCOREvent *)event
     // Write state to disk if we're in the background.
     if ([[GDTCORApplication sharedApplication] isRunningInBackground]) {
       GDTCORLogDebug("%@", @"Saving storage state because the app is running in the background");
-      if (@available(macOS 10.13, iOS 11.0, tvOS 11.0, *)) {
-        NSError *error;
-        NSData *data = [NSKeyedArchiver archivedDataWithRootObject:self
-                                             requiringSecureCoding:YES
-                                                             error:&error];
-        [data writeToFile:[GDTCORStorage archivePath] atomically:YES];
-      } else {
-#if !TARGET_OS_MACCATALYST && !TARGET_OS_WATCH
-        [NSKeyedArchiver archiveRootObject:self toFile:[GDTCORStorage archivePath]];
-#endif
+      NSError *error;
+      GDTCOREncodeArchive(self, [GDTCORStorage archivePath], &error);
+      if (error) {
+        GDTCORLogDebug(@"Serializing GDTCORStorage to an archive failed: %@", error);
       }
     }
 
@@ -227,16 +221,10 @@ - (void)addEventToTrackingCollections:(GDTCOREvent *)event {
 #pragma mark - GDTCORLifecycleProtocol
 
 - (void)appWillForeground:(GDTCORApplication *)app {
-  if (@available(macOS 10.13, iOS 11.0, tvOS 11.0, *)) {
-    NSError *error;
-    NSData *data = [NSData dataWithContentsOfFile:[GDTCORStorage archivePath]];
-    if (data) {
-      [NSKeyedUnarchiver unarchivedObjectOfClass:[GDTCORStorage class] fromData:data error:&error];
-    }
-  } else {
-#if !TARGET_OS_MACCATALYST && !TARGET_OS_WATCH
-    [NSKeyedUnarchiver unarchiveObjectWithFile:[GDTCORStorage archivePath]];
-#endif
+  NSError *error;
+  GDTCORDecodeArchive([GDTCORStorage class], [GDTCORStorage archivePath], nil, &error);
+  if (error) {
+    GDTCORLogDebug(@"Deserializing GDTCORStorage from an archive failed: %@", error);
   }
 }
 
@@ -250,17 +238,10 @@ - (void)appWillBackground:(GDTCORApplication *)app {
                          [app endBackgroundTask:bgID];
                          bgID = GDTCORBackgroundIdentifierInvalid;
                        }];
-
-    if (@available(macOS 10.13, iOS 11.0, tvOS 11.0, *)) {
-      NSError *error;
-      NSData *data = [NSKeyedArchiver archivedDataWithRootObject:self
-                                           requiringSecureCoding:YES
-                                                           error:&error];
-      [data writeToFile:[GDTCORStorage archivePath] atomically:YES];
-    } else {
-#if !TARGET_OS_MACCATALYST && !TARGET_OS_WATCH
-      [NSKeyedArchiver archiveRootObject:self toFile:[GDTCORStorage archivePath]];
-#endif
+    NSError *error;
+    GDTCOREncodeArchive(self, [GDTCORStorage archivePath], &error);
+    if (error) {
+      GDTCORLogDebug(@"Serializing GDTCORStorage to an archive failed: %@", error);
     }
 
     // End the background task if it's still valid.
@@ -271,16 +252,10 @@ - (void)appWillBackground:(GDTCORApplication *)app {
 
 - (void)appWillTerminate:(GDTCORApplication *)application {
   dispatch_sync(_storageQueue, ^{
-    if (@available(macOS 10.13, iOS 11.0, tvOS 11.0, *)) {
-      NSError *error;
-      NSData *data = [NSKeyedArchiver archivedDataWithRootObject:self
-                                           requiringSecureCoding:YES
-                                                           error:&error];
-      [data writeToFile:[GDTCORStorage archivePath] atomically:YES];
-    } else {
-#if !TARGET_OS_MACCATALYST && !TARGET_OS_WATCH
-      [NSKeyedArchiver archiveRootObject:self toFile:[GDTCORStorage archivePath]];
-#endif
+    NSError *error;
+    GDTCOREncodeArchive(self, [GDTCORStorage archivePath], &error);
+    if (error) {
+      GDTCORLogDebug(@"Serializing GDTCORStorage to an archive failed: %@", error);
     }
   });
 }
diff --git a/GoogleDataTransport/GDTCORLibrary/GDTCORUploadCoordinator.m b/GoogleDataTransport/GDTCORLibrary/GDTCORUploadCoordinator.m
@@ -177,9 +177,10 @@ - (instancetype)initWithCoder:(NSCoder *)aDecoder {
   GDTCORUploadCoordinator *sharedCoordinator = [GDTCORUploadCoordinator sharedInstance];
   dispatch_sync(sharedCoordinator->_coordinationQueue, ^{
     @try {
+      NSSet *classes =
+          [NSSet setWithObjects:[NSMutableDictionary class], [GDTCORUploadPackage class], nil];
       sharedCoordinator->_targetToInFlightPackages =
-          [aDecoder decodeObjectOfClass:[NSMutableDictionary class]
-                                 forKey:ktargetToInFlightPackagesKey];
+          [aDecoder decodeObjectOfClasses:classes forKey:ktargetToInFlightPackagesKey];
 
     } @catch (NSException *exception) {
       sharedCoordinator->_targetToInFlightPackages = [NSMutableDictionary dictionary];
diff --git a/GoogleDataTransport/GDTCORLibrary/Public/GDTCORPlatform.h b/GoogleDataTransport/GDTCORLibrary/Public/GDTCORPlatform.h
@@ -88,6 +88,30 @@ GDTCORNetworkType GDTCORNetworkTypeMessage(void);
  */
 GDTCORNetworkMobileSubtype GDTCORNetworkMobileSubTypeMessage(void);
 
+/** Writes the given object to the given fileURL and populates the given error if it fails.
+ *
+ * @param obj The object to encode.
+ * @param filePath The path to write the object to. Can be nil if you just need the data.
+ * @param error The error to populate if something goes wrong.
+ * @return The data of the archive. If error is nil, it's been written to disk.
+ */
+NSData *_Nullable GDTCOREncodeArchive(id<NSSecureCoding> obj,
+                                      NSString *_Nullable filePath,
+                                      NSError *_Nullable *error);
+
+/** Decodes an object of the given class from the given archive path or data and populates the given
+ * error if it fails.
+ *
+ * @param archiveClass The class of the archive's root object.
+ * @param archivePath The path to the archived data. Don't use with the archiveData param.
+ * @param archiveData The data to decode. Don't use with the archivePath param.
+ * @param error The error to populate if something goes wrong.
+ */
+id<NSSecureCoding> _Nullable GDTCORDecodeArchive(Class archiveClass,
+                                                 NSString *_Nullable archivePath,
+                                                 NSData *_Nullable archiveData,
+                                                 NSError *_Nullable *error);
+
 /** A typedef identify background identifiers. */
 typedef volatile NSUInteger GDTCORBackgroundIdentifier;
 
diff --git a/GoogleDataTransport/GDTCORTests/Unit/GDTCORClockTest.m b/GoogleDataTransport/GDTCORTests/Unit/GDTCORClockTest.m
@@ -17,6 +17,7 @@
 #import "GDTCORTests/Unit/GDTCORTestCase.h"
 
 #import "GDTCORLibrary/Public/GDTCORClock.h"
+#import "GDTCORLibrary/Public/GDTCORPlatform.h"
 
 @interface GDTCORClockTest : GDTCORTestCase
 
@@ -51,20 +52,16 @@ - (void)testSupportsSecureEncoding {
 /** Tests encoding and decoding a clock using a keyed archiver. */
 - (void)testEncoding {
   GDTCORClock *clock = [GDTCORClock snapshot];
-  GDTCORClock *unarchivedClock;
-  if (@available(macOS 10.13, iOS 11.0, tvOS 11.0, *)) {
-    NSData *clockData = [NSKeyedArchiver archivedDataWithRootObject:clock
-                                              requiringSecureCoding:YES
-                                                              error:nil];
-    unarchivedClock = [NSKeyedUnarchiver unarchivedObjectOfClass:[GDTCORClock class]
-                                                        fromData:clockData
-                                                           error:nil];
-  } else {
-#if !TARGET_OS_MACCATALYST
-    NSData *clockData = [NSKeyedArchiver archivedDataWithRootObject:clock];
-    unarchivedClock = [NSKeyedUnarchiver unarchiveObjectWithData:clockData];
-#endif
-  }
+  NSError *error;
+  NSData *clockData = GDTCOREncodeArchive(clock, nil, &error);
+  XCTAssertNil(error);
+  XCTAssertNotNil(clockData);
+
+  error = nil;
+  GDTCORClock *unarchivedClock =
+      (GDTCORClock *)GDTCORDecodeArchive([GDTCORClock class], nil, clockData, &error);
+  XCTAssertNil(error);
+  XCTAssertNotNil(unarchivedClock);
   XCTAssertEqual([clock hash], [unarchivedClock hash]);
   XCTAssertEqualObjects(clock, unarchivedClock);
 }
diff --git a/GoogleDataTransport/GDTCORTests/Unit/GDTCOREventTest.m b/GoogleDataTransport/GDTCORTests/Unit/GDTCOREventTest.m
@@ -14,9 +14,11 @@
  * limitations under the License.
  */
 
-#import <GoogleDataTransport/GDTCORClock.h>
 #import <GoogleDataTransport/GDTCOREvent.h>
 
+#import <GoogleDataTransport/GDTCORClock.h>
+#import <GoogleDataTransport/GDTCORPlatform.h>
+
 #import "GDTCORTests/Unit/GDTCORTestCase.h"
 #import "GDTCORTests/Unit/Helpers/GDTCORDataObjectTesterClasses.h"
 
@@ -45,28 +47,18 @@ - (void)testArchiving {
   event.qosTier = GDTCOREventQoSTelemetry;
   event.clockSnapshot = clockSnapshot;
 
-  NSData *archiveData;
-  if (@available(macOS 10.13, iOS 11.0, tvOS 11.0, *)) {
-    archiveData = [NSKeyedArchiver archivedDataWithRootObject:event
-                                        requiringSecureCoding:YES
-                                                        error:nil];
-  } else {
-#if !TARGET_OS_MACCATALYST
-    archiveData = [NSKeyedArchiver archivedDataWithRootObject:event];
-#endif
-  }
+  NSError *error;
+  NSData *archiveData = GDTCOREncodeArchive(event, nil, &error);
+  XCTAssertNil(error);
+  XCTAssertNotNil(archiveData);
+
   // To ensure that all the objects being retained by the original event are dealloc'd.
   event = nil;
-  GDTCOREvent *decodedEvent;
-  if (@available(macOS 10.13, iOS 11.0, tvOS 11.0, *)) {
-    decodedEvent = [NSKeyedUnarchiver unarchivedObjectOfClass:[GDTCOREvent class]
-                                                     fromData:archiveData
-                                                        error:nil];
-  } else {
-#if !TARGET_OS_MACCATALYST
-    decodedEvent = [NSKeyedUnarchiver unarchiveObjectWithData:archiveData];
-#endif
-  }
+  error = nil;
+  GDTCOREvent *decodedEvent =
+      (GDTCOREvent *)GDTCORDecodeArchive([GDTCOREvent class], nil, archiveData, &error);
+  XCTAssertNil(error);
+  XCTAssertNotNil(decodedEvent);
   XCTAssertEqualObjects(decodedEvent.mappingID, @"testID");
   XCTAssertEqual(decodedEvent.target, 42);
   event.dataObject = [[GDTCORDataObjectTesterSimple alloc] initWithString:@"someData"];
diff --git a/GoogleDataTransport/GDTCORTests/Unit/GDTCORStorageTest.m b/GoogleDataTransport/GDTCORTests/Unit/GDTCORStorageTest.m
diff --git a/GoogleDataTransport/GDTCORTests/Unit/GDTCORUploadCoordinatorTest.m b/GoogleDataTransport/GDTCORTests/Unit/GDTCORUploadCoordinatorTest.m
diff --git a/GoogleDataTransportCCTSupport/GDTCCTLibrary/GDTCCTPrioritizer.m b/GoogleDataTransportCCTSupport/GDTCCTLibrary/GDTCCTPrioritizer.m
