@cuboapp/crdt 1.0.27 → 1.0.28

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cuboapp/crdt",
-  "version": "1.0.27",
+  "version": "1.0.28",
   "description": "CRDT for CUBO",
   "main": "src/index.ts",
   "repository": {

package/src/client/index.ts

@@ -2,7 +2,7 @@ import { keyBy, pick, uuid } from '@cuboapp/utils'
 import { WsClientEvent } from '@cuboapp/ws'
 import { computed, reactive, shallowReactive } from 'vue'
 import { applyAwarenessUpdate, Awareness, encodeAwarenessUpdate, removeAwarenessStates } from 'y-protocols/awareness'
-import { applyUpdate, Doc } from 'yjs'
+import { applyUpdate, Doc, encodeStateAsUpdate, encodeStateVector } from 'yjs'
 
 import { CUBO_CRDT_EVENT } from '../constants'
 import { CuboCrdtServerDocumentIncomingAction } from '../server'
@@ -586,6 +586,81 @@ export class CuboCrdtClient<M> {
     }
   }
 
+  private sendDocumentUpdate(
+    entity: string,
+    entity_id: number,
+    document: CuboCrdtClientDoc,
+    update: Uint8Array,
+    origin?: CuboCrdtClientDocOrigin
+  ) {
+    const data: CuboCrdtServerDocumentIncomingAction = {
+      action: 'update',
+      entity,
+      entity_id,
+      data: Array.from(update),
+      origin: {
+        // по умолчанию 'other' — исходную подписку исключаем (её yjs-документ уже
+        // применил изменение локально). Без этого апдейты от TipTap/y-prosemirror
+        // приходят без expose и сервер эхом шлёт их обратно самому автору.
+        expose: 'other',
+        ...pick(origin || {}, ['store', 'keys', 'expose']),
+        subscribe_id: origin?.subscribe_id ?? document.subscribes.values().next().value
+      }
+    }
+
+    void this.ws
+      .request({
+        method: CUBO_CRDT_EVENT.EVENT,
+        data
+      })
+      .catch((error) => console.error('[CRDT] update request failed', error))
+  }
+
+  /**
+   * Сверка локального документа с состоянием, присланным сервером при повторной подписке
+   * (реконнект). Сервер мог за это время пересобрать документ из БД — он выселяет Y.Doc, как
+   * только уходит последний подписчик, а обрыв связи это и есть уход. Пересобранный документ
+   * ничего не знает о структурах этого клиента, и у обычного CRDT-merge два последствия:
+   *
+   * 1. При конкурентных set одного ключа строки Yjs выбирает победителя по clientID, а не по
+   *    времени — локальная (устаревшая) копия могла «победить» строку, сохранённую в БД
+   *    другим окном. Так в карточке задачи после реконнекта описание откатывалось к версии
+   *    этого окна.
+   * 2. Следующие локальные правки ссылаются на структуры, которых у сервера нет, — Yjs
+   *    откладывает их в pending навсегда, и всё набранное после реконнекта молча пропадало.
+   *
+   * Поэтому строка сервера считается истиной: отличающиеся ключи переставляем явно (это
+   * причинно позже обеих версий, значит побеждает везде), а серверу досылаем одним апдейтом
+   * всё, чего у него нет, — вместе с этой переустановкой, чтобы значение строки на сервере
+   * не мигало через устаревшую версию. Без флага store такой апдейт ничего не пишет в БД:
+   * значения и так серверные. Локальные правки, набранные во время обрыва, тоже уезжают в
+   * этом апдейте.
+   */
+  private resyncWithServer(entity: string, entity_id: number, existing: CuboCrdtClientDoc, incoming: Uint8Array) {
+    const server = new Doc()
+    applyUpdate(server, incoming)
+
+    const serverRow: Record<string, unknown> = server.getMap().toJSON()
+    const map = existing.doc.getMap()
+
+    // react: false — наружу не шлём по одному, всё уедет ниже одним диффом
+    existing.doc.transact(() => {
+      for (const [key, value] of Object.entries(serverRow)) {
+        if (JSON.stringify(map.get(key)) !== JSON.stringify(value)) {
+          map.set(key, value)
+        }
+      }
+    }, { react: false })
+
+    // пустой апдейт кодируется двумя байтами
+    const missing = encodeStateAsUpdate(existing.doc, encodeStateVector(server))
+    if (missing.length > 2) {
+      this.sendDocumentUpdate(entity, entity_id, existing, missing)
+    }
+
+    server.destroy()
+  }
+
   private async onDocumentCreate(ctx: CuboCrdtClientSubscribeEvent, opts: CuboCrdtClientDocUpdateOptions) {
     const entity_id = ctx.entity_id
     if (entity_id === undefined) {
@@ -602,7 +677,10 @@ export class CuboCrdtClient<M> {
       }
 
       this.attachDocument(ctx.entity, entity_id, existing, opts)
-      applyUpdate(existing.doc, new Uint8Array(ctx.data as any), { react: false })
+
+      const incoming = new Uint8Array(ctx.data as any)
+      applyUpdate(existing.doc, incoming, { react: false })
+      this.resyncWithServer(ctx.entity, entity_id, existing, incoming)
       this.applyRowJson(opts.storeKey, entity_id, existing.doc)
       return
     }
@@ -636,27 +714,7 @@ export class CuboCrdtClient<M> {
 
       // react = false, если это апдейт с бэка
       if (origin?.react !== false) {
-        const data: CuboCrdtServerDocumentIncomingAction = {
-          action: 'update',
-          entity: ctx.entity,
-          entity_id,
-          data: Array.from(update),
-          origin: {
-            // по умолчанию 'other' — исходную подписку исключаем (её yjs-документ уже
-            // применил изменение локально). Без этого апдейты от TipTap/y-prosemirror
-            // приходят без expose и сервер эхом шлёт их обратно самому автору.
-            expose: 'other',
-            ...pick(origin || {}, ['store', 'keys', 'expose']),
-            subscribe_id: origin?.subscribe_id ?? document.subscribes.values().next().value
-          }
-        }
-
-        void this.ws
-          .request({
-            method: CUBO_CRDT_EVENT.EVENT,
-            data
-          })
-          .catch((error) => console.error('[CRDT] update request failed', error))
+        this.sendDocumentUpdate(ctx.entity, entity_id, document, update, origin)
       }
     })