Merge pull request #9249 from yyforyongyu/fix-shutdown

routing: fix missionControlStore blocks on shutting down

docs/release-notes/release-notes-0.19.0.md

@@ -45,6 +45,9 @@
   back before the commitment tx was confirmed causing potentially force closes
   of the incoming channel.
 
+* [Fixed a bug](https://github.com/lightningnetwork/lnd/pull/9249) found in the
+  mission control store that can block the shutdown process of LND.
+
 # New Features
 ## Functional Enhancements
 ## RPC Additions

routing/missioncontrol_store.go

@@ -50,6 +50,9 @@ type missionControlStore struct {
 	wg   sync.WaitGroup
 	db   missionControlDB
 
+	// TODO(yy): Remove the usage of sync.Cond - we are better off using
+	// channes than a Cond as suggested in the official godoc.
+	//
 	// queueCond is signalled when items are put into the queue.
 	queueCond *sync.Cond
 
@@ -347,15 +350,23 @@ func (b *missionControlStore) run() {
 			// Wait for the queue to not be empty.
 			b.queueCond.L.Lock()
 			for b.queue.Front() == nil {
-				b.queueCond.Wait()
-
+				// To make sure we can properly stop, we must
+				// read the `done` channel first before
+				// attempting to call `Wait()`. This is due to
+				// the fact when `Signal` is called before the
+				// `Wait` call, the `Wait` call will block
+				// indefinitely.
+				//
+				// TODO(yy): replace this with channels.
 				select {
 				case <-b.done:
 					b.queueCond.L.Unlock()
 
 					return
 				default:
 				}
+
+				b.queueCond.Wait()
 			}
 			b.queueCond.L.Unlock()