Skip to content
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.

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

chore: Updated validator messages #1133

Merged
merged 1 commit into from
Sep 16, 2024
Merged

Conversation

Fargekritt
Copy link
Contributor

@Fargekritt Fargekritt commented Sep 16, 2024

Description

Improved validator messages to give error messages with null + when checks.

Related Issue(s)

#1126

Verification

  • Your code builds clean without any errors or warnings
  • Manual testing done (required)
  • Relevant automated test added (if you find this hard, leave it and we'll help out)

Documentation

  • Documentation is updated (either in docs-directory, Altinnpedia or a separate linked PR in altinn-studio-docs., if applicable)

Summary by CodeRabbit

  • New Features

    • Enhanced validation for the Process property to ensure well-formed URIs and enforce maximum length constraints.
    • Improved clarity of validation messages for the TransmissionId property based on ActivityType.
  • Bug Fixes

    • Updated validation logic for TransmissionId to provide clearer error messages.
  • Refactor

    • Streamlined URI validation by consolidating logic into a dedicated method.

@Fargekritt Fargekritt requested a review from a team as a code owner September 16, 2024 08:16
Copy link
Contributor

coderabbitai bot commented Sep 16, 2024

Walkthrough

The changes involve updates to validation rules across multiple classes in the application. The Process property validation has been streamlined using the IsValidUri() method, and maximum length constraints have been added. Additionally, error messages for the TransmissionId property in the NotificationConditionValidator have been clarified based on the ActivityType. These modifications aim to enhance the overall validation logic and improve clarity in user feedback.

Changes

File Change Summary
src/Digdir.Domain.Dialogporten.Application/Features/V1/EndUser/Dialogs/Queries/Search/... Updated Process property validation to use IsValidUri() and added maximum length constraint.
src/Digdir.Domain.Dialogporten.Application/Features/V1/ServiceOwner/DialogActivities/Q... Clarified validation messages for TransmissionId based on ActivityType conditions.
src/Digdir.Domain.Dialogporten.Application/Features/V1/ServiceOwner/Dialogs/Commands/... Updated validation for Process and PrecedingProcess properties to use IsValidUri() and added length constraints.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Validator
    participant URIValidator
    
    User->>Validator: Submit Dialog with Process
    Validator->>URIValidator: Validate Process URI
    URIValidator-->>Validator: Return Valid/Invalid
    Validator-->>User: Return Validation Result
Loading

🐇 In the code, I hop with glee,
New validations set us free!
URIs are checked with care,
Length constraints are now laid bare.
Clear messages guide the way,
Happy users, hip-hip-hooray! 🥕


Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between ca39923 and b53ad95.

Files selected for processing (3)
  • src/Digdir.Domain.Dialogporten.Application/Features/V1/EndUser/Dialogs/Queries/Search/SearchDialogQueryValidator.cs (2 hunks)
  • src/Digdir.Domain.Dialogporten.Application/Features/V1/ServiceOwner/DialogActivities/Queries/NotificationCondition/NotificationConditionValidator.cs (1 hunks)
  • src/Digdir.Domain.Dialogporten.Application/Features/V1/ServiceOwner/Dialogs/Commands/Create/CreateDialogCommandValidator.cs (2 hunks)
Additional comments not posted (7)
src/Digdir.Domain.Dialogporten.Application/Features/V1/ServiceOwner/DialogActivities/Queries/NotificationCondition/NotificationConditionValidator.cs (2)

24-25: LGTM!

The updated error message provides a clear and descriptive explanation of the validation rule. The inclusion of the property names and specific ActivityType value enhances clarity and helps users understand the condition under which TransmissionId must not be null.

The use of string interpolation and the nameof operator improves readability and maintainability of the code.


30-30: LGTM!

Similar to the previous validation rule, the updated error message provides a clear and descriptive explanation of the condition under which TransmissionId must be null. The inclusion of the property names and specific ActivityType value enhances clarity and helps users understand the validation logic.

The use of string interpolation and the nameof operator improves readability and maintainability of the code.

src/Digdir.Domain.Dialogporten.Application/Features/V1/EndUser/Dialogs/Queries/Search/SearchDialogQueryValidator.cs (3)

5-5: LGTM!

The using statement is correctly added to import the required namespace.


49-49: LGTM!

The IsValidUri() method is a cleaner approach for validating the Process property. It improves readability and maintainability by encapsulating the validation logic.


50-50: LGTM!

The maximum length constraint is a valuable addition to validate the Process property. It ensures data integrity by enforcing a predefined URI length limit.

src/Digdir.Domain.Dialogporten.Application/Features/V1/ServiceOwner/Dialogs/Commands/Create/CreateDialogCommandValidator.cs (2)

147-148: Consistent URI validation and length constraint. Looks good!

The changes to the PrecedingProcess property validation rules are consistent with the changes made to the Process property. The URI validation logic is streamlined using the IsValidUri() method, and a maximum length constraint is enforced. This improves the overall validation logic and maintainability of the code.

The verification script suggested for the Process property changes also applies to the PrecedingProcess property changes.


137-138: Streamlined URI validation and added length constraint. LGTM!

The changes consolidate the URI validation logic into the IsValidUri() method and enforce a maximum length constraint. This improves the validation logic and maintainability of the code.

Verify that the IsValidUri() method correctly validates URIs and the Constants.DefaultMaxUriLength aligns with the business requirements by running the following script:


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
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 generate interesting stats about this repository and render them as a table.
    -- @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 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.

Copy link

@Fargekritt Fargekritt merged commit 760da9e into main Sep 16, 2024
22 checks passed
@Fargekritt Fargekritt deleted the feature/improveValidatorMessage branch September 16, 2024 09:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

2 participants