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

[WEB-2626] chore: removed the deleted issue's count #5837

Merged
merged 2 commits into from
Oct 15, 2024

Conversation

NarayanBavisetti
Copy link
Collaborator

@NarayanBavisetti NarayanBavisetti commented Oct 15, 2024

chore:

  • removed the deleted issue's count

Issue Link: WEB-2626

Summary by CodeRabbit

  • New Features

    • Enhanced filtering for issues by excluding deleted items in various analytics and cycle-related endpoints.
  • Bug Fixes

    • Corrected querying mechanism in the analytics plotting function to improve accuracy in issue estimates.

Copy link
Contributor

coderabbitai bot commented Oct 15, 2024

Walkthrough

The changes in this pull request involve updates to various classes and methods to enhance the filtering of issues marked as deleted. Specifically, the deleted_at field is now incorporated into the query annotations across several endpoints, ensuring that only non-deleted issues are considered in various calculations and analytics. The modifications affect the CycleArchiveUnarchiveEndpoint, CycleViewSet, TransferCycleIssueEndpoint, CycleAnalyticsEndpoint, and WorkspaceCyclesEndpoint, while also adjusting the querying mechanism in the burndown_plot function.

Changes

File Path Change Summary
apiserver/plane/app/views/cycle/archive.py Updated CycleArchiveUnarchiveEndpoint to filter out deleted issues in get_queryset and get methods.
apiserver/plane/app/views/cycle/base.py Modified CycleViewSet, TransferCycleIssueEndpoint, and CycleAnalyticsEndpoint to include deleted_at filters in annotations. Method signatures updated for get_queryset, post, and get methods.
apiserver/plane/app/views/workspace/cycle.py Adjusted WorkspaceCyclesEndpoint's get method to filter deleted_at in several Count annotations.
apiserver/plane/utils/analytics_plot.py Changed querying mechanism in burndown_plot function from Issue.objects.filter(...) to Issue.issue_objects.filter(...). Corrected indentation for if statement.

Possibly related PRs

Suggested labels

🧹chore

Suggested reviewers

  • pablohashescobar
  • sriramveeraghanta

🐰 In the fields where issues grow,
A filter now helps us know,
Which ones are gone, which ones remain,
In cycles where we track the gain.
With every hop and every glance,
We tidy up, give data a chance! 🌼


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

🧹 Outside diff range and nitpick comments (2)
apiserver/plane/utils/analytics_plot.py (2)

Line range hint 1-280: Summary of changes in burndown_plot function

The modifications in this file are focused on using a custom manager (issue_objects) for Issue queries in the burndown_plot function. This change is consistently applied for both cycle and module-related queries.

These alterations align with the PR objective of removing deleted issues from counts, likely through the use of a custom manager that filters out deleted issues. The rest of the function and file remain unchanged, preserving the existing logic and structure.

Consider documenting the behavior of the issue_objects manager in a comment within this file or in the model definition to make it clear to other developers why this custom manager is used and what filtering it applies.


@sriramveeraghanta sriramveeraghanta merged commit 6e63af7 into preview Oct 15, 2024
14 of 15 checks passed
@sriramveeraghanta sriramveeraghanta deleted the chore/remove-deleted-issues-count branch October 15, 2024 19:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants