test: wip options

Author: posva

tests/firestore/collection.spec.ts

@@ -1,13 +1,21 @@
 import { mount } from '@vue/test-utils'
 import { describe, expect, it } from 'vitest'
 import { useCollection } from '../../src'
-import { addDoc, collection, DocumentData } from 'firebase/firestore'
+import {
+  addDoc,
+  collection as originalCollection,
+  DocumentData,
+  orderBy,
+} from 'firebase/firestore'
 import { expectType, setupFirestoreRefs, tds, firestore } from '../utils'
 import { usePendingPromises } from '../../src/vuefire/firestore'
 import { type Ref } from 'vue'
 
 describe('Firestore collections', () => {
-  const { itemRef, listRef, orderedListRef } = setupFirestoreRefs()
+  const { collection, query } = setupFirestoreRefs()
+
+  const listRef = collection()
+  const orderedListRef = query(listRef, orderBy('name'))
 
   it('binds a collection as an array', async () => {
     const wrapper = mount(
@@ -39,6 +47,7 @@ describe('Firestore collections', () => {
 
   tds(() => {
     const db = firestore
+    const collection = originalCollection
     expectType<Ref<DocumentData[]>>(useCollection(collection(db, 'todos')))
     // @ts-expect-error
     expectType<Ref<number[]>>(useCollection(collection(db, 'todos')))
@@ -48,7 +57,7 @@ describe('Firestore collections', () => {
     expectType<Ref<string[]>>(useCollection<number>(collection(db, 'todos')))
 
     const refWithConverter = collection(db, 'todos').withConverter<number>({
-      toFirestore: data => ({ n: data }),
+      toFirestore: (data) => ({ n: data }),
       fromFirestore: (snap, options) => snap.data(options).n as number,
     })
     expectType<Ref<number[]>>(useCollection(refWithConverter))

old_tests/vuefire/firestore/options.spec.ts renamed to tests/firestore/options.spec.ts

@@ -1,12 +1,18 @@
-import { firestorePlugin } from '../../../src'
-import { db } from '../../src'
-import { mount } from '@vue/test-utils'
-import * as firestore from '@firebase/firestore-types'
 import { defineComponent } from 'vue'
+import { mount } from '@vue/test-utils'
+import { describe, expect, it, vi } from 'vitest'
+import { firestorePlugin, PluginOptions, useCollection } from '../../src'
+import { addDoc, DocumentData } from 'firebase/firestore'
+import { expectType, setupFirestoreRefs, tds, firestore } from '../utils'
+import { usePendingPromises } from '../../src/vuefire/firestore'
+import { type Ref } from 'vue'
 
 const component = defineComponent({ template: 'no' })
 
-describe('Firestore: plugin options', () => {
+describe.skip('Firestore: Options API', () => {
+  const { itemRef, listRef, orderedListRef, collection, doc } =
+    setupFirestoreRefs()
+
   it('allows customizing $rtdbBind', () => {
     const wrapper = mount(component, {
       global: {
@@ -21,13 +27,16 @@ describe('Firestore: plugin options', () => {
         ],
       },
     })
-    expect(typeof (wrapper.vm as any).$myBind).toBe('function')
-    expect(typeof (wrapper.vm as any).$myUnbind).toBe('function')
+
+    // @ts-expect-error: haven't extended the types
+    expect(wrapper.vm.$myBind).toBeTypeOf('function')
+    // @ts-expect-error: haven't extended the types
+    expect(wrapper.vm.$myUnbind).toBeTypeOf('function')
   })
 
   it('calls custom serialize function with collection', async () => {
-    const pluginOptions = {
-      serialize: jest.fn(() => ({ foo: 'bar' })),
+    const pluginOptions: PluginOptions = {
+      serialize: vi.fn(() => ({ foo: 'bar' })),
     }
     const wrapper = mount(
       {
@@ -41,8 +50,7 @@ describe('Firestore: plugin options', () => {
       }
     )
 
-    // @ts-ignore
-    const items: firestore.CollectionReference = db.collection()
+    const items = collection()
     await items.add({})
 
     await wrapper.vm.$bind('items', items)
@@ -57,7 +65,7 @@ describe('Firestore: plugin options', () => {
 
   it('can be overridden by local option', async () => {
     const pluginOptions = {
-      serialize: jest.fn(() => ({ foo: 'bar' })),
+      serialize: vi.fn(() => ({ foo: 'bar' })),
     }
     const wrapper = mount(
       {
@@ -75,7 +83,7 @@ describe('Firestore: plugin options', () => {
     const items: firestore.CollectionReference = db.collection()
     await items.add({})
 
-    const spy = jest.fn(() => ({ bar: 'bar' }))
+    const spy = vi.fn(() => ({ bar: 'bar' }))
 
     await wrapper.vm.$bind('items', items, { serialize: spy })
 

tests/utils.ts

@@ -18,6 +18,7 @@ import {
   getDocsFromServer,
   QueryDocumentSnapshot,
   deleteDoc,
+  DocumentReference,
 } from 'firebase/firestore'
 import { afterAll, beforeAll } from 'vitest'
 import { isCollectionRef, isDocumentRef } from '../src/shared'
@@ -45,15 +46,50 @@ export function setupFirestoreRefs() {
     // clean up the tests data
     await Promise.all([
       deleteDoc(itemRef),
+      ...[...docsToClean].map((doc) => deleteDoc(doc)),
+      deleteDoc(forItemsRef),
+      ...[...collectionsToClean].map((collection) =>
+        clearCollection(collection)
+      ),
       clearCollection(listRef),
       clearCollection(testsCollection),
     ])
   })
 
-  return { itemRef, listRef, orderedListRef, testId, col: forItemsRef }
+  // for automatically generated collections
+  let collectionId = 0
+  const collectionsToClean = new Set<CollectionReference<any>>()
+  function _collection(path?: string, ...pathSegments: string[]) {
+    path = path || `col_${collectionId++}`
+
+    const col = collection(forItemsRef, path, ...pathSegments)
+    collectionsToClean.add(col)
+    return col
+  }
+
+  // for automatically generated documents
+  let docId = 0
+  const docsToClean = new Set<DocumentReference<any>>()
+  function _doc(path?: string, ...pathSegments: string[]) {
+    path = path || `doc_${docId++}`
+    const d = doc(testsCollection, path, ...pathSegments)
+    docsToClean.add(d)
+    return d
+  }
+
+  return {
+    itemRef,
+    listRef,
+    orderedListRef,
+    testId,
+    col: forItemsRef,
+    collection: _collection,
+    doc: _doc,
+    query: firestoreQuery,
+  }
 }
 
-async function clearCollection(collection: CollectionReference) {
+async function clearCollection(collection: CollectionReference<any>) {
   const { docs } = await getDocsFromServer(collection)
   await Promise.all(
     docs.map((doc) => {
@@ -62,7 +98,7 @@ async function clearCollection(collection: CollectionReference) {
   )
 }
 
-async function recursiveDeleteDoc(doc: QueryDocumentSnapshot) {
+async function recursiveDeleteDoc(doc: QueryDocumentSnapshot<any>) {
   const docData = doc.data()
   const promises: Promise<any>[] = []
   if (docData) {