From 0cd11ad84792a1a8e8beca2ad8475284e0e92323 Mon Sep 17 00:00:00 2001
From: Olaoluwa Osuntokun <laolu32@gmail.com>
Date: Tue, 9 Jul 2024 14:05:33 -0700
Subject: [PATCH] peer: don't stop global msg router

In this commit, we fix a bug that would cause a global message router to
be stopped anytime a peer disconnected. The global msg router only
allows `Start` to be called once, so afterwards, no messages would
properly be routed.
---
 peer/brontide.go | 21 ++++++++++++++++++---
 1 file changed, 18 insertions(+), 3 deletions(-)

diff --git a/peer/brontide.go b/peer/brontide.go
index 311ff0cf31..ebca4d54c5 100644
--- a/peer/brontide.go
+++ b/peer/brontide.go
@@ -559,6 +559,11 @@ type Brontide struct {
 	// new wire messages for handing.
 	msgRouter fn.Option[protofsm.MsgRouter]
 
+	// globalMsgRouter is a flag that indicates whether we have a global
+	// msg router. If so, then we don't worry about stopping the msg router
+	// when a peer disconnects.
+	globalMsgRouter bool
+
 	startReady chan struct{}
 	quit       chan struct{}
 	wg         sync.WaitGroup
@@ -574,6 +579,11 @@ var _ lnpeer.Peer = (*Brontide)(nil)
 func NewBrontide(cfg Config) *Brontide {
 	logPrefix := fmt.Sprintf("Peer(%x):", cfg.PubKeyBytes)
 
+	// We have a global message router if one was passed in via the config.
+	// In this case, we don't need to attempt to tear it down when the peer
+	// is stopped.
+	globalMsgRouter := cfg.MsgRouter.IsSome()
+
 	// We'll either use the msg router instance passed in, or create a new
 	// blank instance.
 	msgRouter := cfg.MsgRouter.Alt(fn.Some[protofsm.MsgRouter](
@@ -603,6 +613,7 @@ func NewBrontide(cfg Config) *Brontide {
 		quit:               make(chan struct{}),
 		log:                build.NewPrefixLog(logPrefix, peerLog),
 		msgRouter:          msgRouter,
+		globalMsgRouter:    globalMsgRouter,
 	}
 
 	if cfg.Conn != nil && cfg.Conn.RemoteAddr() != nil {
@@ -1397,9 +1408,13 @@ func (p *Brontide) Disconnect(reason error) {
 
 	close(p.quit)
 
-	p.msgRouter.WhenSome(func(router protofsm.MsgRouter) {
-		router.Stop()
-	})
+	// If our msg router isn't global (local to this instance), then we'll
+	// stop it. Otherwise, we'll leave it running.
+	if !p.globalMsgRouter {
+		p.msgRouter.WhenSome(func(router protofsm.MsgRouter) {
+			router.Stop()
+		})
+	}
 }
 
 // String returns the string representation of this peer.