@spooky-sync/core 0.0.1-canary.38 → 0.0.1-canary.381

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (266) hide show
  1. package/AGENTS.md +91 -0
  2. package/README.md +59 -16
  3. package/dist/index.d.ts +2238 -144
  4. package/dist/index.js +18149 -2475
  5. package/dist/live.d.ts +149 -0
  6. package/dist/live.js +739 -0
  7. package/dist/otel/index.d.ts +1 -1
  8. package/dist/pure.d.ts +401 -0
  9. package/dist/pure.js +24 -0
  10. package/dist/sqlite-open.js +392 -0
  11. package/dist/sqlite-worker.d.ts +1 -0
  12. package/dist/sqlite-worker.js +439 -0
  13. package/dist/sw.d.ts +207 -0
  14. package/dist/sw.js +393 -0
  15. package/dist/tabs-broker-worker.d.ts +8 -0
  16. package/dist/tabs-broker-worker.js +477 -0
  17. package/dist/types.d.ts +2082 -39
  18. package/dist/worker-edges.js +498 -0
  19. package/dist/worker-impersonation.js +60 -0
  20. package/dist/worker-ref-tables.d.ts +48 -0
  21. package/dist/worker-types.d.ts +112 -0
  22. package/dist/worker-types.js +73 -0
  23. package/package.json +28 -7
  24. package/scripts/check-broker-bundle.mjs +33 -0
  25. package/scripts/check-worker-entries.mjs +173 -0
  26. package/skills/sp00ky-core/SKILL.md +42 -8
  27. package/skills/sp00ky-core/references/config.md +8 -2
  28. package/src/boot/auth-flip.saga.test.ts +174 -0
  29. package/src/boot/auth-flip.saga.ts +77 -0
  30. package/src/boot/boot.saga.test.ts +203 -0
  31. package/src/boot/boot.saga.ts +146 -0
  32. package/src/boot/bucket-switch.saga.test.ts +191 -0
  33. package/src/boot/bucket-switch.saga.ts +151 -0
  34. package/src/boot/preload.saga.test.ts +96 -0
  35. package/src/boot/preload.saga.ts +45 -0
  36. package/src/bucket-blurhash.test.ts +148 -0
  37. package/src/build-globals.d.ts +12 -0
  38. package/src/client/bucket-handle.test.ts +195 -0
  39. package/src/client/bucket-handle.ts +352 -0
  40. package/src/client/router.test.ts +59 -0
  41. package/src/client/router.ts +104 -0
  42. package/src/client/runtime.test.ts +319 -0
  43. package/src/client/runtime.ts +307 -0
  44. package/src/client/services.test.ts +74 -0
  45. package/src/client/services.ts +437 -0
  46. package/src/client/sp00ky-client.test.ts +428 -0
  47. package/src/client/sp00ky-client.ts +737 -0
  48. package/src/events/index.ts +3 -0
  49. package/src/index.ts +86 -1
  50. package/src/kernel/constants.test.ts +19 -0
  51. package/src/kernel/constants.ts +94 -0
  52. package/src/kernel/effects.test.ts +40 -0
  53. package/src/kernel/effects.ts +171 -0
  54. package/src/kernel/events.ts +60 -0
  55. package/src/kernel/interpreter.test.ts +116 -0
  56. package/src/kernel/interpreter.ts +148 -0
  57. package/src/kernel/saga.test.ts +89 -0
  58. package/src/kernel/saga.ts +73 -0
  59. package/src/live/index.test.ts +512 -0
  60. package/src/live/index.ts +1059 -0
  61. package/src/modules/app-release/index.test.ts +125 -0
  62. package/src/modules/app-release/index.ts +209 -0
  63. package/src/modules/auth/auth.local-first.test.ts +228 -0
  64. package/src/modules/auth/auth.session-recheck.test.ts +140 -0
  65. package/src/modules/auth/events/index.ts +7 -1
  66. package/src/modules/auth/impersonation-banner.ts +443 -0
  67. package/src/modules/auth/impersonation.integration.test.ts +209 -0
  68. package/src/modules/auth/impersonation.test.ts +377 -0
  69. package/src/modules/auth/impersonation.ts +179 -0
  70. package/src/modules/auth/index.ts +538 -14
  71. package/src/modules/channel/channel.test.ts +752 -0
  72. package/src/modules/channel/index.ts +1153 -0
  73. package/src/modules/channel/webrtc.ts +472 -0
  74. package/src/modules/crdt/acceptance.ts +75 -0
  75. package/src/modules/crdt/bytes.ts +50 -0
  76. package/src/modules/crdt/crdt-field.ts +125 -0
  77. package/src/modules/crdt/crdt.test.ts +546 -0
  78. package/src/modules/crdt/hash.ts +103 -0
  79. package/src/modules/crdt/index.ts +821 -0
  80. package/src/modules/crdt/loro-loader.ts +25 -0
  81. package/src/modules/crdt/mirror.ts +37 -0
  82. package/src/modules/devtools/flags.ts +349 -0
  83. package/src/modules/devtools/index.ts +746 -93
  84. package/src/modules/devtools/mutations.test.ts +92 -0
  85. package/src/modules/devtools/mutations.ts +160 -0
  86. package/src/modules/devtools/notify-throttle.test.ts +166 -0
  87. package/src/modules/devtools/state-shape.test.ts +263 -0
  88. package/src/modules/devtools/storage-info.test.ts +79 -0
  89. package/src/modules/devtools/storage-info.ts +168 -0
  90. package/src/modules/devtools/versions.test.ts +74 -0
  91. package/src/modules/devtools/versions.ts +110 -0
  92. package/src/modules/feature-flag/index.test.ts +298 -0
  93. package/src/modules/feature-flag/index.ts +316 -0
  94. package/src/modules/ref-tables.test.ts +93 -0
  95. package/src/modules/ref-tables.ts +91 -0
  96. package/src/modules/web-push/index.test.ts +824 -0
  97. package/src/modules/web-push/index.ts +1027 -0
  98. package/src/mutation/ingest-outage.integration.test.ts +400 -0
  99. package/src/mutation/jobs.test.ts +25 -0
  100. package/src/mutation/jobs.ts +41 -0
  101. package/src/mutation/mutation-id.test.ts +37 -0
  102. package/src/mutation/mutation-id.ts +35 -0
  103. package/src/mutation/pending-writes.integration.test.ts +175 -0
  104. package/src/mutation/push.saga.test.ts +361 -0
  105. package/src/mutation/push.saga.ts +245 -0
  106. package/src/mutation/rows.test.ts +278 -0
  107. package/src/mutation/rows.ts +515 -0
  108. package/src/mutation/tray.saga.test.ts +63 -0
  109. package/src/mutation/tray.saga.ts +48 -0
  110. package/src/mutation/write.saga.test.ts +436 -0
  111. package/src/mutation/write.saga.ts +384 -0
  112. package/src/pure.ts +66 -0
  113. package/src/push/types.ts +174 -0
  114. package/src/query/anon-query-isolation.integration.test.ts +531 -0
  115. package/src/query/env.test.ts +23 -0
  116. package/src/query/env.ts +65 -0
  117. package/src/query/fetch.saga.test.ts +199 -0
  118. package/src/query/fetch.saga.ts +120 -0
  119. package/src/query/hash.test.ts +14 -0
  120. package/src/query/hash.ts +18 -0
  121. package/src/query/id-set-plan.test.ts +132 -0
  122. package/src/query/lifecycle.saga.test.ts +274 -0
  123. package/src/query/lifecycle.saga.ts +186 -0
  124. package/src/query/list-ref-live.integration.test.ts +203 -0
  125. package/src/query/materialize.saga.test.ts +200 -0
  126. package/src/query/materialize.saga.ts +102 -0
  127. package/src/query/materialize.test.ts +58 -0
  128. package/src/query/materialize.ts +57 -0
  129. package/src/query/membership.saga.test.ts +514 -0
  130. package/src/query/membership.saga.ts +339 -0
  131. package/src/query/membership.test.ts +151 -0
  132. package/src/query/membership.ts +234 -0
  133. package/src/query/register.saga.test.ts +369 -0
  134. package/src/query/register.saga.ts +293 -0
  135. package/src/query/render-set.test.ts +47 -0
  136. package/src/query/render-set.ts +71 -0
  137. package/src/query/session-guard.integration.test.ts +304 -0
  138. package/src/query/sql.test.ts +118 -0
  139. package/src/query/sql.ts +174 -0
  140. package/src/query/window-query.test.ts +70 -0
  141. package/src/query/window-query.ts +208 -0
  142. package/src/services/blobs/blob-cache.test.ts +359 -0
  143. package/src/services/blobs/blob-cache.ts +603 -0
  144. package/src/services/blobs/blob-manifest.ts +227 -0
  145. package/src/services/blobs/blob-store.test.ts +77 -0
  146. package/src/services/blobs/blob-store.ts +359 -0
  147. package/src/services/blobs/blob.fixture.ts +90 -0
  148. package/src/services/blobs/index.ts +70 -0
  149. package/src/services/database/cache-engine.ts +209 -0
  150. package/src/services/database/connection-supervisor.test.ts +318 -0
  151. package/src/services/database/connection-supervisor.ts +422 -0
  152. package/src/services/database/database.query-timeout.test.ts +140 -0
  153. package/src/services/database/database.responses.test.ts +43 -0
  154. package/src/services/database/database.ts +151 -56
  155. package/src/services/database/engine-factory.ts +33 -0
  156. package/src/services/database/errors.ts +34 -0
  157. package/src/services/database/index.ts +7 -0
  158. package/src/services/database/landed-body-clear.integration.test.ts +236 -0
  159. package/src/services/database/local-migrator.integration.test.ts +110 -0
  160. package/src/services/database/local-migrator.ts +54 -9
  161. package/src/services/database/local.test.ts +150 -0
  162. package/src/services/database/local.ts +503 -59
  163. package/src/services/database/plan-render.test.ts +159 -0
  164. package/src/services/database/plan-render.ts +108 -0
  165. package/src/services/database/relation-resolver.test.ts +484 -0
  166. package/src/services/database/relation-resolver.ts +0 -0
  167. package/src/services/database/remote.ts +283 -4
  168. package/src/services/database/sqlite-cache-engine.test.ts +628 -0
  169. package/src/services/database/sqlite-cache-engine.timeout.test.ts +61 -0
  170. package/src/services/database/sqlite-cache-engine.ts +1401 -0
  171. package/src/services/database/sqlite-column-reset.integration.test.ts +100 -0
  172. package/src/services/database/sqlite-column-reset.ts +91 -0
  173. package/src/services/database/sqlite-devtools-queries.integration.test.ts +143 -0
  174. package/src/services/database/sqlite-devtools-queries.test.ts +154 -0
  175. package/src/services/database/sqlite-lock-verify.test.ts +33 -0
  176. package/src/services/database/sqlite-lock-verify.ts +45 -0
  177. package/src/services/database/sqlite-open.test.ts +150 -0
  178. package/src/services/database/sqlite-open.ts +164 -0
  179. package/src/services/database/sqlite-plan-sql.test.ts +164 -0
  180. package/src/services/database/sqlite-plan-sql.ts +196 -0
  181. package/src/services/database/sqlite-projection.test.ts +121 -0
  182. package/src/services/database/sqlite-select.integration.test.ts +185 -0
  183. package/src/services/database/sqlite-select.test.ts +261 -0
  184. package/src/services/database/sqlite-select.ts +131 -0
  185. package/src/services/database/sqlite-transport.fixture.ts +30 -0
  186. package/src/services/database/sqlite-transport.ts +224 -0
  187. package/src/services/database/sqlite-worker.ts +437 -0
  188. package/src/services/database/surql-translate.ts +417 -0
  189. package/src/services/database/surreal-cache-engine.ts +163 -0
  190. package/src/services/logger/index.test.ts +132 -0
  191. package/src/services/logger/index.ts +187 -6
  192. package/src/services/persistence/resilient.ts +8 -1
  193. package/src/services/persistence/surrealdb.ts +2 -2
  194. package/src/services/stream-processor/index.ts +801 -63
  195. package/src/services/stream-processor/permissions.test.ts +47 -0
  196. package/src/services/stream-processor/permissions.ts +53 -0
  197. package/src/services/stream-processor/stream-processor.batch.test.ts +186 -0
  198. package/src/services/stream-processor/stream-processor.prime.test.ts +234 -0
  199. package/src/services/stream-processor/stream-processor.reset.test.ts +226 -0
  200. package/src/services/stream-processor/wasm-types.ts +57 -1
  201. package/src/services/tabs/broker-client.ts +284 -0
  202. package/src/services/tabs/broker.test.ts +381 -0
  203. package/src/services/tabs/coordinator.test.ts +386 -0
  204. package/src/services/tabs/coordinator.ts +646 -0
  205. package/src/services/tabs/fake-ports.fixture.ts +112 -0
  206. package/src/services/tabs/leader-locks.ts +75 -0
  207. package/src/services/tabs/protocol.ts +262 -0
  208. package/src/services/tabs/support.ts +36 -0
  209. package/src/services/tabs/tabs-broker-worker.ts +652 -0
  210. package/src/sp00ky.ts +5 -394
  211. package/src/state/client-state.ts +231 -0
  212. package/src/state/lifecycle.test.ts +184 -0
  213. package/src/state/lifecycle.ts +127 -0
  214. package/src/state/reducers.test.ts +337 -0
  215. package/src/state/reducers.ts +571 -0
  216. package/src/state/selectors.test.ts +203 -0
  217. package/src/state/selectors.ts +264 -0
  218. package/src/sw/index.test.ts +582 -0
  219. package/src/sw/index.ts +607 -0
  220. package/src/sw/store.ts +96 -0
  221. package/src/sync/connection.saga.test.ts +97 -0
  222. package/src/sync/connection.saga.ts +89 -0
  223. package/src/sync/live.saga.test.ts +229 -0
  224. package/src/sync/live.saga.ts +116 -0
  225. package/src/sync/policy.health.test.ts +56 -0
  226. package/src/sync/policy.test.ts +663 -0
  227. package/src/sync/policy.ts +515 -0
  228. package/src/sync/poll.saga.test.ts +51 -0
  229. package/src/sync/poll.saga.ts +36 -0
  230. package/src/sync/tabs.saga.test.ts +78 -0
  231. package/src/sync/tabs.saga.ts +96 -0
  232. package/src/testing/adapters.ts +137 -0
  233. package/src/testing/build.ts +63 -0
  234. package/src/testing/fake-services.ts +63 -0
  235. package/src/testing/run-pure.test.ts +92 -0
  236. package/src/testing/run-pure.ts +128 -0
  237. package/src/testing/services.ts +17 -0
  238. package/src/types.ts +694 -7
  239. package/src/utils/blurhash.ts +90 -0
  240. package/src/utils/edges.ts +57 -0
  241. package/src/utils/error-classification.test.ts +116 -0
  242. package/src/utils/error-classification.ts +74 -0
  243. package/src/utils/index.ts +83 -6
  244. package/src/utils/parser.test.ts +67 -102
  245. package/src/utils/parser.ts +63 -2
  246. package/src/utils/semver.test.ts +32 -0
  247. package/src/utils/semver.ts +30 -0
  248. package/src/utils/sha256.ts +15 -0
  249. package/src/utils/surql.ts +22 -11
  250. package/src/utils/utils.test.ts +3 -2
  251. package/tsdown.config.ts +117 -3
  252. package/vitest.config.ts +48 -0
  253. package/src/modules/cache/index.ts +0 -241
  254. package/src/modules/cache/types.ts +0 -19
  255. package/src/modules/data/data.test.ts +0 -58
  256. package/src/modules/data/index.ts +0 -882
  257. package/src/modules/sync/engine.ts +0 -173
  258. package/src/modules/sync/events/index.ts +0 -78
  259. package/src/modules/sync/index.ts +0 -3
  260. package/src/modules/sync/queue/index.ts +0 -2
  261. package/src/modules/sync/queue/queue-down.ts +0 -90
  262. package/src/modules/sync/queue/queue-up.ts +0 -224
  263. package/src/modules/sync/scheduler.ts +0 -84
  264. package/src/modules/sync/sync.ts +0 -422
  265. package/src/modules/sync/utils.test.ts +0 -311
  266. package/src/modules/sync/utils.ts +0 -169
@@ -0,0 +1,339 @@
1
+ import type { EdgeDelta, QueryHash, RecordVersionArray, ServerViewMeta } from '../types';
2
+ import type { Saga } from '../kernel/saga';
3
+ import type { Settled, StatementResult } from '../kernel/effects';
4
+ import { fx } from '../kernel/effects';
5
+ import {
6
+ MATERIALIZING_REREAD_LADDER_MS,
7
+ MEMBERSHIP_COALESCE_MS,
8
+ MEMBERSHIP_LEADING_MS,
9
+ VIEW_LOST_RETRY_BASE_MS,
10
+ VIEW_LOST_RETRY_MAX_MS,
11
+ backoffMs,
12
+ } from '../kernel/constants';
13
+ import type { ClientState, QueryEntry } from '../state/client-state';
14
+ import * as R from '../state/reducers';
15
+ import { encodeRecordId } from '../utils/index';
16
+ import { departedIds } from '../state/selectors';
17
+ import { forgetDeparted } from './lifecycle.saga';
18
+ import { planListRefPollChunks, recordVersionArraysEqual } from '../sync/policy';
19
+ import type { SagaEnv } from './env';
20
+ import { listRefTable } from './env';
21
+ import * as sql from './sql';
22
+ import {
23
+ FAILED,
24
+ decideMembershipOutcome,
25
+ rebaseRead,
26
+ withDeltas,
27
+ snapshotFromSingle,
28
+ snapshotsFromBatch,
29
+ suspectHashes,
30
+ type ListRefSnapshot,
31
+ } from './membership';
32
+
33
+ type MembershipOutcome = 'applied' | 'ignored' | 'view-lost';
34
+
35
+ /**
36
+ * Accept (or refuse) a server id-set for one query. The only writer of
37
+ * `remoteArray`, the `_00_view` row and the cold -> live transition.
38
+ */
39
+ export function* applyMembership(
40
+ hash: QueryHash,
41
+ remoteArray: RecordVersionArray,
42
+ meta?: ServerViewMeta,
43
+ verifiedRemoval?: boolean
44
+ ): Saga<MembershipOutcome> {
45
+ const entry = (yield fx.state.read((s) => s.queries.get(hash))) as QueryEntry | undefined;
46
+ if (!entry) return 'ignored';
47
+ if (meta) yield fx.state.update(R.setServerState(hash, meta.present ? meta.state : null));
48
+ // The row is there: whatever made it read as gone has passed.
49
+ if (meta?.present && (entry.viewLostCount > 0 || entry.viewLostRetryAt !== null)) {
50
+ yield fx.state.update(R.setViewLost(hash, 0, null));
51
+ }
52
+ const outcome = decideMembershipOutcome({
53
+ phase: entry.lifecycle.phase,
54
+ held: entry.remoteArray.length,
55
+ remoteArray,
56
+ meta,
57
+ verifiedRemoval,
58
+ });
59
+ if (outcome === 'ignored') return outcome;
60
+ if (outcome === 'view-lost') {
61
+ if (entry.lifecycle.phase !== 'view-lost') {
62
+ yield fx.state.update(R.applyLifecycle(hash, { type: 'row-missing' }));
63
+ yield fx.emit({ type: 'query:view-lost', hash });
64
+ }
65
+ // A recovery is already scheduled: every read in the meantime would
66
+ // otherwise re-register again.
67
+ if (entry.viewLostRetryAt !== null) return outcome;
68
+ if (entry.viewLostCount === 0) {
69
+ yield fx.state.update(R.setViewLost(hash, 1, null));
70
+ if (entry.lifecycle.remote !== 'unregistered') {
71
+ yield fx.state.update(R.applyLifecycle(hash, { type: 'remote-dropped' }));
72
+ }
73
+ yield fx.dispatch({ type: 'EnsureRegistered' });
74
+ return outcome;
75
+ }
76
+ // Re-registered already and the row still reads as gone. Under load that
77
+ // repeated every read, each one costing the server a registration while it
78
+ // was still publishing the last, so from here on it is paced.
79
+ const delay = backoffMs(entry.viewLostCount - 1, VIEW_LOST_RETRY_BASE_MS, VIEW_LOST_RETRY_MAX_MS);
80
+ const now = (yield fx.now()) as number;
81
+ yield fx.state.update(R.setViewLost(hash, entry.viewLostCount + 1, now + delay));
82
+ yield fx.emit({
83
+ type: 'log',
84
+ level: 'debug',
85
+ message: 'view still lost; re-registering after a delay',
86
+ data: { hash, attempt: entry.viewLostCount + 1, delayMs: delay },
87
+ });
88
+ yield fx.timer.set(`view-lost:${hash}`, delay, { type: 'RecoverLostView', hash });
89
+ return outcome;
90
+ }
91
+ yield fx.state.update(R.commitMembership(hash, remoteArray, meta?.present ?? true));
92
+ yield* forgetDeparted(hash, departedIds(entry.remoteArray, remoteArray));
93
+ // No authority flip here: the set is known but its rows are not painted
94
+ // yet (bodies may still be on their way). `materialize` flips it once they are.
95
+ const now = (yield fx.now()) as number;
96
+ try {
97
+ yield fx.local.upsert(
98
+ sql.VIEW_TABLE,
99
+ sql.viewRecordId(entry.def.viewKey),
100
+ sql.viewRow(remoteArray, entry.subqueryRemoteArray, true, now),
101
+ 'replace'
102
+ );
103
+ } catch (err) {
104
+ yield fx.emit({ type: 'log', level: 'debug', message: 'view row write failed', data: { hash, err } });
105
+ }
106
+ yield fx.dispatch({ type: 'FetchRows' });
107
+ return outcome;
108
+ }
109
+
110
+ /**
111
+ * The paced view-lost re-registration. A no-op when the row has been seen
112
+ * since (the pacing was reset) or the query recovered or went away.
113
+ */
114
+ export function* recoverLostView(hash: QueryHash): Saga<void> {
115
+ const entry = (yield fx.state.read((s) => s.queries.get(hash))) as QueryEntry | undefined;
116
+ if (!entry || entry.viewLostRetryAt === null) return;
117
+ yield fx.state.update(R.setViewLost(hash, entry.viewLostCount, null));
118
+ if (entry.lifecycle.phase !== 'view-lost') return;
119
+ if (entry.lifecycle.remote !== 'unregistered') {
120
+ yield fx.state.update(R.applyLifecycle(hash, { type: 'remote-dropped' }));
121
+ }
122
+ yield fx.dispatch({ type: 'RegisterRemote', hash });
123
+ }
124
+
125
+ /**
126
+ * Replace the subquery child set; bodies follow through the fetch plan. A
127
+ * query with a `_00_view` row (past `cold`) records the children there too,
128
+ * so the GC keeps their bodies and a cold scan may paint them.
129
+ */
130
+ export function* applySubqueryChildren(hash: QueryHash, children: RecordVersionArray): Saga<void> {
131
+ const entry = (yield fx.state.read((s) => s.queries.get(hash))) as QueryEntry | undefined;
132
+ if (!entry || recordVersionArraysEqual(entry.subqueryRemoteArray, children)) return;
133
+ yield fx.state.update(R.setSubqueryRemoteArray(hash, children));
134
+ yield* forgetDeparted(hash, departedIds(entry.subqueryRemoteArray, children));
135
+ if (entry.lifecycle.phase !== 'cold') {
136
+ try {
137
+ yield fx.local.upsert(sql.VIEW_TABLE, sql.viewRecordId(entry.def.viewKey), { children }, 'merge');
138
+ } catch (err) {
139
+ yield fx.emit({ type: 'log', level: 'debug', message: 'view row write failed', data: { hash, err } });
140
+ }
141
+ }
142
+ yield fx.dispatch({ type: 'FetchRows' });
143
+ }
144
+
145
+ const ok = (r: Settled): r is { ok: true; value: unknown } => r.ok;
146
+ /** One statement's result, or `FAILED` when it did not answer (see `FAILED`). */
147
+ const stmt = (results: unknown, i: number): unknown => {
148
+ if (!Array.isArray(results)) return FAILED;
149
+ const r = (results as StatementResult[])[i];
150
+ return r && r.status === 'OK' ? r.result : FAILED;
151
+ };
152
+
153
+ /**
154
+ * Commit LIVE edge deltas (rows joining a view, or moving to a newer
155
+ * version) straight to membership, without re-reading the edges: the
156
+ * notification already says what the read would. Returns the hashes it
157
+ * settled; any other change still goes through {@link readMembership}.
158
+ *
159
+ * Only for a query whose membership is known and current (`live`, not
160
+ * materializing, no view-lost recovery pending): before that the read decides
161
+ * what the set is. Removals are never applied here, so a view whose edges
162
+ * are being rewritten never loses (and garbage-collects) bodies mid-rewrite.
163
+ * A query with a `LIMIT` takes it only when every delta is a version bump of
164
+ * a row it already holds. A row JOINING it pushes another out, and rendering
165
+ * the joiner before the read removes the leaver would show one row too many
166
+ * (the id-set render drops the `LIMIT`); a bump cannot change the count. A row
167
+ * that an edit moves out of the window arrives as its own `DELETE`, which still
168
+ * marks the query dirty. Windowed lists are most lists, so this spares the
169
+ * coalesce window and a full round trip on the common case of an edit to a
170
+ * row already on screen.
171
+ */
172
+ export function* applyEdgeDeltas(deltas: EdgeDelta[]): Saga<Set<QueryHash>> {
173
+ const settled = new Set<QueryHash>();
174
+ const byHash = new Map<QueryHash, EdgeDelta[]>();
175
+ for (const d of deltas) byHash.set(d.hash, [...(byHash.get(d.hash) ?? []), d]);
176
+ for (const [hash, list] of byHash) {
177
+ const entry = (yield fx.state.read((s) => s.queries.get(hash))) as QueryEntry | undefined;
178
+ if (!entry || entry.lifecycle.phase !== 'live' || entry.serverState === 'materializing' || entry.viewLostRetryAt !== null) continue;
179
+ const limited = entry.def.plan ? entry.def.plan.limit != null : /\bLIMIT\b/i.test(entry.def.surql);
180
+ if (limited) {
181
+ const held = new Set(entry.remoteArray.map(([id]) => id));
182
+ if (!list.every((d) => held.has(d.id))) continue;
183
+ }
184
+ const next = withDeltas(entry.remoteArray, list);
185
+ // Never empty, so always applied.
186
+ if (next !== entry.remoteArray) yield* applyMembership(hash, next);
187
+ settled.add(hash);
188
+ }
189
+ return settled;
190
+ }
191
+
192
+ /**
193
+ * Read the server membership of many queries in as few round trips as the
194
+ * row budget allows, then apply each changed set. Every server id-set enters
195
+ * state here, except the rows LIVE reports joining (see
196
+ * {@link applyEdgeDeltas}): registration, the poll, LIVE dirt and view-lost
197
+ * recovery all come through here.
198
+ */
199
+ export function* readMembership(
200
+ env: SagaEnv,
201
+ hashes: QueryHash[],
202
+ opts: { force?: boolean } = {}
203
+ ): Saga<{ changed: boolean; failed: boolean }> {
204
+ const state = (yield fx.state.read((s) => s)) as ClientState;
205
+ const entries = hashes.map((h) => state.queries.get(h)).filter((e): e is QueryEntry => !!e);
206
+ if (entries.length === 0) return { changed: false, failed: false };
207
+ const table = listRefTable(env, state);
208
+ const now = (yield fx.now()) as number;
209
+ const chunks = planListRefPollChunks(
210
+ entries.map((e) => ({ hash: e.def.hash, rows: e.remoteArray.length, lastPolledAt: opts.force ? 0 : (e.lastPolledAt ?? 0) })),
211
+ { now }
212
+ );
213
+ const byHash = new Map(entries.map((e) => [e.def.hash, e]));
214
+ const single = (e: QueryEntry) =>
215
+ fx.remote.query(sql.singleSnapshotSelect(table), { in: e.def.id }, env.remoteTimeoutMs);
216
+ const requests = chunks.map((chunk) =>
217
+ chunk.length === 1
218
+ ? single(byHash.get(chunk[0])!)
219
+ : fx.remote.query(sql.batchSnapshotSelect(table), { ins: chunk.map((h) => byHash.get(h)!.def.id) }, env.remoteTimeoutMs)
220
+ );
221
+ const results = (yield fx.all(requests)) as Settled[];
222
+
223
+ const snapshots = new Map<QueryHash, ListRefSnapshot>();
224
+ let failed = false;
225
+ const rereads: QueryEntry[] = [];
226
+ chunks.forEach((chunk, i) => {
227
+ const r = results[i];
228
+ if (!ok(r)) {
229
+ failed = true;
230
+ return;
231
+ }
232
+ if (chunk.length === 1) {
233
+ const snap = snapshotFromSingle(stmt(r.value, 0) as never, stmt(r.value, 1) as never, stmt(r.value, 2) as never);
234
+ if (snap) snapshots.set(chunk[0], snap);
235
+ else failed = true;
236
+ return;
237
+ }
238
+ const hashById = new Map(chunk.map((h) => [encodeRecordId(byHash.get(h)!.def.id), h]));
239
+ const edges = stmt(r.value, 0) as never[] | null;
240
+ const counts = stmt(r.value, 1);
241
+ if (!Array.isArray(edges) || counts === FAILED) {
242
+ failed = true;
243
+ return;
244
+ }
245
+ const batch = snapshotsFromBatch(edges, counts as never, hashById);
246
+ const held = new Map(chunk.map((h) => [h, byHash.get(h)!.remoteArray.length]));
247
+ const suspect = new Set(suspectHashes(batch, held, edges.length));
248
+ for (const [h, snap] of batch) {
249
+ if (suspect.has(h)) rereads.push(byHash.get(h)!);
250
+ else snapshots.set(h, snap);
251
+ }
252
+ });
253
+ if (rereads.length > 0) {
254
+ const again = (yield fx.all(rereads.map(single))) as Settled[];
255
+ again.forEach((r, i) => {
256
+ if (!ok(r)) {
257
+ failed = true;
258
+ return;
259
+ }
260
+ const snap = snapshotFromSingle(stmt(r.value, 0) as never, stmt(r.value, 1) as never, stmt(r.value, 2) as never);
261
+ if (snap) snapshots.set(rereads[i].def.hash, snap);
262
+ else failed = true;
263
+ });
264
+ }
265
+
266
+ let changed = false;
267
+ const stillMaterializing: QueryHash[] = [];
268
+ for (const [hash, snap] of snapshots) {
269
+ const current = (yield fx.state.read((s) => s.queries.get(hash))) as QueryEntry | undefined;
270
+ if (!current) continue;
271
+ const primary = rebaseRead(snap.primary, byHash.get(hash)!.remoteArray, current.remoteArray);
272
+ const metaChanged = current.serverState !== (snap.meta.present ? snap.meta.state : null);
273
+ if (!recordVersionArraysEqual(primary, current.remoteArray) || metaChanged || current.lifecycle.phase === 'cold' || current.lifecycle.phase === 'cached') {
274
+ const outcome = yield* applyMembership(hash, primary, snap.meta);
275
+ if (outcome === 'applied') changed = true;
276
+ if (outcome === 'ignored' && snap.meta.present && snap.meta.state === 'materializing') stillMaterializing.push(hash);
277
+ }
278
+ yield* applySubqueryChildren(hash, snap.subquery);
279
+ }
280
+ yield fx.state.update(R.compose(R.clearMembershipDirty([...snapshots.keys()]), R.stampPolled(snapshots.keys(), now)));
281
+
282
+ // A view whose edges are still in flight: re-read on a short ladder rather
283
+ // than waiting for a backed-off poll tick.
284
+ for (const hash of stillMaterializing) {
285
+ const attempt = (yield fx.state.read((s) => s.membershipReread.get(hash) ?? 0)) as number;
286
+ if (attempt >= MATERIALIZING_REREAD_LADDER_MS.length) {
287
+ yield fx.state.update(R.setMembershipReread(hash, null));
288
+ continue;
289
+ }
290
+ yield fx.state.update(R.compose(R.setMembershipReread(hash, attempt + 1), R.markMembershipDirty([hash])));
291
+ yield fx.timer.set('membership', MATERIALIZING_REREAD_LADDER_MS[attempt], { type: 'ReadDirtyMembership' });
292
+ }
293
+ for (const hash of snapshots.keys()) {
294
+ if (!stillMaterializing.includes(hash)) yield fx.state.update(R.setMembershipReread(hash, null));
295
+ }
296
+ yield fx.dispatch({ type: 'SyncOutcome', ok: !failed, error: failed ? 'membership read failed' : undefined });
297
+ return { changed, failed };
298
+ }
299
+
300
+ /**
301
+ * LIVE handler: mark dirty and coalesce into one batched re-read.
302
+ *
303
+ * The window is armed ONCE per burst, when the dirty set goes from empty to
304
+ * non-empty. `timer.set` replaces a pending timer, so re-arming on every event
305
+ * would push the read out for as long as events keep arriving: on a busy
306
+ * `_00_list_ref` table (registrations, an import, another tab syncing) the
307
+ * events never stop for a whole 50 ms and the read simply never ran, leaving
308
+ * membership frozen until a poll tick happened to cover it.
309
+ *
310
+ * Leading edge: when none of these queries was read within the last
311
+ * {@link MEMBERSHIP_COALESCE_MS}, the read goes out after the short
312
+ * {@link MEMBERSHIP_LEADING_MS} instead of waiting the whole window. A lone
313
+ * remote edit is the common case, and the full window sat in front of every
314
+ * one of them. Dirt arriving while that read is in flight still gets its own
315
+ * trailing read from {@link readDirtyMembership}, so the cap of one read per
316
+ * window holds.
317
+ */
318
+ export function* markMembershipDirty(hashes: QueryHash[]): Saga<void> {
319
+ const [armed, lastRead] = (yield fx.state.read((s) => [
320
+ s.membershipDirty.size > 0,
321
+ hashes.reduce((at, h) => Math.max(at, s.queries.get(h)?.lastPolledAt ?? 0), 0),
322
+ ])) as [boolean, number];
323
+ yield fx.state.update(R.markMembershipDirty(hashes));
324
+ if (armed) return;
325
+ const now = (yield fx.now()) as number;
326
+ const delay = Math.max(MEMBERSHIP_LEADING_MS, lastRead + MEMBERSHIP_COALESCE_MS - now);
327
+ yield fx.timer.set('membership', delay, { type: 'ReadDirtyMembership' });
328
+ }
329
+
330
+ export function* readDirtyMembership(env: SagaEnv): Saga<void> {
331
+ const dirty = (yield fx.state.read((s) => [...s.membershipDirty])) as QueryHash[];
332
+ if (dirty.length === 0) return;
333
+ yield* readMembership(env, dirty, { force: true });
334
+ // Dirt that arrived while the read was in flight, or a hash the read could
335
+ // not answer, holds the set non-empty - and with the window armed only on the
336
+ // empty -> non-empty edge, nothing else would arm it again.
337
+ const left = (yield fx.state.read((s) => s.membershipDirty.size)) as number;
338
+ if (left > 0) yield fx.timer.set('membership', MEMBERSHIP_COALESCE_MS, { type: 'ReadDirtyMembership' });
339
+ }
@@ -0,0 +1,151 @@
1
+ import { describe, expect, it } from 'vitest';
2
+ import { RecordId } from 'surrealdb';
3
+ import {
4
+ decideMembershipOutcome,
5
+ dedupeRecordVersions,
6
+ isResolvedBefore,
7
+ metaFromRow,
8
+ parseViewRow,
9
+ rebaseRead,
10
+ snapshotFromSingle,
11
+ snapshotsFromBatch,
12
+ suspectHashes,
13
+ withDeltas,
14
+ } from './membership';
15
+
16
+ describe('durable view row', () => {
17
+ it('parses and gates resolved-before', () => {
18
+ expect(parseViewRow(null)).toBeNull();
19
+ expect(parseViewRow({ ids: 'nope' })).toBeNull();
20
+ expect(parseViewRow({ ids: [['t:1', 1]], confirmed: true })).toEqual({ ids: [['t:1', 1]], confirmed: true });
21
+ expect(parseViewRow({ ids: [] })).toEqual({ ids: [], confirmed: false });
22
+ expect(isResolvedBefore(null)).toBe(false);
23
+ expect(isResolvedBefore({ ids: [], confirmed: false })).toBe(false);
24
+ expect(isResolvedBefore({ ids: [], confirmed: true })).toBe(true);
25
+ expect(isResolvedBefore({ ids: [['t:1', 1]], confirmed: false })).toBe(true);
26
+ });
27
+ });
28
+
29
+ describe('metaFromRow / dedupe', () => {
30
+ it('folds the row-count select', () => {
31
+ expect(metaFromRow(null)).toEqual({ present: false, rowCount: null, state: null });
32
+ expect(metaFromRow({ rowCount: 3, state: 'ready' })).toEqual({ present: true, rowCount: 3, state: 'ready' });
33
+ expect(metaFromRow({ rowCount: null, state: 'weird' })).toEqual({ present: true, rowCount: null, state: null });
34
+ expect(metaFromRow({ state: 'materializing' })).toEqual({ present: true, rowCount: null, state: 'materializing' });
35
+ });
36
+ it('keeps the highest version per id', () => {
37
+ const single: [string, number][] = [['t:1', 1]];
38
+ expect(dedupeRecordVersions(single)).toBe(single);
39
+ const clean: [string, number][] = [['t:1', 1], ['t:2', 1]];
40
+ expect(dedupeRecordVersions(clean)).toBe(clean);
41
+ expect(dedupeRecordVersions([['t:1', 1], ['t:1', 3], ['t:1', 2]])).toEqual([['t:1', 3]]);
42
+ });
43
+ });
44
+
45
+ describe('decideMembershipOutcome', () => {
46
+ const ready0 = { present: true, rowCount: 0, state: 'ready' as const };
47
+ it('non-empty or verified removal is always applied', () => {
48
+ expect(decideMembershipOutcome({ phase: 'cold', held: 0, remoteArray: [['t:1', 1]] })).toBe('applied');
49
+ expect(decideMembershipOutcome({ phase: 'live', held: 2, remoteArray: [], verifiedRemoval: true })).toBe('applied');
50
+ });
51
+ it('empty with no readable row: view-lost when holding, ignored when cold and empty', () => {
52
+ expect(decideMembershipOutcome({ phase: 'cold', held: 0, remoteArray: [] })).toBe('ignored');
53
+ expect(decideMembershipOutcome({ phase: 'cold', held: 0, remoteArray: [], meta: { present: false, rowCount: null, state: null } })).toBe('ignored');
54
+ expect(decideMembershipOutcome({ phase: 'cold', held: 2, remoteArray: [] })).toBe('view-lost');
55
+ expect(decideMembershipOutcome({ phase: 'cached', held: 0, remoteArray: [] })).toBe('view-lost');
56
+ expect(decideMembershipOutcome({ phase: 'live', held: 1, remoteArray: [], meta: { present: false, rowCount: null, state: null } })).toBe('view-lost');
57
+ });
58
+ it('empty with a present row: applied only when ready and zero rows', () => {
59
+ expect(decideMembershipOutcome({ phase: 'cold', held: 0, remoteArray: [], meta: ready0 })).toBe('applied');
60
+ expect(decideMembershipOutcome({ phase: 'cold', held: 0, remoteArray: [], meta: { present: true, rowCount: 0, state: null } })).toBe('applied');
61
+ expect(decideMembershipOutcome({ phase: 'cold', held: 0, remoteArray: [], meta: { present: true, rowCount: 0, state: 'materializing' } })).toBe('ignored');
62
+ expect(decideMembershipOutcome({ phase: 'live', held: 3, remoteArray: [], meta: { present: true, rowCount: 3, state: 'ready' } })).toBe('ignored');
63
+ expect(decideMembershipOutcome({ phase: 'live', held: 3, remoteArray: [], meta: { present: true, rowCount: null, state: 'ready' } })).toBe('ignored');
64
+ });
65
+ });
66
+
67
+ describe('snapshots', () => {
68
+ const q1 = new RecordId('_00_query', 'a');
69
+ const q2 = new RecordId('_00_query', 'b');
70
+ const out = (id: string) => new RecordId('thing', id);
71
+ it('single: edges, meta, children; null when the primary select is not an array', () => {
72
+ expect(snapshotFromSingle(null, null, null)).toBeNull();
73
+ const snap = snapshotFromSingle(
74
+ [{ out: out('1'), version: 1 }, { out: out('1'), version: 2 }],
75
+ { rowCount: 1, state: 'ready' },
76
+ [{ out: out('c'), version: 1 }]
77
+ );
78
+ expect(snap).toEqual({
79
+ primary: [['thing:1', 2]],
80
+ subquery: [['thing:c', 1]],
81
+ meta: { present: true, rowCount: 1, state: 'ready' },
82
+ });
83
+ expect(snapshotFromSingle([], null, null)!.subquery).toEqual([]);
84
+ });
85
+ it('batch: splits by hash and parent, fills meta, marks missing rows absent', () => {
86
+ const hashById = new Map([['_00_query:a', 'ha'], ['_00_query:b', 'hb']]);
87
+ expect(snapshotsFromBatch(null, null, hashById).size).toBe(0);
88
+ const snaps = snapshotsFromBatch(
89
+ [
90
+ { in: q1, out: out('1'), version: 1 },
91
+ { in: q1, out: out('1'), version: 1 },
92
+ { in: q1, out: out('c'), version: 1, parent: q1 },
93
+ { in: new RecordId('_00_query', 'zz'), out: out('9'), version: 1 },
94
+ ],
95
+ [{ id: q1, rowCount: 1, state: 'ready' }, null, { rowCount: 5 }, { id: new RecordId('_00_query', 'zz') }],
96
+ hashById
97
+ );
98
+ expect(snaps.get('ha')).toEqual({
99
+ primary: [['thing:1', 1]],
100
+ subquery: [['thing:c', 1]],
101
+ meta: { present: true, rowCount: 1, state: 'ready' },
102
+ });
103
+ expect(snaps.get('hb')).toEqual({ primary: [], subquery: [], meta: { present: false, rowCount: null, state: null } });
104
+ expect(snapshotsFromBatch([], null, hashById).get('ha')!.meta.present).toBe(false);
105
+ });
106
+ it('suspectHashes flags held queries with a missing row or a silently empty batch', () => {
107
+ const snaps = new Map([
108
+ ['missing', { primary: [], subquery: [], meta: { present: false, rowCount: null, state: null } }],
109
+ ['empty', { primary: [], subquery: [], meta: { present: true, rowCount: 4, state: 'ready' as const } }],
110
+ ['fine', { primary: [], subquery: [], meta: { present: true, rowCount: 0, state: 'ready' as const } }],
111
+ ['unheld', { primary: [], subquery: [], meta: { present: false, rowCount: null, state: null } }],
112
+ ]);
113
+ const held = new Map([['missing', 2], ['empty', 4], ['fine', 1], ['unheld', 0]]);
114
+ expect(suspectHashes(snaps, held, 0)).toEqual(['missing', 'empty']);
115
+ expect(suspectHashes(snaps, held, 1)).toEqual(['missing']);
116
+ const nullCount = new Map([['q', { primary: [], subquery: [], meta: { present: true, rowCount: null, state: 'ready' as const } }]]);
117
+ expect(suspectHashes(nullCount, new Map([['q', 3]]), 0)).toEqual([]);
118
+ expect(suspectHashes(nullCount, new Map(), 0)).toEqual([]);
119
+ });
120
+ });
121
+
122
+ describe('withDeltas', () => {
123
+ it('adds a joining row and moves a held one to a newer version', () => {
124
+ const held: Array<[string, number]> = [['t:1', 1], ['t:2', 1]];
125
+ expect(withDeltas(held, [{ id: 't:3', version: 1 }, { id: 't:2', version: 4 }])).toEqual([['t:1', 1], ['t:2', 4], ['t:3', 1]]);
126
+ });
127
+ it('hands back the held set itself when nothing moves', () => {
128
+ const held: Array<[string, number]> = [['t:1', 5]];
129
+ expect(withDeltas(held, [{ id: 't:1', version: 5 }, { id: 't:1', version: 2 }])).toBe(held);
130
+ expect(withDeltas(held, [])).toBe(held);
131
+ });
132
+ });
133
+
134
+ describe('rebaseRead', () => {
135
+ it('is the read itself when state did not move while it was in flight', () => {
136
+ const before: Array<[string, number]> = [['t:1', 1]];
137
+ const read: Array<[string, number]> = [['t:2', 1]];
138
+ expect(rebaseRead(read, before, before)).toBe(read);
139
+ });
140
+ it('keeps a row that joined (or moved) after the read was sent', () => {
141
+ const before: Array<[string, number]> = [['t:1', 1]];
142
+ const now: Array<[string, number]> = [['t:1', 3], ['t:2', 1]];
143
+ // The server answered before either change.
144
+ expect(rebaseRead([['t:1', 1]], before, now)).toEqual([['t:1', 3], ['t:2', 1]]);
145
+ // ...or after them: nothing is doubled or moved back.
146
+ expect(rebaseRead([['t:1', 4], ['t:2', 2]], before, now)).toEqual([['t:1', 4], ['t:2', 2]]);
147
+ });
148
+ it('drops a row that left in the meantime', () => {
149
+ expect(rebaseRead([['t:1', 1], ['t:2', 1]], [['t:1', 1], ['t:2', 1]], [['t:2', 1]])).toEqual([['t:2', 1]]);
150
+ });
151
+ });