Add addDoc() (#3141)

Author: schmidt-sebastian

packages/firestore/lite/index.d.ts

@@ -269,7 +269,7 @@ export function getQuery<T>(query: Query<T>): Promise<QuerySnapshot<T>>;
 export function addDoc<T>(
   reference: CollectionReference<T>,
   data: T
-): Promise<DocumentSnapshot<T>>;
+): Promise<DocumentReference<T>>;
 export function setDoc<T>(
   reference: DocumentReference<T>,
   data: T

packages/firestore/lite/index.node.ts

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

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

@@ -320,6 +320,37 @@ export function deleteDoc(
     );
 }
 
+export function addDoc<T>(
+  reference: firestore.CollectionReference<T>,
+  data: T
+): Promise<firestore.DocumentReference<T>> {
+  const collRef = cast(reference, CollectionReference);
+  const docRef = doc(collRef);
+
+  const [convertedValue] = applyFirestoreDataConverter(
+    collRef._converter,
+    data,
+    'addDoc'
+  );
+
+  // Kick off configuring the client, which freezes the settings.
+  const configureClient = collRef.firestore._ensureClientConfigured();
+  const dataReader = newUserDataReader(
+    collRef.firestore._databaseId,
+    collRef.firestore._settings!
+  );
+  const parsed = dataReader.parseSetData('addDoc', convertedValue);
+
+  return configureClient
+    .then(datastore =>
+      invokeCommitRpc(
+        datastore,
+        parsed.toMutations(docRef._key, Precondition.exists(false))
+      )
+    )
+    .then(() => docRef);
+}
+
 function newUserDataReader(
   databaseId: DatabaseId,
   settings: firestore.Settings

packages/firestore/lite/test/helpers.ts

@@ -25,6 +25,7 @@ import {
   DEFAULT_PROJECT_ID,
   DEFAULT_SETTINGS
 } from '../../test/integration/util/settings';
+import { AutoId } from '../../src/util/misc';
 
 let appCount = 0;
 
@@ -66,3 +67,11 @@ export function withTestDocAndInitialData(
     return fn(ref);
   });
 }
+
+export function withTestCollection(
+  fn: (doc: firestore.CollectionReference) => void | Promise<void>
+): Promise<void> {
+  return withTestDb(db => {
+    return fn(collection(db, AutoId.newId()));
+  });
+}

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

@@ -24,6 +24,7 @@ import {
   initializeFirestore
 } from '../src/api/database';
 import {
+  withTestCollection,
   withTestDb,
   withTestDbSettings,
   withTestDoc,
@@ -37,7 +38,8 @@ import {
   DocumentReference,
   getDoc,
   deleteDoc,
-  setDoc
+  setDoc,
+  addDoc
 } from '../src/api/reference';
 import { FieldPath } from '../src/api/field_path';
 import {
@@ -258,6 +260,24 @@ describe('setDoc()', () => {
   });
 });
 
+describe('addDoc()', () => {
+  it('can add a document', () => {
+    return withTestCollection(async collRef => {
+      const docRef = await addDoc(collRef, { val: 1 });
+      const docSnap = await getDoc(docRef);
+      expect(docSnap.data()).to.deep.equal({ val: 1 });
+    });
+  });
+
+  it('throws when user input fails validation', () => {
+    return withTestCollection(async collRef => {
+      expect(() => addDoc(collRef, { val: undefined })).to.throw(
+        'Function addDoc() called with invalid data. Unsupported field value: undefined (found in field val)'
+      );
+    });
+  });
+});
+
 describe('DocumentSnapshot', () => {
   it('can represent missing data', () => {
     return withTestDoc(async docRef => {
@@ -303,6 +323,7 @@ describe('DocumentSnapshot', () => {
   });
 });
 
+// TODO(firestorelite): Add converter tests
 describe('deleteDoc()', () => {
   it('can delete a non-existing document', () => {
     return withTestDoc(docRef => deleteDoc(docRef));