Scrum4Me/__tests__/stores/user-settings.test.ts
Janpeter Visser a0e5867857
feat(PBI-76): user-settings DB-store infrastructure (Phase 0) (#185)
* docs(PBI-76): plan for user-settings DB-store

Persists view/filter prefs in User.settings (Json) instead of
localStorage. SSR-correct hydration, cross-tab sync via
LISTEN/NOTIFY + SSE, cross-device persistence.

Phased: 0=infra, 1=migrate flicker sources, 2=cookie consolidation.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

* feat(PBI-76): User.settings json column + migration

Adds JSONB column to users table for persistent user prefs.
Idempotent SQL — safe on databases where column already exists.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

* feat(PBI-76): user-settings types and merge helpers

Zod schema for User.settings shape (views/devTools), deep-merge
helper that replaces arrays and merges nested objects, and a
safe parser that returns defaults on invalid input.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

* feat(PBI-76): updateUserSettingsAction with notify

Validates patch via Zod, deep-merges with current settings in
a transaction, persists to DB, and emits pg_notify on
scrum4me_changes for cross-tab/cross-device sync. Demo accounts
get 403, unauthenticated 401, invalid input 422.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

* feat(PBI-76): user-settings zustand store with optimistic flow

Hydrate from prop (SSR-correct), setPref via path with optimistic
update + rollback on server error, applyServerPatch for SSE-driven
cross-tab updates. Demo accounts skip server-write entirely.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

* feat(PBI-76): SSE route for user-settings

User-scoped /api/realtime/user-settings stream that filters
scrum4me_changes notifications on kind=user_settings and matching
userId. Forwards the patch as a data: event so other tabs can
applyServerPatch without re-fetching settings.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

* feat(PBI-76): user-settings bridge mounted in app layout

Hydrates the zustand store with the user's persisted settings via
prop (SSR-correct, no flicker). Opens an EventSource to
/api/realtime/user-settings so changes from other tabs/devices
flow into the same store. Demo accounts skip the SSE subscription.

Layout now selects user.settings alongside the other user fields,
no extra DB roundtrip.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

* test(PBI-76): user-settings lib/action/store coverage

22 vitest cases covering merge semantics (no mutation, array
replace, nested merge), Zod schema strictness, server action
auth/demo/validation paths, and the optimistic store flow
including rollback and demo-mode skip.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

* chore(PBI-76): sync package-lock to v1.3.3

Lockfile drifted after @prisma/client reinstall during the
schema regenerate. No dependency changes — just the version
field tracking package.json bumped in #184.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-10 12:44:32 +02:00

105 lines
3.1 KiB
TypeScript

import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest'
const updateAction = vi.fn()
vi.mock('@/actions/user-settings', () => ({
updateUserSettingsAction: (...args: unknown[]) => updateAction(...args),
}))
import { useUserSettingsStore } from '@/stores/user-settings/store'
function resetStore() {
useUserSettingsStore.setState((s) => {
s.entities.settings = {}
s.context.hydrated = false
s.context.isDemo = false
s.pendingMutations = {}
})
}
beforeEach(() => {
resetStore()
updateAction.mockReset()
})
afterEach(() => {
resetStore()
})
describe('useUserSettingsStore', () => {
it('hydrate sets entities and context', () => {
useUserSettingsStore.getState().hydrate(
{ views: { sprintBacklog: { sort: 'code' } } },
false,
)
const s = useUserSettingsStore.getState()
expect(s.entities.settings.views?.sprintBacklog?.sort).toBe('code')
expect(s.context.hydrated).toBe(true)
expect(s.context.isDemo).toBe(false)
})
it('setPref updates state optimistically and settles on success', async () => {
useUserSettingsStore.getState().hydrate({}, false)
updateAction.mockResolvedValueOnce({
success: true,
settings: { views: { sprintBacklog: { filterStatus: 'all' } } },
})
await useUserSettingsStore
.getState()
.setPref(['views', 'sprintBacklog', 'filterStatus'], 'all')
const s = useUserSettingsStore.getState()
expect(s.entities.settings.views?.sprintBacklog?.filterStatus).toBe('all')
expect(Object.keys(s.pendingMutations)).toHaveLength(0)
expect(updateAction).toHaveBeenCalledWith({
views: { sprintBacklog: { filterStatus: 'all' } },
})
})
it('setPref rolls back on server error', async () => {
useUserSettingsStore.getState().hydrate(
{ views: { sprintBacklog: { sort: 'code' } } },
false,
)
updateAction.mockResolvedValueOnce({ error: 'boom', code: 422 })
await useUserSettingsStore
.getState()
.setPref(['views', 'sprintBacklog', 'sort'], 'priority')
const s = useUserSettingsStore.getState()
expect(s.entities.settings.views?.sprintBacklog?.sort).toBe('code')
expect(Object.keys(s.pendingMutations)).toHaveLength(0)
})
it('setPref skips server-call for demo accounts', async () => {
useUserSettingsStore.getState().hydrate({}, true)
await useUserSettingsStore
.getState()
.setPref(['devTools', 'debugMode'], true)
const s = useUserSettingsStore.getState()
expect(s.entities.settings.devTools?.debugMode).toBe(true)
expect(updateAction).not.toHaveBeenCalled()
})
it('applyServerPatch merges without optimistic state', () => {
useUserSettingsStore.getState().hydrate(
{ views: { sprintBacklog: { sort: 'code' } } },
false,
)
useUserSettingsStore.getState().applyServerPatch({
views: { sprintBacklog: { sortDir: 'desc' } },
})
const s = useUserSettingsStore.getState()
expect(s.entities.settings.views?.sprintBacklog).toEqual({
sort: 'code',
sortDir: 'desc',
})
expect(Object.keys(s.pendingMutations)).toHaveLength(0)
})
})