@livestore/adapter-web 0.4.0 → 0.5.0-dev.0

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 (63) hide show
  1. package/dist/.tsbuildinfo +1 -1
  2. package/dist/in-memory/in-memory-adapter.d.ts +6 -8
  3. package/dist/in-memory/in-memory-adapter.d.ts.map +1 -1
  4. package/dist/in-memory/in-memory-adapter.js +30 -26
  5. package/dist/in-memory/in-memory-adapter.js.map +1 -1
  6. package/dist/single-tab/single-tab-adapter.d.ts.map +1 -1
  7. package/dist/single-tab/single-tab-adapter.js +47 -66
  8. package/dist/single-tab/single-tab-adapter.js.map +1 -1
  9. package/dist/web-worker/client-session/client-session-devtools.d.ts +3 -4
  10. package/dist/web-worker/client-session/client-session-devtools.d.ts.map +1 -1
  11. package/dist/web-worker/client-session/client-session-devtools.js +7 -5
  12. package/dist/web-worker/client-session/client-session-devtools.js.map +1 -1
  13. package/dist/web-worker/client-session/devtools-web-channel.d.ts +20 -0
  14. package/dist/web-worker/client-session/devtools-web-channel.d.ts.map +1 -0
  15. package/dist/web-worker/client-session/devtools-web-channel.js +34 -0
  16. package/dist/web-worker/client-session/devtools-web-channel.js.map +1 -0
  17. package/dist/web-worker/client-session/persisted-adapter.d.ts.map +1 -1
  18. package/dist/web-worker/client-session/persisted-adapter.js +57 -64
  19. package/dist/web-worker/client-session/persisted-adapter.js.map +1 -1
  20. package/dist/web-worker/common/persisted-sqlite.d.ts +8 -10
  21. package/dist/web-worker/common/persisted-sqlite.d.ts.map +1 -1
  22. package/dist/web-worker/common/persisted-sqlite.js +15 -24
  23. package/dist/web-worker/common/persisted-sqlite.js.map +1 -1
  24. package/dist/web-worker/common/rpc-worker.d.ts +14 -0
  25. package/dist/web-worker/common/rpc-worker.d.ts.map +1 -0
  26. package/dist/web-worker/common/rpc-worker.js +8 -0
  27. package/dist/web-worker/common/rpc-worker.js.map +1 -0
  28. package/dist/web-worker/common/webmesh-node-names.d.ts +4 -0
  29. package/dist/web-worker/common/webmesh-node-names.d.ts.map +1 -0
  30. package/dist/web-worker/common/webmesh-node-names.js +2 -0
  31. package/dist/web-worker/common/webmesh-node-names.js.map +1 -0
  32. package/dist/web-worker/common/worker-disconnect-channel.d.ts +1 -4
  33. package/dist/web-worker/common/worker-disconnect-channel.d.ts.map +1 -1
  34. package/dist/web-worker/common/worker-disconnect-channel.js +1 -2
  35. package/dist/web-worker/common/worker-disconnect-channel.js.map +1 -1
  36. package/dist/web-worker/common/worker-schema.d.ts +264 -209
  37. package/dist/web-worker/common/worker-schema.d.ts.map +1 -1
  38. package/dist/web-worker/common/worker-schema.js +68 -51
  39. package/dist/web-worker/common/worker-schema.js.map +1 -1
  40. package/dist/web-worker/leader-worker/make-leader-worker.d.ts +6 -8
  41. package/dist/web-worker/leader-worker/make-leader-worker.d.ts.map +1 -1
  42. package/dist/web-worker/leader-worker/make-leader-worker.js +142 -91
  43. package/dist/web-worker/leader-worker/make-leader-worker.js.map +1 -1
  44. package/dist/web-worker/shared-worker/make-shared-worker.d.ts +2 -2
  45. package/dist/web-worker/shared-worker/make-shared-worker.d.ts.map +1 -1
  46. package/dist/web-worker/shared-worker/make-shared-worker.js +50 -63
  47. package/dist/web-worker/shared-worker/make-shared-worker.js.map +1 -1
  48. package/dist/web-worker/vite-dev-polyfill.js +1 -2
  49. package/dist/web-worker/vite-dev-polyfill.js.map +1 -1
  50. package/package.json +14 -24
  51. package/src/in-memory/in-memory-adapter.ts +66 -58
  52. package/src/single-tab/single-tab-adapter.ts +95 -95
  53. package/src/web-worker/client-session/client-session-devtools.ts +16 -8
  54. package/src/web-worker/client-session/devtools-web-channel.ts +57 -0
  55. package/src/web-worker/client-session/persisted-adapter.ts +105 -105
  56. package/src/web-worker/common/persisted-sqlite.ts +41 -48
  57. package/src/web-worker/common/rpc-worker.ts +39 -0
  58. package/src/web-worker/common/webmesh-node-names.ts +1 -0
  59. package/src/web-worker/common/worker-disconnect-channel.ts +1 -1
  60. package/src/web-worker/common/worker-schema.ts +128 -161
  61. package/src/web-worker/leader-worker/make-leader-worker.ts +344 -219
  62. package/src/web-worker/shared-worker/make-shared-worker.ts +93 -84
  63. package/src/web-worker/vite-dev-polyfill.ts +1 -2
@@ -1,7 +1,6 @@
1
- import { Devtools, isWorkerTransportError, LogConfig, liveStoreVersion, UnknownError } from '@livestore/common'
2
- import * as DevtoolsWeb from '@livestore/devtools-web-common/web-channel'
3
- import * as WebmeshWorker from '@livestore/devtools-web-common/worker'
4
- import { isDevEnv, isNotUndefined, LS_DEV } from '@livestore/utils'
1
+ import type { LogConfig } from '@livestore/common'
2
+ import { Devtools, liveStoreVersion, UnknownError } from '@livestore/common'
3
+ import { isDevEnv, LS_DEV } from '@livestore/utils'
5
4
  import {
6
5
  Deferred,
7
6
  Effect,
@@ -9,19 +8,23 @@ import {
9
8
  FetchHttpClient,
10
9
  identity,
11
10
  Layer,
12
- Option,
13
11
  Ref,
12
+ References,
13
+ RpcClient,
14
+ RpcServer,
15
+ RpcWorker,
14
16
  Schema,
15
17
  Scope,
16
18
  Stream,
17
19
  SubscriptionRef,
18
20
  TaskTracing,
19
- Worker,
20
- WorkerRunner,
21
21
  } from '@livestore/utils/effect'
22
22
  import { BrowserWorker, BrowserWorkerRunner } from '@livestore/utils/effect/browser'
23
+ import * as WebmeshWorker from '@livestore/webmesh/worker'
23
24
 
25
+ import { dieOnRpcClientError, dieOnRpcClientErrorStream, makeWebmeshWorkerProxy } from '../common/rpc-worker.ts'
24
26
  import { makeShutdownChannel } from '../common/shutdown-channel.ts'
27
+ import { makeSharedWorkerNodeName } from '../common/webmesh-node-names.ts'
25
28
  import * as WorkerSchema from '../common/worker-schema.ts'
26
29
 
27
30
  // Extract from `livestore-shared-worker-${storeId}`
@@ -47,47 +50,43 @@ if (isDevEnv() === true) {
47
50
  }
48
51
  }
49
52
 
50
- // @effect-diagnostics-next-line anyUnknownInErrorContext:off -- `SerializedRunner.Handlers` uses `any` in the R channel, propagating as `unknown` in `HandlersContext`
51
53
  const makeWorkerRunner = Effect.gen(function* () {
52
- const leaderWorkerContextSubRef = yield* SubscriptionRef.make<
53
- | {
54
- worker: Worker.SerializedWorkerPool<WorkerSchema.LeaderWorkerInnerRequest>
55
- scope: Scope.CloseableScope
56
- }
57
- | undefined
58
- >(undefined)
54
+ type LeaderWorkerContext = {
55
+ client: RpcClient.FromGroup<typeof WorkerSchema.LeaderWorkerInnerRpcs>
56
+ scope: Scope.Closeable
57
+ }
59
58
 
60
- const waitForWorker = SubscriptionRef.waitUntil(leaderWorkerContextSubRef, isNotUndefined).pipe(
61
- Effect.map((_) => _.worker),
62
- )
59
+ const leaderWorkerContextSubRef = yield* SubscriptionRef.make<LeaderWorkerContext | undefined>(undefined)
60
+
61
+ const isLeaderWorkerContext = (context: LeaderWorkerContext | undefined): context is LeaderWorkerContext =>
62
+ context !== undefined
63
63
 
64
- const forwardRequest = <A, I, E, EI, R>(
65
- req: WorkerSchema.LeaderWorkerInnerRequest & Schema.WithResult<A, I, E, EI, R>,
64
+ const waitForWorker = SubscriptionRef.waitUntil(leaderWorkerContextSubRef, isLeaderWorkerContext)
65
+
66
+ const forwardRequest = <A, E, R>(
67
+ tag: string,
68
+ f: (client: RpcClient.FromGroup<typeof WorkerSchema.LeaderWorkerInnerRpcs>) => Effect.Effect<A, E, R>,
66
69
  ): Effect.Effect<A, E, R> =>
67
70
  // Forward the request to the active worker and convert transport errors to defects.
68
71
  waitForWorker.pipe(
69
- // Effect.logBefore(`forwardRequest: ${req._tag}`),
70
- Effect.andThen((worker) => worker.executeEffect(req)),
71
- Effect.catchIf(isWorkerTransportError, (e) => Effect.die(e)),
72
- // Effect.tap((_) => Effect.log(`forwardRequest: ${req._tag}`, _)),
73
- // Effect.tapError((cause) => Effect.logError(`forwardRequest err: ${req._tag}`, cause)),
72
+ Effect.flatMap(({ client }) => f(client)),
73
+ dieOnRpcClientError,
74
74
  Effect.interruptible,
75
75
  Effect.logWarnIfTakesLongerThan({
76
- label: `@livestore/adapter-web:shared-worker:forwardRequest:${req._tag}`,
76
+ label: `@livestore/adapter-web:shared-worker:forwardRequest:${tag}`,
77
77
  duration: 500,
78
78
  }),
79
79
  Effect.tapCauseLogPretty,
80
80
  )
81
81
 
82
- const forwardRequestStream = <A, I, E, EI, R>(
83
- req: WorkerSchema.LeaderWorkerInnerRequest & Schema.WithResult<A, I, E, EI, R>,
82
+ const forwardRequestStream = <A, E, R>(
83
+ tag: string,
84
+ f: (client: RpcClient.FromGroup<typeof WorkerSchema.LeaderWorkerInnerRpcs>) => Stream.Stream<A, E, R>,
84
85
  ): Stream.Stream<A, E, R> =>
85
86
  Effect.gen(function* () {
86
- yield* Effect.logDebug(`forwardRequestStream: ${req._tag}`)
87
- const { worker, scope } = yield* SubscriptionRef.waitUntil(leaderWorkerContextSubRef, isNotUndefined)
88
- const stream = worker.execute(req).pipe(
89
- Stream.refineOrDie((e) => isWorkerTransportError(e) === true ? Option.none() : Option.some(e)),
90
- )
87
+ yield* Effect.logDebug(`forwardRequestStream: ${tag}`)
88
+ const { client, scope } = yield* SubscriptionRef.waitUntil(leaderWorkerContextSubRef, isLeaderWorkerContext)
89
+ const stream = f(client).pipe(dieOnRpcClientErrorStream)
91
90
  // It seems the request stream is not automatically interrupted when the scope shuts down
92
91
  // so we need to manually interrupt it when the scope shuts down
93
92
  const shutdownDeferred = yield* Deferred.make<void>()
@@ -95,7 +94,7 @@ const makeWorkerRunner = Effect.gen(function* () {
95
94
 
96
95
  // Here we're creating an empty stream that will finish when the scope shuts down
97
96
  const scopeShutdownStream = Effect.gen(function* () {
98
- yield* shutdownDeferred
97
+ yield* Deferred.await(shutdownDeferred)
99
98
  return Stream.empty
100
99
  }).pipe(Stream.unwrap)
101
100
 
@@ -104,7 +103,7 @@ const makeWorkerRunner = Effect.gen(function* () {
104
103
  Effect.interruptible,
105
104
  Effect.tapCauseLogPretty,
106
105
  Stream.unwrap,
107
- Stream.ensuring(Effect.logDebug(`shutting down stream for ${req._tag}`)),
106
+ Stream.ensuring(Effect.logDebug(`shutting down stream for ${tag}`)),
108
107
  )
109
108
 
110
109
  const resetCurrentWorkerCtx = Effect.gen(function* () {
@@ -113,7 +112,7 @@ const makeWorkerRunner = Effect.gen(function* () {
113
112
  // NOTE we're already unsetting the current worker here, so new incoming requests are queued for the new worker
114
113
  yield* SubscriptionRef.set(leaderWorkerContextSubRef, undefined)
115
114
 
116
- yield* Effect.yieldNow()
115
+ yield* Effect.yieldNow
117
116
 
118
117
  yield* Scope.close(prevWorker.scope, Exit.void).pipe(
119
118
  Effect.logWarnIfTakesLongerThan({
@@ -136,16 +135,15 @@ const makeWorkerRunner = Effect.gen(function* () {
136
135
  const InvariantsSchema = Schema.Struct({
137
136
  storeId: Schema.String,
138
137
  storageOptions: WorkerSchema.StorageType,
139
- syncPayloadEncoded: Schema.UndefinedOr(Schema.JsonValue),
138
+ syncPayloadEncoded: Schema.UndefinedOr(Schema.Json),
140
139
  liveStoreVersion: Schema.Literal(liveStoreVersion),
141
140
  devtoolsEnabled: Schema.Boolean,
142
141
  })
143
142
  type Invariants = typeof InvariantsSchema.Type
144
143
  const invariantsRef = yield* Ref.make<Invariants | undefined>(undefined)
145
- const sameInvariants = Schema.equivalence(InvariantsSchema)
144
+ const sameInvariants = Schema.toEquivalence(InvariantsSchema)
146
145
 
147
- // @effect-diagnostics-next-line anyUnknownInErrorContext:off -- `SerializedRunner.Handlers` uses `any` in the R channel
148
- return WorkerRunner.layerSerialized(WorkerSchema.SharedWorkerRequest, {
146
+ return WorkerSchema.SharedWorkerRpcs.of({
149
147
  // Whenever the client session leader changes (and thus creates a new leader thread), the new client session leader
150
148
  // sends a new MessagePort to the shared worker which proxies messages to the new leader thread.
151
149
  UpdateMessagePort: ({ port, initial, liveStoreVersion: clientLiveStoreVersion }) =>
@@ -180,21 +178,26 @@ const makeWorkerRunner = Effect.gen(function* () {
180
178
  const shutdownChannel = yield* makeShutdownChannel(initial.storeId)
181
179
 
182
180
  yield* shutdownChannel.listen.pipe(
183
- Stream.flatten(),
181
+ Stream.mapEffect(Effect.fromResult),
184
182
  Stream.tap(() => reset),
185
183
  Stream.runDrain,
186
184
  Effect.tapCauseLogPretty,
187
185
  Effect.forkScoped,
188
186
  )
189
187
 
190
- const workerLayer = yield* Layer.build(BrowserWorker.layer(() => port))
191
-
192
- const worker = yield* Worker.makePoolSerialized<WorkerSchema.LeaderWorkerInnerRequest>({
193
- size: 1,
194
- concurrency: 100,
195
- initialMessage: () => initial,
196
- }).pipe(
197
- Effect.provide(workerLayer),
188
+ const clientContext = yield* Layer.build(
189
+ RpcClient.layerProtocolWorker({ size: 1, concurrency: 100 }).pipe(
190
+ Layer.provide(BrowserWorker.layer(() => port)),
191
+ Layer.provide(
192
+ RpcWorker.layerInitialMessage(
193
+ WorkerSchema.LeaderWorkerInnerInitialMessage.payloadSchema,
194
+ Effect.succeed(initial),
195
+ ),
196
+ ),
197
+ ),
198
+ )
199
+ const client = yield* RpcClient.make(WorkerSchema.LeaderWorkerInnerRpcs).pipe(
200
+ Effect.provide(clientContext),
198
201
  Effect.withSpan('@livestore/adapter-web:shared-worker:makeWorkerProxyFromPort'),
199
202
  )
200
203
 
@@ -202,61 +205,67 @@ const makeWorkerRunner = Effect.gen(function* () {
202
205
  const { node } = yield* WebmeshWorker.CacheService
203
206
  const { storeId, clientId } = initial
204
207
 
205
- yield* DevtoolsWeb.connectViaWorker({
208
+ yield* WebmeshWorker.connectViaWorker({
206
209
  node,
207
- worker,
210
+ worker: makeWebmeshWorkerProxy(client),
208
211
  target: Devtools.makeNodeName.client.leader({ storeId, clientId }),
209
- }).pipe(Effect.tapCauseLogPretty, Effect.forkScoped)
212
+ }).pipe(Effect.tapCauseLogPretty, dieOnRpcClientError, Effect.forkScoped)
210
213
 
211
- yield* SubscriptionRef.set(leaderWorkerContextSubRef, { worker, scope })
212
- }).pipe(Effect.tapCauseLogPretty, Scope.extend(scope), Effect.forkIn(scope))
213
- }).pipe(
214
- Effect.withSpan('@livestore/adapter-web:shared-worker:updateMessagePort'),
215
- Effect.tapCauseLogPretty,
216
- ),
214
+ yield* SubscriptionRef.set(leaderWorkerContextSubRef, {
215
+ client: client as RpcClient.FromGroup<typeof WorkerSchema.LeaderWorkerInnerRpcs>,
216
+ scope,
217
+ })
218
+ }).pipe(Effect.tapCauseLogPretty, Scope.provide(scope), Effect.forkIn(scope))
219
+ }).pipe(Effect.withSpan('@livestore/adapter-web:shared-worker:updateMessagePort'), Effect.tapCauseLogPretty),
217
220
 
218
221
  // Proxied requests
219
- BootStatusStream: forwardRequestStream,
220
- PushToLeader: forwardRequest,
221
- PullStream: forwardRequestStream,
222
- StreamEvents: forwardRequestStream,
223
- Export: forwardRequest,
224
- GetRecreateSnapshot: forwardRequest,
225
- ExportEventlog: forwardRequest,
226
- Setup: forwardRequest,
227
- GetLeaderSyncState: forwardRequest,
228
- SyncStateStream: forwardRequestStream,
229
- GetLeaderHead: forwardRequest,
230
- GetNetworkStatus: forwardRequest,
231
- NetworkStatusStream: forwardRequestStream,
232
- Shutdown: forwardRequest,
233
- ExtraDevtoolsMessage: forwardRequest,
222
+ BootStatusStream: (payload) =>
223
+ forwardRequestStream('BootStatusStream', (client) => client.BootStatusStream(payload)),
224
+ PushToLeader: (payload) => forwardRequest('PushToLeader', (client) => client.PushToLeader(payload)),
225
+ PullStream: (payload) => forwardRequestStream('PullStream', (client) => client.PullStream(payload)),
226
+ StreamEvents: (payload) => forwardRequestStream('StreamEvents', (client) => client.StreamEvents(payload)),
227
+ Export: (payload) => forwardRequest('Export', (client) => client.Export(payload)),
228
+ GetRecreateSnapshot: (payload) =>
229
+ forwardRequest('GetRecreateSnapshot', (client) => client.GetRecreateSnapshot(payload)),
230
+ ExportEventlog: (payload) => forwardRequest('ExportEventlog', (client) => client.ExportEventlog(payload)),
231
+ GetLeaderSyncState: (payload) =>
232
+ forwardRequest('GetLeaderSyncState', (client) => client.GetLeaderSyncState(payload)),
233
+ SyncStateStream: (payload) => forwardRequestStream('SyncStateStream', (client) => client.SyncStateStream(payload)),
234
+ GetLeaderHead: (payload) => forwardRequest('GetLeaderHead', (client) => client.GetLeaderHead(payload)),
235
+ GetNetworkStatus: (payload) => forwardRequest('GetNetworkStatus', (client) => client.GetNetworkStatus(payload)),
236
+ NetworkStatusStream: (payload) =>
237
+ forwardRequestStream('NetworkStatusStream', (client) => client.NetworkStatusStream(payload)),
238
+ Shutdown: (payload) => forwardRequest('Shutdown', (client) => client.Shutdown(payload)),
239
+ ExtraDevtoolsMessage: (payload) =>
240
+ forwardRequest('ExtraDevtoolsMessage', (client) => client.ExtraDevtoolsMessage(payload)),
234
241
 
235
242
  // Accept devtools connections (from leader and client sessions)
236
- 'DevtoolsWebCommon.CreateConnection': WebmeshWorker.CreateConnection,
243
+ 'WebmeshWorker.CreateConnection': WebmeshWorker.CreateConnection,
237
244
  })
238
- }).pipe(Layer.unwrapScoped)
245
+ })
239
246
 
240
- export const makeWorker = (options?: LogConfig.WithLoggerOptions): void => {
247
+ export const makeWorker = (options?: LogConfig.LoggerOptions): void => {
241
248
  const runtimeLayer = Layer.mergeAll(
242
249
  FetchHttpClient.layer,
243
- WebmeshWorker.CacheService.layer({ nodeName: DevtoolsWeb.makeNodeName.sharedWorker({ storeId }) }),
250
+ WebmeshWorker.CacheService.layer({ nodeName: makeSharedWorkerNodeName({ storeId }) }),
244
251
  )
245
252
 
246
- // @effect-diagnostics-next-line anyUnknownInErrorContext:off -- propagated from `makeWorkerRunner`
247
- makeWorkerRunner.pipe(
253
+ RpcServer.layer(WorkerSchema.SharedWorkerRpcs).pipe(
254
+ Layer.provide(WorkerSchema.SharedWorkerRpcs.toLayer(makeWorkerRunner)),
255
+ Layer.provide(RpcServer.layerProtocolWorkerRunner),
248
256
  Layer.provide(BrowserWorkerRunner.layer),
249
- // WorkerRunner.launch,
250
257
  Layer.launch,
251
258
  Effect.scoped,
252
259
  Effect.tapCauseLogPretty,
253
260
  Effect.annotateLogs({ thread: self.name }),
254
261
  Effect.provide(runtimeLayer),
255
262
  LS_DEV === true ? TaskTracing.withAsyncTaggingTracing((name) => (console as any).createTask(name)) : identity,
256
- // TODO remove type-cast (currently needed to silence a tsc bug)
257
- // @effect-diagnostics-next-line anyUnknownInErrorContext:off -- TSC bug workaround; the cast uses `any` as an intermediate
258
- (_) => _ as any as Effect.Effect<void>,
259
- LogConfig.withLoggerConfig(options, { threadName: self.name }),
263
+ Effect.provide(
264
+ Layer.mergeAll(
265
+ options?.logger ?? Layer.empty,
266
+ Layer.succeed(References.MinimumLogLevel, options?.logLevel ?? (isDevEnv() === true ? 'Debug' : 'Info')),
267
+ ),
268
+ ),
260
269
  Effect.runFork,
261
270
  )
262
271
  }
@@ -5,8 +5,7 @@ globalThis.$RefreshReg$ = () => {}
5
5
  // @ts-expect-error TODO remove when Vite does proper treeshaking during dev
6
6
  globalThis.$RefreshSig$ = () => (type: any) => type
7
7
 
8
- // biome-ignore lint/suspicious/noTsIgnore: sometimes @types/node is there, sometimes not.
9
- // @ts-ignore
8
+ // @ts-ignore sometimes @types/node is there, sometimes not.
10
9
  globalThis.process = globalThis.process ?? { env: {} }
11
10
 
12
11
  globalThis.document = (globalThis as any)?.document ?? {