Migrate from using IID SDK for Remote Config to the new FIS SDK (#5096)

dmandar · maksymmalyhin · paulb777 · web-flow · commit 887ff82494df · 2020-03-16T18:16:12.000-07:00
* Update podspec to replace IID with installations SDK. * Update sample app podfile to include installations sdk. * Source code changes to support migration to FIS. The FIS SDK now supports multi-app FIS ids and tokens. * Update RC test app to use FIS SDK. * WIP: Unit tests for incorporating FIS with Remote Config. * Remote Config: fix Installations tests (#5109) * Fix Installations tests. * Fix Firebase/Auth version (#5106) * Remote Config: enable ARC for tests. * run ./scripts/style.sh * Fix warnings * Remote Config: enable ARC for tests. (#5108) * Remote Config: enable ARC for tests. * run ./scripts/style.sh * Fix warnings Co-authored-by: Paul Beusterien <paulbeusterien@google.com> * Add the installations token as an HTTP header. * Add changelog for FIS changes. Co-authored-by: Maksym Malyhin <mmaksym@google.com> Co-authored-by: Paul Beusterien <paulbeusterien@google.com>
diff --git a/FirebaseRemoteConfig.podspec b/FirebaseRemoteConfig.podspec
@@ -41,7 +41,7 @@ app update.
   s.dependency 'FirebaseAnalyticsInterop', '~> 1.4'
   s.dependency 'FirebaseABTesting', '~> 3.1'
   s.dependency 'FirebaseCore', '~> 6.2'
-  s.dependency 'FirebaseInstanceID', '~> 4.2'
+  s.dependency 'FirebaseInstallations', '~> 1.1'
   s.dependency 'GoogleUtilities/Environment', '~> 6.2'
   s.dependency 'GoogleUtilities/NSData+zlib', '~> 6.2'
   s.dependency 'Protobuf', '~> 3.9', '>= 3.9.2'
diff --git a/FirebaseRemoteConfig/CHANGELOG.md b/FirebaseRemoteConfig/CHANGELOG.md
@@ -1,3 +1,5 @@
+# v4.4.10
+- [changed] Internal code changes - migrate to using the FIS SDK. (#5096)
 # v4.4.9
 - [changed] Internal code changes. (#4934)
 # v4.4.8
diff --git a/FirebaseRemoteConfig/Sources/Private/RCNConfigSettings.h b/FirebaseRemoteConfig/Sources/Private/RCNConfigSettings.h
@@ -39,10 +39,10 @@
 @property(nonatomic, copy) NSString *secretToken;
 /// Device data version of checkin information.
 @property(nonatomic, copy) NSString *deviceDataVersion;
-/// InstanceID.
-@property(nonatomic, copy) NSString *configInstanceID;
-/// InstanceID token.
-@property(nonatomic, copy) NSString *configInstanceIDToken;
+/// InstallationsID.
+@property(nonatomic, copy) NSString *configInstallationsIdentifier;
+/// Installations token.
+@property(nonatomic, copy) NSString *configInstallationsToken;
 
 /// A list of successful fetch timestamps in milliseconds.
 /// TODO Not used anymore. Safe to remove.
diff --git a/FirebaseRemoteConfig/Sources/RCNConfigSettings.m b/FirebaseRemoteConfig/Sources/RCNConfigSettings.m
@@ -334,9 +334,9 @@ - (NSString *)nextRequestWithUserProperties:(NSDictionary *)userProperties {
   // Note: We only set user properties as mentioned in the new REST API Design doc
   NSString *ret = [NSString stringWithFormat:@"{"];
   ret = [ret stringByAppendingString:[NSString stringWithFormat:@"app_instance_id:'%@'",
-                                                                _configInstanceID]];
+                                                                _configInstallationsIdentifier]];
   ret = [ret stringByAppendingString:[NSString stringWithFormat:@", app_instance_id_token:'%@'",
-                                                                _configInstanceIDToken]];
+                                                                _configInstallationsToken]];
   ret = [ret stringByAppendingString:[NSString stringWithFormat:@", app_id:'%@'", _googleAppID]];
 
   ret = [ret stringByAppendingString:[NSString stringWithFormat:@", country_code:'%@'",
diff --git a/FirebaseRemoteConfig/Sources/RCNFetch.m b/FirebaseRemoteConfig/Sources/RCNFetch.m
@@ -16,10 +16,10 @@
 
 #import "FirebaseRemoteConfig/Sources/RCNConfigFetch.h"
 
+#import <FirebaseCore/FIRApp.h>
 #import <FirebaseCore/FIRLogger.h>
 #import <FirebaseCore/FIROptions.h>
-#import <FirebaseInstanceID/FIRInstanceID+Private.h>
-#import <FirebaseInstanceID/FIRInstanceIDCheckinPreferences.h>
+#import <FirebaseInstallations/FirebaseInstallations.h>
 #import <GoogleUtilities/GULNSData+zlib.h>
 #import "FirebaseRemoteConfig/Sources/Private/RCNConfigSettings.h"
 #import "FirebaseRemoteConfig/Sources/RCNConfigConstants.h"
@@ -40,7 +40,6 @@
 static NSString *const kServerURLQuery = @":fetch?";
 static NSString *const kServerURLKey = @"key=";
 static NSString *const kRequestJSONKeyAppID = @"app_id";
-static NSString *const kRequestJSONKeyAppInstanceID = @"app_instance_id";
 
 static NSString *const kHTTPMethodPost = @"POST";  ///< HTTP request method config fetch using
 static NSString *const kContentTypeHeaderName = @"Content-Type";  ///< HTTP Header Field Name
@@ -49,13 +48,13 @@
 static NSString *const kAcceptEncodingHeaderName = @"Accept-Encoding";  ///< HTTP Header Field Name
 static NSString *const kETagHeaderName = @"etag";                       ///< HTTP Header Field Name
 static NSString *const kIfNoneMatchETagHeaderName = @"if-none-match";   ///< HTTP Header Field Name
+static NSString *const kInstallationsAuthTokenHeaderName = @"x-goog-firebase-installations-auth";
 // Sends the bundle ID. Refer to b/130301479 for details.
 static NSString *const kiOSBundleIdentifierHeaderName =
     @"X-Ios-Bundle-Identifier";  ///< HTTP Header Field Name
 
 /// Config HTTP request content type proto buffer
 static NSString *const kContentTypeValueJSON = @"application/json";
-static NSString *const kInstanceIDScopeConfig = @"*";  /// InstanceID scope
 
 /// HTTP status codes. Ref: https://cloud.google.com/apis/design/errors#error_retries
 static NSInteger const kRCNFetchResponseHTTPStatusCodeOK = 200;
@@ -192,18 +191,22 @@ - (void)fetchConfigWithExpirationDuration:(NSTimeInterval)expirationDuration
                                          withError:error];
     }
     strongSelf->_settings.isFetchInProgress = YES;
-    [strongSelf refreshInstanceIDTokenAndFetchCheckInInfoWithCompletionHandler:completionHandler];
+    [strongSelf refreshInstallationsTokenWithCompletionHandler:completionHandler];
   });
 }
 
 #pragma mark - Fetch helpers
 
-/// Refresh instance ID token before fetching config. Instance ID is now mandatory for fetch
+- (NSString *)FIRAppNameFromFullyQualifiedNamespace {
+  return [[_FIRNamespace componentsSeparatedByString:@":"] lastObject];
+}
+/// Refresh installation ID token before fetching config. installation ID is now mandatory for fetch
 /// requests to work.(b/14751422).
-- (void)refreshInstanceIDTokenAndFetchCheckInInfoWithCompletionHandler:
+- (void)refreshInstallationsTokenWithCompletionHandler:
     (FIRRemoteConfigFetchCompletion)completionHandler {
-  FIRInstanceID *instanceID = [FIRInstanceID instanceID];
-  if (!_options.GCMSenderID) {
+  FIRInstallations *installations = [FIRInstallations
+      installationsWithApp:[FIRApp appNamed:[self FIRAppNameFromFullyQualifiedNamespace]]];
+  if (!installations || !_options.GCMSenderID) {
     NSString *errorDescription = @"Failed to get GCMSenderID";
     FIRLogError(kFIRLoggerRemoteConfig, @"I-RCN000074", @"%@",
                 [NSString stringWithFormat:@"%@", errorDescription]);
@@ -217,10 +220,11 @@ - (void)refreshInstanceIDTokenAndFetchCheckInInfoWithCompletionHandler:
                                                     NSLocalizedDescriptionKey : errorDescription
                                                   }]];
   }
-  FIRInstanceIDTokenHandler instanceIDHandler = ^(NSString *token, NSError *error) {
-    if (!token || error) {
+  FIRInstallationsTokenHandler installationsTokenHandler = ^(
+      FIRInstallationsAuthTokenResult *tokenResult, NSError *error) {
+    if (!tokenResult || !tokenResult.authToken || error) {
       NSString *errorDescription =
-          [NSString stringWithFormat:@"Failed to get InstanceID token. Error : %@.", error];
+          [NSString stringWithFormat:@"Failed to get installations token. Error : %@.", error];
       FIRLogError(kFIRLoggerRemoteConfig, @"I-RCN000073", @"%@",
                   [NSString stringWithFormat:@"%@", errorDescription]);
       self->_settings.isFetchInProgress = NO;
@@ -234,20 +238,21 @@ - (void)refreshInstanceIDTokenAndFetchCheckInInfoWithCompletionHandler:
                                                     }]];
     }
 
-    // If the token is available, try to get the instanceID.
+    // We have a valid token. Get the backing installationID.
     __weak RCNConfigFetch *weakSelf = self;
-    [instanceID getIDWithHandler:^(NSString *_Nullable identity, NSError *_Nullable error) {
+    [installations installationIDWithCompletion:^(NSString *_Nullable identifier,
+                                                  NSError *_Nullable error) {
       RCNConfigFetch *strongSelf = weakSelf;
 
       // Dispatch to the RC serial queue to update settings on the queue.
       dispatch_async(strongSelf->_lockQueue, ^{
         RCNConfigFetch *strongSelfQueue = weakSelf;
 
         // Update config settings with the IID and token.
-        strongSelfQueue->_settings.configInstanceIDToken = [token copy];
-        strongSelfQueue->_settings.configInstanceID = identity;
+        strongSelfQueue->_settings.configInstallationsToken = tokenResult.authToken;
+        strongSelfQueue->_settings.configInstallationsIdentifier = identifier;
 
-        if (!identity || error) {
+        if (!identifier || error) {
           NSString *errorDescription =
               [NSString stringWithFormat:@"Error getting iid : %@.", error];
           FIRLogError(kFIRLoggerRemoteConfig, @"I-RCN000055", @"%@",
@@ -265,56 +270,23 @@ - (void)refreshInstanceIDTokenAndFetchCheckInInfoWithCompletionHandler:
         }
 
         FIRLogInfo(kFIRLoggerRemoteConfig, @"I-RCN000022", @"Success to get iid : %@.",
-                   strongSelfQueue->_settings.configInstanceID);
-
-        // Continue the fetch regardless of whether fetch of instance ID succeeded.
-        [strongSelfQueue fetchCheckinInfoWithCompletionHandler:completionHandler];
+                   strongSelfQueue->_settings.configInstallationsIdentifier);
+        [strongSelf
+            getAnalyticsUserPropertiesWithCompletionHandler:^(NSDictionary *userProperties) {
+              dispatch_async(strongSelf->_lockQueue, ^{
+                [strongSelf fetchWithUserProperties:userProperties
+                                  completionHandler:completionHandler];
+              });
+            }];
       });
     }];
   };
-  FIRLogDebug(kFIRLoggerRemoteConfig, @"I-RCN000039", @"Starting requesting token.");
-  // Note: We expect the GCMSenderID to always be available by the time this request is made.
-  [instanceID tokenWithAuthorizedEntity:_options.GCMSenderID
-                                  scope:kInstanceIDScopeConfig
-                                options:nil
-                                handler:instanceIDHandler];
-}
 
-/// Fetch checkin info before fetching config. Checkin info including device authentication ID,
-/// secret token and device data version are optional fields in config request.
-- (void)fetchCheckinInfoWithCompletionHandler:(FIRRemoteConfigFetchCompletion)completionHandler {
-  FIRInstanceID *instanceID = [FIRInstanceID instanceID];
-  __weak RCNConfigFetch *weakSelf = self;
-  [instanceID fetchCheckinInfoWithHandler:^(FIRInstanceIDCheckinPreferences *preferences,
-                                            NSError *error) {
-    RCNConfigFetch *fetchCheckinInfoWithHandlerSelf = weakSelf;
-    dispatch_async(fetchCheckinInfoWithHandlerSelf->_lockQueue, ^{
-      RCNConfigFetch *strongSelf = fetchCheckinInfoWithHandlerSelf;
-      if (error) {
-        FIRLogError(kFIRLoggerRemoteConfig, @"I-RCN000023", @"Failed to fetch checkin info: %@.",
-                    error);
-      } else {
-        strongSelf->_settings.deviceAuthID = preferences.deviceID;
-        strongSelf->_settings.secretToken = preferences.secretToken;
-        strongSelf->_settings.deviceDataVersion = preferences.deviceDataVersion;
-        if (strongSelf->_settings.deviceAuthID.length && strongSelf->_settings.secretToken.length) {
-          FIRLogInfo(kFIRLoggerRemoteConfig, @"I-RCN000024",
-                     @"Success to get device authentication ID: %@, security token: %@.",
-                     self->_settings.deviceAuthID, self->_settings.secretToken);
-        }
-      }
-      // Checkin info is optional, continue fetch config regardless fetch of checkin info
-      // succeeded.
-      [strongSelf fetchWithUserPropertiesCompletionHandler:^(NSDictionary *userProperties) {
-        dispatch_async(strongSelf->_lockQueue, ^{
-          [strongSelf fetchWithUserProperties:userProperties completionHandler:completionHandler];
-        });
-      }];
-    });
-  }];
+  FIRLogDebug(kFIRLoggerRemoteConfig, @"I-RCN000039", @"Starting requesting token.");
+  [installations authTokenWithCompletion:installationsTokenHandler];
 }
 
-- (void)fetchWithUserPropertiesCompletionHandler:
+- (void)getAnalyticsUserPropertiesWithCompletionHandler:
     (FIRAInteropUserPropertiesCallback)completionHandler {
   FIRLogDebug(kFIRLoggerRemoteConfig, @"I-RCN000060", @"Fetch with user properties completed.");
   id<FIRAnalyticsInterop> analytics = self->_analytics;
@@ -590,6 +562,8 @@ - (NSURLSessionDataTask *)URLSessionDataTaskWithContent:(NSData *)content
                                timeoutInterval:timeoutInterval];
   URLRequest.HTTPMethod = kHTTPMethodPost;
   [URLRequest setValue:kContentTypeValueJSON forHTTPHeaderField:kContentTypeHeaderName];
+  [URLRequest setValue:_settings.configInstallationsToken
+      forHTTPHeaderField:kInstallationsAuthTokenHeaderName];
   [URLRequest setValue:[[NSBundle mainBundle] bundleIdentifier]
       forHTTPHeaderField:kiOSBundleIdentifierHeaderName];
   [URLRequest setValue:@"gzip" forHTTPHeaderField:kContentEncodingHeaderName];
diff --git a/FirebaseRemoteConfig/Tests/Sample/Podfile b/FirebaseRemoteConfig/Tests/Sample/Podfile
@@ -7,7 +7,6 @@ target 'RemoteConfigSampleApp' do
   pod 'FirebaseAnalytics'
   pod 'FirebaseCore', :path => '../../../'
   pod 'FirebaseInstallations', :path => '../../../'
-  pod 'FirebaseInstanceID', :path => '../../../'
   pod 'FirebaseRemoteConfig', :path => '../../../'
 
   # Pods for RemoteConfigSampleApp
diff --git a/FirebaseRemoteConfig/Tests/Sample/RemoteConfigSampleApp/ViewController.m b/FirebaseRemoteConfig/Tests/Sample/RemoteConfigSampleApp/ViewController.m
@@ -17,7 +17,7 @@
 #import <FirebaseAnalytics/FirebaseAnalytics.h>
 #import <FirebaseCore/FIROptions.h>
 #import <FirebaseCore/FirebaseCore.h>
-#import <FirebaseInstanceID/FIRInstanceID+Private.h>
+#import <FirebaseInstallations/FirebaseInstallations.h>
 #import <FirebaseRemoteConfig/FIRRemoteConfig_Private.h>
 #import <FirebaseRemoteConfig/FirebaseRemoteConfig.h>
 #import "FRCLog.h"
@@ -355,21 +355,19 @@ - (void)printResult:(NSMutableString *)output {
                            stringWithFormat:@"%@\n",
                                             [self statusString:currentRCInstance.lastFetchStatus]]];
 
-  FIRInstanceID *instanceID = [FIRInstanceID instanceID];
-  [instanceID getIDWithHandler:^(NSString *_Nullable identity, NSError *_Nullable error) {
-    [output appendString:@"\n-----------Instance ID------------------\n"];
-    [output appendString:[NSString stringWithFormat:@"%@\n", identity]];
+  FIRInstallations *installations = [FIRInstallations installations];
+  [installations installationIDWithCompletion:^(NSString *_Nullable identifier,
+                                                NSError *_Nullable error) {
+    [output appendString:@"\n-----------Installation ID------------------\n"];
+    [output appendString:[NSString stringWithFormat:@"%@\n", identifier]];
 
-    [output appendString:@"\n-----------Instance ID token------------\n"];
-    [output
-        appendString:[NSString stringWithFormat:@"%@\n",
-                                                currentRCInstance.settings.configInstanceIDToken]];
+    [output appendString:@"\n-----------Installation ID token------------\n"];
 
-    [output appendString:@"\n-----------Android ID------------\n"];
-    [output
-        appendString:[NSString stringWithFormat:@"%@\n", currentRCInstance.settings.deviceAuthID]];
-
-    [[FRCLog sharedInstance] logToConsole:output];
+    [installations authTokenWithCompletion:^(FIRInstallationsAuthTokenResult *_Nullable tokenResult,
+                                             NSError *_Nullable error) {
+      [output appendString:[NSString stringWithFormat:@"%@\n", tokenResult.authToken]];
+      [[FRCLog sharedInstance] logToConsole:output];
+    }];
   }];
 }
 
@@ -409,27 +407,28 @@ - (NSString *)errorString:(FIRRemoteConfigError)error {
 }
 
 - (IBAction)fetchIIDButtonClicked:(id)sender {
-  FIRInstanceID *instanceID = [FIRInstanceID instanceID];
-  FIRInstanceIDTokenHandler instanceIDHandler = ^(NSString *token, NSError *error) {
+  FIRInstallations *installations =
+      [FIRInstallations installationsWithApp:[FIRApp appNamed:self.FIRAppName]];
+  [installations installationIDWithCompletion:^(NSString *_Nullable identifier,
+                                                NSError *_Nullable error) {
     if (error) {
       [[FRCLog sharedInstance] logToConsole:[NSString stringWithFormat:@"%@", error]];
-    }
-    if (token) {
-      ((FIRRemoteConfig *)self.RCInstances[self.currentNamespace][self.FIRAppName])
-          .settings.configInstanceIDToken = token;
-      [instanceID getIDWithHandler:^(NSString *_Nullable identity, NSError *_Nullable error) {
-        [[FRCLog sharedInstance]
-            logToConsole:[NSString
-                             stringWithFormat:
-                                 @"Successfully getting InstanceID : \n\n%@\n\nToken : \n\n%@\n",
-                                 identity, token]];
+    } else {
+      [installations authTokenWithCompletion:^(
+                         FIRInstallationsAuthTokenResult *_Nullable tokenResult,
+                         NSError *_Nullable error) {
+        if (tokenResult.authToken) {
+          ((FIRRemoteConfig *)self.RCInstances[self.currentNamespace][self.FIRAppName])
+              .settings.configInstallationsToken = tokenResult.authToken;
+          [[FRCLog sharedInstance]
+              logToConsole:[NSString
+                               stringWithFormat:
+                                   @"Successfully got installation ID : \n\n%@\n\nToken : \n\n%@\n",
+                                   identifier, tokenResult.authToken]];
+        }
       }];
     }
-  };
-  [instanceID tokenWithAuthorizedEntity:[FIRApp appNamed:self.FIRAppName].options.GCMSenderID
-                                  scope:@"*"
-                                options:nil
-                                handler:instanceIDHandler];
+  }];
 }
 
 - (IBAction)searchButtonClicked:(id)sender {
diff --git a/FirebaseRemoteConfig/Tests/Unit/RCNInstanceIDTest.m b/FirebaseRemoteConfig/Tests/Unit/RCNInstanceIDTest.m

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+# v4.4.10`
	`2`	`+- [changed] Internal code changes - migrate to using the FIS SDK. (#5096)`
`1`	`3`	`# v4.4.9`
`2`	`4`	`- [changed] Internal code changes. (#4934)`
`3`	`5`	`# v4.4.8`