@livestore/livestore 0.3.1 → 0.3.2-dev.1

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/base-class.ts

@@ -2,10 +2,10 @@ import { isNotNil } from '@livestore/utils'
 import { Predicate } from '@livestore/utils/effect'
 import type * as otel from '@opentelemetry/api'
 
-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'
+import * as RG from '../reactive.ts'
+import type { Store } from '../store/store.ts'
+import type { QueryDebugInfo, RefreshReason } from '../store/store-types.ts'
+import type { StackInfo } from '../utils/stack-info.ts'
 
 export type ReactivityGraph = RG.ReactiveGraph<RefreshReason, QueryDebugInfo, ReactivityGraphContext>
 
@@ -23,14 +23,15 @@ export type ReactivityGraphContext = {
   effectsWrapper: (run: () => void) => void
 }
 
-export type GetResult<TQuery extends LiveQueryDef.Any | LiveQuery.Any | SignalDef<any>> =
-  TQuery extends LiveQuery<infer TResult>
+export type GetResult<TQuery extends LiveQueryDef.Any | LiveQuery.Any | SignalDef<any>> = TQuery extends LiveQuery<
+  infer TResult
+>
+  ? TResult
+  : TQuery extends LiveQueryDef<infer TResult>
     ? TResult
-    : TQuery extends LiveQueryDef<infer TResult>
+    : TQuery extends SignalDef<infer TResult>
       ? TResult
-      : TQuery extends SignalDef<infer TResult>
-        ? TResult
-        : unknown
+      : unknown
 
 let queryIdCounter = 0
 

package/src/live-queries/client-document-get-query.ts

@@ -4,7 +4,7 @@ import { State } from '@livestore/common/schema'
 import { shouldNeverHappen } from '@livestore/utils'
 import type * as otel from '@opentelemetry/api'
 
-import type { ReactivityGraphContext } from './base-class.js'
+import type { ReactivityGraphContext } from './base-class.ts'
 
 export const rowQueryLabel = (
   table: State.SQLite.ClientDocumentTableDef.Any,

package/src/live-queries/computed.ts

@@ -1,11 +1,11 @@
 import { getDurationMsFromSpan } from '@livestore/common'
 import * as otel from '@opentelemetry/api'
 
-import type { Thunk } from '../reactive.js'
-import type { RefreshReason } from '../store/store-types.js'
-import { isValidFunctionString } from '../utils/function-string.js'
-import type { DepKey, GetAtomResult, LiveQueryDef, ReactivityGraph, ReactivityGraphContext } from './base-class.js'
-import { depsToString, LiveStoreQueryBase, makeGetAtomResult, withRCMap } from './base-class.js'
+import type { Thunk } from '../reactive.ts'
+import type { RefreshReason } from '../store/store-types.ts'
+import { isValidFunctionString } from '../utils/function-string.ts'
+import type { DepKey, GetAtomResult, LiveQueryDef, ReactivityGraph, ReactivityGraphContext } from './base-class.ts'
+import { depsToString, LiveStoreQueryBase, makeGetAtomResult, withRCMap } from './base-class.ts'
 
 export const computed = <TResult>(
   fn: (get: GetAtomResult) => TResult,

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

@@ -6,11 +6,11 @@ import * as otel from '@opentelemetry/api'
 import { BasicTracerProvider, InMemorySpanExporter, SimpleSpanProcessor } from '@opentelemetry/sdk-trace-base'
 import { expect } from 'vitest'
 
-import * as RG from '../reactive.js'
-import { makeTodoMvc, tables } from '../utils/tests/fixture.js'
-import { getSimplifiedRootSpan } from '../utils/tests/otel.js'
-import { computed } from './computed.js'
-import { queryDb } from './db-query.js'
+import * as RG from '../reactive.ts'
+import { makeTodoMvc, tables } from '../utils/tests/fixture.ts'
+import { getSimplifiedRootSpan } from '../utils/tests/otel.ts'
+import { computed } from './computed.ts'
+import { queryDb } from './db-query.ts'
 
 /*
 TODO write tests for:
@@ -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

@@ -13,13 +13,13 @@ import { deepEqual, shouldNeverHappen } from '@livestore/utils'
 import { Predicate, Schema, TreeFormatter } from '@livestore/utils/effect'
 import * as otel from '@opentelemetry/api'
 
-import type { Thunk } from '../reactive.js'
-import { isThunk, NOT_REFRESHED_YET } from '../reactive.js'
-import type { RefreshReason } from '../store/store-types.js'
-import { isValidFunctionString } from '../utils/function-string.js'
-import type { DepKey, GetAtomResult, LiveQueryDef, ReactivityGraph, ReactivityGraphContext } from './base-class.js'
-import { depsToString, LiveStoreQueryBase, makeGetAtomResult, withRCMap } from './base-class.js'
-import { makeExecBeforeFirstRun, rowQueryLabel } from './client-document-get-query.js'
+import type { Thunk } from '../reactive.ts'
+import { isThunk, NOT_REFRESHED_YET } from '../reactive.ts'
+import type { RefreshReason } from '../store/store-types.ts'
+import { isValidFunctionString } from '../utils/function-string.ts'
+import type { DepKey, GetAtomResult, LiveQueryDef, ReactivityGraph, ReactivityGraphContext } from './base-class.ts'
+import { depsToString, LiveStoreQueryBase, makeGetAtomResult, withRCMap } from './base-class.ts'
+import { makeExecBeforeFirstRun, rowQueryLabel } from './client-document-get-query.ts'
 
 export type QueryInputRaw<TDecoded, TEncoded> = {
   query: string

package/src/live-queries/mod.ts

@@ -1,4 +1,4 @@
-export * from './base-class.js'
-export * from './computed.js'
-export * from './db-query.js'
-export * from './signal.js'
+export * from './base-class.ts'
+export * from './computed.ts'
+export * from './db-query.ts'
+export * from './signal.ts'

package/src/live-queries/signal.test.ts

@@ -2,9 +2,9 @@ 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'
-import { computed } from './computed.js'
-import { signal } from './signal.js'
+import { makeTodoMvc } from '../utils/tests/fixture.ts'
+import { computed } from './computed.ts'
+import { signal } from './signal.ts'
 
 Vitest.describe('signal', () => {
   Vitest.scopedLive('should be able to create a signal', () =>