@livestore/livestore 0.3.0-dev.34 → 0.3.0-dev.37

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

@@ -0,0 +1,25 @@
+import { Effect } from '@livestore/utils/effect'
+import { Vitest } from '@livestore/utils-dev/node-vitest'
+import { expect } from 'vitest'
+
+import { makeTodoMvc } from '../utils/tests/fixture.js'
+import { computed } from './computed.js'
+import { signal } from './signal.js'
+
+Vitest.describe('signal', () => {
+  Vitest.scopedLive('should be able to create a signal', () =>
+    Effect.gen(function* () {
+      const num$ = signal(0, { label: 'num$' })
+
+      const duplicated$ = computed((get) => get(num$) * 2, { label: 'duplicated$' })
+
+      const store = yield* makeTodoMvc({})
+
+      expect(store.query(duplicated$)).toBe(0)
+
+      store.setSignal(num$, 1)
+
+      expect(store.query(duplicated$)).toBe(2)
+    }),
+  )
+})

package/src/live-queries/{make-ref.ts → signal.ts}

@@ -2,27 +2,25 @@ import { nanoid } from '@livestore/utils/nanoid'
 
 import type * as RG from '../reactive.js'
 import type { RefreshReason } from '../store/store-types.js'
-import type { ILiveQueryRef, ILiveQueryRefDef, ReactivityGraph, ReactivityGraphContext } from './base-class.js'
+import type { ISignal, ReactivityGraph, ReactivityGraphContext, SignalDef } from './base-class.js'
 import { withRCMap } from './base-class.js'
 
-// TODO rename to `signal`
-
-export const makeRef = <T>(
+export const signal = <T>(
   defaultValue: T,
   options?: {
     label?: string
   },
-): ILiveQueryRefDef<T> => {
+): SignalDef<T> => {
   const id = nanoid()
   return {
-    _tag: 'live-ref-def',
+    _tag: 'signal-def',
     defaultValue,
-    make: withRCMap(id, (ctx) => new LiveQueryRef(defaultValue, ctx.reactivityGraph.deref()!, options)),
+    make: withRCMap(id, (ctx) => new Signal(defaultValue, ctx.reactivityGraph.deref()!, options)),
   }
 }
 
-export class LiveQueryRef<T> implements ILiveQueryRef<T> {
-  _tag = 'live-ref' as const
+export class Signal<T> implements ISignal<T> {
+  _tag = 'signal' as const
   readonly ref: RG.Ref<T, ReactivityGraphContext, RefreshReason>
 
   constructor(

package/src/mod.ts

@@ -13,7 +13,7 @@ export {
 
 export { SqliteDbWrapper, emptyDebugInfo } from './SqliteDbWrapper.js'
 
-export { queryDb, computed, makeRef, type LiveQuery, type LiveQueryDef } from './live-queries/mod.js'
+export { queryDb, computed, signal, type LiveQuery, type LiveQueryDef } from './live-queries/mod.js'
 
 export * from '@livestore/common/schema'
 export {

package/src/store/store.ts

@@ -28,11 +28,11 @@ import { nanoid } from '@livestore/utils/nanoid'
 import * as otel from '@opentelemetry/api'
 
 import type {
-  ILiveQueryRefDef,
   LiveQuery,
   LiveQueryDef,
   ReactivityGraph,
   ReactivityGraphContext,
+  SignalDef,
 } from '../live-queries/base-class.js'
 import { makeReactivityGraph } from '../live-queries/base-class.js'
 import { makeExecBeforeFirstRun } from '../live-queries/client-document-get-query.js'
@@ -108,10 +108,12 @@ export class Store<TSchema extends LiveStoreSchema = LiveStoreSchema, TContext =
       clientSession,
       runtime: effectContext.runtime,
       materializeEvent: (eventDecoded, { otelContext, withChangeset }) => {
-        const eventDef = getEventDef(schema, eventDecoded.name)
+        const { eventDef, materializer } = getEventDef(schema, eventDecoded.name)
 
         const execArgsArr = getExecArgsFromEvent({
           eventDef,
+          materializer,
+          db: this.sqliteDbWrapper,
           event: { decoded: eventDecoded, encoded: undefined },
         })
 
@@ -203,7 +205,13 @@ export class Store<TSchema extends LiveStoreSchema = LiveStoreSchema, TContext =
         .map((_) => [_.label!.slice('tableRef:'.length), _] as const),
     )
     for (const tableName of allTableNames) {
-      this.tableRefs[tableName] = existingTableRefs.get(tableName) ?? this.makeTableRef(tableName)
+      this.tableRefs[tableName] =
+        existingTableRefs.get(tableName) ??
+        this.reactivityGraph.makeRef(null, {
+          equal: () => false,
+          label: `tableRef:${tableName}`,
+          meta: { liveStoreRefType: 'table' },
+        })
     }
 
     this.boot = Effect.gen(this, function* () {
@@ -402,23 +410,18 @@ export class Store<TSchema extends LiveStoreSchema = LiveStoreSchema, TContext =
     }
   }
 
-  atom = (): TODO => {}
-
-  // makeLive: {
-  //   <T>(def: LiveQueryDef<T, any>): LiveQuery<T, any>
-  //   <T>(def: ILiveQueryRefDef<T>): ILiveQueryRef<T>
-  // } = (def: any) => {
-  //   if (def._tag === 'live-ref-def') {
-  //     return (def as ILiveQueryRefDef<any>).make(this.reactivityGraph.context!)
-  //   } else {
-  //     return (def as LiveQueryDef<any, any>).make(this.reactivityGraph.context!) as any
-  //   }
-  // }
-
-  setRef = <T>(refDef: ILiveQueryRefDef<T>, value: T): void => {
-    const ref = refDef.make(this.reactivityGraph.context!)
-    ref.value.set(value)
-    ref.deref()
+  setSignal = <T>(signalDef: SignalDef<T>, value: T): void => {
+    const signalRef = signalDef.make(this.reactivityGraph.context!)
+    signalRef.value.set(value)
+
+    // The current implementation of signals i.e. the separation into `signal-def` and `signal`
+    // can lead to a situation where a reffed signal is immediately de-reffed when calling `store.setSignal`,
+    // in case there is nothing else holding a reference to the signal which leads to the set value being "lost".
+    // To avoid this, we don't deref the signal here if this set call is the only reference to the signal.
+    // Hopefully this won't lead to any issues in the future. 🤞
+    if (signalRef.rc > 1) {
+      signalRef.deref()
+    }
   }
 
   // #region commit
@@ -593,12 +596,13 @@ export class Store<TSchema extends LiveStoreSchema = LiveStoreSchema, TContext =
     )
   }
 
-  private makeTableRef = (tableName: string) =>
-    this.reactivityGraph.makeRef(null, {
-      equal: () => false,
-      label: `tableRef:${tableName}`,
-      meta: { liveStoreRefType: 'table' },
-    })
+  /**
+   * Shuts down the store and closes the client session.
+   *
+   * This is called automatically when the store was created using the React or Effect API.
+   */
+  shutdown = (cause?: Cause.Cause<UnexpectedError>) =>
+    this.clientSession.shutdown(cause ?? Cause.fail(IntentionalShutdownCause.make({ reason: 'manual' })))
 
   /**
    * Helper methods useful during development
@@ -638,9 +642,6 @@ export class Store<TSchema extends LiveStoreSchema = LiveStoreSchema, TContext =
       }).pipe(this.runEffectFork)
     },
 
-    shutdown: (cause?: Cause.Cause<UnexpectedError>) =>
-      this.clientSession.shutdown(cause ?? Cause.fail(IntentionalShutdownCause.make({ reason: 'manual' }))),
-
     version: liveStoreVersion,
   }