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

Delete TokenSlots when availability is deleted #2786

Conversation

rithviknishad
Copy link
Member

@rithviknishad rithviknishad commented Jan 28, 2025

Proposed Changes

  • Delete TokenSlots when availability is deleted

Associated Issue

Architecture changes

  • Remove this section if not used

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

    • Enhanced data integrity for availability deletions by automatically marking associated token slots as deleted.
  • Tests

    • Improved test suite for availability viewset with new helper methods for creating availability and slot instances.
    • Refactored test cases to use consistent setup and reduce code duplication.

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
@rithviknishad rithviknishad requested a review from a team as a code owner January 28, 2025 11:39
Copy link
Contributor

coderabbitai bot commented Jan 28, 2025

📝 Walkthrough

Walkthrough

The pull request introduces modifications to the AvailabilityViewSet in the scheduling module and its corresponding test suite. The primary change involves updating the perform_destroy method to mark associated TokenSlot objects as deleted when an availability is destroyed. The test file has been refactored to improve test setup and reduce code duplication, adding helper methods for creating availability and slot instances.

Changes

File Change Summary
care/emr/api/viewsets/scheduling/schedule.py Added line to update TokenSlot objects when availability is deleted
care/emr/tests/test_schedule_api.py Added create_availability and create_slot helper methods, refactored test setup

Assessment against linked issues

Objective Addressed Explanation
Hide deleted appointment sessions Partial implementation - only marks TokenSlot as deleted, full visibility control not confirmed

Possibly related PRs

Suggested reviewers

  • vigneshhari

Poem

Slots of time, now marked and gone,
Availability fades like the dawn
🕰️ Delete, update, move along
Data's dance, a gentle song
Scheduling's rhythm, forever strong! 🗓️

✨ 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 (1)

183-183: LGTM! Though we could make the error handling a bit more... robust.

The implementation correctly marks TokenSlots as deleted when their associated availability is destroyed. The placement within the Lock context and after the future bookings check is well thought out.

Consider wrapping the update in a try-except block to handle potential database errors:

-            TokenSlot.objects.filter(availability_id=instance.id).update(deleted=True)
+            try:
+                TokenSlot.objects.filter(availability_id=instance.id).update(deleted=True)
+            except Exception as e:
+                raise ValidationError(f"Failed to delete associated token slots: {str(e)}")
care/emr/tests/test_schedule_api.py (2)

746-755: Good test coverage for the new TokenSlot deletion feature.

The test properly verifies both the availability and slot deletion states.

Consider adding a verification that no hard deletion occurred:

         self.assertTrue(self.availability.deleted)
         self.assertTrue(self.slot.deleted)
+        self.assertTrue(TokenSlot.objects.filter(id=self.slot.id).exists())

Line range hint 762-794: The test cases look comprehensive, but...

The test coverage for error cases is good, particularly for future bookings. However, it might be worth adding a test for the database error scenario if you implement the suggested try-except block.

Would you like me to generate a test case for handling database errors in the TokenSlot deletion process?

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 0b64be7 and 357dfb8.

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

632-633: Nice refactoring of the test setup!

The addition of helper methods improves code reusability and test maintainability.

Also applies to: 690-700

Copy link

codecov bot commented Jan 28, 2025

Codecov Report

Attention: Patch coverage is 0% with 1 line in your changes missing coverage. Please review.

Project coverage is 56.67%. Comparing base (0b64be7) to head (357dfb8).
Report is 2 commits behind head on develop.

Files with missing lines Patch % Lines
care/emr/api/viewsets/scheduling/schedule.py 0.00% 1 Missing ⚠️
Additional details and impacted files
@@             Coverage Diff             @@
##           develop    #2786      +/-   ##
===========================================
- Coverage    56.68%   56.67%   -0.01%     
===========================================
  Files          208      208              
  Lines         9571     9572       +1     
  Branches       942      942              
===========================================
  Hits          5425     5425              
- Misses        4130     4131       +1     
  Partials        16       16              

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

@vigneshhari vigneshhari merged commit b0a5d9c into develop Jan 28, 2025
6 of 8 checks passed
@vigneshhari vigneshhari deleted the rithviknishad/fix/delete-token-slot-when-availability-is-deleted branch January 28, 2025 14:07
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 Session are still visible in the appointments booking session
2 participants