fix logger channel blocking

ethlog/loggers.go

@@ -39,9 +39,8 @@ func (msg *logMessage) send(logger LogSystem) {
 
 var logMessages chan (*logMessage)
 var logSystems []LogSystem
-var quit chan bool
+var quit chan chan error
 var drained chan bool
-var shutdown chan bool
 var mutex = sync.Mutex{}
 
 type LogLevel uint8
@@ -55,44 +54,54 @@ const (
 	DebugDetailLevel
 )
 
+func dispatch(msg *logMessage) {
+	for _, logSystem := range logSystems {
+		if logSystem.GetLogLevel() >= msg.LogLevel {
+			msg.send(logSystem)
+		}
+	}
+}
+
 // log messages are dispatched to log writers
 func start() {
-out:
 	for {
 		select {
-		case <-quit:
+		case status := <-quit:
-			break out
+			status <- nil
+			return
 		case msg := <-logMessages:
-			for _, logSystem := range logSystems {
+			dispatch(msg)
-				if logSystem.GetLogLevel() >= msg.LogLevel {
+		default:
-					msg.send(logSystem)
+			drained <- true // this blocks until a message is sent to the queue
 		}
 	}
-		case drained <- true:
+}
+
+func send(msg *logMessage) {
+	logMessages <- msg
+	select {
+	case <-drained:
 	default:
-			drained <- true // this blocks until a message is sent to the queu
-		}
 	}
-	close(shutdown)
 }
 
 func Reset() {
 	mutex.Lock()
 	defer mutex.Unlock()
 	if logSystems != nil {
-		quit <- true
+		status := make(chan error)
+		quit <- status
 		select {
 		case <-drained:
+		default:
 		}
-		<-shutdown
+		<-status
 	}
 	logSystems = nil
 }
 
 // waits until log messages are drained (dispatched to log writers)
 func Flush() {
-	mutex.Lock()
-	defer mutex.Unlock()
 	if logSystems != nil {
 		<-drained
 	}
@@ -110,22 +119,14 @@ func AddLogSystem(logSystem LogSystem) {
 	mutex.Lock()
 	defer mutex.Unlock()
 	if logSystems == nil {
-		logMessages = make(chan *logMessage)
+		logMessages = make(chan *logMessage, 5)
-		quit = make(chan bool)
+		quit = make(chan chan error, 1)
 		drained = make(chan bool, 1)
-		shutdown = make(chan bool, 1)
 		go start()
 	}
 	logSystems = append(logSystems, logSystem)
 }
 
-func send(msg *logMessage) {
-	select {
-	case <-drained:
-	}
-	logMessages <- msg
-}
-
 func (logger *Logger) sendln(level LogLevel, v ...interface{}) {
 	if logSystems != nil {
 		send(newPrintlnLogMessage(level, logger.tag, v...))

ethlog/loggers_test.go

@@ -28,6 +28,21 @@ func (t *TestLogSystem) GetLogLevel() LogLevel {
 	return t.level
 }
 
+func TestLoggerFlush(t *testing.T) {
+	logger := NewLogger("TEST")
+	testLogSystem := &TestLogSystem{level: WarnLevel}
+	AddLogSystem(testLogSystem)
+	for i := 0; i < 5; i++ {
+		logger.Errorf(".")
+	}
+	Flush()
+	Reset()
+	output := testLogSystem.Output
+	if output != "[TEST] .[TEST] .[TEST] .[TEST] .[TEST] ." {
+		t.Error("Expected complete logger output '[TEST] .[TEST] .[TEST] .[TEST] .[TEST] .', got ", output)
+	}
+}
+
 func TestLoggerPrintln(t *testing.T) {
 	logger := NewLogger("TEST")
 	testLogSystem := &TestLogSystem{level: WarnLevel}