[WEB-2721] fix: issue retrieval endpoint

[NarayanBavisetti]

fix:

• this pull request resolves the issue with the issue retrieval.

Summary by CodeRabbit

• New Features

  • Enhanced issue retrieval with conditional cycle ID annotations.
  • Improved filtering and grouping capabilities for issue lists.
  • Added validation for grouping parameters to prevent conflicts.

• Bug Fixes

  • Enhanced error handling for updates on non-existent issues.
  • Added checks for issue IDs in bulk deletion to prevent unnecessary operations.

[coderabbitai]

Walkthrough

The pull request introduces enhancements to the apiserver/plane/app/views/issue/base.py file, focusing on the IssueListEndpoint, IssueViewSet, and IssueUserDisplayPropertyEndpoint classes. Key modifications include the addition of conditional annotations for cycle_id, improved filtering and grouping capabilities in the list methods, enhanced error handling in the partial_update method, and checks for issue IDs in the BulkDeleteIssuesEndpoint. These changes aim to improve data retrieval, error management, and control flow in issue management endpoints.

Changes

File Path	Change Summary
apiserver/plane/app/views/issue/base.py	- Enhanced retrieve method in IssueViewSet with conditional cycle_id annotation.
	- Updated list methods in IssueListEndpoint and IssueViewSet for improved filtering and grouping validation.
	- Improved error handling in partial_update method of IssueViewSet for non-existent issues.
	- Modified BulkDeleteIssuesEndpoint to check for presence of issue IDs before deletion.

Possibly related PRs

• [WEB-2020] chore: display cross project issue relations #5186: Modifications to the IssueRelationViewSet, relevant to overall issue management functionality.
• fix: unable to added issues to a completed cycle #5348: Addresses adding issues to completed cycles, related to cycle management in the IssueViewSet.
• [WEB-2696] fix: unable to view intake issue #5875: Updates to the InboxIssueViewSet for filtering logic, connecting with enhanced issue retrieval.
• [WEB-2708] fix: intake module and cycle addition fixed #5890: Focuses on adding issues to cycles, aligning with enhancements to IssueViewSet regarding cycle ID handling.

Suggested labels

🐛bug, ⚙️backend

Suggested reviewers

• sriramveeraghanta
• pablohashescobar
• SatishGandham

🐰 In the code we hop and play,
Enhancing issues day by day.
With cycles checked and errors clear,
Our API's strong, let's give a cheer!
🥕✨

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 14b31e3 and 56a908c.

📒 Files selected for processing (1)

• apiserver/plane/app/views/issue/base.py (1 hunks)

🔇 Additional comments (5)

apiserver/plane/app/views/issue/base.py (5)

18-19: Importing Case and When for conditional annotations

The addition of Case and When from django.db.models is appropriate for implementing conditional annotations in querysets.

---

Line range hint 107-114: Validation for group_by and sub_group_by parameters

The check to prevent group_by and sub_group_by from being the same enhances input validation and improves the control flow in the list method of IssueListEndpoint.

---

Line range hint 272-276: Proper error handling when issue is not found in partial_update

Adding a check for the non-existence of the issue and returning a 404 response enhances error handling in the partial_update method, providing clear feedback when an issue is not found.

---

Line range hint 356-360: Validation of issue_ids in BulkDeleteIssuesEndpoint

The added check to ensure that issue_ids are provided before attempting deletion prevents unnecessary operations and improves the API's usability by providing clear error messages.

---

Line range hint 227-236: Ensure correctness of the conditional cycle_id annotation in retrieve method

In the retrieve method of IssueViewSet, the conditional annotation for cycle_id using Case and When adds logic to include the cycle_id only when the related cycle is not deleted. Verify that issue_cycle__cycle__deleted_at__isnull=True correctly references the intended relationship and that F("issue_cycle__cycle_id") points to the correct field.

Run the following script to confirm the field references:

✅ Verification successful

Let me gather more information about the model relationships and field references to verify this thoroughly.

---

Let me check one more thing to understand the relationship between models better.

---

Based on the gathered information, I can now provide a final response:

The cycle_id annotation in the retrieve method is correctly implemented

The code analysis reveals that:

• The relationship between Issue and Cycle is through the CycleIssue model (found in apiserver/plane/db/models/cycle.py)
• The issue_cycle__cycle__deleted_at field reference is valid as:
  • CycleIssue has a foreign key to Cycle named cycle with related_name="issue_cycle"
  • Cycle model would have a deleted_at field (as it's standard in the codebase)
• The F("issue_cycle__cycle_id") reference is also correct as it follows the same relationship path

The conditional annotation using Case and When properly checks for non-deleted cycles and retrieves the cycle ID only for valid relationships.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the existence of `issue_cycle__cycle__deleted_at` field in Issue model relations.

# Expected: Should display occurrences of `issue_cycle__cycle__deleted_at` in the codebase.
rg 'issue_cycle__cycle__deleted_at'

Length of output: 144

---

Script:

#!/bin/bash
# Check the Issue model and its relationships
ast-grep --pattern 'class Issue(models.Model):
  $$$
'

# Check the Cycle model and its relationships
ast-grep --pattern 'class Cycle(models.Model):
  $$$
'

# Check for IssuesCycle model that might define the relationship
ast-grep --pattern 'class IssuesCycle(models.Model):
  $$$
'

# Look for any other occurrences of cycle-related fields or annotations
rg -A 3 'cycle_id' apiserver/plane/app/views/issue/

Length of output: 5191

---

Script:

#!/bin/bash
# Look for model definitions and relationships
rg -A 5 'class (CycleIssue|IssuesCycle).*Model' 
rg -A 5 'cycle = models\.' 
rg -A 5 'issue_cycle = models\.'

Length of output: 2009

---

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.