Add custom signals support in Remote Config.

[tusharkhandelwal8]

feat(rc): Add method to set custom signals for Remote Config Custom targeting

[google-oss-bot]

	1 Warning
⚠️	Did you forget to add a changelog entry? (Add #no-changelog to the PR description to silence this warning.)

Generated by 🚫 Danger

[github-actions]

Apple API Diff Report

Commit: fcbab6f
Last updated: Mon Dec 9 12:25 PST 2024
View workflow logs & download artifacts

---

FirebaseRemoteConfig

Enumerations

[ADDED] FIRRemoteConfigCustomSignalsError

[ADDED] FIRRemoteConfigCustomSignalsError

Swift:
+  typealias RemoteConfigCustomSignalsError . Code . _ErrorType = RemoteConfigCustomSignalsError
+    case unknown = 8101
+    case invalidValueType = 8102
+    case limitExceeded = 8103
Objective-C:
+  enum FIRRemoteConfigCustomSignalsError : NSInteger {}
+    FIRRemoteConfigCustomSignalsErrorUnknown = 8101
+    FIRRemoteConfigCustomSignalsErrorInvalidValueType = 8102
+    FIRRemoteConfigCustomSignalsErrorLimitExceeded = 8103

Classes

FIRRemoteConfig

[ADDED] -setCustomSignals:withCompletion:

Objective-C:
+  - ( void ) setCustomSignals :( nonnull NSDictionary < NSString * , NSObject *> * ) customSignals withCompletion :( void ( ^ _Nullable )( NSError * _Nullable error )) completionHandler NS_REFINED_FOR_SWIFT ;

Constants

[ADDED] FIRRemoteConfigCustomSignalsErrorDomain

[ADDED] FIRRemoteConfigCustomSignalsErrorDomain

Swift:
+  let RemoteConfigCustomSignalsErrorDomain : String
Objective-C:
+  extern NS_SWIFT_NAME ( RemoteConfigCustomSignalsErrorDomain ) NSString * const FIRRemoteConfigCustomSignalsErrorDomain

---

[paulb777]

@tusharkhandelwal8 Thanks for working through all the feedback. LGTM!

[ncooke3]

Taking another pass here. I would recommend including a discussion point to the doc comment on the behavior that clients should expect when adding vs. inserting vs. removing.

Suggested change

	/// Sets custom signals for this Remote Config instance.
	/// - Parameter customSignals: A dictionary mapping string keys to custom
	/// signals to be set for the app instance.
	func setCustomSignals(_ customSignals: [String: CustomSignalValue?]) async throws {
	/// Sets custom signals for this Remote Config instance.
	/// - Parameter customSignals: A dictionary mapping string keys to custom
	/// signals to be set for the app instance.
	///
	/// <insert a few sentences on adding/updating signals and using nil to delete a signal>
	func setCustomSignals(_ customSignals: [String: CustomSignalValue?]) async throws {