refactor(web): migrate document list query state to nuqs (#32339)

This commit is contained in:
yyh
2026-03-03 18:29:23 +08:00
committed by GitHub
parent 3a8ff301fc
commit 1a90c4d81b
49 changed files with 1272 additions and 2003 deletions

60
web/test/nuqs-testing.tsx Normal file
View File

@@ -0,0 +1,60 @@
import type { UrlUpdateEvent } from 'nuqs/adapters/testing'
import type { ComponentProps, ReactElement, ReactNode } from 'react'
import type { Mock } from 'vitest'
import { render, renderHook } from '@testing-library/react'
import { NuqsTestingAdapter } from 'nuqs/adapters/testing'
import { vi } from 'vitest'
type NuqsSearchParams = ComponentProps<typeof NuqsTestingAdapter>['searchParams']
type NuqsOnUrlUpdate = (event: UrlUpdateEvent) => void
type NuqsOnUrlUpdateSpy = Mock<NuqsOnUrlUpdate>
type NuqsTestOptions = {
searchParams?: NuqsSearchParams
onUrlUpdate?: NuqsOnUrlUpdateSpy
}
type NuqsHookTestOptions<Props> = NuqsTestOptions & {
initialProps?: Props
}
type NuqsWrapperProps = {
children: ReactNode
}
export const createNuqsTestWrapper = (options: NuqsTestOptions = {}) => {
const { searchParams = '', onUrlUpdate } = options
const urlUpdateSpy = onUrlUpdate ?? vi.fn<NuqsOnUrlUpdate>()
const wrapper = ({ children }: NuqsWrapperProps) => (
<NuqsTestingAdapter searchParams={searchParams} onUrlUpdate={urlUpdateSpy}>
{children}
</NuqsTestingAdapter>
)
return {
wrapper,
onUrlUpdate: urlUpdateSpy,
}
}
export const renderWithNuqs = (ui: ReactElement, options: NuqsTestOptions = {}) => {
const { wrapper, onUrlUpdate } = createNuqsTestWrapper(options)
const rendered = render(ui, { wrapper })
return {
...rendered,
onUrlUpdate,
}
}
export const renderHookWithNuqs = <Result, Props = void>(
callback: (props: Props) => Result,
options: NuqsHookTestOptions<Props> = {},
) => {
const { initialProps, ...nuqsOptions } = options
const { wrapper, onUrlUpdate } = createNuqsTestWrapper(nuqsOptions)
const rendered = renderHook(callback, { wrapper, initialProps })
return {
...rendered,
onUrlUpdate,
}
}