Implement cell-based sync + undo/redo

theatre-js · Oct 8, 2023 · 76d7b4c · 76d7b4c
1 parent 33df598
commit 76d7b4c
Show file tree

Hide file tree

Showing 47 changed files with 2,015 additions and 427 deletions.
diff --git a/packages/saaz/src/__snapshots__/rogue.test.ts.snap b/packages/saaz/src/__snapshots__/rogue.test.ts.snap
@@ -0,0 +1,172 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`Rogue merging defaults 1`] = `
+{
+  "a": {
+    "aStep": 1,
+    "bStep": 1,
+    "foo": "setBy1",
+    "obj": {
+      "objA": "true",
+      "objB": "true",
+    },
+  },
+}
+`;
+
+exports[`Rogue overriding an existing prop 1`] = `
+[
+  {
+    "branchName": "base",
+    "path": [
+      [
+        "base",
+        "a",
+      ],
+    ],
+    "type": "SetBoxedValue",
+    "value": 2,
+  },
+]
+`;
+
+exports[`Rogue setting a non-existing prop 1`] = `
+[
+  {
+    "$branches": {
+      "base": {
+        "$mapProps": {
+          "a": {
+            "$branches": {
+              "base": {
+                "$boxedValue": 1,
+              },
+            },
+            "$type": [
+              "boxed",
+              "base",
+            ],
+          },
+        },
+      },
+    },
+    "$type": [
+      "map",
+      "base",
+    ],
+  },
+  [
+    {
+      "path": [
+        [
+          "base",
+          "a",
+        ],
+      ],
+      "type": "ChangeType",
+      "value": [
+        "boxed",
+        "base",
+      ],
+    },
+    {
+      "branchName": "base",
+      "path": [
+        [
+          "base",
+          "a",
+        ],
+      ],
+      "type": "SetBoxedValue",
+      "value": 1,
+    },
+  ],
+]
+`;
+
+exports[`Rogue setting a non-existing prop to an object 1`] = `
+[
+  {
+    "$branches": {
+      "base": {
+        "$mapProps": {
+          "a": {
+            "$branches": {
+              "base": {
+                "$mapProps": {
+                  "b": {
+                    "$branches": {
+                      "base": {
+                        "$boxedValue": 1,
+                      },
+                    },
+                    "$type": [
+                      "boxed",
+                      "base",
+                    ],
+                  },
+                },
+              },
+            },
+            "$type": [
+              "map",
+              "base",
+            ],
+          },
+        },
+      },
+    },
+    "$type": [
+      "map",
+      "base",
+    ],
+  },
+  [
+    {
+      "path": [
+        [
+          "base",
+          "a",
+        ],
+      ],
+      "type": "ChangeType",
+      "value": [
+        "map",
+        "base",
+      ],
+    },
+    {
+      "path": [
+        [
+          "base",
+          "a",
+        ],
+        [
+          "base",
+          "b",
+        ],
+      ],
+      "type": "ChangeType",
+      "value": [
+        "boxed",
+        "base",
+      ],
+    },
+    {
+      "branchName": "base",
+      "path": [
+        [
+          "base",
+          "a",
+        ],
+        [
+          "base",
+          "b",
+        ],
+      ],
+      "type": "SetBoxedValue",
+      "value": 1,
+    },
+  ],
+]
+`;
diff --git a/packages/saaz/src/back/SaazBack.ts b/packages/saaz/src/back/SaazBack.ts
@@ -11,27 +11,28 @@ import type {
   PeerSubscribeCallback,
   AllPeersPresenceState,
   PeerPresenceState,
+  FullSnapshot,
 } from '../types'
 import {BackStorage} from './BackStorage'
 import type {DebouncedFunc} from 'lodash-es'
 import {cloneDeep, throttle} from 'lodash-es'
-import {ensureStateIsUptodate} from '../shared/utils'
+import {ensureStateIsUptodate as ensureOpStateIsUptodate} from '../shared/utils'
 import {Atom} from '@theatre/dataverse'
 import deepEqual from '@theatre/utils/deepEqual'
 
 export default class SaazBack implements SaazBackInterface {
   private _dbName: string
   private _storage: BackStorage
   private _readyDeferred = defer<void>()
-  private _dbState: {} = {}
+  private _dbState: FullSnapshot<$IntentionalAny> = {cell: {}, op: {}}
   private _clock: number | null = null
   private _peerStates: {
     [peerId in string]?: {
       lastIncorporatedPeerClock: number
     }
   } = {}
   private _subsribers: Array<PeerSubscribeCallback> = []
-  private _schema: Schema<$IntentionalAny>
+  private _schema: Schema<{$schemaVersion: number}>
   private _presenceState: Atom<AllPeersPresenceState> = new Atom({})
   private _schedulePresenseUpdate: DebouncedFunc<() => void>
 
@@ -113,7 +114,10 @@ export default class SaazBack implements SaazBackInterface {
       clock: this._clock ?? -1,
       lastIncorporatedPeerClock:
         this._peerStates[opts.peerId]?.lastIncorporatedPeerClock ?? null,
-      snapshot: {type: 'Snapshot', value: this._dbState},
+      snapshot: {
+        type: 'Snapshot',
+        value: this._dbState,
+      },
     }
   }
 
@@ -168,7 +172,7 @@ export default class SaazBack implements SaazBackInterface {
     const peerState = this._peerStates[opts.peerId]!
 
     const rebasing = opts.backendClock !== this._clock
-    let stateSoFar = ensureStateIsUptodate(this._dbState, this._schema)
+    let snapshotSoFar = ensureOpStateIsUptodate(this._dbState, this._schema)
     let lastAcknowledgedClock = peerState.lastIncorporatedPeerClock
     let backendClock = this._clock ?? -1
     const updatesToIncorporate = []
@@ -178,20 +182,20 @@ export default class SaazBack implements SaazBackInterface {
         continue
       }
 
-      const before = stateSoFar
-      const [after] = applyOptimisticUpdateToState(
+      const snapshotBefore = snapshotSoFar
+      const [opSnapshotAfter] = applyOptimisticUpdateToState(
         update,
-        before,
+        snapshotBefore,
         this._schema,
         true,
       )
-      stateSoFar = after
+      snapshotSoFar = opSnapshotAfter
       lastAcknowledgedClock = update.peerClock
       backendClock++
     }
 
     if (lastAcknowledgedClock !== peerState.lastIncorporatedPeerClock) {
-      this._dbState = stateSoFar
+      this._dbState = snapshotSoFar
       peerState.lastIncorporatedPeerClock = lastAcknowledgedClock
       this._clock = backendClock
       this._callSubscribersForBackendStateUpdate()