Add getDoc() to firestore-exp

.changeset/popular-beds-yell.md

@@ -0,0 +1,3 @@
+
+---
+---

.changeset/popular-beds-yell2.md

@@ -0,0 +1,3 @@
+
+---
+---

packages/firestore/.eslintrc.js

@@ -59,6 +59,13 @@ module.exports = {
       rules: {
         'import/no-extraneous-dependencies': 'off'
       }
+    },
+    // TODO(firestoreexp): Remove this exception when app-exp is published
+    {
+      files: ['exp/**/*.ts'],
+      rules: {
+        'import/no-extraneous-dependencies': 'off'
+      }
     }
   ]
 };

packages/firestore/exp/index.d.ts

@@ -488,6 +488,6 @@ export interface FirestoreError {
 
 declare module '@firebase/component' {
   interface NameServiceMapping {
-    'firestore/lite': FirebaseFirestore;
+    'firestore-exp': FirebaseFirestore;
   }
 }

packages/firestore/exp/index.node.ts

@@ -15,8 +15,37 @@
  * limitations under the License.
  */
 
+import { version } from '../package.json';
+import { _registerComponent, registerVersion } from '@firebase/app-exp';
+import { Component, ComponentType } from '@firebase/component';
+import { Firestore } from './src/api/database';
+
 export { FieldPath, documentId } from '../lite/src/api/field_path';
 
+export {
+  Firestore,
+  initializeFirestore,
+  getFirestore
+} from './src/api/database';
+
+export { DocumentSnapshot, QueryDocumentSnapshot } from './src/api/snapshot';
+
+export { SnapshotMetadata } from '../src/api/database';
+
+export {
+  DocumentReference,
+  CollectionReference,
+  Query,
+  doc,
+  collection,
+  collectionGroup,
+  parent
+} from '../lite/src/api/reference';
+
+export { runTransaction, Transaction } from '../lite/src/api/transaction';
+
+export { getDoc } from './src/api/reference';
+
 export {
   FieldValue,
   deleteField,
@@ -33,3 +62,24 @@ export { Blob } from '../src/api/blob';
 export { GeoPoint } from '../src/api/geo_point';
 
 export { Timestamp } from '../src/api/timestamp';
+
+export { refEqual, queryEqual } from '../lite/src/api/reference';
+
+export function registerFirestore(): void {
+  _registerComponent(
+    new Component(
+      'firestore-exp',
+      container => {
+        const app = container.getProvider('app-exp').getImmediate()!;
+        return ((app, auth) => new Firestore(app, auth))(
+          app,
+          container.getProvider('auth-internal')
+        );
+      },
+      ComponentType.PUBLIC
+    )
+  );
+  registerVersion('firestore-exp', version, 'node');
+}
+
+registerFirestore();

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

@@ -0,0 +1,108 @@
+/**
+ * @license
+ * Copyright 2020 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import * as firestore from '../../index';
+
+import { _getProvider } from '@firebase/app-exp';
+import { FirebaseApp, _FirebaseService } from '@firebase/app-types-exp';
+import { Provider } from '@firebase/component';
+
+import { FirebaseAuthInternalName } from '@firebase/auth-interop-types';
+import { FirestoreClient } from '../../../src/core/firestore_client';
+import { AsyncQueue } from '../../../src/util/async_queue';
+import {
+  ComponentProvider,
+  MemoryComponentProvider
+} from '../../../src/core/component_provider';
+
+import { Firestore as LiteFirestore } from '../../../lite/src/api/database';
+
+/**
+ * The root reference to the Firestore database and the entry point for the
+ * tree-shakeable SDK.
+ */
+export class Firestore extends LiteFirestore
+  implements firestore.FirebaseFirestore, _FirebaseService {
+  private readonly _queue = new AsyncQueue();
+  private readonly _persistenceKey: string;
+  private _componentProvider: ComponentProvider = new MemoryComponentProvider();
+
+  // Assigned via _getFirestoreClient()
+  private _firestoreClientPromise?: Promise<FirestoreClient>;
+
+  // We override the Settings property of the Lite SDK since the full Firestore
+  // SDK supports more settings.
+  protected _settings?: firestore.Settings;
+
+  constructor(
+    app: FirebaseApp,
+    authProvider: Provider<FirebaseAuthInternalName>
+  ) {
+    super(app, authProvider);
+    this._persistenceKey = app.name;
+  }
+
+  _getSettings(): firestore.Settings {
+    if (!this._settings) {
+      this._settings = {};
+    }
+    return this._settings;
+  }
+
+  _getFirestoreClient(): Promise<FirestoreClient> {
+    if (!this._firestoreClientPromise) {
+      const settings = this._getSettings();
+      const databaseInfo = this._makeDatabaseInfo(
+        settings.host,
+        settings.ssl,
+        settings.experimentalForceLongPolling
+      );
+
+      const firestoreClient = new FirestoreClient(
+        databaseInfo,
+        this._credentials,
+        this._queue
+      );
+
+      this._firestoreClientPromise = firestoreClient
+        .start(this._componentProvider, { durable: false })
+        .then(() => firestoreClient);
+    }
+
+    return this._firestoreClientPromise;
+  }
+
+  async delete(): Promise<void> {
+    // TODO(firestoreexp): Call terminate() once implemented
+  }
+}
+
+export function initializeFirestore(
+  app: FirebaseApp,
+  settings: firestore.Settings
+): Firestore {
+  const firestore = _getProvider(
+    app,
+    'firestore-exp'
+  ).getImmediate() as Firestore;
+  firestore._configureClient(settings);
+  return firestore;
+}
+
+export function getFirestore(app: FirebaseApp): Firestore {
+  return _getProvider(app, 'firestore-exp').getImmediate() as Firestore;
+}

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

@@ -0,0 +1,67 @@
+/**
+ * @license
+ * Copyright 2020 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+// See https://github.com/typescript-eslint/typescript-eslint/issues/363
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+import * as firestore from '../../index';
+
+import { Firestore } from './database';
+import { DocumentKeyReference } from '../../../src/api/user_data_reader';
+import { debugAssert } from '../../../src/util/assert';
+import { cast } from '../../../lite/src/api/util';
+import { DocumentSnapshot } from './snapshot';
+import {
+  getDocViaSnapshotListener,
+  SnapshotMetadata
+} from '../../../src/api/database';
+import { ViewSnapshot } from '../../../src/core/view_snapshot';
+import { DocumentReference } from '../../../lite/src/api/reference';
+
+export function getDoc<T>(
+  reference: firestore.DocumentReference<T>
+): Promise<firestore.DocumentSnapshot<T>> {
+  const ref = cast<DocumentReference<T>>(reference, DocumentReference);
+  const firestore = cast<Firestore>(ref.firestore, Firestore);
+  return firestore._getFirestoreClient().then(async firestoreClient => {
+    const viewSnapshot = await getDocViaSnapshotListener(firestoreClient, ref);
+    return convertToDocSnapshot(firestore, ref, viewSnapshot);
+  });
+}
+
+/**
+ * Converts a ViewSnapshot that contains the single document specified by `ref`
+ * to a DocumentSnapshot.
+ */
+function convertToDocSnapshot<T>(
+  firestore: Firestore,
+  ref: DocumentKeyReference<T>,
+  snapshot: ViewSnapshot
+): DocumentSnapshot<T> {
+  debugAssert(
+    snapshot.docs.size <= 1,
+    'Expected zero or a single result on a document-only query'
+  );
+  const doc = snapshot.docs.get(ref._key);
+
+  return new DocumentSnapshot(
+    firestore,
+    ref._key,
+    doc,
+    ref._converter,
+    new SnapshotMetadata(snapshot.hasPendingWrites, snapshot.fromCache)
+  );
+}

packages/firestore/exp/src/api/snapshot.ts

@@ -0,0 +1,111 @@
+/**
+ * @license
+ * Copyright 2020 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import * as firestore from '../../index';
+
+import { DocumentKey } from '../../../src/model/document_key';
+import { Document } from '../../../src/model/document';
+import {
+  ServerTimestampBehavior,
+  UserDataWriter
+} from '../../../src/api/user_data_writer';
+import {
+  fieldPathFromArgument,
+  DocumentSnapshot as LiteDocumentSnapshot
+} from '../../../lite/src/api/snapshot';
+import { Firestore } from './database';
+import { cast } from '../../../lite/src/api/util';
+import { DocumentReference } from '../../../lite/src/api/reference';
+import { SnapshotMetadata } from '../../../src/api/database';
+
+const DEFAULT_SERVER_TIMESTAMP_BEHAVIOR: ServerTimestampBehavior = 'none';
+
+export class DocumentSnapshot<T = firestore.DocumentData>
+  extends LiteDocumentSnapshot<T>
+  implements firestore.DocumentSnapshot<T> {
+  private readonly _firestoreImpl: Firestore;
+
+  constructor(
+    readonly _firestore: Firestore,
+    key: DocumentKey,
+    document: Document | null,
+    converter: firestore.FirestoreDataConverter<T> | null,
+    readonly metadata: firestore.SnapshotMetadata
+  ) {
+    super(_firestore, key, document, converter);
+    this._firestoreImpl = cast(_firestore, Firestore);
+  }
+
+  exists(): this is firestore.QueryDocumentSnapshot<T> {
+    return super.exists();
+  }
+
+  data(options: firestore.SnapshotOptions = {}): T | undefined {
+    if (!this._document) {
+      return undefined;
+    } else if (this._converter) {
+      // We only want to use the converter and create a new DocumentSnapshot
+      // if a converter has been provided.
+      const snapshot = new QueryDocumentSnapshot(
+        this._firestore,
+        this._key,
+        this._document,
+        /* converter= */ null,
+        this.metadata
+      );
+      return this._converter.fromFirestore(snapshot);
+    } else {
+      const userDataWriter = new UserDataWriter(
+        this._firestoreImpl._databaseId,
+        /* timestampsInSnapshots= */ true,
+        options.serverTimestamps || DEFAULT_SERVER_TIMESTAMP_BEHAVIOR,
+        key =>
+          new DocumentReference(this._firestore, key, /* converter= */ null)
+      );
+      return userDataWriter.convertValue(this._document.toProto()) as T;
+    }
+  }
+
+  get(
+    fieldPath: string | firestore.FieldPath,
+    options: firestore.SnapshotOptions = {}
+  ): unknown {
+    if (this._document) {
+      const value = this._document
+        .data()
+        .field(fieldPathFromArgument('DocumentSnapshot.get', fieldPath));
+      if (value !== null) {
+        const userDataWriter = new UserDataWriter(
+          this._firestoreImpl._databaseId,
+          /* timestampsInSnapshots= */ true,
+          options.serverTimestamps || DEFAULT_SERVER_TIMESTAMP_BEHAVIOR,
+          key => new DocumentReference(this._firestore, key, this._converter)
+        );
+        return userDataWriter.convertValue(value);
+      }
+    }
+    return undefined;
+  }
+}
+
+export class QueryDocumentSnapshot<T = firestore.DocumentData>
+  extends DocumentSnapshot<T>
+  implements firestore.QueryDocumentSnapshot<T> {
+  data(options: firestore.SnapshotOptions = {}): T {
+    return super.data(options) as T;
+  }
+}

packages/firestore/exp/test/deps/verify_dependencies.test.ts

@@ -20,15 +20,15 @@ import { expect } from 'chai';
 import { extractDependencies } from '../../../../../scripts/exp/extract-deps.helpers';
 
 import * as dependencies from './dependencies.json';
-import * as pkg from '../../../package.json';
+import * as pkg from '../../package.json';
 import { forEach } from '../../../src/util/obj';
 
 // TODO(firestorexp): Enable test
 // eslint-disable-next-line no-restricted-properties
 describe.skip('Dependencies', () => {
   forEach(dependencies, (api, { dependencies }) => {
     it(api, () => {
-      return extractDependencies(api, pkg.exp).then(extractedDependencies => {
+      return extractDependencies(api, pkg.main).then(extractedDependencies => {
         expect(extractedDependencies.classes).to.have.members(
           dependencies.classes,
           'for classes'