Skip to content

Conversation

@adbjo
Copy link

@adbjo adbjo commented Dec 1, 2025

The router adds quotes around numerical strings in search params, for example:
http://my-app.com?p=123 changes to http://my-app.com?p="123"

Maybe this is intentional, but seems a bit wonky to me, so here is a fix.

Summary by CodeRabbit

  • Bug Fixes
    • Improved search parameter handling to ensure correct serialization of parsed values, maintaining consistency between parameter parsing and serialization.

✏️ Tip: You can customize this high-level summary in your review settings.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Dec 1, 2025

Walkthrough

The stringifySearchWith function in the search parameters utility now parses string values before stringifying them when a parser is provided, ensuring serialization symmetry with parseSearchWith and correctly handling parseable strings.

Changes

Cohort / File(s) Summary
Search Parameters Utilities
packages/router-core/src/searchParams.ts
Modified stringifySearchWith to parse string values using the provided parser before stringification, ensuring symmetric behavior with parseSearchWith

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

  • Verify that parser invocation doesn't introduce unexpected side effects or errors
  • Confirm the parsed value is correctly passed to the stringify function
  • Validate symmetry with parseSearchWith behavior across common use cases

Poem

🐰 A parser and stringify, now best friends at last,
No longer twisted strings from the parsing past,
Symmetry restored, the logic now clear,
Search params flow smoothly—hip hop, hooray cheer! 🎉

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 50.00% which is insufficient. The required threshold is 80.00%. You can run @coderabbitai generate docstrings to improve docstring coverage.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The PR title 'fix: Do not quote numerical search params' aligns with the core issue being addressed in the changeset - preventing unwanted quote wrapping around numerical search parameters. However, the actual code change is more specific: it ensures symmetric parsing/serialization by parsing strings through a provided parser before stringification, which is the root cause fix for the quoting issue.
✨ Finishing touches
  • 📝 Generate docstrings
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (1)
packages/router-core/src/searchParams.ts (1)

74-83: Behavior change looks correct; consider tightening parser typing in this branch

Using const parsed = parser(val); return stringify(parsed) is the right fix: it makes stringifySearchWith actually round‑trip parseable strings (e.g. "123", "true", "null") according to the provided parser/stringify pair, and avoids adding extra quotes for numeric/boolean‑like search params. The silent error handling and overall control flow remain consistent with parseSearchWith, so this should be a safe and targeted behavior change.

One minor follow‑up: since parser is typed as optional, calling it here can trip strict TypeScript checks (Object is possibly 'undefined'). You already guard it via hasParser, but TS doesn’t narrow from that. If you want to keep strict mode fully happy, consider narrowing directly on parser in the condition, e.g.:

} else if (parser && typeof val === 'string') {
  try {
    const parsed = parser(val)
    return stringify(parsed)
  } catch (_err) {
    // silent
  }
}

This preserves runtime behavior while aligning with strict type expectations.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between afb4b24 and 1af0d4b.

📒 Files selected for processing (1)
  • packages/router-core/src/searchParams.ts (1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
**/*.{ts,tsx}

📄 CodeRabbit inference engine (AGENTS.md)

Use TypeScript strict mode with extensive type safety throughout the codebase

Files:

  • packages/router-core/src/searchParams.ts
🧠 Learnings (1)
📓 Common learnings
Learnt from: nlynzaad
Repo: TanStack/router PR: 5182
File: e2e/react-router/basic-file-based/src/routes/non-nested/named/$baz_.bar.tsx:3-5
Timestamp: 2025-09-22T00:56:49.237Z
Learning: In TanStack Router, underscores are intentionally stripped from route segments (e.g., `$baz_` becomes `baz` in generated types) but should be preserved in base path segments. This is the correct behavior as of the fix in PR #5182.

@adbjo adbjo changed the title fix: Do not add quotes to search params fix: Do not quote numerical search params Dec 1, 2025
@nx-cloud
Copy link

nx-cloud bot commented Dec 1, 2025

🤖 Nx Cloud AI Fix Eligible

An automatically generated fix could have helped fix failing tasks for this run, but Self-healing CI is disabled for this workspace. Visit workspace settings to enable it and get automatic fixes in future runs.

To disable these notifications, a workspace admin can disable them in workspace settings.


View your CI Pipeline Execution ↗ for commit 1af0d4b

Command Status Duration Result
nx affected --targets=test:eslint,test:unit,tes... ❌ Failed 11m 9s View ↗
nx run-many --target=build --exclude=examples/*... ✅ Succeeded 1m 20s View ↗

☁️ Nx Cloud last updated this comment at 2025-12-01 19:37:23 UTC

@pkg-pr-new
Copy link

pkg-pr-new bot commented Dec 1, 2025

More templates

@tanstack/arktype-adapter

npm i https://pkg.pr.new/TanStack/router/@tanstack/arktype-adapter@6000

@tanstack/directive-functions-plugin

npm i https://pkg.pr.new/TanStack/router/@tanstack/directive-functions-plugin@6000

@tanstack/eslint-plugin-router

npm i https://pkg.pr.new/TanStack/router/@tanstack/eslint-plugin-router@6000

@tanstack/history

npm i https://pkg.pr.new/TanStack/router/@tanstack/history@6000

@tanstack/nitro-v2-vite-plugin

npm i https://pkg.pr.new/TanStack/router/@tanstack/nitro-v2-vite-plugin@6000

@tanstack/react-router

npm i https://pkg.pr.new/TanStack/router/@tanstack/react-router@6000

@tanstack/react-router-devtools

npm i https://pkg.pr.new/TanStack/router/@tanstack/react-router-devtools@6000

@tanstack/react-router-ssr-query

npm i https://pkg.pr.new/TanStack/router/@tanstack/react-router-ssr-query@6000

@tanstack/react-start

npm i https://pkg.pr.new/TanStack/router/@tanstack/react-start@6000

@tanstack/react-start-client

npm i https://pkg.pr.new/TanStack/router/@tanstack/react-start-client@6000

@tanstack/react-start-server

npm i https://pkg.pr.new/TanStack/router/@tanstack/react-start-server@6000

@tanstack/router-cli

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-cli@6000

@tanstack/router-core

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-core@6000

@tanstack/router-devtools

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-devtools@6000

@tanstack/router-devtools-core

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-devtools-core@6000

@tanstack/router-generator

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-generator@6000

@tanstack/router-plugin

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-plugin@6000

@tanstack/router-ssr-query-core

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-ssr-query-core@6000

@tanstack/router-utils

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-utils@6000

@tanstack/router-vite-plugin

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-vite-plugin@6000

@tanstack/server-functions-plugin

npm i https://pkg.pr.new/TanStack/router/@tanstack/server-functions-plugin@6000

@tanstack/solid-router

npm i https://pkg.pr.new/TanStack/router/@tanstack/solid-router@6000

@tanstack/solid-router-devtools

npm i https://pkg.pr.new/TanStack/router/@tanstack/solid-router-devtools@6000

@tanstack/solid-router-ssr-query

npm i https://pkg.pr.new/TanStack/router/@tanstack/solid-router-ssr-query@6000

@tanstack/solid-start

npm i https://pkg.pr.new/TanStack/router/@tanstack/solid-start@6000

@tanstack/solid-start-client

npm i https://pkg.pr.new/TanStack/router/@tanstack/solid-start-client@6000

@tanstack/solid-start-server

npm i https://pkg.pr.new/TanStack/router/@tanstack/solid-start-server@6000

@tanstack/start-client-core

npm i https://pkg.pr.new/TanStack/router/@tanstack/start-client-core@6000

@tanstack/start-plugin-core

npm i https://pkg.pr.new/TanStack/router/@tanstack/start-plugin-core@6000

@tanstack/start-server-core

npm i https://pkg.pr.new/TanStack/router/@tanstack/start-server-core@6000

@tanstack/start-static-server-functions

npm i https://pkg.pr.new/TanStack/router/@tanstack/start-static-server-functions@6000

@tanstack/start-storage-context

npm i https://pkg.pr.new/TanStack/router/@tanstack/start-storage-context@6000

@tanstack/valibot-adapter

npm i https://pkg.pr.new/TanStack/router/@tanstack/valibot-adapter@6000

@tanstack/virtual-file-routes

npm i https://pkg.pr.new/TanStack/router/@tanstack/virtual-file-routes@6000

@tanstack/zod-adapter

npm i https://pkg.pr.new/TanStack/router/@tanstack/zod-adapter@6000

commit: 1af0d4b

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant