@spooky-sync/core 0.0.1-canary.26 → 0.0.1-canary.260

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 (228) hide show
  1. package/AGENTS.md +78 -0
  2. package/README.md +56 -16
  3. package/dist/index.d.ts +2197 -80
  4. package/dist/index.js +12745 -2588
  5. package/dist/otel/index.d.ts +2 -2
  6. package/dist/otel/index.js +6 -6
  7. package/dist/sqlite-open.js +331 -0
  8. package/dist/sqlite-worker.d.ts +1 -0
  9. package/dist/sqlite-worker.js +439 -0
  10. package/dist/tabs-broker-worker.d.ts +8 -0
  11. package/dist/tabs-broker-worker.js +472 -0
  12. package/dist/types.d.ts +787 -46
  13. package/package.json +16 -8
  14. package/scripts/check-broker-bundle.mjs +33 -0
  15. package/skills/{spooky-core → sp00ky-core}/SKILL.md +30 -12
  16. package/skills/{spooky-core → sp00ky-core}/references/auth.md +1 -1
  17. package/skills/{spooky-core → sp00ky-core}/references/config.md +2 -2
  18. package/src/boot/auth-flip.saga.test.ts +82 -0
  19. package/src/boot/auth-flip.saga.ts +62 -0
  20. package/src/boot/boot.saga.test.ts +151 -0
  21. package/src/boot/boot.saga.ts +128 -0
  22. package/src/boot/bucket-switch.saga.test.ts +158 -0
  23. package/src/boot/bucket-switch.saga.ts +115 -0
  24. package/src/boot/preload.saga.test.ts +51 -0
  25. package/src/boot/preload.saga.ts +31 -0
  26. package/src/bucket-blurhash.test.ts +148 -0
  27. package/src/build-globals.d.ts +12 -0
  28. package/src/client/bucket-handle.test.ts +117 -0
  29. package/src/client/bucket-handle.ts +227 -0
  30. package/src/client/router.test.ts +56 -0
  31. package/src/client/router.ts +96 -0
  32. package/src/client/runtime.test.ts +192 -0
  33. package/src/client/runtime.ts +296 -0
  34. package/src/client/services.ts +382 -0
  35. package/src/client/sp00ky-client.test.ts +264 -0
  36. package/src/client/sp00ky-client.ts +499 -0
  37. package/src/events/events.test.ts +2 -1
  38. package/src/events/index.ts +3 -0
  39. package/src/index.ts +37 -2
  40. package/src/kernel/constants.test.ts +19 -0
  41. package/src/kernel/constants.ts +61 -0
  42. package/src/kernel/effects.test.ts +40 -0
  43. package/src/kernel/effects.ts +159 -0
  44. package/src/kernel/events.ts +56 -0
  45. package/src/kernel/interpreter.test.ts +116 -0
  46. package/src/kernel/interpreter.ts +148 -0
  47. package/src/kernel/saga.test.ts +89 -0
  48. package/src/kernel/saga.ts +73 -0
  49. package/src/modules/app-release/index.test.ts +125 -0
  50. package/src/modules/app-release/index.ts +209 -0
  51. package/src/modules/auth/auth.local-first.test.ts +141 -0
  52. package/src/modules/auth/events/index.ts +2 -1
  53. package/src/modules/auth/index.ts +138 -25
  54. package/src/modules/crdt/crdt-field.ts +294 -0
  55. package/src/modules/crdt/crdt-hydration.test.ts +210 -0
  56. package/src/modules/crdt/crdt-reconnect.test.ts +195 -0
  57. package/src/modules/crdt/index.ts +463 -0
  58. package/src/modules/crdt/loro-loader.ts +25 -0
  59. package/src/modules/devtools/flags.ts +349 -0
  60. package/src/modules/devtools/index.ts +459 -47
  61. package/src/modules/devtools/notify-throttle.test.ts +154 -0
  62. package/src/modules/devtools/state-shape.test.ts +149 -0
  63. package/src/modules/devtools/storage-info.test.ts +79 -0
  64. package/src/modules/devtools/storage-info.ts +168 -0
  65. package/src/modules/devtools/versions.test.ts +74 -0
  66. package/src/modules/devtools/versions.ts +110 -0
  67. package/src/modules/feature-flag/index.test.ts +251 -0
  68. package/src/modules/feature-flag/index.ts +316 -0
  69. package/src/modules/ref-tables.test.ts +91 -0
  70. package/src/modules/ref-tables.ts +88 -0
  71. package/src/mutation/jobs.test.ts +25 -0
  72. package/src/mutation/jobs.ts +41 -0
  73. package/src/mutation/mutation-id.test.ts +37 -0
  74. package/src/mutation/mutation-id.ts +35 -0
  75. package/src/mutation/push.saga.test.ts +285 -0
  76. package/src/mutation/push.saga.ts +215 -0
  77. package/src/mutation/rows.test.ts +201 -0
  78. package/src/mutation/rows.ts +377 -0
  79. package/src/mutation/tray.saga.test.ts +63 -0
  80. package/src/mutation/tray.saga.ts +48 -0
  81. package/src/mutation/write.saga.test.ts +163 -0
  82. package/src/mutation/write.saga.ts +166 -0
  83. package/src/otel/index.ts +13 -10
  84. package/src/query/env.test.ts +23 -0
  85. package/src/query/env.ts +56 -0
  86. package/src/query/fetch.saga.test.ts +156 -0
  87. package/src/query/fetch.saga.ts +115 -0
  88. package/src/query/hash.test.ts +14 -0
  89. package/src/query/hash.ts +18 -0
  90. package/src/query/id-set-plan.test.ts +132 -0
  91. package/src/query/lifecycle.saga.test.ts +122 -0
  92. package/src/query/lifecycle.saga.ts +101 -0
  93. package/src/query/materialize.saga.test.ts +82 -0
  94. package/src/query/materialize.saga.ts +75 -0
  95. package/src/query/materialize.test.ts +50 -0
  96. package/src/query/materialize.ts +44 -0
  97. package/src/query/membership.saga.test.ts +317 -0
  98. package/src/query/membership.saga.ts +262 -0
  99. package/src/query/membership.test.ts +118 -0
  100. package/src/query/membership.ts +171 -0
  101. package/src/query/register.saga.test.ts +293 -0
  102. package/src/query/register.saga.ts +226 -0
  103. package/src/query/render-set.test.ts +36 -0
  104. package/src/query/render-set.ts +60 -0
  105. package/src/query/sql.test.ts +62 -0
  106. package/src/query/sql.ts +79 -0
  107. package/src/query/window-query.test.ts +70 -0
  108. package/src/query/window-query.ts +195 -0
  109. package/src/services/blobs/blob-cache.test.ts +359 -0
  110. package/src/services/blobs/blob-cache.ts +603 -0
  111. package/src/services/blobs/blob-manifest.ts +227 -0
  112. package/src/services/blobs/blob-store.test.ts +77 -0
  113. package/src/services/blobs/blob-store.ts +359 -0
  114. package/src/services/blobs/blob.fixture.ts +90 -0
  115. package/src/services/blobs/index.ts +70 -0
  116. package/src/services/database/cache-engine.ts +193 -0
  117. package/src/services/database/connection-supervisor.test.ts +318 -0
  118. package/src/services/database/connection-supervisor.ts +422 -0
  119. package/src/services/database/database.query-timeout.test.ts +140 -0
  120. package/src/services/database/database.responses.test.ts +43 -0
  121. package/src/services/database/database.ts +145 -62
  122. package/src/services/database/engine-factory.ts +33 -0
  123. package/src/services/database/errors.ts +34 -0
  124. package/src/services/database/events/index.ts +2 -1
  125. package/src/services/database/index.ts +7 -0
  126. package/src/services/database/local-migrator.ts +30 -27
  127. package/src/services/database/local.test.ts +64 -0
  128. package/src/services/database/local.ts +484 -67
  129. package/src/services/database/plan-render.test.ts +159 -0
  130. package/src/services/database/plan-render.ts +108 -0
  131. package/src/services/database/relation-resolver.test.ts +467 -0
  132. package/src/services/database/relation-resolver.ts +0 -0
  133. package/src/services/database/remote.ts +222 -15
  134. package/src/services/database/sqlite-cache-engine.test.ts +617 -0
  135. package/src/services/database/sqlite-cache-engine.timeout.test.ts +61 -0
  136. package/src/services/database/sqlite-cache-engine.ts +1349 -0
  137. package/src/services/database/sqlite-devtools-queries.integration.test.ts +143 -0
  138. package/src/services/database/sqlite-devtools-queries.test.ts +154 -0
  139. package/src/services/database/sqlite-lock-verify.test.ts +33 -0
  140. package/src/services/database/sqlite-lock-verify.ts +45 -0
  141. package/src/services/database/sqlite-open.test.ts +150 -0
  142. package/src/services/database/sqlite-open.ts +164 -0
  143. package/src/services/database/sqlite-plan-sql.test.ts +104 -0
  144. package/src/services/database/sqlite-plan-sql.ts +153 -0
  145. package/src/services/database/sqlite-projection.test.ts +121 -0
  146. package/src/services/database/sqlite-select.integration.test.ts +185 -0
  147. package/src/services/database/sqlite-select.test.ts +246 -0
  148. package/src/services/database/sqlite-select.ts +131 -0
  149. package/src/services/database/sqlite-transport.fixture.ts +30 -0
  150. package/src/services/database/sqlite-transport.ts +224 -0
  151. package/src/services/database/sqlite-worker.ts +437 -0
  152. package/src/services/database/surql-translate.ts +416 -0
  153. package/src/services/database/surreal-cache-engine.ts +161 -0
  154. package/src/services/logger/index.ts +3 -2
  155. package/src/services/persistence/localstorage.ts +2 -2
  156. package/src/services/persistence/resilient.ts +11 -4
  157. package/src/services/persistence/surrealdb.ts +10 -10
  158. package/src/services/stream-processor/index.ts +796 -84
  159. package/src/services/stream-processor/permissions.test.ts +47 -0
  160. package/src/services/stream-processor/permissions.ts +53 -0
  161. package/src/services/stream-processor/stream-processor.batch.test.ts +186 -0
  162. package/src/services/stream-processor/stream-processor.prime.test.ts +198 -0
  163. package/src/services/stream-processor/stream-processor.reset.test.ts +226 -0
  164. package/src/services/stream-processor/stream-processor.test.ts +1 -1
  165. package/src/services/stream-processor/wasm-types.ts +59 -3
  166. package/src/services/tabs/broker-client.ts +283 -0
  167. package/src/services/tabs/broker.test.ts +327 -0
  168. package/src/services/tabs/coordinator.test.ts +365 -0
  169. package/src/services/tabs/coordinator.ts +633 -0
  170. package/src/services/tabs/fake-ports.fixture.ts +112 -0
  171. package/src/services/tabs/leader-locks.ts +75 -0
  172. package/src/services/tabs/protocol.ts +262 -0
  173. package/src/services/tabs/support.ts +36 -0
  174. package/src/services/tabs/tabs-broker-worker.ts +640 -0
  175. package/src/sp00ky.ts +5 -0
  176. package/src/state/client-state.ts +191 -0
  177. package/src/state/lifecycle.test.ts +118 -0
  178. package/src/state/lifecycle.ts +86 -0
  179. package/src/state/reducers.test.ts +280 -0
  180. package/src/state/reducers.ts +488 -0
  181. package/src/state/selectors.test.ts +149 -0
  182. package/src/state/selectors.ts +184 -0
  183. package/src/sync/connection.saga.test.ts +86 -0
  184. package/src/sync/connection.saga.ts +85 -0
  185. package/src/sync/live.saga.test.ts +178 -0
  186. package/src/sync/live.saga.ts +107 -0
  187. package/src/sync/policy.health.test.ts +56 -0
  188. package/src/sync/policy.test.ts +659 -0
  189. package/src/sync/policy.ts +502 -0
  190. package/src/sync/poll.saga.test.ts +51 -0
  191. package/src/sync/poll.saga.ts +36 -0
  192. package/src/sync/tabs.saga.test.ts +74 -0
  193. package/src/sync/tabs.saga.ts +93 -0
  194. package/src/testing/adapters.ts +133 -0
  195. package/src/testing/build.ts +63 -0
  196. package/src/testing/fake-services.ts +34 -0
  197. package/src/testing/run-pure.test.ts +92 -0
  198. package/src/testing/run-pure.ts +128 -0
  199. package/src/testing/services.ts +17 -0
  200. package/src/types.ts +591 -14
  201. package/src/utils/blurhash.ts +90 -0
  202. package/src/utils/error-classification.test.ts +54 -0
  203. package/src/utils/error-classification.ts +25 -0
  204. package/src/utils/index.ts +79 -13
  205. package/src/utils/parser.test.ts +49 -120
  206. package/src/utils/parser.ts +32 -2
  207. package/src/utils/semver.test.ts +32 -0
  208. package/src/utils/semver.ts +30 -0
  209. package/src/utils/surql.ts +30 -18
  210. package/src/utils/utils.test.ts +2 -1
  211. package/src/utils/withRetry.test.ts +1 -1
  212. package/tsdown.config.ts +86 -1
  213. package/vitest.config.ts +48 -0
  214. package/src/modules/cache/index.ts +0 -241
  215. package/src/modules/cache/types.ts +0 -19
  216. package/src/modules/data/data.test.ts +0 -58
  217. package/src/modules/data/index.ts +0 -879
  218. package/src/modules/sync/engine.ts +0 -173
  219. package/src/modules/sync/events/index.ts +0 -77
  220. package/src/modules/sync/index.ts +0 -3
  221. package/src/modules/sync/queue/index.ts +0 -2
  222. package/src/modules/sync/queue/queue-down.ts +0 -89
  223. package/src/modules/sync/queue/queue-up.ts +0 -223
  224. package/src/modules/sync/scheduler.ts +0 -84
  225. package/src/modules/sync/sync.ts +0 -421
  226. package/src/modules/sync/utils.test.ts +0 -311
  227. package/src/modules/sync/utils.ts +0 -167
  228. package/src/spooky.ts +0 -395
@@ -0,0 +1,227 @@
1
+ import type { RemoteDatabaseService } from '../services/database/remote';
2
+ import type { BlobCache, BlobReadOptions, BlobUrlLease } from '../services/blobs/index';
3
+ import {
4
+ blurhashSidecarPath,
5
+ encodeImageToBlurhash,
6
+ isImagePath,
7
+ isBlurhashValid,
8
+ type BlurhashSetting,
9
+ type BlurhashEncodeOptions,
10
+ } from '../utils/blurhash';
11
+
12
+ /** Coerce whatever the `.get()` RPC hands back into a Blob. */
13
+ export function bucketContentToBlob(content: unknown): Blob | null {
14
+ if (content == null) return null;
15
+ if (content instanceof Blob) return content;
16
+ if (typeof content === 'string') return new Blob([content]);
17
+ if (content instanceof ArrayBuffer) return new Blob([content]);
18
+ // Uint8Array and friends. The cast sidesteps `ArrayBufferLike` vs
19
+ // `ArrayBuffer` (SharedArrayBuffer) in lib.dom's BlobPart.
20
+ if (ArrayBuffer.isView(content)) return new Blob([content as unknown as BlobPart]);
21
+ return null;
22
+ }
23
+
24
+ export interface BucketPutOptions {
25
+ /** Override the client-level {@link Sp00kyConfig.blurhash} setting for this put. */
26
+ blurhash?: BlurhashSetting;
27
+ }
28
+
29
+ export interface BucketPutResult {
30
+ /** The computed blurhash when the content was a hashable image; else null. */
31
+ blurhash: string | null;
32
+ }
33
+
34
+ interface BucketHandleSettings {
35
+ blurhash?: BlurhashSetting;
36
+ logger?: { warn: (obj: unknown, msg?: string) => void };
37
+ }
38
+
39
+ /**
40
+ * Paths known to have no blurhash sidecar, per tab. The blob cache has no
41
+ * negative caching, so without this every mount of a hashless image would pay
42
+ * one serialized remote read. Cleared when a put writes a sidecar or a delete
43
+ * removes the image. Keyed `${bucket}:${path}` (the image path, not the sidecar).
44
+ */
45
+ const missingBlurhash = new Set<string>();
46
+
47
+ export class BucketHandle {
48
+ constructor(
49
+ private bucketName: string,
50
+ private remote: RemoteDatabaseService,
51
+ /** Absent on the raw handle the cache itself reads through. */
52
+ private blobs?: BlobCache | null,
53
+ private settings?: BucketHandleSettings
54
+ ) {}
55
+
56
+ /** Effective blurhash setting: per-call option > client config > default ON. */
57
+ private resolveBlurhash(option?: BlurhashSetting): BlurhashEncodeOptions | null {
58
+ const setting = option ?? this.settings?.blurhash ?? true;
59
+ if (setting === false) return null;
60
+ return setting === true ? {} : setting;
61
+ }
62
+
63
+ async put(
64
+ path: string,
65
+ content: string | Uint8Array | Blob,
66
+ options?: BucketPutOptions
67
+ ): Promise<BucketPutResult> {
68
+ // Start hashing while the upload is in flight; both browser-side costs
69
+ // overlap and the sidecar put only queues once the main put resolved.
70
+ const encodeOptions = this.resolveBlurhash(options?.blurhash);
71
+ const hashPromise =
72
+ encodeOptions && isImagePath(path)
73
+ ? encodeImageToBlurhash(content, encodeOptions)
74
+ : Promise.resolve(null);
75
+
76
+ await this.remote.query(`RETURN f"${this.bucketName}:/${path}".put($content);`, { content });
77
+ // A path can be overwritten, so anything cached under it is now wrong.
78
+ await this.blobs?.invalidate({ bucket: this.bucketName, path });
79
+
80
+ // The sidecar is best-effort: a hash or sidecar failure must never fail
81
+ // the image put that triggered it.
82
+ let hash: string | null = null;
83
+ try {
84
+ hash = await hashPromise;
85
+ if (hash) {
86
+ const sidecar = blurhashSidecarPath(path);
87
+ await this.remote.query(`RETURN f"${this.bucketName}:/${sidecar}".put($content);`, {
88
+ content: hash,
89
+ });
90
+ await this.blobs?.invalidate({ bucket: this.bucketName, path: sidecar });
91
+ missingBlurhash.delete(`${this.bucketName}:${path}`);
92
+ }
93
+ } catch (error) {
94
+ hash = null;
95
+ this.settings?.logger?.warn({ error, path }, 'blurhash sidecar put failed');
96
+ }
97
+ return { blurhash: hash };
98
+ }
99
+
100
+ /**
101
+ * The blurhash stored alongside an uploaded image (see
102
+ * {@link blurhashSidecarPath}), or null when there is none. Reads through the
103
+ * blob cache, so a warm client answers from OPFS without a network hop, and
104
+ * misses are remembered per tab so a hashless image costs at most one
105
+ * serialized remote read per session.
106
+ */
107
+ async blurhash(path: string): Promise<string | null> {
108
+ const cacheKey = `${this.bucketName}:${path}`;
109
+ if (missingBlurhash.has(cacheKey)) return null;
110
+ try {
111
+ const blob = await this.read(blurhashSidecarPath(path), { persist: true });
112
+ if (!blob) {
113
+ missingBlurhash.add(cacheKey);
114
+ return null;
115
+ }
116
+ const hash = (await blob.text()).trim();
117
+ if (!isBlurhashValid(hash).result) {
118
+ this.settings?.logger?.warn({ path }, 'blurhash sidecar holds an invalid hash');
119
+ missingBlurhash.add(cacheKey);
120
+ return null;
121
+ }
122
+ return hash;
123
+ } catch (error) {
124
+ // Transient failure: do NOT negative-cache, the next mount may succeed.
125
+ this.settings?.logger?.warn({ error, path }, 'blurhash sidecar read failed');
126
+ return null;
127
+ }
128
+ }
129
+
130
+ async get(path: string): Promise<unknown> {
131
+ const [result] = await this.remote.query<[unknown]>(
132
+ `RETURN f"${this.bucketName}:/${path}".get();`
133
+ );
134
+ return result;
135
+ }
136
+
137
+ /**
138
+ * Read through the local blob cache: OPFS first, the bucket second. Unlike
139
+ * {@link get} this survives a reload and works offline. Returns null when the
140
+ * file exists in neither place.
141
+ */
142
+ async read(path: string, options?: BlobReadOptions): Promise<Blob | null> {
143
+ if (!this.blobs) return bucketContentToBlob(await this.get(path));
144
+ return this.blobs.read({ bucket: this.bucketName, path }, options);
145
+ }
146
+
147
+ /**
148
+ * A refcounted object URL for `path`, suitable for `<img src>`. The caller
149
+ * MUST call `release()` when the URL goes off screen. Returns null when the
150
+ * file does not exist, or when object URLs are unavailable (non-browser).
151
+ */
152
+ async url(path: string, options?: BlobReadOptions): Promise<BlobUrlLease | null> {
153
+ if (!this.blobs) return null;
154
+ return this.blobs.acquireUrl({ bucket: this.bucketName, path }, options);
155
+ }
156
+
157
+ /** Exempt `path` from pressure eviction. Pinned bytes never expire. */
158
+ pin(path: string): void {
159
+ this.blobs?.setPinned({ bucket: this.bucketName, path }, true);
160
+ }
161
+
162
+ unpin(path: string): void {
163
+ this.blobs?.setPinned({ bucket: this.bucketName, path }, false);
164
+ }
165
+
166
+ /** Drop `path` from the local cache without touching the remote file. */
167
+ async evict(path: string): Promise<void> {
168
+ await this.blobs?.invalidate({ bucket: this.bucketName, path });
169
+ }
170
+
171
+ /** Warm the cache for offline use. Already-cached paths are skipped. */
172
+ async prefetch(paths: string[]): Promise<void> {
173
+ await this.blobs?.prefetch(paths.map((path) => ({ bucket: this.bucketName, path })));
174
+ }
175
+
176
+ async delete(path: string): Promise<void> {
177
+ await this.remote.query(`RETURN f"${this.bucketName}:/${path}".delete();`);
178
+ await this.blobs?.invalidate({ bucket: this.bucketName, path });
179
+ // Symmetry with put: an image's blurhash sidecar dies with it. Best-effort,
180
+ // the sidecar may simply not exist.
181
+ if (isImagePath(path)) {
182
+ const sidecar = blurhashSidecarPath(path);
183
+ try {
184
+ await this.remote.query(`RETURN f"${this.bucketName}:/${sidecar}".delete();`);
185
+ await this.blobs?.invalidate({ bucket: this.bucketName, path: sidecar });
186
+ } catch {
187
+ // Nothing to clean up.
188
+ }
189
+ missingBlurhash.delete(`${this.bucketName}:${path}`);
190
+ }
191
+ }
192
+
193
+ async exists(path: string): Promise<boolean> {
194
+ const [result] = await this.remote.query<[boolean]>(
195
+ `RETURN f"${this.bucketName}:/${path}".exists();`
196
+ );
197
+ return result;
198
+ }
199
+
200
+ async head(path: string): Promise<Record<string, unknown>> {
201
+ const [result] = await this.remote.query<[Record<string, unknown>]>(
202
+ `RETURN f"${this.bucketName}:/${path}".head();`
203
+ );
204
+ return result;
205
+ }
206
+
207
+ async copy(sourcePath: string, targetPath: string): Promise<void> {
208
+ await this.remote.query(`RETURN f"${this.bucketName}:/${sourcePath}".copy($target);`, {
209
+ target: targetPath,
210
+ });
211
+ }
212
+
213
+ async rename(sourcePath: string, targetPath: string): Promise<void> {
214
+ await this.remote.query(`RETURN f"${this.bucketName}:/${sourcePath}".rename($target);`, {
215
+ target: targetPath,
216
+ });
217
+ }
218
+
219
+ async list(prefix?: string): Promise<string[]> {
220
+ const p = prefix ?? '';
221
+ const [result] = await this.remote.query<[string[]]>(
222
+ `RETURN f"${this.bucketName}:/${p}".list();`
223
+ );
224
+ return result;
225
+ }
226
+ }
227
+
@@ -0,0 +1,56 @@
1
+ import { describe, expect, it } from 'vitest';
2
+ import type { RuntimeEvent } from '../kernel/events';
3
+ import { defaultEnv } from '../query/env';
4
+ import { route } from './router';
5
+
6
+ const env = defaultEnv({ tables: [] } as any);
7
+
8
+ describe('route', () => {
9
+ it('maps every event to a saga and the documented lane', () => {
10
+ const cases: Array<[RuntimeEvent, string | undefined]> = [
11
+ [{ type: 'EnsureRegistered' }, 'serial:ensure'],
12
+ [{ type: 'RegisterRemote', hash: 'h' }, 'dedupe:register:h'],
13
+ [{ type: 'ReadDirtyMembership' }, 'serial:membership'],
14
+ [{ type: 'ReadMembership', hashes: ['h'] }, 'serial:membership'],
15
+ [{ type: 'FetchRows' }, 'serial:fetch'],
16
+ [{ type: 'Materialize', hash: 'h' }, 'serial:mat:h'],
17
+ [{ type: 'MaterializeDirty' }, undefined],
18
+ [{ type: 'StreamUpdate', update: { queryHash: 'h', localArray: [] } }, 'serial:stream:h'],
19
+ [{ type: 'LifecycleTick' }, 'dedupe:lifecycle'],
20
+ [{ type: 'HeartbeatNow' }, 'dedupe:lifecycle'],
21
+ [{ type: 'AckPrune' }, 'dedupe:ack-prune'],
22
+ [{ type: 'GcTick' }, 'dedupe:gc'],
23
+ [{ type: 'Drain' }, 'serial:outbox'],
24
+ [{ type: 'FlushWrite', key: 'k' }, 'serial:outbox-write'],
25
+ [{ type: 'PollTick' }, 'dedupe:poll'],
26
+ [{ type: 'SelfHealTick' }, 'dedupe:heal'],
27
+ [{ type: 'SyncOutcome', ok: true }, 'serial:health'],
28
+ [{ type: 'ConnectionChanged', state: 'connected' }, 'serial:connection'],
29
+ [{ type: 'LiveStart' }, 'serial:live'],
30
+ [{ type: 'LiveChange', hashes: [] }, 'serial:live-change'],
31
+ [{ type: 'TabRole', role: 'leader' }, 'serial:tabs'],
32
+ [{ type: 'TabMessage', message: {} }, 'serial:tabs'],
33
+ [{ type: 'StartRemote' }, 'dedupe:start-remote'],
34
+ [{ type: 'PrimeCircuit' }, 'dedupe:prime'],
35
+ [{ type: 'VersionsPrimed', entries: [] }, undefined],
36
+ [{ type: 'WarmBlobs' }, 'dedupe:blobs'],
37
+ [{ type: 'AuthFlip', userId: null }, 'serial:bucket'],
38
+ [{ type: 'BucketSwitch', target: 'x' }, 'serial:bucket'],
39
+ [{ type: 'PageHide' }, undefined],
40
+ ];
41
+ for (const [event, lane] of cases) {
42
+ const target = route(env, event);
43
+ expect(typeof target.saga.next).toBe('function');
44
+ expect(target.lane ? `${target.lane.kind}:${target.lane.key}` : undefined).toBe(lane);
45
+ target.saga.return(undefined);
46
+ }
47
+ });
48
+ it('MaterializeDirty fans out one Materialize per dirty hash', async () => {
49
+ const { runPure } = await import('../testing/run-pure');
50
+ const { buildEntry, buildState } = await import('../testing/build');
51
+ const R = await import('../state/reducers');
52
+ const s = R.markDirty(['a', 'b'])(buildState([buildEntry({ def: { hash: 'a' } }), buildEntry({ def: { hash: 'b' } })]));
53
+ const out = await runPure(route(env, { type: 'MaterializeDirty' }).saga, { state: s });
54
+ expect(out.dispatched).toEqual([{ type: 'Materialize', hash: 'a' }, { type: 'Materialize', hash: 'b' }]);
55
+ });
56
+ });
@@ -0,0 +1,96 @@
1
+ import type { RuntimeEvent } from '../kernel/events';
2
+ import type { Lane, Saga } from '../kernel/saga';
3
+ import type { SagaEnv } from '../query/env';
4
+ import { ensureRegistered, registerRemote } from '../query/register.saga';
5
+ import { readDirtyMembership, readMembership, recoverLostView } from '../query/membership.saga';
6
+ import { fetchRows } from '../query/fetch.saga';
7
+ import { materialize, streamUpdate } from '../query/materialize.saga';
8
+ import { ackPrune, gcTick, lifecycleTick } from '../query/lifecycle.saga';
9
+ import { drain } from '../mutation/push.saga';
10
+ import { flushWrite } from '../mutation/write.saga';
11
+ import { pollTick } from '../sync/poll.saga';
12
+ import { liveChange, liveStart } from '../sync/live.saga';
13
+ import { connectionChanged, selfHealTick, syncOutcome } from '../sync/connection.saga';
14
+ import { setRole, tabMessage } from '../sync/tabs.saga';
15
+ import { pageHide, primeCircuit, startRemote, versionsPrimed, warmBlobs } from '../boot/boot.saga';
16
+ import { authFlip } from '../boot/auth-flip.saga';
17
+ import { bucketSwitch } from '../boot/bucket-switch.saga';
18
+ import { fx } from '../kernel/effects';
19
+
20
+ export interface RouteTarget {
21
+ saga: Saga<unknown>;
22
+ lane?: Lane;
23
+ }
24
+
25
+ const serial = (key: string): Lane => ({ kind: 'serial', key });
26
+ const dedupe = (key: string): Lane => ({ kind: 'dedupe', key });
27
+
28
+ function* materializeDirty(): Saga<void> {
29
+ const dirty = (yield fx.state.read((s) => [...s.dirty])) as string[];
30
+ for (const hash of dirty) yield fx.dispatch({ type: 'Materialize', hash });
31
+ }
32
+
33
+ /** One table: which saga handles an event, and on which lane. */
34
+ export function route(env: SagaEnv, event: RuntimeEvent): RouteTarget {
35
+ switch (event.type) {
36
+ case 'EnsureRegistered':
37
+ return { saga: ensureRegistered(env, { requireAuth: event.requireAuth, attempt: event.attempt }), lane: serial('ensure') };
38
+ case 'RegisterRemote':
39
+ return { saga: registerRemote(env, event.hash, event.retry), lane: dedupe(`register:${event.hash}`) };
40
+ case 'RecoverLostView':
41
+ return { saga: recoverLostView(event.hash), lane: dedupe(`view-lost:${event.hash}`) };
42
+ case 'ReadDirtyMembership':
43
+ return { saga: readDirtyMembership(env), lane: serial('membership') };
44
+ case 'ReadMembership':
45
+ return { saga: readMembership(env, event.hashes, { force: true }), lane: serial('membership') };
46
+ case 'FetchRows':
47
+ return { saga: fetchRows(env), lane: serial('fetch') };
48
+ case 'Materialize':
49
+ return { saga: materialize(event.hash), lane: serial(`mat:${event.hash}`) };
50
+ case 'MaterializeDirty':
51
+ return { saga: materializeDirty() };
52
+ case 'StreamUpdate':
53
+ return { saga: streamUpdate(event.update), lane: serial(`stream:${event.update.queryHash}`) };
54
+ case 'LifecycleTick':
55
+ case 'HeartbeatNow':
56
+ return { saga: lifecycleTick(env), lane: dedupe('lifecycle') };
57
+ case 'AckPrune':
58
+ return { saga: ackPrune(), lane: dedupe('ack-prune') };
59
+ case 'GcTick':
60
+ return { saga: gcTick(), lane: dedupe('gc') };
61
+ case 'Drain':
62
+ return { saga: drain(env), lane: serial('outbox') };
63
+ case 'FlushWrite':
64
+ return { saga: flushWrite(env, event.key), lane: serial('outbox-write') };
65
+ case 'PollTick':
66
+ return { saga: pollTick(env), lane: dedupe('poll') };
67
+ case 'SelfHealTick':
68
+ return { saga: selfHealTick(env), lane: dedupe('heal') };
69
+ case 'SyncOutcome':
70
+ return { saga: syncOutcome(env, event.ok, event.error), lane: serial('health') };
71
+ case 'ConnectionChanged':
72
+ return { saga: connectionChanged(env, event.state), lane: serial('connection') };
73
+ case 'LiveStart':
74
+ return { saga: liveStart(env), lane: serial('live') };
75
+ case 'LiveChange':
76
+ return { saga: liveChange(env, event.hashes, event.rows), lane: serial('live-change') };
77
+ case 'TabRole':
78
+ return { saga: setRole(env, event.role), lane: serial('tabs') };
79
+ case 'TabMessage':
80
+ return { saga: tabMessage(env, event.message), lane: serial('tabs') };
81
+ case 'StartRemote':
82
+ return { saga: startRemote(), lane: dedupe('start-remote') };
83
+ case 'PrimeCircuit':
84
+ return { saga: primeCircuit(), lane: dedupe('prime') };
85
+ case 'VersionsPrimed':
86
+ return { saga: versionsPrimed(event.entries) };
87
+ case 'WarmBlobs':
88
+ return { saga: warmBlobs(), lane: dedupe('blobs') };
89
+ case 'AuthFlip':
90
+ return { saga: authFlip(env, event.userId), lane: serial('bucket') };
91
+ case 'BucketSwitch':
92
+ return { saga: bucketSwitch(env, event.target), lane: serial('bucket') };
93
+ case 'PageHide':
94
+ return { saga: pageHide() };
95
+ }
96
+ }
@@ -0,0 +1,192 @@
1
+ import { describe, expect, it } from 'vitest';
2
+ import { fakeAdapters } from '../testing/adapters';
3
+ import { buildEntry, buildState } from '../testing/build';
4
+ import { defaultEnv } from '../query/env';
5
+ import { fx } from '../kernel/effects';
6
+ import type { Saga } from '../kernel/saga';
7
+ import * as R from '../state/reducers';
8
+ import { Runtime } from './runtime';
9
+
10
+ const env = defaultEnv({ tables: [] } as any, { materializeDebounceMs: 5 });
11
+ const noop = () => {};
12
+ const logs: unknown[] = [];
13
+ const logger: any = { debug: noop, info: noop, warn: noop, trace: noop, error: (o: unknown) => logs.push(o), child: () => logger };
14
+ const make = (over: Parameters<typeof fakeAdapters>[0] = {}, initialState = buildState()) => {
15
+ const a = fakeAdapters(over);
16
+ const rt = new Runtime({ env, adapters: a.adapters, logger, tabId: 'tab-a', initialState });
17
+ return { a, rt };
18
+ };
19
+ const tick = () => new Promise((r) => setTimeout(r, 0));
20
+
21
+ describe('Runtime lanes', () => {
22
+ it('serial lanes run one at a time in order; dedupe lanes join the running saga', async () => {
23
+ const { rt } = make();
24
+ const order: string[] = [];
25
+ function* step(name: string, wait: Promise<void>): Saga<string> {
26
+ order.push(`${name}:start`);
27
+ yield fx.state.wait(() => true);
28
+ await0(wait);
29
+ order.push(`${name}:end`);
30
+ return name;
31
+ }
32
+ let release!: () => void;
33
+ const gate = new Promise<void>((r) => (release = r));
34
+ const await0 = (_p: Promise<void>) => undefined;
35
+ const a = rt.run(step('a', gate), { lane: { kind: 'serial', key: 'x' } });
36
+ const b = rt.run(step('b', gate), { lane: { kind: 'serial', key: 'x' } });
37
+ release();
38
+ expect(await a).toBe('a');
39
+ expect(await b).toBe('b');
40
+ expect(order).toEqual(['a:start', 'a:end', 'b:start', 'b:end']);
41
+ let n = 0;
42
+ function* counted(): Saga<number> {
43
+ n++;
44
+ yield fx.state.wait(() => true);
45
+ return n;
46
+ }
47
+ const d1 = rt.run(counted(), { lane: { kind: 'dedupe', key: 'd' } });
48
+ const d2 = rt.run(counted(), { lane: { kind: 'dedupe', key: 'd' } });
49
+ expect(await d1).toBe(1);
50
+ expect(await d2).toBe(1);
51
+ expect(n).toBe(1);
52
+ const d3 = await rt.run(counted(), { lane: { kind: 'dedupe', key: 'd' } });
53
+ expect(d3).toBe(2);
54
+ });
55
+ it('a failing saga on a serial lane does not block the next one; dispatch logs and never rejects', async () => {
56
+ const { rt } = make();
57
+ function* boom(): Saga<void> {
58
+ yield fx.state.wait(() => true);
59
+ throw new Error('nope');
60
+ }
61
+ function* fine(): Saga<string> {
62
+ yield fx.state.wait(() => true);
63
+ return 'ok';
64
+ }
65
+ await expect(rt.run(boom(), { lane: { kind: 'serial', key: 'k' } })).rejects.toThrow('nope');
66
+ expect(await rt.run(fine(), { lane: { kind: 'serial', key: 'k' } })).toBe('ok');
67
+ logs.length = 0;
68
+ await rt.dispatch({ type: 'Materialize', hash: 'missing' });
69
+ await rt.dispatch({ type: 'ReadMembership', hashes: [] });
70
+ expect(logs).toEqual([]);
71
+ });
72
+ });
73
+
74
+ describe('Runtime state hooks', () => {
75
+ it('dirty queries are materialized after the debounce, once per burst', async () => {
76
+ const { a, rt } = make({ local: { select: async () => [{ id: 'thing:1' }] } }, buildState([buildEntry({ def: { hash: 'q', plan: { table: 'thing' } as any } })]));
77
+ const seen: unknown[] = [];
78
+ rt.subscribe('q', (rows) => seen.push(rows));
79
+ rt.update(R.markDirty(['q']));
80
+ rt.update(R.markDirty(['q']));
81
+ expect(a.timers.pending.has('mat:q')).toBe(true);
82
+ a.timers.fire('mat:q');
83
+ await tick();
84
+ await tick();
85
+ expect(seen).toEqual([[{ id: 'thing:1' }]]);
86
+ expect(rt.state.dirty.has('q')).toBe(false);
87
+ });
88
+ it('status and authority subscriptions fire on transitions, immediate delivers the current value', async () => {
89
+ const { rt } = make({}, buildState([buildEntry({ def: { hash: 'q' } })]));
90
+ const statuses: string[] = [];
91
+ const auths: boolean[] = [];
92
+ const offS = rt.subscribeStatus('q', (s) => statuses.push(s), { immediate: true });
93
+ const offA = rt.subscribeAuthority('q', (k) => auths.push(k), { immediate: true });
94
+ const offA2 = rt.subscribeAuthority('q', () => auths.push(false));
95
+ rt.update(R.applyLifecycle('q', { type: 'fetch-begin' }));
96
+ rt.update(R.applyLifecycle('q', { type: 'fetch-begin' }));
97
+ rt.update(R.applyLifecycle('q', { type: 'fetch-end' }));
98
+ rt.update(R.applyLifecycle('q', { type: 'fetch-end' }));
99
+ rt.emit({ type: 'query:authority', hash: 'q', known: true });
100
+ expect(statuses).toEqual(['idle', 'fetching', 'idle']);
101
+ expect(auths).toEqual([false, true, false]);
102
+ offA2();
103
+ offA();
104
+ rt.emit({ type: 'query:authority', hash: 'q', known: false });
105
+ expect(auths).toHaveLength(3);
106
+ offS();
107
+ rt.update(R.applyLifecycle('q', { type: 'fetch-begin' }));
108
+ expect(statuses).toHaveLength(3);
109
+ const missing: string[] = [];
110
+ rt.subscribeStatus('zz', (s) => missing.push(s), { immediate: true });
111
+ rt.subscribeAuthority('zz', () => missing.push('x'), { immediate: true });
112
+ expect(missing).toEqual([]);
113
+ });
114
+ it('notifies health on a transport change, and only on a real move', () => {
115
+ const { rt } = make();
116
+ const seen: string[] = [];
117
+ rt.on('health:changed', (e) => seen.push(e.type === 'health:changed' ? e.health.connection : '?'));
118
+ rt.update(R.setConnection('connected'));
119
+ rt.update(R.setConnection('connected'));
120
+ rt.update(R.setConnection('reconnecting'));
121
+ expect(seen).toEqual(['connected', 'reconnecting']);
122
+ // A health snapshot rebuilt with the same values must not re-notify.
123
+ rt.update(R.setHealth({ ...rt.state.sync.health }));
124
+ expect(seen).toHaveLength(2);
125
+ rt.update(R.setHealth({ ...rt.state.sync.health, status: 'degraded' }));
126
+ expect(seen).toHaveLength(3);
127
+ });
128
+ it('activity, listeners, records subscription bookkeeping, waitFor and dispose', async () => {
129
+ const { a, rt } = make({}, buildState([buildEntry({ def: { hash: 'q' } })]));
130
+ const events: string[] = [];
131
+ const off = rt.on('activity:changed', (e) => events.push(JSON.stringify(e)));
132
+ rt.on('*', (e) => events.push(`*${e.type}`));
133
+ rt.update(R.applyLifecycle('q', { type: 'fetch-begin' }));
134
+ expect(events).toEqual(['{"type":"activity:changed","fetching":1,"pending":0}', '*activity:changed']);
135
+ off();
136
+ const rows: unknown[] = [];
137
+ const unsub = rt.subscribe('q', (r) => rows.push(r), { immediate: true });
138
+ expect(rows).toEqual([[]]);
139
+ expect(rt.state.queries.get('q')!.subscribers).toBe(1);
140
+ rt.emit({ type: 'query:records', hash: 'q', records: [{ id: 1 }] });
141
+ expect(rows).toHaveLength(2);
142
+ unsub();
143
+ unsub();
144
+ expect(rt.state.queries.get('q')!.subscribers).toBe(0);
145
+ expect(rt.state.queries.get('q')!.lastSubscriberLeftAt).toBe(1_700_000_000_000);
146
+ rt.emit({ type: 'log', level: 'warn', message: 'x' });
147
+ rt.subscribe('q', () => {
148
+ throw new Error('subscriber bug');
149
+ });
150
+ rt.emit({ type: 'query:records', hash: 'q', records: [] });
151
+ expect(logs.at(-1)).toMatchObject({ error: new Error('subscriber bug') });
152
+ await expect(rt.waitFor(() => true)).resolves.toBeUndefined();
153
+ const ctrl = new AbortController();
154
+ ctrl.abort();
155
+ await expect(rt.waitFor(() => false, ctrl.signal)).rejects.toThrow('aborted');
156
+ const ctrl2 = new AbortController();
157
+ const p = rt.waitFor(() => false, ctrl2.signal);
158
+ ctrl2.abort();
159
+ await expect(p).rejects.toThrow('aborted');
160
+ await expect(
161
+ rt.waitFor(() => {
162
+ throw new Error('bad selector');
163
+ })
164
+ ).rejects.toThrow('bad selector');
165
+ let calls = 0;
166
+ const throwingLater = rt.waitFor(() => {
167
+ calls++;
168
+ if (calls > 1) throw new Error('bad selector later');
169
+ return false;
170
+ });
171
+ rt.update(R.setFailedCount(1));
172
+ await expect(throwingLater).rejects.toThrow('bad selector later');
173
+ const pending = rt.waitFor(() => false);
174
+ a.timers.pending.clear();
175
+ rt.update(R.markDirty(['q']));
176
+ expect(a.timers.pending.has('mat:q')).toBe(true);
177
+ rt.dispose();
178
+ await expect(pending).rejects.toThrow('disposed');
179
+ expect(a.timers.pending.size).toBe(0);
180
+ await rt.dispatch({ type: 'PollTick' });
181
+ expect(rt.update(R.setFailedCount(1))).toBeUndefined();
182
+ });
183
+ it('a disposed runtime ignores late timer fires', async () => {
184
+ const { a, rt } = make({}, buildState([buildEntry({ def: { hash: 'q' } })]));
185
+ rt.update(R.markDirty(['q']));
186
+ const fire = a.timers.pending.get('mat:q')!.fire;
187
+ rt.dispose();
188
+ fire();
189
+ await tick();
190
+ expect(rt.state.dirty.has('q')).toBe(true);
191
+ });
192
+ });