code health: extract a msgpack code from the code and tests

The patch replaces the msgpack code by internal wrappers. The msgpack
usage have been extracted to msgpack.go file for the code and to
msgpack_helper_test.go for tests. It is the same logic for submodules.

Part of #124

Author: oleg-jukovec

client_tools.go

@@ -1,16 +1,12 @@
 package tarantool
 
-import (
-	"gopkg.in/vmihailenco/msgpack.v2"
-)
-
 // IntKey is utility type for passing integer key to Select*, Update* and Delete*.
 // It serializes to array with single integer element.
 type IntKey struct {
 	I int
 }
 
-func (k IntKey) EncodeMsgpack(enc *msgpack.Encoder) error {
+func (k IntKey) EncodeMsgpack(enc *encoder) error {
 	enc.EncodeArrayLen(1)
 	enc.EncodeInt(k.I)
 	return nil
@@ -22,7 +18,7 @@ type UintKey struct {
 	I uint
 }
 
-func (k UintKey) EncodeMsgpack(enc *msgpack.Encoder) error {
+func (k UintKey) EncodeMsgpack(enc *encoder) error {
 	enc.EncodeArrayLen(1)
 	enc.EncodeUint(k.I)
 	return nil
@@ -34,7 +30,7 @@ type StringKey struct {
 	S string
 }
 
-func (k StringKey) EncodeMsgpack(enc *msgpack.Encoder) error {
+func (k StringKey) EncodeMsgpack(enc *encoder) error {
 	enc.EncodeArrayLen(1)
 	enc.EncodeString(k.S)
 	return nil
@@ -46,7 +42,7 @@ type IntIntKey struct {
 	I1, I2 int
 }
 
-func (k IntIntKey) EncodeMsgpack(enc *msgpack.Encoder) error {
+func (k IntIntKey) EncodeMsgpack(enc *encoder) error {
 	enc.EncodeArrayLen(2)
 	enc.EncodeInt(k.I1)
 	enc.EncodeInt(k.I2)
@@ -60,7 +56,7 @@ type Op struct {
 	Arg   interface{}
 }
 
-func (o Op) EncodeMsgpack(enc *msgpack.Encoder) error {
+func (o Op) EncodeMsgpack(enc *encoder) error {
 	enc.EncodeArrayLen(3)
 	enc.EncodeString(o.Op)
 	enc.EncodeInt(o.Field)
@@ -148,7 +144,7 @@ type OpSplice struct {
 	Replace string
 }
 
-func (o OpSplice) EncodeMsgpack(enc *msgpack.Encoder) error {
+func (o OpSplice) EncodeMsgpack(enc *encoder) error {
 	enc.EncodeArrayLen(5)
 	enc.EncodeString(o.Op)
 	enc.EncodeInt(o.Field)

connection.go

@@ -15,8 +15,6 @@ import (
 	"sync"
 	"sync/atomic"
 	"time"
-
-	"gopkg.in/vmihailenco/msgpack.v2"
 )
 
 const requestsMap = 128
@@ -142,7 +140,7 @@ type Connection struct {
 	rlimit  chan struct{}
 	opts    Opts
 	state   uint32
-	dec     *msgpack.Decoder
+	dec     *decoder
 	lenbuf  [PacketLengthBytes]byte
 
 	lastStreamId uint64
@@ -199,7 +197,7 @@ type connShard struct {
 	requestsWithCtx [requestsMap]futureList
 	bufmut          sync.Mutex
 	buf             smallWBuf
-	enc             *msgpack.Encoder
+	enc             *encoder
 }
 
 // Greeting is a message sent by Tarantool on connect.
@@ -320,7 +318,7 @@ func Connect(addr string, opts Opts) (conn *Connection, err error) {
 		Greeting:         &Greeting{},
 		control:          make(chan struct{}),
 		opts:             opts,
-		dec:              msgpack.NewDecoder(&smallBuf{}),
+		dec:              newDecoder(&smallBuf{}),
 	}
 	maxprocs := uint32(runtime.GOMAXPROCS(-1))
 	if conn.opts.Concurrency == 0 || conn.opts.Concurrency > maxprocs*128 {
@@ -531,7 +529,7 @@ func (conn *Connection) dial() (err error) {
 	return
 }
 
-func pack(h *smallWBuf, enc *msgpack.Encoder, reqid uint32,
+func pack(h *smallWBuf, enc *encoder, reqid uint32,
 	req Request, streamId uint64, res SchemaResolver) (err error) {
 	hl := h.Len()
 
@@ -569,7 +567,7 @@ func pack(h *smallWBuf, enc *msgpack.Encoder, reqid uint32,
 func (conn *Connection) writeAuthRequest(w *bufio.Writer, scramble []byte) (err error) {
 	var packet smallWBuf
 	req := newAuthRequest(conn.opts.User, string(scramble))
-	err = pack(&packet, msgpack.NewEncoder(&packet), 0, req, ignoreStreamId, conn.Schema)
+	err = pack(&packet, newEncoder(&packet), 0, req, ignoreStreamId, conn.Schema)
 
 	if err != nil {
 		return errors.New("auth: pack error " + err.Error())
@@ -916,7 +914,7 @@ func (conn *Connection) putFuture(fut *Future, req Request, streamId uint64) {
 	firstWritten := shard.buf.Len() == 0
 	if shard.buf.Cap() == 0 {
 		shard.buf.b = make([]byte, 0, 128)
-		shard.enc = msgpack.NewEncoder(&shard.buf)
+		shard.enc = newEncoder(&shard.buf)
 	}
 	blen := shard.buf.Len()
 	reqid := fut.requestId

datetime/datetime.go

@@ -13,8 +13,6 @@ import (
 	"encoding/binary"
 	"fmt"
 	"time"
-
-	"gopkg.in/vmihailenco/msgpack.v2"
 )
 
 // Datetime MessagePack serialization schema is an MP_EXT extension, which
@@ -101,9 +99,6 @@ func (dtime *Datetime) ToTime() time.Time {
 	return dtime.time
 }
 
-var _ msgpack.Marshaler = (*Datetime)(nil)
-var _ msgpack.Unmarshaler = (*Datetime)(nil)
-
 func (dtime *Datetime) MarshalMsgpack() ([]byte, error) {
 	tm := dtime.ToTime()
 
@@ -152,7 +147,3 @@ func (tm *Datetime) UnmarshalMsgpack(b []byte) error {
 	}
 	return err
 }
-
-func init() {
-	msgpack.RegisterExt(datetime_extId, &Datetime{})
-}

datetime/datetime_test.go

@@ -12,7 +12,6 @@ import (
 	. "github.com/tarantool/go-tarantool"
 	. "github.com/tarantool/go-tarantool/datetime"
 	"github.com/tarantool/go-tarantool/test_helpers"
-	"gopkg.in/vmihailenco/msgpack.v2"
 )
 
 var lesserBoundaryTimes = []time.Time{
@@ -270,7 +269,7 @@ type Tuple1 struct {
 	Datetime Datetime
 }
 
-func (t *Tuple1) EncodeMsgpack(e *msgpack.Encoder) error {
+func (t *Tuple1) EncodeMsgpack(e *encoder) error {
 	if err := e.EncodeArrayLen(2); err != nil {
 		return err
 	}
@@ -280,7 +279,7 @@ func (t *Tuple1) EncodeMsgpack(e *msgpack.Encoder) error {
 	return nil
 }
 
-func (t *Tuple1) DecodeMsgpack(d *msgpack.Decoder) error {
+func (t *Tuple1) DecodeMsgpack(d *decoder) error {
 	var err error
 	var l int
 	if l, err = d.DecodeArrayLen(); err != nil {
@@ -296,7 +295,7 @@ func (t *Tuple1) DecodeMsgpack(d *msgpack.Decoder) error {
 	return nil
 }
 
-func (ev *Event) EncodeMsgpack(e *msgpack.Encoder) error {
+func (ev *Event) EncodeMsgpack(e *encoder) error {
 	if err := e.EncodeArrayLen(2); err != nil {
 		return err
 	}
@@ -309,7 +308,7 @@ func (ev *Event) EncodeMsgpack(e *msgpack.Encoder) error {
 	return nil
 }
 
-func (ev *Event) DecodeMsgpack(d *msgpack.Decoder) error {
+func (ev *Event) DecodeMsgpack(d *decoder) error {
 	var err error
 	var l int
 	if l, err = d.DecodeArrayLen(); err != nil {
@@ -329,7 +328,7 @@ func (ev *Event) DecodeMsgpack(d *msgpack.Decoder) error {
 	return nil
 }
 
-func (c *Tuple2) EncodeMsgpack(e *msgpack.Encoder) error {
+func (c *Tuple2) EncodeMsgpack(e *encoder) error {
 	if err := e.EncodeArrayLen(3); err != nil {
 		return err
 	}
@@ -343,7 +342,7 @@ func (c *Tuple2) EncodeMsgpack(e *msgpack.Encoder) error {
 	return nil
 }
 
-func (c *Tuple2) DecodeMsgpack(d *msgpack.Decoder) error {
+func (c *Tuple2) DecodeMsgpack(d *decoder) error {
 	var err error
 	var l int
 	if l, err = d.DecodeArrayLen(); err != nil {
@@ -525,7 +524,7 @@ func TestMPEncode(t *testing.T) {
 			if err != nil {
 				t.Fatalf("Unable to create Datetime from %s: %s", tm, err)
 			}
-			buf, err := msgpack.Marshal(dt)
+			buf, err := marshal(dt)
 			if err != nil {
 				t.Fatalf("Marshalling failed: %s", err.Error())
 			}
@@ -549,7 +548,7 @@ func TestMPDecode(t *testing.T) {
 			}
 			buf, _ := hex.DecodeString(testcase.mpBuf)
 			var v Datetime
-			err = msgpack.Unmarshal(buf, &v)
+			err = unmarshal(buf, &v)
 			if err != nil {
 				t.Fatalf("Unmarshalling failed: %s", err.Error())
 			}

datetime/msgpack.go

@@ -0,0 +1,9 @@
+package datetime
+
+import (
+	"gopkg.in/vmihailenco/msgpack.v2"
+)
+
+func init() {
+	msgpack.RegisterExt(datetime_extId, &Datetime{})
+}

datetime/msgpack_helper_test.go

@@ -0,0 +1,16 @@
+package datetime_test
+
+import (
+	"gopkg.in/vmihailenco/msgpack.v2"
+)
+
+type encoder = msgpack.Encoder
+type decoder = msgpack.Decoder
+
+func marshal(v interface{}) ([]byte, error) {
+	return msgpack.Marshal(v)
+}
+
+func unmarshal(data []byte, v interface{}) error {
+	return msgpack.Unmarshal(data, v)
+}

decimal/decimal.go

@@ -19,7 +19,6 @@ import (
 	"fmt"
 
 	"github.com/shopspring/decimal"
-	"gopkg.in/vmihailenco/msgpack.v2"
 )
 
 // Decimal numbers have 38 digits of precision, that is, the total
@@ -56,9 +55,6 @@ func NewDecimalFromString(src string) (result *Decimal, err error) {
 	return
 }
 
-var _ msgpack.Marshaler = (*Decimal)(nil)
-var _ msgpack.Unmarshaler = (*Decimal)(nil)
-
 func (decNum *Decimal) MarshalMsgpack() ([]byte, error) {
 	one := decimal.NewFromInt(1)
 	maxSupportedDecimal := decimal.New(1, DecimalPrecision).Sub(one) // 10^DecimalPrecision - 1
@@ -99,7 +95,3 @@ func (decNum *Decimal) UnmarshalMsgpack(b []byte) error {
 
 	return nil
 }
-
-func init() {
-	msgpack.RegisterExt(decimalExtID, &Decimal{})
-}

decimal/decimal_test.go

@@ -13,7 +13,6 @@ import (
 	. "github.com/tarantool/go-tarantool"
 	. "github.com/tarantool/go-tarantool/decimal"
 	"github.com/tarantool/go-tarantool/test_helpers"
-	"gopkg.in/vmihailenco/msgpack.v2"
 )
 
 var isDecimalSupported = false
@@ -40,14 +39,14 @@ type TupleDecimal struct {
 	number Decimal
 }
 
-func (t *TupleDecimal) EncodeMsgpack(e *msgpack.Encoder) error {
+func (t *TupleDecimal) EncodeMsgpack(e *encoder) error {
 	if err := e.EncodeArrayLen(1); err != nil {
 		return err
 	}
 	return e.EncodeValue(reflect.ValueOf(&t.number))
 }
 
-func (t *TupleDecimal) DecodeMsgpack(d *msgpack.Decoder) error {
+func (t *TupleDecimal) DecodeMsgpack(d *decoder) error {
 	var err error
 	var l int
 	if l, err = d.DecodeArrayLen(); err != nil {
@@ -144,11 +143,11 @@ func TestMPEncodeDecode(t *testing.T) {
 			}
 			var buf []byte
 			tuple := TupleDecimal{number: *decNum}
-			if buf, err = msgpack.Marshal(&tuple); err != nil {
+			if buf, err = marshal(&tuple); err != nil {
 				t.Fatalf("Failed to encode decimal number '%s' to a MessagePack buffer: %s", testcase.numString, err)
 			}
 			var v TupleDecimal
-			if err = msgpack.Unmarshal(buf, &v); err != nil {
+			if err = unmarshal(buf, &v); err != nil {
 				t.Fatalf("Failed to decode MessagePack buffer '%x' to a decimal number: %s", buf, err)
 			}
 			if !decNum.Equal(v.number.Decimal) {
@@ -247,7 +246,7 @@ func TestEncodeMaxNumber(t *testing.T) {
 	referenceErrMsg := "msgpack: decimal number is bigger than maximum supported number (10^38 - 1)"
 	decNum := decimal.New(1, DecimalPrecision) // // 10^DecimalPrecision
 	tuple := TupleDecimal{number: *NewDecimal(decNum)}
-	_, err := msgpack.Marshal(&tuple)
+	_, err := marshal(&tuple)
 	if err == nil {
 		t.Fatalf("It is possible to encode a number unsupported by Tarantool")
 	}
@@ -261,7 +260,7 @@ func TestEncodeMinNumber(t *testing.T) {
 	two := decimal.NewFromInt(2)
 	decNum := decimal.New(1, DecimalPrecision).Neg().Sub(two) // -10^DecimalPrecision - 2
 	tuple := TupleDecimal{number: *NewDecimal(decNum)}
-	_, err := msgpack.Marshal(&tuple)
+	_, err := marshal(&tuple)
 	if err == nil {
 		t.Fatalf("It is possible to encode a number unsupported by Tarantool")
 	}
@@ -280,10 +279,10 @@ func benchmarkMPEncodeDecode(b *testing.B, src decimal.Decimal, dst interface{})
 	var err error
 	for i := 0; i < b.N; i++ {
 		tuple := TupleDecimal{number: *NewDecimal(src)}
-		if buf, err = msgpack.Marshal(&tuple); err != nil {
+		if buf, err = marshal(&tuple); err != nil {
 			b.Fatal(err)
 		}
-		if err = msgpack.Unmarshal(buf, &v); err != nil {
+		if err = unmarshal(buf, &v); err != nil {
 			b.Fatal(err)
 		}
 	}
@@ -310,7 +309,7 @@ func BenchmarkMPEncodeDecimal(b *testing.B) {
 			}
 			b.ResetTimer()
 			for i := 0; i < b.N; i++ {
-				msgpack.Marshal(decNum)
+				marshal(decNum)
 			}
 		})
 	}
@@ -324,13 +323,13 @@ func BenchmarkMPDecodeDecimal(b *testing.B) {
 				b.Fatal(err)
 			}
 			var buf []byte
-			if buf, err = msgpack.Marshal(decNum); err != nil {
+			if buf, err = marshal(decNum); err != nil {
 				b.Fatal(err)
 			}
 			b.ResetTimer()
 			var v TupleDecimal
 			for i := 0; i < b.N; i++ {
-				msgpack.Unmarshal(buf, &v)
+				unmarshal(buf, &v)
 			}
 
 		})
@@ -417,7 +416,7 @@ func TestMPEncode(t *testing.T) {
 			if err != nil {
 				t.Fatalf("NewDecimalFromString() failed: %s", err.Error())
 			}
-			buf, err := msgpack.Marshal(dec)
+			buf, err := marshal(dec)
 			if err != nil {
 				t.Fatalf("Marshalling failed: %s", err.Error())
 			}
@@ -442,7 +441,7 @@ func TestMPDecode(t *testing.T) {
 				t.Fatalf("hex.DecodeString() failed: %s", err)
 			}
 			var v interface{}
-			err = msgpack.Unmarshal(mpBuf, &v)
+			err = unmarshal(mpBuf, &v)
 			if err != nil {
 				t.Fatalf("Unmarshalling failed: %s", err.Error())
 			}