Scrum4Me/__tests__/lib/user-settings.test.ts
Janpeter Visser bf7162a5fc
feat(PBI-76): migrate cookie-based prefs to user-settings (Phase 2) (#189)
* feat(PBI-76): extend UserSettings schema with layout

Adds layout.splitPanePositions and layout.activeSprints. These will
hold values currently kept in client-side and server-side cookies
(Phase 2). Two new tests cover the shape.

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

* feat(PBI-76): migrate SplitPane positions to user-settings store

Outside of a drag the store is the source of truth (cross-tab
updates flow in for free). During a drag we keep splits in local
state so mousemove does not round-trip through the store. On
mouseup we persist the final splits via setPref. Removes
document.cookie reads/writes — cookieKey is reused as the
store-key for backwards compat.

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

* feat(PBI-76): resolveActiveSprint reads from User.settings

lib/active-sprint:
- New helpers: getActiveSprintIdFromSettings, setActiveSprintInSettings,
  clearActiveSprintInSettings — all read/write user.settings.layout.activeSprints.
- resolveActiveSprint(productId, userId) — userId now required, falls back
  to first OPEN, then most recent CLOSED sprint.
- Cookie helpers (getActiveSprintIdFromCookie/setActiveSprintCookie/
  clearActiveSprintCookie) removed.

Callers updated to pass session.userId. The cookie-based fallback path
is gone — `actions/active-sprint.ts` and `actions/sprints.ts` will be
updated in the next commit (T-917).

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

* feat(PBI-76): rewrite setActiveSprint callers to use settings

setActiveSprintAction, syncActiveSprintCookieAction, and the two
sprint-creation paths in actions/sprints.ts now write through
setActiveSprintInSettings (which also emits pg_notify for cross-tab
sync) instead of dropping a cookie. The action names keep the
'cookie' suffix in the user-visible API for now — clean rename can
come later.

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

* feat(PBI-76): migration helper v2 — handle legacy cookies

Bumps marker version to 'v2'. buildMigrationPatch now also scans
document.cookie for `sp:*` (split-pane positions) and
`active_sprint_*` (active sprint per product) and lifts them into
layout.splitPanePositions / layout.activeSprints. clearLegacyStorage
replaces clearLegacyLocalStorage and clears both keys and cookies.
clearLegacyLocalStorage stays as a deprecated alias so the bridge
upgrade is a single rename.

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

* test(PBI-76): align tests with new SplitPane and active-sprint flow

- split-pane.test.tsx: seed positions via Zustand store instead of
  document.cookie; mock @/actions/user-settings so the prisma client
  is not transitively initialised in jsdom.
- backlog-split-pane.test.tsx: same action mock.
- sprint-dates.test.ts: add user.findUnique/update + $executeRaw
  mocks because createSprintAction now writes to user-settings.

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 21:20:29 +02:00

125 lines
3.9 KiB
TypeScript

import { describe, expect, it } from 'vitest'
import {
DEFAULT_USER_SETTINGS,
UserSettingsSchema,
mergeSettings,
parseUserSettings,
type UserSettings,
} from '@/lib/user-settings'
describe('mergeSettings', () => {
it('returns the patch when previous is empty', () => {
const result = mergeSettings({}, { views: { sprintBacklog: { sort: 'code' } } })
expect(result).toEqual({ views: { sprintBacklog: { sort: 'code' } } })
})
it('preserves existing keys when patch only sets new ones', () => {
const prev: UserSettings = { views: { sprintBacklog: { sort: 'code' } } }
const result = mergeSettings(prev, {
views: { pbiList: { sort: 'date' } },
})
expect(result).toEqual({
views: {
sprintBacklog: { sort: 'code' },
pbiList: { sort: 'date' },
},
})
})
it('merges nested objects without overwriting siblings', () => {
const prev: UserSettings = {
views: { sprintBacklog: { sort: 'code', sortDir: 'asc' } },
}
const result = mergeSettings(prev, {
views: { sprintBacklog: { sort: 'priority' } },
})
expect(result).toEqual({
views: { sprintBacklog: { sort: 'priority', sortDir: 'asc' } },
})
})
it('replaces arrays instead of appending', () => {
const prev: UserSettings = {
views: { sprintBacklog: { collapsedPbis: ['a', 'b'] } },
}
const result = mergeSettings(prev, {
views: { sprintBacklog: { collapsedPbis: ['c'] } },
})
expect(result.views?.sprintBacklog?.collapsedPbis).toEqual(['c'])
})
it('does not mutate the previous object', () => {
const prev: UserSettings = { views: { sprintBacklog: { sort: 'code' } } }
const snapshot = JSON.parse(JSON.stringify(prev))
mergeSettings(prev, { views: { sprintBacklog: { sortDir: 'desc' } } })
expect(prev).toEqual(snapshot)
})
it('skips undefined values in the patch', () => {
const prev: UserSettings = { views: { sprintBacklog: { sort: 'code' } } }
const result = mergeSettings(prev, { views: undefined })
expect(result).toEqual(prev)
})
})
describe('parseUserSettings', () => {
it('returns defaults for null', () => {
expect(parseUserSettings(null)).toEqual(DEFAULT_USER_SETTINGS)
})
it('returns defaults for undefined', () => {
expect(parseUserSettings(undefined)).toEqual(DEFAULT_USER_SETTINGS)
})
it('returns defaults for invalid input', () => {
expect(parseUserSettings({ views: { sprintBacklog: { filterStatus: 'BOGUS' } } }))
.toEqual(DEFAULT_USER_SETTINGS)
})
it('passes valid settings through', () => {
const valid = { views: { sprintBacklog: { sort: 'code' as const } } }
expect(parseUserSettings(valid)).toEqual(valid)
})
})
describe('UserSettingsSchema', () => {
it('rejects unknown top-level keys', () => {
const result = UserSettingsSchema.safeParse({ unknown: 1 })
expect(result.success).toBe(false)
})
it('accepts an empty object', () => {
expect(UserSettingsSchema.safeParse({}).success).toBe(true)
})
it('accepts the full shape', () => {
const result = UserSettingsSchema.safeParse({
views: {
sprintBacklog: {
filterPriority: 1,
filterStatus: 'OPEN',
sort: 'code',
sortDir: 'asc',
collapsedPbis: ['x'],
filterPopoverOpen: true,
},
pbiList: { sort: 'priority', filterPriority: 'all', filterStatus: 'ready', sortDir: 'desc' },
storyPanel: { sort: 'date' },
jobsColumns: { 'queue:active': { kinds: ['TASK_IMPLEMENTATION'], statuses: [] } },
},
devTools: { debugMode: true },
layout: {
splitPanePositions: { 'backlog-pid': [25, 35, 40] },
activeSprints: { 'product-1': 'sprint-1' },
},
})
expect(result.success).toBe(true)
})
it('accepts layout-only settings', () => {
expect(UserSettingsSchema.safeParse({
layout: { splitPanePositions: { x: [50, 50] }, activeSprints: { p: 's' } },
}).success).toBe(true)
})
})