Crashlytics SDK: use Firebase Installations instead of Instance ID (#4954)

maksymmalyhin · web-flow · commit d820aad3fb8c · 2020-02-24T10:46:09.000-05:00
* WIP

* Replace Instance ID by FIS

* Crashlytics podspec: replace FirebaseInstanceID by FirebaseInstallations

* Run  ./scripts/style.sh

* Cleanup and copyright update.
diff --git a/Crashlytics/Crashlytics/Controllers/FIRCLSReportManager.h b/Crashlytics/Crashlytics/Controllers/FIRCLSReportManager.h
@@ -25,13 +25,13 @@ NS_ASSUME_NONNULL_BEGIN
 @class FIRCLSFileManager;
 @class FIRCLSInternalReport;
 @class FIRCLSSettings;
-@class FIRInstanceID;
+@class FIRInstallations;
 @protocol FIRAnalyticsInterop;
 
 @interface FIRCLSReportManager : NSObject
 
 - (instancetype)initWithFileManager:(FIRCLSFileManager *)fileManager
-                         instanceID:(FIRInstanceID *)instanceID
+                      installations:(FIRInstallations *)installations
                           analytics:(nullable id<FIRAnalyticsInterop>)analytics
                         googleAppID:(NSString *)googleAppID
                         dataArbiter:(FIRCLSDataCollectionArbiter *)dataArbiter
diff --git a/Crashlytics/Crashlytics/Controllers/FIRCLSReportManager.m b/Crashlytics/Crashlytics/Controllers/FIRCLSReportManager.m
@@ -164,7 +164,7 @@ @implementation FIRCLSReportManager
 static void (^reportSentCallback)(void);
 
 - (instancetype)initWithFileManager:(FIRCLSFileManager *)fileManager
-                         instanceID:(FIRInstanceID *)instanceID
+                      installations:(FIRInstallations *)installations
                           analytics:(id<FIRAnalyticsInterop>)analytics
                         googleAppID:(NSString *)googleAppID
                         dataArbiter:(FIRCLSDataCollectionArbiter *)dataArbiter {
@@ -196,7 +196,7 @@ - (instancetype)initWithFileManager:(FIRCLSFileManager *)fileManager
   _checkForUnsentReportsCalled = NO;
 
   _appIDModel = [[FIRCLSApplicationIdentifierModel alloc] init];
-  _installIDModel = [[FIRCLSInstallIdentifierModel alloc] initWithInstanceID:instanceID];
+  _installIDModel = [[FIRCLSInstallIdentifierModel alloc] initWithInstallations:installations];
   _executionIDModel = [[FIRCLSExecutionIdentifierModel alloc] init];
 
   _settings = [[FIRCLSSettings alloc] initWithFileManager:_fileManager appIDModel:_appIDModel];
diff --git a/Crashlytics/Crashlytics/FIRCrashlytics.m b/Crashlytics/Crashlytics/FIRCrashlytics.m
@@ -46,7 +46,7 @@
 #import <FirebaseCore/FIRDependency.h>
 #import <FirebaseCore/FIRLibrary.h>
 #import <FirebaseCore/FIROptionsInternal.h>
-#import <FirebaseInstanceID/FirebaseInstanceID.h>
+#import <FirebaseInstallations/FirebaseInstallations.h>
 
 #if TARGET_OS_IPHONE
 #import <UIKit/UIKit.h>
@@ -79,7 +79,7 @@ @implementation FIRCrashlytics
 
 - (instancetype)initWithApp:(FIRApp *)app
                     appInfo:(NSDictionary *)appInfo
-                 instanceID:(FIRInstanceID *)instanceID
+              installations:(FIRInstallations *)installations
                   analytics:(id<FIRAnalyticsInterop>)analytics {
   self = [super init];
 
@@ -101,7 +101,7 @@ - (instancetype)initWithApp:(FIRApp *)app
     _googleAppID = app.options.googleAppID;
     _dataArbiter = [[FIRCLSDataCollectionArbiter alloc] initWithApp:app withAppInfo:appInfo];
     _reportManager = [[FIRCLSReportManager alloc] initWithFileManager:_fileManager
-                                                           instanceID:instanceID
+                                                        installations:installations
                                                             analytics:analytics
                                                           googleAppID:_googleAppID
                                                           dataArbiter:_dataArbiter];
@@ -151,13 +151,13 @@ + (void)load {
 
     id<FIRAnalyticsInterop> analytics = FIR_COMPONENT(FIRAnalyticsInterop, container);
 
-    FIRInstanceID *instanceID = FIRInstanceID.instanceID;
+    FIRInstallations *installations = [FIRInstallations installationsWithApp:container.app];
 
     *isCacheable = YES;
 
     return [[FIRCrashlytics alloc] initWithApp:container.app
                                        appInfo:NSBundle.mainBundle.infoDictionary
-                                    instanceID:instanceID
+                                 installations:installations
                                      analytics:analytics];
   };
 
diff --git a/Crashlytics/Crashlytics/Models/FIRCLSInstallIdentifierModel.h b/Crashlytics/Crashlytics/Models/FIRCLSInstallIdentifierModel.h
@@ -14,7 +14,7 @@
 
 #import <Foundation/Foundation.h>
 
-@class FIRInstanceID;
+@class FIRInstallations;
 
 NS_ASSUME_NONNULL_BEGIN
 
@@ -25,7 +25,7 @@ NS_ASSUME_NONNULL_BEGIN
 
 - (instancetype)init NS_UNAVAILABLE;
 
-- (instancetype)initWithInstanceID:(FIRInstanceID *)instanceID NS_DESIGNATED_INITIALIZER;
+- (instancetype)initWithInstallations:(FIRInstallations *)instanceID NS_DESIGNATED_INITIALIZER;
 
 /**
  * Returns the backwards compatible Crashlytics Installation UUID
diff --git a/Crashlytics/Crashlytics/Models/FIRCLSInstallIdentifierModel.m b/Crashlytics/Crashlytics/Models/FIRCLSInstallIdentifierModel.m
@@ -14,7 +14,7 @@
 
 #import "FIRCLSInstallIdentifierModel.h"
 
-#import <FirebaseInstanceID/FIRInstanceID.h>
+#import <FirebaseInstallations/FirebaseInstallations.h>
 
 #import "FIRCLSByteUtility.h"
 #import "FIRCLSLogger.h"
@@ -31,7 +31,7 @@ @interface FIRCLSInstallIdentifierModel ()
 
 @property(nonatomic, copy) NSString *installID;
 
-@property(nonatomic, readonly) FIRInstanceID *instanceID;
+@property(nonatomic, readonly) FIRInstallations *installations;
 
 @end
 
@@ -41,15 +41,15 @@ @implementation FIRCLSInstallIdentifierModel
 // overridden setters and getters
 @synthesize installID = _installID;
 
-- (instancetype)initWithInstanceID:(FIRInstanceID *)instanceID {
+- (instancetype)initWithInstallations:(FIRInstallations *)installations {
   self = [super init];
   if (!self) {
     return nil;
   }
 
   // capture the install ID information
   _installID = [self readInstallationUUID].copy;
-  _instanceID = instanceID;
+  _installations = installations;
 
   if (!_installID) {
     FIRCLSDebugLog(@"Generating Install ID");
@@ -103,12 +103,13 @@ - (NSString *)generateInstallationUUID {
  */
 - (void)regenerateInstallIDIfNeededWithBlock:(void (^)(BOOL didRotate))callback {
   // This callback is on the main thread
-  [self.instanceID getIDWithHandler:^(NSString *_Nullable currentIID, NSError *_Nullable error) {
-    dispatch_async(dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_HIGH, 0), ^{
-      BOOL didRotate = [self rotateCrashlyticsInstallUUIDWithIID:currentIID error:error];
-      callback(didRotate);
-    });
-  }];
+  [self.installations
+      installationIDWithCompletion:^(NSString *_Nullable currentIID, NSError *_Nullable error) {
+        dispatch_async(dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_HIGH, 0), ^{
+          BOOL didRotate = [self rotateCrashlyticsInstallUUIDWithIID:currentIID error:error];
+          callback(didRotate);
+        });
+      }];
 }
 
 - (BOOL)rotateCrashlyticsInstallUUIDWithIID:(NSString *_Nullable)currentIID
diff --git a/Crashlytics/UnitTests/FIRCLSInstallIdentifierModelTests.m b/Crashlytics/UnitTests/FIRCLSInstallIdentifierModelTests.m
@@ -17,7 +17,7 @@
 #import <XCTest/XCTest.h>
 
 #import "FIRCLSUserDefaults.h"
-#import "FIRMockInstanceID.h"
+#import "FIRMockInstallations.h"
 
 static NSString *const FABInstallationUUIDKey = @"com.crashlytics.iuuid";
 static NSString *const FABInstallationADIDKey = @"com.crashlytics.install.adid";
@@ -66,21 +66,21 @@ - (BOOL)blockOnRegeneration:(FIRCLSInstallIdentifierModel *)model {
 }
 
 - (void)testCreateUUID {
-  FIRMockInstanceID *iid = [[FIRMockInstanceID alloc] initWithIID:@"test_instance_id"];
+  FIRMockInstallations *iid = [[FIRMockInstallations alloc] initWithFID:@"test_instance_id"];
 
   FIRCLSInstallIdentifierModel *model =
-      [[FIRCLSInstallIdentifierModel alloc] initWithInstanceID:iid];
+      [[FIRCLSInstallIdentifierModel alloc] initWithInstallations:iid];
   XCTAssertNotNil(model.installID);
 
   XCTAssertEqualObjects([_defaults objectForKey:FABInstallationUUIDKey], model.installID);
   XCTAssertNil([_defaults objectForKey:FABInstallationADIDKey]);
 }
 
 - (void)testCreateUUIDAndRotate {
-  FIRMockInstanceID *iid = [[FIRMockInstanceID alloc] initWithIID:@"test_instance_id"];
+  FIRMockInstallations *iid = [[FIRMockInstallations alloc] initWithFID:@"test_instance_id"];
 
   FIRCLSInstallIdentifierModel *model =
-      [[FIRCLSInstallIdentifierModel alloc] initWithInstanceID:iid];
+      [[FIRCLSInstallIdentifierModel alloc] initWithInstallations:iid];
   XCTAssertNotNil(model.installID);
 
   BOOL didRotate = [self blockOnRegeneration:model];
@@ -94,10 +94,10 @@ - (void)testCreateUUIDAndRotate {
 
 - (void)testCreateUUIDAndErrorGettingInstanceID {
   NSError *fakeError = [NSError errorWithDomain:NSCocoaErrorDomain code:-1 userInfo:@{}];
-  FIRMockInstanceID *iid = [[FIRMockInstanceID alloc] initWithError:fakeError];
+  FIRMockInstallations *iid = [[FIRMockInstallations alloc] initWithError:fakeError];
 
   FIRCLSInstallIdentifierModel *model =
-      [[FIRCLSInstallIdentifierModel alloc] initWithInstanceID:iid];
+      [[FIRCLSInstallIdentifierModel alloc] initWithInstallations:iid];
   XCTAssertNotNil(model.installID);
 
   BOOL didRotate = [self blockOnRegeneration:model];
@@ -109,10 +109,10 @@ - (void)testCreateUUIDAndErrorGettingInstanceID {
 }
 
 - (void)testCreateUUIDNoIID {
-  FIRMockInstanceID *iid = [[FIRMockInstanceID alloc] initWithIID:nil];
+  FIRMockInstallations *iid = [[FIRMockInstallations alloc] initWithFID:nil];
 
   FIRCLSInstallIdentifierModel *model =
-      [[FIRCLSInstallIdentifierModel alloc] initWithInstanceID:iid];
+      [[FIRCLSInstallIdentifierModel alloc] initWithInstallations:iid];
   XCTAssertNotNil(model.installID);
 
   XCTAssertEqualObjects([_defaults objectForKey:FABInstallationUUIDKey], model.installID);
@@ -126,9 +126,9 @@ - (void)testIIDBecomesNil {
   [_defaults setObject:@"old_instance_id" forKey:FIRCLSInstallationIIDHashKey];
 
   // Initialize the model with the a nil IID.
-  FIRMockInstanceID *iid = [[FIRMockInstanceID alloc] initWithIID:nil];
+  FIRMockInstallations *iid = [[FIRMockInstallations alloc] initWithFID:nil];
   FIRCLSInstallIdentifierModel *model =
-      [[FIRCLSInstallIdentifierModel alloc] initWithInstanceID:iid];
+      [[FIRCLSInstallIdentifierModel alloc] initWithInstallations:iid];
   XCTAssertNotNil(model.installID);
 
   // Test that the UUID did not change. The FIID can be nil if
@@ -144,9 +144,9 @@ - (void)testIIDChanges {
   [_defaults setObject:@"old_instance_id" forKey:FIRCLSInstallationIIDHashKey];
 
   // Initialize the model with the a new IID.
-  FIRMockInstanceID *iid = [[FIRMockInstanceID alloc] initWithIID:@"new_instance_id"];
+  FIRMockInstallations *iid = [[FIRMockInstallations alloc] initWithFID:@"new_instance_id"];
   FIRCLSInstallIdentifierModel *model =
-      [[FIRCLSInstallIdentifierModel alloc] initWithInstanceID:iid];
+      [[FIRCLSInstallIdentifierModel alloc] initWithInstallations:iid];
   XCTAssertNotNil(model.installID);
 
   BOOL didRotate = [self blockOnRegeneration:model];
@@ -166,9 +166,9 @@ - (void)testIIDDoesntChange {
   [_defaults setObject:FIRCLSTestHashOfTestInstanceID forKey:FIRCLSInstallationIIDHashKey];
 
   // Initialize the model with the a new IID.
-  FIRMockInstanceID *iid = [[FIRMockInstanceID alloc] initWithIID:@"test_instance_id"];
+  FIRMockInstallations *iid = [[FIRMockInstallations alloc] initWithFID:@"test_instance_id"];
   FIRCLSInstallIdentifierModel *model =
-      [[FIRCLSInstallIdentifierModel alloc] initWithInstanceID:iid];
+      [[FIRCLSInstallIdentifierModel alloc] initWithInstallations:iid];
   XCTAssertNotNil(model.installID);
 
   BOOL didRotate = [self blockOnRegeneration:model];
@@ -187,9 +187,9 @@ - (void)testUUIDSetButNeverIIDNilIID {
   [_defaults setObject:@"old_uuid" forKey:FABInstallationUUIDKey];
 
   // Initialize the model with the a nil IID.
-  FIRMockInstanceID *iid = [[FIRMockInstanceID alloc] initWithIID:nil];
+  FIRMockInstallations *iid = [[FIRMockInstallations alloc] initWithFID:nil];
   FIRCLSInstallIdentifierModel *model =
-      [[FIRCLSInstallIdentifierModel alloc] initWithInstanceID:iid];
+      [[FIRCLSInstallIdentifierModel alloc] initWithInstallations:iid];
   XCTAssertNotNil(model.installID);
 
   BOOL didRotate = [self blockOnRegeneration:model];
@@ -208,9 +208,9 @@ - (void)testUUIDSetButNeverIIDWithIID {
   [_defaults setObject:@"old_uuid" forKey:FABInstallationUUIDKey];
 
   // Initialize the model with the a nil IID.
-  FIRMockInstanceID *iid = [[FIRMockInstanceID alloc] initWithIID:@"test_instance_id"];
+  FIRMockInstallations *iid = [[FIRMockInstallations alloc] initWithFID:@"test_instance_id"];
   FIRCLSInstallIdentifierModel *model =
-      [[FIRCLSInstallIdentifierModel alloc] initWithInstanceID:iid];
+      [[FIRCLSInstallIdentifierModel alloc] initWithInstallations:iid];
   XCTAssertNotNil(model.installID);
 
   BOOL didRotate = [self blockOnRegeneration:model];
@@ -231,9 +231,9 @@ - (void)testADIDWasSetButNeverIID {
   [_defaults setObject:@"test_adid" forKey:FABInstallationADIDKey];
 
   // Initialize the model with the a new IID.
-  FIRMockInstanceID *iid = [[FIRMockInstanceID alloc] initWithIID:nil];
+  FIRMockInstallations *iid = [[FIRMockInstallations alloc] initWithFID:nil];
   FIRCLSInstallIdentifierModel *model =
-      [[FIRCLSInstallIdentifierModel alloc] initWithInstanceID:iid];
+      [[FIRCLSInstallIdentifierModel alloc] initWithInstallations:iid];
   XCTAssertNotNil(model.installID);
 
   BOOL didRotate = [self blockOnRegeneration:model];
@@ -252,9 +252,9 @@ - (void)testADIDWasSetAndIIDBecomesSet {
   [_defaults setObject:@"test_adid" forKey:FABInstallationADIDKey];
 
   // Initialize the model with the a new IID.
-  FIRMockInstanceID *iid = [[FIRMockInstanceID alloc] initWithIID:@"test_instance_id"];
+  FIRMockInstallations *iid = [[FIRMockInstallations alloc] initWithFID:@"test_instance_id"];
   FIRCLSInstallIdentifierModel *model =
-      [[FIRCLSInstallIdentifierModel alloc] initWithInstanceID:iid];
+      [[FIRCLSInstallIdentifierModel alloc] initWithInstallations:iid];
   XCTAssertNotNil(model.installID);
 
   BOOL didRotate = [self blockOnRegeneration:model];
@@ -275,9 +275,9 @@ - (void)testADIDAndIIDWereSet {
   [_defaults setObject:FIRCLSTestHashOfTestInstanceID forKey:FIRCLSInstallationIIDHashKey];
 
   // Initialize the model with the a new IID.
-  FIRMockInstanceID *iid = [[FIRMockInstanceID alloc] initWithIID:@"test_instance_id"];
+  FIRMockInstallations *iid = [[FIRMockInstallations alloc] initWithFID:@"test_instance_id"];
   FIRCLSInstallIdentifierModel *model =
-      [[FIRCLSInstallIdentifierModel alloc] initWithInstanceID:iid];
+      [[FIRCLSInstallIdentifierModel alloc] initWithInstallations:iid];
   XCTAssertNotNil(model.installID);
 
   BOOL didRotate = [self blockOnRegeneration:model];
@@ -298,9 +298,10 @@ - (void)testADIDAndIIDWereSet2 {
   [_defaults setObject:FIRCLSTestHashOfTestInstanceID forKey:FIRCLSInstallationIIDHashKey];
 
   // Initialize the model with the a new IID.
-  FIRMockInstanceID *iid = [[FIRMockInstanceID alloc] initWithIID:@"test_changed_instance_id"];
+  FIRMockInstallations *iid =
+      [[FIRMockInstallations alloc] initWithFID:@"test_changed_instance_id"];
   FIRCLSInstallIdentifierModel *model =
-      [[FIRCLSInstallIdentifierModel alloc] initWithInstanceID:iid];
+      [[FIRCLSInstallIdentifierModel alloc] initWithInstallations:iid];
   XCTAssertNotNil(model.installID);
 
   BOOL didRotate = [self blockOnRegeneration:model];
diff --git a/Crashlytics/UnitTests/FIRCLSReportManagerTests.m b/Crashlytics/UnitTests/FIRCLSReportManagerTests.m
@@ -35,7 +35,7 @@
 #import "FIRCLSMockFileManager.h"
 #import "FIRCLSMockReportManager.h"
 #import "FIRCLSMockReportUploader.h"
-#import "FIRMockInstanceID.h"
+#import "FIRMockInstallations.h"
 
 #define TEST_API_KEY (@"DB5C8FA65C0D43419120FB96CFDBDE0C")
 #define TEST_GOOGLE_APP_ID (@"1:632950151350:ios:d5b0d08d4f00f4b1")
@@ -71,13 +71,13 @@ - (void)setUp {
   // Delete cached settings
   [self.fileManager removeItemAtPath:_fileManager.settingsFilePath];
 
-  FIRMockInstanceID *iid = [[FIRMockInstanceID alloc] initWithIID:@"test_token"];
+  FIRMockInstallations *iid = [[FIRMockInstallations alloc] initWithFID:@"test_token"];
 
   FABMockApplicationIdentifierModel *appIDModel = [[FABMockApplicationIdentifierModel alloc] init];
   appIDModel.bundleID = TEST_BUNDLE_ID;
 
   self.reportManager = [[FIRCLSMockReportManager alloc] initWithFileManager:self.fileManager
-                                                                 instanceID:iid
+                                                              installations:iid
                                                                   analytics:nil
                                                                 googleAppID:TEST_GOOGLE_APP_ID
                                                                 dataArbiter:self.dataArbiter
diff --git a/Crashlytics/UnitTests/Mocks/FIRCLSMockReportManager.h b/Crashlytics/UnitTests/Mocks/FIRCLSMockReportManager.h
@@ -23,15 +23,15 @@ NS_ASSUME_NONNULL_BEGIN
 @interface FIRCLSMockReportManager : FIRCLSReportManager
 
 - (instancetype)initWithFileManager:(FIRCLSFileManager *)fileManager
-                         instanceID:(FIRInstanceID *)instanceID
+                      installations:(FIRInstallations *)installations
                           analytics:(nullable id<FIRAnalyticsInterop>)analytics
                         googleAppID:(NSString *)googleAppID
                         dataArbiter:(FIRCLSDataCollectionArbiter *)dataArbiter
                          appIDModel:(FIRCLSApplicationIdentifierModel *)appIDModel
     NS_DESIGNATED_INITIALIZER;
 
 - (instancetype)initWithFileManager:(FIRCLSFileManager *)fileManager
-                         instanceID:(FIRInstanceID *)instanceID
+                      installations:(FIRInstallations *)instanceID
                           analytics:(nullable id<FIRAnalyticsInterop>)analytics
                         googleAppID:(NSString *)googleAppID
                         dataArbiter:(FIRCLSDataCollectionArbiter *)dataArbiter NS_UNAVAILABLE;
diff --git a/Crashlytics/UnitTests/Mocks/FIRCLSMockReportManager.m b/Crashlytics/UnitTests/Mocks/FIRCLSMockReportManager.m
@@ -34,13 +34,13 @@ @implementation FIRCLSMockReportManager
 @synthesize bundleIdentifier;
 
 - (instancetype)initWithFileManager:(FIRCLSFileManager *)fileManager
-                         instanceID:(FIRInstanceID *)instanceID
+                      installations:(FIRInstallations *)installations
                           analytics:(id<FIRAnalyticsInterop>)analytics
                         googleAppID:(nonnull NSString *)googleAppID
                         dataArbiter:(FIRCLSDataCollectionArbiter *)dataArbiter
                          appIDModel:(FIRCLSApplicationIdentifierModel *)appIDModel {
   self = [super initWithFileManager:fileManager
-                         instanceID:instanceID
+                      installations:installations
                           analytics:analytics
                         googleAppID:googleAppID
                         dataArbiter:dataArbiter];
diff --git a/Crashlytics/UnitTests/Mocks/FIRMockInstallations.h b/Crashlytics/UnitTests/Mocks/FIRMockInstallations.h
diff --git a/Crashlytics/UnitTests/Mocks/FIRMockInstallations.m b/Crashlytics/UnitTests/Mocks/FIRMockInstallations.m
diff --git a/Crashlytics/UnitTests/Mocks/FIRMockInstanceID.m b/Crashlytics/UnitTests/Mocks/FIRMockInstanceID.m
diff --git a/FirebaseCrashlytics.podspec b/FirebaseCrashlytics.podspec
