status-im
/
react-native-firebase
mirror of
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

[ios][firestore] transactions implementation

This commit is contained in:
Salakar 2018-03-04 23:47:10 +00:00
parent 49bb4a2aef
commit 5473083ebd
3 changed files with 231 additions and 60 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
ios/RNFirebase/RNFirebaseEvents.h
View File

@ -18,6 +18,7 @@ static NSString *const DATABASE_CHILD_REMOVED_EVENT = @"child_removed";
static NSString *const DATABASE_CHILD_MOVED_EVENT = @"child_moved"; static NSString *const DATABASE_CHILD_MOVED_EVENT = @"child_moved";
// Firestore // Firestore
static NSString *const FIRESTORE_TRANSACTION_EVENT = @"firestore_transaction_event";
static NSString *const FIRESTORE_COLLECTION_SYNC_EVENT = @"firestore_collection_sync_event"; static NSString *const FIRESTORE_COLLECTION_SYNC_EVENT = @"firestore_collection_sync_event";
static NSString *const FIRESTORE_DOCUMENT_SYNC_EVENT = @"firestore_document_sync_event"; static NSString *const FIRESTORE_DOCUMENT_SYNC_EVENT = @"firestore_document_sync_event";

2
ios/RNFirebase/firestore/RNFirebaseFirestore.h
View File

@ -10,6 +10,8 @@
#import <React/RCTEventEmitter.h> #import <React/RCTEventEmitter.h>
@interface RNFirebaseFirestore : RCTEventEmitter <RCTBridgeModule> {} @interface RNFirebaseFirestore : RCTEventEmitter <RCTBridgeModule> {}
@property NSMutableDictionary *transactions;
@property dispatch_queue_t transactionQueue;
+ (void)promiseRejectException:(RCTPromiseRejectBlock)reject error:(NSError *)error; + (void)promiseRejectException:(RCTPromiseRejectBlock)reject error:(NSError *)error;

288
ios/RNFirebase/firestore/RNFirebaseFirestore.m
View File

@ -13,49 +13,217 @@ RCT_EXPORT_MODULE();
- (id)init { - (id)init {
self = [super init]; self = [super init];
if (self != nil) { if (self != nil) {
_transactions = [[NSMutableDictionary alloc] init];
_transactionQueue = dispatch_queue_create("io.invertase.react-native-firebase.firestore", DISPATCH_QUEUE_CONCURRENT);
} }
return self; return self;
} }
RCT_EXPORT_METHOD(enableLogging:(BOOL) enabled) { /**
* TRANSACTIONS
*/
RCT_EXPORT_METHOD(transactionGetDocument:(NSString *)appDisplayName
transactionId:(nonnull NSNumber *)transactionId
path:(NSString *)path
resolver:(RCTPromiseResolveBlock)resolve
rejecter:(RCTPromiseRejectBlock)reject) {
__block NSMutableDictionary *transactionState;
dispatch_sync(_transactionQueue, ^{
transactionState = _transactions[[transactionId stringValue]];
});
if (!transactionState) {
NSLog(@"transactionGetDocument called for non-existant transactionId %@", transactionId);
return;
}
NSError *error = nil;
FIRTransaction *transaction = [transactionState valueForKey:@"transaction"];
FIRDocumentReference *ref = [self getDocumentForAppPath:appDisplayName path:path].ref;
FIRDocumentSnapshot *snapshot = [transaction getDocument:ref error:&error];
if (error != nil) {
[RNFirebaseFirestore promiseRejectException:reject error:error];
} else {
NSDictionary *snapshotDict = [RNFirebaseFirestoreDocumentReference snapshotToDictionary:snapshot];
NSString *path = snapshotDict[@"path"];
if (path == nil) {
[snapshotDict setValue:ref.path forKey:@"path"];
}
resolve(snapshotDict);
}
}
RCT_EXPORT_METHOD(transactionDispose:(NSString *)appDisplayName
transactionId:(nonnull NSNumber *)transactionId) {
__block NSMutableDictionary *transactionState;
dispatch_sync(_transactionQueue, ^{
transactionState = _transactions[[transactionId stringValue]];
});
if (!transactionState) {
NSLog(@"transactionGetDocument called for non-existant transactionId %@", transactionId);
return;
}
dispatch_semaphore_t semaphore = [transactionState valueForKey:@"semaphore"];
[transactionState setValue:@true forKey:@"abort"];
dispatch_semaphore_signal(semaphore);
}
RCT_EXPORT_METHOD(transactionApplyBuffer:(NSString *)appDisplayName
transactionId:(nonnull NSNumber *)transactionId
commandBuffer:(NSArray *)commandBuffer) {
__block NSMutableDictionary *transactionState;
dispatch_sync(_transactionQueue, ^{
transactionState = _transactions[[transactionId stringValue]];
});
if (!transactionState) {
NSLog(@"transactionGetDocument called for non-existant transactionId %@", transactionId);
return;
}
dispatch_semaphore_t semaphore = [transactionState valueForKey:@"semaphore"];
[transactionState setValue:commandBuffer forKey:@"commandBuffer"];
dispatch_semaphore_signal(semaphore);
}
RCT_EXPORT_METHOD(transactionBegin:(NSString *)appDisplayName
transactionId:(nonnull NSNumber *)transactionId) {
FIRFirestore *firestore = [RNFirebaseFirestore getFirestoreForApp:appDisplayName];
__block BOOL aborted = false;
dispatch_async(_transactionQueue, ^{
NSMutableDictionary *transactionState = [NSMutableDictionary new];
dispatch_semaphore_t semaphore = dispatch_semaphore_create(0);
transactionState[@"semaphore"] = semaphore;
[firestore runTransactionWithBlock:^id (FIRTransaction *transaction, NSError * *errorPointer) {
transactionState[@"transaction"] = transaction;
// Build and send transaction update event
dispatch_barrier_async(_transactionQueue, ^{
[_transactions setValue:transactionState forKey:[transactionId stringValue]];
NSMutableDictionary *eventMap = [NSMutableDictionary new];
eventMap[@"type"] = @"update";
eventMap[@"id"] = transactionId;
eventMap[@"appName"] = appDisplayName;
[RNFirebaseUtil sendJSEvent:self name:FIRESTORE_TRANSACTION_EVENT body:eventMap];
});
// wait for the js event handler to call transactionApplyBuffer
// this wait occurs on the RNFirestore Worker Queue so if transactionApplyBuffer fails to
// signal the semaphore then no further blocks will be executed by RNFirestore until the timeout expires
dispatch_time_t delayTime = dispatch_time(DISPATCH_TIME_NOW, 3000 * NSEC_PER_SEC);
BOOL timedOut = dispatch_semaphore_wait(semaphore, delayTime) != 0;
aborted = [transactionState valueForKey:@"abort"];
// dispose of transaction dictionary
dispatch_barrier_async(_transactionQueue, ^{
[_transactions removeObjectForKey:[transactionId stringValue]];
});
if (aborted) {
*errorPointer = [NSError errorWithDomain:FIRFirestoreErrorDomain code:FIRFirestoreErrorCodeAborted userInfo:@{}];
return nil;
}
if (timedOut) {
*errorPointer = [NSError errorWithDomain:FIRFirestoreErrorDomain code:FIRFirestoreErrorCodeDeadlineExceeded userInfo:@{}];
return nil;
}
NSArray *commandBuffer = [transactionState valueForKey:@"commandBuffer"];
for (NSDictionary *command in commandBuffer) {
NSString *type = command[@"type"];
NSString *path = command[@"path"];
NSDictionary *data = [RNFirebaseFirestoreDocumentReference parseJSMap:firestore jsMap:command[@"data"]];
FIRDocumentReference *ref = [firestore documentWithPath:path];
if ([type isEqualToString:@"delete"]) {
[transaction deleteDocument:ref];
} else if ([type isEqualToString:@"set"]) {
NSDictionary *options = command[@"options"];
if (options && options[@"merge"]) {
[transaction setData:data forDocument:ref options:[FIRSetOptions merge]];
} else {
[transaction setData:data forDocument:ref];
}
} else if ([type isEqualToString:@"update"]) {
[transaction updateData:data forDocument:ref];
}
}
return nil;
} completion:^(id result, NSError *error) {
if (aborted == NO) {
NSMutableDictionary *eventMap = [NSMutableDictionary new];
eventMap[@"id"] = transactionId;
eventMap[@"appName"] = appDisplayName;
if (error != nil) {
eventMap[@"type"] = @"error";
eventMap[@"error"] = [RNFirebaseFirestore getJSError:error];
} else {
eventMap[@"type"] = @"complete";
}
[RNFirebaseUtil sendJSEvent:self name:FIRESTORE_TRANSACTION_EVENT body:eventMap];
}
}];
});
}
/**
* TRANSACTIONS END
*/
RCT_EXPORT_METHOD(enableLogging:(BOOL)enabled) {
[FIRFirestore enableLogging:enabled]; [FIRFirestore enableLogging:enabled];
} }
RCT_EXPORT_METHOD(collectionGet:(NSString *) appDisplayName RCT_EXPORT_METHOD(collectionGet:(NSString *)appDisplayName
path:(NSString *) path path:(NSString *)path
filters:(NSArray *) filters filters:(NSArray *)filters
orders:(NSArray *) orders orders:(NSArray *)orders
options:(NSDictionary *) options options:(NSDictionary *)options
resolver:(RCTPromiseResolveBlock) resolve resolver:(RCTPromiseResolveBlock)resolve
rejecter:(RCTPromiseRejectBlock) reject) { rejecter:(RCTPromiseRejectBlock)reject) {
[[self getCollectionForAppPath:appDisplayName path:path filters:filters orders:orders options:options] get:resolve rejecter:reject]; [[self getCollectionForAppPath:appDisplayName path:path filters:filters orders:orders options:options] get:resolve rejecter:reject];
} }
RCT_EXPORT_METHOD(collectionOffSnapshot:(NSString *) appDisplayName RCT_EXPORT_METHOD(collectionOffSnapshot:(NSString *)appDisplayName
path:(NSString *) path path:(NSString *)path
filters:(NSArray *) filters filters:(NSArray *)filters
orders:(NSArray *) orders orders:(NSArray *)orders
options:(NSDictionary *) options options:(NSDictionary *)options
listenerId:(nonnull NSString *) listenerId) { listenerId:(nonnull NSString *)listenerId) {
[RNFirebaseFirestoreCollectionReference offSnapshot:listenerId]; [RNFirebaseFirestoreCollectionReference offSnapshot:listenerId];
} }
RCT_EXPORT_METHOD(collectionOnSnapshot:(NSString *) appDisplayName RCT_EXPORT_METHOD(collectionOnSnapshot:(NSString *)appDisplayName
path:(NSString *) path path:(NSString *)path
filters:(NSArray *) filters filters:(NSArray *)filters
orders:(NSArray *) orders orders:(NSArray *)orders
options:(NSDictionary *) options options:(NSDictionary *)options
listenerId:(nonnull NSString *) listenerId listenerId:(nonnull NSString *)listenerId
queryListenOptions:(NSDictionary *) queryListenOptions) { queryListenOptions:(NSDictionary *)queryListenOptions) {
RNFirebaseFirestoreCollectionReference *ref = [self getCollectionForAppPath:appDisplayName path:path filters:filters orders:orders options:options]; RNFirebaseFirestoreCollectionReference *ref = [self getCollectionForAppPath:appDisplayName path:path filters:filters orders:orders options:options];
[ref onSnapshot:listenerId queryListenOptions:queryListenOptions]; [ref onSnapshot:listenerId queryListenOptions:queryListenOptions];
} }
RCT_EXPORT_METHOD(documentBatch:(NSString *) appDisplayName RCT_EXPORT_METHOD(documentBatch:(NSString *)appDisplayName
writes:(NSArray *) writes writes:(NSArray *)writes
resolver:(RCTPromiseResolveBlock) resolve resolver:(RCTPromiseResolveBlock)resolve
rejecter:(RCTPromiseRejectBlock) reject) { rejecter:(RCTPromiseRejectBlock)reject) {
FIRFirestore *firestore = [RNFirebaseFirestore getFirestoreForApp:appDisplayName]; FIRFirestore *firestore = [RNFirebaseFirestore getFirestoreForApp:appDisplayName];
FIRWriteBatch *batch = [firestore batch]; FIRWriteBatch *batch = [firestore batch];
@ -80,7 +248,7 @@ RCT_EXPORT_METHOD(documentBatch:(NSString *) appDisplayName
} }
} }
[batch commitWithCompletion:^(NSError * _Nullable error) { [batch commitWithCompletion:^(NSError *_Nullable error) {
if (error) { if (error) {
[RNFirebaseFirestore promiseRejectException:reject error:error]; [RNFirebaseFirestore promiseRejectException:reject error:error];
} else { } else {
@ -89,55 +257,55 @@ RCT_EXPORT_METHOD(documentBatch:(NSString *) appDisplayName
}]; }];
} }
RCT_EXPORT_METHOD(documentDelete:(NSString *) appDisplayName RCT_EXPORT_METHOD(documentDelete:(NSString *)appDisplayName
path:(NSString *) path path:(NSString *)path
resolver:(RCTPromiseResolveBlock) resolve resolver:(RCTPromiseResolveBlock)resolve
rejecter:(RCTPromiseRejectBlock) reject) { rejecter:(RCTPromiseRejectBlock)reject) {
[[self getDocumentForAppPath:appDisplayName path:path] delete:resolve rejecter:reject]; [[self getDocumentForAppPath:appDisplayName path:path] delete:resolve rejecter:reject];
} }
RCT_EXPORT_METHOD(documentGet:(NSString *) appDisplayName RCT_EXPORT_METHOD(documentGet:(NSString *)appDisplayName
path:(NSString *) path path:(NSString *)path
resolver:(RCTPromiseResolveBlock) resolve resolver:(RCTPromiseResolveBlock)resolve
rejecter:(RCTPromiseRejectBlock) reject) { rejecter:(RCTPromiseRejectBlock)reject) {
[[self getDocumentForAppPath:appDisplayName path:path] get:resolve rejecter:reject]; [[self getDocumentForAppPath:appDisplayName path:path] get:resolve rejecter:reject];
} }
RCT_EXPORT_METHOD(documentGetAll:(NSString *) appDisplayName RCT_EXPORT_METHOD(documentGetAll:(NSString *)appDisplayName
documents:(NSString *) documents documents:(NSString *)documents
resolver:(RCTPromiseResolveBlock) resolve resolver:(RCTPromiseResolveBlock)resolve
rejecter:(RCTPromiseRejectBlock) reject) { rejecter:(RCTPromiseRejectBlock)reject) {
// Not supported on iOS out of the box // Not supported on iOS out of the box
} }
RCT_EXPORT_METHOD(documentOffSnapshot:(NSString *) appDisplayName RCT_EXPORT_METHOD(documentOffSnapshot:(NSString *)appDisplayName
path:(NSString *) path path:(NSString *)path
listenerId:(nonnull NSString *) listenerId) { listenerId:(nonnull NSString *)listenerId) {
[RNFirebaseFirestoreDocumentReference offSnapshot:listenerId]; [RNFirebaseFirestoreDocumentReference offSnapshot:listenerId];
} }
RCT_EXPORT_METHOD(documentOnSnapshot:(NSString *) appDisplayName RCT_EXPORT_METHOD(documentOnSnapshot:(NSString *)appDisplayName
path:(NSString *) path path:(NSString *)path
listenerId:(nonnull NSString *) listenerId listenerId:(nonnull NSString *)listenerId
docListenOptions:(NSDictionary *) docListenOptions) { docListenOptions:(NSDictionary *)docListenOptions) {
RNFirebaseFirestoreDocumentReference *ref = [self getDocumentForAppPath:appDisplayName path:path]; RNFirebaseFirestoreDocumentReference *ref = [self getDocumentForAppPath:appDisplayName path:path];
[ref onSnapshot:listenerId docListenOptions:docListenOptions]; [ref onSnapshot:listenerId docListenOptions:docListenOptions];
} }
RCT_EXPORT_METHOD(documentSet:(NSString *) appDisplayName RCT_EXPORT_METHOD(documentSet:(NSString *)appDisplayName
path:(NSString *) path path:(NSString *)path
data:(NSDictionary *) data data:(NSDictionary *)data
options:(NSDictionary *) options options:(NSDictionary *)options
resolver:(RCTPromiseResolveBlock) resolve resolver:(RCTPromiseResolveBlock)resolve
rejecter:(RCTPromiseRejectBlock) reject) { rejecter:(RCTPromiseRejectBlock)reject) {
[[self getDocumentForAppPath:appDisplayName path:path] set:data options:options resolver:resolve rejecter:reject]; [[self getDocumentForAppPath:appDisplayName path:path] set:data options:options resolver:resolve rejecter:reject];
} }
RCT_EXPORT_METHOD(documentUpdate:(NSString *) appDisplayName RCT_EXPORT_METHOD(documentUpdate:(NSString *)appDisplayName
path:(NSString *) path path:(NSString *)path
data:(NSDictionary *) data data:(NSDictionary *)data
resolver:(RCTPromiseResolveBlock) resolve resolver:(RCTPromiseResolveBlock)resolve
rejecter:(RCTPromiseRejectBlock) reject) { rejecter:(RCTPromiseRejectBlock)reject) {
[[self getDocumentForAppPath:appDisplayName path:path] update:data resolver:resolve rejecter:reject]; [[self getDocumentForAppPath:appDisplayName path:path] update:data resolver:resolve rejecter:reject];
} }
@ -262,11 +430,10 @@ RCT_EXPORT_METHOD(documentUpdate:(NSString *) appDisplayName
} }
- (NSArray<NSString *> *)supportedEvents { - (NSArray<NSString *> *)supportedEvents {
return @[FIRESTORE_COLLECTION_SYNC_EVENT, FIRESTORE_DOCUMENT_SYNC_EVENT]; return @[FIRESTORE_COLLECTION_SYNC_EVENT, FIRESTORE_DOCUMENT_SYNC_EVENT, FIRESTORE_TRANSACTION_EVENT];
} }
+ (BOOL)requiresMainQueueSetup + (BOOL)requiresMainQueueSetup {
{
return YES; return YES;
} }
@ -276,3 +443,4 @@ RCT_EXPORT_METHOD(documentUpdate:(NSString *) appDisplayName
@implementation RNFirebaseFirestore @implementation RNFirebaseFirestore
@end @end
#endif #endif