Skip to content

[WEB-3863] fix: handled error handling for link editing#6968

Merged
sriramveeraghanta merged 1 commit intopreviewfrom
fix-link-error-handling
Apr 25, 2025
Merged

[WEB-3863] fix: handled error handling for link editing#6968
sriramveeraghanta merged 1 commit intopreviewfrom
fix-link-error-handling

Conversation

@gakshita
Copy link
Collaborator

@gakshita gakshita commented Apr 24, 2025

Description

Handled false state updation for invalid links

References

[WEB-3863]

Summary by CodeRabbit

  • Bug Fixes
    • Improved error handling when updating issue links to ensure local data is reverted if the update fails, maintaining data consistency for users.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Apr 24, 2025

Walkthrough

The updateLink method in the link store was revised to introduce error handling for the update operation. The method now saves a shallow copy of the current link data before attempting any updates. The optimistic update and remote call are enclosed in a try-catch block. If the remote update fails, the method logs the error and reverts the local state to its original value, ensuring consistency. The method's signature and external interface remain unchanged.

Changes

File(s) Change Summary
web/core/store/issue/issue-details/link.store.ts Added error handling to updateLink, saving initial state, wrapping update logic in try-catch, and reverting on error.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant LinkStore
    participant RemoteService

    User->>LinkStore: updateLink(linkId, update)
    LinkStore->>LinkStore: Save initialData (shallow copy)
    LinkStore->>LinkStore: Optimistically update linkMap
    alt Remote update succeeds
        LinkStore->>RemoteService: updateLink(linkId, update)
        RemoteService-->>LinkStore: Success response
        LinkStore->>LinkStore: Fetch activities
        LinkStore-->>User: Return updated link
    else Remote update fails
        LinkStore->>RemoteService: updateLink(linkId, update)
        RemoteService-->>LinkStore: Error
        LinkStore->>LinkStore: Log error, revert linkMap to initialData
        LinkStore-->>User: Return reverted data
    end
Loading

Suggested labels

🐛bug

Suggested reviewers

  • sriramveeraghanta

Poem

A bug hopped in, but now it’s gone,
With careful code, we carry on.
If updates fail, we roll right back—
No more state lost off the track!
The store’s now wise, with error checks,
And rabbits dance—no side effects!
🐇✨

✨ 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
🪧 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.

@makeplane
Copy link

makeplane bot commented Apr 24, 2025

Pull Request Linked with Plane Work Items

Comment Automatically Generated by Plane

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

🧹 Nitpick comments (1)
web/core/store/issue/issue-details/link.store.ts (1)

124-145: Good implementation of error handling with state reversion.

The changes appropriately handle errors during link updates by:

  1. Creating a backup of the initial state
  2. Using try-catch to handle API failures
  3. Reverting to the initial state on error using MobX's runInAction

This prevents the UI from showing an inconsistent state when link updates fail.

One minor suggestion: Consider using a more structured error logging approach instead of console.error for better production error tracking.

- console.error("error", error);
+ // Replace with your app's error logging service
+ this.rootIssueDetailStore.logger?.error("Failed to update issue link", { error, linkId, issueId });
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 6df8323 and aa6127d.

📒 Files selected for processing (1)
  • web/core/store/issue/issue-details/link.store.ts (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: Analyze (javascript)
  • GitHub Check: Analyze (python)

@sriramveeraghanta sriramveeraghanta merged commit d86ac36 into preview Apr 25, 2025
5 of 6 checks passed
@sriramveeraghanta sriramveeraghanta deleted the fix-link-error-handling branch April 25, 2025 09:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants