Merge pull request #74 from upfluence/florentcarrez/thrift-sql-serializer

SQL Thrift type as binary

Author: DarkMiMolle

go.mod

@@ -34,7 +34,7 @@ require (
 	github.com/upfluence/errors v0.2.9
 	github.com/upfluence/log v0.0.5
 	github.com/upfluence/stats v0.1.4
-	github.com/upfluence/thrift v2.4.4+incompatible
+	github.com/upfluence/thrift v2.6.8+incompatible
 	golang.org/x/exp v0.0.0-20241108190413-2d47ceb2692f
 	golang.org/x/oauth2 v0.19.0
 	golang.org/x/sync v0.9.0
@@ -43,6 +43,8 @@ require (
 	golang.org/x/time v0.3.0
 )
 
+require github.com/upfluence/base v0.1.138
+
 require (
 	github.com/beorn7/perks v1.0.1 // indirect
 	github.com/cespare/xxhash/v2 v2.2.0 // indirect

go.sum

@@ -451,6 +451,8 @@ github.com/ugorji/go v1.1.4/go.mod h1:uQMGLiO92mf5W77hV/PUCpI3pbzQx3CRekS0kk+RGr
 github.com/ugorji/go v1.1.7/go.mod h1:kZn38zHttfInRq0xu/PH0az30d+z6vm202qpg1oXVMw=
 github.com/ugorji/go/codec v0.0.0-20181204163529-d75b2dcb6bc8/go.mod h1:VFNgLljTbGfSG7qAOspJ7OScBnGdDN/yBr0sguwnwf0=
 github.com/ugorji/go/codec v1.1.7/go.mod h1:Ax+UKWsSmolVDwsd+7N3ZtXu+yMGCf907BLYF3GoBXY=
+github.com/upfluence/base v0.1.138 h1:QvYPq0fhSE54AVCr5rsB+pACAP2vVdpr+Yn0r2Ud7yo=
+github.com/upfluence/base v0.1.138/go.mod h1:jjVPOP0HtL6weh6xrqSIo2Mzt+30LIjjr4yK8npiiTM=
 github.com/upfluence/cfg v0.3.5 h1:NoA7vrzPM2gOso58x0H8kEDdDd9TnBJtds6zXCaieI0=
 github.com/upfluence/cfg v0.3.5/go.mod h1:0TzWsboPheOr4WtyZ370j6KuFAkXAS2IqpdVnTYSBSc=
 github.com/upfluence/errors v0.0.0-20210413181856-d161314a8a8c/go.mod h1:WWK5iZiYpEHoLYZV+MZSFsHrnYueCUMwsaEEko7aiTU=
@@ -461,8 +463,8 @@ github.com/upfluence/log v0.0.5 h1:OR7KY6NKfrqvWfXz1nWHEGLtwP+tw1a5x/6hfPBatHU=
 github.com/upfluence/log v0.0.5/go.mod h1:1uMfWKPiN8wDCUtENVcYC0bRrTqMeSyAP5R3P5yWXsc=
 github.com/upfluence/stats v0.1.4 h1:youBJzTz7H2xgXY7okdBauu321Aa/W4SeYQC6g8HHHU=
 github.com/upfluence/stats v0.1.4/go.mod h1:kzquL6D8zXPCcjFgPqq6e/+6lzzglTJZzJ3V7UWf/as=
-github.com/upfluence/thrift v2.4.4+incompatible h1:xmhLcu9nmMcMjZOVzDl95E+Q9NmMQLDQ/gQ3V54tq4Q=
-github.com/upfluence/thrift v2.4.4+incompatible/go.mod h1:3uGdmLrgG2WjEd1pvDN5Rnxlui3lAE1cZHtv+7O337E=
+github.com/upfluence/thrift v2.6.8+incompatible h1:y8wb0oxdKgPfWW+p62lYZkbks3rIvh/IWGS73RwAQ8Y=
+github.com/upfluence/thrift v2.6.8+incompatible/go.mod h1:3uGdmLrgG2WjEd1pvDN5Rnxlui3lAE1cZHtv+7O337E=
 github.com/urfave/cli v1.20.0/go.mod h1:70zkFmudgCuE/ngEzBv17Jvp/497gISqfk5gWijbERA=
 github.com/urfave/cli v1.22.1/go.mod h1:Gos4lmkARVdJ6EkW0WaNv/tZAAMe9V7XWyB60NtXRu0=
 github.com/urfave/negroni v1.0.0/go.mod h1:Meg73S6kFm/4PpbYdq35yYWoCZ9mS/YSx+lKnmiohz4=

thrift/sql/serializing.go

@@ -0,0 +1,65 @@
+package sql
+
+import (
+	"database/sql/driver"
+
+	"github.com/upfluence/errors"
+	"github.com/upfluence/thrift/lib/go/thrift"
+
+	"github.com/upfluence/pkg/thrift/serializer"
+	"github.com/upfluence/pkg/thrift/thriftutil"
+)
+
+var defaultSerializerFactory = serializer.NewTSerializerFactory(
+	thriftutil.BinaryProtocolFactory,
+)
+
+type TStructPtr[T any] interface {
+	thrift.TStruct
+	*T
+}
+
+type NullThrift[T any, PT TStructPtr[T]] struct {
+	Data              PT
+	SerializerFactory *serializer.TSerializerFactory
+}
+
+func (t NullThrift[T, PT]) serializerFactory() *serializer.TSerializerFactory {
+	if t.SerializerFactory == nil {
+		return defaultSerializerFactory
+	}
+
+	return t.SerializerFactory
+}
+
+func (t *NullThrift[T, PT]) Scan(value any) error {
+	if value == nil {
+		t.Data = nil
+
+		return nil
+	}
+
+	data, ok := value.([]byte)
+
+	if !ok {
+		return errors.New("invalid type: expected []byte")
+	}
+
+	if t.Data == nil {
+		t.Data = new(T)
+	}
+
+	return errors.WithStack(
+		t.serializerFactory().GetDeserializer().Read(t.Data, data),
+	)
+}
+
+func (t NullThrift[T, PT]) Value() (driver.Value, error) {
+	if t.Data == nil {
+		return nil, nil // nolint:nilnil
+	}
+
+	data, err := t.serializerFactory().GetSerializer().Write(t.Data)
+
+	return data, errors.WithStack(err)
+}

thrift/sql/serializing_test.go

@@ -0,0 +1,87 @@
+package sql
+
+import (
+	"fmt"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+	"github.com/upfluence/errors"
+	"github.com/upfluence/thrift/lib/go/thrift"
+
+	"github.com/upfluence/pkg/thrift/serializer"
+	"github.com/upfluence/pkg/thrift/thriftutil"
+)
+
+type fakeTStruct struct {
+	value int64
+}
+
+func (t fakeTStruct) Write(p thrift.TProtocol) error {
+	return errors.WithStack(p.WriteI64(t.value))
+}
+
+func (t *fakeTStruct) Read(p thrift.TProtocol) error {
+	val, err := p.ReadI64()
+
+	if err != nil {
+		return errors.WithStack(err)
+	}
+
+	t.value = val
+
+	return nil
+}
+
+func (t *fakeTStruct) String() string {
+	return fmt.Sprint(t.value)
+}
+
+func TestNullableThrift_Scan(t *testing.T) {
+	for _, tt := range []struct {
+		name              string
+		fakeValue         *fakeTStruct
+		serializerFactory *serializer.TSerializerFactory
+	}{
+		{
+			name:      "nil value",
+			fakeValue: nil,
+		},
+		{
+			name: "with value",
+			fakeValue: &fakeTStruct{
+				value: 42,
+			},
+		},
+		{
+			name: "with custom serializer factory",
+			fakeValue: &fakeTStruct{
+				value: 42,
+			},
+			serializerFactory: serializer.NewTSerializerFactory(
+				thriftutil.JSONProtocolFactory,
+			),
+		},
+	} {
+		t.Run(tt.name, func(t *testing.T) {
+			var (
+				s = NullThrift[
+					fakeTStruct,
+					*fakeTStruct,
+				]{
+					Data:              tt.fakeValue,
+					SerializerFactory: tt.serializerFactory,
+				}
+
+				data, err = s.Value()
+			)
+
+			require.NoError(t, err)
+
+			s.Data = nil
+
+			require.NoError(t, s.Scan(data))
+			assert.Equal(t, tt.fakeValue, s.Data)
+		})
+	}
+}