gui: Fix race in WalletModel::pollBalanceChanged

ryanofsky · ryanofsky · commit bf36a3ccc212 · 2020-02-11T16:53:53.000-05:00
Poll function was wrongly setting cached height to the current chain height instead of the chain height at the time of polling. This bug could cause balances to appear out of date, and was first introduced a0704a8#r378452145 Before that commit, there wasn't a problem because cs_main was held during the poll update. Currently, the problem should be rare. But if 8937d99 from #17954 were merged, the problem would get worse, because the wrong cachedNumBlocks value would be set if the wallet was polled in the interval between a block being connected and it processing the BlockConnected notification. MarcoFalke <falke.marco@gmail.com> also points out that a0704a8 could lead to GUI hangs as well, because previously the pollBalanceChanged method, which runs on the GUI thread, would only make a nonblocking TRY_LOCK(cs_main) call, but after could make blocking LOCK(cs_main) calls, potentially locking up the GUI. Thanks to John Newbery <john@johnnewbery.com> for finding this bug this while reviewing #17954.
diff --git a/src/qt/walletmodel.cpp b/src/qt/walletmodel.cpp
@@ -82,12 +82,12 @@ void WalletModel::pollBalanceChanged()
         return;
     }
 
-    if(fForceCheckBalanceChanged || m_node.getNumBlocks() != cachedNumBlocks)
+    if(fForceCheckBalanceChanged || numBlocks != cachedNumBlocks)
     {
         fForceCheckBalanceChanged = false;
 
         // Balance and number of transactions might have changed
-        cachedNumBlocks = m_node.getNumBlocks();
+        cachedNumBlocks = numBlocks;
 
         checkBalanceChanged(new_balances);
         if(transactionTableModel)

Original file line number	Diff line number	Diff line change
`@@ -82,12 +82,12 @@ void WalletModel::pollBalanceChanged()`
`82`	`82`	`return;`
`83`	`83`	`}`
`84`	`84`
`85`		`- if(fForceCheckBalanceChanged \|\| m_node.getNumBlocks() != cachedNumBlocks)`
	`85`	`+ if(fForceCheckBalanceChanged \|\| numBlocks != cachedNumBlocks)`
`86`	`86`	`{`
`87`	`87`	`fForceCheckBalanceChanged = false;`
`88`	`88`
`89`	`89`	`// Balance and number of transactions might have changed`
`90`		`- cachedNumBlocks = m_node.getNumBlocks();`
	`90`	`+ cachedNumBlocks = numBlocks;`
`91`	`91`
`92`	`92`	`checkBalanceChanged(new_balances);`
`93`	`93`	`if(transactionTableModel)`