Files
firebase-ios-sdk/Firestore/Source/API/FIRFirestoreSettings.mm
T
Konstantin Varlamov a17740e914 Add a flag to control whether DocumentSnapshots return Dates or Timestamps for timestamp fields (#831)
* add a new property `timestampsInSnapshotsEnabled` to `FirestoreSettings`, `false` by default;
* add a verbose warning message urging users to opt into the new behavior;
* set `timestampsInSnapshotsEnabled` to true in the integration tests to reduce the verbose console
spam during the test run and make sure the flag won't break anything once it's flipped.
2018-03-30 14:50:15 -04:00

99 lines
3.2 KiB
Plaintext

/*
* Copyright 2017 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 "FIRFirestoreSettings.h"
#import "Firestore/Source/Util/FSTUsageValidation.h"
NS_ASSUME_NONNULL_BEGIN
static NSString *const kDefaultHost = @"firestore.googleapis.com";
static const BOOL kDefaultSSLEnabled = YES;
static const BOOL kDefaultPersistenceEnabled = YES;
// TODO(b/73820332): flip the default.
static const BOOL kDefaultTimestampsInSnapshotsEnabled = NO;
@implementation FIRFirestoreSettings
- (instancetype)init {
if (self = [super init]) {
_host = kDefaultHost;
_sslEnabled = kDefaultSSLEnabled;
_dispatchQueue = dispatch_get_main_queue();
_persistenceEnabled = kDefaultPersistenceEnabled;
_timestampsInSnapshotsEnabled = kDefaultTimestampsInSnapshotsEnabled;
}
return self;
}
- (BOOL)isEqual:(id)other {
if (self == other) {
return YES;
} else if (![other isKindOfClass:[FIRFirestoreSettings class]]) {
return NO;
}
FIRFirestoreSettings *otherSettings = (FIRFirestoreSettings *)other;
return [self.host isEqual:otherSettings.host] &&
self.isSSLEnabled == otherSettings.isSSLEnabled &&
self.dispatchQueue == otherSettings.dispatchQueue &&
self.isPersistenceEnabled == otherSettings.isPersistenceEnabled &&
self.timestampsInSnapshotsEnabled == otherSettings.timestampsInSnapshotsEnabled;
}
- (NSUInteger)hash {
NSUInteger result = [self.host hash];
result = 31 * result + (self.isSSLEnabled ? 1231 : 1237);
// Ignore the dispatchQueue to avoid having to deal with sizeof(dispatch_queue_t).
result = 31 * result + (self.isPersistenceEnabled ? 1231 : 1237);
result = 31 * result + (self.timestampsInSnapshotsEnabled ? 1231 : 1237);
return result;
}
- (id)copyWithZone:(nullable NSZone *)zone {
FIRFirestoreSettings *copy = [[FIRFirestoreSettings alloc] init];
copy.host = _host;
copy.sslEnabled = _sslEnabled;
copy.dispatchQueue = _dispatchQueue;
copy.persistenceEnabled = _persistenceEnabled;
copy.timestampsInSnapshotsEnabled = _timestampsInSnapshotsEnabled;
return copy;
}
- (void)setHost:(NSString *)host {
if (!host) {
FSTThrowInvalidArgument(
@"host setting may not be nil. You should generally just use the default value "
"(which is %@)",
kDefaultHost);
}
_host = [host mutableCopy];
}
- (void)setDispatchQueue:(dispatch_queue_t)dispatchQueue {
if (!dispatchQueue) {
FSTThrowInvalidArgument(
@"dispatch queue setting may not be nil. Create a new dispatch queue with "
"dispatch_queue_create(\"com.example.MyQueue\", NULL) or just use the default "
"(which is the main queue, returned from dispatch_get_main_queue())");
}
_dispatchQueue = dispatchQueue;
}
@end
NS_ASSUME_NONNULL_END