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 delete method in viewsets #2723

Merged
merged 1 commit into from
Jan 9, 2025
Merged

Conversation

sainak
Copy link
Member

@sainak sainak commented Jan 9, 2025

Proposed Changes

  • Fix delete method in viewsets

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

  • Refactor

    • Renamed various authorize_delete methods to authorize_destroy across multiple viewsets
    • Updated method and mixin names related to deletion operations to maintain consistent naming conventions
  • Technical Note

    • No functional changes to the underlying logic or authorization checks
    • Purely a terminology and naming standardization effort

@sainak sainak requested a review from a team as a code owner January 9, 2025 13:36
Copy link

coderabbitai bot commented Jan 9, 2025

📝 Walkthrough

Walkthrough

The pull request introduces a systematic renaming of deletion-related methods across multiple viewsets in the EMR API. The primary change involves replacing "delete" with "destroy" in method and mixin names, such as authorize_deleteauthorize_destroy and EMRDeleteMixinEMRDestroyMixin. This refactoring maintains the existing functionality while standardizing the terminology used throughout the codebase, affecting various viewsets including facility, organization, patient, and scheduling-related components.

Changes

File Changes
care/emr/api/viewsets/base.py Renamed EMRDeleteMixin to EMRDestroyMixin, updated method names from delete/authorize_delete/perform_delete to destroy/authorize_destroy/perform_destroy
care/emr/api/viewsets/*/ Renamed authorize_delete to authorize_destroy in multiple viewsets (encounter, facility, organization, patient, etc.)
care/emr/api/viewsets/scheduling/schedule.py Updated both perform_delete and authorize_delete methods to their "destroy" counterparts

Poem

Farewell, old "delete", your time has passed,
"Destroy" now reigns, semantic and vast! 🗑️
Refactoring dance, a code ballet so fine,
Renaming methods, line by elegant line 💻
A nomenclature shift, precise and bright ✨

Finishing Touches

  • 📝 Generate Docstrings

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

@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)
care/emr/api/viewsets/base.py (1)

177-188: LGTM! Consider adding docstrings.

The rename from EMRDeleteMixin to EMRDestroyMixin aligns perfectly with Django's conventions. Though, it might be nice to add some docstrings explaining the purpose of each method, you know, for those who come after us.

 class EMRDestroyMixin:
+    """Mixin class for handling object destruction in EMR viewsets.
+
+    This mixin provides standard destroy functionality following Django conventions.
+    """
+
     def authorize_destroy(self, instance):
+        """Authorize the destruction of an instance. Override this method to implement custom authorization."""
         pass

     def perform_destroy(self, instance):
+        """Perform soft deletion by setting deleted flag."""
         instance.deleted = True
         instance.save(update_fields=["deleted"])

     def destroy(self, request, *args, **kwargs):
+        """Handle the destruction of an instance with proper authorization."""
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 8b753ad and bd6c251.

📒 Files selected for processing (11)
  • care/emr/api/viewsets/base.py (2 hunks)
  • care/emr/api/viewsets/encounter_authz_base.py (1 hunks)
  • care/emr/api/viewsets/facility.py (1 hunks)
  • care/emr/api/viewsets/facility_organization.py (2 hunks)
  • care/emr/api/viewsets/organization.py (2 hunks)
  • care/emr/api/viewsets/patient.py (1 hunks)
  • care/emr/api/viewsets/questionnaire.py (1 hunks)
  • care/emr/api/viewsets/resource_request.py (2 hunks)
  • care/emr/api/viewsets/scheduling/availability_exceptions.py (1 hunks)
  • care/emr/api/viewsets/scheduling/schedule.py (6 hunks)
  • care/emr/api/viewsets/user.py (1 hunks)
✅ Files skipped from review due to trivial changes (7)
  • care/emr/api/viewsets/patient.py
  • care/emr/api/viewsets/encounter_authz_base.py
  • care/emr/api/viewsets/facility.py
  • care/emr/api/viewsets/organization.py
  • care/emr/api/viewsets/user.py
  • care/emr/api/viewsets/facility_organization.py
  • care/emr/api/viewsets/scheduling/schedule.py
🔇 Additional comments (5)
care/emr/api/viewsets/base.py (1)

274-274: LGTM! Consistent inheritance update.

The update to use EMRDestroyMixin maintains consistency with the renamed mixin.

care/emr/api/viewsets/scheduling/availability_exceptions.py (1)

38-39: LGTM! Method rename maintains consistency.

The rename from authorize_delete to authorize_destroy aligns with the base class changes while preserving the existing authorization logic.

care/emr/api/viewsets/resource_request.py (1)

77-77: LGTM! Mixin update maintains consistency.

The update to use EMRDestroyMixin aligns with the base class changes.

care/emr/api/viewsets/questionnaire.py (2)

92-94: LGTM! Method rename maintains authorization logic.

The rename from authorize_delete to authorize_destroy aligns with the base class changes while preserving the superuser authorization check.


Line range hint 177-188: Verify complete migration to destroy terminology.

Let's ensure we haven't missed any instances of the old terminology.

✅ Verification successful

Looks like someone did their homework with the destroy terminology migration 🎯

The specific methods mentioned in the review have been successfully renamed, and the remaining "delete" occurrences are just Django's built-in methods and migrations that should stay as they are. How... refreshingly thorough.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check for any remaining instances of delete-related method names

echo "Checking for remaining authorize_delete methods..."
rg "def authorize_delete"

echo "Checking for remaining EMRDeleteMixin references..."
rg "EMRDeleteMixin"

echo "Checking for remaining perform_delete methods..."
rg "def perform_delete"

Length of output: 404


Script:

#!/bin/bash
# More comprehensive check for delete-related patterns

echo "Checking for delete in method names (case insensitive)..."
rg -i "def.*delete"

echo "Checking for delete in class names..."
rg -i "class.*delete"

echo "Checking method declarations with AST..."
ast-grep --pattern 'def $_(self, $$$) { $$$ delete $$$ }'

echo "Checking for any remaining delete references in viewsets..."
fd viewset -t f -x rg -i "delete" {}

echo "Checking for delete in class methods..."
ast-grep --pattern 'class $_ {
  $$$
  def $_($$$) {
    $$$
    delete
    $$$
  }
  $$$
}'

Length of output: 19971

Copy link

codecov bot commented Jan 9, 2025

Codecov Report

Attention: Patch coverage is 81.81818% with 4 lines in your changes missing coverage. Please review.

Project coverage is 45.97%. Comparing base (8b753ad) to head (bd6c251).
Report is 2 commits behind head on develop.

Files with missing lines Patch % Lines
care/emr/api/viewsets/base.py 66.66% 2 Missing ⚠️
care/emr/api/viewsets/scheduling/schedule.py 66.66% 2 Missing ⚠️
Additional details and impacted files
@@           Coverage Diff            @@
##           develop    #2723   +/-   ##
========================================
  Coverage    45.97%   45.97%           
========================================
  Files          313      313           
  Lines        17684    17684           
  Branches      1702     1702           
========================================
  Hits          8130     8130           
  Misses        9494     9494           
  Partials        60       60           

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

@vigneshhari vigneshhari merged commit 3b48ab5 into develop Jan 9, 2025
8 checks passed
@vigneshhari vigneshhari deleted the sainak/fix-delete-method branch January 9, 2025 13:55
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.

2 participants