Firestore: Add test that verifies aggregate query error message when missing index (#12189)

Author: dconeybe

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

@@ -1093,4 +1093,45 @@ - (void)testPerformsAverageOnlyOnNumericFields {
                  [[NSNumber numberWithDouble:5] doubleValue]);
 }
 
+- (void)testFailWithMessageWithConsoleLinkIfMissingIndex {
+  XCTSkipIf([FSTIntegrationTestCase isRunningAgainstEmulator],
+            "Skip this test when running against the Firestore emulator because the Firestore "
+            "emulator does not use indexes and never fails with a 'missing index' error.");
+
+  FIRCollectionReference* testCollection = [self collectionRef];
+  FIRQuery* compositeIndexQuery = [[testCollection queryWhereField:@"field1"
+                                                         isEqualTo:@42] queryWhereField:@"field2"
+                                                                             isLessThan:@99];
+  FIRAggregateQuery* compositeIndexAggregateQuery = [compositeIndexQuery aggregate:@[
+    [FIRAggregateField aggregateFieldForCount],
+    [FIRAggregateField aggregateFieldForSumOfField:@"pages"],
+    [FIRAggregateField aggregateFieldForAverageOfField:@"pages"]
+  ]];
+
+  XCTestExpectation* queryCompletion = [self expectationWithDescription:@"query"];
+  [compositeIndexAggregateQuery
+      aggregationWithSource:FIRAggregateSourceServer
+                 completion:^(FIRAggregateQuerySnapshot* snapshot, NSError* error) {
+                   XCTAssertNotNil(error);
+                   if (error) {
+                     NSString* errorDescription = [error localizedDescription];
+                     XCTAssertTrue([errorDescription.lowercaseString containsString:@"index"],
+                                   "The NSError should have contained the word 'index' "
+                                   "(case-insensitive), but got: %@",
+                                   errorDescription);
+                     // TODO(b/316359394) Remove this check for the default databases once
+                     // cl/582465034 is rolled out to production.
+                     if ([[FSTIntegrationTestCase databaseID] isEqualToString:@"(default)"]) {
+                       XCTAssertTrue(
+                           [errorDescription containsString:@"https://console.firebase.google.com"],
+                           "The NSError should have contained the string "
+                           "'https://console.firebase.google.com', but got: %@",
+                           errorDescription);
+                     }
+                   }
+                   XCTAssertNil(snapshot);
+                   [queryCompletion fulfill];
+                 }];
+  [self awaitExpectations];
+}
 @end

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

@@ -227,4 +227,42 @@ - (void)testFailWithoutNetwork {
   XCTAssertEqual(snapshot.count, [NSNumber numberWithLong:3L]);
 }
 
+- (void)testFailWithMessageWithConsoleLinkIfMissingIndex {
+  XCTSkipIf([FSTIntegrationTestCase isRunningAgainstEmulator],
+            "Skip this test when running against the Firestore emulator because the Firestore "
+            "emulator does not use indexes and never fails with a 'missing index' error.");
+
+  FIRCollectionReference* testCollection = [self collectionRef];
+  FIRQuery* compositeIndexQuery = [[testCollection queryWhereField:@"field1"
+                                                         isEqualTo:@42] queryWhereField:@"field2"
+                                                                             isLessThan:@99];
+  FIRAggregateQuery* compositeIndexCountQuery = [compositeIndexQuery count];
+
+  XCTestExpectation* queryCompletion = [self expectationWithDescription:@"query"];
+  [compositeIndexCountQuery
+      aggregationWithSource:FIRAggregateSourceServer
+                 completion:^(FIRAggregateQuerySnapshot* snapshot, NSError* error) {
+                   XCTAssertNotNil(error);
+                   if (error) {
+                     NSString* errorDescription = [error localizedDescription];
+                     XCTAssertTrue([errorDescription.lowercaseString containsString:@"index"],
+                                   "The NSError should have contained the word 'index' "
+                                   "(case-insensitive), but got: %@",
+                                   errorDescription);
+                     // TODO(b/316359394) Remove this check for the default databases once
+                     // cl/582465034 is rolled out to production.
+                     if ([[FSTIntegrationTestCase databaseID] isEqualToString:@"(default)"]) {
+                       XCTAssertTrue(
+                           [errorDescription containsString:@"https://console.firebase.google.com"],
+                           "The NSError should have contained the string "
+                           "'https://console.firebase.google.com', but got: %@",
+                           errorDescription);
+                     }
+                   }
+                   XCTAssertNil(snapshot);
+                   [queryCompletion fulfill];
+                 }];
+  [self awaitExpectations];
+}
+
 @end