-
Notifications
You must be signed in to change notification settings - Fork 5.4k
fix(web): persist design files view state across navigation #2303
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
neogenix
wants to merge
8
commits into
nexu-io:main
Choose a base branch
from
eefynet:fix/web-design-files-persist-view
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+693
−5
Open
Changes from 7 commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
bb2fb21
fix(web): persist design-files view state across navigation
neogenix 0b8d5a1
fix(web): address review feedback on view-state persistence
neogenix d3f903d
fix(web): harden design-files view-state persistence
neogenix 950b44e
test(e2e): design files view state persists across navigation and reload
neogenix c5a8e94
fix(e2e): address code-reviewer feedback on view-state-persist test
neogenix 5432470
test(e2e): split design-files persist into nav, reload, and per-proje…
neogenix 5237148
fix(web): tighten isPageSize to discrete option set, add invalid-valu…
neogenix 32ac2a9
fix(web): isolate DesignFilesPanel.test.tsx from persisted view-state…
neogenix File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
191 changes: 191 additions & 0 deletions
191
apps/web/tests/components/DesignFilesPanel.view-state-persist.test.tsx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,191 @@ | ||
| // @vitest-environment jsdom | ||
| // | ||
| // Red spec for bug #3a: view state (pageSize, sortKey, sortDir, kindFilter) | ||
| // resets on navigation because the component remounts via key={projectId}. | ||
| // These tests must go RED on origin/main and GREEN after the fix. | ||
|
|
||
| import { cleanup, fireEvent, render } from '@testing-library/react'; | ||
| import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest'; | ||
|
|
||
| import { DesignFilesPanel } from '../../src/components/DesignFilesPanel'; | ||
| import type { ProjectFile, ProjectFileKind } from '../../src/types'; | ||
|
|
||
| // Minimal localStorage stub mirroring the pattern in state/config.test.ts | ||
| const store = new Map<string, string>(); | ||
| vi.stubGlobal('localStorage', { | ||
| getItem: vi.fn((key: string) => store.get(key) ?? null), | ||
| setItem: vi.fn((key: string, value: string) => { | ||
| store.set(key, value); | ||
| }), | ||
| removeItem: vi.fn((key: string) => { | ||
| store.delete(key); | ||
| }), | ||
| clear: vi.fn(() => { | ||
| store.clear(); | ||
| }), | ||
| }); | ||
|
|
||
| function file(name: string, kind: ProjectFileKind = 'html', mtime = Date.now()): ProjectFile { | ||
| return { path: name, name, type: 'file', size: 1024, mtime, kind, mime: 'text/html' }; | ||
| } | ||
|
|
||
| function generateFiles(count: number): ProjectFile[] { | ||
| const kinds: ProjectFileKind[] = ['html', 'image', 'sketch', 'text', 'code', 'pdf']; | ||
| return Array.from({ length: count }, (_, i) => { | ||
| const kind = kinds[i % kinds.length]!; | ||
| return file(`file-${i + 1}.html`, kind, Date.now() - i * 60_000); | ||
| }); | ||
| } | ||
|
|
||
| function renderPanel( | ||
| files: ProjectFile[], | ||
| projectId = 'proj-a', | ||
| ) { | ||
| return render( | ||
| <DesignFilesPanel | ||
| projectId={projectId} | ||
| files={files} | ||
| liveArtifacts={[]} | ||
| onRefreshFiles={vi.fn()} | ||
| onOpenFile={vi.fn()} | ||
| onOpenLiveArtifact={vi.fn()} | ||
| onRenameFile={vi.fn()} | ||
| onDeleteFile={vi.fn()} | ||
| onDeleteFiles={vi.fn()} | ||
| onUpload={vi.fn()} | ||
| onUploadFiles={vi.fn()} | ||
| onPaste={vi.fn()} | ||
| onNewSketch={vi.fn()} | ||
| />, | ||
| ); | ||
| } | ||
|
|
||
| function getPerPageSelect(container: HTMLElement): HTMLSelectElement { | ||
| // The per-page select is the first select in the panel | ||
| return container.querySelector<HTMLSelectElement>('.df-pagination-start select')!; | ||
| } | ||
|
|
||
| function getSortBtn(container: HTMLElement, label: string): HTMLElement { | ||
| return Array.from(container.querySelectorAll<HTMLElement>('.df-th-btn')).find( | ||
| (el) => el.textContent?.trim().startsWith(label), | ||
| )!; | ||
| } | ||
|
|
||
| describe('DesignFilesPanel view-state persistence', () => { | ||
| beforeEach(() => { | ||
| store.clear(); | ||
| vi.mocked(localStorage.getItem).mockClear(); | ||
| vi.mocked(localStorage.setItem).mockClear(); | ||
| }); | ||
|
|
||
| afterEach(() => { | ||
| cleanup(); | ||
| }); | ||
|
|
||
| it('restores pageSize from localStorage after remount', () => { | ||
| const files = generateFiles(500); | ||
|
|
||
| // First mount: change page size to 60 | ||
| const first = renderPanel(files); | ||
| const sel = getPerPageSelect(first.container); | ||
| fireEvent.change(sel, { target: { value: '60' } }); | ||
| first.unmount(); | ||
|
|
||
| // Second mount simulates navigation away and back (key={projectId} causes remount) | ||
| const second = renderPanel(files); | ||
| const restoredSel = getPerPageSelect(second.container); | ||
| expect(restoredSel.value).toBe('60'); | ||
| }); | ||
|
|
||
| it('restores sort key from localStorage after remount', () => { | ||
| const files = generateFiles(50); | ||
|
|
||
| // First mount: click "Name" header to sort by name | ||
| const first = renderPanel(files); | ||
| fireEvent.click(getSortBtn(first.container, 'Name')); | ||
| first.unmount(); | ||
|
|
||
| // Second mount: "Name" column should show the sort arrow | ||
| const second = renderPanel(files); | ||
| const nameBtn = getSortBtn(second.container, 'Name'); | ||
| expect(nameBtn.textContent).toContain('↑'); | ||
| }); | ||
|
|
||
| it('restores sort direction from localStorage after remount', () => { | ||
| const files = generateFiles(50); | ||
|
|
||
| // First mount: click "Name" twice to get desc | ||
| const first = renderPanel(files); | ||
| fireEvent.click(getSortBtn(first.container, 'Name')); | ||
| fireEvent.click(getSortBtn(first.container, 'Name')); | ||
| first.unmount(); | ||
|
|
||
| // Second mount: Name column should show desc arrow | ||
| const second = renderPanel(files); | ||
| const nameBtn = getSortBtn(second.container, 'Name'); | ||
| expect(nameBtn.textContent).toContain('↓'); | ||
| }); | ||
|
|
||
| it('restores kindFilter from localStorage after remount', () => { | ||
| // Files with mixed kinds so the filter button appears | ||
| const files = [ | ||
| file('a.html', 'html'), | ||
| file('b.png', 'image'), | ||
| file('c.txt', 'text'), | ||
| ]; | ||
|
|
||
| // First mount: open the filter popover and check 'HTML page' | ||
| const first = renderPanel(files); | ||
| const filterTrigger = first.container.querySelector<HTMLElement>('.df-kind-filter-trigger'); | ||
| expect(filterTrigger).not.toBeNull(); | ||
| fireEvent.click(filterTrigger!); | ||
| const checkboxes = first.container.querySelectorAll<HTMLInputElement>( | ||
| '.df-kind-filter-list input[type="checkbox"]', | ||
| ); | ||
| // Check the first checkbox (HTML) | ||
| if (checkboxes[0]) fireEvent.click(checkboxes[0]); | ||
| first.unmount(); | ||
|
|
||
| // Second mount: filter button should show active state (a kind is selected) | ||
| const second = renderPanel(files); | ||
| const trigger = second.container.querySelector('.df-kind-filter-trigger'); | ||
| expect(trigger?.classList.contains('active')).toBe(true); | ||
| }); | ||
|
|
||
| it('does not bleed pageSize from one project into another', () => { | ||
| const files = generateFiles(500); | ||
|
|
||
| // Project A: set page size 60 | ||
| const first = renderPanel(files, 'proj-a'); | ||
| fireEvent.change(getPerPageSelect(first.container), { target: { value: '60' } }); | ||
| first.unmount(); | ||
|
|
||
| // Project B: should still have the default (30), not project A's setting | ||
| const second = renderPanel(files, 'proj-b'); | ||
| expect(getPerPageSelect(second.container).value).toBe('30'); | ||
| }); | ||
|
|
||
| it('writes view state to localStorage on pageSize change', () => { | ||
| const files = generateFiles(500); | ||
| const { container } = renderPanel(files); | ||
|
|
||
| fireEvent.change(getPerPageSelect(container), { target: { value: '45' } }); | ||
|
|
||
| expect(vi.mocked(localStorage.setItem)).toHaveBeenCalledWith( | ||
| expect.stringMatching(/od:design-files:view-state/), | ||
| expect.any(String), | ||
| ); | ||
| }); | ||
|
|
||
| it('falls back to default pageSize when stored value is not a supported option', () => { | ||
| const files = generateFiles(500); | ||
|
|
||
| // Seed localStorage with an unsupported value (fractional, out-of-set integer) | ||
| for (const bad of [0.5, 17, 999, -1, 0]) { | ||
| vi.mocked(localStorage.getItem).mockReturnValueOnce(JSON.stringify({ pageSize: bad })); | ||
| const { container } = renderPanel(files); | ||
| expect(getPerPageSelect(container).value).toBe('30'); | ||
| cleanup(); | ||
| } | ||
| }); | ||
| }); |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Persisting every preference change under the real project key here makes the existing
🔁 Powered by Looper · runner=reviewer · agent=opencode · An autonomous AI dev team for your GitHub repos.apps/web/tests/components/DesignFilesPanel.test.tsxsuite stateful across cases, because itsrenderPanel()helper hardcodesprojectId="test-project"and never clearsod:design-files:view-state:v1:test-projectbetween tests. On this head,pnpm --filter @open-design/web exec vitest run -c vitest.config.ts tests/components/DesignFilesPanel.test.tsxnow fails 4 cases: aftershows 60 rows when page size is changed to 60, the later defaults-based assertions start from the restoredpageSize=60instead of30(navigates pages...sees 60 rows,updates page info...sees1–60 of 500, etc.). Because this PR introduces that persisted state, the existing regression suite now goes red at HEAD. Please isolate those tests from this storage key—for example by clearing it inafterEach, or by giving each case a uniqueprojectId—so the pre-existing large-list assertions stay deterministic.