Database Interop (#1865)

* Register Database with Interop + Add AuthInterop dependency + Have Database register with Interop component container + Add weak dependency on Auth ~ Cleaned up imports * Use Interop for Auth token fetching + Use macro to get auth component ~ Change `getTokenForcingRefresh:withCallback:` call to use Interop component version of Auth ~ Clean up imports * Implement necessary protocols + Added FIRComponentRegistrant and FIRDatabaseNilProtocol to FIRDatabase * Squash of my previous local commits for Database Interop Register Database with Interop: + Add AuthInterop dependency + Have Database register with Interop component container + Add weak dependency on Auth ~ Cleaned up imports Use Interop for Auth token fetching: + Use macro to get auth component ~ Change `getTokenForcingRefresh:withCallback:` call to use Interop component version of Auth ~ Clean up imports Implement necessary protocols: + Added FIRComponentRegistrant and FIRDatabaseNilProtocol to FIRDatabase Clean up Database tests: - Removed all unnecessary header files ~ Ran style.sh across all the tests Cleaned Up project file: Some header removals were missed in the last commit. Sorted some test files Fix Database Fake App Tests: + Added container property + Added an Auth fake in the container + Added the Shared utils files to the necessary targets + Added a missing XCTest reference in a test that didn't compile for me * Revert "Squash of my previous local commits for Database Interop" This reverts commit c0d0421. * Cleaned Up project file Some header removals were missed in the last commit. * Sorted some test files * Fix Database Fake App Tests + Added container property + Added an Auth fake in the container + Added the Shared utils files to the necessary targets + Added a missing XCTest reference in a test that didn't compile for me * PR Feedback Changes + Created new FIRDatabaseComponent class to encapsulate instance creation + Updated FAuthTokenProvider to only use an auth instance rather than an app. * PR Feedback Follow-Up - Removed FIRDatabase registration code * pod deintegrate * Move instance management Somes tests may still be out of date. * Fix Auth integration test * pod deintegrate -- again * PR Feedback * PR Feedback Added the FIRComponentLifecycleMaintainer protocol to FIRDatabaseComponent * Update Firebase/Database/Api/FIRDatabaseComponent.m Missed some small changes * Get integration tests compiling * Fix some tests * Fixed more tests Component needs to be cacheable in order to get the appWIllBeDeleted callback. * Update target memberships * Revert project file changes * Add FIRAuthInteropFake for broken targets * PR feedback * Spacing and Style * Moved `instances` to ivar * Simplify FIRDatabaseDictionary It's now keyed on the URL with the app being implied since each app will get its own `FIRDatabaseComponent`

Author: bstpierr

Example/Database/Tests/Helpers/FDevice.h

@@ -18,6 +18,7 @@
 
 @class FIRDatabaseReference;
 @class SenTest;
+@class XCTest;
 
 @interfaceFDevice : NSObject
 - (id)initOnline;

Example/Database/Tests/Helpers/FDevice.m

@@ -58,7 +58,7 @@ - (id)initOfflineWithUrl:(NSString *)firebaseUrl {
 - (id)initWithUrl:(NSString *)firebaseUrlandOnline:(BOOL)online {
  self = [superinit];
 if (self) {
- config = [FIRDatabaseConfigconfigForName:[NSStringstringWithFormat:@"device-%lu", deviceId++]];
+ config = [FTestHelpersconfigForName:[NSStringstringWithFormat:@"device-%lu", deviceId++]];
  config.persistenceEnabled = YES;
  url = firebaseUrl;
  isOnline = online;

Example/Database/Tests/Helpers/FIRFakeApp.h

@@ -16,6 +16,7 @@
 
 #import<Foundation/Foundation.h>
 
+@class FIRComponentContainer;
 @class FIRFakeOptions;
 
 @interfaceFIRFakeApp : NSObject
@@ -24,4 +25,5 @@
 
 @property(nonatomic, readonly) FIRFakeOptions *options;
 @property(nonatomic, copy, readonly) NSString *name;
+@property(nonatomic, readonly) FIRComponentContainer *container;
 @end

Example/Database/Tests/Helpers/FIRFakeApp.m

@@ -16,33 +16,49 @@
 
 #import"FIRFakeApp.h"
 
+#import"FIRAuthInteropFake.h"
+#import"FIRComponentTestUtilities.h"
+#import"FIRDatabaseComponent.h"
+
 @interfaceFIRFakeOptions: NSObject
 @property(nonatomic, readonly, copy) NSString *databaseURL;
-- (instancetype)initWithURL:(NSString *)url;
+- (instancetype)initWithURL:(NSString *)url;
 @end
 
 @implementationFIRFakeOptions
-- (instancetype)initWithURL:(NSString *)url {
-self = [superinit];
-if (self) {
- self->_databaseURL = url;
-}
-return self;
+- (instancetype)initWithURL:(NSString *)url {
+ self = [superinit];
+if (self) {
+ _databaseURL = url;
+ }
+return self;
 }
 @end
 
-@implementationFIRFakeApp
+@interfaceFIRDatabaseComponent (Internal)
+- (instancetype)initWithApp:(FIRApp *)app;
+@end
 
-- (instancetype) initWithName:(NSString *)nameURL:(NSString *)url {
- self = [superinit];
-if (self) {
- self->_name = name;
- self->_options = [[FIRFakeOptions alloc] initWithURL:url];
- }
-return self;
-}
+@implementationFIRFakeApp
 
-- (void)getTokenForcingRefresh:(BOOL)forceRefreshwithCallback:(void (^)(NSString *_Nullable token, NSError *_Nullable error))callback {
-callback(nil, nil);
+- (instancetype)initWithName:(NSString *)nameURL:(NSString *)url {
+ self = [superinit];
+if (self) {
+ _name = name;
+ _options = [[FIRFakeOptions alloc] initWithURL:url];
+ _Nullable id (^authBlock)(FIRComponentContainer *, BOOL *) =
+ ^(FIRComponentContainer *container, BOOL *isCacheable) {
+return [[FIRAuthInteropFake alloc] initWithToken:niluserID:nilerror:nil];
+ };
+ FIRComponentCreationBlock databaseBlock =
+ ^id_Nullable(FIRComponentContainer *container, BOOL *isCacheable) {
+return [[FIRDatabaseComponent alloc] initWithApp:container.app];
+ };
+NSDictionary<NSString *, FIRComponentCreationBlock> *components =
+ @{NSStringFromProtocol(@protocol(FIRAuthInterop)) : authBlock,
+NSStringFromProtocol(@protocol(FIRDatabaseProvider)) : databaseBlock};
+ _container = [[FIRComponentContainer alloc] initWithApp:(FIRApp *)selfcomponents:components];
+ }
+return self;
 }
 @end

Example/Database/Tests/Helpers/FTestHelpers.h

@@ -28,6 +28,8 @@
 #definePATH(__path) [FPath pathWithString:(__path)]
 
 @interfaceFTestHelpers : XCTestCase
++ (FIRDatabaseConfig *) defaultConfig;
++ (FIRDatabaseConfig *) configForName:(NSString *)name;
 + (FIRDatabaseReference *) getRandomNode;
 + (FIRDatabaseReference *) getRandomNodeWithoutPersistence;
 + (FTupleFirebase *) getRandomNodePair;

Example/Database/Tests/Helpers/FTestHelpers.m

@@ -15,118 +15,141 @@
 */
 
 #import"FTestHelpers.h"
-#import"FConstants.h"
-#import<FirebaseCore/FIRApp.h>
+
+#import<FirebaseAuthInterop/FIRAuthInterop.h>
+#import<FirebaseCore/FIRAppInternal.h>
+#import<FirebaseCore/FIRComponent.h>
+#import<FirebaseCore/FIRComponentContainer.h>
 #import<FirebaseCore/FIROptions.h>
+
+#import"FConstants.h"
+#import"FIRAuthInteropFake.h"
 #import"FIRDatabaseConfig_Private.h"
 #import"FTestAuthTokenGenerator.h"
 
 @implementationFTestHelpers
 
-+ (NSTimeInterval)waitUntil:(BOOL (^)())predicatetimeout:(NSTimeInterval)seconds {
-NSTimeInterval start = [NSDatetimeIntervalSinceReferenceDate];
-NSDate *timeoutDate = [NSDatedateWithTimeIntervalSinceNow:seconds];
-NSTimeInterval timeoutTime = [timeoutDate timeIntervalSinceReferenceDate];
-NSTimeInterval currentTime;
++ (NSTimeInterval)waitUntil:(BOOL (^)())predicatetimeout:(NSTimeInterval)seconds {
+NSTimeInterval start = [NSDatetimeIntervalSinceReferenceDate];
+NSDate *timeoutDate = [NSDatedateWithTimeIntervalSinceNow:seconds];
+NSTimeInterval timeoutTime = [timeoutDate timeIntervalSinceReferenceDate];
+NSTimeInterval currentTime;
 
-for (currentTime = [NSDatetimeIntervalSinceReferenceDate];
- !predicate() && currentTime < timeoutTime;
- currentTime = [NSDatetimeIntervalSinceReferenceDate]) {
- [[NSRunLoopcurrentRunLoop] runMode:NSDefaultRunLoopModebeforeDate:[NSDatedateWithTimeIntervalSinceNow:0.25]];
- }
+for (currentTime = [NSDatetimeIntervalSinceReferenceDate];
+ !predicate() && currentTime < timeoutTime;
+ currentTime = [NSDatetimeIntervalSinceReferenceDate]) {
+ [[NSRunLoopcurrentRunLoop] runMode:NSDefaultRunLoopMode
+beforeDate:[NSDatedateWithTimeIntervalSinceNow:0.25]];
+ }
 
-NSTimeInterval finish = [NSDatetimeIntervalSinceReferenceDate];
+NSTimeInterval finish = [NSDatetimeIntervalSinceReferenceDate];
 
-NSAssert(currentTime <= timeoutTime, @"Timed out");
+NSAssert(currentTime <= timeoutTime, @"Timed out");
 
-return (finish - start);
+return (finish - start);
 }
 
-+ (NSArray*) getRandomNodes:(int)numpersistence:(BOOL)persistence {
-staticdispatch_once_t pred = 0;
-staticNSMutableArray *persistenceRefs = nil;
-staticNSMutableArray *noPersistenceRefs = nil;
-dispatch_once(&pred, ^{
- persistenceRefs = [[NSMutableArrayalloc] init];
- noPersistenceRefs = [[NSMutableArrayalloc] init];
-// Uncomment the following line to run tests against a background thread
-//[Firebase setDispatchQueue:dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_DEFAULT, 0)];
- });
-
-NSMutableArray *refs = (persistence) ? persistenceRefs : noPersistenceRefs;
-
-id<FAuthTokenProvider> authTokenProvider = [FAuthTokenProvider authTokenProviderForApp:[FIRApp defaultApp]];
-
-while (num > refs.count) {
-NSString *sessionIdentifier = [NSStringstringWithFormat:@"test-config-%@persistence-%lu", (persistence) ? @"" : @"no-", refs.count];
- FIRDatabaseConfig *config = [[FIRDatabaseConfig alloc] initWithSessionIdentifier:sessionIdentifier authTokenProvider:authTokenProvider];
- config.persistenceEnabled = persistence;
- FIRDatabaseReference * ref = [[FIRDatabaseReference alloc] initWithConfig:config];
- [refs addObject:ref];
- }
++ (FIRDatabaseConfig *)defaultConfig {
+return [selfconfigForName:@"default"];
+}
 
-NSMutableArray* results = [[NSMutableArrayalloc] init];
-NSString* name = nil;
-for (int i = 0; i < num; ++i) {
- FIRDatabaseReference * ref = [refs objectAtIndex:i];
-if (!name) {
- name = [ref childByAutoId].key;
- }
- [results addObject:[ref child:name]];
++ (FIRDatabaseConfig *)configForName:(NSString *)name {
+id<FIRAuthInterop> auth = [[FIRAuthInteropFake alloc] initWithToken:niluserID:nilerror:nil];
+id<FAuthTokenProvider> authTokenProvider = [FAuthTokenProvider authTokenProviderWithAuth:auth];
+return [[FIRDatabaseConfig alloc] initWithSessionIdentifier:name
+authTokenProvider:authTokenProvider];
+}
+
++ (NSArray *)getRandomNodes:(int)numpersistence:(BOOL)persistence {
+staticdispatch_once_t pred = 0;
+staticNSMutableArray *persistenceRefs = nil;
+staticNSMutableArray *noPersistenceRefs = nil;
+dispatch_once(&pred, ^{
+ persistenceRefs = [[NSMutableArrayalloc] init];
+ noPersistenceRefs = [[NSMutableArrayalloc] init];
+// Uncomment the following line to run tests against a background thread
+//[Firebase setDispatchQueue:dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_DEFAULT, 0)];
+ });
+
+NSMutableArray *refs = (persistence) ? persistenceRefs : noPersistenceRefs;
+
+id<FIRAuthInterop> auth = [[FIRAuthInteropFake alloc] initWithToken:niluserID:nilerror:nil];
+id<FAuthTokenProvider> authTokenProvider = [FAuthTokenProvider authTokenProviderWithAuth:auth];
+
+while (num > refs.count) {
+NSString *sessionIdentifier =
+ [NSStringstringWithFormat:@"test-config-%@persistence-%lu", (persistence) ? @"" : @"no-",
+ refs.count];
+ FIRDatabaseConfig *config =
+ [[FIRDatabaseConfig alloc] initWithSessionIdentifier:sessionIdentifier
+authTokenProvider:authTokenProvider];
+ config.persistenceEnabled = persistence;
+ FIRDatabaseReference *ref = [[FIRDatabaseReference alloc] initWithConfig:config];
+ [refs addObject:ref];
+ }
+
+NSMutableArray *results = [[NSMutableArrayalloc] init];
+NSString *name = nil;
+for (int i = 0; i < num; ++i) {
+ FIRDatabaseReference *ref = [refs objectAtIndex:i];
+if (!name) {
+ name = [ref childByAutoId].key;
  }
-return results;
+ [results addObject:[ref child:name]];
+ }
+return results;
 }
 
 // Helpers
-+ (FIRDatabaseReference *)getRandomNode {
-NSArray* refs = [selfgetRandomNodes:1persistence:YES];
-return [refs objectAtIndex:0];
++ (FIRDatabaseReference *)getRandomNode {
+NSArray *refs = [selfgetRandomNodes:1persistence:YES];
+return [refs objectAtIndex:0];
 }
 
-+ (FIRDatabaseReference *)getRandomNodeWithoutPersistence {
-NSArray* refs = [selfgetRandomNodes:1persistence:NO];
-return refs[0];
++ (FIRDatabaseReference *)getRandomNodeWithoutPersistence {
+NSArray *refs = [selfgetRandomNodes:1persistence:NO];
+return refs[0];
 }
 
-+ (FTupleFirebase *)getRandomNodePair {
-NSArray* refs = [selfgetRandomNodes:2persistence:YES];
++ (FTupleFirebase *)getRandomNodePair {
+NSArray *refs = [selfgetRandomNodes:2persistence:YES];
 
-FTupleFirebase* tuple = [[FTupleFirebase alloc] init];
-tuple.one = [refs objectAtIndex:0];
-tuple.two = [refs objectAtIndex:1];
+ FTupleFirebase *tuple = [[FTupleFirebase alloc] init];
+ tuple.one = [refs objectAtIndex:0];
+ tuple.two = [refs objectAtIndex:1];
 
-return tuple;
+return tuple;
 }
 
-+ (FTupleFirebase *)getRandomNodePairWithoutPersistence {
-NSArray* refs = [selfgetRandomNodes:2persistence:NO];
++ (FTupleFirebase *)getRandomNodePairWithoutPersistence {
+NSArray *refs = [selfgetRandomNodes:2persistence:NO];
 
-FTupleFirebase* tuple = [[FTupleFirebase alloc] init];
-tuple.one = refs[0];
-tuple.two = refs[1];
+ FTupleFirebase *tuple = [[FTupleFirebase alloc] init];
+ tuple.one = refs[0];
+ tuple.two = refs[1];
 
-return tuple;
+return tuple;
 }
 
-+ (FTupleFirebase *)getRandomNodeTriple {
-NSArray* refs = [selfgetRandomNodes:3persistence:YES];
-FTupleFirebase* triple = [[FTupleFirebase alloc] init];
-triple.one = [refs objectAtIndex:0];
-triple.two = [refs objectAtIndex:1];
-triple.three = [refs objectAtIndex:2];
++ (FTupleFirebase *)getRandomNodeTriple {
+NSArray *refs = [selfgetRandomNodes:3persistence:YES];
+ FTupleFirebase *triple = [[FTupleFirebase alloc] init];
+ triple.one = [refs objectAtIndex:0];
+ triple.two = [refs objectAtIndex:1];
+ triple.three = [refs objectAtIndex:2];
 
-return triple;
+return triple;
 }
 
 + (id<FNode>)leafNodeOfSize:(NSUInteger)size {
-NSMutableString *string = [NSMutableStringstring];
-NSString *pattern = @"abdefghijklmopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789";
-for (NSUInteger i = 0; i < size - pattern.length; i = i + pattern.length) {
-[string appendString:pattern];
-}
-NSUInteger remainingLength = size - string.length;
-[string appendString:[pattern substringToIndex:remainingLength]];
-return [FSnapshotUtilities nodeFrom:string];
+NSMutableString *string = [NSMutableStringstring];
+NSString *pattern = @"abdefghijklmopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789";
+for (NSUInteger i = 0; i < size - pattern.length; i = i + pattern.length) {
+ [string appendString:pattern];
+ }
+NSUInteger remainingLength = size - string.length;
+ [string appendString:[pattern substringToIndex:remainingLength]];
+return [FSnapshotUtilities nodeFrom:string];
 }
 
 @end

Example/Database/Tests/Integration/FData.m

@@ -2529,7 +2529,7 @@ - (void) testUpdateAfterChildSet {
 
 - (void) testDeltaSyncNoDataUpdatesAfterReconnect {
  FIRDatabaseReference *ref = [FTestHelpers getRandomNode];
- FIRDatabaseConfig *cfg = [FIRDatabaseConfigconfigForName:@"test-config"];
+ FIRDatabaseConfig *cfg = [FTestHelpersconfigForName:@"test-config"];
  FIRDatabaseReference * ref2 = [[[FIRDatabaseReference alloc] initWithConfig:cfg] child:ref.key];
  __block id data = @{ @"a": @1, @"b": @2, @"c": @{ @".priority": @3, @".value": @3}, @"d": @4 };
  [selfwaitForCompletionOf:ref setValue:data];

Example/Database/Tests/Integration/FDotInfo.m

@@ -51,7 +51,7 @@ - (void) testCanWatchInfoConnected {
 }
 
 - (void) testInfoConnectedGoesToFalseOnDisconnect {
- FIRDatabaseConfig *cfg = [FIRDatabaseConfigconfigForName:@"test-config"];
+ FIRDatabaseConfig *cfg = [FTestHelpersconfigForName:@"test-config"];
  FIRDatabaseReference * rootRef = [[FIRDatabaseReference alloc] initWithConfig:cfg];
  __block BOOL everConnected = NO;
  __block NSMutableString *connectedHistory = [[NSMutableStringalloc] init];
@@ -78,7 +78,7 @@ - (void) testInfoConnectedGoesToFalseOnDisconnect {
 }
 
 - (void) testInfoServerTimeOffset {
- FIRDatabaseConfig *cfg = [FIRDatabaseConfigconfigForName:@"test-config"];
+ FIRDatabaseConfig *cfg = [FTestHelpersconfigForName:@"test-config"];
  FIRDatabaseReference * ref = [[FIRDatabaseReference alloc] initWithConfig:cfg];
 
 // make sure childByAutoId works
@@ -103,8 +103,8 @@ - (void) testInfoServerTimeOffset {
 }
 
 - (void) testManualConnectionManagement {
- FIRDatabaseConfig *cfg = [FIRDatabaseConfigconfigForName:@"test-config"];
- FIRDatabaseConfig *altCfg = [FIRDatabaseConfigconfigForName:@"alt-config"];
+ FIRDatabaseConfig *cfg = [FTestHelpersconfigForName:@"test-config"];
+ FIRDatabaseConfig *altCfg = [FTestHelpersconfigForName:@"alt-config"];
 
  FIRDatabaseReference * ref = [[FIRDatabaseReference alloc] initWithConfig:cfg];
  FIRDatabaseReference * refAlt = [[FIRDatabaseReference alloc] initWithConfig:altCfg];