Client navigation to a server route without a `search` schema throws: args carry `search: undefined`, which JSON arguments reject
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 65/100
- Issue type
- Bug
- Clarity
- Clearly specified
- Activity status
- Active
- Tech stack
- javascript, nodejs, typescript
- Domain
- backend-api-design, full-stack
Research direction
Look at src/serverRouteShared.ts to see how serverRouteArgs always returns search: undefined. Understand the isJSONSafe check in @solidjs/web that rejects undefined. The fix likely involves modifying the router to omit the search key when no schema exists, or adjusting the serialization logic. Test by reproducing the bug with the provided example and verifying client navigation works after changes.
Written by the indexing model from the issue text.
Description
Describe the bug
serverRouteArgs (src/serverRouteShared.ts) always returns { params, search }, and search is undefined when the route declares no search schema. On the client, @solidjs/web sends server function arguments as plain JSON by default. Its isJSONSafe check rejects undefined anywhere in the arguments, so the call throws before any request is made:
Server function arguments are sent as JSON by default and these arguments are not JSON-serializable. Call enableRichArguments() (from "@solidjs/web/server-functions/rich-args") once at startup ...
The route shows the error boundary instead of the page. Server rendering is not affected, because the server calls the function directly, so the first page load works and only client navigation fails. This covers every serverRouteComponent route and every file-system server page that has no search schema, which is the common case.
Your Example Website or App
The code below. I ran it as-is in a Vite start-mode app whose src/app.tsx renders <Router> inside <Loading>.
Steps to Reproduce the Bug or Issue
With @solidjs/router@2.0.0-next.28, @solidjs/web@2.0.0-rc.9 and @solidjs/vite-plugin@3.0.0-next.44 (start: {}, ssr: true, serverFunctions: { components: true }):
import { createRouter, defineRoute, query, serverRouteComponent } from "@solidjs/router";
const home = async () => {
"use server";
return () => <a href="/about">About</a>;
};
const about = async () => {
"use server";
return () => <p>About</p>;
};
export const Router = createRouter({
routes: [
defineRoute({ path: "/", component: serverRouteComponent(query(home, "home")) }),
defineRoute({ path: "/about", component: serverRouteComponent(query(about, "about")) })
]
});
- Load
/. It renders. - Click the "About" link.
- The client throws the error above, and no
/_server/data/...request is sent.
Calling enableRichArguments() at startup makes the navigation work, which confirms search: undefined is the only non-JSON value in the arguments.
Expected behavior
Navigating to a server route without a search schema should work with the default JSON argument encoding. The router could leave the search key out when there is no schema. A missing key and an explicit undefined look the same to the server function's destructuring, and the query key only needs the args to be stable. Alternatively, @solidjs/web's isJSONSafe could skip undefined object properties the way JSON.stringify does. The router seems like the smaller fix, since apps shouldn't need rich arguments just to use server routes.
Screenshots or Videos
None.
Platform
- OS: macOS 15 (Darwin 24.3.0)
- Browser: Chromium 149 (headless, Playwright)
- Versions:
@solidjs/router@2.0.0-next.28,@solidjs/web@2.0.0-rc.9,solid-js@2.0.0-rc.9,@solidjs/vite-plugin@3.0.0-next.44
Additional context
Using enableRichArguments() as a workaround currently runs into a separate @solidjs/web packaging bug in Vite builds (the rich-args import does not resolve under rolldown), so apps need a resolve alias as well.
- Dominant language
- TypeScript
- Stars
- 1.3k
- Forks
- 180
- Avg merge
- 1d 10h
- Merged PRs (30d)
- 19
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from solidjs/solid-router
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
solidjs/solid-router#605 · 1 comment ·
-
Difficulty 3/5 1-2 days Newbie friendliness 78/100
solidjs/solid-router#603 · 1 comment ·
-
<A> costs ~6us of server CPU per instance during SSR (20x a plain <a>), mostly mergeProps/splitProps Open
Difficulty 4/5 3-5 days Newbie friendliness 55/100
solidjs/solid-router#583 ·
-
enhancement
Difficulty 5/5 Over a week Newbie friendliness 35/100
solidjs/solid-router#569 · 3 comments ·
-
enhancement
Difficulty 3/5 1-2 days Newbie friendliness 38/100
solidjs/solid-router#518 · 2 comments ·
All issues in solidjs/solid-router
Similar issues
-
bug(cli): hapi doctor inline-media prints a fabricated B:\ helper-script path in packaged installs Open
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
-
Crush Open
Difficulty 1/5 Under an hour Newbie friendliness 85/100
catppuccin/catppuccin#3125 ·
-
Add a SECURITY.md Open
Difficulty 1/5 Under an hour Newbie friendliness 90/100
ElementsProject/cln-application#167 · 1 comment · 1 reaction ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
Quantco/pnpm-licenses#17 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100