@cuboapp/crdt 1.0.14 → 1.0.16

package/src/server/types/document.ts

@@ -1,8 +1,17 @@
 import { CuboCrdtAction, CuboCrdtExposeStrategy } from '../../types'
 
+export type CuboCrdtServerDocumentStoreContext = {
+  previousRow: object
+  row: object
+}
+
 export type CuboCrdtServerDocumentOptions = {
   name: string
-  onStore?: (body: object, origin: CuboCrdtServerDocumentOrigin) => void
+  onStore?: (
+    body: object,
+    origin: CuboCrdtServerDocumentOrigin,
+    context: CuboCrdtServerDocumentStoreContext
+  ) => void | Promise<void>
   // onCreate?: (data: Uint8Array, origin?: CuboCrdtServerDocumentOrigin) => void
   onUpdate?: (data: Uint8Array, origin?: CuboCrdtServerDocumentOrigin) => void
   onAwarenessUpdate?: (data: Uint8Array, origin?: CuboCrdtServerDocumentOrigin) => void

package/src/server/types/index.ts

@@ -1,4 +1,5 @@
 import { WsServer, WsServerSocket } from '@cuboapp/ws'
+import { CuboCrdtListTotals, CuboCrdtMutation } from '../../types'
 import { CuboCrdtServerDocument } from '../document'
 import { CuboCrdtServerDocumentOrigin } from './document'
 import { CuboCrdtServerSubscribe } from './subscribe'
@@ -6,6 +7,11 @@ import { CuboCrdtServerSubscribe } from './subscribe'
 export * from './document'
 export * from './subscribe'
 
+export type CuboCrdtServerFetchResult<T> = {
+  rows: T[]
+  totals?: CuboCrdtListTotals
+}
+
 export type CuboCrdtServerOptions<M, A, E extends Extract<keyof M, string>> = {
   ws: WsServer
   entities: E[]
@@ -19,8 +25,19 @@ export type CuboCrdtServerOptions<M, A, E extends Extract<keyof M, string>> = {
     maxSize?: number
     debounce?: number
   }
-  fetchRows?: (client: WsServerSocket, subscribe: CuboCrdtServerSubscribe) => Promise<M[E][]>
+  pagination?: {
+    debounce?: number
+  }
+  fetchRows?: (
+    client: WsServerSocket,
+    subscribe: CuboCrdtServerSubscribe
+  ) => Promise<M[E][] | CuboCrdtServerFetchResult<M[E]>>
   checkRowIsSutable?: (baseState: boolean, ctx: { entity: E; subscribe: CuboCrdtServerSubscribe; row: any }) => boolean
+  shouldRefreshSubscribe?: (ctx: {
+    entity: E
+    subscribe: CuboCrdtServerSubscribe
+    mutation: CuboCrdtMutation<M[E]>
+  }) => boolean
   storeRow?: <K extends E>(
     entity: K,
     entity_id: number,
@@ -29,6 +46,8 @@ export type CuboCrdtServerOptions<M, A, E extends Extract<keyof M, string>> = {
       document: CuboCrdtServerDocument
       client: CuboCrdtSocketClient<A>
       origin: CuboCrdtServerDocumentOrigin
+      previousRow: M[K]
+      row: M[K]
     }
   ) => Promise<void> | void
 }

package/src/server/types/subscribe.ts

@@ -1,3 +1,5 @@
+import type { CuboCrdtListTotals } from '../../types'
+
 export type CuboCrdtServerUnsubscribeDto = {
   subscribe_id: string
 }
@@ -7,10 +9,21 @@ export type CuboCrdtServerSubscribeDto = {
   filters: {
     [K in 'id' | string]: any
   }
-  awareness: boolean
+  awareness?: boolean
+  paginated?: boolean
 }
 
 export type CuboCrdtServerSubscribe = {
   id: string
   client_id: string
-} & Pick<CuboCrdtServerSubscribeDto, 'entity' | 'filters' | 'awareness'>
+  row_ids: number[]
+  totals: CuboCrdtListTotals
+  revision: number
+} & Pick<CuboCrdtServerSubscribeDto, 'entity' | 'filters' | 'awareness' | 'paginated'>
+
+export type CuboCrdtSubscribeRefreshState = {
+  dirty: boolean
+  forceSync: boolean
+  timer?: ReturnType<typeof setTimeout>
+  running?: Promise<void>
+}

package/src/types/index.ts

@@ -1,5 +1,28 @@
 export type CuboCrdtKey<K, M> = K extends Extract<keyof M, string> ? M[K] : any
 
-export type CuboCrdtAction = 'create' | 'upsert' | 'update' | 'delete' | 'awareness'
+export type CuboCrdtAction = 'create' | 'upsert' | 'update' | 'delete' | 'awareness' | 'sync'
 
 export type CuboCrdtExposeStrategy = 'all' | 'other' | 'subscribe' | 'client'
+
+export type CuboCrdtListTotals = Record<string, number>
+
+export type CuboCrdtSubscriptionStatus =
+  | 'idle'
+  | 'loading'
+  | 'ready'
+  | 'error'
+
+export type CuboCrdtListSyncData = {
+  ids: number[]
+  totals: CuboCrdtListTotals
+  revision: number
+}
+
+export type CuboCrdtMutationAction = 'create' | 'update' | 'delete'
+
+export type CuboCrdtMutation<T = any> = {
+  action: CuboCrdtMutationAction
+  row: T
+  previousRow?: T
+  changedKeys?: string[]
+}

package/src/utils/index.ts

@@ -51,6 +51,18 @@ export function checkRowIsSutable(
       if (!['limit', 'with'].includes(key)) {
         if (customKeys?.[key]) {
           sutable = customKeys[key](key, row, filters)
+        } else if (row && typeof row === 'object' && !(key in row)) {
+          // Виртуальный фильтр: поля с таким именем у строки нет, значит на бэкенде он
+          // разворачивается в условие запроса (join/exists/диапазон) и по одной строке
+          // не проверяется в принципе — например membership пользователя в компании.
+          //
+          // Раньше такой ключ молча не совпадал, и строка считалась выпавшей из подписки.
+          // Для update это фатально: рассылка подменяет action на delete (см. server),
+          // поэтому подписчик получал удаление вместо обновления — строка исчезала из
+          // списка при любой правке, а фоновые обновления постепенно вычищали его целиком.
+          //
+          // Пропускаем такой ключ. Если фильтр всё же должен влиять на live-раскатку,
+          // его семантику описывают в options.checkRowIsSutable или в customKeys.
         } else {
           const [formula, str] = `${value}`.split(':')
 
@@ -100,3 +112,15 @@ export function checkSubscribeIsSutable(origin: CuboCrdtServerDocumentOrigin, su
 
   return noStrategyResolved || strategyOtherResolved || strategyClientResolved || strategySubscribeResolved
 }
+
+export function areCrdtListIdsEqual(left: number[], right: number[]) {
+  return left.length === right.length && left.every((id, index) => id === right[index])
+}
+
+export function areCrdtListTotalsEqual(
+  left: Record<string, number>,
+  right: Record<string, number>
+) {
+  const keys = new Set([...Object.keys(left), ...Object.keys(right)])
+  return Array.from(keys).every((key) => left[key] === right[key])
+}