Skip to content

tests: fix flaky listchannels doc example generation#9328

Open
ksedgwic wants to merge 1 commit into
ElementsProject:masterfrom
ksedgwic:fix-doc-examples-listchannels-race
Open

tests: fix flaky listchannels doc example generation#9328
ksedgwic wants to merge 1 commit into
ElementsProject:masterfrom
ksedgwic:fix-doc-examples-listchannels-race

Conversation

@ksedgwic

Copy link
Copy Markdown
Collaborator

The Update examples in doc schemas CI job intermittently fails with the l3->l4 direction of their channel flipping between disabled and enabled in the regenerated listchannels example (channel_flags 3 vs 1, active false vs true). Two occurrences on 2026-07-17 alone, on unrelated PRs (#9286, #9324).

l4's database is deleted to generate the recoverchannel example, after which l3 disables its side of the l3-l4 channel. That disabling channel_update is emitted lazily (via an error reply or the gossip refresh timer), so whether it lands in l3's gossip store before the listchannels snapshot is a race; the committed example captured the post-disable state. Wait for the disable explicitly before snapshotting, matching the wait_for pattern the script already uses for the post-close listchannels races.

Verified by regenerating the examples locally: the listchannels flip no longer appears.

Fixes #9327

…e its l4 channel

The Update examples in doc schemas CI job intermittently fails with the
l3->l4 direction of their channel flipping between disabled and enabled
in the regenerated listchannels example (channel_flags 3 vs 1, active
false vs true).

l4's database is deleted to generate the recoverchannel example, after
which l3 disables its side of the l3-l4 channel.  That disabling
channel_update is emitted lazily (via an error reply or the gossip
refresh timer), so whether it lands in l3's gossip store before the
listchannels snapshot is a race; the committed example captured the
post-disable state.  Wait for the disable explicitly, as the script
already does for the post-close listchannels races.

Fixes: ElementsProject#9327
Changelog-None

@ShahanaFarooqui ShahanaFarooqui left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Ack f718dfe.

@ShahanaFarooqui ShahanaFarooqui added this to the v26.09 milestone Jul 18, 2026
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.

CI flake check-doc-examples (listchannels disabled/enabled race)

2 participants