Add support for Firestore Collection Group queries #1284

Author: EddyVerbruggen

demo-ng/app/tabs/firestore/firestore.component.html

@@ -31,6 +31,7 @@
     <Button text="Start at 'LA'" (tap)="firestoreStartAt()" class="button"></Button>
     <Button text="Start after 'LA'" (tap)="firestoreStartAfter()" class="button"></Button>
     <Button text="Delete" (tap)="firestoreDelete()" class="button"></Button>
+    <Button text="Collection group query" (tap)="firestoreCollectionGroupQuery()" class="button"></Button>
     <Button text="Transactional update (iOS)" (tap)="transactionalUpdate()" class="button"></Button>
     <Button text="Write batch" (tap)="writeBatch()" class="button"></Button>
   </StackLayout>

demo-ng/app/tabs/firestore/firestore.component.ts

@@ -395,6 +395,13 @@ export class FirestoreComponent {
         .catch(err => console.log("Delete failed, error: " + err));
   }
 
+  firestoreCollectionGroupQuery(): void {
+    firebase.firestore().collectionGroup("cities").where("population", ">=", 1_000_000)
+        .get()
+        .then(result => console.log(JSON.stringify(result)))
+        .catch(err => console.log("Delete failed, error: " + err));
+  }
+
   doWebGetValueForCompanies(): void {
     const path = "/companies";
     firebase.database().ref(path)

docs/STORAGE.md

@@ -212,6 +212,9 @@ In this example we'll determine the remote URL of the previously uploaded file.
 Note that your security rules must be version "2" for this to work,
 so if it fails try adding this at the top of your rules defined for your storage bucket: `rules_version = '2';`
 
+Also note that this will require an index in your db, so make sure to `catch` any errors when invoking this method
+and log out any error messages so you can easily copy-paste the required index into your browser URL bar.
+
 <details>
  <summary>Native API</summary>
 
@@ -225,6 +228,10 @@ so if it fails try adding this at the top of your rules defined for your storage
       function (result) {
           console.log(JSON.stringify(result));
           // see the Web API example below for an advanced example
+      },
+      function (error) {
+          // probably related to a missing index or security rules, see the notes in the readme above
+          console.log(error);
       }
   );
 ```

src/app/firestore/index.ts

@@ -7,6 +7,10 @@ export namespace firestore {
       return firebase.firestore.collection(collectionPath);
     }
 
+    collectionGroup(id: string): firebase.firestore.CollectionGroup {
+      return firebase.firestore.collectionGroup(id);
+    }
+
     doc(path: string): firebase.firestore.DocumentReference {
       return firebase.firestore.docRef(path);
     }

src/firebase.android.ts

@@ -2156,6 +2156,17 @@ firebase.firestore.collection = (collectionPath: string): firestore.CollectionRe
   }
 };
 
+firebase.firestore.collectionGroup = (id: string): firestore.CollectionGroup => {
+  ensureFirestore();
+  try {
+    const db = com.google.firebase.firestore.FirebaseFirestore.getInstance();
+    return firebase.firestore._getCollectionGroupQuery(db.collectionGroup(id));
+  } catch (ex) {
+    console.log("Error in firebase.firestore.collectionGroup: " + ex);
+    return null;
+  }
+};
+
 firebase.firestore.onDocumentSnapshot = (docRef: com.google.firebase.firestore.DocumentReference, optionsOrCallback: firestore.SnapshotListenOptions | ((snapshot: DocumentSnapshot) => void), callbackOrOnError: (docOrError: DocumentSnapshot | Error) => void, onError: (error: Error) => void): () => void => {
   let options = com.google.firebase.firestore.MetadataChanges.EXCLUDE;
   let onNextCallback: (snapshot: DocumentSnapshot) => void;
@@ -2240,6 +2251,16 @@ firebase.firestore._getDocumentReference = (docRef?: JDocumentReference): firest
   };
 };
 
+firebase.firestore._getCollectionGroupQuery = (query?: com.google.firebase.firestore.Query): firestore.CollectionGroup => {
+  if (!query) {
+    return null;
+  }
+
+  return {
+    where: (property: string, opStr: firestore.WhereFilterOp, value: any) => firebase.firestore.where(undefined, property, opStr, value, query)
+  };
+};
+
 firebase.firestore._getCollectionReference = (colRef?: JCollectionReference): firestore.CollectionReference => {
   if (!colRef) {
     return null;

src/firebase.d.ts

@@ -824,6 +824,10 @@ export namespace firestore {
     endBefore(snapshot: DocumentSnapshot): Query;
   }
 
+  export interface CollectionGroup {
+    where(fieldPath: string, opStr: WhereFilterOp, value: any): Query;
+  }
+
   export interface CollectionReference extends Query {
     readonly id: string;
 
@@ -970,6 +974,8 @@ export namespace firestore {
 
   function collection(collectionPath: string): CollectionReference;
 
+  function collectionGroup(id: string): CollectionGroup;
+
   function doc(collectionPath: string, documentPath?: string): DocumentReference;
 
   function docRef(documentPath: string): DocumentReference;

src/firebase.ios.ts

@@ -1673,6 +1673,10 @@ const ensureFirestore = (): void => {
   if (typeof (FIRFirestore) === "undefined") {
     throw new Error("Make sure 'firestore' is enabled in 'firebase.nativescript.json', then clean the node_modules and platforms folders");
   }
+
+  if (!firebase.initialized) {
+    throw new Error("Please run firebase.init() before using Firestore");
+  }
 };
 
 firebase.firestore.WriteBatch = (nativeWriteBatch: FIRWriteBatch): firestore.WriteBatch => {
@@ -1785,18 +1789,23 @@ firebase.firestore.clearPersistence = (): Promise<void> => {
 firebase.firestore.collection = (collectionPath: string): firestore.CollectionReference => {
   ensureFirestore();
   try {
-    if (!firebase.initialized) {
-      console.log("Please run firebase.init() before firebase.firestore.collection()");
-      return null;
-    }
-
     return firebase.firestore._getCollectionReference(FIRFirestore.firestore().collectionWithPath(collectionPath));
   } catch (ex) {
     console.log("Error in firebase.firestore.collection: " + ex);
     return null;
   }
 };
 
+firebase.firestore.collectionGroup = (id: string): firestore.CollectionGroup => {
+  ensureFirestore();
+  try {
+    return firebase.firestore._getCollectionGroupQuery(FIRFirestore.firestore().collectionGroupWithID(id));
+  } catch (ex) {
+    console.log("Error in firebase.firestore.collectionGroup: " + ex);
+    return null;
+  }
+};
+
 firebase.firestore.onDocumentSnapshot = (docRef: FIRDocumentReference, optionsOrCallback: firestore.SnapshotListenOptions | ((snapshot: DocumentSnapshot) => void), callbackOrOnError: (docOrError: DocumentSnapshot | Error) => void, onError: (error: Error) => void): () => void => {
   let includeMetadataChanges = false;
   let onNextCallback: (snapshot: DocumentSnapshot) => void;
@@ -1897,6 +1906,16 @@ firebase.firestore._getCollectionReference = (colRef?: FIRCollectionReference):
   };
 };
 
+firebase.firestore._getCollectionGroupQuery = (query?: FIRQuery): firestore.CollectionGroup => {
+  if (!query) {
+    return null;
+  }
+
+  return {
+    where: (property: string, opStr: firestore.WhereFilterOp, value: any) => firebase.firestore.where(undefined, property, opStr, value, query)
+  };
+};
+
 firebase.firestore._getDocumentReference = (docRef?: FIRDocumentReference): firestore.DocumentReference => {
   if (!docRef) {
     return null;
@@ -1922,11 +1941,6 @@ firebase.firestore._getDocumentReference = (docRef?: FIRDocumentReference): fire
 firebase.firestore.doc = (collectionPath: string, documentPath?: string): firestore.DocumentReference => {
   ensureFirestore();
   try {
-    if (!firebase.initialized) {
-      console.log("Please run firebase.init() before firebase.firestore.doc()");
-      return null;
-    }
-
     const fIRCollectionReference = FIRFirestore.firestore().collectionWithPath(collectionPath);
     const fIRDocumentReference = documentPath ? fIRCollectionReference.documentWithPath(documentPath) : fIRCollectionReference.documentWithAutoID();
     return firebase.firestore._getDocumentReference(fIRDocumentReference);