routerrpc: add a default value for timeout_seconds in SendPaymentV2 #9359

NishantBansal2003 · 2024-12-14T12:40:17Z

Change Description

Description of change / link to associated issue.
This PR introduces a default value of 60 seconds for the timeout_seconds field in the SendPaymentV2 RPC call in the routerrpc.SendPaymentRequest.

Fixes: #9282

Steps to Test

Test with explicit timeout_seconds values:

Make an RPC call to SendPaymentV2 with a valid non-zero value for timeout_seconds.
Verify that the request behaves as expected and uses the provided value.

Test without timeout_seconds:

Make an RPC call to SendPaymentV2 without including the timeout_seconds field.
Verify that the default value of 60 seconds is applied and used during the request.

Pull Request Checklist

Testing

Your PR passes all CI checks.
Tests covering the positive and negative (error paths) are included.
Bug fixes contain tests triggering the bug to prevent regressions.

Code Style and Documentation

The change obeys the Code Documentation and Commenting guidelines, and lines wrap at 80.
Commits follow the Ideal Git Commit Structure.
Any new logging statements use an appropriate subsystem and logging level.
Any new lncli commands have appropriate tags in the comments for the rpc in the proto file.
There is a change description in the release notes, or [skip ci] in the commit message for small changes.

📝 Please see our Contribution Guidelines for further guidance.

coderabbitai · 2024-12-14T12:40:24Z

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.

yyforyongyu

Thanks for the PR. A few suggestions to complete the change,

we should update the SendpaymentRequest in router.proto and make the field timeout_seconds optional, also need to update the docs there to make it clear that this field is now optional.
we then update both the cli and the RPC to not check the timeout value.
we should also update some of the itests to validate the new behavior that we don't check for timeout values, which can be any of the cases that use TimeoutSeconds: 60 when making a payment, and we can simply remove it there to validate the new behavior.

lnrpc/routerrpc/router_server.go

NishantBansal2003 · 2024-12-16T18:46:03Z

Hey @yyforyongyu, thanks for the review! I made some modifications based on your feedback. Could you please check if everything is covered, or if I need to check anything further?
Also, could you let me know in which file I should add the changelog entry—0.18.4 or 0.19.0?

NishantBansal2003 · 2024-12-19T09:06:13Z

Hey @yyforyongyu, thanks for the review! I made some modifications based on your feedback. Could you please check if everything is covered, or if I need to check anything further? Also, could you let me know in which file I should add the changelog entry—0.18.4 or 0.19.0?

cc: @yyforyongyu @guggero, just pinging again in case the last message was missed.

guggero · 2024-12-19T09:42:53Z

Hey @yyforyongyu, thanks for the review! I made some modifications based on your feedback. Could you please check if everything is covered, or if I need to check anything further? Also, could you let me know in which file I should add the changelog entry—0.18.4 or 0.19.0?

cc: @yyforyongyu @guggero, just pinging again in case the last message was missed.

v0.18.4 was just released, so 0.19.

yyforyongyu · 2024-12-19T09:41:10Z

lnrpc/routerrpc/router.proto

+    An optional upper limit on the amount of time we should spend when
+    attempting to fulfill the payment. This is expressed in seconds. If we
+    cannot make a successful payment within this time frame, an error will be
+    returned. This field must be non-zero.


we should also mention the default value of 60s is used when the field is not set, and when setting the field, a value of 0 is not allowed, and we should change the below field to optional int32 timeout_seconds = 6.

Then when we check it, we first check if the field is set by checking if it's nil, if set, we require it to be not zero, otherwise, use the default 60s.

Since timeout_seconds is of type int32 and not a pointer, its default value will be 0 if it is not set. Therefore, whether timeout_seconds is not specified or explicitly set to 0, I have implemented logic to default it to 60 seconds.

Please let me know if there is anything else I need to address.

Can you run make rpc first? Then you'll know what i meant

Done. Thanks for the help! I will make sure to learn from this and avoid making the same mistake in the future.

Wanted to comment about backward compatibility of changing the behavior of the field. But doesn't seem to be an issue, according to this: https://stackoverflow.com/a/76375904
So that seems to be the right approach indeed for this situation.

hmm now that you mention it I think there still might be a compatibility issue re the new optional field, as it may break users' Go code since it now expects TimeoutSeconds to be a pointer? If they haven't set the field then it's fine I think.

I think, while proto3 can be backward compatible in terms of the field being optional or not, the change in Go's generated code (from a value type to a pointer type) could lead to issues if the code depends on the non-pointer representation.

could lead to issues if the code depends on the non-pointer representation.

yeah good point - in that case think we cannot use the optional field for compatibility reasons, we gotta change it back and sorry for the initial suggestion😢

So if timeout_seconds is 0 (explicitly or default), should we use 60 seconds instead?

I don't think there's an easy way to distinguish the empty value 0 from explicitly setting it to 0 - so we use 60 seconds when it's zero.

itest/lnd_amp_test.go

NishantBansal2003 · 2024-12-23T06:24:19Z

Hey @yyforyongyu, I’ve made the required modifications. Please take a look.

lightninglabs-deploy · 2024-12-30T06:37:53Z

@yyforyongyu: review reminder
@NishantBansal2003, remember to re-request review from reviewers when ready

NishantBansal2003 · 2025-01-03T17:31:07Z

@yyforyongyu: review reminder @NishantBansal2003, remember to re-request review from reviewers when ready

Hey @yyforyongyu, just following up to see if there are any additional reviews pending on this PR?

cmd/commands/cmd_payments.go

docs/release-notes/release-notes-0.19.0.md

lnrpc/routerrpc/router_server.go

yyforyongyu · 2025-01-10T08:04:13Z

lnrpc/routerrpc/router.proto

+    An optional upper limit on the amount of time we should spend when
+    attempting to fulfill the payment. This is expressed in seconds. If we
+    cannot make a successful payment within this time frame, an error will be
+    returned. This field must be non-zero.


hmm now that you mention it I think there still might be a compatibility issue re the new optional field, as it may break users' Go code since it now expects TimeoutSeconds to be a pointer? If they haven't set the field then it's fine I think.

yyforyongyu

One last comment, then it should be good to go!

yyforyongyu · 2025-01-15T13:01:44Z

lnrpc/routerrpc/router.proto

+    An optional limit on the amount of time before new payment attempts are
+    submitted, expressed in seconds. If the timeout is reached, an ongoing
+    payment attempt with pending HTLCs might still be in flight. However, the
+    SendPaymentV2 call will return. If the field is not set or is set to zero,


I dont think SendPaymentV2 will return if there are inflight HTLCs

Is this the correct definition for timeout_seconds?

An optional limit on the time, expressed in seconds, before new payment attempts are submitted. If the timeout is reached, ongoing payment attempts with pending HTLCs may continue, and the SendPaymentV2 call will remain active until all HTLCs are resolved or the payment succeeds or fails. If a successful payment cannot be completed within this time frame, an error will be returned. If the field is not set or explicitly set to zero, the default value of 60 seconds will be applied.

it's a bit complicated, since we are here, also related to #5461. In short the timeout here has little effect once the HTLCs are sent, as the final state of the payment is determined by the end results of the HTLCs. The only time the timeout takes effect is when the payment has made zero HTLC attempts, which could happen, say, we fail to find a route for the first HTLC in 60s, then the whole payment flow will exit with a timeout error. A more common case is, that when the payment times out, it still has inflight HTLCs, which may be settled or failed eventually, and the SendPaymentV2 will wait until the final outcomes of the HTLCs are reported back. Even if the payment is timed out now, it can still be considered settled if all the HTLCs are settled after 60s.

So I think the accurate description is "the time to wait before attempting the first HTLC. Once HTLCs are inflight, the payment won't be aborted until the HTLCs are settled or failed". I don't think we need to mention SendPaymentV2, as this is also used in send to route RPC.

If timeout_seconds is not set or is 0, the default value of 60 seconds will be used. Signed-off-by: Nishant Bansal <[email protected]>

Signed-off-by: Nishant Bansal <[email protected]>

yyforyongyu

LGTM 🌺

NishantBansal2003 mentioned this pull request Dec 14, 2024

[feature]: add a default value for timeout_seconds in SendPaymentV2 routerrpc.SendPaymentRequest #9282

Closed

NishantBansal2003 force-pushed the fix-timeout branch 2 times, most recently from c5537ef to 18d4ff0 Compare December 14, 2024 18:27

yyforyongyu requested changes Dec 16, 2024

View reviewed changes

lnrpc/routerrpc/router_server.go Outdated Show resolved Hide resolved

NishantBansal2003 requested a review from yyforyongyu December 16, 2024 18:55

saubyk assigned NishantBansal2003 Dec 17, 2024

yyforyongyu reviewed Dec 19, 2024

View reviewed changes

NishantBansal2003 force-pushed the fix-timeout branch 2 times, most recently from 7866d62 to a6bd8c1 Compare December 19, 2024 12:27

NishantBansal2003 requested a review from yyforyongyu December 19, 2024 12:33

saubyk added this to the v0.19.0 milestone Dec 19, 2024

NishantBansal2003 force-pushed the fix-timeout branch 2 times, most recently from d858578 to 2c4b55c Compare December 20, 2024 16:38

yyforyongyu reviewed Jan 10, 2025

View reviewed changes

NishantBansal2003 force-pushed the fix-timeout branch from 2c4b55c to 89d2ab5 Compare January 14, 2025 13:52

NishantBansal2003 requested a review from yyforyongyu January 14, 2025 13:54

yyforyongyu reviewed Jan 15, 2025

View reviewed changes

NishantBansal2003 added 3 commits January 15, 2025 19:45

routerrpc: default timeout_seconds to 60 in SendPaymentV2

b577ad4

If timeout_seconds is not set or is 0, the default value of 60 seconds will be used. Signed-off-by: Nishant Bansal <[email protected]>

itest: update tests with timeout_seconds

23efbef

Signed-off-by: Nishant Bansal <[email protected]>

docs: add release notes.

3a3002e

Signed-off-by: Nishant Bansal <[email protected]>

NishantBansal2003 force-pushed the fix-timeout branch from 89d2ab5 to 3a3002e Compare January 15, 2025 14:22

yyforyongyu approved these changes Jan 16, 2025

View reviewed changes

guggero self-requested a review January 16, 2025 16:34

guggero approved these changes Jan 17, 2025

View reviewed changes

guggero merged commit 27df4af into lightningnetwork:master Jan 17, 2025
33 of 35 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

routerrpc: add a default value for timeout_seconds in SendPaymentV2 #9359

routerrpc: add a default value for timeout_seconds in SendPaymentV2 #9359

NishantBansal2003 commented Dec 14, 2024

coderabbitai bot commented Dec 14, 2024 •

edited

Loading

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

yyforyongyu left a comment

NishantBansal2003 commented Dec 16, 2024

NishantBansal2003 commented Dec 19, 2024 •

edited

Loading

guggero commented Dec 19, 2024

yyforyongyu Dec 19, 2024

NishantBansal2003 Dec 19, 2024

yyforyongyu Dec 20, 2024

NishantBansal2003 Dec 20, 2024

guggero Dec 20, 2024 •

edited

Loading

yyforyongyu Jan 10, 2025

NishantBansal2003 Jan 10, 2025

yyforyongyu Jan 14, 2025

NishantBansal2003 Jan 14, 2025

yyforyongyu Jan 14, 2025

NishantBansal2003 commented Dec 23, 2024

lightninglabs-deploy commented Dec 30, 2024

NishantBansal2003 commented Jan 3, 2025

yyforyongyu Jan 10, 2025

yyforyongyu left a comment

yyforyongyu Jan 15, 2025

NishantBansal2003 Jan 15, 2025

yyforyongyu Jan 15, 2025

yyforyongyu left a comment

routerrpc: add a default value for timeout_seconds in SendPaymentV2 #9359

routerrpc: add a default value for timeout_seconds in SendPaymentV2 #9359

Conversation

NishantBansal2003 commented Dec 14, 2024

Change Description

Steps to Test

Test with explicit timeout_seconds values:

Test without timeout_seconds:

Pull Request Checklist

Testing

Code Style and Documentation

coderabbitai bot commented Dec 14, 2024 • edited Loading

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

yyforyongyu left a comment

Choose a reason for hiding this comment

NishantBansal2003 commented Dec 16, 2024

NishantBansal2003 commented Dec 19, 2024 • edited Loading

guggero commented Dec 19, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

guggero Dec 20, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

NishantBansal2003 commented Dec 23, 2024

lightninglabs-deploy commented Dec 30, 2024

NishantBansal2003 commented Jan 3, 2025

Choose a reason for hiding this comment

yyforyongyu left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

yyforyongyu left a comment

Choose a reason for hiding this comment

coderabbitai bot commented Dec 14, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

NishantBansal2003 commented Dec 19, 2024 •

edited

Loading

guggero Dec 20, 2024 •

edited

Loading