Add deleteDoc() (#3138)

Author: schmidt-sebastian

packages/firestore/lite/index.node.ts

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

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

@@ -26,8 +26,12 @@ 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 {
+  invokeBatchGetDocumentsRpc,
+  invokeCommitRpc
+} from '../../../src/remote/datastore';
 import { hardAssert } from '../../../src/util/assert';
+import { DeleteMutation, Precondition } from '../../../src/model/mutation';
 import { cast } from './util';
 import {
   validateArgType,
@@ -266,3 +270,16 @@ export function getDoc<T>(
     );
   });
 }
+
+export function deleteDoc(
+  reference: firestore.DocumentReference
+): Promise<void> {
+  const ref = cast(reference, DocumentReference);
+  return ref.firestore
+    ._ensureClientConfigured()
+    .then(datastore =>
+      invokeCommitRpc(datastore, [
+        new DeleteMutation(ref._key, Precondition.none())
+      ])
+    );
+}

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

@@ -30,7 +30,8 @@ import {
   CollectionReference,
   doc,
   DocumentReference,
-  getDoc
+  getDoc,
+  deleteDoc
 } from '../src/api/reference';
 import { expectEqual, expectNotEqual } from '../../test/util/helpers';
 import { FieldValue } from '../../src/api/field_value';
@@ -171,6 +172,13 @@ describe('getDoc()', () => {
   // TODO(firestorelite): Expand test coverage once we can write docs
 });
 
+describe('deleteDoc()', () => {
+  it('can delete a non-existing document', () => {
+    return withTestDoc(docRef => deleteDoc(docRef));
+  });
+});
+
+// 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/src/remote/datastore.ts

@@ -18,7 +18,7 @@
 import { CredentialsProvider } from '../api/credentials';
 import { MaybeDocument, Document } from '../model/document';
 import { DocumentKey } from '../model/document_key';
-import { Mutation, MutationResult } from '../model/mutation';
+import { Mutation } from '../model/mutation';
 import * as api from '../protos/firestore_proto_api';
 import { debugCast, hardAssert } from '../util/assert';
 import { Code, FirestoreError } from '../util/error';
@@ -106,20 +106,13 @@ export function newDatastore(
 export async function invokeCommitRpc(
   datastore: Datastore,
   mutations: Mutation[]
-): Promise<MutationResult[]> {
+): Promise<void> {
   const datastoreImpl = debugCast(datastore, DatastoreImpl);
   const params = {
     database: datastoreImpl.serializer.encodedDatabaseId,
     writes: mutations.map(m => datastoreImpl.serializer.toMutation(m))
   };
-  const response = await datastoreImpl.invokeRPC<
-    api.CommitRequest,
-    api.CommitResponse
-  >('Commit', params);
-  return datastoreImpl.serializer.fromWriteResults(
-    response.writeResults,
-    response.commitTime
-  );
+  await datastoreImpl.invokeRPC('Commit', params);
 }
 
 export async function invokeBatchGetDocumentsRpc(

packages/firestore/test/integration/remote/remote.test.ts

@@ -30,14 +30,9 @@ describe('Remote Storage', () => {
   addEqualityMatcher();
 
   it('can write', () => {
-    return withTestDatastore(async ds => {
+    return withTestDatastore(ds => {
       const mutation = setMutation('docs/1', { sort: 1 });
-      const result = await invokeCommitRpc(ds, [mutation]);
-      expect(result.length).to.equal(1);
-
-      const version = result[0].version;
-      expect(version).not.to.equal(null);
-      expect(SnapshotVersion.min().compareTo(version!)).to.be.lessThan(0);
+      return invokeCommitRpc(ds, [mutation]);
     });
   });