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-1971] fix: remove issue from cycle while changing cycle #5246

Merged
merged 1 commit into from
Jul 29, 2024

Conversation

rahulramesha
Copy link
Collaborator

@rahulramesha rahulramesha commented Jul 26, 2024

This PR fixes the issue when updating cycle while in a cycle issues page, the issue does not get removed.

Screen.Recording.2024-07-26.at.7.06.27.PM.mov

Summary by CodeRabbit

  • Bug Fixes
    • Improved the efficiency of the issue cycle assignment by preventing unnecessary processing when the same cycle ID is used.
    • Enhanced state management by ensuring proper removal of issues from lists when reassigned to the same cycle.

These enhancements lead to a more responsive and accurate issue management experience for users.

@rahulramesha rahulramesha added 🐛bug Something isn't working 🌐frontend labels Jul 26, 2024
Copy link
Contributor

coderabbitai bot commented Jul 26, 2024

Walkthrough

The recent changes enhance the addCycleToIssue method in the BaseIssuesStore class by introducing checks to avoid unnecessary processing. Specifically, it prevents adding a cycle if the cycle ID is already linked to the issue, thus optimizing performance. Additionally, it ensures that the state is correctly updated by removing the issue from the list when it is being reassigned to the same cycle, maintaining consistency in the application's state management.

Changes

File Path Change Summary
web/core/store/issue/helpers/base-issues.store.ts Modified addCycleToIssue method to include checks for existing cycle IDs, optimizing state updates.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant BaseIssuesStore

    User->>BaseIssuesStore: addCycleToIssue(issueId, cycleId)
    alt Check Existing Cycle
        BaseIssuesStore-->>User: return (same cycle)
    else Process Update
        BaseIssuesStore->>BaseIssuesStore: update issueCycleId
        BaseIssuesStore->>BaseIssuesStore: remove issueId from list if necessary
    end
    BaseIssuesStore-->>User: return updated state
Loading

Poem

Hop, hop, hooray, what a splendid day!
With cycles in check, we dance and we play.
No more redundant hops, just smooth, swift glides,
In the garden of code, where efficiency hides.
🐇✨ Let's celebrate progress, in leaps and in bounds!


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

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, codebase verification and nitpick comments (1)
web/core/store/issue/helpers/base-issues.store.ts (1)

895-895: Add a comment to explain the purpose of this check.

Adding a comment will help other developers understand why this early return is necessary.

+ // If the issue is already associated with the given cycleId, return early to avoid redundant operations.
  const issueCycleId = this.rootIssueStore.issues.getIssueById(issueId)?.cycle_id;
Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 2c60967 and 2189c6a.

Files selected for processing (1)
  • web/core/store/issue/helpers/base-issues.store.ts (1 hunks)
Additional comments not posted (2)
web/core/store/issue/helpers/base-issues.store.ts (2)

896-896: Early return optimization looks good.

The early return prevents unnecessary processing if the cycleId is already linked to the issue.


901-902: Ensure state consistency when updating cycle ID.

The state update logic correctly handles removing the issue from the list if the cycle ID before the update matches the current cycle ID.

try {
// Update issueIds from current store
runInAction(() => {
// If cycle Id before update is the same as current cycle Id then, remove issueId from list
if (this.cycleId === issueCycleId) this.removeIssueFromList(issueId);
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why are we removing the issue from the list? Is it like a toggle?

@SatishGandham SatishGandham merged commit d5cbe32 into preview Jul 29, 2024
13 of 14 checks passed
@SatishGandham SatishGandham deleted the fix-issue-cycle-update branch July 29, 2024 07:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🐛bug Something isn't working 🌐frontend
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants