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: FacilityData not populating on Edit #10077

Merged

Conversation

AdityaJ2305
Copy link
Contributor

@AdityaJ2305 AdityaJ2305 commented Jan 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

    • Enhanced query management for facility data using React Query's useQueryClient hook.
    • Improved data synchronization mechanism for facility-related operations.
    • Added extra query invalidation for facility updates to ensure data consistency.
  • Bug Fixes

    • Removed unnecessary query invalidation in the facility editing process for simplification.
  • Chores

    • Standardized localization keys for cover image notifications to improve consistency and readability.

@AdityaJ2305 AdityaJ2305 requested a review from a team as a code owner January 21, 2025 05:05
Copy link
Contributor

coderabbitai bot commented Jan 21, 2025

Walkthrough

The pull request introduces changes to query management in the FacilityHome, EditFacilitySheet, and FacilityForm components using React Query's useQueryClient hook. The modifications focus on improving data synchronization by replacing direct refetch methods with query invalidation. In FacilityHome.tsx, the facilityFetch function is replaced with queryClient.invalidateQueries for managing facility data updates. The EditFacilitySheet.tsx simplifies its query invalidation, and FacilityForm.tsx enhances consistency by invalidating additional queries upon successful updates.

Changes

File Change Summary
src/components/Facility/FacilityHome.tsx Introduced useQueryClient hook, replaced facilityFetch with queryClient.invalidateQueries for managing facility data updates.
src/pages/Organization/components/EditFacilitySheet.tsx Removed queryClient usage, simplifying the query invalidation process upon submission.
src/components/Facility/FacilityForm.tsx Added extra query invalidation for ["facility"] in the onSuccess callback of the updateFacility mutation.
public/locale/en.json Updated keys for cover image notifications to remove trailing periods and capitalize values for consistency.

Assessment against linked issues

Objective Addressed Explanation
Facility data auto-update after editing [#10073]

Possibly related PRs

Suggested labels

needs review, changes required

Suggested reviewers

  • Jacobjeevan
  • rithviknishad

Poem

🐰 Queries dance, data flows free,
Invalidation sets the cache to glee,
No more manual refresh in sight,
React Query brings updates so bright!
A rabbit's code, smooth and light! 🌟


📜 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 ea58b97 and 72fa59b.

📒 Files selected for processing (1)
  • public/locale/en.json (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • public/locale/en.json
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: CodeQL-Build
  • GitHub Check: cypress-run (1)

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

Deploy Preview for care-ohc ready!

Name Link
🔨 Latest commit 72fa59b
🔍 Latest deploy log https://app.netlify.com/sites/care-ohc/deploys/678f9bd2de84550008c4506f
😎 Deploy Preview https://deploy-preview-10077--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/Facility/FacilityHome.tsx (2)

99-99: Remove commented-out code.

The commented-out facilityFetch is no longer needed since we're using query invalidation.

-    // refetch: facilityFetch,

138-140: Consider adding error handling for query invalidation.

While the cache invalidation strategy is solid, we should handle potential failures to ensure robust data synchronization.

 queryClient.invalidateQueries({
   queryKey: ["facility", facilityId],
+  onError: (error) => {
+    toast.error(t("error_refreshing_facility_data"));
+    console.error("Failed to invalidate facility query:", error);
+  }
 });
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 46faa4b and 6c94f98.

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

40-40: LGTM! Query key structure simplified for proper cache invalidation.

The simplified query key structure ensures consistent cache invalidation across components and aligns with React Query's best practices.

src/components/Facility/FacilityHome.tsx (1)

138-140: LGTM! Consistent cache invalidation strategy implemented.

The implementation properly invalidates the facility query after image operations, ensuring the UI reflects the latest data.

Also applies to: 160-162

@AdityaJ2305
Copy link
Contributor Author

Hey Team, Don't you think we should show Upload Cover Photo when there is no image present. Just a typo addition. LMK

@github-actions github-actions bot added needs-triage question Further information is requested labels Jan 21, 2025
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 (3)
src/components/Facility/FacilityForm.tsx (3)

Line range hint 171-175: Consider sanitizing the geolocation error message.

The current implementation directly concatenates the error message from the Geolocation API, which could potentially lead to XSS vulnerabilities. Consider using a safe error message handling approach.

- toast.error(t("unable_to_get_location") + error.message);
+ toast.error(t("unable_to_get_location_with_reason", { reason: error.code === 1 ? "PERMISSION_DENIED" : error.code === 2 ? "POSITION_UNAVAILABLE" : "TIMEOUT" }));

122-130: Consider refining the form reset behavior for updates.

Currently, the form is reset after both create and update operations. For updates, this might not be the desired behavior as users might want to make additional edits.

   onSuccess: (_data: FacilityModel) => {
     toast.success(t("facility_updated_successfully"));
     queryClient.invalidateQueries({
       queryKey: ["organizationFacilities"],
     });
     queryClient.invalidateQueries({
       queryKey: ["facility"],
     });
-    form.reset();
     onSubmitSuccess?.();
   },

Line range hint 367-382: Enhance accessibility for the geolocation button's loading state.

While the button properly shows a loading state visually, its accessibility for screen readers could be improved by adding appropriate ARIA attributes.

 <Button
   type="button"
   variant="outline"
   size="sm"
   onClick={handleGetCurrentLocation}
   disabled={isGettingLocation}
+  aria-busy={isGettingLocation}
   className="flex items-center gap-2"
   data-cy="get-location-button"
 >
   {isGettingLocation ? (
     <>
-      <CareIcon icon="l-spinner" className="h-4 w-4 animate-spin" />
+      <CareIcon icon="l-spinner" className="h-4 w-4 animate-spin" aria-hidden="true" />
       {t("getting_location")}
     </>
   ) : (
     <>
-      <CareIcon icon="l-location-point" className="h-4 w-4" />
+      <CareIcon icon="l-location-point" className="h-4 w-4" aria-hidden="true" />
       {t("get_current_location")}
     </>
   )}
 </Button>
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 728499f and 9c2a03c.

📒 Files selected for processing (2)
  • src/components/Facility/FacilityForm.tsx (1 hunks)
  • src/pages/Organization/components/EditFacilitySheet.tsx (0 hunks)
💤 Files with no reviewable changes (1)
  • src/pages/Organization/components/EditFacilitySheet.tsx
🔇 Additional comments (1)
src/components/Facility/FacilityForm.tsx (1)

122-127: LGTM! The additional query invalidation ensures data consistency.

The addition of ["facility"] query invalidation complements the existing ["organizationFacilities"] invalidation, ensuring that both the facility list and individual facility data are refreshed after updates. This change effectively addresses the issue of FacilityData not populating correctly during edit operations.

Comment on lines -678 to +679
"cover_image_deleted.": "Cover image deleted.",
"cover_image_updated.": "Cover image updated.",
"cover_image_deleted": "Cover Image Deleted",
"cover_image_updated": "Cover Image Updated",
Copy link
Member

Choose a reason for hiding this comment

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

nice find, how did this even end up here 🤣

@rithviknishad rithviknishad merged commit 49d40c4 into ohcnetwork:develop Jan 22, 2025
19 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
needs-triage question Further information is requested
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Facility data not updating automatically after editing
3 participants