feat(firestore): array-contains, array-contains-any & in filters (#2868)

* feat(firestore) Add IN query support (JS/Android)
* feat(firestore) in query validation
* feat(firestore) in query ios support / tests
* docs(firestore): update reference docs to include in query support

packages/admob/RNFBAdMob.podspec

@@ -1,7 +1,7 @@
 require 'json'
 package = JSON.parse(File.read(File.join(__dir__, 'package.json')))
 
-firebase_sdk_version = '~> 6.8.1'
+firebase_sdk_version = '~> 6.12.0'
 using_custom_firebase_sdk_version = defined? $FirebaseSDKVersion
 if using_custom_firebase_sdk_version
   Pod::UI.puts "RNFBAdMob: Using user specified Firebase SDK version '#{$FirebaseSDKVersion}'"

packages/admob/android/build.gradle

@@ -31,7 +31,7 @@ project.ext {
       ],
 
       firebase          : [
-        bom: "21.1.0"
+        bom: "24.1.0"
       ],
 
       ads          : [

packages/analytics/RNFBAnalytics.podspec

@@ -1,7 +1,7 @@
 require 'json'
 package = JSON.parse(File.read(File.join(__dir__, 'package.json')))
 
-firebase_sdk_version = '~> 6.8.1'
+firebase_sdk_version = '~> 6.12.0'
 using_custom_firebase_sdk_version = defined? $FirebaseSDKVersion
 if using_custom_firebase_sdk_version
   Pod::UI.puts "RNFBAnalytics: Using user specified Firebase SDK version '#{$FirebaseSDKVersion}'"

packages/analytics/android/build.gradle

@@ -31,7 +31,7 @@ project.ext {
       ],
 
       firebase          : [
-        bom: "21.1.0",
+        bom: "24.1.0",
       ],
     ],
   ])

packages/app/RNFBApp.podspec

@@ -2,7 +2,7 @@ require 'json'
 require './firebase_json'
 package = JSON.parse(File.read(File.join(__dir__, 'package.json')))
 
-firebase_sdk_version = '~> 6.8.1'
+firebase_sdk_version = '~> 6.12.0'
 using_custom_firebase_sdk_version = defined? $FirebaseSDKVersion
 if using_custom_firebase_sdk_version
   Pod::UI.puts "RNFBApp: Using user specified Firebase SDK version '#{$FirebaseSDKVersion}'"

packages/app/android/build.gradle

@@ -31,7 +31,7 @@ project.ext {
       ],
 
       firebase: [
-        bom: "21.1.0",
+        bom: "24.1.0",
       ],
     ],
   ])

packages/auth/RNFBAuth.podspec

@@ -1,7 +1,7 @@
 require 'json'
 package = JSON.parse(File.read(File.join(__dir__, 'package.json')))
 
-firebase_sdk_version = '~> 6.8.1'
+firebase_sdk_version = '~> 6.12.0'
 using_custom_firebase_sdk_version = defined? $FirebaseSDKVersion
 if using_custom_firebase_sdk_version
   Pod::UI.puts "RNFBAuth: Using user specified Firebase SDK version '#{$FirebaseSDKVersion}'"

packages/crashlytics/RNFBCrashlytics.podspec

@@ -2,7 +2,7 @@ require 'json'
 package = JSON.parse(File.read(File.join(__dir__, 'package.json')))
 
 # Firebase SDK Override
-firebase_sdk_version = '~> 6.8.1'
+firebase_sdk_version = '~> 6.12.0'
 using_custom_firebase_sdk_version = defined? $FirebaseSDKVersion
 if using_custom_firebase_sdk_version
   Pod::UI.puts "RNFBCrashlytics: Using user specified Firebase SDK version '#{$FirebaseSDKVersion}'"

packages/database/RNFBDatabase.podspec

@@ -1,7 +1,7 @@
 require 'json'
 package = JSON.parse(File.read('./package.json'))
 
-firebase_sdk_version = '~> 6.8.1'
+firebase_sdk_version = '~> 6.12.0'
 using_custom_firebase_sdk_version = defined? $FirebaseSDKVersion
 if using_custom_firebase_sdk_version
   Pod::UI.puts "RNFBDatabase: Using user specified Firebase SDK version '#{$FirebaseSDKVersion}'"

packages/database/android/build.gradle

@@ -31,7 +31,7 @@ project.ext {
       ],
 
       firebase: [
-        bom: "21.1.0",
+        bom: "24.1.0",
       ],
     ],
   ])

packages/dynamic-links/RNFBDynamicLinks.podspec

@@ -1,7 +1,7 @@
 require 'json'
 package = JSON.parse(File.read(File.join(__dir__, 'package.json')))
 
-firebase_sdk_version = '~> 6.8.1'
+firebase_sdk_version = '~> 6.12.0'
 using_custom_firebase_sdk_version = defined? $FirebaseSDKVersion
 if using_custom_firebase_sdk_version
   Pod::UI.puts "RNFBDynamicLinks: Using user specified Firebase SDK version '#{$FirebaseSDKVersion}'"

packages/dynamic-links/android/build.gradle

@@ -31,7 +31,7 @@ project.ext {
       ],
 
       firebase: [
-        bom: "21.1.0",
+        bom: "24.1.0",
       ],
     ],
   ])

packages/firestore/RNFBFirestore.podspec

@@ -1,7 +1,7 @@
 require 'json'
 package = JSON.parse(File.read(File.join(__dir__, 'package.json')))
 
-firebase_sdk_version = '~> 6.8.1'
+firebase_sdk_version = '~> 6.12.0'
 using_custom_firebase_sdk_version = defined? $FirebaseSDKVersion
 if using_custom_firebase_sdk_version
   Pod::UI.puts "RNFBDynamicLinks: Using user specified Firebase SDK version '#{$FirebaseSDKVersion}'"

packages/firestore/android/build.gradle

@@ -31,7 +31,7 @@ project.ext {
       ],
 
       firebase: [
-        bom: "21.1.0",
+        bom: "21.3.0",
       ],
     ],
   ])

packages/firestore/android/src/reactnative/java/io/invertase/firebase/firestore/ReactNativeFirebaseFirestoreQuery.java

@@ -84,6 +84,12 @@ private void applyFilters(ReadableArray filters) {
         case "ARRAY_CONTAINS":
           query = query.whereArrayContains(Objects.requireNonNull(fieldPath), Objects.requireNonNull(value));
           break;
+        case "ARRAY_CONTAINS_ANY":
+          query = query.whereArrayContainsAny(Objects.requireNonNull(fieldPath), Objects.requireNonNull((List<Object>) value));
+          break;
+        case "IN":
+          query = query.whereIn(Objects.requireNonNull(fieldPath), Objects.requireNonNull((List<Object>) value));
+          break;
       }
     }
   }

packages/firestore/e2e/Query/where.e2e.js

@@ -128,6 +128,107 @@ describe('firestore().collection().where()', () => {
       .where(new firebase.firestore.FieldPath('foo', 'bar'), '>', 1234);
   });
 
+  it('throws if in query with no array value', () => {
+    try {
+      firebase
+        .firestore()
+        .collection('v6')
+        .where('foo.bar', 'in', '123');
+      return Promise.reject(new Error('Did not throw an Error.'));
+    } catch (error) {
+      error.message.should.containEql('A non-empty array is required');
+      return Promise.resolve();
+    }
+  });
+
+  it('throws if array-contains-any query with no array value', () => {
+    try {
+      firebase
+        .firestore()
+        .collection('v6')
+        .where('foo.bar', 'array-contains-any', '123');
+      return Promise.reject(new Error('Did not throw an Error.'));
+    } catch (error) {
+      error.message.should.containEql('A non-empty array is required');
+      return Promise.resolve();
+    }
+  });
+
+  it('throws if in query array length is greater than 10', () => {
+    try {
+      firebase
+        .firestore()
+        .collection('v6')
+        .where('foo.bar', 'in', [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11]);
+      return Promise.reject(new Error('Did not throw an Error.'));
+    } catch (error) {
+      error.message.should.containEql('maximum of 10 elements in the value');
+      return Promise.resolve();
+    }
+  });
+
+  it('throws if query has multiple array-contains-any filter', () => {
+    try {
+      firebase
+        .firestore()
+        .collection('v6')
+        .where('foo.bar', 'array-contains-any', [1])
+        .where('foo.bar', 'array-contains-any', [2]);
+      return Promise.reject(new Error('Did not throw an Error.'));
+    } catch (error) {
+      error.message.should.containEql("You cannot use more than one 'array-contains-any' filter");
+      return Promise.resolve();
+    }
+  });
+
+  it('throws if query has array-contains-any & in filter', () => {
+    try {
+      firebase
+        .firestore()
+        .collection('v6')
+        .where('foo.bar', 'array-contains-any', [1])
+        .where('foo.bar', 'in', [2]);
+      return Promise.reject(new Error('Did not throw an Error.'));
+    } catch (error) {
+      error.message.should.containEql(
+        "You cannot use 'in' filters with 'array-contains-any' filters",
+      );
+      return Promise.resolve();
+    }
+  });
+
+  it('throws if query has multiple in filter', () => {
+    try {
+      firebase
+        .firestore()
+        .collection('v6')
+        .where('foo.bar', 'in', [1])
+        .where('foo.bar', 'in', [2]);
+      return Promise.reject(new Error('Did not throw an Error.'));
+    } catch (error) {
+      error.message.should.containEql("You cannot use more than one 'in' filter");
+      return Promise.resolve();
+    }
+  });
+
+  it('throws if query has in & array-contains-any filter', () => {
+    try {
+      firebase
+        .firestore()
+        .collection('v6')
+        .where('foo.bar', 'in', [1])
+        .where('foo.bar', 'array-contains-any', [2]);
+      return Promise.reject(new Error('Did not throw an Error.'));
+    } catch (error) {
+      error.message.should.containEql(
+        "You cannot use 'array-contains-any' filters with 'in' filters",
+      );
+      return Promise.resolve();
+    }
+  });
+
+  /* Queries */
+
   it('returns with where equal filter', async () => {
     const colRef = firebase.firestore().collection('v6/filter/equal');
 
@@ -222,7 +323,7 @@ describe('firestore().collection().where()', () => {
   });
 
   it('returns with where array-contains filter', async () => {
-    const colRef = firebase.firestore().collection('v6/filter/arraycontains');
+    const colRef = firebase.firestore().collection('v6/filter/array-contains');
 
     const match = Date.now();
     await Promise.all([
@@ -239,4 +340,38 @@ describe('firestore().collection().where()', () => {
       s.data().foo.should.eql(jet.contextify(expected));
     });
   });
+
+  it('returns with in filter', async () => {
+    const colRef = firebase.firestore().collection('v6/filter/in');
+
+    await Promise.all([
+      colRef.add({ status: 'Ordered' }),
+      colRef.add({ status: 'Ready to Ship' }),
+      colRef.add({ status: 'Ready to Ship' }),
+      colRef.add({ status: 'Incomplete' }),
+    ]);
+
+    const expect = ['Ready to Ship', 'Ordered'];
+    const snapshot = await colRef.where('status', 'in', expect).get();
+    snapshot.size.should.eql(3);
+
+    snapshot.forEach(s => {
+      s.data().status.should.equalOneOf(...expect);
+    });
+  });
+
+  it('returns with array-contains-any filter', async () => {
+    const colRef = firebase.firestore().collection('v6/filter/array-contains-any');
+
+    await Promise.all([
+      colRef.add({ category: ['Appliances', 'Housewares', 'Cooking'] }),
+      colRef.add({ category: ['Appliances', 'Electronics', 'Nursery'] }),
+      colRef.add({ category: ['Audio/Video', 'Electronics'] }),
+      colRef.add({ category: ['Beauty'] }),
+    ]);
+
+    const expect = ['Appliances', 'Electronics'];
+    const snapshot = await colRef.where('category', 'array-contains-any', expect).get();
+    snapshot.size.should.eql(3); // 2nd record should only be returned once
+  });
 });

packages/firestore/ios/RNFBFirestore/RNFBFirestoreQuery.m

@@ -67,6 +67,10 @@ - (void)applyFilters {
       _query = [_query queryWhereField:fieldPath isLessThanOrEqualTo:value];
     } else if ([operator isEqualToString:@"ARRAY_CONTAINS"]) {
       _query = [_query queryWhereField:fieldPath arrayContains:value];
+    } else if ([operator isEqualToString:@"IN"]) {
+      _query = [_query queryWhereField:fieldPath in:value];
+    } else if ([operator isEqualToString:@"ARRAY_CONTAINS_ANY"]) {
+      _query = [_query queryWhereField:fieldPath arrayContainsAny:value];
     }
   }
 }
@@ -107,4 +111,4 @@ - (void)applyOptions {
   }
 }
 
-@end
+@end

packages/firestore/lib/FirestoreQuery.js

@@ -15,7 +15,13 @@
  *
  */
 
-import { isNull, isObject, isString, isUndefined } from '@react-native-firebase/app/lib/common';
+import {
+  isArray,
+  isNull,
+  isObject,
+  isString,
+  isUndefined,
+} from '@react-native-firebase/app/lib/common';
 import NativeError from '@react-native-firebase/app/lib/internal/NativeFirebaseError';
 import FirestoreDocumentSnapshot from './FirestoreDocumentSnapshot';
 import FirestoreFieldPath, { fromDotSeparatedString } from './FirestoreFieldPath';
@@ -349,7 +355,7 @@ export default class FirestoreQuery {
 
     if (!this._modifiers.isValidOperator(opStr)) {
       throw new Error(
-        "firebase.firestore().collection().where(_, *) 'opStr' is invalid. Expected one of '==', '>', '>=', '<', '<=' or 'array-contains'.",
+        "firebase.firestore().collection().where(_, *) 'opStr' is invalid. Expected one of '==', '>', '>=', '<', '<=', 'array-contains', 'array-contains-any' or 'in'.",
       );
     }
 
@@ -365,6 +371,20 @@ export default class FirestoreQuery {
       );
     }
 
+    if (this._modifiers.isInOperator(opStr)) {
+      if (!isArray(value) || !value.length) {
+        throw new Error(
+          `firebase.firestore().collection().where(_, _, *) 'value' is invalid. A non-empty array is required for '${opStr}' filters.`,
+        );
+      }
+
+      if (value.length > 10) {
+        throw new Error(
+          `firebase.firestore().collection().where(_, _, *) 'value' is invalid. '${opStr}' filters support a maximum of 10 elements in the value array.`,
+        );
+      }
+    }
+
     const modifiers = this._modifiers._copy().where(path, opStr, value);
 
     try {