v0.4.3 (#87)

* fix(orderedReducer): subcollection updates correctly update document - #86
* feat(test): tests added to confirm changes fix sub collections updates - #86

Author: prescottprue

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "redux-firestore",
-  "version": "0.4.2",
+  "version": "0.4.3",
   "description": "Redux bindings for Firestore.",
   "main": "lib/index.js",
   "module": "es/index.js",

package.json

@@ -71,6 +71,31 @@ function writeCollection(collectionState, action) {
   if (merge.collection && size(collectionState)) {
     return unionBy(collectionState, action.payload.ordered, 'id');
   }
+
+  // Handle subcollections
+  if (meta.doc && meta.subcollections) {
+    if (!size(collectionState)) {
+      // Collection state does not already exist, create it with item containing
+      // subcollection
+      return [
+        {
+          id: meta.doc,
+          [meta.subcollections[0].collection]: action.payload.ordered,
+        },
+      ];
+    }
+    // Merge with existing document if collection state exists
+    return updateItemInArray(collectionState, meta.doc, item =>
+      mergeObjects(item, {
+        [meta.subcollections[0].collection]: action.payload.ordered,
+      }),
+    );
+  }
+  if (meta.doc && size(collectionState)) {
+    return updateItemInArray(collectionState, meta.doc, item =>
+      mergeObjects(item, action.payload.ordered[0]),
+    );
+  }
   return action.payload.ordered;
 }
 

src/reducers/orderedReducer.js

@@ -17,7 +17,7 @@ describe('orderedReducer', () => {
 
   describe('actionTypes', () => {
     describe('DOCUMENT_ADDED', () => {
-      it('throws for no collection', () => {
+      it('adds a document when collection is empty', () => {
         const collection = 'test1';
         const doc = 'test2';
         const someDoc = { id: doc };
@@ -34,6 +34,32 @@ describe('orderedReducer', () => {
         );
       });
     });
+
+    describe('DOCUMENT_REMOVED', () => {
+      it('removes document from collection', () => {
+        const collection = 'test1';
+        const doc = 'test2';
+        const someDoc = { id: doc };
+        const someDoc2 = { id: 'test3' };
+        const payload = {
+          ordered: { newIndex: 0, oldIndex: -1 },
+          data: someDoc,
+        };
+        const meta = { collection, doc };
+        action = { meta, payload, type: actionTypes.DOCUMENT_REMOVED };
+        const result = orderedReducer(
+          { [collection]: [someDoc, someDoc2] },
+          action,
+        );
+        // Confirm first item is
+        expect(result).to.have.nested.property(
+          `${collection}.0.id`,
+          someDoc2.id,
+        );
+        expect(result[collection]).to.have.length(1);
+      });
+    });
+
     describe('LISTENER_RESPONSE', () => {
       it('returns state if payload is not defined', () => {
         action = { meta: 'test', type: actionTypes.LISTENER_RESPONSE };
@@ -91,7 +117,7 @@ describe('orderedReducer', () => {
       });
 
       describe('doc', () => {
-        it.skip('adds a new doc within state', () => {
+        it('adds a new doc within state', () => {
           const orderedData = { id: 'doc' };
           action = {
             meta: { collection: 'testing', doc: 'doc' },
@@ -122,6 +148,98 @@ describe('orderedReducer', () => {
         });
       });
 
+      describe('subcollections', () => {
+        it('adds a new doc within state with subcollection', () => {
+          const orderedData = { id: 'subDoc' };
+          const subcollection = { collection: 'testing2' };
+          action = {
+            meta: {
+              collection: 'testing',
+              doc: 'doc',
+              subcollections: [subcollection],
+            },
+            type: actionTypes.LISTENER_RESPONSE,
+            payload: { ordered: [orderedData] },
+          };
+          state = {};
+          expect(orderedReducer(state, action)).to.have.nested.property(
+            `testing.0.${subcollection.collection}.0.id`,
+            orderedData.id,
+          );
+        });
+
+        it('adds subcollection to existing doc within state', () => {
+          const orderedData = { id: 'subDoc', someOther: 'thing' };
+          const subcollection = { collection: 'testing2' };
+          action = {
+            meta: {
+              collection: 'testing',
+              doc: 'doc',
+              subcollections: [subcollection],
+            },
+            merge: {}, // reset merge settings
+            type: actionTypes.LISTENER_RESPONSE,
+            payload: { ordered: [orderedData] },
+          };
+          state = { testing: [{ id: 'doc', another: 'thing' }] };
+          const result = orderedReducer(state, action);
+          // Adds subcollection to document
+          expect(result).to.have.nested.property(
+            `testing.0.${subcollection.collection}.0.id`,
+            orderedData.id,
+          );
+          // Preserves original value
+          expect(result).to.have.nested.property('testing.0.another', 'thing');
+        });
+
+        it('perserves existing collections on doc updates', () => {
+          const orderedData = { id: 'doc', someOther: 'thing' };
+          const original = [{ id: 'subDoc' }];
+          action = {
+            meta: {
+              collection: 'testing',
+              doc: 'doc',
+            },
+            merge: {}, // reset merge settings
+            type: actionTypes.LISTENER_RESPONSE,
+            payload: { ordered: [orderedData] },
+          };
+          state = { testing: [{ id: 'doc', original }] };
+          const result = orderedReducer(state, action);
+          // Updates parameter in document
+          expect(result).to.have.nested.property(
+            `testing.0.someOther`,
+            orderedData.someOther,
+          );
+          // Preserves documents in original subcollection
+          expect(result).to.have.nested.property(
+            'testing.0.original.0.id',
+            original[0].id,
+          );
+        });
+
+        it('updates the reference of subcollection docs on parent doc update', () => {
+          const orderedData = { id: 'doc', someOther: 'thing' };
+          const original = [{ id: 'subDoc' }];
+          action = {
+            meta: {
+              collection: 'testing',
+              doc: 'doc',
+            },
+            merge: {}, // reset merge settings
+            type: actionTypes.LISTENER_RESPONSE,
+            payload: { ordered: [orderedData] },
+          };
+          state = { testing: [{ id: 'doc', original }] };
+          const result = orderedReducer(state, action);
+          // Updates reference of documents in original subcollection
+          expect(result).to.not.have.nested.property(
+            'testing.0.original',
+            original,
+          );
+        });
+      });
+
       it('stores data under storeAs', () => {
         const orderedData = [{}];
         const storeAs = 'other';
@@ -173,15 +291,26 @@ describe('orderedReducer', () => {
       it('removes all data from state', () => {
         action = {
           type: actionTypes.CLEAR_DATA,
+          meta: { collection: 'testing' }, // meta is required to trigger ordered reducer
         };
         state = {};
         expect(orderedReducer(state, action)).to.be.empty;
+        expect(orderedReducer(state, action)).to.be.empty;
+      });
+
+      it('sets a new reference when clearing', () => {
+        action = {
+          type: actionTypes.CLEAR_DATA,
+          meta: { collection: 'testing' }, // meta is required to trigger ordered reducer
+        };
+        state = {};
+        expect(orderedReducer(state, action)).to.not.equal(state);
       });
 
       describe('preserve parameter', () => {
         it('array saves keys from state', () => {
           action = {
-            meta: 'test',
+            meta: { collection: 'testing' }, // meta is required to trigger ordered reducer
             type: actionTypes.CLEAR_DATA,
             payload: {},
             preserve: { ordered: ['some'] },
@@ -192,7 +321,7 @@ describe('orderedReducer', () => {
 
         it('function returns state to save', () => {
           action = {
-            meta: 'test',
+            meta: { collection: 'testing' }, // meta is required to trigger ordered reducer
             type: actionTypes.CLEAR_DATA,
             payload: {},
             preserve: { ordered: currentState => currentState },