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: Profile Syncing #9994

Merged
merged 2 commits into from
Jan 16, 2025
Merged

Fix: Profile Syncing #9994

merged 2 commits into from
Jan 16, 2025

Conversation

Jeffrin2005
Copy link
Contributor

@Jeffrin2005 Jeffrin2005 commented Jan 15, 2025

Proposed Changes

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

  • Bug Fixes
    • Improved data synchronization for user avatar updates and deletions
    • Ensured immediate cache refresh after profile picture changes
  • New Features
    • Enhanced query management for user data using the latest library integration

@Jeffrin2005 Jeffrin2005 requested a review from a team as a code owner January 15, 2025 13:08
Copy link
Contributor

coderabbitai bot commented Jan 15, 2025

Walkthrough

The pull request modifies the UserAvatar.tsx component to enhance query management using the useQueryClient hook from the @tanstack/react-query library. It replaces the previous method of refetching user data with query invalidation to ensure that the current user's cached data is refreshed after uploading or deleting their profile picture. This change aims to maintain data consistency across the application.

Changes

File Change Summary
src/components/Users/UserAvatar.tsx - Added useQueryClient import
- Initialized queryClient hook
- Updated handleAvatarUpload and handleAvatarDelete to invalidate queries instead of refetching user data
- Modified method signature to remove refetchUserData parameter

Assessment against linked issues

Objective Addressed Explanation
Profile sync in sidebar navigation [#9960]

Possibly related PRs

Suggested labels

tested

Suggested reviewers

  • Jacobjeevan
  • rithviknishad

Poem

🐰 A rabbit's tale of cache and grace,
Where avatars dance with query's embrace,
Invalidate, refresh, make data shine bright,
No stale sidebar shall dim our delight!
Query magic, a technological art 🎩


📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 9a47823 and 9deb319.

📒 Files selected for processing (1)
  • src/components/Users/UserAvatar.tsx (4 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • src/components/Users/UserAvatar.tsx
⏰ Context from checks skipped due to timeout of 90000ms (6)
  • GitHub Check: Redirect rules - care-ohc
  • GitHub Check: Header rules - care-ohc
  • GitHub Check: Pages changed - care-ohc
  • GitHub Check: CodeQL-Build
  • GitHub Check: cypress-run (1)
  • GitHub Check: OSSAR-Scan

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

Deploy Preview for care-ohc ready!

Name Link
🔨 Latest commit 9deb319
🔍 Latest deploy log https://app.netlify.com/sites/care-ohc/deploys/6787f1cbd7ed930008158740
😎 Deploy Preview https://deploy-preview-9994--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/Users/UserAvatar.tsx (2)

63-63: Consider invalidating queries in the error callback.

While the success case is handled well, consider also invalidating queries in the error callback to ensure consistency if the upload partially succeeded but the XHR status wasn't 200.

      },
      null,
-      () => {
+      async () => {
+        await queryClient.invalidateQueries({ queryKey: ["currentUser"] });
         onError();
       },

Line range hint 84-86: Consider invalidating queries in the error case.

Similar to the upload handler, consider invalidating queries in the error case to ensure consistency if the deletion partially succeeded but the response wasn't ok.

    } else {
+     await queryClient.invalidateQueries({ queryKey: ["currentUser"] });
      onError();
    }
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 86d110a and 9a47823.

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

2-2: LGTM! Good addition of React Query for cache management.

The integration of useQueryClient is a good approach for managing cache invalidation.

Also applies to: 34-34


81-82: LGTM! Good sequencing of operations.

The order of operations is correct: invalidate cache first, then show the success message.


63-63: Verify consistent usage of "currentUser" query key.

Let's verify that the "currentUser" query key is consistently used across the codebase and identify any other components that might need similar cache invalidation.

Also applies to: 81-81

✅ Verification successful

"currentUser" query key usage is consistent and correct

The query key is consistently used across the codebase:

  • Defined as ["currentUser", accessToken] for fetching current user data
  • Invalidated as ["currentUser"] after user-related changes and auth state changes
  • No inconsistencies or missing invalidations found
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for other usages of the "currentUser" query key
rg -l "currentUser.*queryKey|queryKey.*currentUser"

# Search for similar avatar-related components that might need cache invalidation
ast-grep --pattern 'profile_picture|avatar'

Length of output: 225


Script:

#!/bin/bash
# Check how currentUser query key is used in each file
echo "=== AddFacilitySheet.tsx ==="
rg "currentUser.*queryKey|queryKey.*currentUser" src/pages/Organization/components/AddFacilitySheet.tsx -B 2 -A 2

echo -e "\n=== UserAvatar.tsx ==="
rg "currentUser.*queryKey|queryKey.*currentUser" src/components/Users/UserAvatar.tsx -B 2 -A 2

echo -e "\n=== AuthUserProvider.tsx ==="
rg "currentUser.*queryKey|queryKey.*currentUser" src/Providers/AuthUserProvider.tsx -B 2 -A 2

Length of output: 1652

@Jeffrin2005
Copy link
Contributor Author

@rithviknishad Any changes required ?

@github-actions github-actions bot added needs-triage question Further information is requested labels Jan 15, 2025
refetchUserData?.();
await queryClient.invalidateQueries({ queryKey: ["currentUser"] });
Copy link
Member

Choose a reason for hiding this comment

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

we can skip awaiting the query invalidation. toast can be shown right after the mutation has upload/delete has completed without waiting for invalidation to complete.

Suggested change
await queryClient.invalidateQueries({ queryKey: ["currentUser"] });
queryClient.invalidateQueries({ queryKey: ["currentUser"] });

@@ -58,6 +60,7 @@ export default function UserAvatar({
if (xhr.status === 200) {
await sleep(1000);
refetchUserData?.();
await queryClient.invalidateQueries({ queryKey: ["currentUser"] });
Copy link
Member

Choose a reason for hiding this comment

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

here too

@@ -58,6 +60,7 @@ export default function UserAvatar({
if (xhr.status === 200) {
await sleep(1000);
refetchUserData?.();
Copy link
Member

Choose a reason for hiding this comment

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

now that we are invalidating the query, do we need to call refetchUserData?
check what the callees are doing with it and see if we can remove this.

@rithviknishad rithviknishad added changes required and removed question Further information is requested needs-triage labels Jan 15, 2025
Copy link
Member

@rithviknishad rithviknishad left a comment

Choose a reason for hiding this comment

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

LGTM

@rithviknishad rithviknishad merged commit 4bd274a into ohcnetwork:develop Jan 16, 2025
18 of 19 checks passed
Copy link

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

Successfully merging this pull request may close these issues.

Profile Not Syncing with Sidebar Navigation
2 participants