From ee4eb59355718f5a0c9cf3eb91ef08ab1f98f1e1 Mon Sep 17 00:00:00 2001
From: Ethan Buchman <ethan@coinculture.info>
Date: Sun, 20 May 2018 16:44:08 -0400
Subject: [PATCH] update comments

---
 consensus/wal.go  | 21 +++++++++------------
 node/node_test.go |  2 +-
 2 files changed, 10 insertions(+), 13 deletions(-)

diff --git a/consensus/wal.go b/consensus/wal.go
index e9e05fc9..0db0dc50 100644
--- a/consensus/wal.go
+++ b/consensus/wal.go
@@ -110,8 +110,9 @@ func (wal *baseWAL) OnStop() {
 	wal.group.Stop()
 }
 
-// called in newStep and for each receive on the
-// peerMsgQueue and the timoutTicker
+// Write is called in newStep and for each receive on the
+// peerMsgQueue and the timoutTicker.
+// NOTE: does not call fsync()
 func (wal *baseWAL) Write(msg WALMessage) {
 	if wal == nil {
 		return
@@ -119,25 +120,21 @@ func (wal *baseWAL) Write(msg WALMessage) {
 
 	// Write the wal message
 	if err := wal.enc.Encode(&TimedWALMessage{time.Now(), msg}); err != nil {
-		cmn.PanicQ(cmn.Fmt("Error writing msg to consensus wal: %v \n\nMessage: %v", err, msg))
+		panic(cmn.Fmt("Error writing msg to consensus wal: %v \n\nMessage: %v", err, msg))
 	}
 }
 
-// called when we receive a msg from ourselves
-// so that we write to disk before sending signed messages
+// WriteSync is called when we receive a msg from ourselves
+// so that we write to disk before sending signed messages.
+// NOTE: calls fsync()
 func (wal *baseWAL) WriteSync(msg WALMessage) {
 	if wal == nil {
 		return
 	}
 
-	// Write the wal message
-	if err := wal.enc.Encode(&TimedWALMessage{time.Now(), msg}); err != nil {
-		cmn.PanicQ(cmn.Fmt("Error writing msg to consensus wal: %v \n\nMessage: %v", err, msg))
-	}
-
-	// TODO: only flush when necessary
+	wal.Write(msg)
 	if err := wal.group.Flush(); err != nil {
-		cmn.PanicQ(cmn.Fmt("Error flushing consensus wal buf to file. Error: %v \n", err))
+		panic(cmn.Fmt("Error flushing consensus wal buf to file. Error: %v \n", err))
 	}
 }
 
diff --git a/node/node_test.go b/node/node_test.go
index ca539382..cdabdbb3 100644
--- a/node/node_test.go
+++ b/node/node_test.go
@@ -31,7 +31,7 @@ func TestNodeStartStop(t *testing.T) {
 	assert.NoError(t, err)
 	select {
 	case <-blockCh:
-	case <-time.After(5 * time.Second):
+	case <-time.After(10 * time.Second):
 		t.Fatal("timed out waiting for the node to produce a block")
 	}