[WEB-3877] chore: changed the logic to end cycle

[NarayanBavisetti]

Description

this pull request modifies the logic to ensure the cycle ends at the end of the selected date.

Type of Change

• [x] Improvement (change that would cause existing functionality to not work as expected)

Test Scenarios

• cycle starting and ending on same dates.
• cycle starting and ending on different dates.

Summary by CodeRabbit

• Refactor
  • Improved date handling for cycles by simplifying the conversion of end dates to always use the last minute of the day, ensuring consistent cycle end times.
  • Enhanced issue count accuracy by excluding deleted issues from cycle-related statistics across multiple views and endpoints.
• Style
  • Updated internal comments for better clarity regarding cycle end date treatment.

[makeplane[bot]]

Pull Request Linked with Plane Work Items

• [WEB-3877] Cycle Finishes Incorrectly at Start of Day

Comment Automatically Generated by Plane

[coderabbitai[bot]]

Walkthrough

The changes remove the use of the is_start_date_end_date_equal flag throughout the codebase. This flag was previously used to determine if the start and end dates of a cycle were the same, influencing how the end date was converted to UTC. The flag and its associated logic have been eliminated from serializers, views, and the convert_to_utc utility function. Now, the end date is always set to the last minute of the day during UTC conversion, regardless of whether the start and end dates are equal. Additionally, an extra filter condition issue_cycle__issue__deleted_at__isnull=True was added to multiple issue count queries to exclude deleted issues.

Changes

File(s)	Change Summary
apiserver/plane/api/serializers/cycle.py apiserver/plane/app/serializers/cycle.py	Removed calculation and usage of is_start_date_end_date_equal in cycle serializers' validate methods.
apiserver/plane/app/views/cycle/base.py apiserver/plane/api/views/cycle.py apiserver/plane/app/views/workspace/cycle.py	Added filter issue_cycle__issue__deleted_at__isnull=True to issue count queries; removed is_start_date_end_date_equal usage in CycleDateCheckEndpoint.post. Also ensured .first() usage on querysets to get single instances. Added 404 checks and used cached progress snapshot data where available.
apiserver/plane/utils/timezone_converter.py	Removed is_start_date_end_date_equal parameter from convert_to_utc; updated logic to always set end to 23:59.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant View
    participant Serializer
    participant Utils

    Client->>View: POST cycle dates
    View->>Serializer: Validate start_date, end_date
    Serializer->>Utils: convert_to_utc(start_date, project_id, is_start_date=True)
    Serializer->>Utils: convert_to_utc(end_date, project_id, is_start_date=False)
    Utils-->>Serializer: UTC start_date, UTC end_date (end always set to 23:59)
    Serializer-->>View: Validated and converted dates
    View-->>Client: Response

Suggested reviewers

• sriramveeraghanta
• prateekshourya29

Poem

A cycle’s day from start to end,
No longer checks if dates are twins, my friend.
Now every end, at 23:59,
Hops to UTC, looking just fine.
With simpler code, the time’s precise—
This bunny says, “Refactoring’s nice!”
🕰️🐇

✨ Finishing Touches

• [ ] 📝 Generate Docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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 generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.