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

Fixing Valueset editor refetching bug #10741

Merged
merged 2 commits into from
Feb 21, 2025
Merged

Conversation

hrit2773
Copy link
Contributor

@hrit2773 hrit2773 commented Feb 21, 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

  • New Features
    • The Value Set editor now automatically refreshes and displays the most current data following any updates, ensuring you always see the latest information without relying on outdated data.

@hrit2773 hrit2773 requested a review from a team as a code owner February 21, 2025 09:06
Copy link
Contributor

coderabbitai bot commented Feb 21, 2025

Walkthrough

The ValueSetEditor component now imports the useQueryClient hook from the @tanstack/react-query library. After a successful update mutation, the component calls queryClient.removeQueries({ queryKey: ["valueset", slug] }); to invalidate the cache for the modified valueset, ensuring that subsequent queries fetch fresh data.

Changes

File Path Change Summary
src/components/ValueSet/ValueSetEditor.tsx Added useQueryClient import and integrated cache invalidation post-update mutation to remove stale data

Sequence Diagram(s)

sequenceDiagram
    participant V as ValueSetEditor
    participant Q as QueryClient
    participant S as Server

    V->>S: Trigger update mutation
    S-->>V: Mutation success
    V->>Q: Invalidate cache (remove queries ["valueset", slug])
Loading

Suggested labels

good to merge, reviewed

Suggested reviewers

  • rithviknishad
  • Jacobjeevan

Poem

In my warren of code, I hop with glee,
Clearing caches like carrots from a tree,
Bugs scurry off, no longer around,
Fresh data now leaps to be found,
Happy bunny code, wild and free!
🐰🌟

✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

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

Deploy Preview for care-ohc ready!

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

@hrit2773
Copy link
Contributor Author

@Jacobjeevan @rithviknishad The cause for this bug was that after updating a valueset the cache was not cleared. To address this root cause I added removeQueries so that on update mutation the cache gets cleared. Its only after updating that the valueset gets refetched.

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/ValueSet/ValueSetEditor.tsx (1)

50-54: Consider optimizing the update success flow.

While the cache invalidation is correctly implemented, the current order of operations might not be optimal for UX. The cache is invalidated after showing the success toast but before navigation, which means we're cleaning up data that won't be immediately used due to the navigation.

Consider this order for better UX:

    onSuccess: () => {
      toast.success("ValueSet updated successfully");
-     queryClient.removeQueries({ queryKey: ["valueset", slug] });
      navigate(`/admin/valuesets`);
+     queryClient.removeQueries({ queryKey: ["valueset", slug] });
    },
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between d58936d and 132ec1a.

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

1-1: LGTM! Clean import addition.

The useQueryClient hook is appropriately imported alongside related React Query hooks.


26-26: LGTM! Proper query client initialization.

The queryClient is correctly initialized at the component's top level using the useQueryClient hook.


26-54: Great implementation of the refetching fix!

The changes effectively address the ValueSet editor refetching bug by properly managing the cache invalidation after updates. The implementation follows React Query best practices and ensures data consistency.

@rithviknishad rithviknishad added reviewed reviewed by a core member and removed needs review labels Feb 21, 2025
@nihal467
Copy link
Member

LGTM

@Jacobjeevan Jacobjeevan merged commit 52923a4 into ohcnetwork:develop Feb 21, 2025
17 checks passed
Copy link

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

Successfully merging this pull request may close these issues.

Valueset data is not always getting refetched in valueset edit page
4 participants