Enhance validation error handling with custom exception messages

[medchedli]

Improve validation error handling by introducing custom exception messages that provide clearer feedback on validation failures.

Summary by CodeRabbit

• New Features
  • Improved validation error messages to be more concise and user-friendly by aggregating all validation issues into a single, clear message.

[coderabbitai]

Walkthrough

A custom exceptionFactory function was added to the ValidationPipe configuration in the application bootstrap process. This function aggregates validation error messages into a single, user-friendly string and throws a BadRequestException, replacing the default error handling for validation failures.

Changes

File(s)	Change Summary
api/src/main.ts	Added a custom exceptionFactory to ValidationPipe in the bootstrap function, aggregating validation error messages and throwing a BadRequestException with a combined message.

Sequence Diagram(s)

Loading

sequenceDiagram
    participant Client
    participant App
    participant ValidationPipe
    participant exceptionFactory

    Client->>App: Send request with payload
    App->>ValidationPipe: Validate payload
    ValidationPipe->>exceptionFactory: On validation error, call exceptionFactory(errors)
    exceptionFactory->>ValidationPipe: Return BadRequestException with aggregated message
    ValidationPipe->>App: Throw BadRequestException
    App->>Client: Respond with aggregated error message

Poem

In the warren of code, validation once sprawled,
Now errors are gathered, their messages called.
With one tidy string, exceptions now flow—
Much clearer for users, as rabbits well know!
🐇✨

✨ Finishing Touches

• 📝 Generate Docstrings

---

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.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

api/src/main.ts (1)

74-83: Good implementation that achieves the PR objectives!

The custom exception factory successfully aggregates validation errors into user-friendly messages. The fallback message handling is a nice touch.

Consider these optional enhancements for even better error reporting:

1. Include the invalid value in fallback messages for easier debugging:

-          return `${error.property} has invalid value`;
+          return `${error.property} has invalid value: ${error.value}`;

2. Return structured error responses for better API consumer experience:

-        return new BadRequestException(messages.join(', '));
+        return new BadRequestException({
+          message: 'Validation failed',
+          errors: messages
+        });

The current implementation works well for the stated objectives of providing clearer validation feedback.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 933daaa and 1622d48.

📒 Files selected for processing (1)

• api/src/main.ts (2 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (3)

• GitHub Check: Frontend Tests
• GitHub Check: API-Tests
• GitHub Check: Analyze (javascript-typescript)

🔇 Additional comments (1)

api/src/main.ts (1)

9-9: Import looks good!

The addition of BadRequestException is necessary for the custom exception factory implementation.