@livestore/livestore 0.4.0-dev.16 → 0.4.0-dev.18

package/src/store/devtools.ts

@@ -1,23 +1,14 @@
-import type { ClientSession, ClientSessionSyncProcessor, DebugInfo, SyncState } from '@livestore/common'
+import type { DebugInfo, SyncState } from '@livestore/common'
 import { Devtools, liveStoreVersion, UnexpectedError } from '@livestore/common'
 import { throttle } from '@livestore/utils'
 import type { WebChannel } from '@livestore/utils/effect'
 import { Effect, Stream } from '@livestore/utils/effect'
 import { nanoid } from '@livestore/utils/nanoid'
 
-import type { LiveQuery, ReactivityGraph } from '../live-queries/base-class.ts'
 import { NOT_REFRESHED_YET } from '../reactive.ts'
-import type { SqliteDbWrapper } from '../SqliteDbWrapper.ts'
 import { emptyDebugInfo as makeEmptyDebugInfo } from '../SqliteDbWrapper.ts'
-import type { ReferenceCountedSet } from '../utils/data-structures.ts'
-
-type IStore = {
-  clientSession: ClientSession
-  reactivityGraph: ReactivityGraph
-  sqliteDbWrapper: SqliteDbWrapper
-  activeQueries: ReferenceCountedSet<LiveQuery<any>>
-  syncProcessor: ClientSessionSyncProcessor
-}
+import type { Store } from './store.ts'
+import { StoreInternalsSymbol } from './store-types.ts'
 
 type Unsub = () => void
 type RequestId = string
@@ -40,7 +31,7 @@ export const connectDevtoolsToStore = ({
     Devtools.ClientSession.MessageToApp,
     Devtools.ClientSession.MessageFromApp
   >
-  store: IStore
+  store: Store
 }) =>
   Effect.gen(function* () {
     const reactivityGraphSubcriptions: SubMap = new Map()
@@ -48,7 +39,7 @@ export const connectDevtoolsToStore = ({
     const debugInfoHistorySubscriptions: SubMap = new Map()
     const syncHeadClientSessionSubscriptions: SubMap = new Map()
 
-    const { clientId, sessionId } = store.clientSession
+    const { clientId, sessionId } = store[StoreInternalsSymbol].clientSession
 
     yield* Effect.addFinalizer(() =>
       Effect.sync(() => {
@@ -73,7 +64,21 @@ export const connectDevtoolsToStore = ({
       }
 
       if (decodedMessage._tag === 'LSD.ClientSession.Disconnect') {
-        // console.error('TODO handle disconnect properly in store')
+        // Gracefully tear down all DevTools subscriptions and close the channel.
+        // This prevents background fibers from lingering after DevTools closes
+        // (e.g. when a window is closed without sending explicit unsubs).
+        for (const unsub of reactivityGraphSubcriptions.values()) unsub()
+        reactivityGraphSubcriptions.clear()
+        for (const unsub of liveQueriesSubscriptions.values()) unsub()
+        liveQueriesSubscriptions.clear()
+        for (const unsub of debugInfoHistorySubscriptions.values()) unsub()
+        debugInfoHistorySubscriptions.clear()
+        for (const unsub of syncHeadClientSessionSubscriptions.values()) unsub()
+        syncHeadClientSessionSubscriptions.clear()
+
+        // Signal the WebChannel to shut down; this causes the `listen` stream
+        // to complete and allows the surrounding scoped fiber to exit.
+        storeDevtoolsChannel.shutdown.pipe(Effect.runFork)
         return
       }
 
@@ -103,7 +108,7 @@ export const connectDevtoolsToStore = ({
               () =>
                 sendToDevtools(
                   Devtools.ClientSession.ReactivityGraphRes.make({
-                    reactivityGraph: store.reactivityGraph.getSnapshot({ includeResults }),
+                    reactivityGraph: store[StoreInternalsSymbol].reactivityGraph.getSnapshot({ includeResults }),
                     requestId: nanoid(10),
                     clientId,
                     sessionId,
@@ -121,14 +126,17 @@ export const connectDevtoolsToStore = ({
           // This might need to be tweaked further and possibly be exposed to the user in some way.
           const throttledSend = throttle(send, 20)
 
-          reactivityGraphSubcriptions.set(subscriptionId, store.reactivityGraph.subscribeToRefresh(throttledSend))
+          reactivityGraphSubcriptions.set(
+            subscriptionId,
+            store[StoreInternalsSymbol].reactivityGraph.subscribeToRefresh(throttledSend),
+          )
 
           break
         }
         case 'LSD.ClientSession.DebugInfoReq': {
           sendToDevtools(
             Devtools.ClientSession.DebugInfoRes.make({
-              debugInfo: store.sqliteDbWrapper.debugInfo,
+              debugInfo: store[StoreInternalsSymbol].sqliteDbWrapper.debugInfo,
               requestId,
               clientId,
               sessionId,
@@ -144,13 +152,13 @@ export const connectDevtoolsToStore = ({
           let tickHandle: number | undefined
 
           const tick = () => {
-            buffer.push(store.sqliteDbWrapper.debugInfo)
+            buffer.push(store[StoreInternalsSymbol].sqliteDbWrapper.debugInfo)
 
             // NOTE this resets the debug info, so all other "readers" e.g. in other `requestAnimationFrame` loops,
             // will get the empty debug info
             // TODO We need to come up with a more graceful way to do store. Probably via a single global
             // `requestAnimationFrame` loop that is passed in somehow.
-            store.sqliteDbWrapper.debugInfo = makeEmptyDebugInfo()
+            store[StoreInternalsSymbol].sqliteDbWrapper.debugInfo = makeEmptyDebugInfo()
 
             if (buffer.length > 10) {
               sendToDevtools(
@@ -194,7 +202,7 @@ export const connectDevtoolsToStore = ({
           break
         }
         case 'LSD.ClientSession.DebugInfoResetReq': {
-          store.sqliteDbWrapper.debugInfo.slowQueries.clear()
+          store[StoreInternalsSymbol].sqliteDbWrapper.debugInfo.slowQueries.clear()
           sendToDevtools(
             Devtools.ClientSession.DebugInfoResetRes.make({ requestId, clientId, sessionId, liveStoreVersion }),
           )
@@ -202,7 +210,10 @@ export const connectDevtoolsToStore = ({
         }
         case 'LSD.ClientSession.DebugInfoRerunQueryReq': {
           const { queryStr, bindValues, queriedTables } = decodedMessage
-          store.sqliteDbWrapper.cachedSelect(queryStr, bindValues, { queriedTables, skipCache: true })
+          store[StoreInternalsSymbol].sqliteDbWrapper.cachedSelect(queryStr, bindValues, {
+            queriedTables,
+            skipCache: true,
+          })
           sendToDevtools(
             Devtools.ClientSession.DebugInfoRerunQueryRes.make({ requestId, clientId, sessionId, liveStoreVersion }),
           )
@@ -223,7 +234,7 @@ export const connectDevtoolsToStore = ({
               () =>
                 sendToDevtools(
                   Devtools.ClientSession.LiveQueriesRes.make({
-                    liveQueries: [...store.activeQueries].map((q) => ({
+                    liveQueries: [...store[StoreInternalsSymbol].activeQueries].map((q) => ({
                       _tag: q._tag,
                       id: q.id,
                       label: q.label,
@@ -251,7 +262,10 @@ export const connectDevtoolsToStore = ({
           // Same as in the reactivity graph subscription case above, we need to throttle the updates
           const throttledSend = throttle(send, 20)
 
-          liveQueriesSubscriptions.set(subscriptionId, store.reactivityGraph.subscribeToRefresh(throttledSend))
+          liveQueriesSubscriptions.set(
+            subscriptionId,
+            store[StoreInternalsSymbol].reactivityGraph.subscribeToRefresh(throttledSend),
+          )
 
           break
         }
@@ -278,11 +292,11 @@ export const connectDevtoolsToStore = ({
               }),
             )
 
-          send(store.syncProcessor.syncState.pipe(Effect.runSync))
+          send(store[StoreInternalsSymbol].syncProcessor.syncState.pipe(Effect.runSync))
 
           syncHeadClientSessionSubscriptions.set(
             subscriptionId,
-            store.syncProcessor.syncState.changes.pipe(
+            store[StoreInternalsSymbol].syncProcessor.syncState.changes.pipe(
               Stream.tap((syncState) => send(syncState)),
               Stream.runDrain,
               Effect.interruptible,

package/src/store/store-types.ts

@@ -1,5 +1,6 @@
 import {
   type ClientSession,
+  type ClientSessionSyncProcessor,
   type ClientSessionSyncProcessorSimulationParams,
   type IntentionalShutdownCause,
   type InvalidPullError,
@@ -12,13 +13,20 @@ import {
   type UnexpectedError,
 } from '@livestore/common'
 import type { EventSequenceNumber, LiveStoreEvent, LiveStoreSchema } from '@livestore/common/schema'
-import type { Effect, Runtime, Scope } from '@livestore/utils/effect'
+import type { Effect, Runtime, Schema, Scope } from '@livestore/utils/effect'
 import { Deferred, Predicate } from '@livestore/utils/effect'
 import type * as otel from '@opentelemetry/api'
-
-import type { LiveQuery, LiveQueryDef, SignalDef } from '../live-queries/base-class.ts'
+import type {
+  LiveQuery,
+  LiveQueryDef,
+  ReactivityGraph,
+  ReactivityGraphContext,
+  SignalDef,
+} from '../live-queries/base-class.ts'
 import { TypeId } from '../live-queries/base-class.ts'
-import type { DebugRefreshReasonBase } from '../reactive.ts'
+import type { DebugRefreshReasonBase, Ref } from '../reactive.ts'
+import type { SqliteDbWrapper } from '../SqliteDbWrapper.ts'
+import type { ReferenceCountedSet } from '../utils/data-structures.ts'
 import type { StackInfo } from '../utils/stack-info.ts'
 import type { Store } from './store.ts'
 
@@ -52,6 +60,101 @@ export type OtelOptions = {
   rootSpanContext: otel.Context
 }
 
+export const StoreInternalsSymbol = Symbol.for('livestore.StoreInternals')
+export type StoreInternalsSymbol = typeof StoreInternalsSymbol
+
+/**
+ * Opaque bag containing the Store's implementation details.
+ *
+ * Not part of the public API — shapes and semantics may change without notice.
+ * Access only from within the @livestore/livestore package (and Devtools) via
+ * `StoreInternalsSymbol` to avoid accidental coupling in application code.
+ */
+export type StoreInternals = {
+  /**
+   * Runtime event schema used for encoding/decoding events.
+   *
+   * Exposed primarily for Devtools (e.g. databrowser) to validate ad‑hoc
+   * event payloads. Application code should not depend on it directly.
+   */
+  readonly eventSchema: Schema.Schema<LiveStoreEvent.AnyDecoded, LiveStoreEvent.AnyEncoded>
+
+  /**
+   * The active client session backing this Store. Provides access to the
+   * leader thread, network status, and shutdown signaling.
+   *
+   * Do not close or mutate directly — use `store.shutdown(...)`.
+   */
+  readonly clientSession: ClientSession
+
+  /**
+   * Wrapper around the local SQLite state database. Centralizes query
+   * planning, caching, and change tracking used by reads and materializers.
+   */
+  readonly sqliteDbWrapper: SqliteDbWrapper
+
+  /**
+   * Effect runtime and scope used to fork background fibers for the Store.
+   *
+   * - `runtime` executes effects from imperative Store APIs.
+   * - `lifetimeScope` owns forked fibers; closed during Store shutdown.
+   */
+  readonly effectContext: {
+    /** Effect runtime to run Store effects with proper environment. */
+    readonly runtime: Runtime.Runtime<Scope.Scope>
+    /** Scope that owns all long‑lived fibers spawned by the Store. */
+    readonly lifetimeScope: Scope.Scope
+  }
+
+  /**
+   * OpenTelemetry primitives used for instrumentation of commits, queries,
+   * and Store boot lifecycle.
+   */
+  readonly otel: StoreOtel
+
+  /**
+   * The Store's reactive graph instance used to model dependencies and
+   * propagate updates. Provides APIs to create refs/thunks/effects and to
+   * subscribe to refresh cycles.
+   */
+  readonly reactivityGraph: ReactivityGraph
+
+  /**
+   * Per‑table reactive refs used to broadcast invalidations when materializers
+   * write to tables. Values are always `null`; equality is intentionally
+   * `false` to force recomputation.
+   *
+   * Keys are SQLite table names (user tables; some system tables may be
+   * intentionally excluded from refresh).
+   */
+  readonly tableRefs: Readonly<Record<string, Ref<null, ReactivityGraphContext, RefreshReason>>>
+
+  /**
+   * Set of currently subscribed LiveQuery instances (reference‑counted).
+   * Used for Devtools and diagnostics.
+   */
+  readonly activeQueries: ReferenceCountedSet<LiveQuery<any>>
+
+  /**
+   * Client‑session sync processor orchestrating push/pull and materialization
+   * of events into local state.
+   */
+  readonly syncProcessor: ClientSessionSyncProcessor
+
+  /**
+   * Starts background fibers for sync and observation. Must be run exactly
+   * once per Store instance. Scoped; installs finalizers to end spans and
+   * detach reactive refs.
+   */
+  readonly boot: Effect.Effect<void, UnexpectedError, Scope.Scope>
+
+  /**
+   * Tracks whether the Store has been shut down. When true, mutating APIs
+   * should reject via `checkShutdown`.
+   */
+  isShutdown: boolean
+}
+
 export type StoreOptions<TSchema extends LiveStoreSchema = LiveStoreSchema.Any, TContext = {}> = {
   clientSession: ClientSession
   schema: TSchema