Support UUID type in msgpack

This patch provides UUID support for all space operations and as
function return result. UUID type was introduced in Tarantool 2.4.1.
See more in commit messages:
tarantool/tarantool@d68fc29


Closes #90

Author: DifferentialOrange

config.lua

@@ -61,3 +61,24 @@ console.listen '0.0.0.0:33015'
 
 --box.schema.user.revoke('guest', 'read,write,execute', 'universe')
 
+-- Create space with UUID pk if supported
+local uuid = require('uuid')
+local msgpack = require('msgpack')
+
+local uuid_msgpack_supported = pcall(msgpack.encode, uuid.new())
+if uuid_msgpack_supported then
+    local suuid = box.schema.space.create('testUUID', {
+        id = 524,
+        if_not_exists = true,
+    })
+    suuid:create_index('primary', {
+        type = 'tree',
+        parts = {{ field = 1, type = 'uuid' }},
+        if_not_exists = true
+    })
+    suuid:truncate()
+
+    box.schema.user.grant('test', 'read,write', 'space', 'testUUID', { if_not_exists = true })
+
+    suuid:insert({ uuid.fromstr("c8f0fa1f-da29-438c-a040-393f1126ad39") })
+end

go.mod

@@ -3,8 +3,9 @@ module github.com/tarantool/go-tarantool
 go 1.11
 
 require (
+	github.com/google/uuid v1.3.0
 	github.com/niemeyer/pretty v0.0.0-20200227124842-a10e7caefd8e // indirect
-	google.golang.org/appengine v1.6.6 // indirect
+	google.golang.org/appengine v1.6.7 // indirect
 	gopkg.in/check.v1 v1.0.0-20200227125254-8fa46927fb4f // indirect
-	gopkg.in/vmihailenco/msgpack.v2 v2.9.1
+	gopkg.in/vmihailenco/msgpack.v2 v2.9.2
 )

go.sum

@@ -1,5 +1,7 @@
 github.com/golang/protobuf v1.3.1 h1:YF8+flBXS5eO826T4nzqPrxfhQThhXl0YzfuUPu4SBg=
 github.com/golang/protobuf v1.3.1/go.mod h1:6lQm79b+lXiMfvg/cZm0SGofjICqVBUtrP5yJMmIC1U=
+github.com/google/uuid v1.3.0 h1:t6JiXgmwXMjEs8VusXIJk2BXHsn+wx8BZdTaoZ5fu7I=
+github.com/google/uuid v1.3.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
 github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ=
 github.com/kr/text v0.1.0 h1:45sCR5RtlFHMR4UwH9sdQ5TC8v0qDQCHnXt+kaKSTVE=
 github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI=
@@ -12,9 +14,9 @@ golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5h
 golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
 golang.org/x/text v0.3.2/go.mod h1:bEr9sfX3Q8Zfm5fL9x+3itogRgK3+ptLWKqgva+5dAk=
 golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=
-google.golang.org/appengine v1.6.6 h1:lMO5rYAqUxkmaj76jAkRUvt5JZgFymx/+Q5Mzfivuhc=
-google.golang.org/appengine v1.6.6/go.mod h1:8WjMMxjGQR8xUklV/ARdw2HLXBOI7O7uCIDZVag1xfc=
+google.golang.org/appengine v1.6.7 h1:FZR1q0exgwxzPzp/aF+VccGrSfxfPpkBqjIIEq3ru6c=
+google.golang.org/appengine v1.6.7/go.mod h1:8WjMMxjGQR8xUklV/ARdw2HLXBOI7O7uCIDZVag1xfc=
 gopkg.in/check.v1 v1.0.0-20200227125254-8fa46927fb4f h1:BLraFXnmrev5lT+xlilqcH8XK9/i0At2xKjWk4p6zsU=
 gopkg.in/check.v1 v1.0.0-20200227125254-8fa46927fb4f/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
-gopkg.in/vmihailenco/msgpack.v2 v2.9.1 h1:kb0VV7NuIojvRfzwslQeP3yArBqJHW9tOl4t38VS1jM=
-gopkg.in/vmihailenco/msgpack.v2 v2.9.1/go.mod h1:/3Dn1Npt9+MYyLpYYXjInO/5jvMLamn+AEGwNEOatn8=
+gopkg.in/vmihailenco/msgpack.v2 v2.9.2 h1:gjPqo9orRVlSAH/065qw3MsFCDpH7fa1KpiizXyllY4=
+gopkg.in/vmihailenco/msgpack.v2 v2.9.2/go.mod h1:/3Dn1Npt9+MYyLpYYXjInO/5jvMLamn+AEGwNEOatn8=

msgpack_ext.go

@@ -0,0 +1,57 @@
+package tarantool
+
+import (
+	"fmt"
+	"reflect"
+
+	"github.com/google/uuid"
+	"gopkg.in/vmihailenco/msgpack.v2"
+)
+
+// UUID external type
+// Supported since Tarantool 2.4.1. See more in commit messages.
+// https://github.com/tarantool/tarantool/commit/d68fc29246714eee505bc9bbcd84a02de17972c5
+
+const UUID_extId = 2
+
+func encodeUUID(e *msgpack.Encoder, v reflect.Value) error {
+	id := v.Interface().(uuid.UUID)
+
+	bytes, err := id.MarshalBinary()
+	if err != nil {
+		return fmt.Errorf("msgpack: can't marshal binary uuid: %w", err)
+	}
+
+	_, err = e.Writer().Write(bytes)
+	if err != nil {
+		return fmt.Errorf("msgpack: can't write bytes to encoder writer: %w", err)
+	}
+
+	return nil
+}
+
+func decodeUUID(d *msgpack.Decoder, v reflect.Value) error {
+	var bytesCount int = 16;
+	bytes := make([]byte, bytesCount)
+
+	n, err := d.Buffered().Read(bytes)
+	if err != nil {
+		return fmt.Errorf("msgpack: can't read bytes on uuid decode: %w", err)
+	}
+	if n < bytesCount {
+		return fmt.Errorf("msgpack: invalid uuid bytes count %d instead of %d", n, bytesCount)
+	}
+
+	id, err := uuid.FromBytes(bytes)
+	if err != nil {
+		return fmt.Errorf("msgpack: can't create uuid from bytes: %w", err)
+	}
+
+	v.Set(reflect.ValueOf(id))
+	return nil
+}
+
+func init() {
+	msgpack.Register(reflect.TypeOf((*uuid.UUID)(nil)).Elem(), encodeUUID, decodeUUID)
+	msgpack.RegisterExt(UUID_extId, (*uuid.UUID)(nil))
+}

tarantool_test.go

@@ -9,6 +9,7 @@ import (
 
 	. "github.com/tarantool/go-tarantool"
 	"gopkg.in/vmihailenco/msgpack.v2"
+	"github.com/google/uuid"
 )
 
 type Member struct {
@@ -1005,3 +1006,119 @@ func TestComplexStructs(t *testing.T) {
 		return
 	}
 }
+
+
+var uuidSpace = "testUUID"
+var uuidIndex = "primary"
+
+type TupleUUID struct {
+	id uuid.UUID
+}
+
+func (t *TupleUUID) DecodeMsgpack(d *msgpack.Decoder) error {
+	var err error
+	var l int
+	if l, err = d.DecodeSliceLen(); err != nil {
+		return err
+	}
+	if l != 1 {
+		return fmt.Errorf("array len doesn't match: %d", l)
+	}
+	res, err := d.DecodeInterface()
+	if err != nil {
+		return err
+	}
+	t.id = res.(uuid.UUID)
+	return nil
+}
+
+func connectWithValidation(t *testing.T) *Connection {
+	conn, err := Connect(server, opts)
+	if err != nil {
+		t.Errorf("Failed to connect: %s", err.Error())
+	}
+	if conn == nil {
+		t.Errorf("conn is nil after Connect")
+	}
+	return conn
+}
+
+func skipIfUUIDUnsupported(t *testing.T, conn *Connection) {
+	resp, err := conn.Eval("return pcall(require('msgpack').encode, require('uuid').new())", []interface{}{})
+	if err != nil {
+		t.Errorf("Failed to Eval: %s", err.Error())
+	}
+	if resp == nil {
+		t.Errorf("Response is nil after Eval")
+	}
+	if len(resp.Data) < 1 {
+		t.Errorf("Response.Data is empty after Eval")
+	}
+	val := resp.Data[0].(bool)
+	if val != true {
+		t.Skip("Skipping test for Tarantool without UUID support in msgpack")
+	}
+}
+
+func TestUUIDselect(t *testing.T) {
+	conn := connectWithValidation(t)
+	defer conn.Close()
+
+	skipIfUUIDUnsupported(t, conn)
+
+	id, uuidErr := uuid.Parse("c8f0fa1f-da29-438c-a040-393f1126ad39")
+	if uuidErr != nil {
+		t.Errorf("Failed to prepare test uuid: %s", uuidErr)
+	}
+
+	resp, errSel := conn.Select(uuidSpace, uuidIndex, 0, 1, IterEq, []interface{}{ id })
+	if errSel != nil {
+		t.Errorf("UUID select failed: %s", errSel.Error())
+	}
+	if resp == nil {
+		t.Errorf("Response is nil after Select")
+	}
+	if len(resp.Data) != 1 {
+		t.Errorf("Response Data len != 1")
+	}
+
+	var tuples []TupleUUID
+	errTyp := conn.SelectTyped(uuidSpace, uuidIndex, 0, 1, IterEq, []interface{}{ id }, &tuples)
+	if errTyp != nil {
+		t.Errorf("Failed to SelectTyped: %s", errTyp.Error())
+	}
+	if len(tuples) != 1 {
+		t.Errorf("Result len of SelectTyped != 1")
+	}
+	if tuples[0].id != id {
+		t.Errorf("Bad value loaded from SelectTyped: %s", tuples[0].id)
+	}
+}
+
+func TestUUIDreplace(t *testing.T) {
+	conn := connectWithValidation(t)
+	defer conn.Close()
+
+	skipIfUUIDUnsupported(t, conn)
+
+	id, uuidErr := uuid.Parse("64d22e4d-ac92-4a23-899a-e59f34af5479")
+	if uuidErr != nil {
+		t.Errorf("Failed to prepare test uuid: %s", uuidErr)
+	}
+
+	_, errRep := conn.Replace(uuidSpace, []interface{}{ id })
+	if errRep != nil {
+		t.Errorf("UUID replace failed: %s", errRep)
+	}
+
+	resp, errSel := conn.Select(uuidSpace, uuidIndex, 0, 1, IterEq, []interface{}{ id })
+	if errSel != nil {
+		t.Errorf("UUID select failed: %s", errSel)
+	}
+	if resp == nil {
+		t.Errorf("Response is nil after Select")
+	}
+	if len(resp.Data) != 1 {
+		t.Errorf("Response Data len != 1")
+	}
+}