Add count method (#121)

Co-authored By: Michel Parpaillon <[email protected]>

Author: kossnocorp

Diff for: .editorconfig

@@ -1,4 +1,5 @@
 root = true
 
 [*]
+indent_size = 2
 end_of_line = lf

Diff for: .vscode/extensions.json

@@ -0,0 +1,5 @@
+{
+    "recommendations": [
+        "esbenp.prettier-vscode"
+    ]
+}

Diff for: .vscode/settings.json

@@ -20,5 +20,6 @@
     "titleBar.inactiveForeground": "#e7e7e799",
     "commandCenter.border": "#e7e7e799"
   },
-  "peacock.remoteColor": "#136881"
+  "peacock.remoteColor": "#136881",
+  "editor.formatOnSave": true,
 }

Diff for: package-lock.json

@@ -50,7 +50,7 @@
     "@types/webpack-env": "^1.18.0",
     "babel-loader": "^8.2.5",
     "babel-plugin-add-import-extension": "^1.6.0",
-    "firebase": "^9.7.0",
+    "firebase": "^9.22.1",
     "firebase-admin": "^11.5.0",
     "firebase-tools": "^11.23.1",
     "jest": "^28.1.3",

Diff for: package.json

@@ -186,6 +186,11 @@ export class Collection {
     })
   }
 
+  async count() {
+    const snap = await this.adapter().collection().count().get()
+    return snap.data().count
+  }
+
   adapter() {
     return {
       collection: () => this.firebaseCollection(),
@@ -542,7 +547,7 @@ export function query(adapter, queries) {
       firestoreQuery = firestoreQuery[method](...values)
     })
 
-  return new SubscriptionPromise({
+  const sp = new SubscriptionPromise({
     request: request({
       kind: 'query',
       ...adapter.request(),
@@ -606,6 +611,15 @@ export function query(adapter, queries) {
         onResult(docs, meta)
       }, onError)
   })
+
+  Object.assign(sp, {
+    count: async () => {
+      const snap = await firestoreQuery.count().get()
+      return snap.data().count
+    }
+  })
+
+  return sp
 }
 
 export function queryHelpers(mode = 'helpers', acc) {

Diff for: src/adapter/admin/core.mjs

@@ -36,6 +36,11 @@ class Group {
     return all(this.adapter())
   }
 
+  async count() {
+    const snap = await this.adapter().collection().count().get()
+    return snap.data().count
+  }
+
   adapter() {
     return {
       collection: () => this.firebaseCollection(),

Diff for: src/adapter/admin/groups.mjs

@@ -1,4 +1,6 @@
 import {
+  DocumentReference,
+  Timestamp,
   addDoc,
   arrayRemove,
   arrayUnion,
@@ -7,9 +9,9 @@ import {
   deleteField,
   doc,
   documentId,
-  DocumentReference,
   endAt,
   endBefore,
+  getCountFromServer,
   getDoc,
   getDocs,
   getFirestore,
@@ -22,7 +24,6 @@ import {
   setDoc,
   startAfter,
   startAt,
-  Timestamp,
   updateDoc,
   where
 } from 'firebase/firestore'
@@ -199,6 +200,11 @@ export class Collection {
     })
   }
 
+  async count() {
+    const snap = await getCountFromServer(this.firebaseCollection())
+    return snap.data().count
+  }
+
   adapter() {
     return {
       db: () => this.firebaseDB,
@@ -574,7 +580,7 @@ export function _query(adapter, queries) {
   const firebaseQuery = () =>
     query(adapter.collection(), ...firebaseQueries, ...firebaseCursors)
 
-  return new SubscriptionPromise({
+  const sp = new SubscriptionPromise({
     request: request({
       kind: 'query',
       ...adapter.request(),
@@ -651,6 +657,15 @@ export function _query(adapter, queries) {
       )
     }
   })
+
+  Object.assign(sp, {
+    count: async () => {
+      const snap = await getCountFromServer(firebaseQuery())
+      return snap.data().count
+    }
+  })
+
+  return sp
 }
 
 export function queryHelpers(mode = 'helpers', acc) {

Diff for: src/adapter/web/core.mjs

@@ -1,5 +1,9 @@
-import { collectionGroup, getFirestore } from 'firebase/firestore'
-import { all, pathToDoc, _query, queryHelpers, wrapData } from './core.mjs'
+import {
+  collectionGroup,
+  getCountFromServer,
+  getFirestore
+} from 'firebase/firestore'
+import { _query, all, pathToDoc, queryHelpers, wrapData } from './core.mjs'
 
 export const groups = (rootDB) => {
   const groups = {}
@@ -37,6 +41,11 @@ class Group {
     return all(this.adapter())
   }
 
+  async count() {
+    const snap = await getCountFromServer(this.firebaseCollection())
+    return snap.data().count
+  }
+
   adapter() {
     return {
       db: () => this.firebaseDB,

Diff for: src/adapter/web/groups.mjs

@@ -888,6 +888,11 @@ async function tysts() {
   await groups(db4).shposts.all()
   // @ts-expect-error
   await groups(db4).shmosts.all()
+
+  // Count
+
+  const commentsCount = await groups(db2).comments.count()
+  commentsCount.toFixed()
 }
 
 type Assert<Type1, _Type2 extends Type1> = true

Diff for: src/groups/tysts.ts

@@ -0,0 +1,70 @@
+import { groups, schema } from '..'
+
+describe('count', () => {
+  interface Novel {
+    title: string
+  }
+
+  interface Manga {
+    title: string
+    volume: number
+  }
+
+  const db = schema(($) => ({
+    novels: $.collection<Novel>().sub({
+      feedbacks: $.collection<any>()
+    }),
+    mangas: $.collection<Manga>().sub({
+      feedbacks: $.collection<any>()
+    })
+  }))
+
+  beforeEach(async () => {
+    await Promise.all([
+      db.novels.set(db.novels.id('sapiens'), {
+        title: 'Sapiens'
+      }),
+      db.novels.set(db.novels.id('22laws'), {
+        title: 'The 22 Immutable Laws of Marketing'
+      }),
+      db.mangas.set(db.mangas.id('naruto-1'), {
+        title: 'Naruto',
+        volume: 1
+      }),
+      db.mangas.set(db.mangas.id('naruto-2'), {
+        title: 'Naruto',
+        volume: 2
+      })
+    ])
+
+    const sapiens = db.novels(db.novels.id('sapiens'))
+    const naruto1 = db.mangas(db.mangas.id('naruto-1'))
+    const naruto2 = db.mangas(db.mangas.id('naruto-2'))
+
+    await Promise.all([
+      sapiens.feedbacks.set(sapiens.feedbacks.id('1'), { text: 'Great novel' }),
+      naruto1.feedbacks.set(naruto1.feedbacks.id('2'), { text: 'Great manga' }),
+      naruto2.feedbacks.set(naruto2.feedbacks.id('3'), { text: 'Great manga' }),
+      naruto2.feedbacks.set(naruto2.feedbacks.id('4'), {
+        text: 'Average. First one was better'
+      })
+    ])
+  })
+
+  it('counts documents in a collection', async () => {
+    const count = await db.novels.count()
+    expect(count).toBe(2)
+  })
+
+  it('counts documents in a query', async () => {
+    const count = await db.mangas
+      .query(($) => $.field('volume').equal(2))
+      .count()
+    expect(count).toBe(1)
+  })
+
+  it('counts documents in a group collection', async () => {
+    const count = await groups(db).feedbacks.count()
+    expect(count).toBe(4)
+  })
+})

Diff for: src/tests/count.ts

@@ -906,6 +906,8 @@ export namespace TypesaurusCore {
     >
 
     query: Query.Function<Def>
+
+    count(): Promise<number>
   }
 
   /**

Diff for: src/types/core.d.ts

@@ -19,11 +19,7 @@ export namespace TypesaurusQuery {
           // it's impossible towrap the query into a check because the check
           // will be invalid inside the function.
           undefined
-        : Core.SubscriptionPromise<
-            Core.QueryRequest,
-            Core.Doc<Def, Props>[],
-            Core.SubscriptionListMeta<Def, Props>
-          >
+        : SubscriptionPromise<Def, Environment, Props>
       : never
 
     build<
@@ -34,6 +30,18 @@ export namespace TypesaurusQuery {
     ): Builder<Def, Props>
   }
 
+  export interface SubscriptionPromise<
+    Def extends Core.DocDef,
+    Environment extends Core.RuntimeEnvironment,
+    Props extends Core.DocProps & { environment: Environment }
+  > extends Core.SubscriptionPromise<
+      Core.QueryRequest,
+      Core.Doc<Def, Props>[],
+      Core.SubscriptionListMeta<Def, Props>
+    > {
+    count(): Promise<number>
+  }
+
   export type Data<Model extends Core.ModelType> =
     | Query<Model>
     | Array<Query<Model> | Utils.Falsy>

Diff for: src/types/query.d.ts

@@ -272,6 +272,23 @@ async function doc() {
   if (content) db.content.doc(contentId, content.data)
 }
 
+async function collection() {
+  // Count
+
+  const docsCount = await db.users.count()
+  docsCount.toFixed()
+
+  const nestedDB = schema(($) => ({
+    users: $.collection<User>().sub({
+      settings: $.collection<{}>()
+    })
+  }))
+  const nestedDocsCount = await nestedDB
+    .users(nestedDB.users.id('whatever'))
+    .settings.count()
+  nestedDocsCount.toFixed()
+}
+
 async function get() {
   const user = await db.users.get(db.users.id('sasha'))
   if (!user) return
@@ -768,6 +785,14 @@ async function query() {
     '',
     0
   ])
+
+  // Count
+
+  const sashasCount = await db.users
+    .query(($) => $.field('name').equal('Sasha'))
+    .count()
+
+  sashasCount.toFixed()
 }
 
 async function add() {