Store and update config metadata entries by namespace (#7373)

karenyz · web-flow · commit 32922df5446e · 2021-02-22T10:21:41.000-08:00
* Insert and load config metadata by namespace

* Deprecate existing metadata table name

* Update tests

* Fix delete method and update naming

* Add test for writing metadate for multiple namespaces
diff --git a/.gitignore b/.gitignore
@@ -9,6 +9,8 @@ FirebaseAuth/Tests/Sample/SwiftApiTests/Credentials.swift
 FirebaseDatabase/Tests/Resources/GoogleService-Info.plist
 
 FirebaseRemoteConfig/Tests/SwiftAPI/Resources/GoogleService-Info.plist
+FirebaseRemoteConfig/Tests/Sample/RemoteConfigSampleApp/GoogleService-Info.plist
+FirebaseRemoteConfig/Tests/Sample/RemoteConfigSampleApp/SecondApp-GoogleService-Info.plist
 
 # FirebaseStorage integration tests GoogleService-Info.plist
 FirebaseStorage/Tests/Integration/Resources/GoogleService-Info.plist
diff --git a/FirebaseRemoteConfig/CHANGELOG.md b/FirebaseRemoteConfig/CHANGELOG.md
@@ -1,3 +1,6 @@
+# Unreleased
+- [fixed] Store fetch metadata per namespace to address activation issues. (#7179)
+
 # v7.7.0
 - [added] Added community support for watchOS. (#7481)
 
diff --git a/FirebaseRemoteConfig/Sources/RCNConfigDBManager.h b/FirebaseRemoteConfig/Sources/RCNConfigDBManager.h
@@ -26,6 +26,7 @@ typedef NS_ENUM(NSInteger, RCNUpdateOption) {
 
 /// Column names in metadata table
 static NSString *const RCNKeyBundleIdentifier = @"bundle_identifier";
+static NSString *const RCNKeyNamespace = @"namespace";
 static NSString *const RCNKeyFetchTime = @"fetch_time";
 static NSString *const RCNKeyDigestPerNamespace = @"digest_per_ns";
 static NSString *const RCNKeyDeviceContext = @"device_context";
@@ -63,9 +64,10 @@ typedef void (^RCNDBLoadCompletion)(BOOL success,
 /// Load config content from main table to cached memory during app start.
 - (void)loadMainWithBundleIdentifier:(NSString *)bundleIdentifier
                    completionHandler:(RCNDBLoadCompletion)handler;
-/// Load config settings from metadata table to cached memory during app start. Config settings
-/// include success/failure fetch times, device contenxt, app context, etc.
-- (NSDictionary *)loadMetadataWithBundleIdentifier:(NSString *)bundleIdentifier;
+/// Load config settings for a given namespace from metadata table to cached memory during app
+/// start. Config settings include success/failure fetch times, device contenxt, app context, etc.
+- (NSDictionary *)loadMetadataWithBundleIdentifier:(NSString *)bundleIdentifier
+                                         namespace:(NSString *)namespace;
 /// Load internal metadata from internal metadata table, such as customized HTTP connection/read
 /// timeout, throttling time interval and number limit of throttling, etc.
 /// This call needs to be blocking to ensure throttling works during apps starts.
@@ -101,6 +103,7 @@ typedef void (^RCNDBLoadCompletion)(BOOL success,
                    completionHandler:(RCNDBCompletion)handler;
 
 - (void)updateMetadataWithOption:(RCNUpdateOption)option
+                       namespace:(NSString *)namespace
                           values:(NSArray *)values
                completionHandler:(RCNDBCompletion)handler;
 
@@ -112,9 +115,10 @@ typedef void (^RCNDBLoadCompletion)(BOOL success,
 - (void)deleteRecordFromMainTableWithNamespace:(NSString *)namespace_p
                               bundleIdentifier:(NSString *)bundleIdentifier
                                     fromSource:(RCNDBSource)source;
-/// Remove all the records of given package name from metadata/internal metadata DB before updating
-/// new values from response.
+/// Remove all the records of given package name and namespace from metadata/internal metadata DB
+/// before updating new values from response.
 - (void)deleteRecordWithBundleIdentifier:(NSString *)bundlerIdentifier
+                               namespace:(NSString *)namespace
                             isInternalDB:(BOOL)isInternalDB;
 /// Remove all the records from a config content table.
 - (void)deleteAllRecordsFromTableWithSource:(RCNDBSource)source;
diff --git a/FirebaseRemoteConfig/Sources/RCNConfigDBManager.m b/FirebaseRemoteConfig/Sources/RCNConfigDBManager.m
@@ -26,7 +26,8 @@
 #define RCNTableNameMain "main"
 #define RCNTableNameMainActive "main_active"
 #define RCNTableNameMainDefault "main_default"
-#define RCNTableNameMetadata "fetch_metadata"
+#define RCNTableNameMetadataDeprecated "fetch_metadata"
+#define RCNTableNameMetadata "fetch_metadata_v2"
 #define RCNTableNameInternalMetadata "internal_metadata"
 #define RCNTableNameExperiment "experiment"
 #define RCNTableNamePersonalization "personalization"
@@ -98,9 +99,9 @@ static BOOL RemoteConfigCreateFilePathIfNotExist(NSString *filePath) {
 
 static NSArray *RemoteConfigMetadataTableColumnsInOrder() {
   return @[
-    RCNKeyBundleIdentifier, RCNKeyFetchTime, RCNKeyDigestPerNamespace, RCNKeyDeviceContext,
-    RCNKeyAppContext, RCNKeySuccessFetchTime, RCNKeyFailureFetchTime, RCNKeyLastFetchStatus,
-    RCNKeyLastFetchError, RCNKeyLastApplyTime, RCNKeyLastSetDefaultsTime
+    RCNKeyBundleIdentifier, RCNKeyNamespace, RCNKeyFetchTime, RCNKeyDigestPerNamespace,
+    RCNKeyDeviceContext, RCNKeyAppContext, RCNKeySuccessFetchTime, RCNKeyFailureFetchTime,
+    RCNKeyLastFetchStatus, RCNKeyLastFetchError, RCNKeyLastApplyTime, RCNKeyLastSetDefaultsTime
   ];
 }
 
@@ -267,8 +268,8 @@ - (BOOL)createTableSchema {
 
   static const char *createTableMetadata =
       "create TABLE IF NOT EXISTS " RCNTableNameMetadata
-      " (_id INTEGER PRIMARY KEY, bundle_identifier"
-      " TEXT, fetch_time INTEGER, digest_per_ns BLOB, device_context BLOB, app_context BLOB, "
+      " (_id INTEGER PRIMARY KEY, bundle_identifier TEXT, namespace TEXT,"
+      " fetch_time INTEGER, digest_per_ns BLOB, device_context BLOB, app_context BLOB, "
       "success_fetch_time BLOB, failure_fetch_time BLOB, last_fetch_status INTEGER, "
       "last_fetch_error INTEGER, last_apply_time INTEGER, last_set_defaults_time INTEGER)";
 
@@ -354,9 +355,9 @@ - (BOOL)insertMetadataTableWithValues:(NSDictionary *)columnNameToValue {
   RCN_MUST_NOT_BE_MAIN_THREAD();
   static const char *SQL =
       "INSERT INTO " RCNTableNameMetadata
-      " (bundle_identifier, fetch_time, digest_per_ns, device_context, "
+      " (bundle_identifier, namespace, fetch_time, digest_per_ns, device_context, "
       "app_context, success_fetch_time, failure_fetch_time, last_fetch_status, "
-      "last_fetch_error, last_apply_time, last_set_defaults_time) values (?, ?, ?, ?, ?, "
+      "last_fetch_error, last_apply_time, last_set_defaults_time) values (?, ?, ?, ?, ?, ?, "
       "?, ?, ?, ?, ?, ?)";
 
   sqlite3_stmt *statement = [self prepareSQL:SQL];
@@ -368,7 +369,8 @@ - (BOOL)insertMetadataTableWithValues:(NSDictionary *)columnNameToValue {
   NSArray *columns = RemoteConfigMetadataTableColumnsInOrder();
   int index = 0;
   for (NSString *columnName in columns) {
-    if ([columnName isEqualToString:RCNKeyBundleIdentifier]) {
+    if ([columnName isEqualToString:RCNKeyBundleIdentifier] ||
+        [columnName isEqualToString:RCNKeyNamespace]) {
       NSString *value = columnNameToValue[columnName];
       if (![self bindStringToStatement:statement index:++index string:value]) {
         return [self logErrorWithSQL:SQL finalizeStatement:statement returnValue:NO];
@@ -618,10 +620,11 @@ - (BOOL)insertOrUpdatePersonalizationConfig:(NSDictionary *)dataValue
 #pragma mark - update
 
 - (void)updateMetadataWithOption:(RCNUpdateOption)option
+                       namespace:(NSString *)namespace
                           values:(NSArray *)values
                completionHandler:(RCNDBCompletion)handler {
   dispatch_async(_databaseOperationQueue, ^{
-    BOOL success = [self updateMetadataTableWithOption:option andValues:values];
+    BOOL success = [self updateMetadataTableWithOption:option namespace:namespace andValues:values];
     if (handler) {
       dispatch_async(dispatch_get_main_queue(), ^{
         handler(success, nil);
@@ -630,17 +633,20 @@ - (void)updateMetadataWithOption:(RCNUpdateOption)option
   });
 }
 
-- (BOOL)updateMetadataTableWithOption:(RCNUpdateOption)option andValues:(NSArray *)values {
+- (BOOL)updateMetadataTableWithOption:(RCNUpdateOption)option
+                            namespace:(NSString *)namespace
+                            andValues:(NSArray *)values {
   RCN_MUST_NOT_BE_MAIN_THREAD();
   static const char *SQL =
       "UPDATE " RCNTableNameMetadata " (last_fetch_status, last_fetch_error, last_apply_time, "
-      "last_set_defaults_time) values (?, ?, ?, ?)";
+      "last_set_defaults_time) values (?, ?, ?, ?) WHERE namespace = ?";
   if (option == RCNUpdateOptionFetchStatus) {
-    SQL = "UPDATE " RCNTableNameMetadata " SET last_fetch_status = ?, last_fetch_error = ?";
+    SQL = "UPDATE " RCNTableNameMetadata
+          " SET last_fetch_status = ?, last_fetch_error = ? WHERE namespace = ?";
   } else if (option == RCNUpdateOptionApplyTime) {
-    SQL = "UPDATE " RCNTableNameMetadata " SET last_apply_time = ?";
+    SQL = "UPDATE " RCNTableNameMetadata " SET last_apply_time = ? WHERE namespace = ?";
   } else if (option == RCNUpdateOptionDefaultTime) {
-    SQL = "UPDATE " RCNTableNameMetadata " SET last_set_defaults_time = ?";
+    SQL = "UPDATE " RCNTableNameMetadata " SET last_set_defaults_time = ? WHERE namespace = ?";
   } else {
     return NO;
   }
@@ -666,6 +672,12 @@ - (BOOL)updateMetadataTableWithOption:(RCNUpdateOption)option andValues:(NSArray
       return [self logErrorWithSQL:SQL finalizeStatement:statement returnValue:NO];
     }
   }
+  // bind namespace to query
+  if (sqlite3_bind_text(statement, ++index, [namespace UTF8String], -1, SQLITE_TRANSIENT) !=
+      SQLITE_OK) {
+    return [self logErrorWithSQL:SQL finalizeStatement:statement returnValue:NO];
+  }
+
   if (sqlite3_step(statement) != SQLITE_DONE) {
     return [self logErrorWithSQL:SQL finalizeStatement:statement returnValue:NO];
   }
@@ -674,31 +686,34 @@ - (BOOL)updateMetadataTableWithOption:(RCNUpdateOption)option andValues:(NSArray
 }
 #pragma mark - read from DB
 
-- (NSDictionary *)loadMetadataWithBundleIdentifier:(NSString *)bundleIdentifier {
+- (NSDictionary *)loadMetadataWithBundleIdentifier:(NSString *)bundleIdentifier
+                                         namespace:(NSString *)namespace {
   __block NSDictionary *metadataTableResult;
   __weak RCNConfigDBManager *weakSelf = self;
   dispatch_sync(_databaseOperationQueue, ^{
-    metadataTableResult = [weakSelf loadMetadataTableWithBundleIdentifier:bundleIdentifier];
+    metadataTableResult = [weakSelf loadMetadataTableWithBundleIdentifier:bundleIdentifier
+                                                                namespace:namespace];
   });
   if (metadataTableResult) {
     return metadataTableResult;
   }
   return [[NSDictionary alloc] init];
 }
 
-- (NSMutableDictionary *)loadMetadataTableWithBundleIdentifier:(NSString *)bundleIdentifier {
+- (NSMutableDictionary *)loadMetadataTableWithBundleIdentifier:(NSString *)bundleIdentifier
+                                                     namespace:(NSString *)namespace {
   NSMutableDictionary *dict = [[NSMutableDictionary alloc] init];
   const char *SQL =
       "SELECT bundle_identifier, fetch_time, digest_per_ns, device_context, app_context, "
       "success_fetch_time, failure_fetch_time , last_fetch_status, "
       "last_fetch_error, last_apply_time, last_set_defaults_time FROM " RCNTableNameMetadata
-      " WHERE bundle_identifier = ?";
+      " WHERE bundle_identifier = ? and namespace = ?";
   sqlite3_stmt *statement = [self prepareSQL:SQL];
   if (!statement) {
     return nil;
   }
 
-  NSArray *params = @[ bundleIdentifier ];
+  NSArray *params = @[ bundleIdentifier, namespace ];
   [self bindStringsToStatement:statement stringArray:params];
 
   while (sqlite3_step(statement) == SQLITE_ROW) {
@@ -1043,6 +1058,7 @@ - (void)deleteRecordFromMainTableWithNamespace:(NSString *)namespace_p
 }
 
 - (void)deleteRecordWithBundleIdentifier:(NSString *)bundleIdentifier
+                               namespace:(NSString *)namespace
                             isInternalDB:(BOOL)isInternalDB {
   __weak RCNConfigDBManager *weakSelf = self;
   dispatch_async(_databaseOperationQueue, ^{
@@ -1051,10 +1067,11 @@ - (void)deleteRecordWithBundleIdentifier:(NSString *)bundleIdentifier
       return;
     }
     const char *SQL = "DELETE FROM " RCNTableNameInternalMetadata " WHERE key LIKE ?";
+    NSArray *params = @[ bundleIdentifier ];
     if (!isInternalDB) {
-      SQL = "DELETE FROM " RCNTableNameMetadata " WHERE bundle_identifier = ?";
+      SQL = "DELETE FROM " RCNTableNameMetadata " WHERE bundle_identifier = ? and namespace = ?";
+      params = @[ bundleIdentifier, namespace ];
     }
-    NSArray *params = @[ bundleIdentifier ];
     [strongSelf executeQuery:SQL withParams:params];
   });
 }
diff --git a/FirebaseRemoteConfig/Sources/RCNConfigSettings.m b/FirebaseRemoteConfig/Sources/RCNConfigSettings.m
@@ -142,7 +142,8 @@ - (void)updateLastFetchTimeInterval:(NSTimeInterval)lastFetchTimeInterval {
 
 #pragma mark - load from DB
 - (NSDictionary *)loadConfigFromMetadataTable {
-  NSDictionary *metadata = [[_DBManager loadMetadataWithBundleIdentifier:_bundleIdentifier] copy];
+  NSDictionary *metadata = [[_DBManager loadMetadataWithBundleIdentifier:_bundleIdentifier
+                                                               namespace:_FIRNamespace] copy];
   if (metadata) {
     // TODO: Remove (all metadata in general) once ready to
     // migrate to user defaults completely.
@@ -180,7 +181,9 @@ - (NSDictionary *)loadConfigFromMetadataTable {
 // Update internal metadata content to cache and DB.
 - (void)updateInternalContentWithResponse:(NSDictionary *)response {
   // Remove all the keys with current pakcage name.
-  [_DBManager deleteRecordWithBundleIdentifier:_bundleIdentifier isInternalDB:YES];
+  [_DBManager deleteRecordWithBundleIdentifier:_bundleIdentifier
+                                     namespace:_FIRNamespace
+                                  isInternalDB:YES];
 
   for (NSString *key in _internalMetadata.allKeys) {
     if ([key hasPrefix:_bundleIdentifier]) {
@@ -258,7 +261,9 @@ - (void)updateFetchTimeWithSuccessFetch:(BOOL)isSuccessfulFetch {
 }
 
 - (void)updateMetadataTable {
-  [_DBManager deleteRecordWithBundleIdentifier:_bundleIdentifier isInternalDB:NO];
+  [_DBManager deleteRecordWithBundleIdentifier:_bundleIdentifier
+                                     namespace:_FIRNamespace
+                                  isInternalDB:NO];
   NSError *error;
   // Objects to be serialized cannot be invalid.
   if (!_bundleIdentifier) {
@@ -309,6 +314,7 @@ - (void)updateMetadataTable {
 
   NSDictionary *columnNameToValue = @{
     RCNKeyBundleIdentifier : _bundleIdentifier,
+    RCNKeyNamespace : _FIRNamespace,
     RCNKeyFetchTime : @(self.lastFetchTimeInterval),
     RCNKeyDigestPerNamespace : serializedDigestPerNamespace,
     RCNKeyDeviceContext : serializedDeviceContext,
@@ -379,6 +385,7 @@ - (void)setLastFetchError:(FIRRemoteConfigError)lastFetchError {
   if (_lastFetchError != lastFetchError) {
     _lastFetchError = lastFetchError;
     [_DBManager updateMetadataWithOption:RCNUpdateOptionFetchStatus
+                               namespace:_FIRNamespace
                                   values:@[ @(_lastFetchStatus), @(_lastFetchError) ]
                        completionHandler:nil];
   }
@@ -428,13 +435,15 @@ - (void)setFetchTimeout:(NSTimeInterval)fetchTimeout {
 - (void)setLastApplyTimeInterval:(NSTimeInterval)lastApplyTimestamp {
   _lastApplyTimeInterval = lastApplyTimestamp;
   [_DBManager updateMetadataWithOption:RCNUpdateOptionApplyTime
+                             namespace:_FIRNamespace
                                 values:@[ @(lastApplyTimestamp) ]
                      completionHandler:nil];
 }
 
 - (void)setLastSetDefaultsTimeInterval:(NSTimeInterval)lastSetDefaultsTimestamp {
   _lastSetDefaultsTimeInterval = lastSetDefaultsTimestamp;
   [_DBManager updateMetadataWithOption:RCNUpdateOptionDefaultTime
+                             namespace:_FIRNamespace
                                 values:@[ @(lastSetDefaultsTimestamp) ]
                      completionHandler:nil];
 }
diff --git a/FirebaseRemoteConfig/Tests/Unit/RCNConfigDBManagerTest.m b/FirebaseRemoteConfig/Tests/Unit/RCNConfigDBManagerTest.m
