@dxos/feed 0.0.0 → 0.8.4-main.1068cf700f

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 (38) hide show
  1. package/README.md +7 -2
  2. package/dist/lib/neutral/chunk-UOP2Q6KY.mjs +744 -0
  3. package/dist/lib/neutral/chunk-UOP2Q6KY.mjs.map +7 -0
  4. package/dist/lib/neutral/index.mjs +17 -0
  5. package/dist/lib/neutral/index.mjs.map +7 -0
  6. package/dist/lib/neutral/meta.json +1 -0
  7. package/dist/lib/neutral/testing/index.mjs +173 -0
  8. package/dist/lib/neutral/testing/index.mjs.map +7 -0
  9. package/dist/types/src/errors.d.ts +106 -0
  10. package/dist/types/src/errors.d.ts.map +1 -0
  11. package/dist/types/src/feed-store.d.ts +86 -0
  12. package/dist/types/src/feed-store.d.ts.map +1 -0
  13. package/dist/types/src/feed-store.test.d.ts +2 -0
  14. package/dist/types/src/feed-store.test.d.ts.map +1 -0
  15. package/dist/types/src/index.d.ts +5 -0
  16. package/dist/types/src/index.d.ts.map +1 -0
  17. package/dist/types/src/sync-client.d.ts +53 -0
  18. package/dist/types/src/sync-client.d.ts.map +1 -0
  19. package/dist/types/src/sync-server.d.ts +27 -0
  20. package/dist/types/src/sync-server.d.ts.map +1 -0
  21. package/dist/types/src/sync.test.d.ts +2 -0
  22. package/dist/types/src/sync.test.d.ts.map +1 -0
  23. package/dist/types/src/testing/index.d.ts +2 -0
  24. package/dist/types/src/testing/index.d.ts.map +1 -0
  25. package/dist/types/src/testing/test-builder.d.ts +78 -0
  26. package/dist/types/src/testing/test-builder.d.ts.map +1 -0
  27. package/dist/types/tsconfig.tsbuildinfo +1 -0
  28. package/package.json +20 -13
  29. package/src/errors.ts +38 -0
  30. package/src/feed-store.test.ts +283 -35
  31. package/src/feed-store.ts +479 -132
  32. package/src/index.ts +3 -1
  33. package/src/sync-client.ts +188 -0
  34. package/src/sync-server.ts +92 -0
  35. package/src/sync.test.ts +151 -91
  36. package/src/testing/index.ts +1 -1
  37. package/src/testing/test-builder.ts +223 -0
  38. package/src/protocol.ts +0 -110
@@ -0,0 +1,223 @@
1
+ //
2
+ // Copyright 2026 DXOS.org
3
+ //
4
+
5
+ import type * as SqlClient from '@effect/sql/SqlClient';
6
+ import * as Statement from '@effect/sql/Statement';
7
+ import * as Array from 'effect/Array';
8
+ import * as Effect from 'effect/Effect';
9
+ import * as Layer from 'effect/Layer';
10
+ import * as ManagedRuntime from 'effect/ManagedRuntime';
11
+
12
+ import { Resource } from '@dxos/context';
13
+ import { RuntimeProvider } from '@dxos/effect';
14
+ import { type SpaceId } from '@dxos/keys';
15
+ import { FeedProtocol } from '@dxos/protocols';
16
+ import { SqlTransaction } from '@dxos/sql-sqlite';
17
+ import { layerMemory } from '@dxos/sql-sqlite/platform';
18
+ import * as SqlExport from '@dxos/sql-sqlite/SqlExport';
19
+
20
+ import { FeedStore } from '../feed-store';
21
+ import { SyncClient } from '../sync-client';
22
+ import { SyncServer } from '../sync-server';
23
+
24
+ type ProtocolMessage = FeedProtocol.ProtocolMessage;
25
+ const WellKnownNamespaces = FeedProtocol.WellKnownNamespaces;
26
+ type AppendRequest = FeedProtocol.AppendRequest;
27
+ type QueryRequest = FeedProtocol.QueryRequest;
28
+
29
+ export class TestBuilder extends Resource {
30
+ #peers: TestPeer[] = [];
31
+ readonly #spaceId: SpaceId;
32
+ readonly #feedNamespace: string;
33
+
34
+ constructor({
35
+ numPeers,
36
+ spaceId,
37
+ feedNamespace = WellKnownNamespaces.data,
38
+ logSql = false,
39
+ }: {
40
+ numPeers: number;
41
+ spaceId: SpaceId;
42
+ feedNamespace?: string;
43
+ logSql?: boolean;
44
+ }) {
45
+ super();
46
+ this.#spaceId = spaceId;
47
+ this.#feedNamespace = feedNamespace;
48
+ this.#peers = Array.makeBy(
49
+ numPeers,
50
+ (i) =>
51
+ new TestPeer({
52
+ isServer: i === 0,
53
+ actorId: `peer-${i}`,
54
+ serverPeerId: i === 0 ? undefined : 'peer-0',
55
+ sendMessage: (msg) => this.#routeMessage(msg),
56
+ logSql,
57
+ }),
58
+ );
59
+ }
60
+
61
+ get peers() {
62
+ return this.#peers;
63
+ }
64
+
65
+ get server() {
66
+ return this.#peers[0];
67
+ }
68
+
69
+ protected override async _open(): Promise<void> {
70
+ await Promise.all(this.#peers.map((peer) => peer.open()));
71
+ }
72
+
73
+ protected override async _close(): Promise<void> {
74
+ await Promise.all(this.#peers.map((peer) => peer.close()));
75
+ }
76
+
77
+ async pull(client: TestPeer, { limit = 10 }: { limit?: number } = {}): Promise<{ done: boolean }> {
78
+ return client.pull({ spaceId: this.#spaceId, feedNamespace: this.#feedNamespace, limit });
79
+ }
80
+
81
+ async push(client: TestPeer, { limit = 10 }: { limit?: number } = {}): Promise<{ done: boolean }> {
82
+ return client.push({ spaceId: this.#spaceId, feedNamespace: this.#feedNamespace, limit });
83
+ }
84
+
85
+ /** Route a message to the peer identified by recipientPeerId. Runs the recipient's handleMessage with that peer's runtime. */
86
+ #routeMessage(msg: ProtocolMessage): Effect.Effect<void, unknown, never> {
87
+ const peer = this.#peers.find((p) => p.peerId === msg.recipientPeerId);
88
+ if (peer == null) {
89
+ return Effect.die(new Error(`TestPeer not found: ${msg.recipientPeerId}`));
90
+ }
91
+ const handleEffect =
92
+ peer.syncServer != null
93
+ ? peer.syncServer.handleMessage(msg)
94
+ : peer.syncClient != null
95
+ ? peer.syncClient.handleMessage(msg)
96
+ : null;
97
+ if (handleEffect == null) {
98
+ return Effect.die(new Error(`TestPeer has no handler: ${msg.recipientPeerId}`));
99
+ }
100
+ return Effect.promise(() => RuntimeProvider.runPromise(peer.runtime.runtimeEffect)(handleEffect));
101
+ }
102
+ }
103
+
104
+ const loggingTransformer: Statement.Statement.Transformer = (stmt, _make, _, _span) =>
105
+ Effect.sync(() => {
106
+ const [sql, params] = stmt.compile();
107
+ console.log(sql.trim());
108
+ console.log(params);
109
+ return stmt;
110
+ });
111
+
112
+ export class TestPeer extends Resource {
113
+ readonly #peerId: string;
114
+ #feedStore: FeedStore;
115
+ #runtime: ManagedRuntime.ManagedRuntime<
116
+ SqlClient.SqlClient | SqlExport.SqlExport | SqlTransaction.SqlTransaction,
117
+ never
118
+ >;
119
+ #client?: SyncClient;
120
+ #server?: SyncServer;
121
+
122
+ constructor({
123
+ isServer,
124
+ actorId,
125
+ serverPeerId,
126
+ sendMessage,
127
+ logSql = false,
128
+ }: {
129
+ isServer: boolean;
130
+ actorId: string;
131
+ serverPeerId?: string;
132
+ sendMessage: (msg: ProtocolMessage) => Effect.Effect<void, unknown, never>;
133
+ logSql?: boolean;
134
+ }) {
135
+ super();
136
+ this.#peerId = actorId;
137
+ this.#feedStore = new FeedStore({ localActorId: actorId, assignPositions: isServer });
138
+ const baseLayer = layerMemory.pipe(
139
+ Layer.provide(logSql ? Statement.setTransformer(loggingTransformer) : Layer.empty),
140
+ );
141
+ const transactionLayer = SqlTransaction.layer.pipe(Layer.provide(baseLayer));
142
+ this.#runtime = ManagedRuntime.make(Layer.merge(baseLayer, transactionLayer).pipe(Layer.orDie));
143
+ if (isServer) {
144
+ this.#server = new SyncServer({
145
+ peerId: actorId,
146
+ feedStore: this.#feedStore,
147
+ sendMessage,
148
+ });
149
+ } else {
150
+ this.#client = new SyncClient({
151
+ peerId: actorId,
152
+ serverPeerId: serverPeerId!,
153
+ feedStore: this.#feedStore,
154
+ sendMessage,
155
+ });
156
+ }
157
+ }
158
+
159
+ get peerId() {
160
+ return this.#peerId;
161
+ }
162
+
163
+ get feedStore() {
164
+ return this.#feedStore;
165
+ }
166
+
167
+ get runtime() {
168
+ return this.#runtime;
169
+ }
170
+
171
+ get syncClient() {
172
+ return this.#client;
173
+ }
174
+
175
+ get syncServer() {
176
+ return this.#server;
177
+ }
178
+
179
+ protected override async _open(): Promise<void> {
180
+ await this.#feedStore.migrate().pipe(RuntimeProvider.runPromise(this.#runtime.runtimeEffect));
181
+ }
182
+
183
+ protected override async _close(): Promise<void> {
184
+ await this.#runtime.dispose();
185
+ }
186
+
187
+ export(): Promise<Uint8Array> {
188
+ return Effect.gen(function* () {
189
+ const sql = yield* SqlExport.SqlExport;
190
+ return yield* sql.export;
191
+ }).pipe(RuntimeProvider.runPromise(this.#runtime.runtimeEffect));
192
+ }
193
+
194
+ getSyncState({ spaceId, feedNamespace }: { spaceId: SpaceId; feedNamespace: string }) {
195
+ return this.#feedStore
196
+ .getSyncState({ spaceId, feedNamespace })
197
+ .pipe(RuntimeProvider.runPromise(this.#runtime.runtimeEffect));
198
+ }
199
+
200
+ query(req: QueryRequest) {
201
+ return this.#feedStore.query(req).pipe(RuntimeProvider.runPromise(this.#runtime.runtimeEffect));
202
+ }
203
+
204
+ append(req: AppendRequest) {
205
+ return this.#feedStore.append(req).pipe(RuntimeProvider.runPromise(this.#runtime.runtimeEffect));
206
+ }
207
+
208
+ appendLocal(req: Parameters<FeedStore['appendLocal']>[0]) {
209
+ return this.#feedStore.appendLocal(req).pipe(RuntimeProvider.runPromise(this.#runtime.runtimeEffect));
210
+ }
211
+
212
+ pull({ spaceId, feedNamespace, limit = 10 }: { spaceId: SpaceId; feedNamespace: string; limit?: number }) {
213
+ return this.#client!.pull({ spaceId, feedNamespace, limit }).pipe(
214
+ RuntimeProvider.runPromise(this.#runtime.runtimeEffect),
215
+ );
216
+ }
217
+
218
+ push({ spaceId, feedNamespace, limit = 10 }: { spaceId: SpaceId; feedNamespace: string; limit?: number }) {
219
+ return this.#client!.push({ spaceId, feedNamespace, limit }).pipe(
220
+ RuntimeProvider.runPromise(this.#runtime.runtimeEffect),
221
+ );
222
+ }
223
+ }
package/src/protocol.ts DELETED
@@ -1,110 +0,0 @@
1
- //
2
- // Copyright 2026 DXOS.org
3
- //
4
-
5
- import * as Schema from 'effect/Schema';
6
-
7
- export const FeedCursor = Schema.String.pipe(Schema.brand('@dxos/feed/FeedCursor'));
8
- export type FeedCursor = Schema.Schema.Type<typeof FeedCursor>;
9
-
10
- export const Block = Schema.Struct({
11
- /**
12
- * Only set on query.
13
- */
14
- feedId: Schema.UndefinedOr(Schema.String),
15
-
16
- actorId: Schema.String,
17
- sequence: Schema.Number,
18
- predActorId: Schema.NullOr(Schema.String),
19
- predSequence: Schema.NullOr(Schema.Number),
20
- position: Schema.NullOr(Schema.Number),
21
- timestamp: Schema.Number,
22
- data: Schema.Uint8Array,
23
-
24
- /**
25
- * Local insertion ID.
26
- * Not replicated.
27
- */
28
- // TODO(dmaretskyi): Remove. Use cursors.
29
- insertionId: Schema.optional(Schema.Number),
30
- });
31
- export interface Block extends Schema.Schema.Type<typeof Block> {}
32
-
33
- //
34
- // RPC Schemas
35
- //
36
-
37
- // Request is a union of query by subscription or query by feedIds
38
- export const QueryRequest = Schema.Struct({
39
- requestId: Schema.optional(Schema.String),
40
-
41
- // TODO(dmaretskyi): Make required.
42
- spaceId: Schema.optional(Schema.String),
43
-
44
- query: Schema.Union(
45
- Schema.Struct({
46
- feedIds: Schema.Array(Schema.String),
47
- }),
48
- Schema.Struct({
49
- subscriptionId: Schema.String,
50
- }),
51
- Schema.Struct({
52
- feedNamespace: Schema.optional(Schema.String),
53
- }),
54
- ),
55
- /**
56
- * Get changes following this cursor (exclusive).
57
- *
58
- * Must not be used with `position`.
59
- */
60
- cursor: Schema.optional(FeedCursor),
61
-
62
- /**
63
- * Get changes following this position.
64
- *
65
- * Must not be used with `cursor`.
66
- */
67
- position: Schema.optional(Schema.Number),
68
-
69
- limit: Schema.optional(Schema.Number),
70
- });
71
- export interface QueryRequest extends Schema.Schema.Type<typeof QueryRequest> {}
72
-
73
- // Response is a stream/array of blocks
74
- export const QueryResponse = Schema.Struct({
75
- requestId: Schema.optional(Schema.String),
76
- nextCursor: FeedCursor,
77
- blocks: Schema.Array(Block),
78
- });
79
- export interface QueryResponse extends Schema.Schema.Type<typeof QueryResponse> {}
80
-
81
- export const SubscribeRequest = Schema.Struct({
82
- requestId: Schema.optional(Schema.String),
83
- feedIds: Schema.Array(Schema.String),
84
- spaceId: Schema.optional(Schema.String),
85
- });
86
- export interface SubscribeRequest extends Schema.Schema.Type<typeof SubscribeRequest> {}
87
-
88
- export const SubscribeResponse = Schema.Struct({
89
- requestId: Schema.optional(Schema.String),
90
- subscriptionId: Schema.String,
91
- expiresAt: Schema.Number,
92
- });
93
- export interface SubscribeResponse extends Schema.Schema.Type<typeof SubscribeResponse> {}
94
-
95
- export const AppendRequest = Schema.Struct({
96
- requestId: Schema.optional(Schema.String),
97
-
98
- spaceId: Schema.String,
99
- namespace: Schema.String,
100
- feedId: Schema.String,
101
-
102
- blocks: Schema.Array(Block),
103
- });
104
- export interface AppendRequest extends Schema.Schema.Type<typeof AppendRequest> {}
105
-
106
- export const AppendResponse = Schema.Struct({
107
- requestId: Schema.optional(Schema.String),
108
- positions: Schema.Array(Schema.Number),
109
- });
110
- export interface AppendResponse extends Schema.Schema.Type<typeof AppendResponse> {}