Make IN queries publicly available (#4174)

Author: Brian Chen

Firestore/CHANGELOG.md

@@ -1,4 +1,9 @@
 # Unreleased
+- [feature] Added `whereField(_:in:)` and `whereField(_:arrayContainsAny:)` query
+  operators. `whereField(_:in:)` finds documents where a specified field’s value
+  is IN a specified array. `whereField(_:arrayContainsAny:)` finds documents
+  where a specified field is an array and contains ANY element of a specified
+  array.
 
 # v1.6.1
 - [fixed] Fix a race condition that could cause a segmentation fault during
@@ -196,7 +201,7 @@
 # v0.13.0
 - [feature] Added `FieldValue.arrayUnion()` and `FieldValue.arrayRemove()` to
   atomically add and remove elements from an array field in a document.
-- [feature] Added `whereField(arrayContains:)` query filter to find
+- [feature] Added `whereField(_:arrayContains:)` query filter to find
   documents where an array field contains a specific element.
 - [fixed] Fixed compilation with older Xcode versions (#1517).
 - [fixed] Fixed a performance issue where large write batches with hundreds of

Firestore/Example/Tests/Integration/API/FIRQueryTests.mm

@@ -324,9 +324,6 @@ - (void)testQueriesCanUseArrayContainsFilters {
 }
 
 - (void)testQueriesCanUseInFilters {
-  // TODO(b/138855186): Re-enable in prod once feature lands in backend.
-  if (![FSTIntegrationTestCase isRunningAgainstEmulator]) return;
-
   NSDictionary *testDocs = @{
     @"a" : @{@"zip" : @98101},
     @"b" : @{@"zip" : @91102},
@@ -349,9 +346,6 @@ - (void)testQueriesCanUseInFilters {
 }
 
 - (void)testQueriesCanUseInFiltersWithDocIds {
-  // TODO(b/138855186): Re-enable in prod once feature lands in backend.
-  if (![FSTIntegrationTestCase isRunningAgainstEmulator]) return;
-
   NSDictionary *testDocs = @{
     @"aa" : @{@"key" : @"aa"},
     @"ab" : @{@"key" : @"ab"},
@@ -367,9 +361,6 @@ - (void)testQueriesCanUseInFiltersWithDocIds {
 }
 
 - (void)testQueriesCanUseArrayContainsAnyFilters {
-  // TODO(b/138855186): Re-enable in prod once feature lands in backend.
-  if (![FSTIntegrationTestCase isRunningAgainstEmulator]) return;
-
   NSDictionary *testDocs = @{
     @"a" : @{@"array" : @[ @42 ]},
     @"b" : @{@"array" : @[ @"a", @42, @"c" ]},

Firestore/Source/API/FIRQuery+Internal.h

@@ -42,66 +42,6 @@ NS_ASSUME_NONNULL_BEGIN
 
 - (const api::Query &)apiQuery;
 
-/**
- * Creates and returns a new `FIRQuery` with the additional filter that documents must contain
- * the specified field, the value must be an array, and that array must contain at least one value
- * from the provided array.
- *
- * A query can have only one arrayContains filter and it cannot be combined with arrayContains or
- * in.
- *
- * @param field The name of the field containing an array to search.
- * @param value The value that contains the values to match.
- *
- * @return The created `FIRQuery`.
- */
-// TODO(b/138855186): Expose to public once backend is ready.
-- (FIRQuery *)queryWhereField:(NSString *)field arrayContainsAny:(NSArray<id> *)value;
-
-/**
- * Creates and returns a new `FIRQuery` with the additional filter that documents must contain
- * the specified field, the value must be an array, and that array must contain at least one value
- * from the provided array.
- *
- * A query can have only one arrayContains filter and it cannot be combined with arrayContains or
- * in.
- *
- * @param path The path of the field containing an array to search.
- * @param value The value that contains the values to match.
- *
- * @return The created `FIRQuery`.
- */
-// TODO(b/138855186): Expose to public once backend is ready.
-- (FIRQuery *)queryWhereFieldPath:(FIRFieldPath *)path arrayContainsAny:(NSArray<id> *)value;
-
-/**
- * Creates and returns a new `FIRQuery` with the additional filter that documents must contain
- * the specified field and the value must equal one of the values from the provided array.
- *
- * A query can have only one in filter, and it cannot be combined with arrayContainsAny.
- *
- * @param field The name of the field to search.
- * @param value The value that contains the values to match.
- *
- * @return The created `FIRQuery`.
- */
-// TODO(b/138855186): Expose to public once backend is ready.
-- (FIRQuery *)queryWhereField:(NSString *)field in:(NSArray<id> *)value;
-
-/**
- * Creates and returns a new `FIRQuery` with the additional filter that documents must contain
- * the specified field and the value must equal one of the values from the provided array.
- *
- * A query can have only one in filter, and it cannot be combined with arrayContainsAny.
- *
- * @param path The path of the field to search.
- * @param value The value that contains the values to match.
- *
- * @return The created `FIRQuery`.
- */
-// TODO(b/138855186): Expose to public once backend is ready.
-- (FIRQuery *)queryWhereFieldPath:(FIRFieldPath *)path in:(NSArray<id> *)value;
-
 @end
 
 NS_ASSUME_NONNULL_END

Firestore/Source/API/FIRQuery.mm

@@ -252,6 +252,24 @@ - (FIRQuery *)queryWhereFieldPath:(FIRFieldPath *)path isGreaterThanOrEqualTo:(i
                                  value:value];
 }
 
+- (FIRQuery *)queryWhereField:(NSString *)field arrayContainsAny:(NSArray<id> *)value {
+  return [self queryWithFilterOperator:Filter::Operator::ArrayContainsAny field:field value:value];
+}
+
+- (FIRQuery *)queryWhereFieldPath:(FIRFieldPath *)path arrayContainsAny:(NSArray<id> *)value {
+  return [self queryWithFilterOperator:Filter::Operator::ArrayContainsAny
+                                  path:path.internalValue
+                                 value:value];
+}
+
+- (FIRQuery *)queryWhereField:(NSString *)field in:(NSArray<id> *)value {
+  return [self queryWithFilterOperator:Filter::Operator::In field:field value:value];
+}
+
+- (FIRQuery *)queryWhereFieldPath:(FIRFieldPath *)path in:(NSArray<id> *)value {
+  return [self queryWithFilterOperator:Filter::Operator::In path:path.internalValue value:value];
+}
+
 - (FIRQuery *)queryFilteredUsingComparisonPredicate:(NSPredicate *)predicate {
   NSComparisonPredicate *comparison = (NSComparisonPredicate *)predicate;
   if (comparison.comparisonPredicateModifier != NSDirectPredicateModifier) {
@@ -546,24 +564,6 @@ - (Bound)boundFromFieldValues:(NSArray<id> *)fieldValues isBefore:(BOOL)isBefore
 
 @implementation FIRQuery (Internal)
 
-- (FIRQuery *)queryWhereField:(NSString *)field arrayContainsAny:(NSArray<id> *)value {
-  return [self queryWithFilterOperator:Filter::Operator::ArrayContainsAny field:field value:value];
-}
-
-- (FIRQuery *)queryWhereFieldPath:(FIRFieldPath *)path arrayContainsAny:(NSArray<id> *)value {
-  return [self queryWithFilterOperator:Filter::Operator::ArrayContainsAny
-                                  path:path.internalValue
-                                 value:value];
-}
-
-- (FIRQuery *)queryWhereField:(NSString *)field in:(NSArray<id> *)value {
-  return [self queryWithFilterOperator:Filter::Operator::In field:field value:value];
-}
-
-- (FIRQuery *)queryWhereFieldPath:(FIRFieldPath *)path in:(NSArray<id> *)value {
-  return [self queryWithFilterOperator:Filter::Operator::In path:path.internalValue value:value];
-}
-
 - (const core::Query &)query {
   return _query.query();
 }