feat: Error tree

[RobinTail]

https://zod.dev/error-formatting#ztreeifyerror

This should make it easer to display errors in UI form by default.

Summary by CodeRabbit

• New Features
  • Error responses for several endpoints now include an optional structured error tree, providing more detailed validation error information.
• Documentation
  • Updated API documentation to describe the new structured error tree in error responses.
• Tests
  • Switched input validation error response tests to use snapshot testing for improved maintainability.

[coveralls-official[bot]]

coverage: 100.0%. remained the same when pulling 9cbe493e33e36d15f97c7a6669e413436db5075c on feat-error-tree into 34f14887e66bfc43fa5f83ae8b7698d59ec5dee5 on master.

[coderabbitai[bot]]

[!IMPORTANT]

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

A recursive error tree type and its schema were introduced and integrated into error response types and OpenAPI schemas for several API endpoints. The result handler now includes a structured tree property in error responses for input validation errors. Related tests were updated to use snapshot assertions for error responses.

Changes

File(s)	Change Summary
example/example.client.ts	Added recursive error detail type Type2 and optional tree property to multiple negative response types.
example/example.documentation.yaml	Updated OpenAPI error response schemas to include a tree property referencing new recursive schema Schema2.
express-zod-api/src/result-helpers.ts	Added exported recursive Zod schema errorTreeSchema for structured error tree representation.
express-zod-api/src/result-handler.ts	Extended error response schema and handler to include optional tree property for input validation errors.
express-zod-api/tests/endpoint.spec.ts	Switched error response assertions from explicit values to snapshot testing for input validation failures.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant API
    participant Validator
    participant ResultHandler

    Client->>API: Send request with input
    API->>Validator: Validate input
    Validator-->>API: Return validation error (if any)
    API->>ResultHandler: Handle error
    alt InputValidationError
        ResultHandler->>Validator: z.treeifyError(error.cause)
        ResultHandler-->>Client: Respond with error object (includes tree)
    else Other error
        ResultHandler-->>Client: Respond with error object (tree undefined)
    end

Poem

In the warren of code, a new tree has grown,
With branches of errors, now clearly shown.
Snapshots will capture each twist and each root,
While rabbits in docs find the details quite cute.
Recursive and neat, our errors now gleam—
Structured and clear, a developer’s dream!
🐇🌳

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[RobinTail]

@coderabbitai review

[coderabbitai[bot]]

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

[RobinTail]

should not overload the default RH