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: Handle null gender values in user profiles #10614

Merged

Conversation

AdityaJ2305
Copy link
Contributor

@AdityaJ2305 AdityaJ2305 commented Feb 14, 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 the user form's handling of the gender field in edit mode. Now, when no gender value is provided, the field is explicitly cleared, ensuring a more reliable and predictable experience when updating user profiles.

@AdityaJ2305 AdityaJ2305 requested a review from a team as a code owner February 14, 2025 20:19
Copy link
Contributor

coderabbitai bot commented Feb 14, 2025

Walkthrough

The changes update the UserForm.tsx component to explicitly assign the gender field as userData.gender || undefined during the form reset in edit mode. This ensures that if userData.gender is falsy, the field is set to undefined instead of potentially uninitialized.

Changes

File Change Summary
src/.../UserForm.tsx Modified the form reset logic in the useEffect hook to assign formData.gender as `userData.gender

Sequence Diagram(s)

sequenceDiagram
    participant UF as UserForm
    participant UE as useEffect
    UF->>UE: Trigger form reset for edit mode
    UE->>UF: Set formData.gender = userData.gender || undefined
Loading

Possibly related PRs

Suggested labels

needs review, needs testing

Suggested reviewers

  • rithviknishad

Poem

I'm a little rabbit hopping through the code,
Where gender fields now clearly showed.
A tweak in logic smooth and neat,
Ensures our data's sound and complete.
Hop along, let accuracy unload! 🐇✨


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 Feb 14, 2025

Deploy Preview for care-ohc ready!

Name Link
🔨 Latest commit aed576f
🔍 Latest deploy log https://app.netlify.com/sites/care-ohc/deploys/67afa546d9780b0008908410
😎 Deploy Preview https://deploy-preview-10614.preview.ohc.network
📱 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.

@AdityaJ2305
Copy link
Contributor Author

Screenshot 2025-02-15 at 1 45 05 AM

The issue was caused by the backend returning null for the gender value in some user profiles. This needed to be handled properly.

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 (1)
src/components/Users/UserForm.tsx (1)

94-94: Consider making gender optional in edit mode.

Currently, gender is required in both create and edit modes. Since we're handling null gender values, consider making it optional in edit mode similar to other fields.

-gender: z.enum(GENDERS, { required_error: t("gender_is_required") }),
+gender: isEditMode
+  ? z.enum(GENDERS).optional()
+  : z.enum(GENDERS, { required_error: t("gender_is_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 d14283b and aed576f.

📒 Files selected for processing (1)
  • src/components/Users/UserForm.tsx (1 hunks)
🧰 Additional context used
🧠 Learnings (1)
src/components/Users/UserForm.tsx (1)
Learnt from: rajku-dev
PR: ohcnetwork/care_fe#9887
File: src/components/Users/CreateUserForm.tsx:93-93
Timestamp: 2025-01-14T09:22:13.878Z
Learning: The suggestion to use GENDER_TYPES.map(g => g.id) for gender enum validation in CreateUserForm.tsx was incorrect and caused an error.
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Test
🔇 Additional comments (2)
src/components/Users/UserForm.tsx (2)

148-148: LGTM! The change improves null gender value handling.

The change ensures that falsy gender values are explicitly set to undefined during form reset, which aligns with the form's validation schema.


36-37:

✅ Verification successful

Verify the difference between GENDER_TYPES and GENDERS.

The code imports both GENDER_TYPES (used in UI) and GENDERS (used in validation). This could lead to inconsistencies if they're not synchronized.


🏁 Script executed:

#!/bin/bash
# Search for the definitions of GENDER_TYPES and GENDERS
echo "Searching for GENDER_TYPES definition:"
rg "GENDER_TYPES.*=" -A 5
echo -e "\nSearching for GENDERS definition:"
rg "GENDERS.*=" -A 5

Length of output: 3148


Clarification on the Synchronized Use of Gender Constants

The investigation confirms that GENDER_TYPES in src/common/constants.tsx is the detailed source (providing id, text, and icon for each gender) and that GENDERS is directly derived as GENDER_TYPES.map((gender) => gender.id). This design ensures the two remain synchronized by default. However, please be mindful that any modifications to GENDER_TYPES (such as adding, removing, or updating gender objects) will automatically affect GENDERS used in validation.

  • File: src/common/constants.tsx

    • GENDER_TYPES: Array containing full gender details.
    • GENDERS: Derived array of gender IDs for validation.
  • Usage Example in src/components/Users/UserForm.tsx:

    import { GENDER_TYPES } from "@/common/constants";
    import { GENDERS } from "@/common/constants";

To maintain clarity and reduce future confusion, consider adding inline documentation that explicitly states the dependency between these constants.

@Jacobjeevan Jacobjeevan added the reviewed reviewed by a core member label Feb 15, 2025
@Jacobjeevan Jacobjeevan merged commit 21ecdf5 into ohcnetwork:develop Feb 15, 2025
12 of 15 checks passed
Copy link

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

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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Gender field validation error when not selected in Edit User modal
2 participants