test(firestore): add option tests

Author: posva

old_tests/vuefire/firestore/index.spec.ts

@@ -16,13 +16,13 @@ import {
 import { internalUnbind, _useFirestoreRef } from '.'
 import { ResetOption, UnbindWithReset } from '../shared'
 
-export type FirestoreOption = VueFirestoreObject | (() => VueFirestoreObject)
-
 export type VueFirestoreObject = Record<
   string,
-  DocumentReference | Query | CollectionReference
+  DocumentReference<unknown> | Query<unknown> | CollectionReference<unknown>
 >
 
+export type FirestoreOption = VueFirestoreObject | (() => VueFirestoreObject)
+
 // TODO: this should be an entry point to generate the corresponding .d.ts file that only gets included if the plugin is imported
 
 export const firestoreUnbinds = new WeakMap<
@@ -84,7 +84,10 @@ export const firestorePlugin = function firestorePlugin(
   GlobalTarget[bindName] = function firestoreBind(
     this: ComponentPublicInstance,
     key: string,
-    docOrCollectionRef: Query | CollectionReference | DocumentReference,
+    docOrCollectionRef:
+      | Query<unknown>
+      | CollectionReference<unknown>
+      | DocumentReference<unknown>,
     userOptions?: FirestoreRefOptions
   ) {
     const options = Object.assign({}, globalOptions, userOptions)
@@ -191,7 +194,7 @@ declare module '@vue/runtime-core' {
 
   export interface ComponentCustomOptions {
     /**
-     * Calls `$firestoreBind` at created
+     * Calls `$firestoreBind` before mounting the component
      */
     firestore?: FirestoreOption
   }

old_tests/vuefire/firestore/merging.spec.ts

@@ -1,7 +1,11 @@
 import { defineComponent } from 'vue'
 import { mount } from '@vue/test-utils'
 import { describe, expect, it, vi } from 'vitest'
-import { firestorePlugin, FirestorePluginOptions } from '../../src'
+import {
+  FirestoreOption,
+  firestorePlugin,
+  FirestorePluginOptions,
+} from '../../src'
 import { DocumentData } from 'firebase/firestore'
 import { setupFirestoreRefs } from '../utils'
 
@@ -94,4 +98,38 @@ describe('Firestore: Options API', () => {
       expect(wrapper.vm.itemList).toEqual([{ bar: 'bar' }])
     })
   })
+
+  describe('firestore option', () => {
+    function factory(
+      firestore: FirestoreOption,
+      pluginOptions?: FirestorePluginOptions
+    ) {
+      return mount(component, {
+        firestore,
+        global: {
+          plugins: [[firestorePlugin, pluginOptions]],
+        },
+      })
+    }
+
+    it('setups $firestoreRefs', async () => {
+      const itemSource = doc()
+      const itemListSource = collection()
+      const { vm } = factory({ item: itemSource, itemList: itemListSource })
+      expect(Object.keys(vm.$firestoreRefs).sort()).toEqual([
+        'item',
+        'itemList',
+      ])
+      expect(vm.$firestoreRefs.item.path).toBe(itemSource.path)
+      expect(vm.$firestoreRefs.itemList.path).toBe(itemListSource.path)
+    })
+
+    it('clears $firestoreRefs on unmount', async () => {
+      const itemSource = doc()
+      const itemListSource = collection()
+      const wrapper = factory({ item: itemSource, itemList: itemListSource })
+      wrapper.unmount()
+      expect(wrapper.vm.$firestoreRefs).toEqual(null)
+    })
+  })
 })