lightning-block-sync: Fix synchronize_listeners always calling default implementation
#3354
Conversation
Previously, the `ChainListenerSet` `Listen` implementation wouldn't forward to the listeners `block_connected` implementation outside of tests. This would result in the default implementation of `Listen::block_connected` being used and the listeners implementation never being called.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #3354 +/- ##
==========================================
- Coverage 89.61% 89.61% -0.01%
==========================================
Files 127 127
Lines 103531 103531
Branches 103531 103531
==========================================
- Hits 92782 92779 -3
+ Misses 8052 8048 -4
- Partials 2697 2704 +7 ☔ View full report in Codecov by Sentry. |
| // Needed to differentiate test expectations. | ||
| #[cfg(test)] |
There was a problem hiding this comment.
It looks like it was calling each listener's filtered_block_connected method, though, instead of block_connected. Is that a problem? Not clear from the commit message why.
There was a problem hiding this comment.
As also discussed offline, the issue here is that the overridden Listen::block_connected implementation would never be called for the listeners. I.e., if they implement some behavior diverging from the default implementation, it would never be used which is clearly a bug.
If we don't expect users to override block_connected, it shouldn't be a trait method in the first place, IMO. Although I really think we should allow it (as we'll now also require it for LDK Node onchain wallet's listener).
We previously discovered a minor bug that resulted in `synchronize_listeners` not calling the actual implementation of `Listen::block_connected`. While we will fix this upstream (lightningdevkit/rust-lightning#3354), we now copy over the fixed code in question to not be blocked on the next LDK release. We also slightly adjusted it to account for types/APIs that are only visible inside of `lightning-block-sync`. We intend to drop the newly added module as soon as we can upgrade to the next LDK release shipping the fixed version.
Previously, the
ChainListenerSetListenimplementation wouldn't forward to the listenersblock_connectedimplementation outside of tests. This would result in the default implementation ofListen::block_connectedbeing used and the listeners implementation never being called.