[WEB-2813] chore: improved the cascading logic

[NarayanBavisetti]

chore:

• improve the cascading logic.

Summary by CodeRabbit

• Bug Fixes
  • Improved the reliability of the deletion process by enhancing checks for model field attributes.
  • Reduced potential errors related to undefined model relationships during deletion tasks.

[coderabbitai]

Walkthrough

The changes involve modifications to the soft_delete_related_objects function in apiserver/plane/bgtasks/deletion_task.py. The update simplifies the conditional check for the on_delete attribute of the remote_field in a model field, ensuring that the remote_field exists before checking its attributes. This change enhances the code's robustness by preventing potential errors related to accessing undefined attributes.

Changes

File Path	Change Summary
apiserver/plane/bgtasks/deletion_task.py	Modified the soft_delete_related_objects function to simplify the check for the on_delete attribute of remote_field, ensuring it exists before access.

Possibly related PRs

• [WEB-2631] chore: changed the cascading logic for soft delete #5829: This PR modifies the soft_delete_related_objects function in the same file, changing the logic for the on_delete attribute, which is directly related to the changes made in the main PR.

Suggested labels

⚙️backend

Suggested reviewers

• sriramveeraghanta

Poem

In the code where rabbits play,
A check was changed, hip-hip-hooray!
No more errors, clear and bright,
Soft deletes now work just right.
Hopping through the fields of code,
Robust and safe, we share the load! 🐇✨

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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

[coderabbitai]

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)

apiserver/plane/bgtasks/deletion_task.py (1)

22-24: Consider extracting the condition to improve readability

While the current implementation is correct, the multiple condition checks could be extracted into a helper function to improve readability and reusability.

Here's a suggested refactor:

+def has_cascade_delete(field):
+    return (
+        hasattr(field, "remote_field") and
+        hasattr(field.remote_field, "on_delete") and
+        field.remote_field.on_delete == models.CASCADE
+    )
+
 @shared_task
 def soft_delete_related_objects(app_label, model_name, instance_pk, using=None):
     # ... existing code ...
     for field in related_fields:
         if field.one_to_many or field.one_to_one:
             try:
-                if (
-                    hasattr(field, "remote_field") and
-                    hasattr(field.remote_field, "on_delete") and
-                    field.remote_field.on_delete == models.CASCADE
-                ):
+                if has_cascade_delete(field):

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 1b92a18 and 1019cd1.

📒 Files selected for processing (1)

• apiserver/plane/bgtasks/deletion_task.py (1 hunks)

🔇 Additional comments (1)

apiserver/plane/bgtasks/deletion_task.py (1)

22-24: LGTM! More robust attribute checking

The new implementation is more defensive and explicit in checking the existence of attributes before accessing them. This prevents potential AttributeError exceptions and makes the cascading logic more reliable.