Skip to content

Conversation

@NarayanBavisetti
Copy link
Collaborator

@NarayanBavisetti NarayanBavisetti commented Jan 28, 2025

Description

delete user's recent visits when the entity is deleted.

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • Feature (non-breaking change which adds functionality)
  • Improvement (change that would cause existing functionality to not work as expected)
  • Code refactoring
  • Performance improvements
  • Documentation update

References

Issue Link: WEB-3249

Summary by CodeRabbit

  • New Features

    • Enhanced data cleanup process when deleting cycles, issues, modules, pages, and views.
    • Automatically removes associated user recent visit records during entity deletion.
  • Improvements

    • Improved data integrity by ensuring related user visit records are removed when entities are deleted.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jan 28, 2025

Walkthrough

This pull request introduces a consistent enhancement across multiple view files in the Plane application. The changes focus on importing the UserRecentVisit model and modifying the destroy methods in various ViewSets (Cycle, Issue, Module, Page, and View) to automatically delete corresponding user recent visit entries when an entity is deleted. This ensures the clean-up of related user visit records during entity deletion, maintaining data integrity across different components of the application.

Changes

File Change Summary
apiserver/plane/app/views/.../cycle/base.py Added UserRecentVisit import, implemented deletion of recent visit entries in CycleViewSet.destroy()
apiserver/plane/app/views/.../issue/base.py Added UserRecentVisit import, implemented deletion of recent visit entries in IssueViewSet.destroy()
apiserver/plane/app/views/.../module/base.py Added UserRecentVisit import, implemented deletion of recent visit entries in ModuleViewSet.destroy()
apiserver/plane/app/views/.../page/base.py Added UserRecentVisit import, implemented deletion of recent visit entries in PageViewSet.destroy()
apiserver/plane/app/views/.../view/base.py Added UserRecentVisit import, implemented deletion of recent visit entries in IssueViewViewSet.destroy()

Possibly related PRs

Suggested Labels

🐛bug, ⚙️backend

Suggested Reviewers

  • pablohashescobar
  • sriramveeraghanta
  • rahulramesha

Poem

🐰 Hopping through code with glee,
Cleaning visits, setting data free!
Cycles, issues, modules too,
Recent tracks, we bid adieu!
Rabbit's cleanup dance is neat, 🧹
Keeping databases trim and sweet! 🌟


📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between a6318d5 and 1fbe0bc.

📒 Files selected for processing (5)
  • apiserver/plane/app/views/cycle/base.py (2 hunks)
  • apiserver/plane/app/views/issue/base.py (2 hunks)
  • apiserver/plane/app/views/module/base.py (2 hunks)
  • apiserver/plane/app/views/page/base.py (2 hunks)
  • apiserver/plane/app/views/view/base.py (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (5)
  • apiserver/plane/app/views/view/base.py
  • apiserver/plane/app/views/cycle/base.py
  • apiserver/plane/app/views/issue/base.py
  • apiserver/plane/app/views/module/base.py
  • apiserver/plane/app/views/page/base.py
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: Analyze (javascript)
  • GitHub Check: Analyze (python)

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 (1)
apiserver/plane/app/views/cycle/base.py (1)

547-553: Add error handling for the delete operation.

While the deletion of user recent visits is correctly implemented, it's recommended to add error handling to gracefully handle any potential database errors.

Apply this diff to add error handling:

 # Delete the cycle from recent visits
-UserRecentVisit.objects.filter(
-    project_id=project_id,
-    workspace__slug=slug,
-    entity_identifier=pk,
-    entity_name="cycle",
-).delete()
+try:
+    UserRecentVisit.objects.filter(
+        project_id=project_id,
+        workspace__slug=slug,
+        entity_identifier=pk,
+        entity_name="cycle",
+    ).delete()
+except Exception as e:
+    # Log the error but don't block the cycle deletion
+    logger.error(f"Error deleting user recent visits for cycle {pk}: {str(e)}")
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 74913a6 and a6318d5.

📒 Files selected for processing (5)
  • apiserver/plane/app/views/cycle/base.py (2 hunks)
  • apiserver/plane/app/views/issue/base.py (2 hunks)
  • apiserver/plane/app/views/module/base.py (2 hunks)
  • apiserver/plane/app/views/page/base.py (2 hunks)
  • apiserver/plane/app/views/view/base.py (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: Analyze (javascript)
  • GitHub Check: Analyze (python)
🔇 Additional comments (9)
apiserver/plane/app/views/view/base.py (2)

27-27: LGTM!

Import of UserRecentVisit model is correctly placed with other model imports.


499-505: LGTM!

The deletion of user recent visits is correctly implemented:

  • Proper filtering using project_id, workspace slug, entity identifier and entity name
  • Placed after deleting the view and user favorites
  • Consistent with the cleanup process
apiserver/plane/app/views/page/base.py (2)

36-36: LGTM!

Import of UserRecentVisit model is correctly placed with other model imports.


391-397: LGTM!

The deletion of user recent visits is correctly implemented:

  • Proper filtering using project_id, workspace slug, entity identifier and entity name
  • Placed after deleting the page and user favorites
  • Consistent with the cleanup process
apiserver/plane/app/views/module/base.py (2)

57-57: LGTM!

Import of UserRecentVisit model is correctly placed with other model imports.


812-818: LGTM!

The deletion of user recent visits is correctly implemented:

  • Proper filtering using project_id, workspace slug, entity identifier and entity name
  • Placed after deleting the module, module issues and user favorites
  • Consistent with the cleanup process
apiserver/plane/app/views/issue/base.py (2)

47-47: LGTM!

Import of UserRecentVisit model is correctly placed with other model imports.


675-681: LGTM!

The deletion of user recent visits is correctly implemented:

  • Proper filtering using project_id, workspace slug, entity identifier and entity name
  • Placed after deleting the issue and before triggering the issue activity
  • Consistent with the cleanup process
apiserver/plane/app/views/cycle/base.py (1)

50-50: LGTM!

The import of UserRecentVisit model is correctly placed with other model imports.

@sriramveeraghanta sriramveeraghanta merged commit 51b52a7 into preview Jan 28, 2025
12 of 14 checks passed
@sriramveeraghanta sriramveeraghanta deleted the chore-delete-recent-vist branch January 28, 2025 15:20
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.

4 participants