fix(firestore): ensure all index URLs are captured and passed to the …

…user (#10674)
firebase · Apr 4, 2023 · 9800435 · 9800435
1 parent cf7dd46
commit 9800435
Show file tree

Hide file tree

Showing 4 changed files with 48 additions and 5 deletions.
diff --git a/.github/workflows/scripts/firestore.rules b/.github/workflows/scripts/firestore.rules
@@ -9,6 +9,10 @@ service cloud.firestore {
     	allow read, write: if true;
     }
 
+    match /{path=**}/collection-group/{subId} {
+      allow read, write: if true;
+    }
+
     match /firestore-bundle-tests/{document=**} {
     	allow read, write: if true;
     }

diff --git a/...rc/main/java/io/flutter/plugins/firebase/firestore/FlutterFirebaseFirestoreException.java b/...rc/main/java/io/flutter/plugins/firebase/firestore/FlutterFirebaseFirestoreException.java
@@ -79,8 +79,7 @@ public FlutterFirebaseFirestoreException(
             break;
           case "FAILED_PRECONDITION":
             code = "failed-precondition";
-            if (foundMessage.contains("query requires an index")
-                || foundMessage.contains("ensure it has been indexed")) {
+            if (foundMessage.contains("index")) {
               message = foundMessage;
             } else {
               message = ERROR_FAILED_PRECONDITION;

diff --git a/packages/cloud_firestore/cloud_firestore/example/integration_test/query_e2e.dart b/packages/cloud_firestore/cloud_firestore/example/integration_test/query_e2e.dart
@@ -115,6 +115,27 @@ void runQueryTests() {
         expect(groupSnapshot.docs[0].data()['foo'], equals(2));
         expect(groupSnapshot.docs[1].data()['foo'], equals(1));
       });
+
+      testWidgets(
+          'should respond with a FirebaseException, the query requires an index',
+          (_) async {
+        try {
+          await FirebaseFirestore.instance
+              .collectionGroup('collection-group')
+              .where('number', isGreaterThan: 1, isLessThan: 3)
+              .where('foo', isEqualTo: 'bar')
+              .get();
+        } catch (error) {
+          expect(
+            (error as FirebaseException).code,
+            equals('failed-precondition'),
+          );
+          expect(
+            error.message,
+            'The query requires an index',
+          );
+        }
+      });
     });
 
     /**
@@ -186,6 +207,27 @@ void runQueryTests() {
         }
         fail('Should have thrown a [FirebaseException]');
       });
+
+      testWidgets(
+          'should respond with a FirebaseException, the query requires an index',
+          (_) async {
+        try {
+          await FirebaseFirestore.instance
+              .collection('flutter-tests')
+              .where('number', isGreaterThan: 1, isLessThan: 3)
+              .where('foo', isEqualTo: 'bar')
+              .get();
+        } catch (error) {
+          expect(
+            (error as FirebaseException).code,
+            equals('failed-precondition'),
+          );
+          expect(
+            error.message,
+            'The query requires an index',
+          );
+        }
+      });
     });
 
     /**

diff --git a/packages/cloud_firestore/cloud_firestore/ios/Classes/FLTFirebaseFirestoreUtils.m b/packages/cloud_firestore/cloud_firestore/ios/Classes/FLTFirebaseFirestoreUtils.m
@@ -100,9 +100,7 @@ + (NSArray *)ErrorCodeAndMessageFromNSError:(NSError *)error {
       break;
     case FIRFirestoreErrorCodeFailedPrecondition:
       code = @"failed-precondition";
-      if ([error.localizedDescription containsString:@"query requires an index"] ||
-          [error.localizedDescription containsString:@"requires a COLLECTION_GROUP_DESC index"] ||
-          [error.localizedDescription containsString:@"requires a COLLECTION_GROUP_ASC index"]) {
+      if ([error.localizedDescription containsString:@"index"]) {
         message = error.localizedDescription;
       } else {
         message = @"Operation was rejected because the system is not in a state required for the "