itest: properly document the known flakes

[yyforyongyu]

The first commit fixes the flake found from this build,

--- FAIL: TestLightningNetworkDaemon (96.69s)
    harness_setup.go:25: Setting up HarnessTest...
    harness_setup.go:38: Prepare the miner and mine blocks to activate segwit...
    harness_setup.go:46: Connecting the miner at 127.0.0.1:10039 with the chain backend...
    --- FAIL: TestLightningNetworkDaemon/tranche05/89-of-271/bitcoind/channel_force_close-wrong_preimage (15.67s)
        harness_node.go:403: Starting node (name=Carol) with PID=12703
        harness_node.go:403: Starting node (name=Alice) with PID=12734
        miner.go:243: 
            	Error Trace:	/home/runner/work/lnd/lnd/lntest/miner/miner.go:243
            	            				/home/runner/work/lnd/lnd/lntest/harness_miner.go:111
            	            				/home/runner/work/lnd/lnd/itest/lnd_channel_force_close_test.go:1387
            	            				/home/runner/work/lnd/lnd/lntest/harness.go:297
            	            				/home/runner/work/lnd/lnd/itest/lnd_test.go:130
            	Error:      	tx was not included in block
            	Test:       	TestLightningNetworkDaemon/tranche05/89-of-271/bitcoind/channel_force_close-wrong_preimage
            	Messages:   	tx:d8860d5465a2885926a71dfe7c290686518853be8c113f39de71c505f704e406, block has:[18bc2e6987d36fe2fc5f556eb4bf6ae9418c2d90cc3844596d6c42bbe059c5d2 0910529677e03e36e9226eb2801bf75ee802929ad5947ce4d976d2ae45c60bf0]
        harness.go:375: finished test: channel_force_close-wrong_preimage, start height=488, end height=499, mined blocks=11
        harness.go:334: test failed, skipped cleanup
    lnd_test.go:138: Failure time: 2025-03-03 15:58:25.772

The rest of the commits are documentations - we want to have one place documenting all the flaky behavior, plus to remind us these need to be fixed. For any future attempt to temporary mitigate a flake, we should always document it in details - which means we should at least describe the possible cause, and how to fix or where to investigate.

[coderabbitai]

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.

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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