@livestore/livestore 0.3.1-dev.0 → 0.3.2-dev.0

package/src/SqliteDbWrapper.test.ts

@@ -0,0 +1,38 @@
+import { Effect } from '@livestore/utils/effect'
+import { Vitest } from '@livestore/utils-dev/node-vitest'
+import { expect } from 'vitest'
+
+import { makeTodoMvc } from './utils/tests/fixture.js'
+
+Vitest.describe('SqliteDbWrapper', () => {
+  Vitest.describe('getTablesUsed', () => {
+    const getTablesUsed = (query: string) =>
+      Effect.gen(function* () {
+        const store = yield* makeTodoMvc({})
+        return store.sqliteDbWrapper.getTablesUsed(query)
+      })
+
+    Vitest.scopedLive('should return the correct tables used', (_test) =>
+      Effect.gen(function* () {
+        const tablesUsed = yield* getTablesUsed('select * from todos')
+        expect(tablesUsed).toEqual(new Set(['todos']))
+      }),
+    )
+
+    Vitest.scopedLive('should handle DELETE FROM statement without WHERE clause', (_test) =>
+      Effect.gen(function* () {
+        const tablesUsed = yield* getTablesUsed('DELETE FROM todos')
+        expect(tablesUsed).toEqual(new Set(['todos']))
+      }),
+    )
+
+    Vitest.scopedLive('should handle INSERT with ON CONFLICT clause', (_test) =>
+      Effect.gen(function* () {
+        const tablesUsed = yield* getTablesUsed(
+          'INSERT INTO todos (id, text, completed) VALUES (?, ?, ?) ON CONFLICT(id) DO UPDATE SET text = ?',
+        )
+        expect(tablesUsed).toEqual(new Set(['todos']))
+      }),
+    )
+  })
+})

package/src/SqliteDbWrapper.ts

@@ -1,21 +1,20 @@
 /* eslint-disable prefer-arrow/prefer-arrow-functions */
 
-import type {
-  DebugInfo,
-  MutableDebugInfo,
-  PreparedBindValues,
-  PreparedStatement,
-  SqliteDb,
-  SqliteDbChangeset,
-  SqliteDbSession,
-} from '@livestore/common'
 import {
   BoundArray,
   BoundMap,
+  type DebugInfo,
   getDurationMsFromSpan,
   getStartTimeHighResFromSpan,
-  sql,
+  type MutableDebugInfo,
+  type PreparedBindValues,
+  type PreparedStatement,
+  type SqliteDb,
+  type SqliteDbChangeset,
+  SqliteDbHelper,
+  type SqliteDbSession,
   SqliteError,
+  sql,
 } from '@livestore/common'
 import { isDevEnv, LS_DEV } from '@livestore/utils'
 import type * as otel from '@opentelemetry/api'
@@ -67,7 +66,12 @@ export class SqliteDbWrapper implements SqliteDb {
 
     configureSQLite(this)
   }
-  metadata: any
+  get debug() {
+    return this.db.debug
+  }
+  get metadata() {
+    return this.db.metadata
+  }
   prepare(queryStr: string): PreparedStatement {
     return this.db.prepare(queryStr)
   }
@@ -75,10 +79,10 @@ export class SqliteDbWrapper implements SqliteDb {
     return this.db.import(data)
   }
   close(): void {
-    return this.db.close()
+    this.db.close()
   }
   destroy(): void {
-    return this.db.destroy()
+    this.db.destroy()
   }
   session(): SqliteDbSession {
     return this.db.session()
@@ -157,7 +161,7 @@ export class SqliteDbWrapper implements SqliteDb {
     return tablesUsed
   }
 
-  execute(
+  cachedExecute(
     queryStr: string,
     bindValues?: PreparedBindValues | undefined,
     options?: {
@@ -213,6 +217,7 @@ export class SqliteDbWrapper implements SqliteDb {
           span.recordException(cause)
           span.end()
           if (LS_DEV) {
+            // biome-ignore lint/suspicious/noDebugger: debug
             debugger
           }
           throw new SqliteError({ cause, query: { bindValues: bindValues ?? {}, sql: queryStr } })
@@ -221,7 +226,11 @@ export class SqliteDbWrapper implements SqliteDb {
     )
   }
 
-  select<T = any>(
+  execute = SqliteDbHelper.makeExecute((queryStr, bindValues) => this.cachedExecute(queryStr, bindValues))
+
+  select = SqliteDbHelper.makeSelect((queryStr, bindValues) => this.cachedSelect(queryStr, bindValues))
+
+  cachedSelect<T = any>(
     queryStr: string,
     bindValues?: PreparedBindValues | undefined,
     options?: {

package/src/effect/LiveStore.ts

@@ -35,7 +35,7 @@ export const makeLiveStoreContext = <TSchema extends LiveStoreSchema, TContext =
 
       globalThis.__debugLiveStore ??= {}
       if (Object.keys(globalThis.__debugLiveStore).length === 0) {
-        globalThis.__debugLiveStore['_'] = store
+        globalThis.__debugLiveStore._ = store
       }
       globalThis.__debugLiveStore[storeId] = store
 

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/client-document-get-query.ts

@@ -34,7 +34,7 @@ export const makeExecBeforeFirstRun =
 
     const idVal = id === SessionIdSymbol ? store.sessionId : id!
     const rowExists =
-      store.sqliteDbWrapper.select(
+      store.sqliteDbWrapper.cachedSelect(
         `SELECT 1 FROM '${table.sqliteDef.name}' WHERE id = ?`,
         [idVal] as any as PreparedBindValues,
         { otelContext },

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

@@ -155,7 +155,9 @@ Vitest.describe('otel', () => {
       const defaultTodo = { id: '', text: '', completed: false }
 
       const filter = computed(() => ({ completed: false }))
-      const query$ = queryDb((get) => tables.todos.where(get(filter)).first({ fallback: () => defaultTodo }))
+      const query$ = queryDb((get) =>
+        tables.todos.where(get(filter)).first({ behaviour: 'fallback', fallback: () => defaultTodo }),
+      )
 
       expect(store.query(query$)).toMatchInlineSnapshot(`
       {
@@ -189,4 +191,145 @@ 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({ behaviour: 'fallback', 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({ behaviour: 'fallback', 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/live-queries/db-query.ts

@@ -372,7 +372,7 @@ export class LiveStoreDbQuery<TResultSchema, TResult = TResultSchema> extends Li
             span.setAttribute('sql.query', sqlString)
             span.updateName(`db:${sqlString.slice(0, 50)}`)
 
-            const rawDbResults = store.sqliteDbWrapper.select<any>(
+            const rawDbResults = store.sqliteDbWrapper.cachedSelect<any>(
               sqlString,
               bindValues ? prepareBindValues(bindValues, sqlString) : undefined,
               {