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

Added required field validation and scroll before submit for questionnaire forms #10169

Merged

Conversation

Jacobjeevan
Copy link
Contributor

@Jacobjeevan Jacobjeevan commented Jan 25, 2025

Proposed Changes

@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

  • Bug Fixes
    • Improved handling of empty numeric input values in questionnaire responses
    • Enhanced error validation and submission process for questionnaire forms
    • Added more robust error checking for required questions during form submission

@Jacobjeevan Jacobjeevan requested a review from a team as a code owner January 25, 2025 08:24
Copy link
Contributor

coderabbitai bot commented Jan 25, 2025

Walkthrough

The pull request introduces changes to two components: NumberQuestion.tsx and QuestionnaireForm.tsx. In NumberQuestion.tsx, a new approach is implemented to handle empty input values by setting them to undefined. The QuestionnaireForm.tsx modifications enhance error handling and validation during questionnaire submission, focusing on identifying and highlighting mandatory fields that are not filled out.

Changes

File Change Summary
src/components/Questionnaire/QuestionTypes/NumberQuestion.tsx Added emptyValue check to handle empty numeric inputs, setting undefined for empty values
src/components/Questionnaire/QuestionnaireForm.tsx Improved submission error handling by:
- Clearing existing errors
- Validating required questions
- Capturing first error for scrolling
- Halting submission if errors exist

Assessment against linked issues

Objective Addressed Explanation
Highlight Unfilled Mandatory Fields [#9981]

Possibly related PRs

Suggested labels

needs testing, needs review

Suggested reviewers

  • nihal467
  • rithviknishad

Poem

🐰 In the realm of forms, where questions dance,
Validation springs with a rabbit's glance
Empty fields now whisper clear
No more confusion, no more fear
A questionnaire's journey, smooth and bright! 🌟


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 Jan 25, 2025

Deploy Preview for care-ohc ready!

Name Link
🔨 Latest commit 80ee709
🔍 Latest deploy log https://app.netlify.com/sites/care-ohc/deploys/67949fc30759490008b13472
😎 Deploy Preview https://deploy-preview-10169--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

🧹 Nitpick comments (2)
src/components/Questionnaire/QuestionTypes/NumberQuestion.tsx (1)

Line range hint 20-29: Add input validation for numeric parsing and bounds.

Consider adding validation to handle:

  1. Invalid numeric inputs that could cause parsing errors
  2. Min/max bounds if applicable to the questionnaire context
 const handleChange = (value: string) => {
   const emptyValue = value === "";
+  if (emptyValue) {
+    updateQuestionnaireResponseCB({
+      ...questionnaireResponse,
+      values: [{ type: "number", value: undefined }],
+    });
+    return;
+  }
+
+  // Validate numeric input
+  const numStr = value.trim();
+  if (!/^-?\d*\.?\d*$/.test(numStr)) {
+    return; // Invalid numeric input
+  }
+
   const numericValue =
     question.type === "decimal" ? parseFloat(value) : parseInt(value);
+
+  // Optional: Add bounds validation if min/max are provided
+  if (question.min !== undefined && numericValue < question.min) return;
+  if (question.max !== undefined && numericValue > question.max) return;

   updateQuestionnaireResponseCB({
     ...questionnaireResponse,
     values: [
       {
         type: "number",
-        value: emptyValue ? undefined : numericValue,
+        value: numericValue,
       },
     ],
   });
 };
src/components/Questionnaire/QuestionnaireForm.tsx (1)

229-233: Consider using a translation key specific to field type.

The current implementation uses a generic "field_required" message. Consider using field-type-specific messages for better user experience.

 errors.push({
   question_id: q.id,
   error: t("field_required"),
   type: "validation_error",
-  msg: t("field_required"),
+  msg: t(`${q.type}_field_required`),
 });
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 0c06afc and 80ee709.

📒 Files selected for processing (2)
  • src/components/Questionnaire/QuestionTypes/NumberQuestion.tsx (2 hunks)
  • src/components/Questionnaire/QuestionnaireForm.tsx (3 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: cypress-run (1)
🔇 Additional comments (4)
src/components/Questionnaire/QuestionTypes/NumberQuestion.tsx (1)

Line range hint 20-29: LGTM! Improved empty value handling.

The change correctly handles empty values by setting them to undefined instead of attempting numeric conversion.

src/components/Questionnaire/QuestionnaireForm.tsx (3)

165-167: LGTM! Added null safety check.

Good defensive programming practice to handle cases where result.data.errors might be undefined.


203-256: LGTM! Comprehensive validation implementation.

Well-structured implementation that:

  1. Clears existing errors
  2. Validates all required fields
  3. Implements smooth scroll to the first error

263-263: LGTM! Using validated forms for submission.

Correctly uses the validated forms state for submission processing.

Also applies to: 281-281

@rithviknishad rithviknishad merged commit 30e057d into ohcnetwork:develop Jan 25, 2025
23 checks passed
Copy link

@Jacobjeevan 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! 🙌

@Jacobjeevan Jacobjeevan mentioned this pull request Jan 25, 2025
6 tasks
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.

Unfilled Mandatory Fields Not Highlighted During Questionnaire Submission in Encounter
2 participants