@react-native-firebase/database 26.0.0 → 26.1.0

package/ios/RNFBDatabase/RNFBDatabaseOnDisconnectModule.mm

@@ -15,14 +15,17 @@
  *
  */
 
-#import <Firebase/Firebase.h>
 #import <React/RCTUtils.h>
 
-#import "RNFBApp/RCTConvert+FIRApp.h"
-#import "RNFBDatabaseCommon.h"
+#import "RNFBDatabaseOnDisconnectHelper.h"
 #import "RNFBDatabaseOnDisconnectModule.h"
+#import "RNFBDatabaseQueue.h"
 #import "RNFBDatabaseTurboModules.h"
 
+// NOTE: This module deliberately never imports Firebase Database headers.
+// See RNFBDatabaseModule.mm for rationale. All Firebase Database calls are
+// delegated to the plain Objective-C `RNFBDatabaseOnDisconnectHelper`.
+
 @interface RNFBDatabaseOnDisconnectModule () <NativeRNFBTurboDatabaseOnDisconnectSpec,
                                               RCTBridgeModule>
 @end
@@ -43,7 +46,7 @@ RCT_EXPORT_MODULE(NativeRNFBTurboDatabaseOnDisconnect);
 }
 
 - (dispatch_queue_t)methodQueue {
-  return [RNFBDatabaseCommon getDispatchQueue];
+  return [RNFBDatabaseQueue getDispatchQueue];
 }
 
 #pragma mark -
@@ -54,19 +57,11 @@ RCT_EXPORT_MODULE(NativeRNFBTurboDatabaseOnDisconnect);
                       path:(NSString *)path
                    resolve:(RCTPromiseResolveBlock)resolve
                     reject:(RCTPromiseRejectBlock)reject {
-  FIRApp *firebaseApp = [RCTConvert firAppFromString:app];
-  FIRDatabase *firDatabase = [RNFBDatabaseCommon getDatabaseForApp:firebaseApp dbURL:dbURL];
-  FIRDatabaseReference *firDatabaseReference =
-      [RNFBDatabaseCommon getReferenceForDatabase:firDatabase path:path];
-
-  [firDatabaseReference
-      cancelDisconnectOperationsWithCompletionBlock:^(NSError *error, FIRDatabaseReference *ref) {
-        if (error != nil) {
-          [RNFBDatabaseCommon promiseRejectDatabaseException:reject error:error];
-        } else {
-          resolve([NSNull null]);
-        }
-      }];
+  [RNFBDatabaseOnDisconnectHelper onDisconnectCancel:app
+                                               dbURL:dbURL
+                                                path:path
+                                             resolve:resolve
+                                              reject:reject];
 }
 
 - (void)onDisconnectRemove:(NSString *)app
@@ -74,19 +69,11 @@ RCT_EXPORT_MODULE(NativeRNFBTurboDatabaseOnDisconnect);
                       path:(NSString *)path
                    resolve:(RCTPromiseResolveBlock)resolve
                     reject:(RCTPromiseRejectBlock)reject {
-  FIRApp *firebaseApp = [RCTConvert firAppFromString:app];
-  FIRDatabase *firDatabase = [RNFBDatabaseCommon getDatabaseForApp:firebaseApp dbURL:dbURL];
-  FIRDatabaseReference *firDatabaseReference =
-      [RNFBDatabaseCommon getReferenceForDatabase:firDatabase path:path];
-
-  [firDatabaseReference
-      onDisconnectRemoveValueWithCompletionBlock:^(NSError *error, FIRDatabaseReference *ref) {
-        if (error != nil) {
-          [RNFBDatabaseCommon promiseRejectDatabaseException:reject error:error];
-        } else {
-          resolve([NSNull null]);
-        }
-      }];
+  [RNFBDatabaseOnDisconnectHelper onDisconnectRemove:app
+                                               dbURL:dbURL
+                                                path:path
+                                             resolve:resolve
+                                              reject:reject];
 }
 
 - (void)onDisconnectSet:(NSString *)app
@@ -95,19 +82,12 @@ RCT_EXPORT_MODULE(NativeRNFBTurboDatabaseOnDisconnect);
                   props:(NSDictionary *)props
                 resolve:(RCTPromiseResolveBlock)resolve
                  reject:(RCTPromiseRejectBlock)reject {
-  FIRApp *firebaseApp = [RCTConvert firAppFromString:app];
-  FIRDatabase *firDatabase = [RNFBDatabaseCommon getDatabaseForApp:firebaseApp dbURL:dbURL];
-  FIRDatabaseReference *firDatabaseReference =
-      [RNFBDatabaseCommon getReferenceForDatabase:firDatabase path:path];
-
-  [firDatabaseReference onDisconnectSetValue:[props valueForKey:@"value"]
-                         withCompletionBlock:^(NSError *error, FIRDatabaseReference *ref) {
-                           if (error != nil) {
-                             [RNFBDatabaseCommon promiseRejectDatabaseException:reject error:error];
-                           } else {
-                             resolve([NSNull null]);
-                           }
-                         }];
+  [RNFBDatabaseOnDisconnectHelper onDisconnectSet:app
+                                            dbURL:dbURL
+                                             path:path
+                                            props:props
+                                          resolve:resolve
+                                           reject:reject];
 }
 
 - (void)onDisconnectSetWithPriority:(NSString *)app
@@ -116,20 +96,12 @@ RCT_EXPORT_MODULE(NativeRNFBTurboDatabaseOnDisconnect);
                               props:(NSDictionary *)props
                             resolve:(RCTPromiseResolveBlock)resolve
                              reject:(RCTPromiseRejectBlock)reject {
-  FIRApp *firebaseApp = [RCTConvert firAppFromString:app];
-  FIRDatabase *firDatabase = [RNFBDatabaseCommon getDatabaseForApp:firebaseApp dbURL:dbURL];
-  FIRDatabaseReference *firDatabaseReference =
-      [RNFBDatabaseCommon getReferenceForDatabase:firDatabase path:path];
-
-  [firDatabaseReference onDisconnectSetValue:[props valueForKey:@"value"]
-                                 andPriority:[props valueForKey:@"priority"]
-                         withCompletionBlock:^(NSError *error, FIRDatabaseReference *ref) {
-                           if (error != nil) {
-                             [RNFBDatabaseCommon promiseRejectDatabaseException:reject error:error];
-                           } else {
-                             resolve([NSNull null]);
-                           }
-                         }];
+  [RNFBDatabaseOnDisconnectHelper onDisconnectSetWithPriority:app
+                                                        dbURL:dbURL
+                                                         path:path
+                                                        props:props
+                                                      resolve:resolve
+                                                       reject:reject];
 }
 
 - (void)onDisconnectUpdate:(NSString *)app
@@ -138,20 +110,12 @@ RCT_EXPORT_MODULE(NativeRNFBTurboDatabaseOnDisconnect);
                      props:(NSDictionary *)props
                    resolve:(RCTPromiseResolveBlock)resolve
                     reject:(RCTPromiseRejectBlock)reject {
-  FIRApp *firebaseApp = [RCTConvert firAppFromString:app];
-  FIRDatabase *firDatabase = [RNFBDatabaseCommon getDatabaseForApp:firebaseApp dbURL:dbURL];
-  FIRDatabaseReference *firDatabaseReference =
-      [RNFBDatabaseCommon getReferenceForDatabase:firDatabase path:path];
-
-  [firDatabaseReference onDisconnectUpdateChildValues:[props valueForKey:@"values"]
-                                  withCompletionBlock:^(NSError *error, FIRDatabaseReference *ref) {
-                                    if (error != nil) {
-                                      [RNFBDatabaseCommon promiseRejectDatabaseException:reject
-                                                                                   error:error];
-                                    } else {
-                                      resolve([NSNull null]);
-                                    }
-                                  }];
+  [RNFBDatabaseOnDisconnectHelper onDisconnectUpdate:app
+                                               dbURL:dbURL
+                                                path:path
+                                               props:props
+                                             resolve:resolve
+                                              reject:reject];
 }
 
 @end

package/ios/RNFBDatabase/RNFBDatabaseQuery.h

@@ -15,7 +15,18 @@
  *
  */
 
+#if __has_include(<Firebase/Firebase.h>)
 #import <Firebase/Firebase.h>
+#elif __has_include(<FirebaseDatabase/FirebaseDatabase-Swift.h>)
+// SPM: the declared product is the thin Swift wrapper `FirebaseDatabase`
+// (which depends on `FirebaseDatabaseInternal`, not exposed to us directly).
+// Its generated ObjC interface header is what's importable here.
+#import <FirebaseCore/FirebaseCore.h>
+#import <FirebaseDatabase/FirebaseDatabase-Swift.h>
+#else
+@import FirebaseCore;
+@import FirebaseDatabaseInternal;
+#endif
 #import <React/RCTBridgeModule.h>
 
 @interface RNFBDatabaseQuery : NSObject

package/ios/RNFBDatabase/RNFBDatabaseQueryHelper.h

@@ -0,0 +1,49 @@
+/**
+ * Copyright (c) 2016-present Invertase Limited & Contributors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this library 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 <React/RCTBridgeModule.h>
+
+// See RNFBDatabaseModuleHelper.h for rationale: plain Objective-C helper
+// that owns all `FIRDatabaseQuery`/`FIRDataSnapshot` calls and the query
+// listener bookkeeping for RNFBDatabaseQueryModule.
+@interface RNFBDatabaseQueryHelper : NSObject
+
++ (void)once:(NSString *)app
+        dbURL:(NSString *)dbURL
+         path:(NSString *)path
+    modifiers:(NSArray *)modifiers
+    eventType:(NSString *)eventType
+      resolve:(RCTPromiseResolveBlock)resolve
+       reject:(RCTPromiseRejectBlock)reject;
+
++ (void)on:(NSString *)app dbURL:(NSString *)dbURL props:(NSDictionary *)props;
+
++ (void)off:(NSString *)queryKey eventRegistrationKey:(NSString *)eventRegistrationKey;
+
++ (void)keepSynced:(NSString *)app
+             dbURL:(NSString *)dbURL
+               key:(NSString *)key
+              path:(NSString *)path
+         modifiers:(NSArray *)modifiers
+           enabled:(BOOL)value
+           resolve:(RCTPromiseResolveBlock)resolve
+            reject:(RCTPromiseRejectBlock)reject;
+
++ (void)invalidate;
+
+@end

package/ios/RNFBDatabase/RNFBDatabaseQueryHelper.m

@@ -0,0 +1,240 @@
+/**
+ * Copyright (c) 2016-present Invertase Limited & Contributors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this library 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.
+ *
+ */
+
+#if __has_include(<Firebase/Firebase.h>)
+#import <Firebase/Firebase.h>
+#else
+@import FirebaseCore;
+@import FirebaseDatabaseInternal;
+#endif
+
+#import "RNFBApp/RCTConvert+FIRApp.h"
+#import "RNFBDatabaseCommon.h"
+#import "RNFBDatabaseQuery.h"
+#import "RNFBDatabaseQueryHelper.h"
+#import "RNFBRCTEventEmitter.h"
+
+static __strong NSMutableDictionary *queryDictionary;
+static NSString *const RNFB_DATABASE_SYNC = @"database_sync_event";
+
+@implementation RNFBDatabaseQueryHelper
+
++ (NSMutableDictionary *)queryDictionary {
+  static dispatch_once_t onceToken;
+  dispatch_once(&onceToken, ^{
+    queryDictionary = [[NSMutableDictionary alloc] init];
+  });
+  return queryDictionary;
+}
+
++ (void)invalidate {
+  NSMutableDictionary *queries = [self queryDictionary];
+  NSArray *queryKeys = [queries allKeys];
+  for (NSString *key in queryKeys) {
+    RNFBDatabaseQuery *query = queries[key];
+    [query removeAllEventListeners];
+    [queries removeObjectForKey:key];
+  }
+}
+
++ (RNFBDatabaseQuery *)getDatabaseQueryInstance:(FIRDatabaseReference *)reference
+                                      modifiers:(NSArray *)modifiers {
+  return [[RNFBDatabaseQuery alloc] initWithReferenceAndModifiers:reference modifiers:modifiers];
+}
+
++ (RNFBDatabaseQuery *)getDatabaseQueryInstance:(NSString *)key
+                                      reference:(FIRDatabaseReference *)reference
+                                      modifiers:(NSArray *)modifiers {
+  NSMutableDictionary *queries = [self queryDictionary];
+  RNFBDatabaseQuery *cachedQuery = queries[key];
+
+  if (cachedQuery != nil) {
+    return cachedQuery;
+  }
+
+  RNFBDatabaseQuery *query = [[RNFBDatabaseQuery alloc] initWithReferenceAndModifiers:reference
+                                                                            modifiers:modifiers];
+
+  queries[key] = query;
+  return query;
+}
+
++ (void)addOnceEventListener:(RNFBDatabaseQuery *)databaseQuery
+                   eventType:(NSString *)eventType
+                     resolve:(RCTPromiseResolveBlock)resolve
+                      reject:(RCTPromiseRejectBlock)reject {
+  FIRDataEventType firDataEventType =
+      (FIRDataEventType)[RNFBDatabaseCommon getEventTypeFromName:eventType];
+
+  id andPreviousSiblingKeyWithBlock =
+      ^(FIRDataSnapshot *_Nonnull dataSnapshot, NSString *_Nullable previousChildName) {
+        NSDictionary *data;
+        if ([eventType isEqualToString:@"value"]) {
+          data = [RNFBDatabaseCommon snapshotToDictionary:dataSnapshot];
+        } else {
+          data = [RNFBDatabaseCommon snapshotWithPreviousChildToDictionary:dataSnapshot
+                                                         previousChildName:previousChildName];
+        }
+        resolve(data);
+      };
+
+  id errorBlock = ^(NSError *_Nonnull error) {
+    [RNFBDatabaseCommon promiseRejectDatabaseException:reject error:error];
+  };
+
+  [databaseQuery.query observeSingleEventOfType:firDataEventType
+                 andPreviousSiblingKeyWithBlock:andPreviousSiblingKeyWithBlock
+                                withCancelBlock:errorBlock];
+}
+
++ (void)handleDatabaseEvent:(NSString *)key
+                  eventType:(NSString *)eventType
+               registration:(NSDictionary *)registration
+                   snapshot:(FIRDataSnapshot *)dataSnapshot
+          previousChildName:(NSString *)previousChildName {
+  NSDictionary *data;
+  if ([eventType isEqualToString:@"value"]) {
+    data = [RNFBDatabaseCommon snapshotToDictionary:dataSnapshot];
+  } else {
+    data = [RNFBDatabaseCommon snapshotWithPreviousChildToDictionary:dataSnapshot
+                                                   previousChildName:previousChildName];
+  }
+
+  [[RNFBRCTEventEmitter shared] sendEventWithName:RNFB_DATABASE_SYNC
+                                             body:@{
+                                               @"body" : @{
+                                                 @"data" : data,
+                                                 @"key" : key,
+                                                 @"eventType" : eventType,
+                                                 @"registration" : registration,
+                                               }
+                                             }];
+}
+
++ (void)handleDatabaseEventError:(NSString *)key
+                    registration:(NSDictionary *)registration
+                           error:(NSError *)error {
+  NSArray *codeAndMessage = [RNFBDatabaseCommon getCodeAndMessage:error];
+  [[RNFBRCTEventEmitter shared] sendEventWithName:RNFB_DATABASE_SYNC
+                                             body:@{
+                                               @"body" : @{
+                                                 @"key" : key,
+                                                 @"error" : @{
+                                                   @"code" : codeAndMessage[0],
+                                                   @"message" : codeAndMessage[1],
+                                                 },
+                                                 @"registration" : registration,
+                                               }
+                                             }];
+}
+
++ (void)addEventListener:(RNFBDatabaseQuery *)databaseQuery
+               eventType:(NSString *)eventType
+            registration:(NSDictionary *)registration {
+  NSString *eventRegistrationKey = registration[@"eventRegistrationKey"];
+
+  if (![databaseQuery hasEventListener:eventRegistrationKey]) {
+    id andPreviousSiblingKeyWithBlock =
+        ^(FIRDataSnapshot *_Nonnull dataSnapshot, NSString *_Nullable previousChildName) {
+          [self handleDatabaseEvent:eventRegistrationKey
+                          eventType:eventType
+                       registration:registration
+                           snapshot:dataSnapshot
+                  previousChildName:previousChildName];
+        };
+
+    id errorBlock = ^(NSError *_Nonnull error) {
+      [databaseQuery removeEventListener:eventRegistrationKey];
+      [self handleDatabaseEventError:eventRegistrationKey registration:registration error:error];
+    };
+
+    FIRDataEventType firDataEventType =
+        (FIRDataEventType)[RNFBDatabaseCommon getEventTypeFromName:eventType];
+    FIRDatabaseHandle handle = [databaseQuery.query observeEventType:firDataEventType
+                                      andPreviousSiblingKeyWithBlock:andPreviousSiblingKeyWithBlock
+                                                     withCancelBlock:errorBlock];
+    [databaseQuery addEventListener:eventRegistrationKey handle:handle];
+  }
+}
+
++ (void)once:(NSString *)app
+        dbURL:(NSString *)dbURL
+         path:(NSString *)path
+    modifiers:(NSArray *)modifiers
+    eventType:(NSString *)eventType
+      resolve:(RCTPromiseResolveBlock)resolve
+       reject:(RCTPromiseRejectBlock)reject {
+  FIRApp *firebaseApp = [RCTConvert firAppFromString:app];
+  FIRDatabase *firDatabase = [RNFBDatabaseCommon getDatabaseForApp:firebaseApp dbURL:dbURL];
+  FIRDatabaseReference *firDatabaseReference =
+      [RNFBDatabaseCommon getReferenceForDatabase:firDatabase path:path];
+  RNFBDatabaseQuery *databaseQuery = [self getDatabaseQueryInstance:firDatabaseReference
+                                                          modifiers:modifiers];
+
+  [self addOnceEventListener:databaseQuery eventType:eventType resolve:resolve reject:reject];
+}
+
++ (void)on:(NSString *)app dbURL:(NSString *)dbURL props:(NSDictionary *)props {
+  NSString *key = [props valueForKey:@"key"];
+  NSString *path = [props valueForKey:@"path"];
+  NSString *eventType = [props valueForKey:@"eventType"];
+  NSArray *modifiers = [props valueForKey:@"modifiers"];
+  NSDictionary *registration = [props valueForKey:@"registration"];
+
+  FIRApp *firebaseApp = [RCTConvert firAppFromString:app];
+  FIRDatabase *firDatabase = [RNFBDatabaseCommon getDatabaseForApp:firebaseApp dbURL:dbURL];
+  FIRDatabaseReference *firDatabaseReference =
+      [RNFBDatabaseCommon getReferenceForDatabase:key firebaseDatabase:firDatabase path:path];
+  RNFBDatabaseQuery *databaseQuery = [self getDatabaseQueryInstance:key
+                                                          reference:firDatabaseReference
+                                                          modifiers:modifiers];
+  [self addEventListener:databaseQuery eventType:eventType registration:registration];
+}
+
++ (void)off:(NSString *)queryKey eventRegistrationKey:(NSString *)eventRegistrationKey {
+  NSMutableDictionary *queries = [self queryDictionary];
+  RNFBDatabaseQuery *databaseQuery = queries[queryKey];
+
+  if (databaseQuery != nil) {
+    [databaseQuery removeEventListener:eventRegistrationKey];
+
+    if (![databaseQuery hasListeners]) {
+      [queries removeObjectForKey:queryKey];
+      [RNFBDatabaseCommon removeReferenceByKey:queryKey];
+    }
+  }
+}
+
++ (void)keepSynced:(NSString *)app
+             dbURL:(NSString *)dbURL
+               key:(NSString *)key
+              path:(NSString *)path
+         modifiers:(NSArray *)modifiers
+           enabled:(BOOL)value
+           resolve:(RCTPromiseResolveBlock)resolve
+            reject:(RCTPromiseRejectBlock)reject {
+  FIRApp *firebaseApp = [RCTConvert firAppFromString:app];
+  FIRDatabase *firDatabase = [RNFBDatabaseCommon getDatabaseForApp:firebaseApp dbURL:dbURL];
+  FIRDatabaseReference *firDatabaseReference =
+      [RNFBDatabaseCommon getReferenceForDatabase:firDatabase path:path];
+  RNFBDatabaseQuery *databaseQuery = [self getDatabaseQueryInstance:firDatabaseReference
+                                                          modifiers:modifiers];
+  [databaseQuery.query keepSynced:value];
+  resolve([NSNull null]);
+}
+
+@end

package/ios/RNFBDatabase/RNFBDatabaseQueryModule.h

@@ -15,9 +15,13 @@
  *
  */
 
-#import <Firebase/Firebase.h>
 #import <Foundation/Foundation.h>
 #import <React/RCTBridgeModule.h>
 
+// NOTE: This header must stay Firebase-free. It is imported by
+// RNFBDatabaseQueryModule.mm, and `FirebaseDatabase` is a Swift-only SPM
+// product whose `@import` cannot be used from Objective-C++ (.mm) files
+// when C++ modules are disabled. See RNFBDatabaseModule.mm for details.
+
 @interface RNFBDatabaseQueryModule : NSObject <RCTBridgeModule>
 @end