Skip to content

fix(react-router): Pass SearchParamError#cause in validateSearch #3155

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 4 commits into from
Jan 25, 2025
Merged

fix(react-router): Pass SearchParamError#cause in validateSearch #3155

merged 4 commits into from
Jan 25, 2025

Conversation

KubaJastrz
Copy link
Contributor

@KubaJastrz KubaJastrz commented Jan 13, 2025 •
edited
Loading

What

Ensure that SearchParamError#cause contains the original parsing error thrown/returned by the validateSearch implementation configured by the user. Notable example: passing valibot schema directly without an adapter.

validateSearch: object({ ... }) // when this failed, it did not contain the proper `cause` field on the error

Why

It's useful to know what happened, because the error can be accessed with Route.errorComponent or Route.onError. Also for consistency with other implementations of validateSearch.

How

  1. Add missing cause to the SearchParamError thrown by validateSearch
  2. Do not wrap instances of SearchParamError in another SearchParamError
  3. Add tests for ~standard, validator fn, validator obj

@schiller-manuel
Copy link
Contributor

can you add a test please?

@KubaJastrz
Copy link
Contributor Author

Thanks for the suggestion. Adding the test for ~standard parsing revealed another problem that would prevent my initial change from working. Apparently the SearchParamError thrown by validateSearch were wrapped in another SearchParamError, messing with the cause field.

@nx-cloud Nx Cloud
Copy link

nx-cloud bot commented Jan 14, 2025 •
edited
Loading

View your CI Pipeline Execution ↗ for commit 3beb0d0.

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

☁️ Nx Cloud last updated this comment at 2025-01-14 19:01:46 UTC

@pkg-pr-new pkg.pr.new
Copy link

pkg-pr-new bot commented Jan 14, 2025 •
edited
Loading

Open in Stackblitz

More templates

@tanstack/arktype-adapter

npm i https://pkg.pr.new/@tanstack/arktype-adapter@3155

@tanstack/eslint-plugin-router

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

@tanstack/create-router

npm i https://pkg.pr.new/@tanstack/create-router@3155

@tanstack/history

npm i https://pkg.pr.new/@tanstack/history@3155

@tanstack/react-cross-context

npm i https://pkg.pr.new/@tanstack/react-cross-context@3155

@tanstack/create-start

npm i https://pkg.pr.new/@tanstack/create-start@3155

@tanstack/react-router

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

@tanstack/react-router-with-query

npm i https://pkg.pr.new/@tanstack/react-router-with-query@3155

@tanstack/router-cli

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

@tanstack/router-devtools

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

@tanstack/router-generator

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

@tanstack/router-plugin

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

@tanstack/router-vite-plugin

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

@tanstack/start

npm i https://pkg.pr.new/@tanstack/start@3155

@tanstack/start-vite-plugin

npm i https://pkg.pr.new/@tanstack/start-vite-plugin@3155

@tanstack/valibot-adapter

npm i https://pkg.pr.new/@tanstack/valibot-adapter@3155

@tanstack/virtual-file-routes

npm i https://pkg.pr.new/@tanstack/virtual-file-routes@3155

@tanstack/zod-adapter

npm i https://pkg.pr.new/@tanstack/zod-adapter@3155

commit: 3beb0d0

@schiller-manuel schiller-manuel changed the title Pass SearchParamError#cause in validateSearch fix(react-router): Pass SearchParamError#cause in validateSearch Jan 25, 2025
@schiller-manuel schiller-manuel merged commit ad0e9de into TanStack:main Jan 25, 2025
5 checks passed
@KubaJastrz KubaJastrz deleted the validate-search-cause branch January 25, 2025 12:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@KubaJastrz @schiller-manuel