@livestore/react 0.3.0-dev.9 → 0.3.0

package/src/__tests__/fixture.tsx

@@ -1,9 +1,9 @@
+import { makeInMemoryAdapter } from '@livestore/adapter-web'
 import { provideOtel } from '@livestore/common'
-import { DbSchema, makeSchema } from '@livestore/common/schema'
-import type { LiveStoreContextRunning } from '@livestore/livestore'
-import { createStore, globalReactivityGraph, makeReactivityGraph } from '@livestore/livestore'
-import { Effect } from '@livestore/utils/effect'
-import { makeInMemoryAdapter } from '@livestore/web'
+import { Events, makeSchema, State } from '@livestore/common/schema'
+import type { Store } from '@livestore/livestore'
+import { createStore } from '@livestore/livestore'
+import { Effect, Schema } from '@livestore/utils/effect'
 import type * as otel from '@opentelemetry/api'
 import React from 'react'
 
@@ -22,55 +22,78 @@ export type AppState = {
   filter: Filter
 }
 
-export const todos = DbSchema.table(
-  'todos',
-  {
-    id: DbSchema.text({ primaryKey: true }),
-    text: DbSchema.text({ default: '', nullable: false }),
-    completed: DbSchema.boolean({ default: false, nullable: false }),
+const todos = State.SQLite.table({
+  name: 'todos',
+  columns: {
+    id: State.SQLite.text({ primaryKey: true }),
+    text: State.SQLite.text({ default: '', nullable: false }),
+    completed: State.SQLite.boolean({ default: false, nullable: false }),
   },
-  { deriveMutations: true, isSingleton: false },
-)
-
-export const app = DbSchema.table(
-  'app',
-  {
-    id: DbSchema.text({ primaryKey: true, default: 'static' }),
-    newTodoText: DbSchema.text({ default: '', nullable: true }),
-    filter: DbSchema.text({ default: 'all', nullable: false }),
+})
+
+const app = State.SQLite.table({
+  name: 'app',
+  columns: {
+    id: State.SQLite.text({ primaryKey: true, default: 'static' }),
+    newTodoText: State.SQLite.text({ default: '', nullable: true }),
+    filter: State.SQLite.text({ default: 'all', nullable: false }),
   },
-  { isSingleton: true },
-)
-
-export const AppComponentSchema = DbSchema.table(
-  'UserInfo',
-  {
-    username: DbSchema.text({ default: '' }),
-    text: DbSchema.text({ default: '' }),
+})
+
+const userInfo = State.SQLite.clientDocument({
+  name: 'UserInfo',
+  schema: Schema.Struct({
+    username: Schema.String,
+    text: Schema.String,
+  }),
+  default: { value: { username: '', text: '' } },
+})
+
+const AppRouterSchema = State.SQLite.clientDocument({
+  name: 'AppRouter',
+  schema: Schema.Struct({
+    currentTaskId: Schema.String.pipe(Schema.NullOr),
+  }),
+  default: {
+    value: { currentTaskId: null },
+    id: 'singleton',
   },
-  { deriveMutations: true },
-)
+})
+
+export const events = {
+  todoCreated: Events.synced({
+    name: 'todoCreated',
+    schema: Schema.Struct({ id: Schema.String, text: Schema.String, completed: Schema.Boolean }),
+  }),
+  todoUpdated: Events.synced({
+    name: 'todoUpdated',
+    schema: Schema.Struct({
+      id: Schema.String,
+      text: Schema.String.pipe(Schema.optional),
+      completed: Schema.Boolean.pipe(Schema.optional),
+    }),
+  }),
+  AppRouterSet: AppRouterSchema.set,
+  UserInfoSet: userInfo.set,
+}
 
-export const AppRouterSchema = DbSchema.table(
-  'AppRouter',
-  {
-    currentTaskId: DbSchema.text({ default: null, nullable: true }),
-  },
-  { isSingleton: true, deriveMutations: true },
-)
+const materializers = State.SQLite.materializers(events, {
+  todoCreated: ({ id, text, completed }) => todos.insert({ id, text, completed }),
+  todoUpdated: ({ id, text, completed }) => todos.update({ completed, text }).where({ id }),
+})
 
-export const tables = { todos, app, AppComponentSchema, AppRouterSchema }
-export const schema = makeSchema({ tables })
+export const tables = { todos, app, userInfo, AppRouterSchema }
+
+const state = State.SQLite.makeState({ tables, materializers })
+export const schema = makeSchema({ state, events })
 
 export const makeTodoMvcReact = ({
   otelTracer,
   otelContext,
-  useGlobalReactivityGraph = true,
   strictMode,
 }: {
   otelTracer?: otel.Tracer
   otelContext?: otel.Context
-  useGlobalReactivityGraph?: boolean
   strictMode?: boolean
 } = {}) =>
   Effect.gen(function* () {
@@ -89,18 +112,20 @@ export const makeTodoMvcReact = ({
       }
     }
 
-    const reactivityGraph = useGlobalReactivityGraph ? globalReactivityGraph : makeReactivityGraph()
-
-    const store = yield* createStore({
+    const store: Store<any> = yield* createStore({
       schema,
       storeId: 'default',
       adapter: makeInMemoryAdapter(),
-      reactivityGraph,
       debug: { instanceId: 'test' },
     })
 
+    const storeWithReactApi = LiveStoreReact.withReactApi(store)
+
     // TODO improve typing of `LiveStoreContext`
-    const storeContext = { stage: 'running', store } as any as LiveStoreContextRunning
+    const storeContext = {
+      stage: 'running' as const,
+      store: storeWithReactApi,
+    }
 
     const MaybeStrictMode = strictMode ? React.StrictMode : React.Fragment
 
@@ -112,5 +137,7 @@ export const makeTodoMvcReact = ({
       </MaybeStrictMode>
     )
 
-    return { wrapper, store, reactivityGraph, makeRenderCount }
+    const renderCount = makeRenderCount()
+
+    return { wrapper, store: storeWithReactApi, renderCount }
   }).pipe(provideOtel({ parentSpanContext: otelContext, otelTracer }))

package/src/experimental/components/LiveList.tsx

@@ -1,9 +1,8 @@
-import type { LiveQuery } from '@livestore/livestore'
+import type { LiveQueryDef } from '@livestore/livestore'
 import { computed } from '@livestore/livestore'
 import React from 'react'
 
 import { useQuery } from '../../useQuery.js'
-import { useScopedQuery } from '../../useScopedQuery.js'
 
 /*
 TODO:
@@ -12,7 +11,7 @@ TODO:
 */
 
 export type LiveListProps<TItem> = {
-  items$: LiveQuery<ReadonlyArray<TItem>>
+  items$: LiveQueryDef<ReadonlyArray<TItem>>
   // TODO refactor render-flag to allow for transition animations on add/remove
   renderItem: (item: TItem, opts: { index: number; isInitialListRender: boolean }) => React.ReactNode
   /** Needs to be unique across all list items */
@@ -32,14 +31,18 @@ export const LiveList = <TItem,>({ items$, renderItem, getKey }: LiveListProps<T
 
   React.useEffect(() => setHasMounted(true), [])
 
-  const keysCb = React.useCallback(() => computed((get) => get(items$).map(getKey)), [getKey, items$])
-  const keys = useScopedQuery(keysCb, 'fixed')
+  const keys = useQuery(computed((get) => get(items$).map(getKey)))
   const arr = React.useMemo(
     () =>
       keys.map(
         (key) =>
           // TODO figure out a way so that `item$` returns an ordered lookup map to more efficiently find the item by key
-          [key, computed((get) => get(items$).find((item) => getKey(item, 0) === key)!) as LiveQuery<TItem>] as const,
+          [
+            key,
+            computed((get) => get(items$).find((item) => getKey(item, 0) === key)!, {
+              deps: [key],
+            }) as LiveQueryDef<TItem>,
+          ] as const,
       ),
     [getKey, items$, keys],
   )
@@ -65,7 +68,7 @@ const ItemWrapper = <TItem,>({
   renderItem,
 }: {
   itemKey: string | number
-  item$: LiveQuery<TItem>
+  item$: LiveQueryDef<TItem>
   opts: { index: number; isInitialListRender: boolean }
   renderItem: (item: TItem, opts: { index: number; isInitialListRender: boolean }) => React.ReactNode
 }) => {

package/src/mod.ts

@@ -1,13 +1,12 @@
-export { LiveStoreContext, useStore } from './LiveStoreContext.js'
+export { LiveStoreContext, type ReactApi } from './LiveStoreContext.js'
+export { useStore, withReactApi } from './useStore.js'
 export { LiveStoreProvider } from './LiveStoreProvider.js'
-export { useQuery } from './useQuery.js'
-export { useScopedQuery } from './useScopedQuery.js'
 export { useStackInfo } from './utils/stack-info.js'
+export { useQuery, useQueryRef } from './useQuery.js'
 export {
-  useRow,
+  useClientDocument,
   type StateSetters,
   type SetStateAction,
   type Dispatch,
   type UseRowResult as UseStateResult,
-} from './useRow.js'
-export { useAtom } from './useAtom.js'
+} from './useClientDocument.js'

package/src/useClientDocument.test.tsx

@@ -0,0 +1,306 @@
+import * as LiveStore from '@livestore/livestore'
+import { getSimplifiedRootSpan } from '@livestore/livestore/internal/testing-utils'
+import { Effect, ReadonlyRecord, Schema } from '@livestore/utils/effect'
+import { Vitest } from '@livestore/utils-dev/node-vitest'
+import * as otel from '@opentelemetry/api'
+import { BasicTracerProvider, InMemorySpanExporter, SimpleSpanProcessor } from '@opentelemetry/sdk-trace-base'
+import * as ReactTesting from '@testing-library/react'
+import React from 'react'
+import { beforeEach, expect, it } from 'vitest'
+
+import { events, makeTodoMvcReact, tables } from './__tests__/fixture.js'
+import type * as LiveStoreReact from './mod.js'
+import { __resetUseRcResourceCache } from './useRcResource.js'
+
+// const strictMode = process.env.REACT_STRICT_MODE !== undefined
+
+// NOTE running tests concurrently doesn't work with the default global db graph
+Vitest.describe('useClientDocument', () => {
+  beforeEach(() => {
+    __resetUseRcResourceCache()
+  })
+
+  Vitest.scopedLive('should update the data based on component key', () =>
+    Effect.gen(function* () {
+      const { wrapper, store, renderCount } = yield* makeTodoMvcReact({})
+
+      const { result, rerender } = ReactTesting.renderHook(
+        (userId: string) => {
+          renderCount.inc()
+
+          const [state, setState, id] = store.useClientDocument(tables.userInfo, userId)
+          return { state, setState, id }
+        },
+        { wrapper, initialProps: 'u1' },
+      )
+
+      expect(result.current.id).toBe('u1')
+      expect(result.current.state.username).toBe('')
+      expect(renderCount.val).toBe(1)
+      expect(store.reactivityGraph.getSnapshot({ includeResults: true })).toMatchSnapshot()
+      store.commit(tables.userInfo.set({ username: 'username_u2' }, 'u2'))
+
+      rerender('u2')
+
+      expect(store.reactivityGraph.getSnapshot({ includeResults: true })).toMatchSnapshot()
+      expect(result.current.id).toBe('u2')
+      expect(result.current.state.username).toBe('username_u2')
+      expect(renderCount.val).toBe(2)
+    }),
+  )
+
+  // TODO add a test that makes sure React doesn't re-render when a setter is used to set the same value
+
+  Vitest.scopedLive('should update the data reactively - via setState', () =>
+    Effect.gen(function* () {
+      const { wrapper, store, renderCount } = yield* makeTodoMvcReact({})
+
+      const { result } = ReactTesting.renderHook(
+        (userId: string) => {
+          renderCount.inc()
+
+          const [state, setState, id] = store.useClientDocument(tables.userInfo, userId)
+          return { state, setState, id }
+        },
+        { wrapper, initialProps: 'u1' },
+      )
+
+      expect(result.current.id).toBe('u1')
+      expect(result.current.state.username).toBe('')
+      expect(renderCount.val).toBe(1)
+
+      ReactTesting.act(() => result.current.setState({ username: 'username_u1_hello' }))
+
+      expect(result.current.id).toBe('u1')
+      expect(result.current.state.username).toBe('username_u1_hello')
+      expect(renderCount.val).toBe(2)
+    }),
+  )
+
+  Vitest.scopedLive('should update the data reactively - via raw store commit', () =>
+    Effect.gen(function* () {
+      const { wrapper, store, renderCount } = yield* makeTodoMvcReact({})
+
+      const { result } = ReactTesting.renderHook(
+        (userId: string) => {
+          renderCount.inc()
+
+          const [state, setState, id] = store.useClientDocument(tables.userInfo, userId)
+          return { state, setState, id }
+        },
+        { wrapper, initialProps: 'u1' },
+      )
+
+      expect(result.current.id).toBe('u1')
+      expect(result.current.state.username).toBe('')
+      expect(renderCount.val).toBe(1)
+
+      ReactTesting.act(() => store.commit(events.UserInfoSet({ username: 'username_u1_hello' }, 'u1')))
+
+      expect(result.current.id).toBe('u1')
+      expect(result.current.state.username).toBe('username_u1_hello')
+      expect(renderCount.val).toBe(2)
+    }),
+  )
+
+  Vitest.scopedLive('should work for a larger app', () =>
+    Effect.gen(function* () {
+      const { wrapper, store, renderCount } = yield* makeTodoMvcReact({})
+
+      const allTodos$ = LiveStore.queryDb(
+        { query: `select * from todos`, schema: Schema.Array(tables.todos.rowSchema) },
+        { label: 'allTodos' },
+      )
+
+      let globalSetState: LiveStoreReact.StateSetters<typeof tables.AppRouterSchema> | undefined
+      const AppRouter: React.FC = () => {
+        renderCount.inc()
+
+        const [state, setState] = store.useClientDocument(tables.AppRouterSchema, 'singleton')
+
+        globalSetState = setState
+
+        return (
+          <div>
+            <TasksList setTaskId={(taskId) => setState({ currentTaskId: taskId })} />
+            <div role="current-id">Current Task Id: {state.currentTaskId ?? '-'}</div>
+            {state.currentTaskId ? <TaskDetails id={state.currentTaskId} /> : <div>Click on a task to see details</div>}
+          </div>
+        )
+      }
+
+      const TasksList: React.FC<{ setTaskId: (_: string) => void }> = ({ setTaskId }) => {
+        const allTodos = store.useQuery(allTodos$)
+
+        return (
+          <div>
+            {allTodos.map((_) => (
+              <div key={_.id} onClick={() => setTaskId(_.id)}>
+                {_.id}
+              </div>
+            ))}
+          </div>
+        )
+      }
+
+      const TaskDetails: React.FC<{ id: string }> = ({ id }) => {
+        const todo = store.useQuery(LiveStore.queryDb(tables.todos.where({ id }).first(), { deps: id }))
+        return <div role="content">{JSON.stringify(todo)}</div>
+      }
+
+      const renderResult = ReactTesting.render(<AppRouter />, { wrapper })
+
+      expect(renderCount.val).toBe(1)
+
+      ReactTesting.act(() =>
+        store.commit(
+          LiveStore.rawSqlEvent({
+            sql: LiveStore.sql`INSERT INTO todos (id, text, completed) VALUES ('t1', 'buy milk', 0)`,
+          }),
+        ),
+      )
+
+      expect(renderCount.val).toBe(1)
+      expect(renderResult.getByRole('current-id').innerHTML).toMatchInlineSnapshot('"Current Task Id: -"')
+
+      ReactTesting.act(() => globalSetState!({ currentTaskId: 't1' }))
+
+      expect(renderCount.val).toBe(2)
+      expect(renderResult.getByRole('content').innerHTML).toMatchInlineSnapshot(
+        `"{"id":"t1","text":"buy milk","completed":false}"`,
+      )
+
+      expect(renderResult.getByRole('current-id').innerHTML).toMatchInlineSnapshot('"Current Task Id: t1"')
+
+      ReactTesting.act(() =>
+        store.commit(
+          events.todoCreated({ id: 't2', text: 'buy eggs', completed: false }),
+          events.AppRouterSet({ currentTaskId: 't2' }),
+          events.todoCreated({ id: 't3', text: 'buy bread', completed: false }),
+        ),
+      )
+
+      expect(renderCount.val).toBe(3)
+      expect(renderResult.getByRole('current-id').innerHTML).toMatchInlineSnapshot('"Current Task Id: t2"')
+    }),
+  )
+
+  Vitest.scopedLive('should work for a useClientDocument query chained with a useTemporary query', () =>
+    Effect.gen(function* () {
+      const { store, wrapper, renderCount } = yield* makeTodoMvcReact({})
+
+      store.commit(
+        events.todoCreated({ id: 't1', text: 'buy milk', completed: false }),
+        events.todoCreated({ id: 't2', text: 'buy bread', completed: false }),
+      )
+
+      const { result, unmount, rerender } = ReactTesting.renderHook(
+        (userId: string) => {
+          renderCount.inc()
+
+          const [_row, _setRow, _id, rowState$] = store.useClientDocument(tables.userInfo, userId)
+          const todos = store.useQuery(
+            LiveStore.queryDb(
+              (get) => tables.todos.where('text', 'LIKE', `%${get(rowState$).text}%`),
+              // TODO find a way where explicit `userId` is not needed here
+              // possibly by automatically understanding the `get(rowState$)` dependency
+              { label: 'todosFiltered', deps: userId },
+            ),
+            // TODO introduce a `deps` array which is only needed when a query is parametric
+          )
+
+          return { todos }
+        },
+        { wrapper, initialProps: 'u1' },
+      )
+
+      ReactTesting.act(() => store.commit(events.UserInfoSet({ username: 'username_u2', text: 'milk' }, 'u2')))
+
+      expect(result.current.todos.length).toBe(2)
+      expect(renderCount.val).toBe(1)
+
+      rerender('u2')
+
+      expect(result.current.todos.length).toBe(1)
+      expect(renderCount.val).toBe(2)
+
+      unmount()
+    }),
+  )
+
+  Vitest.describe('otel', () => {
+    it.each([{ strictMode: true }, { strictMode: false }])(
+      'should update the data based on component key strictMode=%s',
+      async ({ strictMode }) => {
+        const exporter = new InMemorySpanExporter()
+
+        const provider = new BasicTracerProvider({
+          spanProcessors: [new SimpleSpanProcessor(exporter)],
+        })
+
+        const otelTracer = provider.getTracer(`testing-${strictMode ? 'strict' : 'non-strict'}`)
+
+        const span = otelTracer.startSpan('test-root')
+        const otelContext = otel.trace.setSpan(otel.context.active(), span)
+
+        await Effect.gen(function* () {
+          const { wrapper, store, renderCount } = yield* makeTodoMvcReact({
+            otelContext,
+            otelTracer,
+            strictMode,
+          })
+
+          const { result, rerender, unmount } = ReactTesting.renderHook(
+            (userId: string) => {
+              renderCount.inc()
+
+              const [state, setState, id] = store.useClientDocument(tables.userInfo, userId)
+              return { state, setState, id }
+            },
+            { wrapper, initialProps: 'u1' },
+          )
+
+          expect(result.current.id).toBe('u1')
+          expect(result.current.state.username).toBe('')
+          expect(renderCount.val).toBe(1)
+
+          // For u2 we'll make sure that the row already exists,
+          // so the lazy `insert` will be skipped
+          ReactTesting.act(() => store.commit(events.UserInfoSet({ username: 'username_u2' }, 'u2')))
+
+          rerender('u2')
+
+          expect(result.current.id).toBe('u2')
+          expect(result.current.state.username).toBe('username_u2')
+          expect(renderCount.val).toBe(2)
+
+          unmount()
+          span.end()
+        }).pipe(Effect.scoped, Effect.tapCauseLogPretty, Effect.runPromise)
+
+        await provider.forceFlush()
+
+        const mapAttributes = (attributes: otel.Attributes) => {
+          return ReadonlyRecord.map(attributes, (val, key) => {
+            if (key === 'firstStackInfo') {
+              const stackInfo = JSON.parse(val as string) as LiveStore.StackInfo
+              // stackInfo.frames.shift() // Removes `renderHook.wrapper` from the stack
+              stackInfo.frames.forEach((_) => {
+                if (_.name.includes('renderHook.wrapper')) {
+                  _.name = 'renderHook.wrapper'
+                }
+                _.filePath = '__REPLACED_FOR_SNAPSHOT__'
+              })
+              return JSON.stringify(stackInfo)
+            }
+            return val
+          })
+        }
+
+        expect(getSimplifiedRootSpan(exporter, mapAttributes)).toMatchSnapshot()
+
+        await provider.shutdown()
+      },
+    )
+  })
+})