@spooky-sync/core 0.0.0-canary.1 → 0.0.1-alpha.1
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.
- package/AGENTS.md +74 -0
- package/README.md +56 -16
- package/dist/index.d.ts +2178 -411
- package/dist/index.js +12503 -2475
- package/dist/otel/index.d.ts +21 -0
- package/dist/otel/index.js +86 -0
- package/dist/sqlite-open.js +322 -0
- package/dist/sqlite-worker.d.ts +1 -0
- package/dist/sqlite-worker.js +439 -0
- package/dist/tabs-broker-worker.d.ts +8 -0
- package/dist/tabs-broker-worker.js +472 -0
- package/dist/types.d.ts +1060 -0
- package/package.json +49 -12
- package/scripts/check-broker-bundle.mjs +33 -0
- package/skills/sp00ky-core/SKILL.md +276 -0
- package/skills/sp00ky-core/references/auth.md +98 -0
- package/skills/sp00ky-core/references/config.md +76 -0
- package/src/boot/auth-flip.saga.test.ts +82 -0
- package/src/boot/auth-flip.saga.ts +62 -0
- package/src/boot/boot.saga.test.ts +151 -0
- package/src/boot/boot.saga.ts +128 -0
- package/src/boot/bucket-switch.saga.test.ts +158 -0
- package/src/boot/bucket-switch.saga.ts +115 -0
- package/src/boot/preload.saga.test.ts +51 -0
- package/src/boot/preload.saga.ts +31 -0
- package/src/bucket-blurhash.test.ts +148 -0
- package/src/build-globals.d.ts +12 -0
- package/src/client/bucket-handle.test.ts +117 -0
- package/src/client/bucket-handle.ts +227 -0
- package/src/client/router.test.ts +56 -0
- package/src/client/router.ts +94 -0
- package/src/client/runtime.test.ts +178 -0
- package/src/client/runtime.ts +285 -0
- package/src/client/services.ts +349 -0
- package/src/client/sp00ky-client.test.ts +241 -0
- package/src/client/sp00ky-client.ts +482 -0
- package/src/events/events.test.ts +2 -1
- package/src/events/index.ts +3 -0
- package/src/index.ts +37 -1
- package/src/kernel/constants.test.ts +19 -0
- package/src/kernel/constants.ts +54 -0
- package/src/kernel/effects.test.ts +40 -0
- package/src/kernel/effects.ts +159 -0
- package/src/kernel/events.ts +55 -0
- package/src/kernel/interpreter.test.ts +116 -0
- package/src/kernel/interpreter.ts +143 -0
- package/src/kernel/saga.test.ts +89 -0
- package/src/kernel/saga.ts +73 -0
- package/src/modules/app-release/index.test.ts +125 -0
- package/src/modules/app-release/index.ts +209 -0
- package/src/modules/auth/auth.local-first.test.ts +141 -0
- package/src/modules/auth/events/index.ts +2 -1
- package/src/modules/auth/index.ts +138 -25
- package/src/modules/crdt/crdt-field.ts +294 -0
- package/src/modules/crdt/crdt-hydration.test.ts +210 -0
- package/src/modules/crdt/crdt-reconnect.test.ts +195 -0
- package/src/modules/crdt/index.ts +463 -0
- package/src/modules/crdt/loro-loader.ts +25 -0
- package/src/modules/devtools/flags.ts +349 -0
- package/src/modules/devtools/index.ts +459 -47
- package/src/modules/devtools/notify-throttle.test.ts +154 -0
- package/src/modules/devtools/state-shape.test.ts +149 -0
- package/src/modules/devtools/storage-info.test.ts +79 -0
- package/src/modules/devtools/storage-info.ts +168 -0
- package/src/modules/devtools/versions.test.ts +74 -0
- package/src/modules/devtools/versions.ts +110 -0
- package/src/modules/feature-flag/index.test.ts +251 -0
- package/src/modules/feature-flag/index.ts +316 -0
- package/src/modules/ref-tables.test.ts +91 -0
- package/src/modules/ref-tables.ts +88 -0
- package/src/mutation/jobs.test.ts +25 -0
- package/src/mutation/jobs.ts +41 -0
- package/src/mutation/mutation-id.test.ts +37 -0
- package/src/mutation/mutation-id.ts +35 -0
- package/src/mutation/push.saga.test.ts +285 -0
- package/src/mutation/push.saga.ts +215 -0
- package/src/mutation/rows.test.ts +201 -0
- package/src/mutation/rows.ts +377 -0
- package/src/mutation/tray.saga.test.ts +63 -0
- package/src/mutation/tray.saga.ts +48 -0
- package/src/mutation/write.saga.test.ts +163 -0
- package/src/mutation/write.saga.ts +166 -0
- package/src/otel/index.ts +127 -0
- package/src/query/env.test.ts +23 -0
- package/src/query/env.ts +56 -0
- package/src/query/fetch.saga.test.ts +156 -0
- package/src/query/fetch.saga.ts +109 -0
- package/src/query/hash.test.ts +14 -0
- package/src/query/hash.ts +18 -0
- package/src/query/id-set-plan.test.ts +132 -0
- package/src/query/lifecycle.saga.test.ts +122 -0
- package/src/query/lifecycle.saga.ts +101 -0
- package/src/query/materialize.saga.test.ts +82 -0
- package/src/query/materialize.saga.ts +75 -0
- package/src/query/materialize.test.ts +50 -0
- package/src/query/materialize.ts +44 -0
- package/src/query/membership.saga.test.ts +246 -0
- package/src/query/membership.saga.ts +208 -0
- package/src/query/membership.test.ts +118 -0
- package/src/query/membership.ts +158 -0
- package/src/query/register.saga.test.ts +251 -0
- package/src/query/register.saga.ts +190 -0
- package/src/query/render-set.test.ts +36 -0
- package/src/query/render-set.ts +60 -0
- package/src/query/sql.test.ts +62 -0
- package/src/query/sql.ts +79 -0
- package/src/query/window-query.test.ts +70 -0
- package/src/query/window-query.ts +195 -0
- package/src/services/blobs/blob-cache.test.ts +359 -0
- package/src/services/blobs/blob-cache.ts +603 -0
- package/src/services/blobs/blob-manifest.ts +227 -0
- package/src/services/blobs/blob-store.test.ts +77 -0
- package/src/services/blobs/blob-store.ts +359 -0
- package/src/services/blobs/blob.fixture.ts +90 -0
- package/src/services/blobs/index.ts +70 -0
- package/src/services/database/cache-engine.ts +193 -0
- package/src/services/database/connection-supervisor.test.ts +289 -0
- package/src/services/database/connection-supervisor.ts +415 -0
- package/src/services/database/database.query-timeout.test.ts +140 -0
- package/src/services/database/database.responses.test.ts +43 -0
- package/src/services/database/database.ts +145 -62
- package/src/services/database/engine-factory.ts +33 -0
- package/src/services/database/errors.ts +34 -0
- package/src/services/database/events/index.ts +2 -1
- package/src/services/database/index.ts +7 -0
- package/src/services/database/local-migrator.ts +30 -27
- package/src/services/database/local.test.ts +64 -0
- package/src/services/database/local.ts +484 -67
- package/src/services/database/plan-render.test.ts +159 -0
- package/src/services/database/plan-render.ts +108 -0
- package/src/services/database/relation-resolver.test.ts +467 -0
- package/src/services/database/relation-resolver.ts +0 -0
- package/src/services/database/remote.ts +222 -15
- package/src/services/database/sqlite-cache-engine.test.ts +617 -0
- package/src/services/database/sqlite-cache-engine.timeout.test.ts +61 -0
- package/src/services/database/sqlite-cache-engine.ts +1349 -0
- package/src/services/database/sqlite-devtools-queries.integration.test.ts +143 -0
- package/src/services/database/sqlite-devtools-queries.test.ts +154 -0
- package/src/services/database/sqlite-lock-verify.test.ts +33 -0
- package/src/services/database/sqlite-lock-verify.ts +45 -0
- package/src/services/database/sqlite-open.test.ts +150 -0
- package/src/services/database/sqlite-open.ts +164 -0
- package/src/services/database/sqlite-plan-sql.test.ts +104 -0
- package/src/services/database/sqlite-plan-sql.ts +138 -0
- package/src/services/database/sqlite-projection.test.ts +99 -0
- package/src/services/database/sqlite-select.integration.test.ts +185 -0
- package/src/services/database/sqlite-select.test.ts +246 -0
- package/src/services/database/sqlite-select.ts +131 -0
- package/src/services/database/sqlite-transport.fixture.ts +30 -0
- package/src/services/database/sqlite-transport.ts +224 -0
- package/src/services/database/sqlite-worker.ts +437 -0
- package/src/services/database/surql-translate.ts +416 -0
- package/src/services/database/surreal-cache-engine.ts +161 -0
- package/src/services/logger/index.ts +6 -101
- package/src/services/persistence/localstorage.ts +2 -2
- package/src/services/persistence/resilient.ts +41 -0
- package/src/services/persistence/surrealdb.ts +10 -10
- package/src/services/stream-processor/index.ts +796 -84
- package/src/services/stream-processor/permissions.test.ts +47 -0
- package/src/services/stream-processor/permissions.ts +53 -0
- package/src/services/stream-processor/stream-processor.batch.test.ts +186 -0
- package/src/services/stream-processor/stream-processor.prime.test.ts +198 -0
- package/src/services/stream-processor/stream-processor.reset.test.ts +226 -0
- package/src/services/stream-processor/stream-processor.test.ts +1 -1
- package/src/services/stream-processor/wasm-types.ts +59 -3
- package/src/services/tabs/broker-client.ts +283 -0
- package/src/services/tabs/broker.test.ts +327 -0
- package/src/services/tabs/coordinator.test.ts +365 -0
- package/src/services/tabs/coordinator.ts +633 -0
- package/src/services/tabs/fake-ports.fixture.ts +112 -0
- package/src/services/tabs/leader-locks.ts +75 -0
- package/src/services/tabs/protocol.ts +262 -0
- package/src/services/tabs/support.ts +36 -0
- package/src/services/tabs/tabs-broker-worker.ts +640 -0
- package/src/sp00ky.ts +5 -0
- package/src/state/client-state.ts +184 -0
- package/src/state/lifecycle.test.ts +118 -0
- package/src/state/lifecycle.ts +86 -0
- package/src/state/reducers.test.ts +280 -0
- package/src/state/reducers.ts +462 -0
- package/src/state/selectors.test.ts +149 -0
- package/src/state/selectors.ts +184 -0
- package/src/sync/connection.saga.test.ts +84 -0
- package/src/sync/connection.saga.ts +86 -0
- package/src/sync/live.saga.test.ts +69 -0
- package/src/sync/live.saga.ts +49 -0
- package/src/sync/policy.health.test.ts +56 -0
- package/src/sync/policy.test.ts +659 -0
- package/src/sync/policy.ts +507 -0
- package/src/sync/poll.saga.test.ts +51 -0
- package/src/sync/poll.saga.ts +36 -0
- package/src/sync/tabs.saga.test.ts +74 -0
- package/src/sync/tabs.saga.ts +92 -0
- package/src/testing/adapters.ts +133 -0
- package/src/testing/build.ts +61 -0
- package/src/testing/fake-services.ts +34 -0
- package/src/testing/run-pure.test.ts +92 -0
- package/src/testing/run-pure.ts +128 -0
- package/src/testing/services.ts +17 -0
- package/src/types.ts +557 -16
- package/src/utils/blurhash.ts +90 -0
- package/src/utils/error-classification.test.ts +54 -0
- package/src/utils/error-classification.ts +25 -0
- package/src/utils/index.ts +86 -13
- package/src/utils/parser.test.ts +49 -120
- package/src/utils/parser.ts +32 -2
- package/src/utils/semver.test.ts +32 -0
- package/src/utils/semver.ts +30 -0
- package/src/utils/surql.ts +30 -18
- package/src/utils/utils.test.ts +2 -1
- package/src/utils/withRetry.test.ts +1 -1
- package/tsdown.config.ts +86 -1
- package/vitest.config.ts +48 -0
- package/src/modules/cache/index.ts +0 -241
- package/src/modules/cache/types.ts +0 -19
- package/src/modules/data/data.test.ts +0 -58
- package/src/modules/data/index.ts +0 -777
- package/src/modules/sync/engine.ts +0 -163
- package/src/modules/sync/events/index.ts +0 -77
- package/src/modules/sync/index.ts +0 -3
- package/src/modules/sync/queue/index.ts +0 -2
- package/src/modules/sync/queue/queue-down.ts +0 -89
- package/src/modules/sync/queue/queue-up.ts +0 -223
- package/src/modules/sync/scheduler.ts +0 -84
- package/src/modules/sync/sync.ts +0 -407
- package/src/modules/sync/utils.test.ts +0 -311
- package/src/modules/sync/utils.ts +0 -171
- package/src/spooky.ts +0 -346
|
@@ -0,0 +1,94 @@
|
|
|
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 } 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 'ReadDirtyMembership':
|
|
41
|
+
return { saga: readDirtyMembership(env), lane: serial('membership') };
|
|
42
|
+
case 'ReadMembership':
|
|
43
|
+
return { saga: readMembership(env, event.hashes, { force: true }), lane: serial('membership') };
|
|
44
|
+
case 'FetchRows':
|
|
45
|
+
return { saga: fetchRows(env), lane: serial('fetch') };
|
|
46
|
+
case 'Materialize':
|
|
47
|
+
return { saga: materialize(event.hash), lane: serial(`mat:${event.hash}`) };
|
|
48
|
+
case 'MaterializeDirty':
|
|
49
|
+
return { saga: materializeDirty() };
|
|
50
|
+
case 'StreamUpdate':
|
|
51
|
+
return { saga: streamUpdate(event.update), lane: serial(`stream:${event.update.queryHash}`) };
|
|
52
|
+
case 'LifecycleTick':
|
|
53
|
+
case 'HeartbeatNow':
|
|
54
|
+
return { saga: lifecycleTick(env), lane: dedupe('lifecycle') };
|
|
55
|
+
case 'AckPrune':
|
|
56
|
+
return { saga: ackPrune(), lane: dedupe('ack-prune') };
|
|
57
|
+
case 'GcTick':
|
|
58
|
+
return { saga: gcTick(), lane: dedupe('gc') };
|
|
59
|
+
case 'Drain':
|
|
60
|
+
return { saga: drain(env), lane: serial('outbox') };
|
|
61
|
+
case 'FlushWrite':
|
|
62
|
+
return { saga: flushWrite(env, event.key), lane: serial('outbox-write') };
|
|
63
|
+
case 'PollTick':
|
|
64
|
+
return { saga: pollTick(env), lane: dedupe('poll') };
|
|
65
|
+
case 'SelfHealTick':
|
|
66
|
+
return { saga: selfHealTick(env), lane: dedupe('heal') };
|
|
67
|
+
case 'SyncOutcome':
|
|
68
|
+
return { saga: syncOutcome(env, event.ok, event.error), lane: serial('health') };
|
|
69
|
+
case 'ConnectionChanged':
|
|
70
|
+
return { saga: connectionChanged(env, event.state), lane: serial('connection') };
|
|
71
|
+
case 'LiveStart':
|
|
72
|
+
return { saga: liveStart(env), lane: serial('live') };
|
|
73
|
+
case 'LiveChange':
|
|
74
|
+
return { saga: liveChange(event.hashes), lane: serial('live-change') };
|
|
75
|
+
case 'TabRole':
|
|
76
|
+
return { saga: setRole(env, event.role), lane: serial('tabs') };
|
|
77
|
+
case 'TabMessage':
|
|
78
|
+
return { saga: tabMessage(env, event.message), lane: serial('tabs') };
|
|
79
|
+
case 'StartRemote':
|
|
80
|
+
return { saga: startRemote(), lane: dedupe('start-remote') };
|
|
81
|
+
case 'PrimeCircuit':
|
|
82
|
+
return { saga: primeCircuit(), lane: dedupe('prime') };
|
|
83
|
+
case 'VersionsPrimed':
|
|
84
|
+
return { saga: versionsPrimed(event.entries) };
|
|
85
|
+
case 'WarmBlobs':
|
|
86
|
+
return { saga: warmBlobs(), lane: dedupe('blobs') };
|
|
87
|
+
case 'AuthFlip':
|
|
88
|
+
return { saga: authFlip(env, event.userId), lane: serial('bucket') };
|
|
89
|
+
case 'BucketSwitch':
|
|
90
|
+
return { saga: bucketSwitch(env, event.target), lane: serial('bucket') };
|
|
91
|
+
case 'PageHide':
|
|
92
|
+
return { saga: pageHide() };
|
|
93
|
+
}
|
|
94
|
+
}
|
|
@@ -0,0 +1,178 @@
|
|
|
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('activity, listeners, records subscription bookkeeping, waitFor and dispose', async () => {
|
|
115
|
+
const { a, rt } = make({}, buildState([buildEntry({ def: { hash: 'q' } })]));
|
|
116
|
+
const events: string[] = [];
|
|
117
|
+
const off = rt.on('activity:changed', (e) => events.push(JSON.stringify(e)));
|
|
118
|
+
rt.on('*', (e) => events.push(`*${e.type}`));
|
|
119
|
+
rt.update(R.applyLifecycle('q', { type: 'fetch-begin' }));
|
|
120
|
+
expect(events).toEqual(['{"type":"activity:changed","fetching":1,"pending":0}', '*activity:changed']);
|
|
121
|
+
off();
|
|
122
|
+
const rows: unknown[] = [];
|
|
123
|
+
const unsub = rt.subscribe('q', (r) => rows.push(r), { immediate: true });
|
|
124
|
+
expect(rows).toEqual([[]]);
|
|
125
|
+
expect(rt.state.queries.get('q')!.subscribers).toBe(1);
|
|
126
|
+
rt.emit({ type: 'query:records', hash: 'q', records: [{ id: 1 }] });
|
|
127
|
+
expect(rows).toHaveLength(2);
|
|
128
|
+
unsub();
|
|
129
|
+
unsub();
|
|
130
|
+
expect(rt.state.queries.get('q')!.subscribers).toBe(0);
|
|
131
|
+
expect(rt.state.queries.get('q')!.lastSubscriberLeftAt).toBe(1_700_000_000_000);
|
|
132
|
+
rt.emit({ type: 'log', level: 'warn', message: 'x' });
|
|
133
|
+
rt.subscribe('q', () => {
|
|
134
|
+
throw new Error('subscriber bug');
|
|
135
|
+
});
|
|
136
|
+
rt.emit({ type: 'query:records', hash: 'q', records: [] });
|
|
137
|
+
expect(logs.at(-1)).toMatchObject({ error: new Error('subscriber bug') });
|
|
138
|
+
await expect(rt.waitFor(() => true)).resolves.toBeUndefined();
|
|
139
|
+
const ctrl = new AbortController();
|
|
140
|
+
ctrl.abort();
|
|
141
|
+
await expect(rt.waitFor(() => false, ctrl.signal)).rejects.toThrow('aborted');
|
|
142
|
+
const ctrl2 = new AbortController();
|
|
143
|
+
const p = rt.waitFor(() => false, ctrl2.signal);
|
|
144
|
+
ctrl2.abort();
|
|
145
|
+
await expect(p).rejects.toThrow('aborted');
|
|
146
|
+
await expect(
|
|
147
|
+
rt.waitFor(() => {
|
|
148
|
+
throw new Error('bad selector');
|
|
149
|
+
})
|
|
150
|
+
).rejects.toThrow('bad selector');
|
|
151
|
+
let calls = 0;
|
|
152
|
+
const throwingLater = rt.waitFor(() => {
|
|
153
|
+
calls++;
|
|
154
|
+
if (calls > 1) throw new Error('bad selector later');
|
|
155
|
+
return false;
|
|
156
|
+
});
|
|
157
|
+
rt.update(R.setFailedCount(1));
|
|
158
|
+
await expect(throwingLater).rejects.toThrow('bad selector later');
|
|
159
|
+
const pending = rt.waitFor(() => false);
|
|
160
|
+
a.timers.pending.clear();
|
|
161
|
+
rt.update(R.markDirty(['q']));
|
|
162
|
+
expect(a.timers.pending.has('mat:q')).toBe(true);
|
|
163
|
+
rt.dispose();
|
|
164
|
+
await expect(pending).rejects.toThrow('disposed');
|
|
165
|
+
expect(a.timers.pending.size).toBe(0);
|
|
166
|
+
await rt.dispatch({ type: 'PollTick' });
|
|
167
|
+
expect(rt.update(R.setFailedCount(1))).toBeUndefined();
|
|
168
|
+
});
|
|
169
|
+
it('a disposed runtime ignores late timer fires', async () => {
|
|
170
|
+
const { a, rt } = make({}, buildState([buildEntry({ def: { hash: 'q' } })]));
|
|
171
|
+
rt.update(R.markDirty(['q']));
|
|
172
|
+
const fire = a.timers.pending.get('mat:q')!.fire;
|
|
173
|
+
rt.dispose();
|
|
174
|
+
fire();
|
|
175
|
+
await tick();
|
|
176
|
+
expect(rt.state.dirty.has('q')).toBe(true);
|
|
177
|
+
});
|
|
178
|
+
});
|
|
@@ -0,0 +1,285 @@
|
|
|
1
|
+
import type { Logger } from '../services/logger/index';
|
|
2
|
+
import type { QueryAuthorityCallback, QueryHash, QueryStatus, QueryStatusCallback, QueryUpdateCallback } from '../types';
|
|
3
|
+
import type { OutEvent, RuntimeEvent } from '../kernel/events';
|
|
4
|
+
import type { Adapters, Interpreter } from '../kernel/interpreter';
|
|
5
|
+
import { createInterpreter } from '../kernel/interpreter';
|
|
6
|
+
import type { Lane, Saga } from '../kernel/saga';
|
|
7
|
+
import { runSaga } from '../kernel/saga';
|
|
8
|
+
import type { ClientState } from '../state/client-state';
|
|
9
|
+
import { emptyState } from '../state/client-state';
|
|
10
|
+
import { deriveStatus, isAuthoritative } from '../state/lifecycle';
|
|
11
|
+
import * as R from '../state/reducers';
|
|
12
|
+
import { fetchingQueryCount, pendingMutationCount } from '../state/selectors';
|
|
13
|
+
import type { SagaEnv } from '../query/env';
|
|
14
|
+
import { route } from './router';
|
|
15
|
+
|
|
16
|
+
interface Waiter {
|
|
17
|
+
until: (s: ClientState) => boolean;
|
|
18
|
+
resolve: () => void;
|
|
19
|
+
reject: (e: unknown) => void;
|
|
20
|
+
}
|
|
21
|
+
|
|
22
|
+
export interface RuntimeOptions {
|
|
23
|
+
env: SagaEnv;
|
|
24
|
+
adapters: Adapters;
|
|
25
|
+
logger: Logger;
|
|
26
|
+
tabId: string;
|
|
27
|
+
initialState?: ClientState;
|
|
28
|
+
}
|
|
29
|
+
|
|
30
|
+
/**
|
|
31
|
+
* The one effectful object of the engine: holds the state, runs sagas on
|
|
32
|
+
* lanes, fires timers, fans events out to subscribers and schedules
|
|
33
|
+
* materialization for dirty queries. No decision logic lives here.
|
|
34
|
+
*/
|
|
35
|
+
export class Runtime {
|
|
36
|
+
private stateValue: ClientState;
|
|
37
|
+
private readonly interpret: Interpreter;
|
|
38
|
+
private readonly env: SagaEnv;
|
|
39
|
+
private readonly adapters: Adapters;
|
|
40
|
+
private readonly logger: Logger;
|
|
41
|
+
private readonly serialLanes = new Map<string, Promise<unknown>>();
|
|
42
|
+
private readonly dedupeLanes = new Map<string, Promise<unknown>>();
|
|
43
|
+
private readonly waiters = new Set<Waiter>();
|
|
44
|
+
private readonly recordSubs = new Map<QueryHash, Set<QueryUpdateCallback>>();
|
|
45
|
+
private readonly statusSubs = new Map<QueryHash, Set<QueryStatusCallback>>();
|
|
46
|
+
private readonly authoritySubs = new Map<QueryHash, Set<QueryAuthorityCallback>>();
|
|
47
|
+
private readonly lastStatus = new Map<QueryHash, QueryStatus>();
|
|
48
|
+
private readonly listeners = new Map<string, Set<(event: OutEvent) => void>>();
|
|
49
|
+
private readonly scheduledMaterialize = new Set<QueryHash>();
|
|
50
|
+
private readonly timerKeys = new Set<string>();
|
|
51
|
+
private lastActivity = { fetching: 0, pending: 0 };
|
|
52
|
+
private disposed = false;
|
|
53
|
+
|
|
54
|
+
constructor(opts: RuntimeOptions) {
|
|
55
|
+
this.env = opts.env;
|
|
56
|
+
this.logger = opts.logger;
|
|
57
|
+
this.stateValue = opts.initialState ?? emptyState({ tabId: opts.tabId });
|
|
58
|
+
const timers = opts.adapters.timers;
|
|
59
|
+
this.adapters = {
|
|
60
|
+
...opts.adapters,
|
|
61
|
+
timers: {
|
|
62
|
+
set: (key, ms, fire) => {
|
|
63
|
+
this.timerKeys.add(key);
|
|
64
|
+
timers.set(key, ms, () => {
|
|
65
|
+
this.timerKeys.delete(key);
|
|
66
|
+
if (!this.disposed) fire();
|
|
67
|
+
});
|
|
68
|
+
},
|
|
69
|
+
clear: (key) => {
|
|
70
|
+
this.timerKeys.delete(key);
|
|
71
|
+
timers.clear(key);
|
|
72
|
+
},
|
|
73
|
+
},
|
|
74
|
+
};
|
|
75
|
+
this.interpret = createInterpreter(this.adapters, {
|
|
76
|
+
getState: () => this.stateValue,
|
|
77
|
+
setState: (next) => this.setState(next),
|
|
78
|
+
waitFor: (until, signal) => this.waitFor(until, signal),
|
|
79
|
+
emit: (event) => this.emit(event),
|
|
80
|
+
dispatch: (event) => void this.dispatch(event),
|
|
81
|
+
});
|
|
82
|
+
}
|
|
83
|
+
|
|
84
|
+
get state(): ClientState {
|
|
85
|
+
return this.stateValue;
|
|
86
|
+
}
|
|
87
|
+
|
|
88
|
+
/** Run a saga, optionally on a lane. Rejections propagate to the caller. */
|
|
89
|
+
run<R>(saga: Saga<R>, opts: { lane?: Lane; signal?: AbortSignal } = {}): Promise<R> {
|
|
90
|
+
const exec = () => runSaga(saga, (effect) => this.interpret(effect, { signal: opts.signal }));
|
|
91
|
+
const lane = opts.lane;
|
|
92
|
+
if (!lane) return exec();
|
|
93
|
+
if (lane.kind === 'dedupe') {
|
|
94
|
+
const running = this.dedupeLanes.get(lane.key);
|
|
95
|
+
if (running) return running as Promise<R>;
|
|
96
|
+
const p = exec().finally(() => {
|
|
97
|
+
if (this.dedupeLanes.get(lane.key) === p) this.dedupeLanes.delete(lane.key);
|
|
98
|
+
});
|
|
99
|
+
this.dedupeLanes.set(lane.key, p);
|
|
100
|
+
return p;
|
|
101
|
+
}
|
|
102
|
+
const prev = this.serialLanes.get(lane.key) ?? Promise.resolve();
|
|
103
|
+
const p = prev.then(exec, exec);
|
|
104
|
+
const tail = p.catch(() => undefined);
|
|
105
|
+
this.serialLanes.set(lane.key, tail);
|
|
106
|
+
void tail.then(() => {
|
|
107
|
+
if (this.serialLanes.get(lane.key) === tail) this.serialLanes.delete(lane.key);
|
|
108
|
+
});
|
|
109
|
+
return p;
|
|
110
|
+
}
|
|
111
|
+
|
|
112
|
+
/** Route an event to its saga. Never rejects: failures are logged. */
|
|
113
|
+
dispatch(event: RuntimeEvent): Promise<void> {
|
|
114
|
+
if (this.disposed) return Promise.resolve();
|
|
115
|
+
const target = route(this.env, event);
|
|
116
|
+
return this.run(target.saga, { lane: target.lane }).then(
|
|
117
|
+
() => undefined,
|
|
118
|
+
(error) => {
|
|
119
|
+
this.logger.error({ error, event: event.type, Category: 'sp00ky-client::Runtime::dispatch' }, 'saga failed');
|
|
120
|
+
}
|
|
121
|
+
);
|
|
122
|
+
}
|
|
123
|
+
|
|
124
|
+
private setState(next: ClientState): void {
|
|
125
|
+
const prev = this.stateValue;
|
|
126
|
+
if (next === prev) return;
|
|
127
|
+
this.stateValue = next;
|
|
128
|
+
for (const w of [...this.waiters]) {
|
|
129
|
+
let ok = false;
|
|
130
|
+
try {
|
|
131
|
+
ok = w.until(next);
|
|
132
|
+
} catch (error) {
|
|
133
|
+
this.waiters.delete(w);
|
|
134
|
+
w.reject(error);
|
|
135
|
+
continue;
|
|
136
|
+
}
|
|
137
|
+
if (ok) {
|
|
138
|
+
this.waiters.delete(w);
|
|
139
|
+
w.resolve();
|
|
140
|
+
}
|
|
141
|
+
}
|
|
142
|
+
for (const hash of next.dirty) {
|
|
143
|
+
if (this.scheduledMaterialize.has(hash)) continue;
|
|
144
|
+
this.scheduledMaterialize.add(hash);
|
|
145
|
+
this.adapters.timers.set(`mat:${hash}`, this.env.materializeDebounceMs, () => {
|
|
146
|
+
this.scheduledMaterialize.delete(hash);
|
|
147
|
+
void this.dispatch({ type: 'Materialize', hash });
|
|
148
|
+
});
|
|
149
|
+
}
|
|
150
|
+
for (const [hash, subs] of this.statusSubs) {
|
|
151
|
+
const entry = next.queries.get(hash);
|
|
152
|
+
if (!entry) continue;
|
|
153
|
+
const status = deriveStatus(entry.lifecycle);
|
|
154
|
+
if (this.lastStatus.get(hash) === status) continue;
|
|
155
|
+
this.lastStatus.set(hash, status);
|
|
156
|
+
for (const cb of subs) this.safely(() => cb(status));
|
|
157
|
+
this.notify({ type: 'query:status', hash, status });
|
|
158
|
+
}
|
|
159
|
+
const activity = { fetching: fetchingQueryCount(next), pending: pendingMutationCount(next) };
|
|
160
|
+
if (activity.fetching !== this.lastActivity.fetching || activity.pending !== this.lastActivity.pending) {
|
|
161
|
+
this.lastActivity = activity;
|
|
162
|
+
this.notify({ type: 'activity:changed', ...activity });
|
|
163
|
+
}
|
|
164
|
+
}
|
|
165
|
+
|
|
166
|
+
waitFor(until: (s: ClientState) => boolean, signal?: AbortSignal): Promise<void> {
|
|
167
|
+
try {
|
|
168
|
+
if (until(this.stateValue)) return Promise.resolve();
|
|
169
|
+
} catch (error) {
|
|
170
|
+
return Promise.reject(error);
|
|
171
|
+
}
|
|
172
|
+
if (signal?.aborted) return Promise.reject(new Error('aborted'));
|
|
173
|
+
return new Promise<void>((resolve, reject) => {
|
|
174
|
+
const waiter: Waiter = { until, resolve, reject };
|
|
175
|
+
this.waiters.add(waiter);
|
|
176
|
+
signal?.addEventListener(
|
|
177
|
+
'abort',
|
|
178
|
+
() => {
|
|
179
|
+
if (this.waiters.delete(waiter)) reject(new Error('aborted'));
|
|
180
|
+
},
|
|
181
|
+
{ once: true }
|
|
182
|
+
);
|
|
183
|
+
});
|
|
184
|
+
}
|
|
185
|
+
|
|
186
|
+
/** Deliver an outbound event to its subscribers and listeners. */
|
|
187
|
+
emit(event: OutEvent): void {
|
|
188
|
+
switch (event.type) {
|
|
189
|
+
case 'query:records':
|
|
190
|
+
for (const cb of this.recordSubs.get(event.hash) ?? []) this.safely(() => cb(event.records as Record<string, any>[]));
|
|
191
|
+
break;
|
|
192
|
+
case 'query:authority':
|
|
193
|
+
for (const cb of this.authoritySubs.get(event.hash) ?? []) this.safely(() => cb(event.known));
|
|
194
|
+
break;
|
|
195
|
+
case 'log':
|
|
196
|
+
this.logger[event.level](Object.assign({}, event.data as object | undefined, { Category: 'sp00ky-client::saga' }), event.message);
|
|
197
|
+
break;
|
|
198
|
+
default:
|
|
199
|
+
break;
|
|
200
|
+
}
|
|
201
|
+
this.notify(event);
|
|
202
|
+
}
|
|
203
|
+
|
|
204
|
+
private notify(event: OutEvent): void {
|
|
205
|
+
for (const cb of this.listeners.get(event.type) ?? []) this.safely(() => cb(event));
|
|
206
|
+
for (const cb of this.listeners.get('*') ?? []) this.safely(() => cb(event));
|
|
207
|
+
}
|
|
208
|
+
|
|
209
|
+
private safely(fn: () => void): void {
|
|
210
|
+
try {
|
|
211
|
+
fn();
|
|
212
|
+
} catch (error) {
|
|
213
|
+
this.logger.error({ error, Category: 'sp00ky-client::Runtime::subscriber' }, 'subscriber threw');
|
|
214
|
+
}
|
|
215
|
+
}
|
|
216
|
+
|
|
217
|
+
/** Observe outbound events by type (`'*'` for all). */
|
|
218
|
+
on(type: OutEvent['type'] | '*', cb: (event: OutEvent) => void): () => void {
|
|
219
|
+
const set = this.listeners.get(type) ?? new Set();
|
|
220
|
+
set.add(cb);
|
|
221
|
+
this.listeners.set(type, set);
|
|
222
|
+
return () => void set.delete(cb);
|
|
223
|
+
}
|
|
224
|
+
|
|
225
|
+
subscribe(hash: QueryHash, cb: QueryUpdateCallback, options: { immediate?: boolean } = {}): () => void {
|
|
226
|
+
const set = this.recordSubs.get(hash) ?? new Set();
|
|
227
|
+
set.add(cb);
|
|
228
|
+
this.recordSubs.set(hash, set);
|
|
229
|
+
this.setState(R.subscribe(hash)(this.stateValue));
|
|
230
|
+
if (options.immediate) {
|
|
231
|
+
const entry = this.stateValue.queries.get(hash);
|
|
232
|
+
if (entry) this.safely(() => cb(entry.records as Record<string, any>[]));
|
|
233
|
+
}
|
|
234
|
+
return () => {
|
|
235
|
+
if (!set.delete(cb)) return;
|
|
236
|
+
if (set.size === 0) this.recordSubs.delete(hash);
|
|
237
|
+
this.setState(R.unsubscribe(hash, this.adapters.clock.now())(this.stateValue));
|
|
238
|
+
};
|
|
239
|
+
}
|
|
240
|
+
|
|
241
|
+
subscribeStatus(hash: QueryHash, cb: QueryStatusCallback, options: { immediate?: boolean } = {}): () => void {
|
|
242
|
+
const set = this.statusSubs.get(hash) ?? new Set();
|
|
243
|
+
set.add(cb);
|
|
244
|
+
this.statusSubs.set(hash, set);
|
|
245
|
+
const entry = this.stateValue.queries.get(hash);
|
|
246
|
+
if (entry) {
|
|
247
|
+
const status = deriveStatus(entry.lifecycle);
|
|
248
|
+
this.lastStatus.set(hash, status);
|
|
249
|
+
if (options.immediate) this.safely(() => cb(status));
|
|
250
|
+
}
|
|
251
|
+
return () => {
|
|
252
|
+
set.delete(cb);
|
|
253
|
+
if (set.size === 0) {
|
|
254
|
+
this.statusSubs.delete(hash);
|
|
255
|
+
this.lastStatus.delete(hash);
|
|
256
|
+
}
|
|
257
|
+
};
|
|
258
|
+
}
|
|
259
|
+
|
|
260
|
+
subscribeAuthority(hash: QueryHash, cb: QueryAuthorityCallback, options: { immediate?: boolean } = {}): () => void {
|
|
261
|
+
const set = this.authoritySubs.get(hash) ?? new Set();
|
|
262
|
+
set.add(cb);
|
|
263
|
+
this.authoritySubs.set(hash, set);
|
|
264
|
+
if (options.immediate) {
|
|
265
|
+
const entry = this.stateValue.queries.get(hash);
|
|
266
|
+
if (entry) this.safely(() => cb(isAuthoritative(entry.lifecycle)));
|
|
267
|
+
}
|
|
268
|
+
return () => {
|
|
269
|
+
set.delete(cb);
|
|
270
|
+
if (set.size === 0) this.authoritySubs.delete(hash);
|
|
271
|
+
};
|
|
272
|
+
}
|
|
273
|
+
|
|
274
|
+
/** Apply a reducer outside a saga (facade conveniences such as timing reports). */
|
|
275
|
+
update(reducer: (s: ClientState) => ClientState): void {
|
|
276
|
+
this.setState(reducer(this.stateValue));
|
|
277
|
+
}
|
|
278
|
+
|
|
279
|
+
dispose(): void {
|
|
280
|
+
this.disposed = true;
|
|
281
|
+
for (const key of [...this.timerKeys]) this.adapters.timers.clear(key);
|
|
282
|
+
for (const w of this.waiters) w.reject(new Error('runtime disposed'));
|
|
283
|
+
this.waiters.clear();
|
|
284
|
+
}
|
|
285
|
+
}
|