Skip to content

Commit 5e9bb6d

Browse files
fix(showcase): keep default pagination out of the canonical URL (#1472)
fix(showcase): keep default pagination out of canonical URL
1 parent 020677d commit 5e9bb6d

3 files changed

Lines changed: 73 additions & 17 deletions

File tree

‎src/routes/showcase/index.tsx‎

Lines changed: 9 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,18 @@
1-
import { createFileRoute } from '@tanstack/react-router'
1+
import { createFileRoute, stripSearchParams } from '@tanstack/react-router'
22
import * as v from 'valibot'
33
import { seo } from '~/utils/seo'
44
import { ShowcaseGallery } from '~/components/ShowcaseGallery'
55
import { getApprovedShowcasesQueryOptions } from '~/queries/showcases'
66
import {
7-
libraryIdSchema,
8-
showcaseUseCaseSchema,
9-
pageNumberSchema,
10-
pageSizeSchema,
11-
} from '~/utils/schemas'
12-
13-
const searchSchema = v.object({
14-
page: v.optional(pageNumberSchema, 1),
15-
pageSize: v.optional(pageSizeSchema, 24),
16-
libraryIds: v.optional(v.pipe(v.array(libraryIdSchema), v.maxLength(16))),
17-
useCases: v.optional(v.pipe(v.array(showcaseUseCaseSchema), v.maxLength(12))),
18-
hasSourceCode: v.optional(v.boolean()),
19-
q: v.optional(v.pipe(v.string(), v.maxLength(120))),
20-
})
7+
showcaseSearchSchema,
8+
defaultShowcaseSearch,
9+
} from '~/utils/showcase-search'
2110

2211
export const PAGE_SIZE_OPTIONS = [24, 48, 96] as const
2312

24-
function hasNonCanonicalSearch(search: v.InferOutput<typeof searchSchema>) {
13+
function hasNonCanonicalSearch(
14+
search: v.InferOutput<typeof showcaseSearchSchema>,
15+
) {
2516
return Boolean(
2617
search.page > 1 ||
2718
search.pageSize !== PAGE_SIZE_OPTIONS[0] ||
@@ -33,7 +24,8 @@ function hasNonCanonicalSearch(search: v.InferOutput<typeof searchSchema>) {
3324
}
3425

3526
export const Route = createFileRoute('/showcase/')({
36-
validateSearch: searchSchema,
27+
validateSearch: showcaseSearchSchema,
28+
search: { middlewares: [stripSearchParams(defaultShowcaseSearch)] },
3729
loaderDeps: ({ search }) => ({
3830
page: search.page,
3931
pageSize: search.pageSize,

‎src/utils/showcase-search.ts‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
import * as v from 'valibot'
2+
import {
3+
libraryIdSchema,
4+
showcaseUseCaseSchema,
5+
pageNumberSchema,
6+
pageSizeSchema,
7+
} from '~/utils/schemas'
8+
9+
export const showcaseSearchSchema = v.object({
10+
page: v.optional(pageNumberSchema, 1),
11+
pageSize: v.optional(pageSizeSchema, 24),
12+
libraryIds: v.optional(v.pipe(v.array(libraryIdSchema), v.maxLength(16))),
13+
useCases: v.optional(v.pipe(v.array(showcaseUseCaseSchema), v.maxLength(12))),
14+
hasSourceCode: v.optional(v.boolean()),
15+
q: v.optional(v.pipe(v.string(), v.maxLength(120))),
16+
})
17+
18+
export const defaultShowcaseSearch = v.parse(showcaseSearchSchema, {})

‎tests/showcase-search.test.ts‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
import assert from 'node:assert/strict'
2+
import test from 'node:test'
3+
import * as v from 'valibot'
4+
import {
5+
createRootRoute,
6+
createRoute,
7+
createRouter,
8+
createMemoryHistory,
9+
stripSearchParams,
10+
} from '@tanstack/react-router'
11+
import {
12+
showcaseSearchSchema,
13+
defaultShowcaseSearch,
14+
} from '../src/utils/showcase-search'
15+
16+
test('showcase defaults stay available to loaders without entering the URL', async () => {
17+
const root = createRootRoute()
18+
const showcase = createRoute({
19+
getParentRoute: () => root,
20+
path: '/showcase',
21+
validateSearch: showcaseSearchSchema,
22+
search: { middlewares: [stripSearchParams(defaultShowcaseSearch)] },
23+
})
24+
const router = createRouter({
25+
routeTree: root.addChildren([showcase]),
26+
history: createMemoryHistory({ initialEntries: ['/showcase'] }),
27+
})
28+
await router.load()
29+
assert.deepEqual(v.parse(showcaseSearchSchema, {}), { page: 1, pageSize: 24 })
30+
assert.equal(
31+
router.buildLocation({ to: '/showcase', search: { page: 1, pageSize: 24 } })
32+
.href,
33+
'/showcase',
34+
)
35+
const filtered = {
36+
page: 2,
37+
pageSize: 48,
38+
libraryIds: ['query'],
39+
hasSourceCode: true,
40+
q: 'dashboard',
41+
}
42+
assert.deepEqual(
43+
router.buildLocation({ to: '/showcase', search: filtered }).search,
44+
filtered,
45+
)
46+
})

0 commit comments

Comments
 (0)