[Draft]Activate rollout metadata and send notification to Interop

FirebaseRemoteConfig/Sources/FIRRemoteConfig.m

@@ -45,6 +45,8 @@
 /// Notification when config is successfully activated
 const NSNotificationName FIRRemoteConfigActivateNotification =
     @"FIRRemoteConfigActivateNotification";
+static NSString *const RolloutsStateDidChangeNotificationName =
+    @"RolloutsStateDidChangeNotification";
 
 /// Listener for the get methods.
 typedef void (^FIRRemoteConfigListener)(NSString *_Nonnull, NSDictionary *_Nonnull);
@@ -326,9 +328,14 @@ - (void)activateWithCompletion:(FIRRemoteConfigActivateChangeCompletion)completi
                                           toSource:RCNDBSourceActive
                                       forNamespace:self->_FIRNamespace];
     strongSelf->_settings.lastApplyTimeInterval = [[NSDate date] timeIntervalSince1970];
+
     // New config has been activated at this point
     FIRLogDebug(kFIRLoggerRemoteConfig, @"I-RCN000069", @"Config activated.");
+    NSString *activeVersionNumber = [strongSelf->_settings updateLastActiveTemplateVersion];
     [strongSelf->_configContent activatePersonalization];
+    NSArray<NSDictionary *> *activeRolloutMetadata =
+        [strongSelf->_configContent activateRolloutMetdata];
+    [self notifyRolloutsStateChange:activeRolloutMetadata versionNumber:activeVersionNumber];
     // Update experiments only for 3p namespace
     NSString *namespace = [strongSelf->_FIRNamespace
         substringToIndex:[strongSelf->_FIRNamespace rangeOfString:@":"].location];
@@ -613,4 +620,51 @@ - (FIRConfigUpdateListenerRegistration *)addOnConfigUpdateListener:
   return [self->_configRealtime addConfigUpdateListener:listener];
 }
 
+#pragma mark - Rollout
+
+- (void)addRemoteConfigInteropSubscriber:(id<FIRRolloutsStateSubscriber>)subscriber {
+  [[NSNotificationCenter defaultCenter]
+      addObserverForName:RolloutsStateDidChangeNotificationName
+                  object:self
+                   queue:nil
+              usingBlock:^(NSNotification *_Nonnull notification) {
+                FIRRolloutsState *rolloutsState =
+                    notification.userInfo[RolloutsStateDidChangeNotificationName];
+                [subscriber rolloutsStateDidChange:rolloutsState];
+              }];
+}
+
+- (void)notifyRolloutsStateChange:(NSArray<NSDictionary *> *)rolloutMetadata
+                    versionNumber:(NSString *)versionNumber {
+  NSMutableArray<FIRRolloutAssignment *> *rolloutsAssignments = [[NSMutableArray alloc] init];
+  for (NSDictionary *metadata in rolloutMetadata) {
+    NSString *rolloutId = metadata[@"rollout_id"];
+    NSString *variantID = metadata[@"variant_id"];
+    NSArray<NSString *> *affectedParameterKeys = metadata[@"affected_parameter_keys"];
+    if (rolloutId && variantID && affectedParameterKeys) {
+      for (NSString *key in affectedParameterKeys) {
+        FIRRemoteConfigValue *value = [self configValueForKey:key];
+        if (value) {
+          FIRRolloutAssignment *assignment =
+              [[FIRRolloutAssignment alloc] initWithRolloutId:rolloutId
+                                                    variantId:variantID
+                                              templateVersion:[versionNumber longLongValue]
+                                                 parameterKey:key
+                                               parameterValue:value.stringValue];
+          [rolloutsAssignments addObject:assignment];
+        }
+      }
+    }
+  }
+  if (rolloutsAssignments.count > 0) {
+    FIRRolloutsState *rolloutsState =
+        [[FIRRolloutsState alloc] initWithAssignmentList:rolloutsAssignments];
+    FIRLogDebug(kFIRLoggerRemoteConfig, @"I-RCN000069", @"Send notification to Interop.");
+    [[NSNotificationCenter defaultCenter]
+        postNotificationName:RolloutsStateDidChangeNotificationName
+                      object:self
+                    userInfo:@{RolloutsStateDidChangeNotificationName : rolloutsState}];
+  }
+}
+
 @end

FirebaseRemoteConfig/Sources/FIRRemoteConfigComponent.m

@@ -149,7 +149,7 @@ + (void)load {
 - (void)registerRolloutsStateSubscriber:(id<FIRRolloutsStateSubscriber>)subscriber
                                     for:(NSString * _Nonnull)namespace {
   // TODO(Themisw): Adding the registered subscriber reference to the namespace instance
-  // [self.instances[namespace] addRemoteConfigInteropSubscriber:subscriber];
+  [self.instances[namespace] addRemoteConfigInteropSubscriber:subscriber];
 }
 
 @end

FirebaseRemoteConfig/Sources/Private/FIRRemoteConfig_Private.h

@@ -17,6 +17,8 @@
 #import <FirebaseRemoteConfig/FIRRemoteConfig.h>
 #import "RCNConfigSettings.h"  // This import is needed to expose settings for the Swift API tests.
 
+@import FirebaseRemoteConfigInterop;
+
 @class FIROptions;
 @class RCNConfigContent;
 @class RCNConfigDBManager;
@@ -78,6 +80,8 @@ NS_ASSUME_NONNULL_BEGIN
                   configContent:(RCNConfigContent *)configContent
                       analytics:(nullable id<FIRAnalyticsInterop>)analytics;
 
+- (void)addRemoteConfigInteropSubscriber:(id<FIRRolloutsStateSubscriber> _Nonnull)subscriber;
+
 @end
 
 NS_ASSUME_NONNULL_END

FirebaseRemoteConfig/Sources/Private/RCNConfigSettings.h

@@ -79,8 +79,10 @@
 @property(nonatomic, readwrite, assign) NSString *lastETag;
 /// The timestamp of the last eTag update.
 @property(nonatomic, readwrite, assign) NSTimeInterval lastETagUpdateTime;
-// Last fetched template version.
-@property(nonatomic, readwrite, assign) NSString *lastTemplateVersion;
+/// Last fetched template version.
+@property(nonatomic, readwrite, assign) NSString *lastFetchedTemplateVersion;
+/// Last active template version.
+@property(nonatomic, readwrite, assign) NSString *lastActiveTemplateVersion;
 
 #pragma mark Throttling properties
 
@@ -134,6 +136,10 @@
 /// indicates a server issue.
 - (void)updateRealtimeExponentialBackoffTime;
 
+/// Update last active template version from last fetched template version and return the active
+/// template version number.
+- (NSString *)updateLastActiveTemplateVersion;
+
 /// Returns the difference between the Realtime backoff end time and the current time in a
 /// NSTimeInterval format.
 - (NSTimeInterval)getRealtimeBackoffInterval;

FirebaseRemoteConfig/Sources/RCNConfigConstants.h

@@ -60,5 +60,7 @@ static NSString *const RCNFetchResponseKeyStateNoTemplate = @"NO_TEMPLATE";
 static NSString *const RCNFetchResponseKeyStateNoChange = @"NO_CHANGE";
 /// Template found, but evaluates to empty (e.g. all keys omitted).
 static NSString *const RCNFetchResponseKeyStateEmptyConfig = @"EMPTY_CONFIG";
-/// Template Version key
+/// Fetched Template Version key
 static NSString *const RCNFetchResponseKeyTemplateVersion = @"templateVersion";
+/// Active Template Version key
+static NSString *const RCNActiveKeyTemplateVersion = @"activeTemplateVersion";

FirebaseRemoteConfig/Sources/RCNConfigContent.h

@@ -62,6 +62,9 @@ typedef NS_ENUM(NSInteger, RCNDBSource) {
 /// Sets the fetched Personalization metadata to active.
 - (void)activatePersonalization;
 
+/// Sets the fetched rollout metadata to active and return the active rollout metadata.
+- (NSArray<NSDictionary *> *)activateRolloutMetdata;
+
 /// Gets the active config and Personalization metadata.
 - (NSDictionary *)getConfigAndMetadataForNamespace:(NSString *)FIRNamespace;
 

FirebaseRemoteConfig/Sources/RCNConfigContent.m

@@ -280,6 +280,7 @@ - (void)updateConfigContentWithResponse:(NSDictionary *)response
     [self handleUpdateStateForConfigNamespace:currentNamespace
                                   withEntries:response[RCNFetchResponseKeyEntries]];
     [self handleUpdatePersonalization:response[RCNFetchResponseKeyPersonalizationMetadata]];
+    [self handleUpdateRolloutFetchedMetadata:response[RCNFetchResponseKeyRolloutMetadata]];
     return;
   }
 }
@@ -290,6 +291,14 @@ - (void)activatePersonalization {
                                        fromSource:RCNDBSourceActive];
 }
 
+- (NSArray<NSDictionary *> *)activateRolloutMetdata {
+  _activeRolloutMetadata = _fetchedRolloutMetadata;
+  [_DBManager insertOrUpdateRolloutTableWithKey:@RCNRolloutTableKeyActiveMetadata
+                                          value:_activeRolloutMetadata
+                              completionHandler:nil];
+  return _activeRolloutMetadata;
+}
+
 #pragma mark State handling
 - (void)handleNoChangeStateForConfigNamespace:(NSString *)currentNamespace {
   if (!_fetchedConfig[currentNamespace]) {
@@ -353,6 +362,16 @@ - (void)handleUpdatePersonalization:(NSDictionary *)metadata {
   [_DBManager insertOrUpdatePersonalizationConfig:metadata fromSource:RCNDBSourceFetched];
 }
 
+- (void)handleUpdateRolloutFetchedMetadata:(NSArray<NSDictionary *> *)metadata {
+  if (!metadata) {
+    return;
+  }
+  _fetchedRolloutMetadata = metadata;
+  [_DBManager insertOrUpdateRolloutTableWithKey:@RCNRolloutTableKeyFetchedMetadata
+                                          value:metadata
+                              completionHandler:nil];
+}
+
 #pragma mark - getter/setter
 - (NSDictionary *)fetchedConfig {
   /// If this is the first time reading the fetchedConfig, we might still be reading it from the

FirebaseRemoteConfig/Sources/RCNConfigFetch.m

@@ -105,7 +105,7 @@ - (instancetype)initWithContent:(RCNConfigContent *)content
     _content = content;
     _fetchSession = [self newFetchSession];
     _options = options;
-    _templateVersionNumber = [self->_settings lastTemplateVersion];
+    _templateVersionNumber = [self->_settings lastFetchedTemplateVersion];
   }
   return self;
 }

FirebaseRemoteConfig/Sources/RCNConfigSettings.m

@@ -110,7 +110,8 @@ - (instancetype)initWithDatabaseManager:(RCNConfigDBManager *)manager
     }
 
     _isFetchInProgress = NO;
-    _lastTemplateVersion = [_userDefaultsManager lastTemplateVersion];
+    _lastFetchedTemplateVersion = [_userDefaultsManager lastFetchedTemplateVersion];
+    _lastActiveTemplateVersion = [_userDefaultsManager lastActiveTemplateVersion];
     _realtimeExponentialBackoffRetryInterval =
         [_userDefaultsManager currentRealtimeThrottlingRetryIntervalSeconds];
     _realtimeExponentialBackoffThrottleEndTime = [_userDefaultsManager realtimeThrottleEndTime];
@@ -292,7 +293,7 @@ - (void)updateMetadataWithFetchSuccessStatus:(BOOL)fetchSuccess
     [self updateLastFetchTimeInterval:[[NSDate date] timeIntervalSince1970]];
     // Note: We expect the googleAppID to always be available.
     _deviceContext = FIRRemoteConfigDeviceContextWithProjectIdentifier(_googleAppID);
-    [_userDefaultsManager setLastTemplateVersion:templateVersion];
+    [_userDefaultsManager setLastFetchedTemplateVersion:templateVersion];
   }
 
   [self updateMetadataTable];
@@ -377,6 +378,12 @@ - (void)updateMetadataTable {
   [_DBManager insertMetadataTableWithValues:columnNameToValue completionHandler:nil];
 }
 
+- (NSString *)updateLastActiveTemplateVersion {
+  _lastActiveTemplateVersion = _lastFetchedTemplateVersion;
+  [_userDefaultsManager setLastActiveTemplateVersion:_lastActiveTemplateVersion];
+  return _lastActiveTemplateVersion;
+}
+
 #pragma mark - fetch request
 
 /// Returns a fetch request with the latest device and config change.

FirebaseRemoteConfig/Sources/RCNUserDefaultsManager.h

@@ -44,7 +44,9 @@ NS_ASSUME_NONNULL_BEGIN
 /// Realtime retry count.
 @property(nonatomic, assign) int realtimeRetryCount;
 /// Last fetched template version.
-@property(nonatomic, assign) NSString *lastTemplateVersion;
+@property(nonatomic, assign) NSString *lastFetchedTemplateVersion;
+/// Last active template version.
+@property(nonatomic, assign) NSString *lastActiveTemplateVersion;
 
 /// Designated initializer.
 - (instancetype)initWithAppName:(NSString *)appName

FirebaseRemoteConfig/Sources/RCNUserDefaultsManager.m

@@ -111,7 +111,7 @@ - (void)setLastETag:(NSString *)lastETag {
   }
 }
 
-- (NSString *)lastTemplateVersion {
+- (NSString *)lastFetchedTemplateVersion {
   NSDictionary *userDefaults = [self instanceUserDefaults];
   if ([userDefaults objectForKey:RCNFetchResponseKeyTemplateVersion]) {
     return [userDefaults objectForKey:RCNFetchResponseKeyTemplateVersion];
@@ -120,12 +120,27 @@ - (NSString *)lastTemplateVersion {
   return @"0";
 }
 
-- (void)setLastTemplateVersion:(NSString *)templateVersion {
+- (void)setLastFetchedTemplateVersion:(NSString *)templateVersion {
   if (templateVersion) {
     [self setInstanceUserDefaultsValue:templateVersion forKey:RCNFetchResponseKeyTemplateVersion];
   }
 }
 
+- (NSString *)lastActiveTemplateVersion {
+  NSDictionary *userDefaults = [self instanceUserDefaults];
+  if ([userDefaults objectForKey:RCNActiveKeyTemplateVersion]) {
+    return [userDefaults objectForKey:RCNActiveKeyTemplateVersion];
+  }
+
+  return @"0";
+}
+
+- (void)setLastActiveTemplateVersion:(NSString *)templateVersion {
+  if (templateVersion) {
+    [self setInstanceUserDefaultsValue:templateVersion forKey:RCNActiveKeyTemplateVersion];
+  }
+}
+
 - (NSTimeInterval)lastETagUpdateTime {
   NSNumber *lastETagUpdateTime =
       [[self instanceUserDefaults] objectForKey:kRCNUserDefaultsKeyNamelastETagUpdateTime];