Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
92 changes: 47 additions & 45 deletions src/routes/stats/npm/index.tsx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import * as React from 'react'
import { createFileRoute } from '@tanstack/react-router'
import { createFileRoute, stripSearchParams } from '@tanstack/react-router'
import * as v from 'valibot'
import { useThrottledCallback, useThrottler } from '@tanstack/react-pacer'
import { QuestionIcon } from '@phosphor-icons/react'
Expand Down Expand Up @@ -90,50 +90,55 @@ const bucketOffsetSchema = v.pipe(
v.maxValue(0),
)
const timelineZoomTimeSchema = v.pipe(v.number(), v.integer(), v.minValue(0))
export const Route = createFileRoute('/stats/npm/')({
validateSearch: v.object({
packageGroups: v.fallback(
v.optional(packageGroupsSchema, defaultPackageGroups),
defaultPackageGroups,
),
range: v.fallback(
v.optional(
v.picklist([
'7-days',
'30-days',
'90-days',
'180-days',
'365-days',
'730-days',
'1825-days',
'all-time',
]),
export const npmStatsSearchSchema = v.object({
packageGroups: v.fallback(
v.optional(packageGroupsSchema, defaultPackageGroups),
defaultPackageGroups,
),
range: v.fallback(
v.optional(
v.picklist([
'7-days',
'30-days',
'90-days',
'180-days',
'365-days',
'730-days',
'1825-days',
),
'all-time',
]),
'1825-days',
),
transform: v.fallback(v.optional(transformModeSchema, 'none'), 'none'),
binType: v.fallback(v.optional(binTypeSchema, 'weekly'), 'weekly'),
viewMode: v.fallback(v.optional(viewModeSchema, 'history'), 'history'),
chartType: v.fallback(v.optional(chartTypeSchema, 'line'), 'line'),
barOrientation: v.fallback(v.optional(barOrientationSchema), undefined),
barSort: v.fallback(v.optional(latestBarSortSchema, 'value'), 'value'),
bucketOffset: v.fallback(v.optional(bucketOffsetSchema, 0), 0),
playbackIntervalMs: v.fallback(
v.optional(playbackIntervalMsSchema, defaultPlaybackIntervalMs),
defaultPlaybackIntervalMs,
),
playbackLoop: v.fallback(v.optional(v.boolean(), false), false),
playbackPlaying: v.fallback(v.optional(v.boolean(), false), false),
showDataMode: v.fallback(v.optional(showDataModeSchema, 'all'), 'all'),
normalizeBaseline: v.fallback(v.optional(v.boolean(), true), true),
showBaseline: v.fallback(v.optional(v.boolean(), false), false),
showLegend: v.fallback(v.optional(v.boolean(), false), false),
height: v.fallback(v.optional(chartHeightSchema, 400), 400),
width: v.fallback(v.optional(chartWidthSchema), undefined),
timelineStart: v.fallback(v.optional(timelineZoomTimeSchema), undefined),
timelineEnd: v.fallback(v.optional(timelineZoomTimeSchema), undefined),
}),
'1825-days',
),
transform: v.fallback(v.optional(transformModeSchema, 'none'), 'none'),
binType: v.fallback(v.optional(binTypeSchema, 'weekly'), 'weekly'),
viewMode: v.fallback(v.optional(viewModeSchema, 'history'), 'history'),
chartType: v.fallback(v.optional(chartTypeSchema, 'line'), 'line'),
barOrientation: v.fallback(v.optional(barOrientationSchema), undefined),
barSort: v.fallback(v.optional(latestBarSortSchema, 'value'), 'value'),
bucketOffset: v.fallback(v.optional(bucketOffsetSchema, 0), 0),
playbackIntervalMs: v.fallback(
v.optional(playbackIntervalMsSchema, defaultPlaybackIntervalMs),
defaultPlaybackIntervalMs,
),
playbackLoop: v.fallback(v.optional(v.boolean(), false), false),
playbackPlaying: v.fallback(v.optional(v.boolean(), false), false),
showDataMode: v.fallback(v.optional(showDataModeSchema, 'all'), 'all'),
normalizeBaseline: v.fallback(v.optional(v.boolean(), true), true),
showBaseline: v.fallback(v.optional(v.boolean(), false), false),
showLegend: v.fallback(v.optional(v.boolean(), false), false),
height: v.fallback(v.optional(chartHeightSchema, 400), 400),
width: v.fallback(v.optional(chartWidthSchema), undefined),
timelineStart: v.fallback(v.optional(timelineZoomTimeSchema), undefined),
timelineEnd: v.fallback(v.optional(timelineZoomTimeSchema), undefined),
})

export const defaultNpmStatsSearch = v.parse(npmStatsSearchSchema, {})

export const Route = createFileRoute('/stats/npm/')({
validateSearch: npmStatsSearchSchema,
search: { middlewares: [stripSearchParams(defaultNpmStatsSearch)] },
loaderDeps: ({ search }) => ({
packageList: search.packageGroups?.map(getPackageGroupLabel).join(' vs '),
packageNames: search.packageGroups?.map(getPackageGroupLabel) ?? [],
Expand Down Expand Up @@ -242,9 +247,6 @@ export const Route = createFileRoute('/stats/npm/')({
}
},
component: RouteComponent,
staticData: {
includeSearchInCanonical: true,
},
})

type _NpmStatsSearch = {
Expand Down
41 changes: 41 additions & 0 deletions tests/npm-stats-search-defaults.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
import assert from 'node:assert/strict'
import test from 'node:test'
import * as v from 'valibot'
import { stripSearchParams } from '@tanstack/react-router'
import {
npmStatsSearchSchema,
defaultNpmStatsSearch,
} from '../src/routes/stats/npm/index'

test('default chart state produces a clean shareable URL', () => {
const result = v.parse(npmStatsSearchSchema, {})
const serialized = stripSearchParams(defaultNpmStatsSearch)({
search: result,
next: () => result,
})
assert.deepEqual(serialized, {})
})

test('non-default packages and display controls survive default stripping', () => {
for (const packages of [
['react'],
['@tanstack/react-query'],
['react', 'vue'],
]) {
const packageGroups = packages.map((name) => ({ packages: [{ name }] }))
const result = v.parse(npmStatsSearchSchema, {
packageGroups,
height: 600,
showLegend: true,
})
const serialized = stripSearchParams(defaultNpmStatsSearch)({
search: result,
next: () => result,
})
assert.deepEqual(serialized, {
packageGroups,
height: 600,
showLegend: true,
})
}
})
Loading