@livestore/livestore 0.4.0 → 0.5.0-dev.0

package/src/live-queries/db-query.test.ts

@@ -54,7 +54,7 @@ Vitest.describe('otel', () => {
     }
   })
 
-  Vitest.scopedLive('otel', () =>
+  Vitest.live('otel', () =>
     Effect.gen(function* () {
       const { store, exporter, span, provider } = yield* makeQuery
 
@@ -93,7 +93,7 @@ Vitest.describe('otel', () => {
     ),
   )
 
-  Vitest.scopedLive('with thunks', () =>
+  Vitest.live('with thunks', () =>
     Effect.gen(function* () {
       const { store, exporter, span, provider } = yield* makeQuery
 
@@ -150,7 +150,7 @@ Vitest.describe('otel', () => {
     ),
   )
 
-  Vitest.scopedLive('with thunks with query builder and without labels', () =>
+  Vitest.live('with thunks with query builder and without labels', () =>
     Effect.gen(function* () {
       const { store, exporter, span, provider } = yield* makeQuery
 
@@ -195,7 +195,7 @@ Vitest.describe('otel', () => {
     ),
   )
 
-  Vitest.scopedLive('QueryBuilder subscription - basic functionality', () =>
+  Vitest.live('QueryBuilder subscription - basic functionality', () =>
     Effect.gen(function* () {
       const { store, exporter, span, provider } = yield* makeQuery
 
@@ -239,7 +239,7 @@ Vitest.describe('otel', () => {
     ),
   )
 
-  Vitest.scopedLive('QueryBuilder subscription - skipInitialRun', () =>
+  Vitest.live('QueryBuilder subscription - skipInitialRun', () =>
     Effect.gen(function* () {
       const { store, exporter, span, provider } = yield* makeQuery
 
@@ -286,7 +286,7 @@ Vitest.describe('otel', () => {
     ),
   )
 
-  Vitest.scopedLive('QueryBuilder subscription - unsubscribe functionality', () =>
+  Vitest.live('QueryBuilder subscription - unsubscribe functionality', () =>
     Effect.gen(function* () {
       const { store, exporter, span, provider } = yield* makeQuery
 
@@ -338,7 +338,7 @@ Vitest.describe('otel', () => {
     ),
   )
 
-  Vitest.scopedLive('QueryBuilder subscription - async iterator', () =>
+  Vitest.live('QueryBuilder subscription - async iterator', () =>
     Effect.gen(function* () {
       const { store, exporter, span, provider } = yield* makeQuery
 
@@ -386,7 +386,7 @@ Vitest.describe('otel', () => {
     ),
   )
 
-  Vitest.scopedLive('QueryBuilder subscription - async iterator with skipInitialRun', () =>
+  Vitest.live('QueryBuilder subscription - async iterator with skipInitialRun', () =>
     Effect.gen(function* () {
       const { store, exporter, span, provider } = yield* makeQuery
 
@@ -435,7 +435,7 @@ Vitest.describe('otel', () => {
     ),
   )
 
-  Vitest.scopedLive('QueryBuilder subscription - direct table subscription', () =>
+  Vitest.live('QueryBuilder subscription - direct table subscription', () =>
     Effect.gen(function* () {
       const { store, exporter, span, provider } = yield* makeQuery
 

package/src/live-queries/db-query.ts

@@ -1,17 +1,17 @@
+import * as otel from '@opentelemetry/api'
+
 import type { Bindable, QueryBuilder } from '@livestore/common'
 import {
-  getDurationMsFromSpan,
   getResultSchema,
   isQueryBuilder,
   prepareBindValues,
   QueryBuilderAstSymbol,
-  replaceSessionIdSymbol,
+  resolveSessionIdSymbolInBindValues,
   SessionIdSymbol,
   UnknownError,
 } from '@livestore/common'
 import { deepEqual, objectToString, omitUndefineds, shouldNeverHappen } from '@livestore/utils'
-import { Equal, Hash, Predicate, Schema, TreeFormatter } from '@livestore/utils/effect'
-import * as otel from '@opentelemetry/api'
+import { Equal, Hash, Predicate, Result, Schema, SchemaIssue } from '@livestore/utils/effect'
 
 import type { Thunk } from '../reactive.ts'
 import { isThunk, NOT_REFRESHED_YET } from '../reactive.ts'
@@ -19,12 +19,12 @@ import type { RefreshReason } from '../store/store-types.ts'
 import { StoreInternalsSymbol } from '../store/store-types.ts'
 import { isValidFunctionString } from '../utils/function-string.ts'
 import type { DepKey, GetAtomResult, LiveQueryDef, ReactivityGraph, ReactivityGraphContext } from './base-class.ts'
-import { depsToString, LiveStoreQueryBase, makeGetAtomResult, withRCMap } from './base-class.ts'
+import { depsToString, isLiveQueryDef, LiveStoreQueryBase, makeGetAtomResult, withRCMap } from './base-class.ts'
 import { makeExecBeforeFirstRun, rowQueryLabel } from './client-document-get-query.ts'
 
 export type QueryInputRaw<TDecoded, TEncoded> = {
   query: string
-  schema: Schema.Schema<TDecoded, TEncoded>
+  schema: Schema.Codec<TDecoded, TEncoded>
   bindValues?: Bindable
   /**
    * Can be provided explicitly to slightly speed up initial query performance
@@ -103,7 +103,11 @@ export const queryDb: {
 } = (queryInput, options) => {
   const { queryString, extraDeps } = getQueryStringAndExtraDeps(queryInput)
 
-  const hash = [queryString, options?.deps !== undefined ? depsToString(options.deps) : undefined, depsToString(extraDeps)]
+  const hash = [
+    queryString,
+    options?.deps !== undefined ? depsToString(options.deps) : undefined,
+    depsToString(extraDeps),
+  ]
     .filter(Boolean)
     .join('-')
 
@@ -112,7 +116,7 @@ export const queryDb: {
   }
 
   if (hash.trim() === '') {
-      return shouldNeverHappen('Invalid query hash for query:', objectToString(queryInput))
+    return shouldNeverHappen('Invalid query hash for query:', objectToString(queryInput))
   }
 
   const label = options?.label ?? queryString
@@ -131,8 +135,8 @@ export const queryDb: {
     }),
     label,
     hash,
-    [Equal.symbol](that: LiveQueryDef<any>): boolean {
-      return this.hash === that.hash
+    [Equal.symbol](that: Equal.Equal): boolean {
+      return isLiveQueryDef(that) && that._tag === 'def' && this.hash === that.hash
     },
     [Hash.symbol](): number {
       return Hash.string(this.hash)
@@ -214,9 +218,13 @@ export class LiveStoreDbQuery<TResultSchema, TResult = TResultSchema> extends Li
 
     this.mapResult = map === undefined ? (rows: any) => rows as TResult : map
 
-    const schemaRef: { current: Schema.Schema<any, any> | undefined } = {
+    const schemaRef: { current: Schema.Codec<any, any> | undefined } = {
       current:
-        typeof queryInput === 'function' ? undefined : isQueryBuilder(queryInput) === true ? undefined : queryInput.schema,
+        typeof queryInput === 'function'
+          ? undefined
+          : isQueryBuilder(queryInput) === true
+            ? undefined
+            : queryInput.schema,
     }
 
     const execBeforeFirstRunRef: {
@@ -232,7 +240,7 @@ export class LiveStoreDbQuery<TResultSchema, TResult = TResultSchema> extends Li
     const fromQueryBuilder = (qb: QueryBuilder.Any, otelContext: otel.Context | undefined) => {
       try {
         const qbRes = qb.asSql()
-        const schema = getResultSchema(qb) as Schema.Schema<TResultSchema, ReadonlyArray<any>>
+        const schema = getResultSchema(qb) as Schema.Codec<TResultSchema, ReadonlyArray<any>>
         const ast = qb[QueryBuilderAstSymbol]
 
         return {
@@ -320,9 +328,9 @@ export class LiveStoreDbQuery<TResultSchema, TResult = TResultSchema> extends Li
 
     const queriedTablesRef: { current: Set<string> | undefined } = { current: undefined }
 
-    const makeResultsEqual = (resultSchema: Schema.Schema<any, any>) => {
+    const makeResultsEqual = (resultSchema: Schema.Codec<any, any>) => {
       // Creating the equivalence function eagerly in outer scope as it might be expensive
-      const eq = Schema.equivalence(resultSchema)
+      const eq = Schema.toEquivalence(resultSchema)
       return (a: TResult, b: TResult) => (a === NOT_REFRESHED_YET || b === NOT_REFRESHED_YET ? false : eq(a, b))
     }
 
@@ -342,13 +350,15 @@ export class LiveStoreDbQuery<TResultSchema, TResult = TResultSchema> extends Li
           'db:...', // NOTE span name will be overridden further down
           {
             attributes: {
-              'livestore.debugRefreshReason': Predicate.hasProperty(debugRefreshReason, 'label') === true
-                ? (debugRefreshReason.label as string)
-                : debugRefreshReason?._tag,
+              'livestore.debugRefreshReason':
+                Predicate.hasProperty(debugRefreshReason, 'label') === true
+                  ? (debugRefreshReason.label as string)
+                  : debugRefreshReason?._tag,
             },
           },
           otelContext ?? queryContext.rootOtelContext,
           (span) => {
+            const startTimePerfNow = performance.now()
             const otelContext = otel.trace.setSpan(otel.context.active(), span)
             const { store } = queryContext
 
@@ -357,9 +367,10 @@ export class LiveStoreDbQuery<TResultSchema, TResult = TResultSchema> extends Li
               execBeforeFirstRunRef.current = undefined
             }
 
-            const queryInputResult = isThunk(queryInputRaw$OrQueryInputRaw) === true
-              ? (get(queryInputRaw$OrQueryInputRaw, otelContext, debugRefreshReason) as TQueryInputRaw)
-              : (queryInputRaw$OrQueryInputRaw as TQueryInputRaw)
+            const queryInputResult =
+              isThunk(queryInputRaw$OrQueryInputRaw) === true
+                ? (get(queryInputRaw$OrQueryInputRaw, otelContext, debugRefreshReason) as TQueryInputRaw)
+                : (queryInputRaw$OrQueryInputRaw as TQueryInputRaw)
 
             const sqlString = queryInputResult.query
             const bindValues = queryInputResult.bindValues
@@ -368,9 +379,10 @@ export class LiveStoreDbQuery<TResultSchema, TResult = TResultSchema> extends Li
               queriedTablesRef.current = store[StoreInternalsSymbol].sqliteDbWrapper.getTablesUsed(sqlString)
             }
 
-            if (bindValues !== undefined) {
-              replaceSessionIdSymbol(bindValues, store.sessionId)
-            }
+            // Live query inputs may be cached and re-run as reactive dependencies change.
+            // Resolve SessionIdSymbol per execution so the cached input stays symbolic and session-agnostic.
+            const resolvedBindValues =
+              bindValues === undefined ? undefined : resolveSessionIdSymbolInBindValues(bindValues, store.sessionId)
 
             // Establish a reactive dependency on the tables used in the query
             for (const tableName of queriedTablesRef.current) {
@@ -385,7 +397,7 @@ export class LiveStoreDbQuery<TResultSchema, TResult = TResultSchema> extends Li
 
             const rawDbResults = store[StoreInternalsSymbol].sqliteDbWrapper.cachedSelect(
               sqlString,
-              bindValues !== undefined ? prepareBindValues(bindValues, sqlString) : undefined,
+              resolvedBindValues !== undefined ? prepareBindValues(resolvedBindValues, sqlString) : undefined,
               {
                 otelContext,
                 ...(queriedTablesRef.current !== undefined ? { queriedTables: queriedTablesRef.current } : {}),
@@ -394,10 +406,10 @@ export class LiveStoreDbQuery<TResultSchema, TResult = TResultSchema> extends Li
 
             span.setAttribute('sql.rowsCount', rawDbResults.length)
 
-            const parsedResult = Schema.decodeEither(schemaRef.current!)(rawDbResults)
+            const parsedResult = Schema.decodeResult(schemaRef.current!)(rawDbResults)
 
-            if (parsedResult._tag === 'Left') {
-              const parseErrorStr = TreeFormatter.formatErrorSync(parsedResult.left)
+            if (Result.isFailure(parsedResult) === true) {
+              const parseErrorStr = SchemaIssue.makeFormatterDefault()(parsedResult.failure.issue)
               const expectedSchemaStr = String(schemaRef.current!.ast)
               const bindValuesStr = bindValues === undefined ? '' : `\nBind values: ${JSON.stringify(bindValues)}`
 
@@ -418,11 +430,11 @@ Result:`,
               )
             }
 
-            const result = this.mapResult(parsedResult.right)
+            const result = this.mapResult(parsedResult.success)
 
             span.end()
 
-            const durationMs = getDurationMsFromSpan(span)
+            const durationMs = performance.now() - startTimePerfNow
 
             this.executionTimes.push(durationMs)
 

package/src/live-queries/signal.test.ts

@@ -8,7 +8,7 @@ import { computed } from './computed.ts'
 import { signal } from './signal.ts'
 
 Vitest.describe('signal', () => {
-  Vitest.scopedLive('should be able to create a signal', () =>
+  Vitest.live('should be able to create a signal', () =>
     Effect.gen(function* () {
       const num$ = signal(0, { label: 'num$' })
 
@@ -24,7 +24,7 @@ Vitest.describe('signal', () => {
     }),
   )
 
-  Vitest.scopedLive('counter example', () =>
+  Vitest.live('counter example', () =>
     Effect.gen(function* () {
       const count$ = signal(0, { label: 'count$' })
 

package/src/live-queries/signal.ts

@@ -4,7 +4,7 @@ import { nanoid } from '@livestore/utils/nanoid'
 import type * as RG from '../reactive.ts'
 import type { RefreshReason } from '../store/store-types.ts'
 import type { ISignal, ReactivityGraph, ReactivityGraphContext, SignalDef } from './base-class.ts'
-import { LiveStoreQueryBase, withRCMap } from './base-class.ts'
+import { isSignalDef, LiveStoreQueryBase, withRCMap } from './base-class.ts'
 
 /**
  * Creates a reactive signal for ephemeral, local-only state that isn't persisted to the database.
@@ -70,8 +70,8 @@ export const signal = <T>(
           def,
         }),
     ),
-    [Equal.symbol](that: SignalDef<T>): boolean {
-      return this.hash === that.hash
+    [Equal.symbol](that: Equal.Equal): boolean {
+      return isSignalDef(that) && this.hash === that.hash
     },
     [Hash.symbol](): number {
       return Hash.string(this.hash)

package/src/reactive.ts

@@ -25,17 +25,13 @@ import type * as otel from '@opentelemetry/api'
 
 import { BoundArray } from '@livestore/common'
 import { deepEqual, omitUndefineds, shouldNeverHappen } from '@livestore/utils'
-import type { Types } from '@livestore/utils/effect'
+import { Schema, type Types } from '@livestore/utils/effect'
 // import { getDurationMsFromSpan } from './otel.ts'
 
 export const NOT_REFRESHED_YET = Symbol.for('NOT_REFRESHED_YET')
 export type NOT_REFRESHED_YET = typeof NOT_REFRESHED_YET
 
-export type GetAtom = <T>(
-  atom: Atom<T, any, any>,
-  otelContext?: otel.Context  ,
-  debugRefreshReason?: TODO  ,
-) => T
+export type GetAtom = <T>(atom: Atom<T, any, any>, otelContext?: otel.Context, debugRefreshReason?: TODO) => T
 
 export type Ref<T, TContext, TDebugRefreshReason extends DebugRefreshReason> = {
   _tag: 'ref'
@@ -79,7 +75,7 @@ export type Effect<TDebugRefreshReason extends DebugRefreshReason> = {
   _tag: 'effect'
   id: string
   isDestroyed: boolean
-  doEffect: (otelContext?: otel.Context  , debugRefreshReason?: TDebugRefreshReason  ) => void
+  doEffect: (otelContext?: otel.Context, debugRefreshReason?: TDebugRefreshReason) => void
   sub: Set<Atom<any, TODO, TODO>>
   label?: string | undefined
   invocations: number
@@ -246,13 +242,11 @@ export class ReactiveGraph<
       otelContext: otel.Context | undefined,
       debugRefreshReason: TDebugRefreshReason | undefined,
     ) => T,
-    options?:
-      | {
-          label?: string
-          meta?: any
-          equal?: (a: T, b: T) => boolean
-        }
-       ,
+    options?: {
+      label?: string
+      meta?: any
+      equal?: (a: T, b: T) => boolean
+    },
   ): Thunk<T, TContext, TDebugRefreshReason> {
     const thunk: Thunk<T, TContext, TDebugRefreshReason> = {
       _tag: 'thunk',
@@ -291,7 +285,7 @@ export class ReactiveGraph<
             debugRefreshReason,
           )
 
-          const resultChanged = ! thunk.equal(thunk.previousResult as T, result)
+          const resultChanged = !thunk.equal(thunk.previousResult as T, result)
 
           const debugInfoForAtom = {
             atom: serializeAtom(thunk, false),
@@ -384,7 +378,7 @@ export class ReactiveGraph<
       otelContext: otel.Context | undefined,
       debugRefreshReason: DebugRefreshReason | undefined,
     ) => void,
-    options?: { label?: string }  ,
+    options?: { label?: string },
   ): Effect<TDebugRefreshReason> {
     const effect: Effect<TDebugRefreshReason> = {
       _tag: 'effect',
@@ -422,26 +416,22 @@ export class ReactiveGraph<
   setRef<T>(
     ref: Ref<T, TContext, TDebugRefreshReason>,
     val: T,
-    options?:
-      | {
-          skipRefresh?: boolean
-          debugRefreshReason?: TDebugRefreshReason
-          otelContext?: otel.Context
-        }
-       ,
+    options?: {
+      skipRefresh?: boolean
+      debugRefreshReason?: TDebugRefreshReason
+      otelContext?: otel.Context
+    },
   ) {
     this.setRefs([[ref, val]], options)
   }
 
   setRefs<T>(
     refs: [Ref<T, TContext, TDebugRefreshReason>, T][],
-    options?:
-      | {
-          skipRefresh?: boolean
-          debugRefreshReason?: TDebugRefreshReason
-          otelContext?: otel.Context
-        }
-       ,
+    options?: {
+      skipRefresh?: boolean
+      debugRefreshReason?: TDebugRefreshReason
+      otelContext?: otel.Context
+    },
   ) {
     const effectsToRefresh = new Set<Effect<TDebugRefreshReason>>()
     for (const [ref, val] of refs) {
@@ -640,11 +630,31 @@ const serializeAtom = (atom: Atom<any, unknown, any>, includeResult: boolean): S
     super_.push(a.id)
   }
 
-  const previousResult: EncodedOption<string> = includeResult === true
-    ? encodedOptionSome(
-        atom.previousResult === NOT_REFRESHED_YET ? '"SYMBOL_NOT_REFRESHED_YET"' : JSON.stringify(atom.previousResult),
-      )
-    : encodedOptionNone()
+  const previousResult: EncodedOption<string> =
+    includeResult === true
+      ? encodedOptionSome(
+          atom.previousResult === NOT_REFRESHED_YET
+            ? '"SYMBOL_NOT_REFRESHED_YET"'
+            : JSON.stringify(atom.previousResult, (key, nestedValue) => {
+                if (Schema.isSchema(nestedValue) === false) return nestedValue
+
+                // Query inputs carry schemas for result decoding, but graph snapshots use previousResult
+                // to explain reactive data flow. Omitting that field preserves the stable query shape
+                // without embedding Effect full schema object graph.
+                if (key === 'schema') return undefined
+
+                const annotations = Schema.resolveAnnotations(nestedValue)
+
+                return omitUndefineds({
+                  _tag: 'Schema',
+                  ast: nestedValue.ast._tag,
+                  identifier: annotations?.identifier,
+                  title: annotations?.title,
+                  hash: Schema.hash(nestedValue),
+                })
+              }),
+        )
+      : encodedOptionNone()
 
   if (atom._tag === 'ref') {
     return {