@livestore/livestore 0.3.0-dev.10 → 0.3.0-dev.12

package/src/store/create-store.ts

@@ -2,8 +2,9 @@ import type {
   Adapter,
   BootStatus,
   ClientSession,
+  ClientSessionDevtoolsChannel,
   IntentionalShutdownCause,
-  StoreDevtoolsChannel,
+  MigrationsReport,
 } from '@livestore/common'
 import { provideOtel, UnexpectedError } from '@livestore/common'
 import type { EventId, LiveStoreSchema, MutationEvent } from '@livestore/common/schema'
@@ -14,6 +15,7 @@ import {
   Effect,
   Exit,
   identity,
+  Layer,
   Logger,
   LogLevel,
   MutableHashMap,
@@ -26,8 +28,7 @@ import {
 import { nanoid } from '@livestore/utils/nanoid'
 import * as otel from '@opentelemetry/api'
 
-import { globalReactivityGraph } from '../global-state.js'
-import type { ReactivityGraph } from '../live-queries/base-class.js'
+import { LiveStoreContextRunning } from '../effect/index.js'
 import { connectDevtoolsToStore } from './devtools.js'
 import { Store } from './store.js'
 import type { BaseGraphQLContext, GraphQLOptions, OtelOptions, ShutdownDeferred } from './store-types.js'
@@ -36,12 +37,14 @@ export interface CreateStoreOptions<TGraphQLContext extends BaseGraphQLContext,
   schema: TSchema
   adapter: Adapter
   storeId: string
-  reactivityGraph?: ReactivityGraph
   graphQLOptions?: GraphQLOptions<TGraphQLContext>
   boot?: (
     store: Store<TGraphQLContext, TSchema>,
-    parentSpan: otel.Span,
-  ) => void | Promise<void> | Effect.Effect<void, unknown, OtelTracer.OtelTracer>
+    ctx: {
+      migrationsReport: MigrationsReport
+      parentSpan: otel.Span
+    },
+  ) => void | Promise<void> | Effect.Effect<void, unknown, OtelTracer.OtelTracer | LiveStoreContextRunning>
   batchUpdates?: (run: () => void) => void
   disableDevtools?: boolean
   onBootStatus?: (status: BootStatus) => void
@@ -95,7 +98,6 @@ export const createStore = <
   storeId,
   graphQLOptions,
   boot,
-  reactivityGraph = globalReactivityGraph,
   batchUpdates,
   disableDevtools,
   onBootStatus,
@@ -109,6 +111,8 @@ export const createStore = <
   Effect.gen(function* () {
     const lifetimeScope = yield* Scope.make()
 
+    yield* validateStoreId(storeId)
+
     yield* Effect.addFinalizer((_) => Scope.close(lifetimeScope, _))
 
     const debugInstanceId = debug?.instanceId ?? nanoid(10)
@@ -130,7 +134,7 @@ export const createStore = <
 
       const storeDeferred = yield* Deferred.make<Store>()
 
-      const connectDevtoolsToStore_ = (storeDevtoolsChannel: StoreDevtoolsChannel) =>
+      const connectDevtoolsToStore_ = (storeDevtoolsChannel: ClientSessionDevtoolsChannel) =>
         Effect.gen(function* () {
           const store = yield* storeDeferred
           yield* connectDevtoolsToStore({ storeDevtoolsChannel, store })
@@ -160,32 +164,44 @@ export const createStore = <
         debugInstanceId,
       }).pipe(Effect.withPerformanceMeasure('livestore:makeAdapter'), Effect.withSpan('createStore:makeAdapter'))
 
+      if (LS_DEV && clientSession.leaderThread.initialState.migrationsReport.migrations.length > 0) {
+        yield* Effect.logDebug(
+          '[@livestore/livestore:createStore] migrationsReport',
+          ...clientSession.leaderThread.initialState.migrationsReport.migrations.map(
+            (m) =>
+              `Schema hash mismatch for table '${m.tableName}' (DB: ${m.hashes.actual}, expected: ${m.hashes.expected}), migrating table...`,
+          ),
+        )
+      }
+
       // TODO fill up with unsynced mutation events from the client session
       const unsyncedMutationEvents = MutableHashMap.empty<EventId.EventId, MutationEvent.ForSchema<TSchema>>()
 
-      const store = Store.createStore<TGraphQLContext, TSchema>(
-        {
-          clientSession,
-          schema,
-          graphQLOptions,
-          otelOptions: { tracer: otelTracer, rootSpanContext: otelRootSpanContext },
-          reactivityGraph,
-          disableDevtools,
-          unsyncedMutationEvents,
-          lifetimeScope,
-          runtime,
-          // NOTE during boot we're not yet executing mutations in a batched context
-          // but only set the provided `batchUpdates` function after boot
-          batchUpdates: (run) => run(),
-          storeId,
-        },
-        span,
-      )
+      const store = new Store<TGraphQLContext, TSchema>({
+        clientSession,
+        schema,
+        graphQLOptions,
+        otelOptions: { tracer: otelTracer, rootSpanContext: otelRootSpanContext },
+        disableDevtools,
+        unsyncedMutationEvents,
+        lifetimeScope,
+        runtime,
+        // NOTE during boot we're not yet executing mutations in a batched context
+        // but only set the provided `batchUpdates` function after boot
+        batchUpdates: (run) => run(),
+        storeId,
+      })
+
+      // Starts background fibers (syncing, mutation processing, etc) for store
+      yield* store.boot
 
       if (boot !== undefined) {
         // TODO also incorporate `boot` function progress into `bootStatusQueue`
-        yield* Effect.tryAll(() => boot(store, span)).pipe(
+        yield* Effect.tryAll(() =>
+          boot(store, { migrationsReport: clientSession.leaderThread.initialState.migrationsReport, parentSpan: span }),
+        ).pipe(
           UnexpectedError.mapToUnexpectedError,
+          Effect.provide(Layer.succeed(LiveStoreContextRunning, { stage: 'running', store: store as any as Store })),
           Effect.withSpan('createStore:boot'),
         )
       }
@@ -208,3 +224,15 @@ export const createStore = <
       Scope.extend(lifetimeScope),
     )
   })
+
+const validateStoreId = (storeId: string) =>
+  Effect.gen(function* () {
+    const validChars = /^[a-zA-Z0-9_-]+$/
+
+    if (!validChars.test(storeId)) {
+      return yield* UnexpectedError.make({
+        cause: `Invalid storeId: ${storeId}. Only alphanumeric characters, underscores, and hyphens are allowed.`,
+        payload: { storeId },
+      })
+    }
+  })

package/src/store/devtools.ts

@@ -1,4 +1,4 @@
-import type { ClientSession, DebugInfo } from '@livestore/common'
+import type { ClientSession, ClientSessionSyncProcessor, DebugInfo, SyncState } from '@livestore/common'
 import { Devtools, liveStoreVersion, UnexpectedError } from '@livestore/common'
 import { throttle } from '@livestore/utils'
 import type { WebChannel } from '@livestore/utils/effect'
@@ -6,15 +6,16 @@ import { Effect, Stream } from '@livestore/utils/effect'
 
 import type { LiveQuery, ReactivityGraph } from '../live-queries/base-class.js'
 import { NOT_REFRESHED_YET } from '../reactive.js'
-import type { SynchronousDatabaseWrapper } from '../SynchronousDatabaseWrapper.js'
-import { emptyDebugInfo as makeEmptyDebugInfo } from '../SynchronousDatabaseWrapper.js'
+import type { SqliteDbWrapper } from '../SqliteDbWrapper.js'
+import { emptyDebugInfo as makeEmptyDebugInfo } from '../SqliteDbWrapper.js'
 import type { ReferenceCountedSet } from '../utils/data-structures.js'
 
 type IStore = {
   clientSession: ClientSession
   reactivityGraph: ReactivityGraph
-  syncDbWrapper: SynchronousDatabaseWrapper
+  sqliteDbWrapper: SqliteDbWrapper
   activeQueries: ReferenceCountedSet<LiveQuery<any>>
+  syncProcessor: ClientSessionSyncProcessor
 }
 
 type Unsub = () => void
@@ -34,13 +35,17 @@ export const connectDevtoolsToStore = ({
   storeDevtoolsChannel,
   store,
 }: {
-  storeDevtoolsChannel: WebChannel.WebChannel<Devtools.MessageToAppClientSession, Devtools.MessageFromAppClientSession>
+  storeDevtoolsChannel: WebChannel.WebChannel<
+    Devtools.ClientSession.MessageToApp,
+    Devtools.ClientSession.MessageFromApp
+  >
   store: IStore
 }) =>
   Effect.gen(function* () {
     const reactivityGraphSubcriptions: SubMap = new Map()
     const liveQueriesSubscriptions: SubMap = new Map()
     const debugInfoHistorySubscriptions: SubMap = new Map()
+    const syncHeadClientSessionSubscriptions: SubMap = new Map()
 
     const { clientId, sessionId } = store.clientSession
 
@@ -49,13 +54,14 @@ export const connectDevtoolsToStore = ({
         reactivityGraphSubcriptions.forEach((unsub) => unsub())
         liveQueriesSubscriptions.forEach((unsub) => unsub())
         debugInfoHistorySubscriptions.forEach((unsub) => unsub())
+        syncHeadClientSessionSubscriptions.forEach((unsub) => unsub())
       }),
     )
 
-    const sendToDevtools = (message: Devtools.MessageFromAppClientSession) =>
+    const sendToDevtools = (message: Devtools.ClientSession.MessageFromApp) =>
       storeDevtoolsChannel.send(message).pipe(Effect.tapCauseLogPretty, Effect.runFork)
 
-    const onMessage = (decodedMessage: typeof Devtools.MessageToAppClientSession.Type) => {
+    const onMessage = (decodedMessage: typeof Devtools.ClientSession.MessageToApp.Type) => {
       // console.debug('@livestore/livestore:store:devtools:onMessage', decodedMessage)
 
       if (decodedMessage.clientId !== clientId || decodedMessage.sessionId !== sessionId) {
@@ -63,7 +69,7 @@ export const connectDevtoolsToStore = ({
         return
       }
 
-      if (decodedMessage._tag === 'LSD.Disconnect') {
+      if (decodedMessage._tag === 'LSD.ClientSession.Disconnect') {
         // console.error('TODO handle disconnect properly in store')
         return
       }
@@ -73,7 +79,7 @@ export const connectDevtoolsToStore = ({
       const requestIdleCallback = globalThis.requestIdleCallback ?? ((cb: () => void) => cb())
 
       switch (decodedMessage._tag) {
-        case 'LSD.ReactivityGraphSubscribe': {
+        case 'LSD.ClientSession.ReactivityGraphSubscribe': {
           const includeResults = decodedMessage.includeResults
 
           const send = () =>
@@ -82,7 +88,7 @@ export const connectDevtoolsToStore = ({
             requestIdleCallback(
               () =>
                 sendToDevtools(
-                  Devtools.ReactivityGraphRes.make({
+                  Devtools.ClientSession.ReactivityGraphRes.make({
                     reactivityGraph: store.reactivityGraph.getSnapshot({ includeResults }),
                     requestId,
                     clientId,
@@ -104,10 +110,10 @@ export const connectDevtoolsToStore = ({
 
           break
         }
-        case 'LSD.DebugInfoReq': {
+        case 'LSD.ClientSession.DebugInfoReq': {
           sendToDevtools(
-            Devtools.DebugInfoRes.make({
-              debugInfo: store.syncDbWrapper.debugInfo,
+            Devtools.ClientSession.DebugInfoRes.make({
+              debugInfo: store.sqliteDbWrapper.debugInfo,
               requestId,
               clientId,
               sessionId,
@@ -116,23 +122,23 @@ export const connectDevtoolsToStore = ({
           )
           break
         }
-        case 'LSD.DebugInfoHistorySubscribe': {
+        case 'LSD.ClientSession.DebugInfoHistorySubscribe': {
           const buffer: DebugInfo[] = []
           let hasStopped = false
           let tickHandle: number | undefined
 
           const tick = () => {
-            buffer.push(store.syncDbWrapper.debugInfo)
+            buffer.push(store.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.syncDbWrapper.debugInfo = makeEmptyDebugInfo()
+            store.sqliteDbWrapper.debugInfo = makeEmptyDebugInfo()
 
             if (buffer.length > 10) {
               sendToDevtools(
-                Devtools.DebugInfoHistoryRes.make({
+                Devtools.ClientSession.DebugInfoHistoryRes.make({
                   debugInfoHistory: buffer,
                   requestId,
                   clientId,
@@ -162,36 +168,40 @@ export const connectDevtoolsToStore = ({
 
           break
         }
-        case 'LSD.DebugInfoHistoryUnsubscribe': {
+        case 'LSD.ClientSession.DebugInfoHistoryUnsubscribe': {
           // NOTE given WebMesh channels have persistent retry behaviour, it can happen that a previous
           // WebMesh channel will send a unsubscribe message for an old requestId. Thus the `?.()` handling.
           debugInfoHistorySubscriptions.get(requestId)?.()
           debugInfoHistorySubscriptions.delete(requestId)
           break
         }
-        case 'LSD.DebugInfoResetReq': {
-          store.syncDbWrapper.debugInfo.slowQueries.clear()
-          sendToDevtools(Devtools.DebugInfoResetRes.make({ requestId, clientId, sessionId, liveStoreVersion }))
+        case 'LSD.ClientSession.DebugInfoResetReq': {
+          store.sqliteDbWrapper.debugInfo.slowQueries.clear()
+          sendToDevtools(
+            Devtools.ClientSession.DebugInfoResetRes.make({ requestId, clientId, sessionId, liveStoreVersion }),
+          )
           break
         }
-        case 'LSD.DebugInfoRerunQueryReq': {
+        case 'LSD.ClientSession.DebugInfoRerunQueryReq': {
           const { queryStr, bindValues, queriedTables } = decodedMessage
-          store.syncDbWrapper.select(queryStr, { bindValues, queriedTables, skipCache: true })
-          sendToDevtools(Devtools.DebugInfoRerunQueryRes.make({ requestId, clientId, sessionId, liveStoreVersion }))
+          store.sqliteDbWrapper.select(queryStr, bindValues, { queriedTables, skipCache: true })
+          sendToDevtools(
+            Devtools.ClientSession.DebugInfoRerunQueryRes.make({ requestId, clientId, sessionId, liveStoreVersion }),
+          )
           break
         }
-        case 'LSD.ReactivityGraphUnsubscribe': {
+        case 'LSD.ClientSession.ReactivityGraphUnsubscribe': {
           // NOTE given WebMesh channels have persistent retry behaviour, it can happen that a previous
           // WebMesh channel will send a unsubscribe message for an old requestId. Thus the `?.()` handling.
           reactivityGraphSubcriptions.get(requestId)?.()
           break
         }
-        case 'LSD.LiveQueriesSubscribe': {
+        case 'LSD.ClientSession.LiveQueriesSubscribe': {
           const send = () =>
             requestIdleCallback(
               () =>
                 sendToDevtools(
-                  Devtools.LiveQueriesRes.make({
+                  Devtools.ClientSession.LiveQueriesRes.make({
                     liveQueries: [...store.activeQueries].map((q) => ({
                       _tag: q._tag,
                       id: q.id,
@@ -222,14 +232,49 @@ export const connectDevtoolsToStore = ({
 
           break
         }
-        case 'LSD.LiveQueriesUnsubscribe': {
+        case 'LSD.ClientSession.LiveQueriesUnsubscribe': {
           // NOTE given WebMesh channels have persistent retry behaviour, it can happen that a previous
           // WebMesh channel will send a unsubscribe message for an old requestId. Thus the `?.()` handling.
           liveQueriesSubscriptions.get(requestId)?.()
           liveQueriesSubscriptions.delete(requestId)
           break
         }
-        // No default
+        case 'LSD.ClientSession.SyncHeadSubscribe': {
+          const send = (syncState: SyncState) =>
+            sendToDevtools(
+              Devtools.ClientSession.SyncHeadRes.make({
+                local: syncState.localHead,
+                upstream: syncState.upstreamHead,
+                requestId,
+                clientId,
+                sessionId,
+                liveStoreVersion,
+              }),
+            )
+
+          send(store.syncProcessor.syncState.pipe(Effect.runSync))
+
+          syncHeadClientSessionSubscriptions.set(
+            requestId,
+            store.syncProcessor.syncState.changes.pipe(
+              Stream.tap((syncState) => send(syncState)),
+              Stream.runDrain,
+              Effect.interruptible,
+              Effect.tapCauseLogPretty,
+              Effect.runCallback,
+            ),
+          )
+
+          break
+        }
+        case 'LSD.ClientSession.SyncHeadUnsubscribe': {
+          syncHeadClientSessionSubscriptions.get(requestId)?.()
+          syncHeadClientSessionSubscriptions.delete(requestId)
+          break
+        }
+        default: {
+          console.warn(`[LSD.ClientSession] Unknown message`, decodedMessage)
+        }
       }
     }
 

package/src/store/store-types.ts

@@ -5,9 +5,8 @@ import { Schema } from '@livestore/utils/effect'
 import type * as otel from '@opentelemetry/api'
 import type { GraphQLSchema } from 'graphql'
 
-import type { ReactivityGraph } from '../live-queries/base-class.js'
 import type { DebugRefreshReasonBase } from '../reactive.js'
-import type { SynchronousDatabaseWrapper } from '../SynchronousDatabaseWrapper.js'
+import type { SqliteDbWrapper } from '../SqliteDbWrapper.js'
 import type { StackInfo } from '../utils/stack-info.js'
 import type { Store } from './store.js'
 
@@ -43,7 +42,7 @@ export type BaseGraphQLContext = {
 
 export type GraphQLOptions<TContext> = {
   schema: GraphQLSchema
-  makeContext: (db: SynchronousDatabaseWrapper, tracer: otel.Tracer, sessionId: string) => TContext
+  makeContext: (db: SqliteDbWrapper, tracer: otel.Tracer, sessionId: string) => TContext
 }
 
 export type OtelOptions = {
@@ -61,7 +60,6 @@ export type StoreOptions<
   // TODO remove graphql-related stuff from store and move to GraphQL query directly
   graphQLOptions?: GraphQLOptions<TGraphQLContext>
   otelOptions: OtelOptions
-  reactivityGraph: ReactivityGraph
   disableDevtools?: boolean
   lifetimeScope: Scope.Scope
   runtime: Runtime.Runtime<Scope.Scope>
@@ -87,6 +85,8 @@ export type RefreshReason =
       label?: string
       stackInfo?: StackInfo
     }
+  | { _tag: 'subscribe.initial'; label?: string }
+  | { _tag: 'subscribe.update'; label?: string }
   | { _tag: 'manual'; label?: string }
 
 export type QueryDebugInfo = {
@@ -108,3 +108,5 @@ export type StoreMutateOptions = {
   spanLinks?: otel.Link[]
   otelContext?: otel.Context
 }
+
+export type Unsubscribe = () => void