Merge pull request #270 from blinklabs-io/fix/muxer-stop-deadlock

fix: close connection on muxer stop

Author: agaffney

internal/test/ouroboros_mock/connection.go

@@ -70,6 +70,7 @@ func (c *Connection) Write(b []byte) (n int, err error) {
 
 // Close closes both sides of the connection. This is needed to satisfy the net.Conn interface
 func (c *Connection) Close() error {
+	c.muxer.Stop()
 	if err := c.conn.Close(); err != nil {
 		return err
 	}

muxer/muxer.go

@@ -88,6 +88,9 @@ func (m *Muxer) Stop() {
 	m.onceStop.Do(func() {
 		// Close doneChan to signify that we're shutting down
 		close(m.doneChan)
+		// Close underlying connection
+		// We must do this to break out of pending Read() calls to shut down cleanly
+		_ = m.conn.Close()
 		// Wait for other goroutines to shutdown
 		m.waitGroup.Wait()
 		// Close protocol receive channels

ouroboros.go

@@ -138,12 +138,6 @@ func (o *Ouroboros) Close() error {
 		if o.muxer != nil {
 			o.muxer.Stop()
 		}
-		// Close the underlying connection
-		if o.conn != nil {
-			if err = o.conn.Close(); err != nil {
-				return
-			}
-		}
 		// Wait for other goroutines to finish
 		o.waitGroup.Wait()
 		// Close channels