feat: customizable validation errors by sandros94 · Pull Request #1146 · h3js/h3

sandros94 · 2025-07-05T12:24:13Z

resolves #982

I've added an additional argument to each readValidatedBody, getValidatedQuery and getValidatedRouteParams which can be either an error object or a function that returns one. If a standard-schema is being used, then the issues array is available as an argument for the function variant.

This allows for the following custom error, which will ouput a markdown list of all the errors recorded:

import * as v from "valibot";

app.post("/", async (event) => {
  const body = await readValidatedBody(
    event,
    v.object({
      name: v.pipe(v.string(), v.minLength(3), v.maxLength(20)),
      age: v.pipe(v.number(), v.integer(), v.minValue(1)),
    }),
    {
      onError: ({ issues }) => ({
        statusText: "Custom validation error",
        message: v.summarize(issues),
      }),
    },
  );
});

I've also updated the defineValidatedHandler, which brings three more properties: bodyErrors, headersErrors and queryErrors. All allowing for either error object or function that returns one

Added two types, but I'm not super satisfied with ValidateIssues naming (I'm open for suggestions):

export type ValidateIssues = ReadonlyArray<Issue>;
export type ValidateError =
  | (() => ErrorDetails)
  | ((result: FailureResult) => ErrorDetails);

I've also made sure that if a new HTTPError is thrown during validation, its content will be directly passed as is, quite useful for non-standard-schema validations.

sandros94 · 2025-07-05T12:24:52Z

Oh, is it normal that we have a decode option for route params but not for queries? 🤔

codecov · 2025-07-05T12:24:57Z

Codecov Report

❌ Patch coverage is 93.33333% with 2 lines in your changes missing coverage. Please review.

Files with missing lines	Patch %	Lines
src/utils/internal/validate.ts	91.66%	2 Missing ⚠️

📢 Thoughts on this report? Let us know!

cloudflare-workers-and-pages · 2025-07-06T10:34:27Z

Deploying h3dev with Cloudflare Pages

Latest commit:	`9f96225`
Status:	✅ Deploy successful!
Preview URL:	https://69c3837d.h3dev.pages.dev
Branch Preview URL:	https://feat-custom-validation-error.h3dev.pages.dev

View logs

sandros94 · 2025-10-29T16:44:22Z

@pi0 any update on this?

pi0 · 2025-10-29T17:13:22Z

Hi dear @sandros94. It is in my todo list, in meantime do you have time to help on fixing merge conflicts and adressing #1146 (comment) 🙏🏼

sandros94 · 2025-10-29T19:41:30Z

Hi dear @sandros94. It is in my todo list, in meantime do you have time to help on fixing merge conflicts and adressing #1146 (comment) 🙏🏼

Yes absolutely! And sorry, I completely forgot about that review 😅

sandros94 · 2025-10-31T01:25:39Z

I'm terribly sorry, I didn't realize that in 1e4d720 I did not update the docs 🙈

For now I would leave it as only { issues }, to better follow the standard-schema spec FailureResult and leave room for future expansion.

Let me know if there is anything else I should take care of

pi0 · 2025-11-01T09:40:31Z

@sandros94 updated implementation to be more compact API. Love your opinion on latest changes.

sandros94 · 2025-11-01T16:32:40Z

@sandros94 updated implementation to be more compact API. Love your opinion on latest changes.

Thank you, and yes it required a bit of cleanup

coderabbitai · 2025-12-30T14:02:28Z

Warning

Rate limit exceeded

@pi0 has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 11 minutes and 33 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between d6b5f2a and f85c8cf.

📒 Files selected for processing (7)

docs/2.utils/1.request.md
src/handler.ts
src/utils/body.ts
src/utils/internal/validate.ts
src/utils/request.ts
test/handler.test.ts
test/validate.test.ts

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.}

feat: customizable validation errors

55eab38

sandros94 self-assigned this Jul 5, 2025

sandros94 requested a review from pi0 as a code owner July 5, 2025 12:24

sandros94 added the enhancement New feature or request label Jul 5, 2025

pi0 reviewed Jul 6, 2025

View reviewed changes

Comment thread src/handler.ts Outdated

pi0 reviewed Jul 6, 2025

View reviewed changes

Comment thread src/utils/body.ts Outdated

fix(validation): remove error object format and move it to options

dc7fd8a

sandros94 added 4 commits July 6, 2025 12:40

fix(defineValidatedHandler): group errors in single key

ec3aab8

fix(defineValidatedHandler): unify validation errors

03ecef4

Merge branch 'main' into feat/custom-validation-errors

fdfe83a

refactor(defineValidatedHandler): use new validate` object

f2480cb

pi0 reviewed Jul 6, 2025

View reviewed changes

Comment thread docs/2.utils/1.request.md Outdated

sandros94 added 6 commits July 6, 2025 16:27

fix(validation): pass whole result to error

1e4d720

Merge branch 'main' into feat/custom-validation-errors

6828111

test(handler): update custom error tests

1740670

Merge branch 'main' into feat/custom-validation-errors

c5e524c

Merge branch 'main' into feat/custom-validation-errors

ac145f4

Merge branch 'main' into feat/custom-validation-errors

9f96225

sandros94 added 2 commits October 31, 2025 02:14

Merge branch 'main' into feat/custom-validation-errors

408046e

doc(validation): dix onError example

0494c5c

pi0 added 3 commits November 1, 2025 10:10

small improvements

162e601

simplify

dec55a9

update

be8a089

update

5330abb

lint

2ca1f17

Merge branch 'main' into feat/custom-validation-errors

f85c8cf

pi0 approved these changes Dec 30, 2025

View reviewed changes

pi0 merged commit 1ec9c94 into main Dec 30, 2025
5 of 6 checks passed

pi0 deleted the feat/custom-validation-errors branch December 30, 2025 14:04

sandros94 mentioned this pull request Jul 5, 2026

RFC: evolving defineValidatedHandler / defineRoute into a richer validated-routing core and types #1437

Open

1 task

Uh oh!

Conversation

sandros94 commented Jul 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

sandros94 commented Jul 5, 2025

Uh oh!

codecov Bot commented Jul 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Uh oh!

cloudflare-workers-and-pages Bot commented Jul 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Deploying h3dev with Cloudflare Pages

Uh oh!

Uh oh!

sandros94 commented Oct 29, 2025

Uh oh!

pi0 commented Oct 29, 2025

Uh oh!

sandros94 commented Oct 29, 2025

Uh oh!

sandros94 commented Oct 31, 2025

Uh oh!

pi0 commented Nov 1, 2025

Uh oh!

sandros94 commented Nov 1, 2025

Uh oh!

coderabbitai Bot commented Dec 30, 2025

Rate limit exceeded

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

sandros94 commented Jul 5, 2025 •

edited

Loading

codecov Bot commented Jul 5, 2025 •

edited

Loading

cloudflare-workers-and-pages Bot commented Jul 6, 2025 •

edited

Loading