Evaluate custom validation rules first

[chiragchhatrala]

Summary by CodeRabbit

• New Features

  • Enhanced validation logic for form fields with user-defined custom rules.

• Bug Fixes

  • Activated previously commented-out custom validation logic for form fields.

• Tests

  • Added a new test case to validate custom conditions before required field validation, ensuring proper error handling for specific domain requirements.

[coderabbitai]

Walkthrough

The pull request introduces enhanced validation capabilities in the AnswerFormRequest class by activating custom validation logic. A new validation step allows for user-defined custom validation rules to be applied to form fields based on their properties. Simultaneously, a corresponding test case has been added to AnswerFormTest.php to verify the custom validation behavior, specifically testing a scenario where an email field must contain a specific domain.

Changes

File	Change Summary
api/app/Http/Requests/AnswerFormRequest.php	Activated custom validation rule logic for form fields with properties not starting with 'nf-'
api/tests/Feature/Forms/AnswerFormTest.php	Added new test case to validate custom validation execution before required field validation

Sequence Diagram

sequenceDiagram
    participant User
    participant FormRequest
    participant CustomValidation
    participant RequiredValidation

    User->>FormRequest: Submit form data
    FormRequest->>CustomValidation: Check custom rules
    alt Custom validation passes
        CustomValidation-->>RequiredValidation: Proceed to required field validation
        RequiredValidation->>User: Validate required fields
    else Custom validation fails
        CustomValidation->>User: Return validation error
    end

Loading

Possibly related PRs

• Conditioned field validation #418: Modifications to the rules method of the AnswerFormRequest class to include custom validation rules

Suggested reviewers

• JhumanJ

Poem

🐰 Validation's dance, a rabbit's delight,
Custom rules now shine so bright!
From 'nf-' to email's domain,
Our form's logic breaks the chain
Of mundane validation's might! 🎉

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ 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.
  • Generate unit testing code for this file.
  • 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 generate unit testing code for this file.
  • @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 generate unit testing code.
  • @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.

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. (Beta)
• @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/app/Http/Requests/AnswerFormRequest.php (1)

68-72: Ensure robust handling of custom validation properties
While this logic neatly integrates the custom validation rule, consider validating the structure of $property['validation'] before invoking CustomFieldValidationRule. For instance, unexpected data types or missing array keys might lead to runtime errors.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between d18c4cc and cc836e4.

📒 Files selected for processing (2)

• api/app/Http/Requests/AnswerFormRequest.php (1 hunks)
• api/tests/Feature/Forms/AnswerFormTest.php (1 hunks)

🔇 Additional comments (1)

api/tests/Feature/Forms/AnswerFormTest.php (1)

308-353: Kudos on adding a focused test for custom validation
This test is clearly named and verifies that custom validation runs before required checks. You may also consider edge cases (e.g., uppercase domains or empty values) to gain more confidence in the feature’s robustness.