Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/bright-keys-update.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@tanstack/preact-store': patch
---

Fix stale `useSelector` results when a selector changes while the store snapshot stays unchanged, including selectors that capture component props. Preserve snapshot caching for selectors that return fresh arrays or objects.
2 changes: 1 addition & 1 deletion docs/framework/preact/reference/functions/useSelector.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ function useSelector<TSource, TSelected>(
options?): TSelected;
```

Defined in: [preact-store/src/useSelector.ts:128](https://github.com/TanStack/store/blob/main/packages/preact-store/src/useSelector.ts#L128)
Defined in: [preact-store/src/useSelector.ts:129](https://github.com/TanStack/store/blob/main/packages/preact-store/src/useSelector.ts#L129)

Selects a slice of state from an atom or store and subscribes the component
to that selection.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ id: UseSelectorOptions
title: UseSelectorOptions
---

Defined in: [preact-store/src/useSelector.ts:9](https://github.com/TanStack/store/blob/main/packages/preact-store/src/useSelector.ts#L9)
Defined in: [preact-store/src/useSelector.ts:10](https://github.com/TanStack/store/blob/main/packages/preact-store/src/useSelector.ts#L10)

## Type Parameters

Expand All @@ -19,7 +19,7 @@ Defined in: [preact-store/src/useSelector.ts:9](https://github.com/TanStack/stor
optional compare: (a, b) => boolean;
```

Defined in: [preact-store/src/useSelector.ts:10](https://github.com/TanStack/store/blob/main/packages/preact-store/src/useSelector.ts#L10)
Defined in: [preact-store/src/useSelector.ts:11](https://github.com/TanStack/store/blob/main/packages/preact-store/src/useSelector.ts#L11)

#### Parameters

Expand Down
33 changes: 16 additions & 17 deletions packages/preact-store/src/useSelector.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ import {
useCallback,
useEffect,
useLayoutEffect,
useMemo,
useRef,
useState,
} from 'preact/hooks'
Expand Down Expand Up @@ -146,26 +147,24 @@ export function useSelector<TSource, TSelected = NoInfer<TSource>>(
// returning a fresh reference each call (e.g. `(s) => [s.one, s.two]`) still
// produce a stable reference for unchanged snapshots. Without this, the
// shim's identity-based memo would always miss and trigger an update loop.
const selectorMemoRef = useRef<{
_hasMemo: boolean
_snapshot: TSource | undefined
_selected: TSelected | undefined
}>({ _hasMemo: false, _snapshot: undefined, _selected: undefined })

const memoizedSelector = useCallback(
(snapshot: TSource): TSelected => {
const memo = selectorMemoRef.current
if (memo._hasMemo && Object.is(memo._snapshot, snapshot)) {
return memo._selected as TSelected
// Scope the cache to the selector so a new selector can read the same
// snapshot with updated props instead of reusing the previous selection.
const memoizedSelector = useMemo(() => {
let hasMemo = false
let previousSnapshot: TSource
let previousSelection: TSelected

return (snapshot: TSource): TSelected => {
if (hasMemo && Object.is(previousSnapshot, snapshot)) {
return previousSelection
}
const next = selector(snapshot)
memo._hasMemo = true
memo._snapshot = snapshot
memo._selected = next
hasMemo = true
previousSnapshot = snapshot
previousSelection = next
return next
},
[selector],
)
}
}, [selector])

return useSyncExternalStoreWithSelector(
subscribe,
Expand Down
84 changes: 84 additions & 0 deletions packages/preact-store/tests/index.test.tsx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import { act, render, renderHook, waitFor } from '@testing-library/preact'
import { userEvent } from '@testing-library/user-event'
import { useCallback } from 'preact/hooks'
import { describe, expect, it, test, vi } from 'vitest'
import { createAtom, createStore } from '@tanstack/store'
import {
Expand Down Expand Up @@ -390,6 +391,89 @@ describe('store hooks', () => {
expect(getByText('Store: 0')).toBeInTheDocument()
})

it.each([false, true])(
'useSelector updates when captured props change (memoized: %s)',
(memoized) => {
const store = createStore({ alt: true, control: false })
const snapshot = store.get()
const { result, rerender } = renderHook(
({ modifier }: { modifier: 'alt' | 'control' }) => {
const selector = (state: typeof snapshot) => state[modifier]
const stableSelector = useCallback(selector, [modifier])
return useSelector(store, memoized ? stableSelector : selector)
},
{ initialProps: { modifier: 'alt' } },
)

expect(result.current).toBe(true)
rerender({ modifier: 'control' })
expect(result.current).toBe(false)
rerender({ modifier: 'alt' })
expect(result.current).toBe(true)
expect(store.get()).toBe(snapshot)

act(() => {
store.setState(() => ({ alt: false, control: true }))
})
expect(result.current).toBe(false)
},
)

it('useSelector caches unchanged snapshots for a stable selector', () => {
const store = createStore({ count: 1 })
const selector = vi.fn((state: { count: number }) => [state.count])
const { result, rerender } = renderHook(() => useSelector(store, selector))
const selection = result.current

expect(selection).toEqual([1])
expect(selector).toHaveBeenCalledTimes(1)
rerender()
expect(result.current).toBe(selection)
expect(selector).toHaveBeenCalledTimes(1)

act(() => {
store.setState(() => ({ count: 2 }))
})
expect(result.current).toEqual([2])
expect(selector).toHaveBeenCalledTimes(2)
})

it('useSelector compares selections across selector changes', () => {
const store = createStore({ one: 1, two: 1, three: 3 })
const { result, rerender } = renderHook(
({ key }: { key: 'one' | 'two' | 'three' }) =>
useSelector(store, (state) => [state[key]], { compare: shallow }),
{ initialProps: { key: 'one' } },
)
const selection = result.current

expect(selection).toEqual([1])
rerender({ key: 'two' })
expect(result.current).toBe(selection)
rerender({ key: 'three' })
expect(result.current).toEqual([3])
expect(result.current).not.toBe(selection)
})

it('useSelector supports fresh array selections across parent rerenders', () => {
const store = createStore({ count: 1 })
const { result, rerender } = renderHook(
({ offset }) => useSelector(store, (state) => [state.count + offset]),
{ initialProps: { offset: 0 } },
)

expect(result.current).toEqual([1])
rerender({ offset: 0 })
expect(result.current).toEqual([1])
rerender({ offset: 2 })
expect(result.current).toEqual([3])

act(() => {
store.setState(() => ({ count: 2 }))
})
expect(result.current).toEqual([4])
})

it('useSelector reads writable and readonly store state', async () => {
const baseStore = createStore(1)
const readonlyStore = createStore(() => ({ value: baseStore.state * 2 }))
Expand Down
Loading