[WEB-2177] fix: handling the archived module ids in the issue list and issue detail endpoints

[gurusainath]

Summary

This pull request removes the module_ids which are archived from the issue, module, and cycle issues endpoint and issue detail endpoint

Plane Issue:

[WEB-2177]

Summary by CodeRabbit

• New Features

  • Enhanced filtering logic to exclude archived modules from dataset queries.
  • Improved data integrity by ensuring only relevant, non-archived modules are included in responses.

• Bug Fixes

  • Resolved issues related to outdated filtering conditions that included archived modules in results.

• Style

  • Minor formatting adjustments for cleaner code, including the removal of unnecessary blank lines.

[coderabbitai]

Walkthrough

The recent changes enhance the data filtering logic across multiple components of the application. By adding conditions to exclude archived modules in various queries, the updates improve data integrity and relevance. This refinement ensures that only active modules are considered in aggregations, leading to more accurate and meaningful results in the application's responses.

Changes

Files	Change Summary
apiserver/plane/app/views/inbox/base.py	Updated filter in ArrayAgg to exclude archived modules by checking archived_at.
apiserver/plane/app/views/issue/base.py	Enhanced retrieve method filtering in IssueListEndpoint to exclude archived modules.
apiserver/plane/app/views/view/base.py	Modified filter in ArrayAgg to ensure only non-archived modules are included in results.
apiserver/plane/utils/grouper.py	Adjusted filtering in issue_queryset_grouper and issue_on_results for non-archived modules.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant API
    participant Database

    Client->>API: Request data
    API->>Database: Query with filters
    Database-->>API: Return non-archived data
    API-->>Client: Send filtered response

Loading

🐇 In the meadows where bunnies play,
Changes bloom like flowers in May.
Archived modules, now kept away,
Keep our data fresh every day!
Hops and skips, our joy's display! 🌷

---

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>.
  • 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 24b1e71 and 5a452df.

Files selected for processing (4)

• apiserver/plane/app/views/inbox/base.py (1 hunks)
• apiserver/plane/app/views/issue/base.py (3 hunks)
• apiserver/plane/app/views/view/base.py (1 hunks)
• apiserver/plane/utils/grouper.py (3 hunks)

Additional comments not posted (4)

apiserver/plane/utils/grouper.py (1)

32-35: Enhance filtering criteria for module IDs.

The added condition Q(issue_module__module__archived_at__isnull=True) in the annotations_map ensures that only non-archived modules are included in the results. This change aligns with the PR objectives to filter out archived modules.

apiserver/plane/app/views/view/base.py (1)

226-227: Refine module ID aggregation logic.

The addition of Q(issue_module__module__archived_at__isnull=True) to the filter in the ArrayAgg function ensures that only non-archived modules are considered. This aligns with the PR objectives to exclude archived modules from the dataset.

apiserver/plane/app/views/inbox/base.py (1)

163-164: Improve module ID filtering logic.

The inclusion of Q(issue_module__module__archived_at__isnull=True) in the ArrayAgg filter ensures that only non-archived modules are aggregated. This change supports the PR's goal of excluding archived modules from the results.

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

440-441: Approved: Exclude archived modules in retrieve method.

The added filter Q(issue_module__module__archived_at__isnull=True) ensures that archived modules are excluded from the module_ids annotation. This aligns with the PR objectives and improves data relevance.