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.

Sign up for GitHub

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

Jump to bottom

multi: fix payment failure overwrite #9543

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

multi: fix payment failure overwrite #9543

wants to merge 1 commit into from

Conversation

ziggie1984
Copy link
Collaborator

@ziggie1984 ziggie1984 commented Feb 22, 2025 •
edited by saubyk
Loading

We are not consistent when handling payment failures so we need to make sure we do not fail a payment twice overwriting its previous failure reason.

Thanks @feelancer21 for reporting. Fixes #9542

Observed in the sendtoroute cmd. When tracking the payment it can be observed that we overwrite the payment failure.

@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Feb 22, 2025

Important

Review skipped

Auto reviews are limited to specific labels.

🏷️ Labels to auto review (1)
  • llm-review

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

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>, 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. (Beta)
  • @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.

@ziggie1984
multi: fix payment failure overwrite
4eca3b9 
We now make sure we do not overwrite the payment failure status
if it is already set and return an error. When using sendtoroute
we might fail a payment twice hence we do not error out if we
fail a payment twice.
@ziggie1984 ziggie1984 force-pushed the fix-payment-inconsitency branch from ab5cd5f to 4eca3b9 Compare February 22, 2025 10:47
@ziggie1984
Copy link
Collaborator Author

ziggie1984 commented Feb 22, 2025 •
edited
Loading

If the approach is ok, will add a unit-test.
I don't think we should allow swapping the payment error tbh, a payment should only fail once and I think this is a relict in the codebase fromer the prior behaviour, we should only fail a payment if all shards are resolved.

lnd/channeldb/payment_control_test.go

Lines 891 to 894 in 5fe900d

// Check that we can override any perevious terminal
// failure. This is to allow multiple concurrent shard
// write a terminal failure to the database without
// syncing.

@ziggie1984 ziggie1984 marked this pull request as ready for review February 22, 2025 10:47
@yyforyongyu
Copy link
Member

Why did we fail the payment twice? Can we make it fail it once instead?

@ziggie1984
Copy link
Collaborator Author

We fail it almost certainly twice in SendToRouteV2 because we don't know whether we only fail the attempt or the attempt and the payment in the result collector:

lnd/routing/router.go

Lines 1189 to 1206 in 5fe900d

result, err = p.collectAndHandleResult(attempt)
if err != nil {
return nil, err
}
// We got a successful result.
if result.err == nil {
return result.attempt, nil
}
// An error returned from collecting the result, we'll mark the payment
// as failed if we don't skip temp error.
if !skipTempErr {
err := r.cfg.Control.FailPayment(paymentIdentifier, reason)
if err != nil {
return nil, err
}
}

yyforyongyu
yyforyongyu reviewed Feb 26, 2025
View reviewed changes
routing/router.go
@@ -1200,7 +1200,12 @@ func (r *ChannelRouter) sendToRoute(htlcHash lntypes.Hash, rt *route.Route,
// as failed if we don't skip temp error.
if !skipTempErr {
err := r.cfg.Control.FailPayment(paymentIdentifier, reason)
if err != nil {

Copy link
Member

Choose a reason for hiding this comment

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

I think a better approach is to perform a check on this payment, if it's already failed, we skip calling the above FailPayment. We don't wanna this single case to change the underlying logic/assumptions for our CRUD.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@yyforyongyu yyforyongyu yyforyongyu left review comments

At least 2 approving reviews are required to merge this pull request.

Assignees

@ziggie1984 ziggie1984

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[bug]: TrackPayments occasionally returns two failed payments
2 participants
@ziggie1984 @yyforyongyu