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

Daily Rounds External Id in Notification Handler #2641

Merged

Conversation

Jacobjeevan
Copy link
Contributor

@Jacobjeevan Jacobjeevan commented Dec 9, 2024

Proposed Changes

  • Notifications currently stores daily round's id instead of external Id
    • used in notifications for consultation creation/updates
    • however FE is expecting the external Id to access the Log update page (consultation/consultation:id/log_updates/log:id/)

Associated Issue

Merge Checklist

  • Tests added/fixed
  • Update docs in /docs
  • Linting Complete
  • Any other necessary step

Only PR's with test cases included and passing lint and test pipelines will be reviewed

@ohcnetwork/care-backend-maintainers @ohcnetwork/care-backend-admins

Summary by CodeRabbit

  • New Features

    • Updated notifications to reference DailyRound objects by their external IDs instead of internal IDs.
  • Bug Fixes

    • Improved handling of Notification instances to ensure accurate updates of daily_round references.

@Jacobjeevan Jacobjeevan requested a review from a team as a code owner December 9, 2024 04:14
Copy link

coderabbitai bot commented Dec 9, 2024

📝 Walkthrough

Walkthrough

The changes involve a migration script that updates the caused_objects field of Notification instances in the facility app by replacing internal daily_round IDs with their corresponding external IDs. Additionally, a minor modification in the NotificationGenerator class alters how the daily_round attribute is assigned within the generate_cause_objects method, switching from using the internal ID to the external identifier. These adjustments ensure that notifications reference external identifiers, maintaining consistency across the application.

Changes

File Path Change Summary
care/facility/migrations/0468_notifications_dailyround_external_id.py Added update_daily_rounds function and Migration class to update caused_objects with external_id.
care/utils/notification_handler.py Modified generate_cause_objects method in NotificationGenerator to use external_id instead of internal ID for daily_round.

Poem

In the realm of notifications bright,
External IDs now take flight.
Daily rounds, once lost in the haze,
Now shine with clarity, deserving praise.
A migration here, a change so small,
Yet it echoes through the code, after all! ✨


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

@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

🧹 Outside diff range and nitpick comments (2)
care/facility/migrations/0468_notifications_dailyround_external_id.py (2)

10-10: Consider batching the notification updates

While the migration works, querying all notifications at once might not be the most efficient approach for large datasets.

Consider using batch processing:

-    for notification in Notification.objects.all():
+    batch_size = 1000
+    for notification in Notification.objects.iterator(chunk_size=batch_size):

12-19: Add error logging for missing DailyRounds

The migration silently skips notifications with missing DailyRounds. While this is safe, it might be helpful to log these cases for monitoring.

             except DailyRound.DoesNotExist:
-                # Handle the case where the DailyRound does not exist
-                pass
+                logger.warning(
+                    f"DailyRound {daily_round_id} not found for notification {notification.id}"
+                )
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 9a20757 and 74b397b.

📒 Files selected for processing (2)
  • care/facility/migrations/0468_notifications_dailyround_external_id.py (1 hunks)
  • care/utils/notification_handler.py (1 hunks)
🧰 Additional context used
🪛 Ruff (0.8.0)
care/facility/migrations/0468_notifications_dailyround_external_id.py

24-24: Single quotes found but double quotes preferred

Replace single quotes with double quotes

(Q000)


24-24: Single quotes found but double quotes preferred

Replace single quotes with double quotes

(Q000)

🔇 Additional comments (2)
care/utils/notification_handler.py (2)

290-290: LGTM! The change aligns perfectly with the PR objectives

The modification to use external_id instead of id for daily rounds is consistent with how other objects are handled in the notification system. This change will properly support the front-end's expectation for the consultation log update page.


289-293: Verify the external_id usage in front-end routes

Just to be thorough, let's verify that the front-end correctly uses this external_id in the route pattern consultation/consultation:id/log_updates/log:id/.

Copy link

codecov bot commented Dec 9, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 69.63%. Comparing base (7d3d958) to head (a7f5a64).
Report is 23 commits behind head on develop.

Additional details and impacted files
@@           Coverage Diff            @@
##           develop    #2641   +/-   ##
========================================
  Coverage    69.63%   69.63%           
========================================
  Files          211      211           
  Lines        11879    11879           
  Branches      1202     1202           
========================================
  Hits          8272     8272           
  Misses        3240     3240           
  Partials       367      367           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@vigneshhari
Copy link
Member

We dont need to back fill any data, you can delete the migration. Notifications are anyways deleted periodically.

@sainak sainak requested a review from rithviknishad December 18, 2024 08:31
@vigneshhari vigneshhari merged commit fbf76d7 into ohcnetwork:develop Dec 20, 2024
5 checks passed
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.

4 participants