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

Fixes TokenSlots of schedule not getting deleted #2783

Merged

Conversation

rithviknishad
Copy link
Member

@rithviknishad rithviknishad commented Jan 27, 2025

Proposed Changes

  • Fixes TokenSlots of schedule not getting deleted

Associated Issue

Merge Checklist

  • Tests added/fixed
  • Linting Complete

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

Summary by CodeRabbit

  • Bug Fixes

    • Improved schedule deletion logic to handle availability and slot resources more robustly.
  • Tests

    • Updated test cases for schedule management to use existing schedule resources and validate deletion process.
    • Added assertions to verify associated resources are correctly handled during schedule deletion.

@rithviknishad rithviknishad requested a review from a team as a code owner January 27, 2025 11:28
Copy link
Contributor

coderabbitai bot commented Jan 27, 2025

📝 Walkthrough

Walkthrough

The pull request focuses on modifications to the ScheduleViewSet and its corresponding test suite. The primary changes involve refactoring the perform_destroy method to improve code clarity and potentially optimize database queries. The test file has been updated to use a pre-existing schedule for testing, streamlining the test cases and adding assertions to verify the deletion process.

Changes

File Change Summary
care/emr/api/viewsets/scheduling/schedule.py Refactored perform_destroy method to explicitly create availability_ids list
care/emr/tests/test_schedule_api.py Simplified test methods by using self.schedule and added deletion verification assertions

Assessment against linked issues

Objective Addressed Explanation
Prevent deleted schedules from appearing in booking slots [#10207]

Possibly related PRs

Suggested reviewers

  • vigneshhari

Poem

Schedules dance, then fade away,
Bits and bytes in code's ballet,
Deletion's art, precise and clean,
No phantom slots shall intervene! 🗓️✨

✨ 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
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)
care/emr/api/viewsets/scheduling/schedule.py (2)

63-63: Consider removing unnecessary list conversion.

The conversion to list using list(availabilities.values_list("id")) is redundant and could impact performance for large datasets. The values_list already returns a queryset that can be used directly in the filter.

-            availability_ids = list(availabilities.values_list("id"))
+            availability_ids = availabilities.values_list("id", flat=True)

75-78: Consider combining filter and update into a single query.

The current implementation uses two separate database calls. This could be optimized into a single update query.

-            slots = TokenSlot.objects.filter(
-                resource=instance.resource, availability_id__in=availability_ids
-            )
-            slots.update(deleted=True)
+            TokenSlot.objects.filter(
+                resource=instance.resource, availability_id__in=availability_ids
+            ).update(deleted=True)
care/emr/tests/test_schedule_api.py (1)

254-263: Consider adding tests for partial deletion failures.

While the current test coverage is good, it would be beneficial to add tests that verify the transaction rollback behavior when part of the deletion process fails (e.g., if slot deletion fails, the availability should not be marked as deleted).

Here's a suggested test case:

def test_delete_schedule_rolls_back_on_partial_failure(self):
    """Test that the transaction rolls back if any part of the deletion fails."""
    permissions = [
        UserSchedulePermissions.can_write_user_schedule.name,
        UserSchedulePermissions.can_list_user_schedule.name,
    ]
    role = self.create_role_with_permissions(permissions)
    self.attach_role_facility_organization_user(self.organization, self.user, role)

    # Mock TokenSlot.objects.filter to raise an exception
    with patch('care.emr.models.TokenSlot.objects.filter') as mock_filter:
        mock_filter.side_effect = Exception("Simulated failure")
        
        delete_url = self._get_schedule_url(self.schedule.external_id)
        response = self.client.delete(delete_url)
        
        self.assertEqual(response.status_code, status.HTTP_500_INTERNAL_SERVER_ERROR)
        
        # Verify nothing was deleted due to transaction rollback
        self.availability.refresh_from_db()
        self.assertFalse(self.availability.deleted)
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 6add747 and 96603ca.

📒 Files selected for processing (2)
  • care/emr/api/viewsets/scheduling/schedule.py (2 hunks)
  • care/emr/tests/test_schedule_api.py (4 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: test / test
  • GitHub Check: Analyze (python)
🔇 Additional comments (2)
care/emr/tests/test_schedule_api.py (2)

258-262: LGTM! Nice addition of deletion verification.

The test now properly verifies that both availability and slots are marked as deleted. The refresh_from_db calls ensure we're checking the latest state.


218-219: LGTM! Good refactor to reduce test complexity.

Using the existing schedule fixture instead of creating new ones makes the tests more maintainable and efficient.

Also applies to: 237-238

Copy link

codecov bot commented Jan 27, 2025

Codecov Report

Attention: Patch coverage is 0% with 3 lines in your changes missing coverage. Please review.

Project coverage is 56.68%. Comparing base (6add747) to head (96603ca).
Report is 2 commits behind head on develop.

Files with missing lines Patch % Lines
care/emr/api/viewsets/scheduling/schedule.py 0.00% 3 Missing ⚠️
Additional details and impacted files
@@             Coverage Diff             @@
##           develop    #2783      +/-   ##
===========================================
- Coverage    56.69%   56.68%   -0.02%     
===========================================
  Files          208      208              
  Lines         9569     9571       +2     
  Branches       942      942              
===========================================
  Hits          5425     5425              
- Misses        4128     4130       +2     
  Partials        16       16              

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

@vigneshhari vigneshhari merged commit 0b64be7 into develop Jan 27, 2025
6 of 8 checks passed
@vigneshhari vigneshhari deleted the rithviknishad/fix/schedule-delete-not-deleting-tokens branch January 27, 2025 15:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Deleted schedules displayed while booking appointments
2 participants