@livestore/livestore 0.0.56-dev.2 → 0.0.56

package/src/reactiveQueries/sql.test.ts

@@ -1,4 +1,4 @@
-import { Schema } from '@livestore/utils/effect'
+import { Effect, Schema } from '@livestore/utils/effect'
 import * as otel from '@opentelemetry/api'
 import { BasicTracerProvider, InMemorySpanExporter, SimpleSpanProcessor } from '@opentelemetry/sdk-trace-base'
 import { describe, expect, it } from 'vitest'
@@ -17,7 +17,7 @@ TODO write tests for:
 describe('otel', () => {
   let cachedProvider: BasicTracerProvider | undefined
 
-  const makeQuery = async () => {
+  const makeQuery = Effect.gen(function* () {
     const exporter = new InMemorySpanExporter()
 
     const provider = cachedProvider ?? new BasicTracerProvider()
@@ -30,31 +30,30 @@ describe('otel', () => {
     const span = otelTracer.startSpan('test')
     const otelContext = otel.trace.setSpan(otel.context.active(), span)
 
-    const { store } = await makeTodoMvc({ otelTracer, otelContext })
+    const { store } = yield* makeTodoMvc({ otelTracer, otelContext })
 
     return {
-      [Symbol.dispose]: () => store.destroy(),
       store,
       otelTracer,
       exporter,
       span,
       provider,
     }
-  }
+  })
 
   it('otel', async () => {
-    using inputs = await makeQuery()
-    const { store, exporter, span } = inputs
+    const { exporter } = await Effect.gen(function* () {
+      const { store, exporter, span } = yield* makeQuery
 
-    const query = querySQL(`select * from todos`, {
-      schema: Schema.Array(tables.todos.schema),
-      queriedTables: new Set(['todos']),
-    })
-    expect(query.run()).toMatchInlineSnapshot('[]')
+      const query = querySQL(`select * from todos`, {
+        schema: Schema.Array(tables.todos.schema),
+        queriedTables: new Set(['todos']),
+      })
+      expect(query.run()).toMatchInlineSnapshot('[]')
 
-    store.mutate(rawSqlMutation({ sql: sql`INSERT INTO todos (id, text, completed) VALUES ('t1', 'buy milk', 0)` }))
+      store.mutate(rawSqlMutation({ sql: sql`INSERT INTO todos (id, text, completed) VALUES ('t1', 'buy milk', 0)` }))
 
-    expect(query.run()).toMatchInlineSnapshot(`
+      expect(query.run()).toMatchInlineSnapshot(`
       [
         {
           "completed": false,
@@ -64,9 +63,11 @@ describe('otel', () => {
       ]
     `)
 
-    await store.destroy()
-    query.destroy()
-    span.end()
+      query.destroy()
+      span.end()
+
+      return { exporter }
+    }).pipe(Effect.scoped, Effect.tapCauseLogPretty, Effect.runPromise)
 
     expect(getSimplifiedRootSpan(exporter)).toMatchInlineSnapshot(`
       {
@@ -101,7 +102,7 @@ describe('otel', () => {
                     },
                     "children": [
                       {
-                        "_name": "LiveStore:mutatetWithoutRefresh",
+                        "_name": "LiveStore:mutateWithoutRefresh",
                         "attributes": {
                           "livestore.args": "{
         "sql": "INSERT INTO todos (id, text, completed) VALUES ('t1', 'buy milk', 0)"
@@ -168,18 +169,18 @@ describe('otel', () => {
   })
 
   it('with thunks', async () => {
-    using inputs = await makeQuery()
-    const { store, exporter, span } = inputs
+    const { exporter } = await Effect.gen(function* () {
+      const { store, exporter, span } = yield* makeQuery
 
-    const defaultTodo = { id: '', text: '', completed: false }
+      const defaultTodo = { id: '', text: '', completed: false }
 
-    const filter = computed(() => `where completed = 0`, { label: 'where-filter' })
-    const query = querySQL((get) => `select * from todos ${get(filter)}`, {
-      label: 'all todos',
-      schema: Schema.Array(tables.todos.schema).pipe(Schema.headOrElse(() => defaultTodo)),
-    })
+      const filter = computed(() => `where completed = 0`, { label: 'where-filter' })
+      const query = querySQL((get) => `select * from todos ${get(filter)}`, {
+        label: 'all todos',
+        schema: Schema.Array(tables.todos.schema).pipe(Schema.headOrElse(() => defaultTodo)),
+      })
 
-    expect(query.run()).toMatchInlineSnapshot(`
+      expect(query.run()).toMatchInlineSnapshot(`
       {
         "completed": false,
         "id": "",
@@ -187,9 +188,9 @@ describe('otel', () => {
       }
     `)
 
-    store.mutate(rawSqlMutation({ sql: sql`INSERT INTO todos (id, text, completed) VALUES ('t1', 'buy milk', 0)` }))
+      store.mutate(rawSqlMutation({ sql: sql`INSERT INTO todos (id, text, completed) VALUES ('t1', 'buy milk', 0)` }))
 
-    expect(query.run()).toMatchInlineSnapshot(`
+      expect(query.run()).toMatchInlineSnapshot(`
       {
         "completed": false,
         "id": "t1",
@@ -197,9 +198,11 @@ describe('otel', () => {
       }
     `)
 
-    await store.destroy()
-    query.destroy()
-    span.end()
+      query.destroy()
+      span.end()
+
+      return { exporter }
+    }).pipe(Effect.scoped, Effect.tapCauseLogPretty, Effect.runPromise)
 
     expect(getSimplifiedRootSpan(exporter)).toMatchInlineSnapshot(`
       {
@@ -234,7 +237,7 @@ describe('otel', () => {
                     },
                     "children": [
                       {
-                        "_name": "LiveStore:mutatetWithoutRefresh",
+                        "_name": "LiveStore:mutateWithoutRefresh",
                         "attributes": {
                           "livestore.args": "{
         "sql": "INSERT INTO todos (id, text, completed) VALUES ('t1', 'buy milk', 0)"

package/src/store-context.ts

@@ -0,0 +1,23 @@
+import type { IntentionalShutdownCause, UnexpectedError } from '@livestore/common'
+import { Schema } from '@livestore/utils/effect'
+
+import type { Store } from './store.js'
+
+export type LiveStoreContext =
+  | LiveStoreContextRunning
+  | {
+      stage: 'error'
+      error: UnexpectedError | unknown
+    }
+  | {
+      stage: 'shutdown'
+      cause: IntentionalShutdownCause | StoreAbort
+    }
+
+export class StoreAbort extends Schema.TaggedError<StoreAbort>()('LiveStore.StoreAbort', {}) {}
+export class StoreInterrupted extends Schema.TaggedError<StoreInterrupted>()('LiveStore.StoreInterrupted', {}) {}
+
+export type LiveStoreContextRunning = {
+  stage: 'running'
+  store: Store
+}

package/src/store-devtools.ts

@@ -35,6 +35,14 @@ export const connectDevtoolsToStore = ({
     const liveQueriesSubscriptions: SubMap = new Map()
     const debugInfoHistorySubscriptions: SubMap = new Map()
 
+    yield* Effect.addFinalizer(() =>
+      Effect.sync(() => {
+        reactivityGraphSubcriptions.forEach((unsub) => unsub())
+        liveQueriesSubscriptions.forEach((unsub) => unsub())
+        debugInfoHistorySubscriptions.forEach((unsub) => unsub())
+      }),
+    )
+
     const sendToDevtools = (message: Devtools.MessageFromAppHostStore) =>
       storeDevtoolsChannel.send(message).pipe(Effect.tapCauseLogPretty, Effect.runSync)
 

package/src/store.ts

@@ -1,9 +1,9 @@
 import type {
   BootDb,
   BootStatus,
+  IntentionalShutdownCause,
   ParamsObject,
   PreparedBindValues,
-  ResetMode,
   StoreAdapter,
   StoreAdapterFactory,
   StoreDevtoolsChannel,
@@ -12,8 +12,8 @@ import { getExecArgsFromMutation, prepareBindValues, UnexpectedError } from '@li
 import type { LiveStoreSchema, MutationEvent } from '@livestore/common/schema'
 import { makeMutationEventSchemaMemo, SCHEMA_META_TABLE, SCHEMA_MUTATIONS_META_TABLE } from '@livestore/common/schema'
 import { assertNever, makeNoopTracer, shouldNeverHappen } from '@livestore/utils'
-import type { Cause } from '@livestore/utils/effect'
 import {
+  Cause,
   Deferred,
   Duration,
   Effect,
@@ -59,9 +59,6 @@ export type OtelOptions = {
   rootSpanContext: otel.Context
 }
 
-export class ForceStoreShutdown extends Schema.TaggedError<ForceStoreShutdown>()('LiveStore.ForceStoreShutdown', {}) {}
-export class StoreShutdown extends Schema.TaggedError<StoreShutdown>()('LiveStore.StoreShutdown', {}) {}
-
 export type StoreOptions<
   TGraphQLContext extends BaseGraphQLContext,
   TSchema extends LiveStoreSchema = LiveStoreSchema,
@@ -74,6 +71,7 @@ export type StoreOptions<
   reactivityGraph: ReactivityGraph
   disableDevtools?: boolean
   fiberSet: FiberSet.FiberSet
+  runtime: Runtime.Runtime<Scope.Scope>
   // TODO remove this temporary solution and find a better way to avoid re-processing the same mutation
   __processedMutationIds: Set<string>
 }
@@ -125,12 +123,15 @@ export type StoreMutateOptions = {
   persisted?: boolean
 }
 
+if (typeof window !== 'undefined') {
+  window.__debugDownloadBlob = downloadBlob
+}
+
 export class Store<
   TGraphQLContext extends BaseGraphQLContext = BaseGraphQLContext,
   TSchema extends LiveStoreSchema = LiveStoreSchema,
 > extends Inspectable.Class {
   id = uniqueStoreId()
-  private fiberSet: FiberSet.FiberSet
   reactivityGraph: ReactivityGraph
   syncDbWrapper: SynchronousDatabaseWrapper
   adapter: StoreAdapter
@@ -144,6 +145,9 @@ export class Store<
    */
   tableRefs: { [key: string]: Ref<null, QueryContext, RefreshReason> }
 
+  private fiberSet: FiberSet.FiberSet
+  private runtime: Runtime.Runtime<Scope.Scope>
+
   // TODO remove this temporary solution and find a better way to avoid re-processing the same mutation
   private __processedMutationIds
   private __processedMutationWithoutRefreshIds = new Set<string>()
@@ -163,6 +167,7 @@ export class Store<
     disableDevtools,
     __processedMutationIds,
     fiberSet,
+    runtime,
   }: StoreOptions<TGraphQLContext, TSchema>) {
     super()
 
@@ -171,6 +176,7 @@ export class Store<
     this.schema = schema
 
     this.fiberSet = fiberSet
+    this.runtime = runtime
 
     // TODO refactor
     this.__mutationEventSchema = makeMutationEventSchemaMemo(schema)
@@ -254,7 +260,7 @@ export class Store<
       )
 
       yield* Effect.never
-    }).pipe(Effect.scoped, Effect.withSpan('LiveStore:store-constructor'), FiberSet.run(fiberSet), runEffectFork)
+    }).pipe(Effect.scoped, Effect.withSpan('LiveStore:constructor'), this.runEffectFork)
   }
   // #endregion constructor
 
@@ -263,7 +269,7 @@ export class Store<
     parentSpan: otel.Span,
   ): Store<TGraphQLContext, TSchema> => {
     const ctx = otel.trace.setSpan(otel.context.active(), parentSpan)
-    return storeOptions.otelOptions.tracer.startActiveSpan('LiveStore:store-constructor', {}, ctx, (span) => {
+    return storeOptions.otelOptions.tracer.startActiveSpan('LiveStore:createStore', {}, ctx, (span) => {
       try {
         return new Store(storeOptions)
       } finally {
@@ -315,15 +321,6 @@ export class Store<
       },
     )
 
-  /**
-   * Destroys the entire store, including all queries and subscriptions.
-   *
-   * Currently only used when shutting down the app for debugging purposes (e.g. to close Otel spans).
-   */
-  destroy = async () => {
-    await FiberSet.clear(this.fiberSet).pipe(Effect.withSpan('Store:destroy'), runEffectPromise)
-  }
-
   // #region mutate
   mutate: {
     <const TMutationArg extends ReadonlyArray<MutationEvent.ForSchema<TSchema>>>(...list: TMutationArg): void
@@ -509,7 +506,7 @@ export class Store<
     const { otelContext, coordinatorMode = 'default' } = options
 
     return this.otel.tracer.startActiveSpan(
-      'LiveStore:mutatetWithoutRefresh',
+      'LiveStore:mutateWithoutRefresh',
       {
         attributes: {
           'livestore.mutation': mutationEventDecoded.mutation,
@@ -548,7 +545,7 @@ export class Store<
           // Asynchronously apply mutation to a persistent storage (we're not awaiting this promise here)
           this.adapter.coordinator
             .mutate(mutationEventEncoded as MutationEvent.AnyEncoded, { persisted: coordinatorMode !== 'skip-persist' })
-            .pipe(runEffectFork)
+            .pipe(Runtime.runFork(this.runtime))
         }
 
         // Uncomment to print a list of queries currently registered on the store
@@ -575,14 +572,14 @@ export class Store<
   ) => {
     this.syncDbWrapper.execute(query, prepareBindValues(params, query), writeTables, { otelContext })
 
-    this.adapter.coordinator.execute(query, prepareBindValues(params, query)).pipe(runEffectFork)
+    this.adapter.coordinator.execute(query, prepareBindValues(params, query)).pipe(this.runEffectFork)
   }
 
   select = (query: string, params: ParamsObject = {}) => {
     return this.syncDbWrapper.select(query, { bindValues: prepareBindValues(params, query) })
   }
 
-  makeTableRef = (tableName: string) =>
+  private makeTableRef = (tableName: string) =>
     this.reactivityGraph.makeRef(null, {
       equal: () => false,
       label: `tableRef:${tableName}`,
@@ -594,13 +591,11 @@ export class Store<
     downloadBlob(data, `livestore-${Date.now()}.db`)
   }
 
-  __devDownloadMutationLogDb = async () => {
-    const data = await this.adapter.coordinator.getMutationLogData.pipe(runEffectPromise)
-    downloadBlob(data, `livestore-mutationlog-${Date.now()}.db`)
-  }
-
-  // TODO allow for graceful store reset without requiring a full page reload (which should also call .boot)
-  dangerouslyResetStorage = (mode: ResetMode) => this.adapter.coordinator.dangerouslyReset(mode).pipe(runEffectPromise)
+  __devDownloadMutationLogDb = () =>
+    Effect.gen(this, function* () {
+      const data = yield* this.adapter.coordinator.getMutationLogData
+      downloadBlob(data, `livestore-mutationlog-${Date.now()}.db`)
+    }).pipe(this.runEffectFork)
 
   // NOTE This is needed because when booting a Store via Effect it seems to call `toJSON` in the error path
   toJSON = () => {
@@ -609,6 +604,9 @@ export class Store<
       reactivityGraph: this.reactivityGraph.getSnapshot({ includeResults: true }),
     }
   }
+
+  private runEffectFork = <A, E>(effect: Effect.Effect<A, E, never>) =>
+    effect.pipe(Effect.tapCauseLogPretty, FiberSet.run(this.fiberSet), Runtime.runFork(this.runtime))
 }
 
 export type CreateStoreOptions<TGraphQLContext extends BaseGraphQLContext, TSchema extends LiveStoreSchema> = {
@@ -645,7 +643,14 @@ export const createStorePromise = async <
       Effect.andThen((fiberSet) => createStore({ ...options, fiberSet })),
       Scope.extend(scope),
     )
-  }).pipe(Effect.withSpan('createStore'), runEffectPromise)
+  }).pipe(
+    Effect.withSpan('createStore'),
+    Effect.tapCauseLogPretty,
+    Effect.annotateLogs({ thread: 'window' }),
+    Effect.provide(Logger.pretty),
+    Logger.withMinimumLogLevel(LogLevel.Debug),
+    Effect.runPromise,
+  )
 
 // #region createStore
 export const createStore = <
@@ -695,21 +700,31 @@ export const createStore = <
         yield* connectDevtoolsToStore({ storeDevtoolsChannel, store })
       })
 
+    const runtime = yield* Effect.runtime<Scope.Scope>()
+
+    const runEffectFork = (effect: Effect.Effect<any, any, never>) =>
+      effect.pipe(Effect.tapCauseLogPretty, FiberSet.run(fiberSet), Runtime.runFork(runtime))
+
     // TODO close parent scope? (Needs refactor with Mike A)
-    const shutdown = (cause: Cause.Cause<unknown>) =>
+    const shutdown = (cause: Cause.Cause<UnexpectedError | IntentionalShutdownCause>) =>
       Effect.gen(function* () {
-        yield* Effect.logWarning(`Shutting down LiveStore`, cause)
+        // NOTE we're calling `cause.toString()` here to avoid triggering a `console.error` in the grouped log
+        const logCause =
+          Cause.isFailType(cause) && cause.error._tag === 'LiveStore.IntentionalShutdownCause'
+            ? cause.toString()
+            : cause
+        yield* Effect.logDebug(`Shutting down LiveStore`, logCause)
 
         FiberSet.clear(fiberSet).pipe(
-          Effect.andThen(() => FiberSet.run(fiberSet, Effect.fail(StoreShutdown.make()))),
+          Effect.andThen(() => FiberSet.run(fiberSet, Effect.failCause(cause))),
           Effect.timeout(Duration.seconds(1)),
           Effect.logWarnIfTakesLongerThan({ label: '@livestore/livestore:shutdown:clear-fiber-set', duration: 500 }),
-          Effect.catchTag('TimeoutException', () =>
-            Effect.logWarning('Store shutdown timed out. Forcing shutdown.').pipe(
-              Effect.andThen(FiberSet.run(fiberSet, Effect.fail(ForceStoreShutdown.make()))),
+          Effect.catchTag('TimeoutException', (err) =>
+            Effect.logError('Store shutdown timed out. Forcing shutdown.', err).pipe(
+              Effect.andThen(FiberSet.run(fiberSet, Effect.failCause(cause))),
             ),
           ),
-          runEffectFork, // NOTE we need to fork this separately otherwise it will also be interrupted
+          Runtime.runFork(runtime), // NOTE we need to fork this separately otherwise it will also be interrupted
         )
       }).pipe(Effect.withSpan('livestore:shutdown'))
 
@@ -775,11 +790,11 @@ export const createStore = <
         txn: (callback) => {
           try {
             isInTxn = true
-            adapter.syncDb.execute('BEGIN', undefined)
+            // adapter.syncDb.execute('BEGIN TRANSACTION', undefined)
 
             callback()
 
-            adapter.syncDb.execute('COMMIT', undefined)
+            // adapter.syncDb.execute('COMMIT', undefined)
 
             // adapter.coordinator.execute('BEGIN', undefined, undefined)
             for (const [queryStr, bindValues] of txnExecuteStmnts) {
@@ -787,7 +802,7 @@ export const createStore = <
             }
             // adapter.coordinator.execute('COMMIT', undefined, undefined)
           } catch (e: any) {
-            adapter.syncDb.execute('ROLLBACK', undefined)
+            // adapter.syncDb.execute('ROLLBACK', undefined)
             throw e
           } finally {
             isInTxn = false
@@ -812,6 +827,7 @@ export const createStore = <
         disableDevtools,
         __processedMutationIds,
         fiberSet,
+        runtime,
       },
       span,
     )
@@ -829,23 +845,3 @@ export const createStore = <
   )
 }
 // #endregion createStore
-
-// TODO propagate runtime
-const runEffectFork = <A, E>(effect: Effect.Effect<A, E, never>) =>
-  effect.pipe(
-    Effect.tapCauseLogPretty,
-    Effect.annotateLogs({ thread: 'window' }),
-    Effect.provide(Logger.pretty),
-    Logger.withMinimumLogLevel(LogLevel.Debug),
-    Effect.runFork,
-  )
-
-// TODO propagate runtime
-const runEffectPromise = <A, E>(effect: Effect.Effect<A, E, never>) =>
-  effect.pipe(
-    Effect.tapCauseLogPretty,
-    Effect.annotateLogs({ thread: 'window' }),
-    Effect.provide(Logger.pretty),
-    Logger.withMinimumLogLevel(LogLevel.Debug),
-    Effect.runPromise,
-  )

package/vitest.config.js

@@ -11,7 +11,7 @@ export default defineConfig({
   },
   resolve: {
     alias: {
-      '@livestore/sqlite-wasm': '@livestore/sqlite-wasm/node',
+      '@livestore/wa-sqlite/dist/wa-sqlite.mjs': '@livestore/wa-sqlite/dist/wa-sqlite.node.mjs',
     },
   },
 })