HCMPRE-218 adding validation for plan config name

[Priyanka-eGov]

Summary by CodeRabbit

• New Features

  • Introduced enhanced name validation mechanisms, including new error codes and messages for scenarios involving empty or failed name validation.
  • Added methods for regex validation of plan configuration names, improving compliance with naming conventions.
  • Incorporated validation logic related to naming conventions within data handling processes.

• Bug Fixes

  • Improved error handling and validation processes to enhance data integrity and robustness.

• Style

  • Updated variable naming conventions for improved readability and consistency in the codebase.

[coderabbitai]

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

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

The recent updates enhance the name validation functionality within the health services plan module. New constants for error handling and regex-based validation methods have been introduced, improving robustness and compliance with naming conventions. These changes streamline the validation process, ensure better error reporting, and enhance the overall integrity of plan configurations.

Changes

Files	Change Summary
health-services/plan-service/src/main/java/digit/config/ServiceConstants.java	Added constants for error codes and messages related to name validation, enhancing error handling.
health-services/plan-service/src/main/java/digit/service/validator/PlanConfigurationValidator.java	Introduced methods for regex validation of plan configuration names, improving validation logic.
health-services/plan-service/src/main/java/digit/util/MdmsUtil.java	Enhanced getPlanModuleDetail method with new MasterDetail for naming regex validation.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant PlanConfigurationValidator
    participant MdmsUtil

    User->>PlanConfigurationValidator: validateCreate(request)
    PlanConfigurationValidator->>MdmsUtil: getPlanModuleDetail()
    MdmsUtil-->>PlanConfigurationValidator: return MasterDetail
    PlanConfigurationValidator->>PlanConfigurationValidator: validatePlanConfigName(request)
    PlanConfigurationValidator-->>User: return validation result

Loading

Poem

🐰 In the garden where names do bloom,
New constants sprout, dispelling gloom.
Regex dances, validation's delight,
Ensuring our plans shine ever so bright!
With each hop, we celebrate the change,
In this land of code, we rearrange! 🌼

---

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>.
  • 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 show all the console.log statements in this repository.
  • @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.

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.

[Priyanka-eGov]

@coderabbitai review

[coderabbitai]

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.

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: .coderabbit.yaml
Review profile: ASSERTIVE

Commits

Files that changed from the base of the PR and between 0e1092f and 4d258fd.

Files selected for processing (3)

• health-services/plan-service/src/main/java/digit/config/ServiceConstants.java (3 hunks)
• health-services/plan-service/src/main/java/digit/service/validator/PlanConfigurationValidator.java (3 hunks)
• health-services/plan-service/src/main/java/digit/util/MdmsUtil.java (1 hunks)

Additional comments not posted (16)

health-services/plan-service/src/main/java/digit/util/MdmsUtil.java (3)

78-78: Good job on renaming the variable to follow Java naming conventions.

The change from UnitDetails to unitDetails improves readability and consistency.

---

79-79: The addition of namingRegexDetails is a valuable enhancement.

Incorporating name validation logic improves the robustness of the data structure.

---

86-87: Including the new MasterDetail objects in the list is a good practice.

This ensures that the new validation logic is part of the returned ModuleDetail.

health-services/plan-service/src/main/java/digit/config/ServiceConstants.java (5)

79-79: Adding NAME_VALIDATION_LIST_EMPTY_CODE improves error handling.

This constant will help in identifying scenarios where the name validation list is empty.

---

80-80: Adding NAME_VALIDATION_LIST_EMPTY_MESSAGE enhances error messaging.

This constant provides a clear and specific error message for empty name validation lists.

---

82-83: Adding NAME_VALIDATION_FAILED_CODE and NAME_VALIDATION_FAILED_MESSAGE is a good practice.

These constants will help in identifying and handling name validation failures.

---

94-94: Adding MDMS_MASTER_NAME_VALIDATION is a valuable enhancement.

This constant represents the regex pattern for name validation, improving code clarity and maintainability.

---

121-121: Adding NAME_VALIDATION_DATA enhances the validation framework.

This constant likely relates to name validation data, contributing to a more robust validation process.

health-services/plan-service/src/main/java/digit/service/validator/PlanConfigurationValidator.java (8)

10-11: Adding imports for Matcher and Pattern is necessary.

These imports are required for the regex validation logic.

---

53-55: Incorporating validatePlanConfigName in validateCreate enhances validation.

This ensures that the plan configuration name is validated during the creation process.

---

57-88: Adding validatePlanConfigName is a valuable enhancement.

This method validates the plan configuration name against a regex pattern retrieved from MDMS data, improving data integrity.

---

90-100: Adding validateStringAgainstRegex improves code modularity.

This static method encapsulates the regex matching logic, promoting code reuse and maintainability.

---

348-349: Incorporating validatePlanConfigName in validateUpdateRequest enhances validation.

This ensures that the plan configuration name is validated during the update process.

---

69-77: Constructing and using JSONPath for name validation is well-implemented.

This segment correctly handles potential errors and throws a CustomException if the JSONPath evaluation fails.

---

79-81: Checking for an empty name validation list is a good practice.

This ensures that the name validation process has the necessary data to proceed.

---

83-86: Validating the plan configuration name against the regex pattern is well-implemented.

This segment correctly handles the validation and throws a CustomException if the name does not match the regex pattern.

[Priyanka-eGov]

Ticket link - https://digit-discuss.atlassian.net/browse/HCMPRE-218?
@kavi-egov