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: Prevent negative number input in the form fields of "Add Triage" #9433

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from

Conversation

SathishAdithiyaaSV
Copy link

@SathishAdithiyaaSV SathishAdithiyaaSV commented Dec 14, 2024

Proposed Changes

  • Fixes Negative Numbers in Triage Form #9429
  • Prevent entry of negative numbers in the form fields of "Add Triage"
  • Add validation to ensure only whole numbers are entered for specific fields.
  • Earlier the error shows up only after clicking "Save Triage" but now it is denied in the textbox itself

@ohcnetwork/care-fe-code-reviewers
Screencast from 2024-12-15 01-27-09.webm

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 validation in the TriageForm to accept only numeric values for specific fields, improving data integrity.
  • Bug Fixes

    • Resolved issues related to non-numeric input being processed incorrectly for form fields.

@SathishAdithiyaaSV SathishAdithiyaaSV requested a review from a team as a code owner December 14, 2024 20:02
Copy link
Contributor

coderabbitai bot commented Dec 14, 2024

Walkthrough

The pull request introduces a validation enhancement in the TriageForm component's handleFormFieldChange function. The modification adds a condition to ensure only non-negative numeric values are accepted for form fields, with an exception for the entry_date field. This change prevents non-numeric and negative input from being processed, making the form input validation more robust and aligned with the expected user input requirements.

Changes

File Change Summary
src/components/Facility/TriageForm.tsx Added input validation to prevent non-numeric and negative values in form fields

Assessment against linked issues

Objective Addressed Explanation
Prevent Negative Numbers [#9429]
Ensure Numeric Input Validation

Possibly related PRs

Suggested labels

needs review, tested

Suggested reviewers

  • khavinshankar
  • rithviknishad

Poem

🐰 Validation's dance, a numeric delight,
No negatives shall slip through my sight!
Zeros and positives, clean and bright,
Form fields now guarded with rabbit's might!
Input pristine, errors take flight! 🚫🔢

Tip

CodeRabbit's docstrings feature is now available as part of our Early Access Program! Simply use the command @coderabbitai generate docstrings to have CodeRabbit automatically generate docstrings for your pull request. This feature will be included in our Pro Plan when released.


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

Copy link

netlify bot commented Dec 14, 2024

Deploy Preview for care-ohc ready!

Name Link
🔨 Latest commit d0b0be1
🔍 Latest deploy log https://app.netlify.com/sites/care-ohc/deploys/675de447f2f22a0008e9913f
😎 Deploy Preview https://deploy-preview-9433--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: 2

🧹 Outside diff range and nitpick comments (2)
src/components/Facility/TriageForm.tsx (2)

Line range hint 52-90: Consider consolidating validation logic

The form currently has validation in both handleFormFieldChange and validateForm. Consider extracting common validation logic into a shared utility function to maintain consistency and avoid duplication.

const validateNumericField = (value: string, fieldName: string): string | null => {
  if (value === "") return null;
  if (!/^\d*$/.test(value)) return "Only non-negative whole numbers are allowed";
  if (Number(value) < 0) return "Value must be greater than or equal to 0";
  return null;
};
🧰 Tools
🪛 eslint

[error] 192-193: Delete ⏎····

(prettier/prettier)


Line range hint 280-332: Add aria-label attributes for better accessibility

The numeric input fields should have appropriate aria-labels to improve accessibility for screen readers.

 <TextFormField
   name="num_patients_visited"
   type="number"
+  aria-label="Number of patients visited in triage"
   label="Patients Visited in Triage"
   value={state.form.num_patients_visited}
   onChange={handleFormFieldChange}
   error={state.errors.num_patients_visited}
 />
🧰 Tools
🪛 eslint

[error] 192-193: Delete ⏎····

(prettier/prettier)

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between f82dfa8 and d0b0be1.

📒 Files selected for processing (1)
  • src/components/Facility/TriageForm.tsx (1 hunks)
🧰 Additional context used
🪛 eslint
src/components/Facility/TriageForm.tsx

[error] 192-193: Delete ⏎····

(prettier/prettier)

Comment on lines +192 to +195

if (!/^\d*$/.test(event.value as string) && event.name !== "entry_date")
return;

Copy link
Contributor

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Consider enhancing the input validation feedback

While the regex validation successfully prevents negative numbers, it silently fails without informing users why their input was rejected. Consider adding immediate visual feedback.

 const handleFormFieldChange = (event: FieldChangeEvent<unknown>) => {
-    
-    if (!/^\d*$/.test(event.value as string) && event.name !== "entry_date")
-      return;
+    if (event.name !== "entry_date") {
+      if (!/^\d*$/.test(event.value as string)) {
+        dispatch({
+          type: "set_error",
+          errors: {
+            ...state.errors,
+            [event.name]: "Only non-negative whole numbers are allowed"
+          }
+        });
+        return;
+      }
+      // Clear error when valid input is entered
+      dispatch({
+        type: "set_error",
+        errors: {
+          ...state.errors,
+          [event.name]: ""
+        }
+      });
+    }
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
if (!/^\d*$/.test(event.value as string) && event.name !== "entry_date")
return;
if (event.name !== "entry_date") {
if (!/^\d*$/.test(event.value as string)) {
dispatch({
type: "set_error",
errors: {
...state.errors,
[event.name]: "Only non-negative whole numbers are allowed"
}
});
return;
}
// Clear error when valid input is entered
dispatch({
type: "set_error",
errors: {
...state.errors,
[event.name]: ""
}
});
}
🧰 Tools
🪛 eslint

[error] 192-193: Delete ⏎····

(prettier/prettier)


💡 Codebase verification

Numeric validation is incomplete for form fields

The current validation /^\d*$/ is applied conditionally to all fields except "entry_date", but the form contains multiple numeric fields that should be explicitly validated:

  • num_patients_visited
  • num_patients_home_quarantine
  • num_patients_isolation
  • num_patient_referred
  • num_patient_confirmed_positive

The current implementation might allow invalid input in these numeric fields since the validation is tied to the event handler rather than being specific to numeric fields.

🔗 Analysis chain

Verify the validation coverage

Let's ensure the validation is properly applied to all numeric fields in the form.


Let me gather more information about the form fields to better understand the validation context.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Find all numeric input fields in the component
ast-grep --pattern 'TextFormField
  name="num_$_"
  type="number"'

# Check for any other numeric validation patterns
rg "test\(.*value.*\)" --type ts

Length of output: 420


Script:

#!/bin/bash
# Find all form fields in TriageForm.tsx
ast-grep --pattern 'TextFormField {
  $$$
}'  src/components/Facility/TriageForm.tsx

# Also check for any field type definitions or interfaces
ast-grep --pattern 'interface $_ {
  $$$
}' src/components/Facility/TriageForm.tsx

# Look for form field declarations
rg "name=" src/components/Facility/TriageForm.tsx

Length of output: 518

🧰 Tools
🪛 eslint

[error] 192-193: Delete ⏎····

(prettier/prettier)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Negative Numbers in Triage Form
1 participant