@livestore/livestore 0.4.0-dev.3 → 0.4.0-dev.6

package/src/store/store.ts

@@ -3,13 +3,14 @@ import {
   type ClientSession,
   type ClientSessionSyncProcessor,
   Devtools,
-  getDurationMsFromSpan,
   getExecStatementsFromMaterializer,
   getResultSchema,
   hashMaterializerResults,
   IntentionalShutdownCause,
   isQueryBuilder,
   liveStoreVersion,
+  MaterializeError,
+  MaterializerHashMismatchError,
   makeClientSessionSyncProcessor,
   type PreparedBindValues,
   prepareBindValues,
@@ -20,7 +21,7 @@ import {
 } from '@livestore/common'
 import type { LiveStoreSchema } from '@livestore/common/schema'
 import { getEventDef, LiveStoreEvent, SystemTables } from '@livestore/common/schema'
-import { assertNever, isDevEnv, notYetImplemented } from '@livestore/utils'
+import { assertNever, isDevEnv, notYetImplemented, omitUndefineds, shouldNeverHappen } from '@livestore/utils'
 import type { Scope } from '@livestore/utils/effect'
 import {
   Cause,
@@ -128,72 +129,76 @@ export class Store<TSchema extends LiveStoreSchema = LiveStoreSchema.Any, TConte
       schema,
       clientSession,
       runtime: effectContext.runtime,
-      materializeEvent: (eventDecoded, { otelContext, withChangeset, materializerHashLeader }) => {
-        const { eventDef, materializer } = getEventDef(schema, eventDecoded.name)
-
-        const execArgsArr = getExecStatementsFromMaterializer({
-          eventDef,
-          materializer,
-          dbState: this.sqliteDbWrapper,
-          event: { decoded: eventDecoded, encoded: undefined },
-        })
-
-        const materializerHash = isDevEnv() ? Option.some(hashMaterializerResults(execArgsArr)) : Option.none()
-
-        if (
-          materializerHashLeader._tag === 'Some' &&
-          materializerHash._tag === 'Some' &&
-          materializerHashLeader.value !== materializerHash.value
-        ) {
-          void this.shutdown(
-            Cause.fail(
-              UnexpectedError.make({
-                cause: `Materializer hash mismatch detected for event "${eventDecoded.name}".`,
-                note: `Please make sure your event materializer is a pure function without side effects.`,
-              }),
-            ),
-          )
-        }
-
-        const writeTablesForEvent = new Set<string>()
-
-        const exec = () => {
-          for (const {
-            statementSql,
-            bindValues,
-            writeTables = this.sqliteDbWrapper.getTablesUsed(statementSql),
-          } of execArgsArr) {
-            try {
-              this.sqliteDbWrapper.cachedExecute(statementSql, bindValues, { otelContext, writeTables })
-            } catch (cause) {
-              throw UnexpectedError.make({
-                cause,
-                note: `Error executing materializer for event "${eventDecoded.name}".\nStatement: ${statementSql}\nBind values: ${JSON.stringify(bindValues)}`,
-              })
+      materializeEvent: Effect.fn('client-session-sync-processor:materialize-event')(
+        (eventDecoded, { withChangeset, materializerHashLeader }) =>
+          // We need to use `Effect.gen` (even though we're using `Effect.fn`) so that we can pass `this` to the function
+          Effect.gen(this, function* () {
+            const { eventDef, materializer } = getEventDef(schema, eventDecoded.name)
+
+            const execArgsArr = getExecStatementsFromMaterializer({
+              eventDef,
+              materializer,
+              dbState: this.sqliteDbWrapper,
+              event: { decoded: eventDecoded, encoded: undefined },
+            })
+
+            const materializerHash = isDevEnv() ? Option.some(hashMaterializerResults(execArgsArr)) : Option.none()
+
+            // Hash mismatch detection only occurs during the pull path (when receiving events from the leader).
+            // During push path (local commits), materializerHashLeader is always Option.none(), so this condition
+            // will never be met. The check happens when the same event comes back from the leader during sync,
+            // allowing us to compare the leader's computed hash with our local re-materialization hash.
+            if (
+              materializerHashLeader._tag === 'Some' &&
+              materializerHash._tag === 'Some' &&
+              materializerHashLeader.value !== materializerHash.value
+            ) {
+              return yield* MaterializerHashMismatchError.make({ eventName: eventDecoded.name })
             }
 
-            // durationMsTotal += durationMs
-            for (const table of writeTables) {
-              writeTablesForEvent.add(table)
+            const span = yield* OtelTracer.currentOtelSpan.pipe(Effect.orDie)
+            const otelContext = otel.trace.setSpan(otel.context.active(), span)
+
+            const writeTablesForEvent = new Set<string>()
+
+            const exec = () => {
+              for (const {
+                statementSql,
+                bindValues,
+                writeTables = this.sqliteDbWrapper.getTablesUsed(statementSql),
+              } of execArgsArr) {
+                try {
+                  this.sqliteDbWrapper.cachedExecute(statementSql, bindValues, { otelContext, writeTables })
+                } catch (cause) {
+                  // TOOD refactor with `SqliteError`
+                  throw UnexpectedError.make({
+                    cause,
+                    note: `Error executing materializer for event "${eventDecoded.name}".\nStatement: ${statementSql}\nBind values: ${JSON.stringify(bindValues)}`,
+                  })
+                }
+
+                // durationMsTotal += durationMs
+                for (const table of writeTables) {
+                  writeTablesForEvent.add(table)
+                }
+
+                this.sqliteDbWrapper.debug.head = eventDecoded.seqNum
+              }
             }
 
-            this.sqliteDbWrapper.debug.head = eventDecoded.seqNum
-          }
-        }
-
-        let sessionChangeset:
-          | { _tag: 'sessionChangeset'; data: Uint8Array<ArrayBuffer>; debug: any }
-          | { _tag: 'no-op' }
-          | { _tag: 'unset' } = { _tag: 'unset' }
-
-        if (withChangeset === true) {
-          sessionChangeset = this.sqliteDbWrapper.withChangeset(exec).changeset
-        } else {
-          exec()
-        }
+            let sessionChangeset:
+              | { _tag: 'sessionChangeset'; data: Uint8Array<ArrayBuffer>; debug: any }
+              | { _tag: 'no-op' }
+              | { _tag: 'unset' } = { _tag: 'unset' }
+            if (withChangeset === true) {
+              sessionChangeset = this.sqliteDbWrapper.withChangeset(exec).changeset
+            } else {
+              exec()
+            }
 
-        return { writeTables: writeTablesForEvent, sessionChangeset, materializerHash }
-      },
+            return { writeTables: writeTablesForEvent, sessionChangeset, materializerHash }
+          }).pipe(Effect.mapError((cause) => MaterializeError.make({ cause }))),
+      ),
       rollback: (changeset) => {
         this.sqliteDbWrapper.rollback(changeset)
       },
@@ -208,8 +213,12 @@ export class Store<TSchema extends LiveStoreSchema = LiveStoreSchema.Any, TConte
       },
       span: syncSpan,
       params: {
-        leaderPushBatchSize: params.leaderPushBatchSize,
-        simulation: params.simulation?.clientSessionSyncProcessor,
+        ...omitUndefineds({
+          leaderPushBatchSize: params.leaderPushBatchSize,
+        }),
+        ...(params.simulation?.clientSessionSyncProcessor !== undefined
+          ? { simulation: params.simulation.clientSessionSyncProcessor }
+          : {}),
       },
       confirmUnsavedChanges,
     })
@@ -411,8 +420,7 @@ export class Store<TSchema extends LiveStoreSchema = LiveStoreSchema.Any, TConte
           Effect.sync(() =>
             this.subscribe(query$, {
               onUpdate: (result) => emit.single(result),
-              otelContext,
-              label: options?.label,
+              ...omitUndefineds({ otelContext, label: options?.label }),
             }),
           ),
           (unsub) => Effect.sync(() => unsub()),
@@ -447,7 +455,7 @@ export class Store<TSchema extends LiveStoreSchema = LiveStoreSchema.Any, TConte
 
     if (typeof query === 'object' && 'query' in query && 'bindValues' in query) {
       const res = this.sqliteDbWrapper.cachedSelect(query.query, prepareBindValues(query.bindValues, query.query), {
-        otelContext: options?.otelContext,
+        ...omitUndefineds({ otelContext: options?.otelContext }),
       }) as any
       if (query.schema) {
         return Schema.decodeSync(query.schema)(res)
@@ -473,11 +481,23 @@ export class Store<TSchema extends LiveStoreSchema = LiveStoreSchema.Any, TConte
       }
 
       const rawRes = this.sqliteDbWrapper.cachedSelect(sqlRes.query, sqlRes.bindValues as any as PreparedBindValues, {
-        otelContext: options?.otelContext,
+        ...omitUndefineds({ otelContext: options?.otelContext }),
         queriedTables: new Set([query[QueryBuilderAstSymbol].tableDef.sqliteDef.name]),
       })
 
-      return Schema.decodeSync(schema)(rawRes)
+      const decodeResult = Schema.decodeEither(schema)(rawRes)
+      if (decodeResult._tag === 'Right') {
+        return decodeResult.right
+      } else {
+        return shouldNeverHappen(
+          `Failed to decode query result with for schema:`,
+          schema.toString(),
+          'raw result:',
+          rawRes,
+          'decode error:',
+          decodeResult.left,
+        )
+      }
     } else if (query._tag === 'def') {
       const query$ = query.make(this.reactivityGraph.context!)
       const result = this.query(query$.value, options)
@@ -487,7 +507,9 @@ export class Store<TSchema extends LiveStoreSchema = LiveStoreSchema.Any, TConte
       const signal$ = query.make(this.reactivityGraph.context!)
       return signal$.value.get()
     } else {
-      return query.run({ otelContext: options?.otelContext, debugRefreshReason: options?.debugRefreshReason })
+      return query.run({
+        ...omitUndefineds({ otelContext: options?.otelContext, debugRefreshReason: options?.debugRefreshReason }),
+      })
     }
   }
 
@@ -597,84 +619,76 @@ export class Store<TSchema extends LiveStoreSchema = LiveStoreSchema.Any, TConte
 
     const { events, options } = this.getCommitArgs(firstEventOrTxnFnOrOptions, restEvents)
 
-    for (const event of events) {
-      replaceSessionIdSymbol(event.args, this.clientSession.sessionId)
-    }
-
-    if (events.length === 0) return
-
-    const skipRefresh = options?.skipRefresh ?? false
+    Effect.gen(this, function* () {
+      const commitsSpan = otel.trace.getSpan(this.otel.commitsSpanContext)
+      commitsSpan?.addEvent('commit')
+      const currentSpan = yield* OtelTracer.currentOtelSpan.pipe(Effect.orDie)
+      commitsSpan?.addLink({ context: currentSpan.spanContext() })
 
-    const commitsSpan = otel.trace.getSpan(this.otel.commitsSpanContext)!
-    commitsSpan.addEvent('commit')
-
-    // console.group('LiveStore.commit', { skipRefresh })
-    // events.forEach((_) => console.debug(_.name, _.args))
-    // console.groupEnd()
-
-    let durationMs: number
-
-    return this.otel.tracer.startActiveSpan(
-      'LiveStore:commit',
-      {
-        attributes: {
-          'livestore.eventsCount': events.length,
-          'livestore.eventTags': events.map((_) => _.name),
-          'livestore.commitLabel': options?.label,
-        },
-        links: options?.spanLinks,
-      },
-      options?.otelContext ?? this.otel.commitsSpanContext,
-      (span) => {
-        const otelContext = otel.trace.setSpan(otel.context.active(), span)
+      for (const event of events) {
+        replaceSessionIdSymbol(event.args, this.clientSession.sessionId)
+      }
 
-        try {
-          // Materialize events to state
-          const { writeTables } = (() => {
-            try {
-              const materializeEvents = () => this.syncProcessor.push(events, { otelContext })
+      if (events.length === 0) return
 
-              if (events.length > 1) {
-                return this.sqliteDbWrapper.txn(materializeEvents)
-              } else {
-                return materializeEvents()
-              }
-            } catch (e: any) {
-              console.error(e)
-              span.setStatus({ code: otel.SpanStatusCode.ERROR, message: e.toString() })
-              throw e
-            } finally {
-              span.end()
-            }
-          })()
+      const localRuntime = yield* Effect.runtime()
 
-          const tablesToUpdate = [] as [Ref<null, ReactivityGraphContext, RefreshReason>, null][]
-          for (const tableName of writeTables) {
-            const tableRef = this.tableRefs[tableName]
-            assertNever(tableRef !== undefined, `No table ref found for ${tableName}`)
-            tablesToUpdate.push([tableRef!, null])
+      const materializeEventsTx = Effect.try({
+        try: () => {
+          const runMaterializeEvents = () => {
+            return this.syncProcessor.push(events).pipe(Runtime.runSync(localRuntime))
           }
 
-          const debugRefreshReason = {
-            _tag: 'commit' as const,
-            events,
-            writeTables: Array.from(writeTables),
+          if (events.length > 1) {
+            return this.sqliteDbWrapper.txn(runMaterializeEvents)
+          } else {
+            return runMaterializeEvents()
           }
+        },
+        catch: (cause) => UnexpectedError.make({ cause }),
+      })
 
-          // Update all table refs together in a batch, to only trigger one reactive update
-          this.reactivityGraph.setRefs(tablesToUpdate, { debugRefreshReason, otelContext, skipRefresh })
-        } catch (e: any) {
-          console.error(e)
-          span.setStatus({ code: otel.SpanStatusCode.ERROR, message: e.toString() })
-          throw e
-        } finally {
-          span.end()
+      // Materialize events to state
+      const { writeTables } = yield* materializeEventsTx
 
-          durationMs = getDurationMsFromSpan(span)
-        }
+      const tablesToUpdate: [Ref<null, ReactivityGraphContext, RefreshReason>, null][] = []
+      for (const tableName of writeTables) {
+        const tableRef = this.tableRefs[tableName]
+        assertNever(tableRef !== undefined, `No table ref found for ${tableName}`)
+        tablesToUpdate.push([tableRef!, null])
+      }
 
-        return { durationMs }
-      },
+      const debugRefreshReason: RefreshReason = {
+        _tag: 'commit',
+        events,
+        writeTables: Array.from(writeTables),
+      }
+      const skipRefresh = options?.skipRefresh ?? false
+
+      // Update all table refs together in a batch, to only trigger one reactive update
+      this.reactivityGraph.setRefs(tablesToUpdate, {
+        debugRefreshReason,
+        skipRefresh,
+        otelContext: otel.trace.setSpan(otel.context.active(), currentSpan),
+      })
+    }).pipe(
+      Effect.withSpan('LiveStore:commit', {
+        root: true,
+        attributes: {
+          'livestore.eventsCount': events.length,
+          'livestore.eventTags': events.map((_) => _.name),
+          ...(options?.label && { 'livestore.commitLabel': options.label }),
+        },
+        links: [
+          // Span link to LiveStore:commits
+          OtelTracer.makeSpanLink({ context: otel.trace.getSpanContext(this.otel.commitsSpanContext)! }),
+          // User-provided span links
+          ...(options?.spanLinks?.map(OtelTracer.makeSpanLink) ?? []),
+        ],
+      }),
+      Effect.tapErrorCause(Effect.logError),
+      Effect.catchAllCause((cause) => Effect.fork(this.shutdown(cause))),
+      Runtime.runSync(this.effectContext.runtime),
     )
   }
   // #endregion commit
@@ -746,9 +760,7 @@ export class Store<TSchema extends LiveStoreSchema = LiveStoreSchema.Any, TConte
    *
    * This is called automatically when the store was created using the React or Effect API.
    */
-  shutdown = (cause?: Cause.Cause<UnexpectedError>): Effect.Effect<void> => {
-    this.checkShutdown('shutdown')
-
+  shutdown = (cause?: Cause.Cause<UnexpectedError | MaterializeError>): Effect.Effect<void> => {
     this.isShutdown = true
     return this.clientSession.shutdown(
       cause ? Exit.failCause(cause) : Exit.succeed(IntentionalShutdownCause.make({ reason: 'manual' })),
@@ -798,14 +810,12 @@ export class Store<TSchema extends LiveStoreSchema = LiveStoreSchema.Any, TConte
         .pipe(this.runEffectFork)
     },
 
-    syncStates: () => {
+    syncStates: () =>
       Effect.gen(this, function* () {
         const session = yield* this.syncProcessor.syncState
-        console.log('Session sync state:', session.toJSON())
         const leader = yield* this.clientSession.leaderThread.getSyncState
-        console.log('Leader sync state:', leader.toJSON())
-      }).pipe(this.runEffectFork)
-    },
+        return { session, leader }
+      }).pipe(this.runEffectPromise),
 
     version: liveStoreVersion,
 
@@ -827,6 +837,9 @@ export class Store<TSchema extends LiveStoreSchema = LiveStoreSchema.Any, TConte
       Runtime.runFork(this.effectContext.runtime),
     )
 
+  private runEffectPromise = <A, E>(effect: Effect.Effect<A, E, Scope.Scope>) =>
+    effect.pipe(Effect.tapCauseLogPretty, Runtime.runPromise(this.effectContext.runtime))
+
   private getCommitArgs = (
     firstEventOrTxnFnOrOptions: any,
     restEvents: any[],

package/src/utils/tests/fixture.ts

@@ -1,6 +1,7 @@
 import { makeInMemoryAdapter } from '@livestore/adapter-web'
 import { provideOtel } from '@livestore/common'
 import { createStore, Events, makeSchema, State } from '@livestore/livestore'
+import { omitUndefineds } from '@livestore/utils'
 import { Effect, Schema } from '@livestore/utils/effect'
 import type * as otel from '@opentelemetry/api'
 
@@ -71,4 +72,4 @@ export const makeTodoMvc = ({
     })
 
     return store
-  }).pipe(provideOtel({ parentSpanContext: otelContext, otelTracer: otelTracer }))
+  }).pipe(provideOtel(omitUndefineds({ parentSpanContext: otelContext, otelTracer: otelTracer })))

package/src/utils/tests/otel.ts

@@ -1,13 +1,17 @@
+import { omitUndefineds } from '@livestore/utils'
 import { identity } from '@livestore/utils/effect'
 import type { Attributes } from '@opentelemetry/api'
 import type { InMemorySpanExporter, ReadableSpan } from '@opentelemetry/sdk-trace-base'
 
 type SimplifiedNestedSpan = { _name: string; attributes: any; children: SimplifiedNestedSpan[] }
 
-export const getSimplifiedRootSpan = (
+type NestedSpan = { span: ReadableSpan; children: NestedSpan[] }
+
+const buildSimplifiedRootSpans = (
   exporter: InMemorySpanExporter,
+  rootSpanName: string,
   mapAttributes?: (attributes: Attributes) => Attributes,
-): SimplifiedNestedSpan => {
+): SimplifiedNestedSpan[] => {
   const spans = exporter.getFinishedSpans()
   const spansMap = new Map<string, NestedSpan>(spans.map((span) => [span.spanContext().spanId, { span, children: [] }]))
 
@@ -21,14 +25,12 @@ export const getSimplifiedRootSpan = (
     }
   })
 
-  type NestedSpan = { span: ReadableSpan; children: NestedSpan[] }
-  const createStoreSpanData = spans.find((_) => _.name === 'createStore')
-  if (createStoreSpanData === undefined) {
+  const rootSpanDataList = spans.filter((_) => _.name === rootSpanName)
+  if (rootSpanDataList.length === 0) {
     throw new Error(
-      `Could not find the root span named 'createStore'. Available spans: ${spans.map((s) => s.name).join(', ')}`,
+      `Could not find any root spans named '${rootSpanName}'. Available spans: ${spans.map((s) => s.name).join(', ')}`,
     )
   }
-  const rootSpan = spansMap.get(createStoreSpanData.spanContext().spanId)!
 
   const simplifySpanRec = (span: NestedSpan): SimplifiedNestedSpan =>
     omitEmpty({
@@ -40,20 +42,29 @@ export const getSimplifiedRootSpan = (
         .map(simplifySpanRec),
     })
 
-  // console.log('rootSpan', rootSpan.span)
-
-  // console.dir(
-  //   spans.map((_) => [_.spanContext().spanId, _.name, _.attributes, _.parentSpanId]),
-  //   { depth: 10 },
-  // )
-
-  const simplifiedRootSpan = simplifySpanRec(rootSpan)
-
-  // console.log('simplifiedRootSpan', simplifiedRootSpan)
+  return rootSpanDataList.map((rootSpanData) => {
+    const rootSpan = spansMap.get(rootSpanData.spanContext().spanId)!
+    return simplifySpanRec(rootSpan)
+  })
+}
 
-  // writeFileSync('tmp/trace.json', JSON.stringify(toTraceFile(spans), null, 2))
+export const getSimplifiedRootSpan = (
+  exporter: InMemorySpanExporter,
+  rootSpanName: string,
+  mapAttributes?: (attributes: Attributes) => Attributes,
+): SimplifiedNestedSpan => {
+  const results = buildSimplifiedRootSpans(exporter, rootSpanName, mapAttributes)
+  const firstResult = results[0]
+  if (!firstResult) throw new Error(`Could not find the root span named '${rootSpanName}'.`)
+  return firstResult
+}
 
-  return simplifiedRootSpan
+export const getAllSimplifiedRootSpans = (
+  exporter: InMemorySpanExporter,
+  rootSpanName: string,
+  mapAttributes?: (attributes: Attributes) => Attributes,
+): SimplifiedNestedSpan[] => {
+  return buildSimplifiedRootSpans(exporter, rootSpanName, mapAttributes)
 }
 
 // const compareHrTime = (a: [number, numndber], b: [number, number]) => {
@@ -96,7 +107,7 @@ export const toTraceFile = (spans: ReadableSpan[]) => {
             spans: spans.map((span) => ({
               traceId: span.spanContext().traceId,
               spanId: span.spanContext().spanId,
-              ...(span.parentSpanContext?.spanId ? { parentSpanId: span.parentSpanContext.spanId } : {}),
+              ...omitUndefineds({ parentSpanId: span.parentSpanContext?.spanId }),
               // traceState: span.spanContext().traceState ?? '',
               name: span.name,
               kind: 'SPAN_KIND_INTERNAL',