Add getDoc() (#3133)

Author: schmidt-sebastian

integration/firestore/gulpfile.js

@@ -1,6 +1,6 @@
 /**
  * @license
- * Copyright 2017 Google Inc.
+ * Copyright 2017 Google LLC
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -51,6 +51,7 @@ function copyTests() {
         testBase + '/integration/api/*.ts',
         testBase + '/integration/util/events_accumulator.ts',
         testBase + '/integration/util/helpers.ts',
+        testBase + '/integration/util/settings.ts',
         testBase + '/util/equality_matcher.ts',
         testBase + '/util/promise.ts'
       ],

packages/firestore/lite/index.node.ts

@@ -34,7 +34,8 @@ export {
   CollectionReference,
   collection,
   doc,
-  parent
+  parent,
+  getDoc
 } from './src/api/reference';
 
 // TOOD(firestorelite): Add tests when setDoc() is available

packages/firestore/lite/src/api/database.ts

@@ -22,12 +22,19 @@ import { FirebaseApp } from '@firebase/app-types-exp';
 import { Provider } from '@firebase/component';
 
 import { Code, FirestoreError } from '../../../src/util/error';
-import { DatabaseId } from '../../../src/core/database_info';
+import { DatabaseId, DatabaseInfo } from '../../../src/core/database_info';
 import { FirebaseAuthInternalName } from '@firebase/auth-interop-types';
 import {
   CredentialsProvider,
   FirebaseCredentialsProvider
 } from '../../../src/api/credentials';
+import { Datastore, newDatastore } from '../../../src/remote/datastore';
+import { PlatformSupport } from '../../../src/platform/platform';
+import { Deferred } from '../../../src/util/promise';
+
+// settings() defaults:
+const DEFAULT_HOST = 'firestore.googleapis.com';
+const DEFAULT_SSL = true;
 
 // TODO(firestorelite): Depend on FirebaseService once #3112 is merged
 
@@ -38,7 +45,10 @@ export class Firestore implements firestore.FirebaseFirestore {
   readonly _databaseId: DatabaseId;
   private readonly _firebaseApp: FirebaseApp;
   private readonly _credentials: CredentialsProvider;
-  private _settings?: firestore.Settings;
+
+  // Assigned via _configureClient()/_ensureClientConfigured()
+  _settings?: firestore.Settings;
+  private readonly _datastoreDeferred = new Deferred<Datastore>();
 
   constructor(
     app: FirebaseApp,
@@ -63,12 +73,41 @@ export class Firestore implements firestore.FirebaseFirestore {
       );
     }
     this._settings = settings;
+
+    const databaseInfo = this._makeDatabaseInfo(settings);
+
+    // Kick off initializing the datastore but don't actually wait for it.
+    // eslint-disable-next-line @typescript-eslint/no-floating-promises
+    PlatformSupport.getPlatform()
+      .loadConnection(databaseInfo)
+      .then(connection => {
+        const serializer = PlatformSupport.getPlatform().newSerializer(
+          databaseInfo.databaseId
+        );
+        const datastore = newDatastore(
+          connection,
+          this._credentials,
+          serializer
+        );
+        this._datastoreDeferred.resolve(datastore);
+      });
   }
 
-  _ensureClientConfigured(): void {
+  _ensureClientConfigured(): Promise<Datastore> {
     if (!this._settings) {
       this._settings = {};
     }
+    return this._datastoreDeferred.promise;
+  }
+
+  private _makeDatabaseInfo(settings: firestore.Settings): DatabaseInfo {
+    return new DatabaseInfo(
+      this._databaseId,
+      /* persistenceKey= */ 'unsupported',
+      settings.host ?? DEFAULT_HOST,
+      settings.ssl ?? DEFAULT_SSL,
+      /* forceLongPolling= */ false
+    );
   }
 
   private static databaseIdFromApp(app: FirebaseApp): DatabaseId {

packages/firestore/lite/src/api/reference.ts

@@ -17,13 +17,17 @@
 
 import * as firestore from '../../index';
 
+import { Document } from '../../../src/model/document';
 import { DocumentKey } from '../../../src/model/document_key';
 import { Firestore } from './database';
 import { DocumentKeyReference } from '../../../src/api/user_data_reader';
 import { Query as InternalQuery } from '../../../src/core/query';
 import { FirebaseFirestore, FirestoreDataConverter } from '../../index';
 import { ResourcePath } from '../../../src/model/path';
 import { AutoId } from '../../../src/util/misc';
+import { DocumentSnapshot } from './snapshot';
+import { invokeBatchGetDocumentsRpc } from '../../../src/remote/datastore';
+import { hardAssert } from '../../../src/util/assert';
 import { cast } from './util';
 import {
   validateArgType,
@@ -245,3 +249,20 @@ export function parent<T>(
     );
   }
 }
+
+export function getDoc<T>(
+  reference: firestore.DocumentReference<T>
+): Promise<firestore.DocumentSnapshot<T>> {
+  const ref = cast(reference, DocumentReference) as DocumentReference<T>;
+  return ref.firestore._ensureClientConfigured().then(async datastore => {
+    const result = await invokeBatchGetDocumentsRpc(datastore, [ref._key]);
+    hardAssert(result.length === 1, 'Expected a single document result');
+    const maybeDocument = result[0];
+    return new DocumentSnapshot<T>(
+      ref.firestore,
+      ref._key,
+      maybeDocument instanceof Document ? maybeDocument : null,
+      ref._converter
+    );
+  });
+}

packages/firestore/lite/test/helpers.ts

@@ -17,23 +17,41 @@
 
 import { initializeApp } from '@firebase/app-exp';
 
-import { Firestore, getFirestore } from '../src/api/database';
+import * as firestore from '../index';
 
-// eslint-disable-next-line @typescript-eslint/no-require-imports
-const PROJECT_CONFIG = require('../../../../config/project.json');
-
-export const DEFAULT_PROJECT_ID = PROJECT_CONFIG.projectId;
+import { initializeFirestore } from '../src/api/database';
+import { doc, collection } from '../src/api/reference';
+import {
+  DEFAULT_PROJECT_ID,
+  DEFAULT_SETTINGS
+} from '../../test/integration/util/settings';
 
 let appCount = 0;
 
-export async function withTestDb(
-  fn: (db: Firestore) => void | Promise<void>
+export async function withTestDbSettings(
+  projectId: string,
+  settings: firestore.Settings,
+  fn: (db: firestore.FirebaseFirestore) => void | Promise<void>
 ): Promise<void> {
   const app = initializeApp(
-    { apiKey: 'fake-api-key', projectId: DEFAULT_PROJECT_ID },
+    { apiKey: 'fake-api-key', projectId },
     'test-app-' + appCount++
   );
 
-  const firestore = getFirestore(app);
+  const firestore = initializeFirestore(app, settings);
   return fn(firestore);
 }
+
+export function withTestDb(
+  fn: (db: firestore.FirebaseFirestore) => void | Promise<void>
+): Promise<void> {
+  return withTestDbSettings(DEFAULT_PROJECT_ID, DEFAULT_SETTINGS, fn);
+}
+
+export function withTestDoc(
+  fn: (doc: firestore.DocumentReference) => void | Promise<void>
+): Promise<void> {
+  return withTestDb(db => {
+    return fn(doc(collection(db, 'test-collection')));
+  });
+}

packages/firestore/lite/test/integration.test.ts

@@ -23,13 +23,14 @@ import {
   getFirestore,
   initializeFirestore
 } from '../src/api/database';
-import { withTestDb } from './helpers';
+import { withTestDb, withTestDoc } from './helpers';
 import {
   parent,
   collection,
   CollectionReference,
   doc,
-  DocumentReference
+  DocumentReference,
+  getDoc
 } from '../src/api/reference';
 import { expectEqual, expectNotEqual } from '../../test/util/helpers';
 import { FieldValue } from '../../src/api/field_value';
@@ -159,6 +160,17 @@ describe('parent', () => {
   });
 });
 
+describe('getDoc()', () => {
+  it('can get a non-existing document', () => {
+    return withTestDoc(async docRef => {
+      const docSnap = await getDoc(docRef);
+      expect(docSnap.exists()).to.be.false;
+    });
+  });
+
+  // TODO(firestorelite): Expand test coverage once we can write docs
+});
+
 describe('FieldValue', () => {
   it('support equality checking with isEqual()', () => {
     expectEqual(FieldValue.delete(), FieldValue.delete());

packages/firestore/test/integration/api/database.test.ts

@@ -25,13 +25,13 @@ import { EventsAccumulator } from '../util/events_accumulator';
 import firebase from '../util/firebase_export';
 import {
   apiDescribe,
-  DEFAULT_SETTINGS,
   withTestCollection,
   withTestDb,
   withTestDbs,
   withTestDoc,
   withTestDocAndInitialData
 } from '../util/helpers';
+import { DEFAULT_SETTINGS } from '../util/settings';
 
 // tslint:disable:no-floating-promises
 

packages/firestore/test/integration/api/fields.test.ts

@@ -19,13 +19,13 @@ import { expect } from 'chai';
 import firebase from '../util/firebase_export';
 import {
   apiDescribe,
-  DEFAULT_SETTINGS,
   toDataArray,
   withTestCollection,
   withTestCollectionSettings,
   withTestDoc,
   withTestDocAndSettings
 } from '../util/helpers';
+import { DEFAULT_SETTINGS } from '../util/settings';
 
 const FieldPath = firebase.firestore!.FieldPath;
 const FieldValue = firebase.firestore!.FieldValue;

packages/firestore/test/integration/api/validation.test.ts

@@ -21,13 +21,12 @@ import { expect } from 'chai';
 import { Deferred } from '../../util/promise';
 import firebase from '../util/firebase_export';
 import {
-  ALT_PROJECT_ID,
   apiDescribe,
-  DEFAULT_PROJECT_ID,
   withAlternateTestDb,
   withTestCollection,
   withTestDb
 } from '../util/helpers';
+import { ALT_PROJECT_ID, DEFAULT_PROJECT_ID } from '../util/settings';
 
 // tslint:disable:no-floating-promises
 

packages/firestore/test/integration/browser/webchannel.test.ts

@@ -19,7 +19,7 @@ import { expect } from 'chai';
 import { DatabaseId, DatabaseInfo } from '../../../src/core/database_info';
 import { WebChannelConnection } from '../../../src/platform_browser/webchannel_connection';
 import * as api from '../../../src/protos/firestore_proto_api';
-import { DEFAULT_PROJECT_ID } from '../util/helpers';
+import { DEFAULT_PROJECT_ID } from '../util/settings';
 import { getDefaultDatabaseInfo } from '../util/internal_helpers';
 
 /* eslint-disable no-restricted-globals */

packages/firestore/test/integration/util/helpers.ts

@@ -17,53 +17,14 @@
 
 import * as firestore from '@firebase/firestore-types';
 import firebase from './firebase_export';
+import {
+  ALT_PROJECT_ID,
+  DEFAULT_PROJECT_ID,
+  DEFAULT_SETTINGS
+} from './settings';
 
 /* eslint-disable no-restricted-globals */
 
-/**
- * NOTE: These helpers are used by api/ tests and therefore may not have any
- * dependencies on src/ files.
- */
-// __karma__ is an untyped global
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-declare const __karma__: any;
-
-// eslint-disable-next-line @typescript-eslint/no-require-imports
-const PROJECT_CONFIG = require('../../../../../config/project.json');
-
-const EMULATOR_PORT = process.env.FIRESTORE_EMULATOR_PORT;
-const EMULATOR_PROJECT_ID = process.env.FIRESTORE_EMULATOR_PROJECT_ID;
-export const USE_EMULATOR = !!EMULATOR_PORT;
-
-const EMULATOR_FIRESTORE_SETTING = {
-  host: `localhost:${EMULATOR_PORT}`,
-  ssl: false
-};
-
-const PROD_FIRESTORE_SETTING = {
-  host: 'firestore.googleapis.com',
-  ssl: true
-};
-
-export const DEFAULT_SETTINGS = getDefaultSettings();
-
-// eslint-disable-next-line no-console
-console.log(`Default Settings: ${JSON.stringify(DEFAULT_SETTINGS)}`);
-
-function getDefaultSettings(): firestore.Settings {
-  const karma = typeof __karma__ !== 'undefined' ? __karma__ : undefined;
-  if (karma && karma.config.firestoreSettings) {
-    return karma.config.firestoreSettings;
-  } else {
-    return USE_EMULATOR ? EMULATOR_FIRESTORE_SETTING : PROD_FIRESTORE_SETTING;
-  }
-}
-
-export const DEFAULT_PROJECT_ID = USE_EMULATOR
-  ? EMULATOR_PROJECT_ID
-  : PROJECT_CONFIG.projectId;
-export const ALT_PROJECT_ID = 'test-db2';
-
 function isIeOrEdge(): boolean {
   if (!window.navigator) {
     return false;

packages/firestore/test/integration/util/internal_helpers.ts

@@ -28,12 +28,9 @@ import {
 import { Firestore } from '../../../src/api/database';
 import { PlatformSupport } from '../../../src/platform/platform';
 import { AsyncQueue } from '../../../src/util/async_queue';
-import {
-  DEFAULT_PROJECT_ID,
-  DEFAULT_SETTINGS,
-  withTestDbsSettings
-} from './helpers';
+import { withTestDbsSettings } from './helpers';
 import { User } from '../../../src/auth/user';
+import { DEFAULT_PROJECT_ID, DEFAULT_SETTINGS } from './settings';
 
 /** Helper to retrieve the AsyncQueue for a give FirebaseFirestore instance. */
 export function asyncQueue(db: firestore.FirebaseFirestore): AsyncQueue {