Add updateDoc() (#3148)

Author: schmidt-sebastian

packages/firestore/lite/index.d.ts

@@ -280,15 +280,16 @@ export function setDoc<T>(
   options: SetOptions
 ): Promise<void>;
 export function updateDoc(
-  reference: DocumentReference,
+  reference: DocumentReference<unknown>,
   data: UpdateData
 ): Promise<void>;
 export function updateDoc(
+  reference: DocumentReference<unknown>,
   field: string | FieldPath,
   value: any,
   ...moreFieldsAndValues: any[]
 ): Promise<void>;
-export function deleteDoc(reference: DocumentReference): Promise<void>;
+export function deleteDoc(reference: DocumentReference<unknown>): Promise<void>;
 
 export class FieldValue {
   private constructor();

packages/firestore/lite/index.node.ts

@@ -38,6 +38,7 @@ export {
   getDoc,
   deleteDoc,
   setDoc,
+  updateDoc,
   addDoc
 } from './src/api/reference';
 

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

@@ -22,10 +22,10 @@ import { DocumentKey } from '../../../src/model/document_key';
 import { Firestore } from './database';
 import {
   DocumentKeyReference,
+  ParsedUpdateData,
   UserDataReader
 } from '../../../src/api/user_data_reader';
 import { Query as InternalQuery } from '../../../src/core/query';
-import { FirebaseFirestore, FirestoreDataConverter } from '../../index';
 import { ResourcePath } from '../../../src/model/path';
 import { AutoId } from '../../../src/util/misc';
 import { DocumentSnapshot } from './snapshot';
@@ -38,6 +38,7 @@ import { DeleteMutation, Precondition } from '../../../src/model/mutation';
 import { PlatformSupport } from '../../../src/platform/platform';
 import { applyFirestoreDataConverter } from '../../../src/api/database';
 import { DatabaseId } from '../../../src/core/database_info';
+import { FieldPath } from './field_path';
 import { cast } from './util';
 import {
   validateArgType,
@@ -78,7 +79,7 @@ export class Query<T = firestore.DocumentData> implements firestore.Query<T> {
   constructor(
     readonly firestore: Firestore,
     readonly _query: InternalQuery,
-    readonly _converter?: FirestoreDataConverter<T>
+    readonly _converter?: firestore.FirestoreDataConverter<T>
   ) {}
 
   where(
@@ -173,11 +174,11 @@ export class CollectionReference<T = firestore.DocumentData> extends Query<T>
 }
 
 export function collection(
-  firestore: FirebaseFirestore,
+  firestore: firestore.FirebaseFirestore,
   collectionPath: string
 ): CollectionReference<firestore.DocumentData>;
 export function collection(
-  reference: DocumentReference,
+  reference: firestore.DocumentReference,
   collectionPath: string
 ): CollectionReference<firestore.DocumentData>;
 export function collection(
@@ -198,11 +199,11 @@ export function collection(
 }
 
 export function doc(
-  firestore: FirebaseFirestore,
+  firestore: firestore.FirebaseFirestore,
   documentPath: string
 ): DocumentReference<firestore.DocumentData>;
 export function doc<T>(
-  reference: CollectionReference<T>,
+  reference: firestore.CollectionReference<T>,
   documentPath?: string
 ): DocumentReference<T>;
 export function doc<T>(
@@ -277,6 +278,15 @@ export function getDoc<T>(
   });
 }
 
+export function setDoc<T>(
+  reference: firestore.DocumentReference<T>,
+  data: T
+): Promise<void>;
+export function setDoc<T>(
+  reference: firestore.DocumentReference<T>,
+  data: Partial<T>,
+  options: firestore.SetOptions
+): Promise<void>;
 export function setDoc<T>(
   reference: firestore.DocumentReference<T>,
   data: T,
@@ -307,6 +317,63 @@ export function setDoc<T>(
   );
 }
 
+export function updateDoc(
+  reference: firestore.DocumentReference,
+  data: firestore.UpdateData
+): Promise<void>;
+export function updateDoc(
+  reference: firestore.DocumentReference,
+  field: string | firestore.FieldPath,
+  value: unknown,
+  ...moreFieldsAndValues: unknown[]
+): Promise<void>;
+export function updateDoc(
+  reference: firestore.DocumentReference,
+  fieldOrUpdateData: string | firestore.FieldPath | firestore.UpdateData,
+  value?: unknown,
+  ...moreFieldsAndValues: unknown[]
+): Promise<void> {
+  const ref = cast(reference, DocumentReference);
+
+  // Kick off configuring the client, which freezes the settings.
+  const configureClient = ref.firestore._ensureClientConfigured();
+  const dataReader = newUserDataReader(
+    ref.firestore._databaseId,
+    ref.firestore._settings!
+  );
+
+  let parsed: ParsedUpdateData;
+  if (
+    typeof fieldOrUpdateData === 'string' ||
+    fieldOrUpdateData instanceof FieldPath
+  ) {
+    parsed = dataReader.parseUpdateVarargs(
+      'updateDoc',
+      fieldOrUpdateData,
+      value,
+      moreFieldsAndValues
+    );
+  } else {
+    parsed = dataReader.parseUpdateData('updateDoc', fieldOrUpdateData);
+  }
+
+  return configureClient.then(datastore =>
+    invokeCommitRpc(
+      datastore,
+      parsed.toMutations(ref._key, Precondition.none())
+    )
+  );
+
+  return ref.firestore
+    ._ensureClientConfigured()
+    .then(datastore =>
+      invokeCommitRpc(
+        datastore,
+        parsed.toMutations(ref._key, Precondition.exists(true))
+      )
+    );
+}
+
 export function deleteDoc(
   reference: firestore.DocumentReference
 ): Promise<void> {

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

@@ -39,7 +39,8 @@ import {
   getDoc,
   deleteDoc,
   setDoc,
-  addDoc
+  addDoc,
+  updateDoc
 } from '../src/api/reference';
 import { FieldPath } from '../src/api/field_path';
 import {
@@ -260,6 +261,32 @@ describe('setDoc()', () => {
   });
 });
 
+describe('update()', () => {
+  it('can update a document', () => {
+    return withTestDocAndInitialData({ foo: 1, bar: 1 }, async docRef => {
+      await updateDoc(docRef, { foo: 2, baz: 2 });
+      const docSnap = await getDoc(docRef);
+      expect(docSnap.data()).to.deep.equal({ foo: 2, bar: 1, baz: 2 });
+    });
+  });
+
+  it('can update a document (using varargs)', () => {
+    return withTestDocAndInitialData({ foo: 1, bar: 1 }, async docRef => {
+      await updateDoc(docRef, 'foo', 2, new FieldPath('baz'), 2);
+      const docSnap = await getDoc(docRef);
+      expect(docSnap.data()).to.deep.equal({ foo: 2, bar: 1, baz: 2 });
+    });
+  });
+
+  it('throws when user input fails validation', () => {
+    return withTestDoc(async docRef => {
+      expect(() => updateDoc(docRef, { val: undefined })).to.throw(
+        'Function updateDoc() called with invalid data. Unsupported field value: undefined (found in field val)'
+      );
+    });
+  });
+});
+
 describe('addDoc()', () => {
   it('can add a document', () => {
     return withTestCollection(async collRef => {