Merge branch 'master' into mila/BloomFilter

Author: milaGGL

Crashlytics/CHANGELOG.md

@@ -1,4 +1,4 @@
-# Unreleased
+# 10.7.0
 - [fixed] Updated upload-symbols to 3.14 with an improvement to upload all dSYM files for Flutter apps
 
 # 10.6.0

FirebaseAuth/CHANGELOG.md

@@ -1,4 +1,4 @@
-# Unreleased
+# 10.7.0
 - [added] Added an API for developers to pass the fullName from the Sign in with Apple credential to Firebase. (#10068)
 
 # 10.6.0

FirebaseRemoteConfig/CHANGELOG.md

@@ -1,3 +1,6 @@
+# 10.7.0
+- [feature] Added support for real-time config updates. To learn more, see [Get started with Firebase Remote Config](https://firebase.google.com/docs/remote-config/get-started?platform=ios).
+
 # 9.3.0
 - [changed] Arrays and Dictionaries are now supported when initializing defaults from a
   plist. (#8306)

FirebaseRemoteConfig/Sources/FIRRemoteConfig.m

@@ -26,13 +26,16 @@
 #import "FirebaseRemoteConfig/Sources/RCNConfigContent.h"
 #import "FirebaseRemoteConfig/Sources/RCNConfigDBManager.h"
 #import "FirebaseRemoteConfig/Sources/RCNConfigExperiment.h"
+#import "FirebaseRemoteConfig/Sources/RCNConfigRealtime.h"
 #import "FirebaseRemoteConfig/Sources/RCNConfigValue_Internal.h"
 #import "FirebaseRemoteConfig/Sources/RCNDevice.h"
 #import "FirebaseRemoteConfig/Sources/RCNPersonalization.h"
 
 /// Remote Config Error Domain.
 /// TODO: Rename according to obj-c style for constants.
 NSString *const FIRRemoteConfigErrorDomain = @"com.google.remoteconfig.ErrorDomain";
+// Remote Config Realtime Error Domain
+NSString *const FIRRemoteConfigUpdateErrorDomain = @"com.google.remoteconfig.update.ErrorDomain";
 /// Remote Config Error Info End Time Seconds;
 NSString *const FIRRemoteConfigThrottledEndTimeInSecondsKey = @"error_throttled_end_time_seconds";
 /// Minimum required time interval between fetch requests made to the backend.
@@ -66,6 +69,7 @@ @implementation FIRRemoteConfig {
   RCNConfigSettings *_settings;
   RCNConfigFetch *_configFetch;
   RCNConfigExperiment *_configExperiment;
+  RCNConfigRealtime *_configRealtime;
   dispatch_queue_t _queue;
   NSString *_appName;
   NSMutableArray *_listeners;
@@ -165,6 +169,11 @@ - (instancetype)initWithAppName:(NSString *)appName
                                                  namespace:_FIRNamespace
                                                    options:options];
 
+    _configRealtime = [[RCNConfigRealtime alloc] init:_configFetch
+                                             settings:_settings
+                                            namespace:_FIRNamespace
+                                              options:options];
+
     [_settings loadConfigFromMetadataTable];
 
     if (analytics) {
@@ -597,4 +606,11 @@ - (void)setConfigSettings:(FIRRemoteConfigSettings *)configSettings {
   dispatch_async(_queue, setConfigSettingsBlock);
 }
 
+#pragma mark - Realtime
+
+- (FIRConfigUpdateListenerRegistration *)addOnConfigUpdateListener:
+    (void (^_Nonnull)(FIRRemoteConfigUpdate *update, NSError *_Nullable error))listener {
+  return [self->_configRealtime addConfigUpdateListener:listener];
+}
+
 @end

FirebaseRemoteConfig/Sources/FIRRemoteConfigUpdate.m

@@ -0,0 +1,33 @@
+/*
+ * Copyright 2022 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#import <Foundation/Foundation.h>
+
+#import "FirebaseRemoteConfig/Sources/Public/FirebaseRemoteConfig/FIRRemoteConfig.h"
+
+@implementation FIRRemoteConfigUpdate {
+  NSSet<NSString *> *_updatedKeys;
+}
+
+- (instancetype)initWithUpdatedKeys:(NSSet<NSString *> *)updatedKeys {
+  self = [super init];
+  if (self) {
+    _updatedKeys = [updatedKeys copy];
+  }
+  return self;
+}
+
+@end

FirebaseRemoteConfig/Sources/Private/FIRRemoteConfig_Private.h

@@ -21,12 +21,19 @@
 @class RCNConfigContent;
 @class RCNConfigDBManager;
 @class RCNConfigFetch;
+@class RCNConfigRealtime;
 @protocol FIRAnalyticsInterop;
 
 NS_ASSUME_NONNULL_BEGIN
 
 @class RCNConfigSettings;
 
+@interface FIRRemoteConfigUpdate ()
+
+/// Designated initializer.
+- (instancetype)initWithUpdatedKeys:(NSSet<NSString *> *)updatedKeys;
+@end
+
 @interface FIRRemoteConfig () {
   NSString *_FIRNamespace;
 }
@@ -37,6 +44,8 @@ NS_ASSUME_NONNULL_BEGIN
 /// Config settings are custom settings.
 @property(nonatomic, readwrite, strong, nonnull) RCNConfigFetch *configFetch;
 
+@property(nonatomic, readwrite, strong, nonnull) RCNConfigRealtime *configRealtime;
+
 /// Returns the FIRRemoteConfig instance for your namespace and for the default Firebase App.
 /// This singleton object contains the complete set of Remote Config parameter values available to
 /// the app, including the Active Config and Default Config.. This object also caches values fetched

FirebaseRemoteConfig/Sources/Private/RCNConfigFetch.h

@@ -30,6 +30,11 @@ NS_ASSUME_NONNULL_BEGIN
 /// Completion handler invoked by NSSessionFetcher.
 typedef void (^RCNConfigFetcherCompletion)(NSData *data, NSURLResponse *response, NSError *error);
 
+/// Completion handler invoked after a fetch that contains the updated keys
+typedef void (^RCNConfigFetchCompletion)(FIRRemoteConfigFetchStatus status,
+                                         FIRRemoteConfigUpdate *update,
+                                         NSError *error);
+
 @interface RCNConfigFetch : NSObject
 
 - (instancetype)init NS_UNAVAILABLE;
@@ -50,12 +55,22 @@ typedef void (^RCNConfigFetcherCompletion)(NSData *data, NSURLResponse *response
 - (void)fetchConfigWithExpirationDuration:(NSTimeInterval)expirationDuration
                         completionHandler:(FIRRemoteConfigFetchCompletion)completionHandler;
 
+/// Fetches config data immediately, keyed by namespace. Completion block will be called on the main
+/// queue.
+/// @param fetchAttemptNumber The number of the fetch attempt.
+/// @param completionHandler   Callback handler.
+- (void)realtimeFetchConfigWithNoExpirationDuration:(NSInteger)fetchAttemptNumber
+                                  completionHandler:(RCNConfigFetchCompletion)completionHandler;
+
 /// Add the ability to update NSURLSession's timeout after a session has already been created.
 - (void)recreateNetworkSession;
 
 /// Provide fetchSession for tests to override.
 @property(nonatomic, readwrite, strong, nonnull) NSURLSession *fetchSession;
 
+/// Provide config template version number for Realtime config client.
+@property(nonatomic, copy, nonnull) NSString *templateVersionNumber;
+
 NS_ASSUME_NONNULL_END
 
 @end

FirebaseRemoteConfig/Sources/Private/RCNConfigSettings.h

@@ -79,6 +79,8 @@
 @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;
 
 #pragma mark Throttling properties
 
@@ -90,6 +92,14 @@
 @property(nonatomic, readwrite, assign) double exponentialBackoffRetryInterval;
 /// Returns the time in seconds until the next request is allowed while in exponential backoff mode.
 @property(nonatomic, readonly, assign) NSTimeInterval exponentialBackoffThrottleEndTime;
+/// Returns the current retry interval in seconds set for exponential backoff for the Realtime
+/// service.
+@property(nonatomic, readwrite, assign) double realtimeExponentialBackoffRetryInterval;
+/// Returns the time in seconds until the next request is allowed while in exponential backoff mode
+/// for the Realtime service.
+@property(nonatomic, readonly, assign) NSTimeInterval realtimeExponentialBackoffThrottleEndTime;
+/// Realtime connection attempts.
+@property(nonatomic, readwrite, assign) int realtimeRetryCount;
 
 #pragma mark Throttling Methods
 
@@ -113,12 +123,21 @@
 
 /// Updates the metadata table with the current fetch status.
 /// @param fetchSuccess True if fetch was successful.
-- (void)updateMetadataWithFetchSuccessStatus:(BOOL)fetchSuccess;
+- (void)updateMetadataWithFetchSuccessStatus:(BOOL)fetchSuccess
+                             templateVersion:(NSString *)templateVersion;
 
 /// Increases the throttling time. Should only be called if the fetch error indicates a server
 /// issue.
 - (void)updateExponentialBackoffTime;
 
+/// Increases the throttling time for Realtime. Should only be called if the Realtime error
+/// indicates a server issue.
+- (void)updateRealtimeExponentialBackoffTime;
+
+/// Returns the difference between the Realtime backoff end time and the current time in a
+/// NSTimeInterval format.
+- (NSTimeInterval)getRealtimeBackoffInterval;
+
 /// Returns true if we are in exponential backoff mode and it is not yet the next request time.
 - (BOOL)shouldThrottle;
 

FirebaseRemoteConfig/Sources/Public/FirebaseRemoteConfig/FIRRemoteConfig.h

@@ -30,6 +30,23 @@ extern NSString *const _Nonnull FIRNamespaceGoogleMobilePlatform NS_SWIFT_NAME(
 extern NSString *const _Nonnull FIRRemoteConfigThrottledEndTimeInSecondsKey NS_SWIFT_NAME(
     RemoteConfigThrottledEndTimeInSecondsKey);
 
+/**
+ * Listener registration returned by `addOnConfigUpdateListener`. Calling its method `remove` stops
+ * the listener from receiving config updates and unregisters itself.
+ *
+ * If remove is called and no other listener registrations remain, the connection to the real-time
+ * RC backend is closed. Subsequently calling `addOnConfigUpdateListener` will re-open the
+ * connection.
+ */
+NS_SWIFT_NAME(ConfigUpdateListenerRegistration)
+@interface FIRConfigUpdateListenerRegistration : NSObject
+/**
+ * Removes the listener being tracked by this `ConfigUpdateListenerRegistration`. After the initial
+ * call, subsequent calls have no effect.
+ */
+- (void)remove;
+@end
+
 /// Indicates whether updated data was successfully fetched.
 typedef NS_ENUM(NSInteger, FIRRemoteConfigFetchStatus) {
   /// Config has never been fetched.
@@ -65,6 +82,20 @@ typedef NS_ERROR_ENUM(FIRRemoteConfigErrorDomain, FIRRemoteConfigError){
     FIRRemoteConfigErrorInternalError = 8003,
 } NS_SWIFT_NAME(RemoteConfigError);
 
+/// Remote Config error domain that handles errors for the real-time service.
+extern NSString *const _Nonnull FIRRemoteConfigUpdateErrorDomain NS_SWIFT_NAME(RemoteConfigUpdateErrorDomain);
+/// Firebase Remote Config real-time service error.
+typedef NS_ERROR_ENUM(FIRRemoteConfigUpdateErrorDomain, FIRRemoteConfigUpdateError){
+    /// Unable to make a connection to the backend.
+    FIRRemoteConfigUpdateErrorStreamError = 8001,
+    /// Unable to fetch the latest config.
+    FIRRemoteConfigUpdateErrorNotFetched = 8002,
+    /// The ConfigUpdate message was unparsable.
+    FIRRemoteConfigUpdateErrorMessageInvalid = 8003,
+    /// The real-time Remote Config service is unavailable.
+    FIRRemoteConfigUpdateErrorUnavailable = 8004,
+} NS_SWIFT_NAME(RemoteConfigUpdateError);
+
 /// Enumerated value that indicates the source of Remote Config data. Data can come from
 /// the Remote Config service, the DefaultConfig that is available when the app is first installed,
 /// or a static initialized value if data is not available from the service or DefaultConfig.
@@ -139,6 +170,17 @@ NS_SWIFT_NAME(RemoteConfigSettings)
 @property(nonatomic, assign) NSTimeInterval fetchTimeout;
 @end
 
+#pragma mark - FIRRemoteConfigUpdate
+/// Firebase Remote Config update
+NS_SWIFT_NAME(RemoteConfigUpdate)
+@interface FIRRemoteConfigUpdate : NSObject
+
+/// Parameter keys whose values have been updated from the currently activated values. Includes
+/// keys that are added, deleted, and whose value, value source, or metadata has changed.
+@property(nonatomic, readonly, nonnull) NSSet<NSString *> *updatedKeys;
+
+@end
+
 #pragma mark - FIRRemoteConfig
 /// Firebase Remote Config class. The class method `remoteConfig()` can be used
 /// to fetch, activate and read config results and set default config results on the default
@@ -283,4 +325,34 @@ NS_SWIFT_NAME(RemoteConfig)
 ///                         nil if the key doesn't exist in the default config.
 - (nullable FIRRemoteConfigValue *)defaultValueForKey:(nullable NSString *)key;
 
+#pragma mark - Realtime
+
+/// Completion handler invoked by `addOnConfigUpdateListener` when there is an update to
+/// the config from the backend.
+///
+/// @param configUpdate Information on which key's values have changed
+/// @param error  Error message on failure.
+typedef void (^FIRRemoteConfigUpdateCompletion)(FIRRemoteConfigUpdate *_Nullable configUpdate,
+                                                NSError *_Nullable error)
+    NS_SWIFT_UNAVAILABLE("Use Swift's closure syntax instead.");
+
+/// Start listening for real-time config updates from the Remote Config backend and automatically
+/// fetch updates when they're available.
+///
+/// If a connection to the Remote Config backend is not already open, calling this method will
+/// open it. Multiple listeners can be added by calling this method again, but subsequent calls
+/// re-use the same connection to the backend.
+///
+/// Note: Real-time Remote Config requires the Firebase Remote Config Realtime API. See Get started
+/// with Firebase Remote Config at https://firebase.google.com/docs/remote-config/get-started for
+/// more information.
+///
+/// @param listener              The configured listener that is called for every config update.
+/// @return              Returns a registration representing the listener. The registration contains
+/// a remove method, which can be used to stop receiving for updates for this particular
+/// registration.
+- (FIRConfigUpdateListenerRegistration *_Nonnull)addOnConfigUpdateListener:
+    (FIRRemoteConfigUpdateCompletion _Nonnull)listener
+    NS_SWIFT_NAME(addOnConfigUpdateListener(remoteConfigUpdateCompletion:));
+
 @end

FirebaseRemoteConfig/Sources/RCNConfigConstants.h

@@ -58,3 +58,5 @@ 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
+static NSString *const RCNFetchResponseKeyTemplateVersion = @"templateVersion";

FirebaseRemoteConfig/Sources/RCNConfigContent.h

@@ -16,6 +16,8 @@
 
 #import <Foundation/Foundation.h>
 
+#import "FirebaseRemoteConfig/Sources/Public/FirebaseRemoteConfig/FIRRemoteConfig.h"
+
 typedef NS_ENUM(NSInteger, RCNDBSource) {
   RCNDBSourceActive,
   RCNDBSourceDefault,
@@ -63,4 +65,7 @@ typedef NS_ENUM(NSInteger, RCNDBSource) {
 /// Gets the active config and Personalization metadata.
 - (NSDictionary *)getConfigAndMetadataForNamespace:(NSString *)FIRNamespace;
 
+/// Returns the updated parameters between fetched and active config.
+- (FIRRemoteConfigUpdate *)getConfigUpdateForNamespace:(NSString *)FIRNamespace;
+
 @end