feat(refs): unbind refs in collections items when collection is unbound

Author: posva

src/index.js

@@ -67,9 +67,14 @@ function bindCollection ({
   const originalResolve = resolve
   let isResolved
 
+  // contain ref subscriptions of objects
+  // arraySubs is a mirror of array
+  const arraySubs = []
+
   const change = {
     added: ({ newIndex, doc }) => {
-      const subs = {}
+      arraySubs.splice(newIndex, 0, Object.create(null))
+      const subs = arraySubs[newIndex]
       const snapshot = createSnapshot(doc)
       const [data, refs] = extractRefs(snapshot)
       array.splice(newIndex, 0, data)
@@ -94,8 +99,7 @@ function bindCollection ({
     }
   }
 
-  // TODO return custom unbind function that unbinds nested refs
-  return collection.onSnapshot(({ docChanges }) => {
+  const unbind = collection.onSnapshot(({ docChanges }) => {
     // console.log('pending', metadata.hasPendingWrites)
     // docs.forEach(d => console.log('doc', d, '\n', 'data', d.data()))
     // NOTE this will only be triggered once and it will be with all the documents
@@ -128,6 +132,15 @@ function bindCollection ({
     // resolves when array is empty
     if (!docChanges.length) resolve()
   }, reject)
+
+  return () => {
+    unbind()
+    arraySubs.forEach(subs => {
+      for (const subKey in subs) {
+        subs[subKey].unbind()
+      }
+    })
+  }
 }
 
 function updateDataFromDocumentSnapshot ({ snapshot, target, key, subs, depth = 0, resolve }) {

test/refs-collections.spec.js

@@ -4,6 +4,7 @@ import {
   tick,
   delay,
   delayUpdate,
+  spyUnbind,
   Vue
 } from './helpers'
 
@@ -67,3 +68,23 @@ test('binds refs when adding to collection', async () => {
     { ref: { isC: true }}
   ])
 })
+
+test('unbinds refs when the collection is unbound', async () => {
+  const items = db.collection()
+  const spyA = spyUnbind(a)
+  const spyB = spyUnbind(b)
+  await items.add({ ref: a })
+  await items.add({ ref: b })
+  await vm.$bind('items', items)
+
+  expect(spyA).toHaveBeenCalledTimes(0)
+  expect(spyB).toHaveBeenCalledTimes(0)
+
+  vm.$unbind('items')
+
+  expect(spyA).toHaveBeenCalledTimes(1)
+  expect(spyB).toHaveBeenCalledTimes(1)
+
+  spyA.mockRestore()
+  spyB.mockRestore()
+})

test/refs-documents.spec.js

@@ -38,7 +38,6 @@ beforeEach(async () => {
     }
   })
   await tick()
-  // NOTE should add option for it waitForRefs: true (by default)
   // wait for refs to be ready as well
   await delay(5)
 })