Start Channel Arbitrators concurrently #9262

ziggie1984 · 2024-11-12T22:18:28Z

Followup of #9253. This makes sure we start the channel arbitrators concurrently with a maximum timeout of 5 min.

coderabbitai · 2024-11-12T22:18:35Z

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

guggero

Nice! Thanks a lot for the fix 🎉

I think we might want to make it configurable, just in case.
Here's my proposal to add a config value (hidden, so we don't have to add it to the sample-lnd.conf file to avoid people messing with it when not necessary):
arb.diff.txt

guggero · 2024-11-13T10:23:59Z

contractcourt/chain_arbitrator.go

@@ -27,6 +28,12 @@ import (
 // ErrChainArbExiting signals that the chain arbitrator is shutting down.
 var ErrChainArbExiting = errors.New("ChainArbitrator exiting")

+const (
+	// chainArbTimeout is the timeout for the chain arbitrator to start
+	// the channel arbitrators for each channel.


We could add some rationale here for why this number is rather high. Something along the lines of: "Because starting arbitrators might depend on resolutions that are done by an external component (e.g. aux component hooks), this might require other lnd subsystems to be fully started. So we need to give everything enough time."

guggero · 2024-11-13T10:26:21Z

contractcourt/chain_arbitrator.go

 	for _, arbitrator := range c.activeChannels {
 		startState, ok := startStates[arbitrator.cfg.ChanPoint]
 		if !ok {
 			stopAndLog()
+
+			// In case we encounter an error we need to cancel the
+			// context to ensure all goroutines are cleaned up.


nit: we don't actually clean up the goroutines yet (or I mean we don't interrupt the arb.Start() yet, we just don't wait for it anymore). So can perhaps add a TODO here that we'll want to eventually add a context to Start() so things will clean up properly on cancel?

Now we clean them up, I think adding a context ist not really the way to go because looking into the startup functionality it does not look like a context might help here.

ziggie1984 · 2024-11-13T12:04:01Z

Ok I think this approach is not really good because you were raising a really good point here @guggero:

go func(arb *ChannelArbitrator) {
			defer wgChannelArb.Done()

			select {
			case channelArbErrs <- arb.Start(startState):

			case <-ctx.Done():
				channelArbErrs <- ctx.Err()

			case <-c.quit:
				channelArbErrs <- ErrChainArbExiting
			}
		}(arbitrator)

This call does block forever when we launch the arb.Start prior timeout, which we very likely will, the starting is not the problem but more the finishing.
Tho looking into the start() function I don't really see an easy way to spawn goroutines which could cancel because of a timeout. I think what we should garantee is, that the call to the external units should be timing out if the call blocks. So I think this change makes no real sense.

ziggie1984 · 2024-11-13T12:06:38Z

By easy way, I don't think it is appropriate design, cancels imo make only sense if we know we spawn goroutines in that function but our problem arises because a function call to a normal subsystem does not timeout, so I think we need to improve there.

ziggie1984 · 2024-11-13T12:15:47Z

what we could do which is the only way it could work is something like this:

      // Create a new goroutine for the actual Start call
        startErrChan := make(chan error, 1)
        go func() {
            startErrChan <- arb.Start(startState)
        }()

        // Wait for either the start to complete or context to be done
        select {
        case err := <-startErrChan:
            channelArbErrs <- err

        case <-ctx.Done():
            // Don't wait for Start to complete if timeout occurs
            channelArbErrs <- ctx.Err()

        case <-c.quit:
            channelArbErrs <- ErrChainArbExiting

basically starting a goroutine in a goroutine. Only then can we really abort after the timeout.

ziggie1984 · 2024-11-13T12:48:52Z

Ok I mean spawning goroutines might not be the best solution here because we need for each startup 2, but I implemented it nonetheless because maybe it will take a while until we have the hooks for external subsystems configurable with timeouts.

ziggie1984 · 2024-11-15T12:12:21Z

@Roasbeef this works as well and resolves the deadlock.

When starting the channel arbitrators we make sure they are started concurrently.

The channel arbitrator startups have now a configurable timeout but this config value is hidden.

ziggie1984 force-pushed the fix-channel-arbitrator-deadlock branch 2 times, most recently from 98664a1 to d68ce0c Compare November 12, 2024 22:29

ziggie1984 marked this pull request as ready for review November 12, 2024 22:44

guggero approved these changes Nov 13, 2024

View reviewed changes

ziggie1984 force-pushed the fix-channel-arbitrator-deadlock branch from 1579cc6 to af4df94 Compare November 13, 2024 12:59

ziggie1984 added 4 commits November 15, 2024 13:42

contractcourt: make channel arb starts async.

0db9138

When starting the channel arbitrators we make sure they are started concurrently.

multi: make timeout configurable

1ca2373

The channel arbitrator startups have now a configurable timeout but this config value is hidden.

contractcourt: use concurrent safe waitGroup.

ae120e3

docs: add release-notes

b0ee865

ziggie1984 force-pushed the fix-channel-arbitrator-deadlock branch from 02ef00d to b0ee865 Compare November 15, 2024 12:43

ziggie1984 requested a review from Roasbeef November 15, 2024 12:43

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Start Channel Arbitrators concurrently #9262

Start Channel Arbitrators concurrently #9262

ziggie1984 commented Nov 12, 2024 •

edited

Loading

coderabbitai bot commented Nov 12, 2024 •

edited

Loading

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

guggero left a comment

guggero Nov 13, 2024

guggero Nov 13, 2024

ziggie1984 Nov 13, 2024

ziggie1984 commented Nov 13, 2024

ziggie1984 commented Nov 13, 2024

ziggie1984 commented Nov 13, 2024 •

edited

Loading

ziggie1984 commented Nov 13, 2024

ziggie1984 commented Nov 15, 2024

Start Channel Arbitrators concurrently #9262

Are you sure you want to change the base?

Start Channel Arbitrators concurrently #9262

Conversation

ziggie1984 commented Nov 12, 2024 • edited Loading

coderabbitai bot commented Nov 12, 2024 • edited Loading

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

guggero left a comment

Choose a reason for hiding this comment

guggero Nov 13, 2024

Choose a reason for hiding this comment

guggero Nov 13, 2024

Choose a reason for hiding this comment

ziggie1984 Nov 13, 2024

Choose a reason for hiding this comment

ziggie1984 commented Nov 13, 2024

ziggie1984 commented Nov 13, 2024

ziggie1984 commented Nov 13, 2024 • edited Loading

ziggie1984 commented Nov 13, 2024

ziggie1984 commented Nov 15, 2024

ziggie1984 commented Nov 12, 2024 •

edited

Loading

coderabbitai bot commented Nov 12, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

ziggie1984 commented Nov 13, 2024 •

edited

Loading