feat(actions): add MULTIPLE_DOCUMENTS_ADDED event to group doc updates

src/constants.js

@@ -78,6 +78,7 @@ export const actionTypes = {
   DOCUMENT_ADDED: `${actionsPrefix}/DOCUMENT_ADDED`,
   DOCUMENT_MODIFIED: `${actionsPrefix}/DOCUMENT_MODIFIED`,
   DOCUMENT_REMOVED: `${actionsPrefix}/DOCUMENT_REMOVED`,
+  MULTIPLE_DOCUMENTS_ADDED: `${actionsPrefix}/MULTIPLE_DOCUMENTS_ADDED`,
   TRANSACTION_START: `${actionsPrefix}/TRANSACTION_START`,
   TRANSACTION_SUCCESS: `${actionsPrefix}/TRANSACTION_SUCCESS`,
   TRANSACTION_FAILURE: `${actionsPrefix}/TRANSACTION_FAILURE`,

src/reducers/crossSliceReducer.js

@@ -16,6 +16,7 @@ export default function crossSliceReducer(state = {}, action) {
       case actionTypes.DOCUMENT_MODIFIED:
       case actionTypes.DOCUMENT_ADDED:
       case actionTypes.DOCUMENT_REMOVED:
+      case actionTypes.MULTIPLE_DOCUMENTS_ADDED:
       case actionTypes.LISTENER_RESPONSE:
       case actionTypes.UNSET_LISTENER:
         // Take all of the query values and plop them into composite, replacing the existing data entirely

src/reducers/dataReducer.js

@@ -12,6 +12,7 @@ const {
   DOCUMENT_ADDED,
   DOCUMENT_MODIFIED,
   DOCUMENT_REMOVED,
+  MULTIPLE_DOCUMENTS_ADDED,
 } = actionTypes;
 
 /**
@@ -74,6 +75,13 @@ export default function dataReducer(state = {}, action) {
         action.payload.data,
         state,
       );
+    case MULTIPLE_DOCUMENTS_ADDED:
+      return action.payload.reduce((futureState, change) => setWith(
+        Object,
+        pathFromMeta(change.meta),
+        change.payload.data,
+        futureState
+      ), state)
     case DOCUMENT_REMOVED:
     case DELETE_SUCCESS:
       const removePath = pathFromMeta(action.meta);

src/reducers/orderedReducer.js

@@ -10,6 +10,7 @@ import {
 
 const {
   DOCUMENT_ADDED,
+  MULTIPLE_DOCUMENTS_ADDED,
   GET_SUCCESS,
   LISTENER_RESPONSE,
   CLEAR_DATA,
@@ -111,6 +112,18 @@ function addDoc(array = [], action) {
   return modifyDoc(array, action);
 }
 
+/**
+ * Case reducer for adding multiple documents to a collection or subcollection.
+ * @param {Array} [array=[]] - Redux state of current collection
+ * @param {object} action - The action that was dispatched
+ * @returns {Array} State with document modified
+ */
+function addMultipleDocs(array=[], action) {
+  const { payload } = action;
+
+  return payload.reduce((futureState, changeAction) => addDoc(futureState, changeAction), array)
+}
+
 /**
  * Case reducer for adding a document to a collection.
  * @param {Array} array - Redux state of current collection
@@ -240,6 +253,7 @@ const actionHandlers = {
   [DOCUMENT_ADDED]: addDoc,
   [DOCUMENT_MODIFIED]: modifyDoc,
   [DOCUMENT_REMOVED]: removeDoc,
+  [MULTIPLE_DOCUMENTS_ADDED]: addMultipleDocs,
   [DELETE_SUCCESS]: removeDoc,
   [LISTENER_RESPONSE]: writeCollection,
   [GET_SUCCESS]: writeCollection,

src/reducers/queriesReducer.js

@@ -45,6 +45,11 @@ export default function queriesReducer(state = {}, action) {
       case actionTypes.DOCUMENT_MODIFIED:
         set(draft, [key, 'data', action.meta.doc], action.payload.data);
         return draft;
+      case actionTypes.MULTIPLE_DOCUMENTS_ADDED:
+        action.payload.forEach(changeAction => {
+          set(draft, [key, 'data', changeAction.meta.doc], changeAction.payload.data);
+        })
+        return draft;
       case actionTypes.DOCUMENT_REMOVED:
       case actionTypes.DELETE_SUCCESS:
         unset(draft, [key, 'data', action.meta.doc]);

src/utils/query.js

@@ -9,6 +9,7 @@ import {
   get,
   set,
   cloneDeep,
+  partition
 } from 'lodash';
 import { actionTypes } from '../constants';
 
@@ -735,6 +736,43 @@ function docChangeEvent(change, originalMeta = {}) {
   };
 }
 
+/**
+ * Action creator for multiple document additions event. Used to create action objects
+ * to be passed to dispatch.
+ * @param {object} additions - Array of document addition objects from Firebase callback
+ * @param {object} [originalMeta={}] - Original meta data of action
+ * @returns {object} Resolves with docs change action object
+ */
+function docMultipleAdditionsEvent(additionObjects, originalMeta= {}) {
+  const additionsToMake = additionObjects.map(change => {
+    const meta = { ...cloneDeep(originalMeta),
+      path: change.doc.ref.path
+    };
+
+    if (originalMeta.subcollections && !originalMeta.storeAs) {
+      meta.subcollections[0] = { ...meta.subcollections[0],
+        doc: change.doc.id
+      };
+    } else {
+      meta.doc = change.doc.id;
+    }
+
+    return ({
+      meta,
+      payload: {
+        data: change.doc.data(),
+        ordered: { oldIndex: change.oldIndex, newIndex: change.newIndex },
+      },
+    })
+  })
+
+  return {
+    meta: originalMeta,
+    type: actionTypes.MULTIPLE_DOCUMENTS_ADDED,
+    payload: additionsToMake
+  };
+}
+
 /**
  * Dispatch action(s) response from listener response.
  * @private
@@ -761,9 +799,13 @@ export function dispatchListenerResponse({
       : docData.docChanges;
   // Dispatch different actions for doc changes (only update doc(s) by key)
   if (docChanges && docChanges.length < docData.size) {
-    // Loop to dispatch for each change if there are multiple
-    // TODO: Option for dispatching multiple changes in single action
-    docChanges.forEach(change => {
+    // Divide docChanges by types
+    const [docAdditions, otherDocChanges] = partition(docChanges, (change) => changeTypeToEventType[change.type] === actionTypes.DOCUMENT_ADDED)
+
+    dispatch(docMultipleAdditionsEvent(docAdditions, meta))
+
+    // Handle all other doc changes
+    otherDocChanges.forEach(change => {
       dispatch(docChangeEvent(change, meta));
     });
   } else {