chore: PR changes

Author: Bobby

src/reducers/cacheReducer.js

@@ -403,46 +403,15 @@ const nestedMap = (obj, key, val) => {
   return obj;
 };
 
-/**
- * Mutate ArrayUnion
- * @param {string} key - mutate tuple key
- * @param {*} val - mutate tuple value
- * @param {Function} cached - function that returns in-memory cached instance
- * @returns Null | Array<*>
- */
-function arrayUnion(key, val, cached) {
-  if (key !== '::arrayUnion') return null;
-  return (cached() || []).concat([val]);
-}
+const arrayUnion = (key, val, cached) =>
+  key !== '::arrayUnion' ? null : (cached() || []).concat([val]);
 
-/**
- * Mutate arrayRemove
- * @param {string} key - mutate tuple key
- * @param {*} val - mutate tuple value
- * @param {Function} cached - function that returns in-memory cached instance
- * @returns Null | Array<*>
- */
-function arrayRemove(key, val, cached) {
-  return (
-    key === '::arrayRemove' && (cached() || []).filter((item) => item !== val)
-  );
-}
+const arrayRemove = (key, val, cached) =>
+  key === '::arrayRemove' && (cached() || []).filter((item) => item !== val);
 
-/**
- * Mutate increment
- * @param {string} key - mutate tuple key
- * @param {*} val - mutate tuple value
- * @param {Function} cached - function that returns in-memory cached instance
- * @returns Null | number
- */
 const increment = (key, val, cached) =>
   key === '::increment' && typeof val === 'number' && (cached() || 0) + val;
 
-/**
- * Mutate timestamp
- * @param {*} key
- * @returns
- */
 const serverTimestamp = (key) => key === '::serverTimestamp' && new Date();
 
 /**

src/reducers/listenersReducer.js

@@ -8,8 +8,8 @@ import { combineReducers } from '../utils/reducers';
  * @param {object} [state={}] - Current listenersById redux state
  * @param {object} action - Object containing the action that was dispatched
  * @param {string} action.type - Type of action that was dispatched
- * @param action.path
- * @param action.payload
+ * @param {String} action.path - Path of action
+ * @param {object} action.payload - THe payload
  * @returns {object} listenersById state after reduction (used in listeners)
  * @private
  */
@@ -35,7 +35,7 @@ function listenersById(state = {}, { type, path, payload }) {
  * @param {object} [state=[]] - Current authError redux state
  * @param {object} action - Object containing the action that was dispatched
  * @param {string} action.type - Type of action that was dispatched
- * @param action.payload
+ * @param {object} action.payload - THe payload
  * @returns {object} allListeners state after reduction (used in listeners)
  * @private
  */
@@ -44,7 +44,7 @@ function allListeners(state = [], { type, payload }) {
     case actionTypes.SET_LISTENER:
       return [...state, payload.name];
     case actionTypes.UNSET_LISTENER:
-      return state.filter(name => name !== payload.name);
+      return state.filter((name) => name !== payload.name);
     default:
       return state;
   }

src/reducers/statusReducer.js

@@ -71,7 +71,7 @@ export function requestedReducer(state = {}, { type, meta }) {
  * @param {object} action - Object containing the action that was dispatched
  * @param {string} action.type - Type of action that was dispatched
  * @param {string} action.path - Path of action that was dispatched
- * @param action.meta
+ * @param {object} action.meta - Metadata for action
  * @returns {object} Profile state after reduction
  */
 export function timestampsReducer(state = {}, { type, meta }) {

src/utils/actions.js

@@ -35,46 +35,40 @@ export function wrapInDispatch(
     meta,
     payload: isObject(requestingType) ? requestingType.payload : { args },
   });
-  const success = (result) => {
-    const successIsObject = isObject(successType);
-    // Built action object handling function for custom payload
-    const actionObj = {
-      type: successIsObject ? successType.type : successType,
-      meta,
-      payload:
-        successIsObject && successType.payload
-          ? makePayload(successType, result)
-          : { args },
-    };
-    // Attach preserve to action if it is passed
-    if (successIsObject && successType.preserve) {
-      actionObj.preserve = successType.preserve;
-    }
-    // Attach merge to action if it is passed
-    if (successIsObject && successType.merge) {
-      actionObj.merge = successType.merge;
-    }
-    dispatch(actionObj);
-    return result;
-  };
-  const failure = (err) => {
-    dispatch({
-      type: errorType,
-      meta,
-      payload: err,
-    });
-    return Promise.reject(err);
-  };
 
-  if (method === 'mutate') {
-    return mutate(ref, ...args)
-      .then(success)
-      .catch(failure);
-  }
-
-  return ref[method](...args)
-    .then(success)
-    .catch(failure);
+  const actionPromise =
+    method === 'mutate' ? mutate(ref, ...args) : ref[method](...args);
+  return actionPromise
+    .then((result) => {
+      const successIsObject = isObject(successType);
+      // Built action object handling function for custom payload
+      const actionObj = {
+        type: successIsObject ? successType.type : successType,
+        meta,
+        payload:
+          successIsObject && successType.payload
+            ? makePayload(successType, result)
+            : { args },
+      };
+      // Attach preserve to action if it is passed
+      if (successIsObject && successType.preserve) {
+        actionObj.preserve = successType.preserve;
+      }
+      // Attach merge to action if it is passed
+      if (successIsObject && successType.merge) {
+        actionObj.merge = successType.merge;
+      }
+      dispatch(actionObj);
+      return result;
+    })
+    .catch((err) => {
+      dispatch({
+        type: errorType,
+        meta,
+        payload: err,
+      });
+      return Promise.reject(err);
+    });
 }
 
 /**

src/utils/mutate.js

@@ -1,4 +1,4 @@
-import { chunk, cloneDeep, flatten, isFunction, mapValues } from 'lodash';
+import { chunk, cloneDeep, flatten, mapValues } from 'lodash';
 import debug from 'debug';
 import { firestoreRef } from './query';
 import mark from './profiling';
@@ -12,7 +12,7 @@ const info = debug('rrf:mutate');
  * @returns Boolean
  */
 const docRef = (firestore, collection, doc) =>
-  firestore.collection(collection).doc(doc);
+  firestore.doc(`${collection}/${doc}`);
 
 /**
  * @param object
@@ -123,20 +123,20 @@ function atomize(firebase, operation) {
 function write(firebase, operation = {}, writer = null) {
   const { collection, path, doc, id, data, ...rest } = operation;
   const ref = docRef(firebase.firestore(), path || collection, id || doc);
-  const [changes, useUpdate = false] = atomize(firebase, data || rest);
+  const [changes, requiresUpdate = false] = atomize(firebase, data || rest);
 
   if (writer) {
     const writeType = writer.commit ? 'Batching' : 'Transaction.set';
     info(writeType, { id: ref.id, path: ref.parent.path, ...changes });
-    if (useUpdate) {
+    if (requiresUpdate) {
       writer.update(ref, changes);
     } else {
       writer.set(ref, changes, { merge: true });
     }
     return { id: ref.id, path: ref.parent.path, ...changes };
   }
   info('Writing', { id: ref.id, path: ref.parent.path, ...changes });
-  if (useUpdate) {
+  if (requiresUpdate) {
     return ref.update(changes);
   }
 
@@ -196,23 +196,19 @@ async function writeInTransaction(firebase, operations) {
     };
 
     const done = mark('mutate.writeInTransaction:reads');
-    const readsPromised = mapValues(operations.reads, (read) => {
+    const readsPromised = mapValues(operations.reads, async (read) => {
       if (isDocRead(read)) {
         const doc = firestoreRef(firebase, read);
-        return getter(doc)
-          .then((snapshot) => (snapshot.exsits === false ? null : snapshot))
-          .then(serialize);
+        const snapshot = await getter(doc);
+        return serialize(snapshot.exsits === false ? null : snapshot);
       }
 
-      // NOTE: Firestore Transaction don't support collection inside
+      // NOTE: Queries are not supported in Firestore Transactions (client-side)
       const coll = firestoreRef(firebase, read);
-      return coll
-        .get()
-        .then((snapshot) => {
-          if (snapshot.docs.length === 0) return Promise.resolve([]);
-          return Promise.all(snapshot.docs.map(getter));
-        })
-        .then((docs) => docs.map(serialize));
+      const snapshot = await coll.get();
+      if (snapshot.docs.length === 0) return [];
+      const unserializedDocs = await Promise.all(snapshot.docs.map(getter));
+      return unserializedDocs.map(serialize);
     });
 
     done();
@@ -222,7 +218,8 @@ async function writeInTransaction(firebase, operations) {
 
     operations.writes.forEach((writeFnc) => {
       const complete = mark('mutate.writeInTransaction:writes');
-      const operation = isFunction(writeFnc) ? writeFnc(reads) : writeFnc;
+      const operation =
+        typeof writeFnc === 'function' ? writeFnc(reads) : writeFnc;
 
       if (Array.isArray(operation)) {
         operation.map((op) => write(firebase, op, transaction));

src/utils/query.js

@@ -172,11 +172,9 @@ export function firestoreRef(firebase, meta) {
   const { globalDataConvertor } =
     (firebase && firebase._ && firebase._.config) || {};
 
-  if (path) ref = ref.collection(path);
-  if (collection) ref = ref.collection(collection);
+  if (path || collection) ref = ref.collection(path || collection);
   if (collectionGroup) ref = ref.collectionGroup(collectionGroup);
-  if (id) ref = ref.doc(id);
-  if (doc) ref = ref.doc(doc);
+  if (id || doc) ref = ref.doc(id || doc);
   ref = handleSubcollections(ref, subcollections);
   if (where) ref = addWhereToRef(ref, where);
   if (orderBy) ref = addOrderByToRef(ref, orderBy);

test/unit/actions/firestore.spec.js

@@ -909,7 +909,7 @@ describe('firestoreActions', () => {
           parent: { path: 'path' },
         }));
         const collection = sinon.spy(() => ({ doc }));
-        const firestore = sinon.spy(() => ({ collection }));
+        const firestore = sinon.spy(() => ({ collection, doc }));
 
         const instance = createFirestoreInstance(
           { firestore },

test/unit/utils/actions.spec.js

@@ -82,15 +82,14 @@ describe('actions utils', () => {
         parent: { path: 'path' },
       }));
       const collection = sinon.spy(() => ({ doc }));
-      const firestore = sinon.spy(() => ({ collection }));
+      const firestore = sinon.spy(() => ({ collection, doc }));
       wrapInDispatch(dispatchSpy, {
         ref: { firestore },
         types: ['mutate', 'mutate', 'mutate'],
         args: [{ collection: '/collection/path', doc: 'doc', data: { a: 1 } }],
         method: 'mutate',
       });
-      expect(collection).to.have.been.calledOnceWith('/collection/path');
-      expect(doc).to.have.been.calledOnceWith('doc');
+      expect(doc).to.have.been.calledOnceWith('/collection/path/doc');
       expect(set).to.have.been.calledOnceWith({ a: 1 });
     });
   });

test/unit/utils/mutate.spec.js

@@ -10,8 +10,7 @@ describe('firestore.mutate()', () => {
       id: 'id',
       parent: { path: 'path' },
     }));
-    const collection = sinon.spy(() => ({ doc }));
-    const firestore = sinon.spy(() => ({ collection }));
+    const firestore = sinon.spy(() => ({ doc }));
 
     await mutate(
       { firestore },
@@ -24,8 +23,7 @@ describe('firestore.mutate()', () => {
       },
     );
 
-    expect(collection.calledWith('orgs/tara-ai/teams'));
-    expect(doc.calledWith('team-bravo'));
+    expect(doc.calledWith('orgs/tara-ai/teams/team-bravo'));
     expect(set.calledWith({ name: 'Bravo Team 🎄' }, { merge: true }));
   });
 
@@ -37,10 +35,9 @@ describe('firestore.mutate()', () => {
       id: 'id',
       parent: { path: 'path' },
     }));
-    const collection = sinon.spy(() => ({ doc }));
 
     const batch = sinon.spy(() => ({ set, commit }));
-    const firestore = sinon.spy(() => ({ batch, collection }));
+    const firestore = sinon.spy(() => ({ batch, doc }));
 
     await mutate({ firestore }, [
       {
@@ -88,10 +85,9 @@ describe('firestore.mutate()', () => {
       id: 'id',
       parent: { path: 'path' },
     }));
-    const collection = sinon.spy(() => ({ doc }));
 
     const batch = sinon.spy(() => ({ set, commit }));
-    const firestore = sinon.spy(() => ({ batch, collection }));
+    const firestore = sinon.spy(() => ({ batch, doc }));
 
     const writes = Array.from(Array(501), (_el, index) => ({
       collection: 'orgs/tara-ai/teams',
@@ -288,7 +284,7 @@ describe('firestore.mutate()', () => {
       parent: { path: 'path' },
     }));
     const collection = sinon.spy(() => ({ doc }));
-    const firestore = sinon.spy(() => ({ collection }));
+    const firestore = sinon.spy(() => ({ collection, doc }));
     firestore.FieldValue = {
       serverTimestamp: sinon.spy(() => 'time'),
       increment: sinon.spy(() => '++'),