Save activated ExperimentsDescriptions in DB (#11259)

* Add activated experiment metadata and payload keys to experiments table

* Call updateActivatedExperiments in activation method

* Update key name for experiments table

* Update test to include activation call

* Update DB manager for Active experiments payload and metadata

* Fix metadata naming

* add comment

* Don't save experiments metadata b/c it isn't required to diff experiments

* Add extra assertion for test

* Address PR comments

Author: qdpham13

FirebaseRemoteConfig/Sources/RCNConfigDBManager.m

@@ -827,12 +827,22 @@ - (void)loadExperimentWithCompletionHandler:(RCNDBCompletion)handler {
       experimentMetadata = [[NSMutableDictionary alloc] init];
     }
 
+    /// Load activated experiments payload.
+    NSMutableArray *activeExperimentPayloads =
+        [strongSelf loadExperimentTableFromKey:@RCNExperimentTableKeyActivePayload];
+    if (!activeExperimentPayloads) {
+      activeExperimentPayloads = [[NSMutableArray alloc] init];
+    }
+
     if (handler) {
       dispatch_async(dispatch_get_main_queue(), ^{
         handler(
             YES, @{
               @RCNExperimentTableKeyPayload : [experimentPayloads copy],
-              @RCNExperimentTableKeyMetadata : [experimentMetadata copy]
+              @RCNExperimentTableKeyMetadata : [experimentMetadata copy],
+              /// Activated experiments only need ExperimentsDescriptions data, which
+              /// experimentPayloads contains.
+              @RCNExperimentTableKeyActivePayload : [activeExperimentPayloads copy]
             });
       });
     }

FirebaseRemoteConfig/Sources/RCNConfigDefines.h

@@ -30,5 +30,6 @@
 
 #define RCNExperimentTableKeyPayload "experiment_payload"
 #define RCNExperimentTableKeyMetadata "experiment_metadata"
+#define RCNExperimentTableKeyActivePayload "experiment_active_payload"
 
 #endif

FirebaseRemoteConfig/Sources/RCNConfigExperiment.m

@@ -32,7 +32,9 @@ @interface RCNConfigExperiment ()
     NSMutableArray<NSData *> *experimentPayloads;  ///< Experiment payloads.
 @property(nonatomic, strong)
     NSMutableDictionary<NSString *, id> *experimentMetadata;  ///< Experiment metadata
-@property(nonatomic, strong) RCNConfigDBManager *DBManager;   ///< Database Manager.
+@property(nonatomic, strong)
+    NSMutableArray<NSData *> *activeExperimentPayloads;      ///< Activated experiment payloads.
+@property(nonatomic, strong) RCNConfigDBManager *DBManager;  ///< Database Manager.
 @property(nonatomic, strong) FIRExperimentController *experimentController;
 @property(nonatomic, strong) NSDateFormatter *experimentStartTimeDateFormatter;
 @end
@@ -45,6 +47,7 @@ - (instancetype)initWithDBManager:(RCNConfigDBManager *)DBManager
   if (self) {
     _experimentPayloads = [[NSMutableArray alloc] init];
     _experimentMetadata = [[NSMutableDictionary alloc] init];
+    _activeExperimentPayloads = [[NSMutableArray alloc] init];
     _experimentStartTimeDateFormatter = [[NSDateFormatter alloc] init];
     [_experimentStartTimeDateFormatter setDateFormat:@"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'"];
     [_experimentStartTimeDateFormatter setTimeZone:[NSTimeZone timeZoneForSecondsFromGMT:0]];
@@ -89,6 +92,23 @@ - (void)loadExperimentFromTable {
     if (result[@RCNExperimentTableKeyMetadata]) {
       strongSelf->_experimentMetadata = [result[@RCNExperimentTableKeyMetadata] mutableCopy];
     }
+
+    /// Load activated experiments payload and metadata.
+    if (result[@RCNExperimentTableKeyActivePayload]) {
+      [strongSelf->_activeExperimentPayloads removeAllObjects];
+      for (NSData *experiment in result[@RCNExperimentTableKeyActivePayload]) {
+        NSError *error;
+        id experimentPayloadJSON = [NSJSONSerialization JSONObjectWithData:experiment
+                                                                   options:kNilOptions
+                                                                     error:&error];
+        if (!experimentPayloadJSON || error) {
+          FIRLogWarning(kFIRLoggerRemoteConfig, @"I-RCN000031",
+                        @"Activated experiment payload could not be parsed as JSON.");
+        } else {
+          [strongSelf->_activeExperimentPayloads addObject:experiment];
+        }
+      }
+    }
   };
   [_DBManager loadExperimentWithCompletionHandler:completionHandler];
 }
@@ -131,6 +151,9 @@ - (void)updateExperimentsWithHandler:(void (^)(NSError *_Nullable))handler {
                            lastStartTime:lastStartTime
                                 payloads:_experimentPayloads
                        completionHandler:handler];
+
+  /// Update activated experiments payload and metadata in DB.
+  [self updateActiveExperimentsInDB];
 }
 
 - (void)updateExperimentStartTime {
@@ -157,6 +180,18 @@ - (void)updateExperimentStartTime {
                          completionHandler:nil];
 }
 
+- (void)updateActiveExperimentsInDB {
+  /// Put current fetched experiment payloads into activated experiment DB.
+  [_activeExperimentPayloads removeAllObjects];
+  [_DBManager deleteExperimentTableForKey:@RCNExperimentTableKeyActivePayload];
+  for (NSData *experiment in _experimentPayloads) {
+    [_activeExperimentPayloads addObject:experiment];
+    [_DBManager insertExperimentTableWithKey:@RCNExperimentTableKeyActivePayload
+                                       value:experiment
+                           completionHandler:nil];
+  }
+}
+
 - (NSTimeInterval)latestStartTimeWithExistingLastStartTime:(NSTimeInterval)existingLastStartTime {
   return [self.experimentController
       latestExperimentStartTimestampBetweenTimestamp:existingLastStartTime

FirebaseRemoteConfig/Tests/Unit/RCNConfigDBManagerTest.m

@@ -504,6 +504,45 @@ - (void)testWriteAndLoadExperiments {
   [self waitForExpectationsWithTimeout:_expectionTimeout handler:nil];
 }
 
+- (void)testWriteAndLoadActivatedExperiments {
+  XCTestExpectation *updateAndLoadExperimentExpectation =
+      [self expectationWithDescription:@"Update and load experiment in database successfully"];
+
+  NSError *error;
+  NSArray *payload2 = @[ @"ab", @"cd" ];
+  NSData *payloadData2 = [NSJSONSerialization dataWithJSONObject:payload2
+                                                         options:NSJSONWritingPrettyPrinted
+                                                           error:&error];
+  NSDictionary *payload3 =
+      @{@"experiment_ID" : @"35667", @"experiment_activate_name" : @"activate_game"};
+  NSData *payloadData3 = [NSJSONSerialization dataWithJSONObject:payload3
+                                                         options:NSJSONWritingPrettyPrinted
+                                                           error:&error];
+  NSArray *payloads = @[ [[NSData alloc] init], payloadData2, payloadData3 ];
+
+  RCNDBCompletion writePayloadCompletion = ^(BOOL success, NSDictionary *result) {
+    XCTAssertTrue(success);
+    RCNDBCompletion readCompletion = ^(BOOL success, NSDictionary *experimentResults) {
+      XCTAssertTrue(success);
+      XCTAssertNotNil(experimentResults[@RCNExperimentTableKeyActivePayload]);
+      XCTAssertEqualObjects(payloads, experimentResults[@RCNExperimentTableKeyActivePayload]);
+      [updateAndLoadExperimentExpectation fulfill];
+    };
+    [self->_DBManager loadExperimentWithCompletionHandler:readCompletion];
+  };
+  [_DBManager insertExperimentTableWithKey:@RCNExperimentTableKeyActivePayload
+                                     value:[[NSData alloc] init]
+                         completionHandler:nil];
+  [_DBManager insertExperimentTableWithKey:@RCNExperimentTableKeyActivePayload
+                                     value:payloadData2
+                         completionHandler:nil];
+  [_DBManager insertExperimentTableWithKey:@RCNExperimentTableKeyActivePayload
+                                     value:payloadData3
+                         completionHandler:writePayloadCompletion];
+
+  [self waitForExpectationsWithTimeout:_expectionTimeout handler:nil];
+}
+
 - (void)testWriteAndLoadMetadataMultipleTimes {
   XCTestExpectation *updateAndLoadMetadataExpectation = [self
       expectationWithDescription:@"Update and load experiment metadata in database successfully"];

FirebaseRemoteConfig/Tests/Unit/RCNConfigExperimentTest.m

@@ -38,9 +38,11 @@ - (instancetype)initWithAnalytics:(nullable id<FIRAnalyticsInterop>)analytics;
 @interface RCNConfigExperiment ()
 @property(nonatomic, copy) NSMutableArray *experimentPayloads;
 @property(nonatomic, copy) NSMutableDictionary *experimentMetadata;
+@property(nonatomic, copy) NSMutableArray *activeExperimentPayloads;
 @property(nonatomic, strong) RCNConfigDBManager *DBManager;
 - (NSTimeInterval)updateExperimentStartTime;
 - (void)loadExperimentFromTable;
+- (void)updateActiveExperimentsInDB;
 @end
 
 @interface RCNConfigExperimentTest : XCTestCase {
@@ -232,6 +234,8 @@ - (void)testUpdateExperiments {
     XCTAssertNil(error);
     XCTAssertEqualObjects(experiment.experimentMetadata[@"last_experiment_start_time"],
                           @(12345678));
+    OCMVerify([experiment updateActiveExperimentsInDB]);
+    XCTAssertEqualObjects(experiment.activeExperimentPayloads, @[ payloadData ]);
   }];
 }