Hide members

Author: schmidt-sebastian

packages/firestore/src/core/firestore_client.ts

@@ -23,7 +23,7 @@ import { Document, MaybeDocument, NoDocument } from '../model/document';
 import { DocumentKey } from '../model/document_key';
 import { Mutation } from '../model/mutation';
 import { Platform } from '../platform/platform';
-import { Datastore } from '../remote/datastore';
+import { createDatastore } from '../remote/datastore';
 import { RemoteStore } from '../remote/remote_store';
 import { AsyncQueue } from '../util/async_queue';
 import { Code, FirestoreError } from '../util/error';
@@ -238,7 +238,11 @@ export class FirestoreClient {
       const serializer = this.platform.newSerializer(
         this.databaseInfo.databaseId
       );
-      const datastore = new Datastore(connection, this.credentials, serializer);
+      const datastore = createDatastore(
+        connection,
+        this.credentials,
+        serializer
+      );
 
       await componentProvider.initialize({
         asyncQueue: this.asyncQueue,

packages/firestore/src/remote/datastore.ts

@@ -20,7 +20,7 @@ import { MaybeDocument } from '../model/document';
 import { DocumentKey } from '../model/document_key';
 import { Mutation, MutationResult } from '../model/mutation';
 import * as api from '../protos/firestore_proto_api';
-import { hardAssert } from '../util/assert';
+import { debugAssert, hardAssert } from '../util/assert';
 import { Code, FirestoreError } from '../util/error';
 import { Connection } from './connection';
 import { JsonProtoSerializer } from './serializer';
@@ -43,16 +43,24 @@ interface CommitRequest extends api.CommitRequest {
 }
 
 /**
- * Datastore is a wrapper around the external Google Cloud Datastore grpc API,
- * which provides an interface that is more convenient for the rest of the
- * client SDK architecture to consume.
+ * Datastore and its related methods are a wrapper around the external Google
+ * Cloud Datastore grpc API, which provides an interface that is more convenient
+ * for the rest of the client SDK architecture to consume.
  */
-export class Datastore {
+export class Datastore {}
+
+/**
+ * An implementation of Datastore that exposes additional state for internal
+ * consumption.
+ */
+class DatastoreImpl extends Datastore {
   constructor(
     public readonly connection: Connection,
     public readonly credentials: CredentialsProvider,
     public readonly serializer: JsonProtoSerializer
-  ) {}
+  ) {
+    super();
+  }
 
   /** Gets an auth token and invokes the provided RPC. */
   invokeRPC<Req, Resp>(rpcName: string, request: Req): Promise<Resp> {
@@ -92,10 +100,22 @@ export class Datastore {
   }
 }
 
+export function createDatastore(
+  connection: Connection,
+  credentials: CredentialsProvider,
+  serializer: JsonProtoSerializer
+): Datastore {
+  return new DatastoreImpl(connection, credentials, serializer);
+}
+
 export function invokeCommitRpc(
   datastore: Datastore,
   mutations: Mutation[]
 ): Promise<MutationResult[]> {
+  debugAssert(
+    datastore instanceof DatastoreImpl,
+    'invokeCommitRpc() requires DatastoreImpl'
+  );
   const params: CommitRequest = {
     database: datastore.serializer.encodedDatabaseId,
     writes: mutations.map(m => datastore.serializer.toMutation(m))
@@ -114,6 +134,10 @@ export function invokeBatchGetDocumentsRpc(
   datastore: Datastore,
   keys: DocumentKey[]
 ): Promise<MaybeDocument[]> {
+  debugAssert(
+    datastore instanceof DatastoreImpl,
+    'invokeBatchGetDocumentsRpc() requires DatastoreImpl'
+  );
   const params: BatchGetDocumentsRequest = {
     database: datastore.serializer.encodedDatabaseId,
     documents: keys.map(k => datastore.serializer.toName(k))
@@ -145,6 +169,10 @@ export function newPersistentWriteStream(
   queue: AsyncQueue,
   listener: WriteStreamListener
 ): PersistentWriteStream {
+  debugAssert(
+    datastore instanceof DatastoreImpl,
+    'newPersistentWriteStream() requires DatastoreImpl'
+  );
   return new PersistentWriteStream(
     queue,
     datastore.connection,
@@ -159,6 +187,10 @@ export function newPersistentWatchStream(
   queue: AsyncQueue,
   listener: WatchStreamListener
 ): PersistentListenStream {
+  debugAssert(
+    datastore instanceof DatastoreImpl,
+    'newPersistentWatchStream() requires DatastoreImpl'
+  );
   return new PersistentListenStream(
     queue,
     datastore.connection,

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

@@ -18,7 +18,7 @@
 import * as firestore from '@firebase/firestore-types';
 
 import { DatabaseId, DatabaseInfo } from '../../../src/core/database_info';
-import { Datastore } from '../../../src/remote/datastore';
+import { createDatastore, Datastore } from '../../../src/remote/datastore';
 
 import {
   CredentialChangeListener,
@@ -61,7 +61,7 @@ export function withTestDatastore(
       const serializer = PlatformSupport.getPlatform().newSerializer(
         databaseInfo.databaseId
       );
-      const datastore = new Datastore(conn, credentialsProvider, serializer);
+      const datastore = createDatastore(conn, credentialsProvider, serializer);
       return fn(datastore);
     });
 }

packages/firestore/test/unit/specs/spec_test_runner.ts

@@ -54,7 +54,7 @@ import { Mutation } from '../../../src/model/mutation';
 import { PlatformSupport } from '../../../src/platform/platform';
 import * as api from '../../../src/protos/firestore_proto_api';
 import { Connection, Stream } from '../../../src/remote/connection';
-import { Datastore } from '../../../src/remote/datastore';
+import { createDatastore, Datastore } from '../../../src/remote/datastore';
 import { ExistenceFilter } from '../../../src/remote/existence_filter';
 import { WriteRequest } from '../../../src/remote/persistent_stream';
 import { RemoteStore } from '../../../src/remote/remote_store';
@@ -470,7 +470,7 @@ abstract class TestRunner {
 
   async start(): Promise<void> {
     this.connection = new MockConnection(this.queue);
-    this.datastore = new Datastore(
+    this.datastore = createDatastore(
       this.connection,
       new EmptyCredentialsProvider(),
       this.serializer