[WEB-3477] fix: mutation issue on moving work items for a manually ended cycle

[gakshita]

Description

This PR restricts the users from editing work items in completed cycle

Summary by CodeRabbit

• Bug Fixes
  • Improved cycle filtering so that cycles marked as "completed" appear correctly in the completed list, regardless of end date conditions.
  • Adjusted the logic to ensure these cycles are excluded from the incomplete list.

[coderabbitai]

Walkthrough

This pull request refines the filtering logic in the CycleStore class by updating two computed properties. The currentProjectCompletedCycleIds property now includes cycles marked as "completed" regardless of the end date status. Conversely, the currentProjectIncompleteCycleIds property explicitly filters out cycles that are marked as "completed." These changes improve the accuracy of cycle classification based on their status and date conditions.

Changes

File(s)	Change Summary
web/core/store/cycle.store.ts	Modified the computed properties currentProjectCompletedCycleIds and currentProjectIncompleteCycleIds to include cycle status in the filtering criteria.

Suggested labels

🐛bug, ⚙️backend

Suggested reviewers

• SatishGandham
• rahulramesha

Poem

I'm a rabbit with a joyful trot,
Skipping through code with a curious thought.
Cycles now sorted with precision and flair,
Completed and pending handled with care.
Hop along, dear coder, in this logic so neat,
For carrots and code make a jubilant treat!

✨ Finishing Touches

• 📝 Generate Docstrings

---

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 generate docstrings to generate docstrings for 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.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (2)

web/core/store/cycle.store.ts (2)

182-184: Improved cycle completion logic to include manually completed cycles

The enhanced condition now correctly identifies cycles as completed when they are explicitly marked with a "completed" status, regardless of their end date. This is a good improvement that allows for manual cycle completion.

Consider adding a comment explaining this logic to help future developers understand the different conditions that make a cycle "completed":

+ // A cycle is completed if either:
+ // 1. Its end date has passed and is not today, or
+ // 2. It has been explicitly marked as "completed" regardless of its end date
return (
  c.project_id === projectId && ((hasEndDatePassed && !isEndDateToday) || c.status?.toLowerCase() === "completed")
);

---

200-202: Properly exclude completed cycles from incomplete cycles list

This change ensures that cycles explicitly marked as "completed" are not included in the incomplete cycles list, even if their end date hasn't passed yet. This is consistent with the update to currentProjectCompletedCycleIds and properly addresses the PR objective of preventing edits to work items in completed cycles.

Similar to the previous suggestion, consider adding a comment for clarity:

+ // A cycle is incomplete if:
+ // 1. It belongs to the current project
+ // 2. Its end date hasn't passed
+ // 3. It's not archived
+ // 4. It's not explicitly marked as "completed"
return (
  c.project_id === projectId && !hasEndDatePassed && !c?.archived_at && c.status?.toLowerCase() !== "completed"
);

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between c021ffd and 05521a4.

📒 Files selected for processing (1)

• web/core/store/cycle.store.ts (2 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (2)

• GitHub Check: Analyze (javascript)
• GitHub Check: Analyze (python)

🔇 Additional comments (1)

web/core/store/cycle.store.ts (1)

182-184:

❓ Verification inconclusive

Verify that this fix is complete for preventing work item edits in completed cycles

The changes correctly identify cycles as completed based on both end date and status. However, to fully implement the PR objective of "preventing users from editing work items that are part of a completed cycle", there might be additional code needed in the UI or other components that actually enforces this restriction.

Let's check if there are any UI components or other code that needs to use these updated cycle classifications to enforce the edit restriction:

Also applies to: 200-202

---

🏁 Script executed:

#!/bin/bash
# Search for places where work items are edited and might need to check cycle completion status

echo "Searching for places where work items might be edited in the context of cycles..."

# Look for UI components that handle work item editing
echo "Looking for UI components that might edit work items in cycles:"
rg -A 3 -B 3 "edit.*item.*cycle|cycle.*edit.*item" --glob "*.tsx" --glob "*.jsx"

# Look for any API endpoints or services that handle work item mutations within cycles
echo "Looking for API handlers for work item mutations:"
rg -A 3 -B 3 "update.*cycle.*item|move.*cycle.*item|edit.*cycle.*item" --glob "*.ts"

# Look for mutation functions that might need to check cycle completion
echo "Looking for mutation functions that might need to be updated:"
rg -A 3 -B 3 "mutation.*cycle|update.*cycle" --glob "*.ts" --glob "*.tsx"

Length of output: 25304

---

Verify implementation of work item edit restrictions across UI and API

The updated condition in web/core/store/cycle.store.ts (lines 182–184) appropriately marks cycles as completed based on end date and status. However, our repository search did not reveal any explicit checks in the UI (or related mutation functions) that block work item edits when a cycle is completed. It appears that while the cycle classification is updated, additional enforcement in components (e.g., cycle forms, issue editing handlers in the UI, and relevant API endpoints) may be needed to fully prevent editing in completed cycles.

• Action Item: Please review the components modifying work items (such as those found in cycles/form.tsx, header.tsx, and the issue update functions) to ensure they also check for a completed cycle status and disable edits accordingly.