@livestore/livestore 0.0.0-snapshot-5e5bc344e2b3e234a08cf85e4dc890053d91b170 → 0.0.0-snapshot-3d6080d88e57e27247dc7f7d5252e86944494dfd

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

@@ -1,5 +1,394 @@
 // Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
 
+exports[`otel > QueryBuilder subscription - basic functionality 1`] = `
+{
+  "_name": "createStore",
+  "attributes": {
+    "debugInstanceId": "test",
+    "storeId": "default",
+  },
+  "children": [
+    {
+      "_name": "livestore.in-memory-db:execute",
+      "attributes": {
+        "sql.query": "
+      PRAGMA page_size=32768;
+      PRAGMA cache_size=10000;
+      PRAGMA synchronous='OFF';
+      PRAGMA temp_store='MEMORY';
+      PRAGMA foreign_keys='ON'; -- we want foreign key constraints to be enforced
+    ",
+      },
+    },
+    {
+      "_name": "@livestore/common:LeaderSyncProcessor:push",
+      "attributes": {
+        "batch": "undefined",
+        "batchSize": 1,
+      },
+    },
+    {
+      "_name": "client-session-sync-processor:pull",
+      "attributes": {
+        "code.stacktrace": "<STACKTRACE>",
+        "span.label": "⚠︎ Interrupted",
+        "status.interrupted": true,
+      },
+    },
+    {
+      "_name": "LiveStore:sync",
+    },
+    {
+      "_name": "LiveStore:commits",
+      "children": [
+        {
+          "_name": "LiveStore:commit",
+          "attributes": {
+            "livestore.eventTags": [
+              "livestore.RawSql",
+            ],
+            "livestore.eventsCount": 1,
+          },
+          "children": [
+            {
+              "_name": "livestore.in-memory-db:execute",
+              "attributes": {
+                "sql.query": "INSERT INTO todos (id, text, completed) VALUES ('t1', 'buy milk', 0)",
+              },
+            },
+          ],
+        },
+      ],
+    },
+    {
+      "_name": "LiveStore:queries",
+      "children": [
+        {
+          "_name": "LiveStore.subscribe",
+          "attributes": {
+            "queryLabel": "SELECT * FROM 'todos' WHERE completed = ? LIMIT ?",
+          },
+          "children": [
+            {
+              "_name": "db:SELECT * FROM 'todos' WHERE completed = ? LIMIT ?",
+              "attributes": {
+                "livestore.debugRefreshReason": "subscribe-initial-run:undefined",
+                "sql.query": "SELECT * FROM 'todos' WHERE completed = ? LIMIT ?",
+                "sql.rowsCount": 0,
+              },
+              "children": [
+                {
+                  "_name": "sql-in-memory-select",
+                  "attributes": {
+                    "sql.cached": false,
+                    "sql.query": "SELECT * FROM 'todos' WHERE completed = ? LIMIT ?",
+                    "sql.rowsCount": 0,
+                  },
+                },
+              ],
+            },
+            {
+              "_name": "db:SELECT * FROM 'todos' WHERE completed = ? LIMIT ?",
+              "attributes": {
+                "livestore.debugRefreshReason": "commit",
+                "sql.query": "SELECT * FROM 'todos' WHERE completed = ? LIMIT ?",
+                "sql.rowsCount": 1,
+              },
+              "children": [
+                {
+                  "_name": "sql-in-memory-select",
+                  "attributes": {
+                    "sql.cached": false,
+                    "sql.query": "SELECT * FROM 'todos' WHERE completed = ? LIMIT ?",
+                    "sql.rowsCount": 1,
+                  },
+                },
+              ],
+            },
+          ],
+        },
+      ],
+    },
+  ],
+}
+`;
+
+exports[`otel > QueryBuilder subscription - direct table subscription 1`] = `
+{
+  "_name": "createStore",
+  "attributes": {
+    "debugInstanceId": "test",
+    "storeId": "default",
+  },
+  "children": [
+    {
+      "_name": "livestore.in-memory-db:execute",
+      "attributes": {
+        "sql.query": "
+      PRAGMA page_size=32768;
+      PRAGMA cache_size=10000;
+      PRAGMA synchronous='OFF';
+      PRAGMA temp_store='MEMORY';
+      PRAGMA foreign_keys='ON'; -- we want foreign key constraints to be enforced
+    ",
+      },
+    },
+    {
+      "_name": "@livestore/common:LeaderSyncProcessor:push",
+      "attributes": {
+        "batch": "undefined",
+        "batchSize": 1,
+      },
+    },
+    {
+      "_name": "client-session-sync-processor:pull",
+      "attributes": {
+        "code.stacktrace": "<STACKTRACE>",
+        "span.label": "⚠︎ Interrupted",
+        "status.interrupted": true,
+      },
+    },
+    {
+      "_name": "LiveStore:sync",
+    },
+    {
+      "_name": "LiveStore:commits",
+      "children": [
+        {
+          "_name": "LiveStore:commit",
+          "attributes": {
+            "livestore.eventTags": [
+              "livestore.RawSql",
+            ],
+            "livestore.eventsCount": 1,
+          },
+          "children": [
+            {
+              "_name": "livestore.in-memory-db:execute",
+              "attributes": {
+                "sql.query": "INSERT INTO todos (id, text, completed) VALUES ('t5', 'clean house', 1)",
+              },
+            },
+          ],
+        },
+      ],
+    },
+    {
+      "_name": "LiveStore:queries",
+      "children": [
+        {
+          "_name": "LiveStore.subscribe",
+          "attributes": {
+            "queryLabel": "SELECT * FROM 'todos'",
+          },
+          "children": [
+            {
+              "_name": "db:SELECT * FROM 'todos'",
+              "attributes": {
+                "livestore.debugRefreshReason": "subscribe-initial-run:undefined",
+                "sql.query": "SELECT * FROM 'todos'",
+                "sql.rowsCount": 0,
+              },
+              "children": [
+                {
+                  "_name": "sql-in-memory-select",
+                  "attributes": {
+                    "sql.cached": false,
+                    "sql.query": "SELECT * FROM 'todos'",
+                    "sql.rowsCount": 0,
+                  },
+                },
+              ],
+            },
+            {
+              "_name": "db:SELECT * FROM 'todos'",
+              "attributes": {
+                "livestore.debugRefreshReason": "commit",
+                "sql.query": "SELECT * FROM 'todos'",
+                "sql.rowsCount": 1,
+              },
+              "children": [
+                {
+                  "_name": "sql-in-memory-select",
+                  "attributes": {
+                    "sql.cached": false,
+                    "sql.query": "SELECT * FROM 'todos'",
+                    "sql.rowsCount": 1,
+                  },
+                },
+              ],
+            },
+          ],
+        },
+      ],
+    },
+  ],
+}
+`;
+
+exports[`otel > QueryBuilder subscription - unsubscribe functionality 1`] = `
+{
+  "_name": "createStore",
+  "attributes": {
+    "debugInstanceId": "test",
+    "storeId": "default",
+  },
+  "children": [
+    {
+      "_name": "livestore.in-memory-db:execute",
+      "attributes": {
+        "sql.query": "
+      PRAGMA page_size=32768;
+      PRAGMA cache_size=10000;
+      PRAGMA synchronous='OFF';
+      PRAGMA temp_store='MEMORY';
+      PRAGMA foreign_keys='ON'; -- we want foreign key constraints to be enforced
+    ",
+      },
+    },
+    {
+      "_name": "@livestore/common:LeaderSyncProcessor:push",
+      "attributes": {
+        "batch": "undefined",
+        "batchSize": 1,
+      },
+    },
+    {
+      "_name": "@livestore/common:LeaderSyncProcessor:push",
+      "attributes": {
+        "batch": "undefined",
+        "batchSize": 1,
+      },
+    },
+    {
+      "_name": "client-session-sync-processor:pull",
+      "attributes": {
+        "code.stacktrace": "<STACKTRACE>",
+        "span.label": "⚠︎ Interrupted",
+        "status.interrupted": true,
+      },
+    },
+    {
+      "_name": "LiveStore:sync",
+    },
+    {
+      "_name": "LiveStore:commits",
+      "children": [
+        {
+          "_name": "LiveStore:commit",
+          "attributes": {
+            "livestore.eventTags": [
+              "livestore.RawSql",
+            ],
+            "livestore.eventsCount": 1,
+          },
+          "children": [
+            {
+              "_name": "livestore.in-memory-db:execute",
+              "attributes": {
+                "sql.query": "INSERT INTO todos (id, text, completed) VALUES ('t3', 'read book', 0)",
+              },
+            },
+          ],
+        },
+        {
+          "_name": "LiveStore:commit",
+          "attributes": {
+            "livestore.eventTags": [
+              "livestore.RawSql",
+            ],
+            "livestore.eventsCount": 1,
+          },
+          "children": [
+            {
+              "_name": "livestore.in-memory-db:execute",
+              "attributes": {
+                "sql.query": "INSERT INTO todos (id, text, completed) VALUES ('t4', 'cook dinner', 0)",
+              },
+            },
+          ],
+        },
+      ],
+    },
+    {
+      "_name": "LiveStore:queries",
+      "children": [
+        {
+          "_name": "LiveStore.subscribe",
+          "attributes": {
+            "queryLabel": "SELECT * FROM 'todos' WHERE completed = ? LIMIT ?",
+          },
+          "children": [
+            {
+              "_name": "db:SELECT * FROM 'todos' WHERE completed = ? LIMIT ?",
+              "attributes": {
+                "livestore.debugRefreshReason": "subscribe-initial-run:undefined",
+                "sql.query": "SELECT * FROM 'todos' WHERE completed = ? LIMIT ?",
+                "sql.rowsCount": 0,
+              },
+              "children": [
+                {
+                  "_name": "sql-in-memory-select",
+                  "attributes": {
+                    "sql.cached": false,
+                    "sql.query": "SELECT * FROM 'todos' WHERE completed = ? LIMIT ?",
+                    "sql.rowsCount": 0,
+                  },
+                },
+              ],
+            },
+            {
+              "_name": "db:SELECT * FROM 'todos' WHERE completed = ? LIMIT ?",
+              "attributes": {
+                "livestore.debugRefreshReason": "commit",
+                "sql.query": "SELECT * FROM 'todos' WHERE completed = ? LIMIT ?",
+                "sql.rowsCount": 1,
+              },
+              "children": [
+                {
+                  "_name": "sql-in-memory-select",
+                  "attributes": {
+                    "sql.cached": false,
+                    "sql.query": "SELECT * FROM 'todos' WHERE completed = ? LIMIT ?",
+                    "sql.rowsCount": 1,
+                  },
+                },
+              ],
+            },
+          ],
+        },
+        {
+          "_name": "LiveStore.subscribe",
+          "attributes": {
+            "queryLabel": "SELECT * FROM 'todos' WHERE completed = ? LIMIT ?",
+          },
+          "children": [
+            {
+              "_name": "db:SELECT * FROM 'todos' WHERE completed = ? LIMIT ?",
+              "attributes": {
+                "livestore.debugRefreshReason": "commit",
+                "sql.query": "SELECT * FROM 'todos' WHERE completed = ? LIMIT ?",
+                "sql.rowsCount": 1,
+              },
+              "children": [
+                {
+                  "_name": "sql-in-memory-select",
+                  "attributes": {
+                    "sql.cached": false,
+                    "sql.query": "SELECT * FROM 'todos' WHERE completed = ? LIMIT ?",
+                    "sql.rowsCount": 1,
+                  },
+                },
+              ],
+            },
+          ],
+        },
+      ],
+    },
+  ],
+}
+`;
+
 exports[`otel > otel 3`] = `
 {
   "_name": "createStore",

package/src/live-queries/db-query.test.ts

@@ -189,4 +189,141 @@ Vitest.describe('otel', () => {
       ),
     ),
   )
+
+  Vitest.scopedLive('QueryBuilder subscription - basic functionality', () =>
+    Effect.gen(function* () {
+      const { store, exporter, span, provider } = yield* makeQuery
+
+      const callbackResults: any[] = []
+      const defaultTodo = { id: '', text: '', completed: false }
+
+      const queryBuilder = tables.todos.where({ completed: false }).first({ fallback: () => defaultTodo })
+
+      const unsubscribe = store.subscribe(queryBuilder, {
+        onUpdate: (result) => {
+          callbackResults.push(result)
+        },
+      })
+
+      expect(callbackResults).toHaveLength(1)
+      expect(callbackResults[0]).toMatchObject(defaultTodo)
+
+      store.commit(rawSqlEvent({ sql: sql`INSERT INTO todos (id, text, completed) VALUES ('t1', 'buy milk', 0)` }))
+
+      expect(callbackResults).toHaveLength(2)
+      expect(callbackResults[1]).toMatchObject({
+        id: 't1',
+        text: 'buy milk',
+        completed: false,
+      })
+
+      unsubscribe()
+      span.end()
+
+      return { exporter, provider }
+    }).pipe(
+      Effect.scoped,
+      Effect.tap(({ exporter, provider }) =>
+        Effect.promise(async () => {
+          await provider.forceFlush()
+          expect(getSimplifiedRootSpan(exporter, mapAttributes)).toMatchSnapshot()
+          await provider.shutdown()
+        }),
+      ),
+    ),
+  )
+
+  Vitest.scopedLive('QueryBuilder subscription - unsubscribe functionality', () =>
+    Effect.gen(function* () {
+      const { store, exporter, span, provider } = yield* makeQuery
+
+      const callbackResults1: any[] = []
+      const callbackResults2: any[] = []
+      const defaultTodo = { id: '', text: '', completed: false }
+
+      const queryBuilder = tables.todos.where({ completed: false }).first({ fallback: () => defaultTodo })
+
+      const unsubscribe1 = store.subscribe(queryBuilder, {
+        onUpdate: (result) => {
+          callbackResults1.push(result)
+        },
+      })
+
+      const unsubscribe2 = store.subscribe(queryBuilder, {
+        onUpdate: (result) => {
+          callbackResults2.push(result)
+        },
+      })
+
+      expect(callbackResults1).toHaveLength(1)
+      expect(callbackResults2).toHaveLength(1)
+
+      store.commit(rawSqlEvent({ sql: sql`INSERT INTO todos (id, text, completed) VALUES ('t3', 'read book', 0)` }))
+
+      expect(callbackResults1).toHaveLength(2)
+      expect(callbackResults2).toHaveLength(2)
+
+      unsubscribe1()
+
+      store.commit(rawSqlEvent({ sql: sql`INSERT INTO todos (id, text, completed) VALUES ('t4', 'cook dinner', 0)` }))
+
+      expect(callbackResults1).toHaveLength(2)
+      expect(callbackResults2).toHaveLength(3)
+
+      unsubscribe2()
+      span.end()
+
+      return { exporter, provider }
+    }).pipe(
+      Effect.scoped,
+      Effect.tap(({ exporter, provider }) =>
+        Effect.promise(async () => {
+          await provider.forceFlush()
+          expect(getSimplifiedRootSpan(exporter, mapAttributes)).toMatchSnapshot()
+          await provider.shutdown()
+        }),
+      ),
+    ),
+  )
+
+  Vitest.scopedLive('QueryBuilder subscription - direct table subscription', () =>
+    Effect.gen(function* () {
+      const { store, exporter, span, provider } = yield* makeQuery
+
+      const callbackResults: any[] = []
+
+      const unsubscribe = store.subscribe(tables.todos, {
+        onUpdate: (result) => {
+          callbackResults.push(result)
+        },
+      })
+
+      expect(callbackResults).toHaveLength(1)
+      expect(callbackResults[0]).toEqual([])
+
+      store.commit(rawSqlEvent({ sql: sql`INSERT INTO todos (id, text, completed) VALUES ('t5', 'clean house', 1)` }))
+
+      expect(callbackResults).toHaveLength(2)
+      expect(callbackResults[1]).toHaveLength(1)
+      expect(callbackResults[1][0]).toMatchObject({
+        id: 't5',
+        text: 'clean house',
+        completed: true,
+      })
+
+      unsubscribe()
+      span.end()
+
+      return { exporter, provider }
+    }).pipe(
+      Effect.scoped,
+      Effect.tap(({ exporter, provider }) =>
+        Effect.promise(async () => {
+          await provider.forceFlush()
+          expect(getSimplifiedRootSpan(exporter, mapAttributes)).toMatchSnapshot()
+          await provider.shutdown()
+        }),
+      ),
+    ),
+  )
 })

package/src/store/store.ts

@@ -37,6 +37,7 @@ import type {
 } from '../live-queries/base-class.js'
 import { makeReactivityGraph } from '../live-queries/base-class.js'
 import { makeExecBeforeFirstRun } from '../live-queries/client-document-get-query.js'
+import { queryDb } from '../live-queries/db-query.js'
 import type { Ref } from '../reactive.js'
 import { SqliteDbWrapper } from '../SqliteDbWrapper.js'
 import { ReferenceCountedSet } from '../utils/data-structures.js'
@@ -290,7 +291,7 @@ export class Store<TSchema extends LiveStoreSchema = LiveStoreSchema, TContext =
    * ```
    */
   subscribe = <TResult>(
-    query: LiveQueryDef<TResult, 'def' | 'signal-def'> | LiveQuery<TResult>,
+    query: LiveQueryDef<TResult, 'def' | 'signal-def'> | LiveQuery<TResult> | QueryBuilder<TResult, any, any>,
     options: {
       /** Called when the query result has changed */
       onUpdate: (value: TResult) => void
@@ -310,14 +311,15 @@ export class Store<TSchema extends LiveStoreSchema = LiveStoreSchema, TContext =
   ): Unsubscribe =>
     this.otel.tracer.startActiveSpan(
       `LiveStore.subscribe`,
-      { attributes: { label: options?.label, queryLabel: query.label } },
+      { attributes: { label: options?.label, queryLabel: isQueryBuilder(query) ? query.toString() : query.label } },
       options?.otelContext ?? this.otel.queriesSpanContext,
       (span) => {
         // console.debug('store sub', query$.id, query$.label)
         const otelContext = otel.trace.setSpan(otel.context.active(), span)
 
-        const queryRcRef =
-          query._tag === 'def' || query._tag === 'signal-def'
+        const queryRcRef = isQueryBuilder(query)
+          ? queryDb(query).make(this.reactivityGraph.context!)
+          : query._tag === 'def' || query._tag === 'signal-def'
             ? query.make(this.reactivityGraph.context!)
             : {
                 value: query as LiveQuery<TResult>,