react-native-firebase/bridge/e2e/firestore/documentSnapshot.e2e.js

const {
  COL_DOC_1,
  COL_DOC_1_ID,
  COL_DOC_1_PATH,
  testCollectionDoc,
  resetTestCollectionDoc,
} = TestHelpers.firestore;

describe('firestore()', () => {
  describe('DocumentSnapshot', () => {
    before(async () => {
      await resetTestCollectionDoc(COL_DOC_1_PATH, COL_DOC_1());
    });

    describe('id', () => {
      it('returns a string document id', async () => {
        const snapshot = await testCollectionDoc(COL_DOC_1_PATH).get();
        snapshot.id.should.be.a.String();
        snapshot.id.should.equal(COL_DOC_1_ID);
      });
    });

    describe('ref', () => {
      it('returns a DocumentReference', async () => {
        const snapshot = await testCollectionDoc(COL_DOC_1_PATH).get();
        const DocumentReference = bridge.require(
          'dist/modules/firestore/DocumentReference'
        );
        snapshot.ref.should.be.an.instanceOf(DocumentReference);
      });
    });

    describe('metadata', () => {
      it('returns an object of meta data', async () => {
        const { metadata } = await testCollectionDoc(COL_DOC_1_PATH).get();
        metadata.should.be.an.Object();
        metadata.should.have.property('hasPendingWrites');
        metadata.should.have.property('fromCache');
        metadata.hasPendingWrites.should.be.a.Boolean();
        metadata.fromCache.should.be.a.Boolean();
      });
    });

    describe('exists', () => {
      it('returns a boolean', async () => {
        const { exists } = await testCollectionDoc(COL_DOC_1_PATH).get();
        exists.should.be.a.Boolean();
        exists.should.be.true();
      });
    });

    describe('data()', () => {
      it('returns document data', async () => {
        // additionally tests context binding not lost during destructuring
        const snapshot = await testCollectionDoc(COL_DOC_1_PATH).get();
        const { data } = snapshot;

        snapshot.data.should.be.a.Function();
        data.should.be.a.Function();

        snapshot.data().should.be.a.Object();
        data().should.be.a.Object();

        snapshot.data().baz.should.be.true();
        data().baz.should.be.true();
      });
    });

    describe('get()', () => {
      it('using a dot notated path string', async () => {
        // additionally tests context binding not lost during destructuring
        const snapshot = await testCollectionDoc(COL_DOC_1_PATH).get();
        const { get } = snapshot;

        should.equal(snapshot.get('foo'), 'bar');
        should.equal(get('foo'), 'bar');

        should.equal(snapshot.get('object.daz'), 123);
        should.equal(get('object.daz'), 123);

        should.equal(snapshot.get('nonexistent.object'), undefined);
        should.equal(get('nonexistent.object'), undefined);
      });

      it('using a FieldPath instance', async () => {
        const snapshot = await testCollectionDoc(COL_DOC_1_PATH).get();

        should.equal(snapshot.get('foo'), 'bar');

        should.equal(
          snapshot.get(new firebase.firestore.FieldPath('foo')),
          'bar'
        );

        should.equal(
          snapshot.get(new firebase.firestore.FieldPath('object', 'daz')),
          123
        );

        should.equal(
          snapshot.get(
            new firebase.firestore.FieldPath('nonexistent', 'object')
          ),
          undefined
        );
      });
    });
  });
});