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: use formatDisplayName on UserDashboard #10593

Merged
merged 1 commit into from
Feb 14, 2025

Conversation

areebahmeddd
Copy link
Contributor

@areebahmeddd areebahmeddd commented Feb 13, 2025

Proposed Changes

Ensure consistent autogenerated avatar display by using formatDisplayName for the name prop in UserDashboard.

@ohcnetwork/care-fe-code-reviewers

Summary by CodeRabbit

  • Style
    • Updated the avatar display for a consistent, defined size.
  • New Features
    • Enhanced the user dashboard by formatting display names for improved readability.
  • Bug Fixes
    • Improved error handling during avatar deletion to offer a smoother experience.

@areebahmeddd areebahmeddd requested a review from a team as a code owner February 13, 2025 12:10
Copy link
Contributor

coderabbitai bot commented Feb 13, 2025

Walkthrough

This pull request makes two primary changes. In the UserAvatar.tsx file, the Avatar component now explicitly sets a className of "h-20 w-20" for styling and wraps the mutateAvatarDelete call in a try-catch block to improve error handling. In the UserDashboard.tsx file, the direct usage of user.first_name has been replaced with a call to the formatDisplayName function to format the user's name displayed in the UI.

Changes

File(s) Change Summary
src/components/Users/UserAvatar.tsx Added a className prop ("h-20 w-20") to the Avatar component; wrapped mutateAvatarDelete in a try-catch block to handle errors during avatar deletion.
src/pages/UserDashboard.tsx Imported and used formatDisplayName for formatting the user’s display name instead of directly using user.first_name.

Sequence Diagram(s)

sequenceDiagram
    participant U as User
    participant A as Avatar Component
    participant M as mutateAvatarDelete
    participant O as onError Callback

    U->>A: Request avatar deletion
    A->>M: Invoke mutateAvatarDelete
    alt Error occurs
        M-->>A: Throws error
        A->>O: Call onError callback
    else No error
        M-->>A: Return success
    end
Loading
sequenceDiagram
    participant D as UserDashboard
    participant F as formatDisplayName Utility

    D->>F: Send user object for formatting
    F-->>D: Return formatted display name
Loading

Possibly related PRs

Suggested labels

needs review, tested

Suggested reviewers

  • Jacobjeevan
  • rithviknishad

Poem

I'm a bunny with a hop in my code,
Skipping through changes on a bright, winding road.
With new styles added and errors now caught,
My little paws dance in the success that I sought.
A cheerful nibble of updates so neat,
CodeRabbit hops on with a joyful beat! 🐰✨


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 13, 2025

Deploy Preview for care-ohc ready!

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

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/Users/UserAvatar.tsx (1)

85-91: Enhance error handling in handleAvatarDelete.

The error handling can be improved by logging the error and displaying a user-friendly message.

Apply this diff to enhance error handling:

 const handleAvatarDelete = async (onError: () => void) => {
   try {
     mutateAvatarDelete();
-  } catch {
+  } catch (error) {
+    console.error('Failed to delete avatar:', error);
+    toast.error(t('avatar_delete_error'));
     onError();
   }
 };
src/pages/UserDashboard.tsx (1)

25-29: Consider using formatDisplayName in welcome message for consistency.

While the Avatar component now uses formatDisplayName, the welcome message still uses user.first_name. For consistency in name display across the UI, consider using formatDisplayName in the welcome message as well.

Apply this diff to maintain consistency:

 <h1 className="text-xl md:text-2xl font-bold">
-  Welcome back, {user.first_name}!
+  Welcome back, {formatDisplayName(user).split(' ')[0]}!
 </h1>

Also applies to: 31-33

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 16af629 and d80a5e9.

📒 Files selected for processing (2)
  • src/components/Users/UserAvatar.tsx (1 hunks)
  • src/pages/UserDashboard.tsx (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (5)
  • GitHub Check: Redirect rules - care-ohc
  • GitHub Check: Header rules - care-ohc
  • GitHub Check: Pages changed - care-ohc
  • GitHub Check: cypress-run (1)
  • GitHub Check: OSSAR-Scan
🔇 Additional comments (2)
src/components/Users/UserAvatar.tsx (1)

105-109: LGTM! Consistent avatar display and styling.

The changes ensure consistent avatar display by using formatDisplayName and explicit styling.

src/pages/UserDashboard.tsx (1)

11-11: LGTM! Clean import organization.

The import is correctly placed and necessary for the Avatar component changes.

@areebahmeddd areebahmeddd changed the title fix: ensure UserAvatar and UserDashboard use formatDisplayName for co… fix: ensure UserAvatar and UserDashboard use formatDisplayName Feb 13, 2025
Copy link
Member

@yash-learner yash-learner left a comment

Choose a reason for hiding this comment

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

LGTM


Name your branches in this format issues/:issue_id/short_description, It is common/good practice followed when naming branches.

Example: issues/10375/dept-team-users


Also check the PR description generated by CodeRabbit and edit if there are any discrepancies.

Bug Fixes
Improved error handling during avatar deletion to offer a smoother experience.

I think the above is not valid, is it valid for this PR changes?

@areebahmeddd
Copy link
Contributor Author

areebahmeddd commented Feb 13, 2025

  • Ah yes, I'm aware of the standard open-source practices and will ensure to follow the branch naming convention in future PRs. 💪🏻
  • The suggested error handling doesn’t apply here.

CC: @yash-learner

Copy link
Contributor

Choose a reason for hiding this comment

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

🤔 Why change/commit this? Do a self-review (whether before pushing commit/opening PR or even just starting PR as draft and then marking as ready for review - up to you how you want to approach the workflow).

Copy link
Contributor

Choose a reason for hiding this comment

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

Also update the title 😅 It's a bit misleading when your change is only in UserDashboard.

Copy link
Contributor Author

@areebahmeddd areebahmeddd Feb 13, 2025

Choose a reason for hiding this comment

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

  • Updated UserAvatar to maintain consistency with UserDashboard, placing name first and imageUrl after. 😅
  • Renamed title.

Copy link
Contributor

Choose a reason for hiding this comment

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

  • Updated UserAvatar to maintain consistency with UserDashboard, placing name first and imageUrl after. 😅

🤔 That's not really important? If I'm importing a component in multiple places, I don't need to maintain the same order for props (like name, imageUrl etc).

Copy link
Contributor

Choose a reason for hiding this comment

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

Anyways, I'll approve it, keep in mind for future.

@areebahmeddd areebahmeddd changed the title fix: ensure UserAvatar and UserDashboard use formatDisplayName fix: use formatDisplayName on UserDashboard Feb 13, 2025
@Jacobjeevan Jacobjeevan merged commit 0e09cfe into ohcnetwork:develop Feb 14, 2025
14 of 15 checks passed
Copy link

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

@areebahmeddd areebahmeddd deleted the fix/consistent-name branch February 14, 2025 05:56
@coderabbitai coderabbitai bot mentioned this pull request Feb 19, 2025
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Default avatar is not consistent
3 participants