chore: test jsonb

Author: thomaspoignant

dao/dbmodel/feature_flag.go

@@ -1,25 +1,12 @@
 package dbmodel
 
 import (
-	"database/sql/driver"
-	"encoding/json"
 	"time"
 
 	"github.com/go-feature-flag/app-api/model"
 	"github.com/google/uuid"
 )
 
-type JSONB json.RawMessage
-
-func (j JSONB) Value() (driver.Value, error) {
-	valueString, err := json.Marshal(j)
-	return string(valueString), err
-}
-
-func (j *JSONB) Scan(value interface{}) error {
-	return json.Unmarshal(value.([]byte), &j)
-}
-
 type FeatureFlag struct {
 	ID              uuid.UUID      `db:"id"`
 	Name            string         `db:"name"`
@@ -41,36 +28,26 @@ func FromModelFeatureFlag(mff model.FeatureFlag) (FeatureFlag, error) {
 	if err != nil {
 		return FeatureFlag{}, err
 	}
-
-	variations, err := json.Marshal(mff.Variations)
-	if err != nil {
-		return FeatureFlag{}, err
-	}
-
-	var metadata JSONB
-	if mff.Metadata != nil {
-		metadataBytes, err := json.Marshal(mff.Metadata)
-		if err != nil {
-			return FeatureFlag{}, err
-		}
-		metadata = JSONB(metadataBytes)
-	}
-
-	return FeatureFlag{
+	ff := FeatureFlag{
 		ID:              id,
 		Name:            mff.Name,
 		Description:     mff.Description,
-		Variations:      JSONB(variations),
 		Type:            mff.VariationType,
 		BucketingKey:    mff.BucketingKey,
-		Metadata:        metadata,
 		TrackEvents:     mff.TrackEvents,
 		Disable:         mff.Disable,
 		Version:         mff.Version,
 		CreatedDate:     mff.CreatedDate,
 		LastUpdatedDate: mff.LastUpdatedDate,
 		LastModifiedBy:  mff.LastModifiedBy,
-	}, nil
+	}
+	if mff.Variations != nil {
+		ff.Variations = JSONB(*mff.Variations)
+	}
+	if mff.Metadata != nil {
+		ff.Metadata = JSONB(*mff.Metadata)
+	}
+	return ff, nil
 }
 
 func (ff *FeatureFlag) ToModelFeatureFlag(rules []Rule) (model.FeatureFlag, error) {
@@ -87,19 +64,14 @@ func (ff *FeatureFlag) ToModelFeatureFlag(rules []Rule) (model.FeatureFlag, erro
 		}
 		apiRules = append(apiRules, convertedRule)
 	}
-
-	var variations map[string]*interface{}
-	err := json.Unmarshal(ff.Variations, &variations)
-	if err != nil {
-		return model.FeatureFlag{}, err
+	variations := make(map[string]interface{})
+	if ff.Variations != nil {
+		variations = ff.Variations
 	}
-
-	var metadata map[string]interface{}
-	err = json.Unmarshal(ff.Metadata, &metadata)
-	if err != nil {
-		return model.FeatureFlag{}, err
+	metadata := make(map[string]interface{})
+	if ff.Metadata != nil {
+		metadata = ff.Metadata
 	}
-
 	return model.FeatureFlag{
 		ID:              ff.ID.String(),
 		Name:            ff.Name,

dao/dbmodel/jsonb.go

@@ -0,0 +1,22 @@
+package dbmodel
+
+import (
+	"database/sql/driver"
+	"encoding/json"
+	"errors"
+)
+
+type JSONB map[string]interface{}
+
+func (a JSONB) Value() (driver.Value, error) {
+	return json.Marshal(a)
+}
+
+func (a *JSONB) Scan(value interface{}) error {
+	b, ok := value.([]byte)
+	if !ok {
+		return errors.New("type assertion to []byte failed")
+	}
+
+	return json.Unmarshal(b, &a)
+}

dao/dbmodel/jsonb_test.go

@@ -0,0 +1,40 @@
+package dbmodel_test
+
+import (
+	"encoding/json"
+	"testing"
+
+	"github.com/go-feature-flag/app-api/dao/dbmodel"
+	_ "github.com/lib/pq"
+	"github.com/stretchr/testify/assert"
+)
+
+var theTestMap = map[string]interface{}{
+	"key":         "value",
+	"another_key": "another_value",
+	"nested_key": map[string]interface{}{
+		"child_key": "child_value",
+	},
+}
+
+var theTestString = `{"field":{"another_key":"another_value","key":"value","nested_key":{"child_key":"child_value"}}}`
+
+type TestStruct struct {
+	Field dbmodel.JSONB `json:"field"`
+}
+
+func TestJSONBMarshalling(t *testing.T) {
+	theTest := TestStruct{
+		Field: theTestMap,
+	}
+	b, err := json.Marshal(theTest)
+	assert.Nil(t, err)
+	assert.Equal(t, theTestString, string(b))
+}
+
+func TestJSONBUnmarshalling(t *testing.T) {
+	theTest := TestStruct{}
+	err := json.Unmarshal([]byte(theTestString), &theTest)
+	assert.Nil(t, err)
+	assert.Equal(t, dbmodel.JSONB(theTestMap), theTest.Field)
+}

model/flags.go

@@ -24,7 +24,7 @@ type FeatureFlag struct {
 	VariationType   FlagType  `json:"type" db:"type"`
 	// Variations are all the variations available for this flag. The minimum is 2 variations and, we don't have any max
 	// limit except if the variationValue is a bool, the max is 2.
-	Variations *map[string]*interface{} `json:"variations,omitempty"`
+	Variations *map[string]interface{} `json:"variations,omitempty"`
 
 	// Rules is the list of Rule for this flag.
 	// This an optional field.