Merge pull request soumak77#104 from ilearnio/firestore/DocumentReference/getCollections

Add DocumentReference.prototype.getCollections

Author: soumak77

src/firestore-document.js

@@ -199,6 +199,29 @@ MockFirestoreDocument.prototype.delete = function (callback) {
   });
 };
 
+/**
+ * Fetches the subcollections that are direct children of the document.
+ * @see https://cloud.google.com/nodejs/docs/reference/firestore/0.15.x/DocumentReference#getCollections
+ */
+MockFirestoreDocument.prototype.getCollections = function () {
+  var err = this._nextErr('getCollections');
+  var self = this;
+  return new Promise(function (resolve, reject) {
+    self._defer('getCollections', _.toArray(arguments), function () {
+      if (err === null) {
+        var collections = _.toArray(this.children);
+        // Filter out empty collections
+        collections = _.filter(collections, function (collection) {
+          return !_.isEmpty(collection.data);
+        });
+        resolve(collections);
+      } else {
+        reject(err);
+      }
+    });
+  });
+};
+
 MockFirestoreDocument.prototype._hasChild = function (key) {
   return _.isObject(this.data) && _.has(this.data, key);
 };

test/unit/firestore-document.js

@@ -396,4 +396,71 @@ describe('MockFirestoreDocument', function () {
       expect(result).to.eventually.equal(null);
     });
   });
+
+  describe('#getCollections', function () {
+    beforeEach(function () {
+      db.doc('doc/subcol/subcol-doc').set({ foo: 'bar' });
+      db.doc('doc/subcol2/subcol-doc').set({ foo: 'bar' });
+      db.doc('doc/subcol/subcol-doc/deep-col/deep-doc').set({ foo: 'bar' });
+      db.doc('doc/subcol/subcol-doc/deep-col2/deep-doc').set({ foo: 'bar' });
+      db.flush();
+    });
+    afterEach(function () {
+      db.doc('doc/subcol/subcol-doc').delete();
+      db.doc('doc/subcol2/subcol-doc').delete();
+      db.doc('doc/subcol/subcol-doc/deep-col/deep-doc').delete();
+      db.doc('doc/subcol/subcol-doc/deep-col2/deep-doc').delete();
+      db.flush();
+    });
+
+    context('when present', function () {
+      it('returns collections of document', function (done) {
+        db.doc('doc').getCollections().then(function (colRefs) {
+          expect(colRefs).to.be.an('array');
+          expect(colRefs).to.have.length(2);
+          expect(colRefs[0].path).to.equal('doc/subcol');
+          expect(colRefs[1].path).to.equal('doc/subcol2');
+          done();
+        });
+        db.flush();
+      });
+
+      it('returns deeply nested collections of document', function (done) {
+        db.doc('doc/subcol/subcol-doc').getCollections().then(function (colRefs) {
+          expect(colRefs).to.be.an('array');
+          expect(colRefs).to.have.length(2);
+          expect(colRefs[0].path).to.equal('doc/subcol/subcol-doc/deep-col');
+          expect(colRefs[1].path).to.equal('doc/subcol/subcol-doc/deep-col2');
+          done();
+        });
+        db.flush();
+      });
+    });
+
+    context('when not present', function () {
+      it('returns empty list of collections', function (done) {
+        db.doc('not-existing').getCollections().then(function (colRefs) {
+          expect(colRefs).to.be.an('array');
+          expect(colRefs).to.have.length(0);
+          done();
+        });
+        db.flush();
+      });
+
+      it('skips collections that has no documents', function (done) {
+        db.doc('doc/subcol/subcol-doc').delete();
+        db.doc('doc/subcol2/subcol-doc').delete();
+        db.doc('doc/subcol/subcol-doc/deep-col/deep-doc').delete();
+        db.doc('doc/subcol/subcol-doc/deep-col2/deep-doc').delete();
+        db.flush();
+
+        db.doc('doc').getCollections().then(function (colRefs) {
+          expect(colRefs).to.be.an('array');
+          expect(colRefs).to.have.length(0);
+          done();
+        });
+        db.flush();
+      });
+    });
+  });
 });