Add Swift tests and immutable signal map

Author: tusharkhandelwal8

FirebaseRemoteConfig/Sources/Private/RCNConfigSettings.h

@@ -87,7 +87,7 @@
 #pragma mark - Custom Signals
 
 /// A dictionary to hold custom signals that are set by the developer.
-@property(nonatomic, readwrite, strong) NSMutableDictionary<NSString *, NSString *> *customSignals;
+@property(nonatomic, readwrite, strong) NSDictionary<NSString *, NSString *> *customSignals;
 
 #pragma mark Throttling properties
 

FirebaseRemoteConfig/Sources/RCNConfigSettings.m

@@ -109,7 +109,6 @@ - (instancetype)initWithDatabaseManager:(RCNConfigDBManager *)manager
       [_userDefaultsManager resetUserDefaults];
     }
 
-    _customSignals = [_userDefaultsManager customSignals];
     _isFetchInProgress = NO;
     _lastFetchedTemplateVersion = [_userDefaultsManager lastFetchedTemplateVersion];
     _lastActiveTemplateVersion = [_userDefaultsManager lastActiveTemplateVersion];
@@ -446,9 +445,10 @@ - (NSString *)nextRequestWithUserProperties:(NSDictionary *)userProperties {
     }
   }
 
-  if (_customSignals.count > 0) {
+  NSDictionary<NSString *, NSString *> *customSignals = [self customSignals];
+  if (customSignals.count > 0) {
     NSError *error;
-    NSData *jsonData = [NSJSONSerialization dataWithJSONObject:_customSignals
+    NSData *jsonData = [NSJSONSerialization dataWithJSONObject:customSignals
                                                        options:0
                                                          error:&error];
     if (!error) {
@@ -460,7 +460,7 @@ - (NSString *)nextRequestWithUserProperties:(NSDictionary *)userProperties {
                                                                encoding:NSUTF8StringEncoding]]];
       // Log the custom signals during fetch.
       FIRLogDebug(kFIRLoggerRemoteConfig, @"I-RCN000078", @"Fetching with custom signals: %@",
-                  _customSignals);
+                  customSignals);
     }
   }
   ret = [ret stringByAppendingString:@"}"];
@@ -536,8 +536,11 @@ - (void)setLastSetDefaultsTimeInterval:(NSTimeInterval)lastSetDefaultsTimestamp
                      completionHandler:nil];
 }
 
-- (void)setCustomSignals:(NSMutableDictionary<NSString *, NSString *> *)customSignals {
-  _customSignals = customSignals;
+- (NSDictionary<NSString *, NSString *> *)customSignals {
+  return [_userDefaultsManager customSignals];
+}
+
+- (void)setCustomSignals:(NSDictionary<NSString *, NSString *> *)customSignals {
   [_userDefaultsManager setCustomSignals:customSignals];
 }
 

FirebaseRemoteConfig/Sources/RCNUserDefaultsManager.h

@@ -48,7 +48,7 @@ NS_ASSUME_NONNULL_BEGIN
 /// Last active template version.
 @property(nonatomic, assign) NSString *lastActiveTemplateVersion;
 /// A dictionary to hold the latest custom signals set by the developer.
-@property(nonatomic, readwrite, strong) NSMutableDictionary<NSString *, NSString *> *customSignals;
+@property(nonatomic, readwrite, strong) NSDictionary<NSString *, NSString *> *customSignals;
 
 /// Designated initializer.
 - (instancetype)initWithAppName:(NSString *)appName

FirebaseRemoteConfig/Sources/RCNUserDefaultsManager.m

@@ -142,16 +142,16 @@ - (void)setLastActiveTemplateVersion:(NSString *)templateVersion {
   }
 }
 
-- (NSMutableDictionary<NSString *, NSString *> *)customSignals {
+- (NSDictionary<NSString *, NSString *> *)customSignals {
   NSDictionary *userDefaults = [self instanceUserDefaults];
   if ([userDefaults objectForKey:kRCNUserDefaultsKeyCustomSignals]) {
     return [userDefaults objectForKey:kRCNUserDefaultsKeyCustomSignals];
   }
 
-  return [[NSMutableDictionary<NSString *, NSString *> alloc] init];
+  return [[NSDictionary<NSString *, NSString *> alloc] init];
 }
 
-- (void)setCustomSignals:(NSMutableDictionary<NSString *, NSString *> *)customSignals {
+- (void)setCustomSignals:(NSDictionary<NSString *, NSString *> *)customSignals {
   if (customSignals) {
     [self setInstanceUserDefaultsValue:customSignals forKey:kRCNUserDefaultsKeyCustomSignals];
   }

FirebaseRemoteConfig/Tests/Swift/SwiftAPI/APITestBase.swift

@@ -57,6 +57,7 @@ class APITestBase: XCTestCase {
     let settings = RemoteConfigSettings()
     settings.minimumFetchInterval = 0
     config.configSettings = settings
+    config.settings.customSignals = [:]
 
     let jsonData = try JSONSerialization.data(
       withJSONObject: Constants.jsonValue

FirebaseRemoteConfig/Tests/Swift/SwiftAPI/AsyncAwaitTests.swift

@@ -129,4 +129,54 @@ class AsyncAwaitTests: APITestBase {
     XCTAssertTrue(config.configValue(forKey: Constants.jedi).dataValue.isEmpty,
                   "Remote config should have been deleted.")
   }
+
+  func testSetCustomSignals() async throws {
+    let testSignals: [String: CustomSignalValue?] = [
+      "signal_1": .integer(5),
+      "signal_2": .string("basic"),
+      "signal_3": .double(3.14159),
+    ]
+
+    let expectedSignals: [String: String] = [
+      "signal_1": "5",
+      "signal_2": "basic",
+      "signal_3": "3.14159",
+    ]
+
+    _ = try await config.setCustomSignals(testSignals)
+    XCTAssertEqual(config.settings.customSignals, expectedSignals)
+  }
+
+  func testSetCustomSignalsMultipleTimes() async throws {
+    let testSignals: [String: CustomSignalValue?] = [
+      "signal_1": 6,
+      "signal_2": "basic",
+      "signal_3": 3.14,
+    ]
+
+    let expectedSignals: [String: String] = [
+      "signal_1": "6",
+      "signal_2": "basic",
+      "signal_3": "3.14",
+    ]
+
+    _ = try await config.setCustomSignals(testSignals)
+    XCTAssertEqual(config.settings.customSignals, expectedSignals)
+
+    let testSignals2: [String: CustomSignalValue?] = [
+      "signal_4": .integer(100),
+      "signal_3": nil,
+      "signal_5": .double(3.1234),
+    ]
+
+    let expectedSignals2: [String: String] = [
+      "signal_1": "6",
+      "signal_2": "basic",
+      "signal_4": "100",
+      "signal_5": "3.1234",
+    ]
+
+    _ = try await config.setCustomSignals(testSignals2)
+    XCTAssertEqual(config.settings.customSignals, expectedSignals2)
+  }
 }

FirebaseRemoteConfig/Tests/Unit/RCNRemoteConfigTest.m

@@ -1851,7 +1851,7 @@ - (void)testSetCustomSignals {
     [_configInstances[i] setCustomSignals:testSignals
                            withCompletion:^(NSError *_Nullable error) {
                              XCTAssertNil(error);
-                             NSMutableDictionary<NSString *, NSString *> *retrievedSignals =
+                             NSDictionary<NSString *, NSString *> *retrievedSignals =
                                  self->_configInstances[i].settings.customSignals;
                              XCTAssertEqualObjects(retrievedSignals, testSignals);
                              [expectations[i] fulfill];
@@ -1895,7 +1895,7 @@ - (void)testSetCustomSignalsMultipleTimes {
                                  setCustomSignals:testSignals2
                                    withCompletion:^(NSError *_Nullable error) {
                                      XCTAssertNil(error);
-                                     NSMutableDictionary<NSString *, NSString *> *retrievedSignals =
+                                     NSDictionary<NSString *, NSString *> *retrievedSignals =
                                          self->_configInstances[i].settings.customSignals;
                                      XCTAssertEqualObjects(retrievedSignals, expectedSignals);
                                      [expectations[i] fulfill];