Merge 85cd5bf into 5f51ab5

Author: schmidt-sebastian

.changeset/thin-hornets-admire.md

@@ -0,0 +1,2 @@
+---
+---

packages/firestore/exp/index.node.ts

@@ -59,6 +59,10 @@ export { setLogLevel } from '../src/util/log';
 
 export { Blob } from '../src/api/blob';
 
+export { writeBatch } from './src/api/write_batch';
+
+export { WriteBatch } from '../lite/src/api/write_batch';
+
 export { GeoPoint } from '../src/api/geo_point';
 
 export { Timestamp } from '../src/api/timestamp';

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

@@ -0,0 +1,35 @@
+/**
+ * @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 { cast } from '../../../lite/src/api/util';
+import { WriteBatch } from '../../../lite/src/api/write_batch';
+import { Firestore } from './database';
+
+export function writeBatch(
+  firestore: firestore.FirebaseFirestore
+): firestore.WriteBatch {
+  const firestoreImpl = cast(firestore, Firestore);
+  return new WriteBatch(firestoreImpl, writes =>
+    firestoreImpl
+      ._getFirestoreClient()
+      .then(firestoreClient => firestoreClient.write(writes))
+  );
+}

packages/firestore/exp/test/integration.test.ts

@@ -54,6 +54,7 @@ import {
   updateDoc
 } from '../../lite/src/api/reference';
 import { QuerySnapshot } from '../src/api/snapshot';
+import { writeBatch } from '../src/api/write_batch';
 
 use(chaiAsPromised);
 
@@ -173,6 +174,69 @@ genericMutationTests({
   delete: deleteDoc
 });
 
+describe('WriteBatch', () => {
+  class WriteBatchTester implements MutationTester {
+    delete(ref: firestore.DocumentReference<unknown>): Promise<void> {
+      const batch = writeBatch(ref.firestore);
+      batch.delete(ref);
+      return batch.commit();
+    }
+
+    set<T>(
+      ref: firestore.DocumentReference<T>,
+      data: T | Partial<T>,
+      options?: firestore.SetOptions
+    ): Promise<void> {
+      const batch = writeBatch(ref.firestore);
+      // TODO(mrschmidt): Find a way to remove the `any` cast here
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
+      (batch.set as any).apply(batch, Array.from(arguments));
+      return batch.commit();
+    }
+
+    update(
+      ref: firestore.DocumentReference<unknown>,
+      dataOrField: firestore.UpdateData | string | firestore.FieldPath,
+      value?: unknown,
+      ...moreFieldsAndValues: unknown[]
+    ): Promise<void> {
+      const batch = writeBatch(ref.firestore);
+      // TODO(mrschmidt): Find a way to remove the `any` cast here
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
+      (batch.update as any).apply(batch, Array.from(arguments));
+      return batch.commit();
+    }
+  }
+
+  genericMutationTests(new WriteBatchTester());
+
+  it('can add multiple operations', () => {
+    return withTestCollection(async coll => {
+      const batch = writeBatch(coll.firestore);
+      batch.set(doc(coll), { doc: 1 });
+      batch.set(doc(coll), { doc: 2 });
+      await batch.commit();
+
+      // TODO(firestorelite): Verify collection contents once getQuery is added
+    });
+  });
+
+  it('cannot add write after commit', () => {
+    return withTestDoc(async doc => {
+      const batch = writeBatch(doc.firestore);
+      batch.set(doc, { doc: 1 });
+      const op = batch.commit();
+      expect(() => batch.delete(doc)).to.throw(
+        'A write batch can no longer be used after commit() has been called.'
+      );
+      await op;
+      expect(() => batch.delete(doc)).to.throw(
+        'A write batch can no longer be used after commit() has been called.'
+      );
+    });
+  });
+});
+
 function genericMutationTests(
   op: MutationTester,
   validationUsesPromises: boolean = false

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

@@ -41,7 +41,10 @@ export class WriteBatch implements firestore.WriteBatch {
   private _mutations = [] as Mutation[];
   private _committed = false;
 
-  constructor(private readonly _firestore: Firestore) {
+  constructor(
+    private readonly _firestore: Firestore,
+    private readonly _commitHandler: (m: Mutation[]) => Promise<void>
+  ) {
     this._dataReader = newUserDataReader(_firestore);
   }
 
@@ -133,9 +136,7 @@ export class WriteBatch implements firestore.WriteBatch {
     this.verifyNotCommitted();
     this._committed = true;
     if (this._mutations.length > 0) {
-      return this._firestore
-        ._getDatastore()
-        .then(datastore => invokeCommitRpc(datastore, this._mutations));
+      return this._commitHandler(this._mutations);
     }
 
     return Promise.resolve();
@@ -169,5 +170,10 @@ export function validateReference<T>(
 export function writeBatch(
   firestore: firestore.FirebaseFirestore
 ): firestore.WriteBatch {
-  return new WriteBatch(cast(firestore, Firestore));
+  const firestoreImpl = cast(firestore, Firestore);
+  return new WriteBatch(firestoreImpl, writes =>
+    firestoreImpl
+      ._getDatastore()
+      .then(datastore => invokeCommitRpc(datastore, writes))
+  );
 }