Merge pull request #931 from tendermint/785-wal-improvements

[consensus] remove WAL separator

CHANGELOG.md

@@ -30,6 +30,7 @@ BUG FIXES:
 ## 0.14.0 (TBD)
 
 BREAKING CHANGES:
+- consensus/wal: removed separator
 - rpc/client: changed Subscribe/Unsubscribe/UnsubscribeAll funcs signatures to be identical to event bus.
 
 IMPROVEMENTS:

consensus/wal.go

@@ -20,10 +20,6 @@ import (
 //--------------------------------------------------------
 // types and functions for savings consensus messages
 
-var (
-	walSeparator = []byte{55, 127, 6, 130} // 0x377f0682 - magic number
-)
-
 type TimedWALMessage struct {
 	Time time.Time  `json:"time"` // for debugging purposes
 	Msg  WALMessage `json:"msg"`
@@ -195,7 +191,7 @@ func NewWALEncoder(wr io.Writer) *WALEncoder {
 }
 
 // Encode writes the custom encoding of v to the stream.
-func (enc *WALEncoder) Encode(v interface{}) error {
+func (enc *WALEncoder) Encode(v *TimedWALMessage) error {
 	data := wire.BinaryBytes(v)
 
 	crc := crc32.Checksum(data, crc32c)
@@ -209,11 +205,6 @@ func (enc *WALEncoder) Encode(v interface{}) error {
 
 	_, err := enc.wr.Write(msg)
 
-	if err == nil {
-		// TODO [Anton Kaliaev 23 Oct 2017]: remove separator
-		_, err = enc.wr.Write(walSeparator)
-	}
-
 	return err
 }
 
@@ -278,28 +269,9 @@ func (dec *WALDecoder) Decode() (*TimedWALMessage, error) {
 		return nil, fmt.Errorf("failed to decode data: %v", err)
 	}
 
-	// TODO [Anton Kaliaev 23 Oct 2017]: remove separator
-	if err = readSeparator(dec.rd); err != nil {
-		return nil, err
-	}
-
 	return res, err
 }
 
-// readSeparator reads a separator from r. It returns any error from underlying
-// reader or if it's not a separator.
-func readSeparator(r io.Reader) error {
-	b := make([]byte, len(walSeparator))
-	_, err := r.Read(b)
-	if err != nil {
-		return fmt.Errorf("failed to read separator: %v", err)
-	}
-	if !bytes.Equal(b, walSeparator) {
-		return fmt.Errorf("not a separator: %v", b)
-	}
-	return nil
-}
-
 type nilWAL struct{}
 
 func (nilWAL) Save(m WALMessage)  {}

consensus/wal_generator.go

@@ -103,7 +103,7 @@ func makePathname() string {
 	if err != nil {
 		panic(err)
 	}
-	fmt.Println(p)
+	// fmt.Println(p)
 	sep := string(filepath.Separator)
 	return strings.Replace(p, sep, "_", -1)
 }

rpc/test/helpers.go

@@ -51,7 +51,7 @@ func makePathname() string {
 	if err != nil {
 		panic(err)
 	}
-	fmt.Println(p)
+	// fmt.Println(p)
 	sep := string(filepath.Separator)
 	return strings.Replace(p, sep, "_", -1)
 }