[WEB-3102]fix: transfer issue count #6379
Conversation
WalkthroughThe pull request introduces a new Changes
Sequence DiagramsequenceDiagram
participant API as CycleViewSet
participant Type as TProgressSnapshot
participant Frontend as CycleComponents
API->>API: Count pending issues
API-->>Type: Add pending_issues field
Type-->>Frontend: Update cycle data structure
Frontend->>Frontend: Render cycle list with pending issues
Possibly related PRs
Suggested reviewers
Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
⏰ Context from checks skipped due to timeout of 90000ms (3)
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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (2)
apiserver/plane/app/views/cycle/base.py (2)
135-146: Implementation of pending_issues annotation looks good!The annotation correctly counts distinct issues in transferable states (backlog, unstarted, started) while maintaining consistency with existing filters for archived, draft, and deleted items.
Consider breaking the long line into multiple lines for better readability:
- issue_cycle__issue__state__group__in=["backlog", "unstarted", "started"], + issue_cycle__issue__state__group__in=[ + "backlog", + "unstarted", + "started" + ],🧰 Tools
🪛 Ruff (0.8.2)
140-140: Line too long (97 > 88)
(E501)
140-140: Fix line length issues.The following lines exceed the maximum line length of 88 characters:
- Line 140: 97 characters
- Line 586: 146 characters
Apply these changes to improve readability:
# For line 140 - issue_cycle__issue__state__group__in=["backlog", "unstarted", "started"], + issue_cycle__issue__state__group__in=[ + "backlog", + "unstarted", + "started" + ], # For line 586 - avatar_url=Case(When(assignees__avatar_asset__isnull=False, then=Concat(Value("/api/assets/v2/static/"), "assignees__avatar_asset", Value("/"),)), + avatar_url=Case( + When( + assignees__avatar_asset__isnull=False, + then=Concat( + Value("/api/assets/v2/static/"), + "assignees__avatar_asset", + Value("/"), + ), + ),Also applies to: 586-586
🧰 Tools
🪛 Ruff (0.8.2)
140-140: Line too long (97 > 88)
(E501)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (5)
apiserver/plane/app/views/cycle/base.py(3 hunks)packages/types/src/cycle/cycle.d.ts(2 hunks)web/ce/components/cycles/end-cycle/modal.tsx(1 hunks)web/core/components/cycles/list/cycle-list-item-action.tsx(2 hunks)web/core/components/cycles/quick-actions.tsx(1 hunks)
🧰 Additional context used
🪛 Ruff (0.8.2)
apiserver/plane/app/views/cycle/base.py
140-140: Line too long (97 > 88)
(E501)
🪛 GitHub Actions: Build and Lint on Pull Request
apiserver/plane/app/views/cycle/base.py
[error] 586-586: Line too long (146 > 88 characters). Consider breaking down the line or using line continuation.
🔇 Additional comments (7)
web/ce/components/cycles/end-cycle/modal.tsx (1)
9-9: LGTM! Interface update aligns with the new pending issues count.The property rename from
transferrableIssuesCounttopendingIssuesis consistent with the bug fix objectives.packages/types/src/cycle/cycle.d.ts (2)
61-61: LGTM! Type definition properly placed.The
pending_issuesfield is correctly added to theTProgressSnapshottype, maintaining consistency with other issue count fields.
124-124: LGTM! Formatting improvement.The
SelectCycleTypeformatting change improves readability without affecting functionality.web/core/components/cycles/list/cycle-list-item-action.tsx (2)
256-256: LGTM! Updated text display.The transfer issues text now correctly displays the count from
pending_issues.
84-84: Verify completion state handling.The condition correctly uses
pending_issues > 0for completed cycles. However, let's verify that this handles all cycle states correctly.✅ Verification successful
Completion state handling is correctly implemented ✓
The
cycleStatus === "completed"check is consistently implemented across all cycle-related components, and the additionalpending_issues > 0condition is appropriately specific to the transfer functionality.🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Search for all cycle status checks to ensure consistent handling rg "cycleStatus.*=== .*completed" web/Length of output: 980
apiserver/plane/app/views/cycle/base.py (2)
229-229: LGTM!The pending_issues field is correctly included in the response data structure.
261-261: LGTM!The pending_issues field is correctly included in the values list.
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
web/core/store/issue/cycle/issue.store.ts(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (2)
- GitHub Check: lint-apiserver
- GitHub Check: Analyze (javascript)
🔇 Additional comments (1)
web/core/store/issue/cycle/issue.store.ts (1)
311-318: Verify the impact on UI components.The changes to
pending_issuescount might affect UI components that rely on this value. Let's verify the usage across the codebase.✅ Verification successful
The pending_issues changes are safe for UI components
The modification to set
pending_issuesto 0 is handled appropriately by all dependent UI components:
- Cycle actions properly handle the zero state for transfer options
- Dashboard statistics and profile views safely calculate and display the count
- No potential rendering or calculation issues were found
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Search for UI components using pending_issues echo "Searching for UI components using pending_issues..." rg -l "pending_issues" --type=typescript --type=tsx # Search for specific usage patterns echo "\nSearching for specific usage patterns..." ast-grep --pattern 'pending_issues'Length of output: 1941
Script:
#!/bin/bash # Search with explicit file extensions echo "Searching TypeScript/TSX files..." rg -l "pending_issues" --glob "*.ts" --glob "*.tsx" # Search for cycle store usage echo "\nSearching for cycle store imports and usage..." rg -l "cycleStore|CycleStore" --glob "*.tsx" # Search for specific pending_issues access pattern echo "\nSearching for pending_issues access patterns..." ast-grep --pattern 'pending_issues'Length of output: 2515
Script:
#!/bin/bash # Check implementation of components using pending_issues echo "Checking quick-actions implementation..." rg -A 5 -B 5 "pending_issues" "web/core/components/cycles/quick-actions.tsx" echo "\nChecking cycle-list-item-action implementation..." rg -A 5 -B 5 "pending_issues" "web/core/components/cycles/list/cycle-list-item-action.tsx" echo "\nChecking overview-stats implementation..." rg -A 5 -B 5 "pending_issues" "web/core/components/dashboard/widgets/overview-stats.tsx" echo "\nChecking profile sidebar implementation..." rg -A 5 -B 5 "pending_issues" "web/core/components/profile/sidebar.tsx"Length of output: 4209
| // update pending count | ||
| runInAction(() => { | ||
| if (this.rootIssueStore.cycleMap) | ||
| set(this.rootIssueStore.cycleMap[cycleId], "pending_issues", { | ||
| ...this.rootIssueStore.cycleMap[cycleId], | ||
| pending_issues: 0, | ||
| }); | ||
| }); |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Simplify the object structure and improve type safety.
The current implementation has a few issues that could be improved:
- The object spread is redundant as you're setting a new value directly.
- The type safety could be improved with proper null checks.
- Error handling could be added for edge cases.
Here's the suggested implementation:
// update pending count
runInAction(() => {
- if (this.rootIssueStore.cycleMap)
- set(this.rootIssueStore.cycleMap[cycleId], "pending_issues", {
- ...this.rootIssueStore.cycleMap[cycleId],
- pending_issues: 0,
- });
+ try {
+ const cycleMap = this.rootIssueStore.cycleMap;
+ if (!cycleMap?.[cycleId]) return;
+
+ set(cycleMap, [cycleId, "pending_issues"], 0);
+ } catch (error) {
+ console.error("Failed to update pending issues count:", error);
+ }
});📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| // update pending count | |
| runInAction(() => { | |
| if (this.rootIssueStore.cycleMap) | |
| set(this.rootIssueStore.cycleMap[cycleId], "pending_issues", { | |
| ...this.rootIssueStore.cycleMap[cycleId], | |
| pending_issues: 0, | |
| }); | |
| }); | |
| // update pending count | |
| runInAction(() => { | |
| try { | |
| const cycleMap = this.rootIssueStore.cycleMap; | |
| if (!cycleMap?.[cycleId]) return; | |
| set(cycleMap, [cycleId, "pending_issues"], 0); | |
| } catch (error) { | |
| console.error("Failed to update pending issues count:", error); | |
| } | |
| }); |
Description
Corrected issues count in then Transfer issues button in cycles list.
Type of Change
References
WEB-3102
Summary by CodeRabbit
Release Notes
New Features
pending_issuescount to cycle details, providing more granular insight into issue status.Improvements
pending_issuesinstead of calculating transferable issues manually.Technical Updates
pending_issuesproperty.pending_issuesduring issue transfers in the cycle management logic.