@livestore/livestore 0.2.0 → 0.3.0-dev.11

package/src/live-queries/__snapshots__/{db.test.ts.snap → db-query.test.ts.snap}

@@ -2,7 +2,11 @@
 
 exports[`otel > otel 3`] = `
 {
-  "_name": "test",
+  "_name": "createStore",
+  "attributes": {
+    "debugInstanceId": "test",
+    "storeId": "default",
+  },
   "children": [
     {
       "_name": "livestore.in-memory-db:execute",
@@ -17,39 +21,26 @@ exports[`otel > otel 3`] = `
     ",
       },
     },
+    {
+      "_name": "LiveStore:sync",
+    },
     {
       "_name": "LiveStore:mutations",
       "children": [
         {
           "_name": "LiveStore:mutate",
           "attributes": {
-            "livestore.mutateLabel": "mutate",
+            "livestore.mutationEventTags": [
+              "livestore.RawSql",
+            ],
+            "livestore.mutationEventsCount": 1,
           },
           "children": [
             {
-              "_name": "LiveStore:processWrites",
+              "_name": "livestore.in-memory-db:execute",
               "attributes": {
-                "livestore.mutateLabel": "mutate",
+                "sql.query": "INSERT INTO todos (id, text, completed) VALUES ('t1', 'buy milk', 0)",
               },
-              "children": [
-                {
-                  "_name": "LiveStore:mutateWithoutRefresh",
-                  "attributes": {
-                    "livestore.args": "{
-  "sql": "INSERT INTO todos (id, text, completed) VALUES ('t1', 'buy milk', 0)"
-}",
-                    "livestore.mutation": "livestore.RawSql",
-                  },
-                  "children": [
-                    {
-                      "_name": "livestore.in-memory-db:execute",
-                      "attributes": {
-                        "sql.query": "INSERT INTO todos (id, text, completed) VALUES ('t1', 'buy milk', 0)",
-                      },
-                    },
-                  ],
-                },
-              ],
             },
           ],
         },
@@ -98,9 +89,185 @@ exports[`otel > otel 3`] = `
 }
 `;
 
+exports[`otel > with thunks 1`] = `
+{
+  "atoms": [
+    {
+      "_tag": "ref",
+      "id": "node-1",
+      "isDestroyed": false,
+      "isDirty": false,
+      "label": "tableRef:todos",
+      "meta": {
+        "liveStoreRefType": "table",
+      },
+      "previousResult": {
+        "_tag": "Some",
+        "value": "null",
+      },
+      "refreshes": 0,
+      "sub": [],
+      "super": [],
+    },
+    {
+      "_tag": "ref",
+      "id": "node-2",
+      "isDestroyed": false,
+      "isDirty": false,
+      "label": "tableRef:app",
+      "meta": {
+        "liveStoreRefType": "table",
+      },
+      "previousResult": {
+        "_tag": "Some",
+        "value": "null",
+      },
+      "refreshes": 0,
+      "sub": [],
+      "super": [],
+    },
+  ],
+  "deferredEffects": [],
+  "effects": [],
+}
+`;
+
 exports[`otel > with thunks 3`] = `
 {
-  "_name": "test",
+  "atoms": [
+    {
+      "_tag": "ref",
+      "id": "node-1",
+      "isDestroyed": false,
+      "isDirty": false,
+      "label": "tableRef:todos",
+      "meta": {
+        "liveStoreRefType": "table",
+      },
+      "previousResult": {
+        "_tag": "Some",
+        "value": "null",
+      },
+      "refreshes": 0,
+      "sub": [],
+      "super": [],
+    },
+    {
+      "_tag": "ref",
+      "id": "node-2",
+      "isDestroyed": false,
+      "isDirty": false,
+      "label": "tableRef:app",
+      "meta": {
+        "liveStoreRefType": "table",
+      },
+      "previousResult": {
+        "_tag": "Some",
+        "value": "null",
+      },
+      "refreshes": 0,
+      "sub": [],
+      "super": [],
+    },
+  ],
+  "deferredEffects": [],
+  "effects": [],
+}
+`;
+
+exports[`otel > with thunks 4`] = `
+{
+  "atoms": [
+    {
+      "_tag": "ref",
+      "id": "node-1",
+      "isDestroyed": false,
+      "isDirty": false,
+      "label": "tableRef:todos",
+      "meta": {
+        "liveStoreRefType": "table",
+      },
+      "previousResult": {
+        "_tag": "Some",
+        "value": "null",
+      },
+      "refreshes": 1,
+      "sub": [],
+      "super": [],
+    },
+    {
+      "_tag": "ref",
+      "id": "node-2",
+      "isDestroyed": false,
+      "isDirty": false,
+      "label": "tableRef:app",
+      "meta": {
+        "liveStoreRefType": "table",
+      },
+      "previousResult": {
+        "_tag": "Some",
+        "value": "null",
+      },
+      "refreshes": 0,
+      "sub": [],
+      "super": [],
+    },
+  ],
+  "deferredEffects": [],
+  "effects": [],
+}
+`;
+
+exports[`otel > with thunks 6`] = `
+{
+  "atoms": [
+    {
+      "_tag": "ref",
+      "id": "node-1",
+      "isDestroyed": false,
+      "isDirty": false,
+      "label": "tableRef:todos",
+      "meta": {
+        "liveStoreRefType": "table",
+      },
+      "previousResult": {
+        "_tag": "Some",
+        "value": "null",
+      },
+      "refreshes": 1,
+      "sub": [],
+      "super": [],
+    },
+    {
+      "_tag": "ref",
+      "id": "node-2",
+      "isDestroyed": false,
+      "isDirty": false,
+      "label": "tableRef:app",
+      "meta": {
+        "liveStoreRefType": "table",
+      },
+      "previousResult": {
+        "_tag": "Some",
+        "value": "null",
+      },
+      "refreshes": 0,
+      "sub": [],
+      "super": [],
+    },
+  ],
+  "deferredEffects": [],
+  "effects": [],
+}
+`;
+
+exports[`otel > with thunks 7`] = `
+{
+  "_name": "createStore",
+  "attributes": {
+    "debugInstanceId": "test",
+    "storeId": "default",
+  },
   "children": [
     {
       "_name": "livestore.in-memory-db:execute",
@@ -115,39 +282,26 @@ exports[`otel > with thunks 3`] = `
     ",
       },
     },
+    {
+      "_name": "LiveStore:sync",
+    },
     {
       "_name": "LiveStore:mutations",
       "children": [
         {
           "_name": "LiveStore:mutate",
           "attributes": {
-            "livestore.mutateLabel": "mutate",
+            "livestore.mutationEventTags": [
+              "livestore.RawSql",
+            ],
+            "livestore.mutationEventsCount": 1,
           },
           "children": [
             {
-              "_name": "LiveStore:processWrites",
+              "_name": "livestore.in-memory-db:execute",
               "attributes": {
-                "livestore.mutateLabel": "mutate",
+                "sql.query": "INSERT INTO todos (id, text, completed) VALUES ('t1', 'buy milk', 0)",
               },
-              "children": [
-                {
-                  "_name": "LiveStore:mutateWithoutRefresh",
-                  "attributes": {
-                    "livestore.args": "{
-  "sql": "INSERT INTO todos (id, text, completed) VALUES ('t1', 'buy milk', 0)"
-}",
-                    "livestore.mutation": "livestore.RawSql",
-                  },
-                  "children": [
-                    {
-                      "_name": "livestore.in-memory-db:execute",
-                      "attributes": {
-                        "sql.query": "INSERT INTO todos (id, text, completed) VALUES ('t1', 'buy milk', 0)",
-                      },
-                    },
-                  ],
-                },
-              ],
             },
           ],
         },
@@ -183,6 +337,9 @@ exports[`otel > with thunks 3`] = `
             "sql.rowsCount": 1,
           },
           "children": [
+            {
+              "_name": "js:where-filter",
+            },
             {
               "_name": "sql-in-memory-select",
               "attributes": {
@@ -201,7 +358,11 @@ exports[`otel > with thunks 3`] = `
 
 exports[`otel > with thunks with query builder and without labels 3`] = `
 {
-  "_name": "test",
+  "_name": "createStore",
+  "attributes": {
+    "debugInstanceId": "test",
+    "storeId": "default",
+  },
   "children": [
     {
       "_name": "livestore.in-memory-db:execute",
@@ -216,39 +377,26 @@ exports[`otel > with thunks with query builder and without labels 3`] = `
     ",
       },
     },
+    {
+      "_name": "LiveStore:sync",
+    },
     {
       "_name": "LiveStore:mutations",
       "children": [
         {
           "_name": "LiveStore:mutate",
           "attributes": {
-            "livestore.mutateLabel": "mutate",
+            "livestore.mutationEventTags": [
+              "livestore.RawSql",
+            ],
+            "livestore.mutationEventsCount": 1,
           },
           "children": [
             {
-              "_name": "LiveStore:processWrites",
+              "_name": "livestore.in-memory-db:execute",
               "attributes": {
-                "livestore.mutateLabel": "mutate",
+                "sql.query": "INSERT INTO todos (id, text, completed) VALUES ('t1', 'buy milk', 0)",
               },
-              "children": [
-                {
-                  "_name": "LiveStore:mutateWithoutRefresh",
-                  "attributes": {
-                    "livestore.args": "{
-  "sql": "INSERT INTO todos (id, text, completed) VALUES ('t1', 'buy milk', 0)"
-}",
-                    "livestore.mutation": "livestore.RawSql",
-                  },
-                  "children": [
-                    {
-                      "_name": "livestore.in-memory-db:execute",
-                      "attributes": {
-                        "sql.query": "INSERT INTO todos (id, text, completed) VALUES ('t1', 'buy milk', 0)",
-                      },
-                    },
-                  ],
-                },
-              ],
             },
           ],
         },
@@ -284,6 +432,9 @@ exports[`otel > with thunks with query builder and without labels 3`] = `
             "sql.rowsCount": 1,
           },
           "children": [
+            {
+              "_name": "js:() => ({ completed: false })",
+            },
             {
               "_name": "sql-in-memory-select",
               "attributes": {

package/src/live-queries/base-class.ts

@@ -1,59 +1,119 @@
 import type { QueryInfo } from '@livestore/common'
+import { isNotNil } from '@livestore/utils'
+import { GlobalValue } from '@livestore/utils/effect'
 import type * as otel from '@opentelemetry/api'
 
-import { type Atom, type GetAtom, ReactiveGraph, throwContextNotSetError, type Thunk } from '../reactive.js'
+import * as RG from '../reactive.js'
 import type { Store } from '../store/store.js'
 import type { QueryDebugInfo, RefreshReason } from '../store/store-types.js'
 import type { StackInfo } from '../utils/stack-info.js'
 
-export type ReactivityGraph = ReactiveGraph<RefreshReason, QueryDebugInfo, QueryContext>
+export type ReactivityGraph = RG.ReactiveGraph<RefreshReason, QueryDebugInfo, ReactivityGraphContext>
 
 export const makeReactivityGraph = (): ReactivityGraph =>
-  new ReactiveGraph<RefreshReason, QueryDebugInfo, QueryContext>()
+  new RG.ReactiveGraph<RefreshReason, QueryDebugInfo, ReactivityGraphContext>()
 
-export type QueryContext = {
+export const defCounterRef = GlobalValue.globalValue('livestore-def-counter', () => ({ current: 0 }))
+
+type LiveQueryDefHash = string
+
+export type LiveQueryRCMap = Map<LiveQueryDefHash, RcRef<LiveQueryAny | ILiveQueryRef<any>>>
+
+export type ReactivityGraphContext = {
   store: Store
+  liveQueryRCMap: LiveQueryRCMap
+  /** Back-reference to the reactivity graph for convenience */
+  reactivityGraph: WeakRef<ReactivityGraph>
   otelTracer: otel.Tracer
   rootOtelContext: otel.Context
   effectsWrapper: (run: () => void) => void
 }
 
-export type UnsubscribeQuery = () => void
-
-export type GetResult<TQuery extends LiveQueryAny> =
-  TQuery extends LiveQuery<infer TResult, infer _1> ? TResult : unknown
+export type GetResult<TQuery extends LiveQueryDefAny | LiveQueryAny> =
+  TQuery extends LiveQuery<infer TResult, infer _1>
+    ? TResult
+    : TQuery extends LiveQueryDef<infer TResult, infer _1>
+      ? TResult
+      : unknown
 
 let queryIdCounter = 0
 
 export type LiveQueryAny = LiveQuery<any, QueryInfo>
+export type LiveQueryDefAny = LiveQueryDef<any, any>
+
+export interface ILiveQueryRefDef<T> {
+  _tag: 'live-ref-def'
+  defaultValue: T
+  make: (ctx: ReactivityGraphContext) => RcRef<ILiveQueryRef<T>>
+}
+
+export interface ILiveQueryRef<T> {
+  _tag: 'live-ref'
+  reactivityGraph: ReactivityGraph
+  ref: RG.Ref<T, ReactivityGraphContext, RefreshReason>
+  set: (value: T) => void
+  get: () => T
+  destroy: () => void
+}
 
 export const TypeId = Symbol.for('LiveQuery')
 export type TypeId = typeof TypeId
 
+export interface RcRef<T> {
+  rc: number
+  value: T
+  deref: () => void
+}
+
+export type DepKey = string | number | ReadonlyArray<string | number | undefined | null>
+
+export const depsToString = (deps: DepKey): string => {
+  if (typeof deps === 'string' || typeof deps === 'number') {
+    return deps.toString()
+  }
+  return deps.filter(isNotNil).join(',')
+}
+
+export interface LiveQueryDef<TResult, TQueryInfo extends QueryInfo = QueryInfo.None> {
+  _tag: 'def'
+  // TODO do we need both id and hash?
+  /** A unique identifier for the query definition */
+  id: number
+  /** Creates a new LiveQuery instance bound to a specific store/reactivityGraph */
+  make: (ctx: ReactivityGraphContext, otelContext?: otel.Context) => RcRef<LiveQuery<TResult, TQueryInfo>>
+  label: string
+  hash: string
+  queryInfo: TQueryInfo
+}
+
+/**
+ * A LiveQuery is stateful
+ */
 export interface LiveQuery<TResult, TQueryInfo extends QueryInfo = QueryInfo.None> {
   id: number
   _tag: 'computed' | 'db' | 'graphql'
   [TypeId]: TypeId
 
+  // reactivityGraph: ReactivityGraph
+
   /** This should only be used on a type-level and doesn't hold any value during runtime */
   '__result!': TResult
 
   /** A reactive thunk representing the query results */
-  results$: Thunk<TResult, QueryContext, RefreshReason>
+  results$: RG.Thunk<TResult, ReactivityGraphContext, RefreshReason>
 
   label: string
 
-  run: (otelContext?: otel.Context, debugRefreshReason?: RefreshReason) => TResult
-
-  runAndDestroy: (otelContext?: otel.Context, debugRefreshReason?: RefreshReason) => TResult
+  run: (args: { otelContext?: otel.Context; debugRefreshReason?: RefreshReason }) => TResult
 
-  destroy(): void
+  destroy: () => void
+  isDestroyed: boolean
 
-  subscribe(
-    onNewValue: (value: TResult) => void,
-    onUnsubsubscribe?: () => void,
-    options?: { label?: string; otelContext?: otel.Context },
-  ): () => void
+  // subscribe(
+  //   onNewValue: (value: TResult) => void,
+  //   onUnsubsubscribe?: () => void,
+  //   options?: { label?: string; otelContext?: otel.Context },
+  // ): () => void
 
   activeSubscriptions: Set<StackInfo>
 
@@ -75,11 +135,11 @@ export abstract class LiveStoreQueryBase<TResult, TQueryInfo extends QueryInfo>
   /** Human-readable label for the query for debugging */
   abstract label: string
 
-  abstract results$: Thunk<TResult, QueryContext, RefreshReason>
+  abstract results$: RG.Thunk<TResult, ReactivityGraphContext, RefreshReason>
 
   activeSubscriptions: Set<StackInfo> = new Set()
 
-  protected abstract reactivityGraph: ReactivityGraph
+  abstract readonly reactivityGraph: ReactivityGraph
 
   abstract queryInfo: TQueryInfo
 
@@ -89,33 +149,93 @@ export abstract class LiveStoreQueryBase<TResult, TQueryInfo extends QueryInfo>
 
   executionTimes: number[] = []
 
+  // TODO double check if this is needed
+  isDestroyed = false
   abstract destroy: () => void
 
-  run = (otelContext?: otel.Context, debugRefreshReason?: RefreshReason): TResult =>
-    this.results$.computeResult(otelContext, debugRefreshReason)
-
-  runAndDestroy = (otelContext?: otel.Context, debugRefreshReason?: RefreshReason): TResult => {
-    const result = this.run(otelContext, debugRefreshReason)
-    this.destroy()
-    return result
+  run = (args: { otelContext?: otel.Context; debugRefreshReason?: RefreshReason }): TResult => {
+    return this.results$.computeResult(args.otelContext, args.debugRefreshReason)
   }
 
-  subscribe = (
-    onNewValue: (value: TResult) => void,
-    onUnsubsubscribe?: () => void,
-    options?: { label?: string; otelContext?: otel.Context } | undefined,
-  ): (() => void) =>
-    this.reactivityGraph.context?.store.subscribe(this, onNewValue, onUnsubsubscribe, options) ??
-    throwContextNotSetError(this.reactivityGraph)
-}
+  protected dependencyQueriesRef: DependencyQueriesRef = new Set()
 
-export type GetAtomResult = <T>(atom: Atom<T, any, RefreshReason> | LiveQuery<T, any>) => T
+  // subscribe = (
+  //   onNewValue: (value: TResult) => void,
+  //   onUnsubsubscribe?: () => void,
+  //   options?: { label?: string; otelContext?: otel.Context } | undefined,
+  // ): (() => void) =>
+  //   this.reactivityGraph.context?.store.subscribe(this, onNewValue, onUnsubsubscribe, options) ??
+  //   RG.throwContextNotSetError(this.reactivityGraph)
+}
 
-export const makeGetAtomResult = (get: GetAtom, otelContext: otel.Context) => {
-  const getAtom: GetAtomResult = (atom) => {
-    if (atom._tag === 'thunk' || atom._tag === 'ref') return get(atom, otelContext)
-    return get(atom.results$, otelContext)
+export type GetAtomResult = <T>(
+  atom:
+    | RG.Atom<T, any, RefreshReason>
+    | LiveQueryDef<T, any>
+    | LiveQuery<T, any>
+    | ILiveQueryRef<T>
+    | ILiveQueryRefDef<T>,
+  otelContext?: otel.Context | undefined,
+  debugRefreshReason?: RefreshReason | undefined,
+) => T
+
+export type DependencyQueriesRef = Set<RcRef<LiveQueryAny | ILiveQueryRef<any>>>
+
+export const makeGetAtomResult = (
+  get: RG.GetAtom,
+  ctx: ReactivityGraphContext,
+  otelContext: otel.Context,
+  dependencyQueriesRef: DependencyQueriesRef,
+) => {
+  // NOTE we're using the `otelContext` from `makeGetAtomResult` here, not the `otelContext` from `getAtom`
+  const getAtom: GetAtomResult = (atom, _otelContext, debugRefreshReason) => {
+    // ReactivityGraph atoms case
+    if (atom._tag === 'thunk' || atom._tag === 'ref') return get(atom, otelContext, debugRefreshReason)
+
+    // LiveQueryDef case
+    if (atom._tag === 'def' || atom._tag === 'live-ref-def') {
+      const query = atom.make(ctx)
+      dependencyQueriesRef.add(query)
+      // TODO deref the query on destroy
+      return getAtom(query.value, _otelContext, debugRefreshReason)
+    }
+
+    // LiveQueryRef case
+    if (atom._tag === 'live-ref') return get(atom.ref, otelContext, debugRefreshReason)
+
+    // LiveQuery case
+    return get(atom.results$, otelContext, debugRefreshReason)
   }
 
   return getAtom
 }
+
+export const withRCMap = <T extends LiveQueryAny | ILiveQueryRef<any>>(
+  id: string,
+  make: (ctx: ReactivityGraphContext, otelContext?: otel.Context) => T,
+): ((ctx: ReactivityGraphContext, otelContext?: otel.Context) => RcRef<T>) => {
+  return (ctx, otelContext) => {
+    let item = ctx.liveQueryRCMap.get(id)
+    if (item) {
+      item.rc++
+      return item as RcRef<T>
+    }
+
+    const query$ = make(ctx, otelContext)
+
+    item = {
+      rc: 1,
+      value: query$,
+      deref: () => {
+        item!.rc--
+        if (item!.rc === 0) {
+          item!.value.destroy()
+        }
+        ctx.liveQueryRCMap.delete(id)
+      },
+    }
+    ctx.liveQueryRCMap.set(id, item)
+
+    return item as RcRef<T>
+  }
+}