chainntnfs: remove queued confirmation notification in CancelConf
This addresses a panic when a notification is canceled after its been detected as included in a block and before its confirmation notification is dispatched.
This commit is contained in:
parent
be36776120
commit
69b8a356b2
@ -752,7 +752,21 @@ func (n *TxNotifier) CancelConf(confRequest ConfRequest, confID uint64) {
|
|||||||
close(ntfn.Event.Confirmed)
|
close(ntfn.Event.Confirmed)
|
||||||
close(ntfn.Event.Updates)
|
close(ntfn.Event.Updates)
|
||||||
close(ntfn.Event.NegativeConf)
|
close(ntfn.Event.NegativeConf)
|
||||||
|
|
||||||
|
// Finally, we'll clean up any lingering references to this
|
||||||
|
// notification.
|
||||||
delete(confSet.ntfns, confID)
|
delete(confSet.ntfns, confID)
|
||||||
|
|
||||||
|
// Remove the queued confirmation notification if the transaction has
|
||||||
|
// already confirmed, but hasn't met its required number of
|
||||||
|
// confirmations.
|
||||||
|
if confSet.details != nil {
|
||||||
|
confHeight := confSet.details.BlockHeight +
|
||||||
|
ntfn.NumConfirmations - 1
|
||||||
|
if confHeight <= n.currentHeight {
|
||||||
|
delete(n.ntfnsByConfirmHeight[confHeight], ntfn)
|
||||||
|
}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// UpdateConfDetails attempts to update the confirmation details for an active
|
// UpdateConfDetails attempts to update the confirmation details for an active
|
||||||
|
@ -1138,7 +1138,7 @@ func TestTxNotifierCancelConf(t *testing.T) {
|
|||||||
hintCache := newMockHintCache()
|
hintCache := newMockHintCache()
|
||||||
n := chainntnfs.NewTxNotifier(startingHeight, 100, hintCache, hintCache)
|
n := chainntnfs.NewTxNotifier(startingHeight, 100, hintCache, hintCache)
|
||||||
|
|
||||||
// We'll register two notification requests. Only the second one will be
|
// We'll register three notification requests. The last two will be
|
||||||
// canceled.
|
// canceled.
|
||||||
tx1 := wire.NewMsgTx(1)
|
tx1 := wire.NewMsgTx(1)
|
||||||
tx1.AddTxOut(&wire.TxOut{PkScript: testRawScript})
|
tx1.AddTxOut(&wire.TxOut{PkScript: testRawScript})
|
||||||
@ -1155,8 +1155,15 @@ func TestTxNotifierCancelConf(t *testing.T) {
|
|||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatalf("unable to register spend ntfn: %v", err)
|
t.Fatalf("unable to register spend ntfn: %v", err)
|
||||||
}
|
}
|
||||||
|
ntfn3, err := n.RegisterConf(&tx2Hash, testRawScript, 1, 1)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("unable to register spend ntfn: %v", err)
|
||||||
|
}
|
||||||
|
cancelConfRequest := ntfn2.HistoricalDispatch.ConfRequest
|
||||||
|
|
||||||
// Construct a block that will confirm both transactions.
|
// Extend the chain with a block that will confirm both transactions.
|
||||||
|
// This will queue confirmation notifications to dispatch once their
|
||||||
|
// respective heights have been met.
|
||||||
block := btcutil.NewBlock(&wire.MsgBlock{
|
block := btcutil.NewBlock(&wire.MsgBlock{
|
||||||
Transactions: []*wire.MsgTx{tx1, tx2},
|
Transactions: []*wire.MsgTx{tx1, tx2},
|
||||||
})
|
})
|
||||||
@ -1167,14 +1174,18 @@ func TestTxNotifierCancelConf(t *testing.T) {
|
|||||||
Tx: tx1,
|
Tx: tx1,
|
||||||
}
|
}
|
||||||
|
|
||||||
// Before extending the notifier's tip with the block above, we'll
|
// Cancel the second notification before connecting the block.
|
||||||
// cancel the second request.
|
n.CancelConf(cancelConfRequest, 2)
|
||||||
n.CancelConf(ntfn2.HistoricalDispatch.ConfRequest, 2)
|
|
||||||
|
|
||||||
err = n.ConnectTip(block.Hash(), startingHeight+1, block.Transactions())
|
err = n.ConnectTip(block.Hash(), startingHeight+1, block.Transactions())
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatalf("unable to connect block: %v", err)
|
t.Fatalf("unable to connect block: %v", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Cancel the third notification before notifying to ensure its queued
|
||||||
|
// confirmation notification gets removed as well.
|
||||||
|
n.CancelConf(cancelConfRequest, 3)
|
||||||
|
|
||||||
if err := n.NotifyHeight(startingHeight + 1); err != nil {
|
if err := n.NotifyHeight(startingHeight + 1); err != nil {
|
||||||
t.Fatalf("unable to dispatch notifications: %v", err)
|
t.Fatalf("unable to dispatch notifications: %v", err)
|
||||||
}
|
}
|
||||||
@ -1188,7 +1199,7 @@ func TestTxNotifierCancelConf(t *testing.T) {
|
|||||||
t.Fatalf("expected to receive confirmation notification")
|
t.Fatalf("expected to receive confirmation notification")
|
||||||
}
|
}
|
||||||
|
|
||||||
// The second one, however, should not have. The event's Confirmed
|
// The second and third, however, should not have. The event's Confirmed
|
||||||
// channel must have also been closed to indicate the caller that the
|
// channel must have also been closed to indicate the caller that the
|
||||||
// TxNotifier can no longer fulfill their canceled request.
|
// TxNotifier can no longer fulfill their canceled request.
|
||||||
select {
|
select {
|
||||||
@ -1199,6 +1210,14 @@ func TestTxNotifierCancelConf(t *testing.T) {
|
|||||||
default:
|
default:
|
||||||
t.Fatal("expected Confirmed channel to be closed")
|
t.Fatal("expected Confirmed channel to be closed")
|
||||||
}
|
}
|
||||||
|
select {
|
||||||
|
case _, ok := <-ntfn3.Event.Confirmed:
|
||||||
|
if ok {
|
||||||
|
t.Fatal("expected Confirmed channel to be closed")
|
||||||
|
}
|
||||||
|
default:
|
||||||
|
t.Fatal("expected Confirmed channel to be closed")
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// TestTxNotifierCancelSpend ensures that a spend notification after a client
|
// TestTxNotifierCancelSpend ensures that a spend notification after a client
|
||||||
|
Loading…
Reference in New Issue
Block a user