Add terminate() to Lite SDK (#3157)

Author: schmidt-sebastian

packages/firestore/lite/index.node.ts

@@ -25,7 +25,8 @@ import '../src/platform_node/node_init';
 export {
   Firestore,
   initializeFirestore,
-  getFirestore
+  getFirestore,
+  terminate
 } from './src/api/database';
 
 export {
@@ -42,6 +43,9 @@ export {
   addDoc
 } from './src/api/reference';
 
+// TOOD(firestorelite): Add tests when Queries are usable
+export { FieldPath, documentId } from './src/api/field_path';
+
 // TOOD(firestorelite): Add tests when setDoc() is available
 export {
   FieldValue,

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

@@ -28,9 +28,14 @@ import {
   CredentialsProvider,
   FirebaseCredentialsProvider
 } from '../../../src/api/credentials';
-import { Datastore, newDatastore } from '../../../src/remote/datastore';
+import {
+  Datastore,
+  newDatastore,
+  terminateDatastore
+} from '../../../src/remote/datastore';
 import { PlatformSupport } from '../../../src/platform/platform';
 import { Deferred } from '../../../src/util/promise';
+import { cast } from './util';
 
 // settings() defaults:
 const DEFAULT_HOST = 'firestore.googleapis.com';
@@ -137,3 +142,13 @@ export function initializeFirestore(
 export function getFirestore(app: FirebaseApp): Firestore {
   return _getProvider(app, 'firestore/lite').getImmediate() as Firestore;
 }
+
+export function terminate(
+  firestore: firestore.FirebaseFirestore
+): Promise<void> {
+  // TODO(firestorelite): Call _removeServiceInstance when available
+  const firestoreClient = cast(firestore, Firestore);
+  return firestoreClient
+    ._ensureClientConfigured()
+    .then(datastore => terminateDatastore(datastore));
+}

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

@@ -15,13 +15,15 @@
  * limitations under the License.
  */
 
-import { expect } from 'chai';
+import { expect, use } from 'chai';
+import * as chaiAsPromised from 'chai-as-promised';
 
 import { initializeApp } from '@firebase/app-exp';
 import {
   Firestore,
   getFirestore,
-  initializeFirestore
+  initializeFirestore,
+  terminate
 } from '../src/api/database';
 import {
   withTestCollection,
@@ -50,6 +52,8 @@ import {
 import { expectEqual, expectNotEqual } from '../../test/util/helpers';
 import { FieldValue } from '../../src/api/field_value';
 
+use(chaiAsPromised);
+
 describe('Firestore', () => {
   it('can provide setting', () => {
     const app = initializeApp(
@@ -82,6 +86,39 @@ describe('Firestore', () => {
       'Firestore has already been started and its settings can no longer be changed.'
     );
   });
+
+  it('cannot use once terminated', () => {
+    const app = initializeApp(
+      { apiKey: 'fake-api-key', projectId: 'test-project' },
+      'test-app-terminated'
+    );
+    const firestore = initializeFirestore(app, {
+      host: 'localhost',
+      ssl: false
+    });
+
+    // We don't await the Promise. Any operation enqueued after should be
+    // rejected.
+    // eslint-disable-next-line @typescript-eslint/no-floating-promises
+    terminate(firestore);
+
+    return expect(
+      getDoc(doc(firestore, 'coll/doc'))
+    ).to.be.eventually.rejectedWith('The client has already been terminated.');
+  });
+
+  it('can call terminate() multiple times', () => {
+    const app = initializeApp(
+      { apiKey: 'fake-api-key', projectId: 'test-project' },
+      'test-app-multi-terminate'
+    );
+    const firestore = initializeFirestore(app, {
+      host: 'localhost',
+      ssl: false
+    });
+
+    return terminate(firestore).then(() => terminate(firestore));
+  });
 });
 
 describe('doc', () => {

packages/firestore/src/remote/datastore.ts

@@ -49,6 +49,8 @@ export class Datastore {
  * consumption.
  */
 class DatastoreImpl extends Datastore {
+  terminated = false;
+
   constructor(
     public readonly connection: Connection,
     public readonly credentials: CredentialsProvider,
@@ -57,8 +59,18 @@ class DatastoreImpl extends Datastore {
     super();
   }
 
+  private verifyNotTerminated(): void {
+    if (this.terminated) {
+      throw new FirestoreError(
+        Code.FAILED_PRECONDITION,
+        'The client has already been terminated.'
+      );
+    }
+  }
+
   /** Gets an auth token and invokes the provided RPC. */
   invokeRPC<Req, Resp>(rpcName: string, request: Req): Promise<Resp> {
+    this.verifyNotTerminated();
     return this.credentials
       .getToken()
       .then(token => {
@@ -77,6 +89,7 @@ class DatastoreImpl extends Datastore {
     rpcName: string,
     request: Req
   ): Promise<Resp[]> {
+    this.verifyNotTerminated();
     return this.credentials
       .getToken()
       .then(token => {
@@ -199,3 +212,8 @@ export function newPersistentWatchStream(
     listener
   );
 }
+
+export function terminateDatastore(datastore: Datastore): void {
+  const datastoreImpl = debugCast(datastore, DatastoreImpl);
+  datastoreImpl.terminated = true;
+}