Files
firebase-ios-sdk/FirebaseRemoteConfig/Sources/FIRRemoteConfig.m
T
4e5b83f2d9 Merge Realtime into Remote Config (#10060)
* Realtime rc dev (#9807)

* Remove commits from non-CLA account. Move TypeDef to private RCNRealtimeConfig file.

* Remove completion handler typedef

* Format file

* Update listener registration description

* Realtime rc dev (#9835)

* Remove commits from non-CLA account. Move TypeDef to private RCNRealtimeConfig file.

* Remove completion handler typedef

* Format file

* Update listener registration description

* Add http streaming and auto fetch. Also add template version number to cache for autofetch.

* Format file.

* Add unit tests

* Format files

* fix test

* update test and header file

* Change templateVersionNumber to ivar

* Fix async tests and update NSDictionary changes

* Format file

* Update fetch time

* remove define header

* Wrap auto fetch in async queue

* Add auto fetch test

* Change template version extraction check.

* Change realtime error code to start at 8001

* Realtime rc dev (#9914)

* Remove commits from non-CLA account. Move TypeDef to private RCNRealtimeConfig file.

* Remove completion handler typedef

* Format file

* Update listener registration description

* Add http streaming and auto fetch. Also add template version number to cache for autofetch.

* Format file.

* Add unit tests

* Format files

* fix test

* update test and header file

* Change templateVersionNumber to ivar

* Fix async tests and update NSDictionary changes

* Format file

* Update fetch time

* remove define header

* Add http stream retry and background change listener.

* Wrap auto fetch in async queue

* Expose realtime method in public

* Update comments

* Add auto fetch test

* Change template version extraction check.

* Change realtime error code to start at 8001

* Change from NSTimer to dispatch. Add flag to guard against retrying.

* Format and add comments.

* Update tests

* Qdpham13 patch 1 (#9913)

* Delete .SecondApp-GoogleService-Info.plist

* Delete SecondApp-GoogleService-Info.plist

* Delete GoogleService-Info.plist

* Delete SecondApp-GoogleService-Info.plist

* Update ViewController.m

* Delete clang-format directory

* format

* Change to NSExtensionHostWillEnterForegroundNotification

* Change to UIApplicationWillEnterForegroundNotification

* add import

* Remove import, use string literal instead of UIKit enum

* add test for new public method

* Update template version number retrieval function and update delay

* Fix test

* Fix test

* Update retry seconds and fetch interval seconds

* Update ddos to DDoS

* Update variable according to style guide.

* Replace NSLog with kFIRLoggerRemoteConfig (#10062)

* Replace NSLog with kFIRLoggerRemoteConfig

* Remove logs and change others from info to debug.

* update log messages.

* Format files

* Realtime rc failsafe (#10067)

* Add failsafe logic to request, response and application logic.

* Update flag name and conditions.

* Format file

* Add check for template version number

* Format files

* Changes based on PR comments

* move response parsing logic to separate function and add test for failsafe flag

* Update based on PR comments and add method to propagate error to listeners in queue.

* Realtime rc merge patch v1 (#10089)

* Fix foreground reconnection naming, add background check and flag, add check to see if fetch is currently in progress.

* Add check so fetches come only when the template version is greater than the current one.

* Format file changes

* Add debug log

* Make changes based on PR comments.

* Resolve failsafe changes

* Updating instance var names

* change template version check for auto fetch from >= to >

* Cherry-pick #10123 into Firebase 9.5.0

* [RC] Fix retry logic to respect max retry count (#10143)

* Fix retry logic to respect max retry count

* Rename to isRequestInProgress

* Save template version in settings (#10162)

* Save template version in settings

* Format files

* set last template version to 0

* Store template version in userDefaults instead of deviceContents

* return nil for unsuccessful fetches

* fix typo

* Realtime rc no change (#10188)

* Save template version in settings

* Format files

* set last template version to 0

* Store template version in userDefaults instead of deviceContents

* return nil for unsuccessful fetches

* fix typo

* put addEtagToHeader flag to fetch and propagate it to surrounding functions

* Add excludeEtagHeaderForRealtime flag to RCNConfigFetch

* Update mocks for Swift test

* Fix flag

* Add commentting

* reconcile master branch merge conflicts

* Revert "Realtime rc no change (#10188)" (#10346)

This reverts commit abe7939602.
In part of implementing a different solution.

* Add Http status check to Realtime stream (#10406)

* Check status code before retrying

* Change time out to 5 and a half minutes

* Throw exception if unable to establish connection due to non-retryable status code

* Format file

* Replace old realtime exceptions with new exceptions (#10482)

* Replace old realtime exceptions with new exceptions

* Fix word type

* Realtime RC Fetch ID (#10499)

* Add Realtime specific fetch method and fetch type header changes

* Add test

* Add comments and format

* Fix tests

* Update fetch header name

* Update tests and edit realtime fetch name and params

* refactor remainingAttempts var

* Realtime rc backoff (#10483)

* Change Realtime back off to use same system as Fetch and persist backoff state

* format and fix merge conflict

* Save retry count along with other throttling metadata

* Update var name

* Fix naming

* Return ConfigUpdate to realtime listeners (#10578)

* diff fetched and active config on realtime fetch

* Some refactoring and added tests

* Revert some unrelated changes to fetch

* Fix formatting

* Update branch and fix swift tests

* Rename updatedParams to updatedKeys (#10683)

* Update Realtime RC service URL. (#10713)

* Compare p13n metadata values as dictionaries. (#10756)

* Realtime RC 1P Bug Fix: Add checks for retryHttpConnection method (#10770)

* Add checks to retry method

* Move background check to beginning of retry

* Capitalize FetchType header (#10774)

* Remove Fetch Duplicate error and fix API misuse error (#10814)

* Remove fetch duplicate error

* Move completionHandler to bottom of didReceiveData

* Remove unused var

* Return Server produced error if Http status code is 403  (#10844)

* Add API message to enable Realtime

* Update error message parsing to return error message from backend

* Format file

* Add comment and remove unnecessary string

* Format and update error checks

* Change matcher string

* Update matcher string

* Address PR comments (#10845)

* Address PR comments

* Add Realtime Swift mocks

* Remove unnecessary mocks

* Format files

* Format tests

* Add Realtime mock

* Add missing quote

* Fix bugs

* Remove import

* Update import

* Change import

* Don't make connection call for Realtime mock

* Move around import of RCNConfigSettings

* Fix andDo

* Update test

* Add mockedRealtime flags

* trigger integration test

* Add integration and unit test

* change constant value

* Add new RC key

* Update update

* Remove deleted item

* Add registration removal

* Fix and format files

* remove semicolon

* Update error check

* remove space

* Update capitalization

* Add space

* Remove spaces

* remove more spaces

* Remove comment and add swift name

* format

* Add tests and sampleApp changes for updatedKeys (#10879)

* Update tests and sample app

* change key name

* remove unused var

* Add comment

* update sampleApp comments

* Update comments for public methods

* Update backoff commenting

* Add changelog entry for real-time updates. (#10942)

* Add changelog entry for RC real time updates.

* Hyphenation.

* Change doc references to hyphenate real-time (#10948)

* Change doc references to hyphenate real-time

* Run formatter.

* Re-word real-time paragraph to flow better.

---------

Co-authored-by: Andrew Heard <andrew@wizheard.com>
Co-authored-by: karenyz <58443706+karenyz@users.noreply.github.com>
Co-authored-by: Karen Zeng <karenzeng@google.com>
Co-authored-by: Dana Silver <dsilver1221@gmail.com>
Co-authored-by: Dana Silver <danasilver@google.com>
2023-03-13 16:02:56 -07:00

617 lines
25 KiB
Objective-C

/*
* Copyright 2019 Google
*
* 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 "FirebaseRemoteConfig/Sources/Public/FirebaseRemoteConfig/FIRRemoteConfig.h"
#import "FirebaseABTesting/Sources/Private/FirebaseABTestingInternal.h"
#import "FirebaseCore/Extension/FirebaseCoreInternal.h"
#import "FirebaseRemoteConfig/Sources/FIRRemoteConfigComponent.h"
#import "FirebaseRemoteConfig/Sources/Private/FIRRemoteConfig_Private.h"
#import "FirebaseRemoteConfig/Sources/Private/RCNConfigFetch.h"
#import "FirebaseRemoteConfig/Sources/Private/RCNConfigSettings.h"
#import "FirebaseRemoteConfig/Sources/RCNConfigConstants.h"
#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.
static NSString *const kRemoteConfigMinimumFetchIntervalKey = @"_rcn_minimum_fetch_interval";
/// Timeout value for waiting on a fetch response.
static NSString *const kRemoteConfigFetchTimeoutKey = @"_rcn_fetch_timeout";
/// Notification when config is successfully activated
const NSNotificationName FIRRemoteConfigActivateNotification =
@"FIRRemoteConfigActivateNotification";
/// Listener for the get methods.
typedef void (^FIRRemoteConfigListener)(NSString *_Nonnull, NSDictionary *_Nonnull);
@implementation FIRRemoteConfigSettings
- (instancetype)init {
self = [super init];
if (self) {
_minimumFetchInterval = RCNDefaultMinimumFetchInterval;
_fetchTimeout = RCNHTTPDefaultConnectionTimeout;
}
return self;
}
@end
@implementation FIRRemoteConfig {
/// All the config content.
RCNConfigContent *_configContent;
RCNConfigDBManager *_DBManager;
RCNConfigSettings *_settings;
RCNConfigFetch *_configFetch;
RCNConfigExperiment *_configExperiment;
RCNConfigRealtime *_configRealtime;
dispatch_queue_t _queue;
NSString *_appName;
NSMutableArray *_listeners;
}
static NSMutableDictionary<NSString *, NSMutableDictionary<NSString *, FIRRemoteConfig *> *>
*RCInstances;
+ (nonnull FIRRemoteConfig *)remoteConfigWithApp:(FIRApp *_Nonnull)firebaseApp {
return [FIRRemoteConfig remoteConfigWithFIRNamespace:FIRNamespaceGoogleMobilePlatform
app:firebaseApp];
}
+ (nonnull FIRRemoteConfig *)remoteConfigWithFIRNamespace:(NSString *_Nonnull)firebaseNamespace {
if (![FIRApp isDefaultAppConfigured]) {
[NSException raise:@"FIRAppNotConfigured"
format:@"The default `FirebaseApp` instance must be configured before the "
@"default Remote Config instance can be initialized. One way to ensure this "
@"is to call `FirebaseApp.configure()` in the App Delegate's "
@"`application(_:didFinishLaunchingWithOptions:)` or the `@main` struct's "
@"initializer in SwiftUI."];
}
return [FIRRemoteConfig remoteConfigWithFIRNamespace:firebaseNamespace app:[FIRApp defaultApp]];
}
+ (nonnull FIRRemoteConfig *)remoteConfigWithFIRNamespace:(NSString *_Nonnull)firebaseNamespace
app:(FIRApp *_Nonnull)firebaseApp {
// Use the provider to generate and return instances of FIRRemoteConfig for this specific app and
// namespace. This will ensure the app is configured before Remote Config can return an instance.
id<FIRRemoteConfigProvider> provider =
FIR_COMPONENT(FIRRemoteConfigProvider, firebaseApp.container);
return [provider remoteConfigForNamespace:firebaseNamespace];
}
+ (FIRRemoteConfig *)remoteConfig {
// If the default app is not configured at this point, warn the developer.
if (![FIRApp isDefaultAppConfigured]) {
[NSException raise:@"FIRAppNotConfigured"
format:@"The default `FirebaseApp` instance must be configured before the "
@"default Remote Config instance can be initialized. One way to ensure this "
@"is to call `FirebaseApp.configure()` in the App Delegate's "
@"`application(_:didFinishLaunchingWithOptions:)` or the `@main` struct's "
@"initializer in SwiftUI."];
}
return [FIRRemoteConfig remoteConfigWithFIRNamespace:FIRNamespaceGoogleMobilePlatform
app:[FIRApp defaultApp]];
}
/// Singleton instance of serial queue for queuing all incoming RC calls.
+ (dispatch_queue_t)sharedRemoteConfigSerialQueue {
static dispatch_once_t onceToken;
static dispatch_queue_t sharedRemoteConfigQueue;
dispatch_once(&onceToken, ^{
sharedRemoteConfigQueue =
dispatch_queue_create(RCNRemoteConfigQueueLabel, DISPATCH_QUEUE_SERIAL);
});
return sharedRemoteConfigQueue;
}
/// Designated initializer
- (instancetype)initWithAppName:(NSString *)appName
FIROptions:(FIROptions *)options
namespace:(NSString *)FIRNamespace
DBManager:(RCNConfigDBManager *)DBManager
configContent:(RCNConfigContent *)configContent
analytics:(nullable id<FIRAnalyticsInterop>)analytics {
self = [super init];
if (self) {
_appName = appName;
_DBManager = DBManager;
// The fully qualified Firebase namespace is namespace:firappname.
_FIRNamespace = [NSString stringWithFormat:@"%@:%@", FIRNamespace, appName];
// Initialize RCConfigContent if not already.
_configContent = configContent;
_settings = [[RCNConfigSettings alloc] initWithDatabaseManager:_DBManager
namespace:_FIRNamespace
firebaseAppName:appName
googleAppID:options.googleAppID];
FIRExperimentController *experimentController = [FIRExperimentController sharedInstance];
_configExperiment = [[RCNConfigExperiment alloc] initWithDBManager:_DBManager
experimentController:experimentController];
/// Serial queue for read and write lock.
_queue = [FIRRemoteConfig sharedRemoteConfigSerialQueue];
// Initialize with default config settings.
[self setDefaultConfigSettings];
_configFetch = [[RCNConfigFetch alloc] initWithContent:_configContent
DBManager:_DBManager
settings:_settings
analytics:analytics
experiment:_configExperiment
queue:_queue
namespace:_FIRNamespace
options:options];
_configRealtime = [[RCNConfigRealtime alloc] init:_configFetch
settings:_settings
namespace:_FIRNamespace
options:options];
[_settings loadConfigFromMetadataTable];
if (analytics) {
_listeners = [[NSMutableArray alloc] init];
RCNPersonalization *personalization =
[[RCNPersonalization alloc] initWithAnalytics:analytics];
[self addListener:^(NSString *key, NSDictionary *config) {
[personalization logArmActive:key config:config];
}];
}
}
return self;
}
// Initialize with default config settings.
- (void)setDefaultConfigSettings {
// Set the default config settings.
self->_settings.fetchTimeout = RCNHTTPDefaultConnectionTimeout;
self->_settings.minimumFetchInterval = RCNDefaultMinimumFetchInterval;
}
- (void)ensureInitializedWithCompletionHandler:
(nonnull FIRRemoteConfigInitializationCompletion)completionHandler {
__weak FIRRemoteConfig *weakSelf = self;
dispatch_async(dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_LOW, 0), ^{
FIRRemoteConfig *strongSelf = weakSelf;
if (!strongSelf) {
return;
}
BOOL initializationSuccess = [self->_configContent initializationSuccessful];
NSError *error = nil;
if (!initializationSuccess) {
error = [[NSError alloc]
initWithDomain:FIRRemoteConfigErrorDomain
code:FIRRemoteConfigErrorInternalError
userInfo:@{NSLocalizedDescriptionKey : @"Timed out waiting for database load."}];
}
completionHandler(error);
});
}
/// Adds a listener that will be called whenever one of the get methods is called.
/// @param listener Function that takes in the parameter key and the config.
- (void)addListener:(nonnull FIRRemoteConfigListener)listener {
@synchronized(_listeners) {
[_listeners addObject:listener];
}
}
- (void)callListeners:(NSString *)key config:(NSDictionary *)config {
@synchronized(_listeners) {
for (FIRRemoteConfigListener listener in _listeners) {
dispatch_async(_queue, ^{
listener(key, config);
});
}
}
}
#pragma mark - fetch
- (void)fetchWithCompletionHandler:(FIRRemoteConfigFetchCompletion)completionHandler {
dispatch_async(_queue, ^{
[self fetchWithExpirationDuration:self->_settings.minimumFetchInterval
completionHandler:completionHandler];
});
}
- (void)fetchWithExpirationDuration:(NSTimeInterval)expirationDuration
completionHandler:(FIRRemoteConfigFetchCompletion)completionHandler {
FIRRemoteConfigFetchCompletion completionHandlerCopy = nil;
if (completionHandler) {
completionHandlerCopy = [completionHandler copy];
}
[_configFetch fetchConfigWithExpirationDuration:expirationDuration
completionHandler:completionHandlerCopy];
}
#pragma mark - fetchAndActivate
- (void)fetchAndActivateWithCompletionHandler:
(FIRRemoteConfigFetchAndActivateCompletion)completionHandler {
__weak FIRRemoteConfig *weakSelf = self;
FIRRemoteConfigFetchCompletion fetchCompletion =
^(FIRRemoteConfigFetchStatus fetchStatus, NSError *fetchError) {
FIRRemoteConfig *strongSelf = weakSelf;
if (!strongSelf) {
return;
}
// Fetch completed. We are being called on the main queue.
// If fetch is successful, try to activate the fetched config
if (fetchStatus == FIRRemoteConfigFetchStatusSuccess && !fetchError) {
[strongSelf activateWithCompletion:^(BOOL changed, NSError *_Nullable activateError) {
if (completionHandler) {
FIRRemoteConfigFetchAndActivateStatus status =
activateError ? FIRRemoteConfigFetchAndActivateStatusSuccessUsingPreFetchedData
: FIRRemoteConfigFetchAndActivateStatusSuccessFetchedFromRemote;
dispatch_async(dispatch_get_main_queue(), ^{
completionHandler(status, nil);
});
}
}];
} else if (completionHandler) {
FIRRemoteConfigFetchAndActivateStatus status =
fetchStatus == FIRRemoteConfigFetchStatusSuccess
? FIRRemoteConfigFetchAndActivateStatusSuccessUsingPreFetchedData
: FIRRemoteConfigFetchAndActivateStatusError;
dispatch_async(dispatch_get_main_queue(), ^{
completionHandler(status, fetchError);
});
}
};
[self fetchWithCompletionHandler:fetchCompletion];
}
#pragma mark - activate
typedef void (^FIRRemoteConfigActivateChangeCompletion)(BOOL changed, NSError *_Nullable error);
- (void)activateWithCompletion:(FIRRemoteConfigActivateChangeCompletion)completion {
__weak FIRRemoteConfig *weakSelf = self;
void (^applyBlock)(void) = ^(void) {
FIRRemoteConfig *strongSelf = weakSelf;
if (!strongSelf) {
NSError *error = [NSError errorWithDomain:FIRRemoteConfigErrorDomain
code:FIRRemoteConfigErrorInternalError
userInfo:@{@"ActivationFailureReason" : @"Internal Error."}];
if (completion) {
dispatch_async(dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_DEFAULT, 0), ^{
completion(NO, error);
});
}
FIRLogError(kFIRLoggerRemoteConfig, @"I-RCN000068", @"Internal error activating config.");
return;
}
// Check if the last fetched config has already been activated. Fetches with no data change are
// ignored.
if (strongSelf->_settings.lastETagUpdateTime == 0 ||
strongSelf->_settings.lastETagUpdateTime <= strongSelf->_settings.lastApplyTimeInterval) {
FIRLogDebug(kFIRLoggerRemoteConfig, @"I-RCN000069",
@"Most recently fetched config is already activated.");
if (completion) {
dispatch_async(dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_DEFAULT, 0), ^{
completion(NO, nil);
});
}
return;
}
[strongSelf->_configContent copyFromDictionary:self->_configContent.fetchedConfig
toSource:RCNDBSourceActive
forNamespace:self->_FIRNamespace];
strongSelf->_settings.lastApplyTimeInterval = [[NSDate date] timeIntervalSince1970];
// New config has been activated at this point
FIRLogDebug(kFIRLoggerRemoteConfig, @"I-RCN000069", @"Config activated.");
[strongSelf->_configContent activatePersonalization];
// Update experiments only for 3p namespace
NSString *namespace = [strongSelf->_FIRNamespace
substringToIndex:[strongSelf->_FIRNamespace rangeOfString:@":"].location];
if ([namespace isEqualToString:FIRNamespaceGoogleMobilePlatform]) {
dispatch_async(dispatch_get_main_queue(), ^{
[self notifyConfigHasActivated];
});
[strongSelf->_configExperiment updateExperimentsWithHandler:^(NSError *_Nullable error) {
if (completion) {
dispatch_async(dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_DEFAULT, 0), ^{
completion(YES, nil);
});
}
}];
} else {
if (completion) {
dispatch_async(dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_DEFAULT, 0), ^{
completion(YES, nil);
});
}
}
};
dispatch_async(_queue, applyBlock);
}
- (void)notifyConfigHasActivated {
// Need a valid google app name.
if (!_appName) {
return;
}
// The Remote Config Swift SDK will be listening for this notification so it can tell SwiftUI to
// update the UI.
NSDictionary *appInfoDict = @{kFIRAppNameKey : _appName};
[[NSNotificationCenter defaultCenter] postNotificationName:FIRRemoteConfigActivateNotification
object:self
userInfo:appInfoDict];
}
#pragma mark - helpers
- (NSString *)fullyQualifiedNamespace:(NSString *)namespace {
// If this is already a fully qualified namespace, return.
if ([namespace rangeOfString:@":"].location != NSNotFound) {
return namespace;
}
NSString *fullyQualifiedNamespace = [NSString stringWithFormat:@"%@:%@", namespace, _appName];
return fullyQualifiedNamespace;
}
#pragma mark - Get Config Result
- (FIRRemoteConfigValue *)objectForKeyedSubscript:(NSString *)key {
return [self configValueForKey:key];
}
- (FIRRemoteConfigValue *)configValueForKey:(NSString *)key {
if (!key) {
return [[FIRRemoteConfigValue alloc] initWithData:[NSData data]
source:FIRRemoteConfigSourceStatic];
}
NSString *FQNamespace = [self fullyQualifiedNamespace:_FIRNamespace];
__block FIRRemoteConfigValue *value;
dispatch_sync(_queue, ^{
value = self->_configContent.activeConfig[FQNamespace][key];
if (value) {
if (value.source != FIRRemoteConfigSourceRemote) {
FIRLogError(kFIRLoggerRemoteConfig, @"I-RCN000001",
@"Key %@ should come from source:%zd instead coming from source: %zd.", key,
(long)FIRRemoteConfigSourceRemote, (long)value.source);
}
[self callListeners:key
config:[self->_configContent getConfigAndMetadataForNamespace:FQNamespace]];
return;
}
value = self->_configContent.defaultConfig[FQNamespace][key];
if (value) {
return;
}
value = [[FIRRemoteConfigValue alloc] initWithData:[NSData data]
source:FIRRemoteConfigSourceStatic];
});
return value;
}
- (FIRRemoteConfigValue *)configValueForKey:(NSString *)key source:(FIRRemoteConfigSource)source {
if (!key) {
return [[FIRRemoteConfigValue alloc] initWithData:[NSData data]
source:FIRRemoteConfigSourceStatic];
}
NSString *FQNamespace = [self fullyQualifiedNamespace:_FIRNamespace];
__block FIRRemoteConfigValue *value;
dispatch_sync(_queue, ^{
if (source == FIRRemoteConfigSourceRemote) {
value = self->_configContent.activeConfig[FQNamespace][key];
} else if (source == FIRRemoteConfigSourceDefault) {
value = self->_configContent.defaultConfig[FQNamespace][key];
} else {
value = [[FIRRemoteConfigValue alloc] initWithData:[NSData data]
source:FIRRemoteConfigSourceStatic];
}
});
return value;
}
- (NSUInteger)countByEnumeratingWithState:(NSFastEnumerationState *)state
objects:(id __unsafe_unretained[])stackbuf
count:(NSUInteger)len {
__block NSUInteger localValue;
dispatch_sync(_queue, ^{
localValue =
[self->_configContent.activeConfig[self->_FIRNamespace] countByEnumeratingWithState:state
objects:stackbuf
count:len];
});
return localValue;
}
#pragma mark - Properties
/// Last fetch completion time.
- (NSDate *)lastFetchTime {
__block NSDate *fetchTime;
dispatch_sync(_queue, ^{
NSTimeInterval lastFetchTime = self->_settings.lastFetchTimeInterval;
fetchTime = [NSDate dateWithTimeIntervalSince1970:lastFetchTime];
});
return fetchTime;
}
- (FIRRemoteConfigFetchStatus)lastFetchStatus {
__block FIRRemoteConfigFetchStatus currentStatus;
dispatch_sync(_queue, ^{
currentStatus = self->_settings.lastFetchStatus;
});
return currentStatus;
}
- (NSArray *)allKeysFromSource:(FIRRemoteConfigSource)source {
__block NSArray *keys = [[NSArray alloc] init];
dispatch_sync(_queue, ^{
NSString *FQNamespace = [self fullyQualifiedNamespace:self->_FIRNamespace];
switch (source) {
case FIRRemoteConfigSourceDefault:
if (self->_configContent.defaultConfig[FQNamespace]) {
keys = [[self->_configContent.defaultConfig[FQNamespace] allKeys] copy];
}
break;
case FIRRemoteConfigSourceRemote:
if (self->_configContent.activeConfig[FQNamespace]) {
keys = [[self->_configContent.activeConfig[FQNamespace] allKeys] copy];
}
break;
default:
break;
}
});
return keys;
}
- (nonnull NSSet *)keysWithPrefix:(nullable NSString *)prefix {
__block NSMutableSet *keys = [[NSMutableSet alloc] init];
dispatch_sync(_queue, ^{
NSString *FQNamespace = [self fullyQualifiedNamespace:self->_FIRNamespace];
if (self->_configContent.activeConfig[FQNamespace]) {
NSArray *allKeys = [self->_configContent.activeConfig[FQNamespace] allKeys];
if (!prefix.length) {
keys = [NSMutableSet setWithArray:allKeys];
} else {
for (NSString *key in allKeys) {
if ([key hasPrefix:prefix]) {
[keys addObject:key];
}
}
}
}
});
return [keys copy];
}
#pragma mark - Defaults
- (void)setDefaults:(NSDictionary<NSString *, NSObject *> *)defaultConfig {
NSString *FQNamespace = [self fullyQualifiedNamespace:_FIRNamespace];
NSDictionary *defaultConfigCopy = [[NSDictionary alloc] init];
if (defaultConfig) {
defaultConfigCopy = [defaultConfig copy];
}
void (^setDefaultsBlock)(void) = ^(void) {
NSDictionary *namespaceToDefaults = @{FQNamespace : defaultConfigCopy};
[self->_configContent copyFromDictionary:namespaceToDefaults
toSource:RCNDBSourceDefault
forNamespace:FQNamespace];
self->_settings.lastSetDefaultsTimeInterval = [[NSDate date] timeIntervalSince1970];
};
dispatch_async(_queue, setDefaultsBlock);
}
- (FIRRemoteConfigValue *)defaultValueForKey:(NSString *)key {
NSString *FQNamespace = [self fullyQualifiedNamespace:_FIRNamespace];
__block FIRRemoteConfigValue *value;
dispatch_sync(_queue, ^{
NSDictionary *defaultConfig = self->_configContent.defaultConfig;
value = defaultConfig[FQNamespace][key];
if (value) {
if (value.source != FIRRemoteConfigSourceDefault) {
FIRLogError(kFIRLoggerRemoteConfig, @"I-RCN000002",
@"Key %@ should come from source:%zd instead coming from source: %zd", key,
(long)FIRRemoteConfigSourceDefault, (long)value.source);
}
}
});
return value;
}
- (void)setDefaultsFromPlistFileName:(nullable NSString *)fileName {
if (!fileName || fileName.length == 0) {
FIRLogWarning(kFIRLoggerRemoteConfig, @"I-RCN000037",
@"The plist file '%@' could not be found by Remote Config.", fileName);
return;
}
NSArray *bundles = @[ [NSBundle mainBundle], [NSBundle bundleForClass:[self class]] ];
for (NSBundle *bundle in bundles) {
NSString *plistFile = [bundle pathForResource:fileName ofType:@"plist"];
// Use the first one we find.
if (plistFile) {
NSDictionary *defaultConfig = [[NSDictionary alloc] initWithContentsOfFile:plistFile];
if (defaultConfig) {
[self setDefaults:defaultConfig];
}
return;
}
}
FIRLogWarning(kFIRLoggerRemoteConfig, @"I-RCN000037",
@"The plist file '%@' could not be found by Remote Config.", fileName);
}
#pragma mark - custom variables
- (FIRRemoteConfigSettings *)configSettings {
__block NSTimeInterval minimumFetchInterval = RCNDefaultMinimumFetchInterval;
__block NSTimeInterval fetchTimeout = RCNHTTPDefaultConnectionTimeout;
dispatch_sync(_queue, ^{
minimumFetchInterval = self->_settings.minimumFetchInterval;
fetchTimeout = self->_settings.fetchTimeout;
});
FIRLogDebug(kFIRLoggerRemoteConfig, @"I-RCN000066",
@"Successfully read configSettings. Minimum Fetch Interval:%f, "
@"Fetch timeout: %f",
minimumFetchInterval, fetchTimeout);
FIRRemoteConfigSettings *settings = [[FIRRemoteConfigSettings alloc] init];
settings.minimumFetchInterval = minimumFetchInterval;
settings.fetchTimeout = fetchTimeout;
/// The NSURLSession needs to be recreated whenever the fetch timeout may be updated.
[_configFetch recreateNetworkSession];
return settings;
}
- (void)setConfigSettings:(FIRRemoteConfigSettings *)configSettings {
void (^setConfigSettingsBlock)(void) = ^(void) {
if (!configSettings) {
return;
}
self->_settings.minimumFetchInterval = configSettings.minimumFetchInterval;
self->_settings.fetchTimeout = configSettings.fetchTimeout;
/// The NSURLSession needs to be recreated whenever the fetch timeout may be updated.
[self->_configFetch recreateNetworkSession];
FIRLogDebug(kFIRLoggerRemoteConfig, @"I-RCN000067",
@"Successfully set configSettings. Minimum Fetch Interval:%f, "
@"Fetch timeout:%f",
configSettings.minimumFetchInterval, configSettings.fetchTimeout);
};
dispatch_async(_queue, setConfigSettingsBlock);
}
#pragma mark - Realtime
- (FIRConfigUpdateListenerRegistration *)addOnConfigUpdateListener:
(void (^_Nonnull)(FIRRemoteConfigUpdate *update, NSError *_Nullable error))listener {
return [self->_configRealtime addConfigUpdateListener:listener];
}
@end