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

fix: Resolve creation of patient name despite having numeric values #9152

Merged
merged 3 commits into from
Nov 20, 2024

Conversation

Tanuj1718
Copy link
Contributor

@Tanuj1718 Tanuj1718 commented Nov 18, 2024

Proposed Changes

Patient.mp4

@ohcnetwork/care-fe-code-reviewers

Merge Checklist

  • Add specs that demonstrate bug / test a new feature.
  • Update product documentation.
  • Ensure that UI text is kept in I18n files.
  • Prep screenshot or demo video for changelog entry, and attach it to issue.
  • Request for Peer Reviews
  • Completion of QA

Summary by CodeRabbit

  • New Features

    • Enhanced form validation for patient registration, including a new validation check for the patient's name.
    • Added a new field for the patient's name in the registration form.
  • Bug Fixes

    • Improved error messaging for invalid name entries.
  • Improvements

    • Ensured consistent formatting of names before submission, enhancing data integrity.

@Tanuj1718 Tanuj1718 requested a review from a team as a code owner November 18, 2024 12:22
Copy link
Contributor

coderabbitai bot commented Nov 18, 2024

Walkthrough

The changes in the PatientRegister.tsx component focus on enhancing the validation logic for patient names within the form handling process. A new validation function, validateName, has been introduced to ensure that names do not contain numeric values. The form initialization now includes a name field, and the validation logic has been updated accordingly. Additionally, the submission handling has been adjusted to format the name correctly before processing.

Changes

File Change Summary
src/components/Patient/PatientRegister.tsx Integrated validateName for name validation, updated form initialization to include a name field, modified validateForm for new validation, and adjusted handleSubmit for name formatting.

Assessment against linked issues

Objective Addressed Explanation
Prevent creation of patients with numeric values in name (#9143)

Poem

🐇 In the garden where names bloom bright,
A rabbit hops with pure delight.
With validations strong and true,
No numbers in names, just skies so blue!
So patients' names, all neat and fair,
Are crafted with love, beyond compare! 🌼


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 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 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

netlify bot commented Nov 18, 2024

Deploy Preview for care-ohc ready!

Name Link
🔨 Latest commit 7ba4669
🔍 Latest deploy log https://app.netlify.com/sites/care-ohc/deploys/673bbd5b2c060c00087fa615
😎 Deploy Preview https://deploy-preview-9152--care-ohc.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)
src/components/Patient/PatientRegister.tsx (1)

Line range hint 1023-1029: Consider enhancing the name field UX.

While the validation is working correctly, consider these improvements for better user experience:

  1. Add a placeholder to guide users about the expected format
  2. Add a pattern attribute to prevent special characters at input time
 <TextFormField
   required
   {...field("name")}
   type="text"
   label={"Name"}
+  placeholder="Enter patient's name (letters only)"
+  pattern="[A-Za-z\s]+"
 />
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between c4f54a8 and 1d03d53.

📒 Files selected for processing (1)
  • src/components/Patient/PatientRegister.tsx (2 hunks)
🔇 Additional comments (3)
src/components/Patient/PatientRegister.tsx (3)

70-70: LGTM: Import changes are correct.

The validateName import is properly added and follows the project's import conventions.


424-427: LGTM: Name validation is properly implemented.

The validation logic:

  • Is correctly placed in the form validation switch statement
  • Returns an appropriate error message
  • Integrates well with the existing form validation system

70-70: Verify: Changes successfully address the PR objective.

The implementation effectively prevents the creation of patient names with numeric values through:

  1. Addition of name validation
  2. Clear error messaging
  3. Integration with form validation

This matches the requirements from issue #9143.

Also applies to: 424-427

✅ Verification successful

Changes successfully prevent numeric values in patient names

The implementation effectively addresses the PR objective through:

  1. The validateName function uses the regex pattern /^([a-zA-Z]*( [a-zA-Z])?)+$/ which only allows alphabetic characters and spaces
  2. The validation is properly integrated into the form validation logic
  3. The function is imported and used in the patient registration form
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the validateName function implementation

# Check the validation function implementation
echo "Checking validation function..."
ast-grep --pattern 'export function validateName($_) {
  $$$
}'

# Check for any other direct numeric validation in the codebase
echo "Checking for other numeric validation patterns..."
rg 'function.*validateName|name.*validation|numeric.*validation' --type ts

Length of output: 324


Script:

#!/bin/bash
# Let's try a different approach to locate the validation implementation

# Search for validateName in common/validation files
echo "Searching for validateName in validation files..."
fd "validation" --type f --exec cat {}

# Search for name validation usage in PatientRegister
echo "Checking PatientRegister implementation..."
fd "PatientRegister" --type f --exec cat {}

# Look for validation-related imports
echo "Checking validation imports..."
rg "import.*validation" --type ts

Length of output: 68341

@shivankacker
Copy link
Member

@Tanuj1718 have we also accounted for characters like underscores, dots and commas ?

@Tanuj1718
Copy link
Contributor Author

Tanuj1718 commented Nov 19, 2024

@Tanuj1718 have we also accounted for characters like underscores, dots and commas ?

Yes we have checked. We only allow alphabetic characters and spaces in Name.

@github-actions github-actions bot added needs-triage question Further information is requested labels Nov 19, 2024
@nihal467
Copy link
Member

LGTM

@nihal467 nihal467 added tested reviewed reviewed by a core member and removed question Further information is requested needs testing needs-triage labels Nov 19, 2024
@khavinshankar khavinshankar merged commit ff63195 into ohcnetwork:develop Nov 20, 2024
19 of 20 checks passed
Copy link

@Tanuj1718 Your efforts have helped advance digital healthcare and TeleICU systems. 🚀 Thank you for taking the time out to make CARE better. We hope you continue to innovate and contribute; your impact is immense! 🙌

@rithviknishad
Copy link
Member

@Tanuj1718 #9177 would be reverting this PR due to reason mentioned in #9143 (comment)

@Tanuj1718
Copy link
Contributor Author

Tanuj1718 commented Nov 22, 2024

@Tanuj1718 #9177 would be reverting this PR due to reason mentioned in #9143 (comment)

Okay @rithviknishad , it's always interesting to know about the new things.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
reviewed reviewed by a core member tested
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Patient created despite having numeric values in name
5 participants