Added fix for customFieldEncodeValue mishandling non-string values

Author: demeyerthom

.changes/unreleased/Fixed-20230816-143923.yaml

@@ -0,0 +1,3 @@
+kind: Fixed
+body: Fixed custom field encoding with non-string field values
+time: 2023-08-16T14:39:23.454743853+02:00

commercetools/custom_fields.go

@@ -68,17 +68,8 @@ type SetCustomFieldAction interface {
 		platform.CartDiscountSetCustomFieldAction
 }
 
-func CustomFieldCreateFieldContainer(data map[string]any) *platform.FieldContainer {
-	if raw, ok := data["fields"].(map[string]any); ok {
-		fields := platform.FieldContainer(raw)
-		return &fields
-	}
-	return nil
-}
-
 func customFieldEncodeType(t *platform.Type, name string, value any) (any, error) {
-	// Sub-optimal to do this everytime, however performance is not that
-	// important here and impact is neglible
+	// Suboptimal to do this everytime, however performance is not that important here and impact is negligible
 	fieldTypes := map[string]platform.FieldType{}
 	for _, field := range t.FieldDefinitions {
 		fieldTypes[field.Name] = field.Type
@@ -124,7 +115,18 @@ func customFieldEncodeValue(t platform.FieldType, name string, value any) (any,
 
 		result := make([]any, len(values))
 		for i := range values {
-			itemValue, err := customFieldEncodeValue(v.ElementType, name, values[i])
+			var element = values[i]
+			_, ok := element.(string)
+
+			//We need to re-marshal the data here, so we can recursively pass it back to the encoding function
+			if !ok {
+				marshalledValue, err := json.Marshal(values[i])
+				if err != nil {
+					return nil, err
+				}
+				element = string(marshalledValue)
+			}
+			itemValue, err := customFieldEncodeValue(v.ElementType, name, element)
 			if err != nil {
 				return nil, err
 			}
@@ -263,22 +265,22 @@ func CustomFieldUpdateActions[T SetCustomTypeAction, F SetCustomFieldAction](ctx
 		return nil, err
 	}
 
-	old, new := d.GetChange("custom")
-	old_data := firstElementFromSlice(old.([]any))
-	new_data := firstElementFromSlice(new.([]any))
-	old_type_id := old_data["type_id"]
-	new_type_id := new_data["type_id"]
+	oldState, newState := d.GetChange("custom")
+	oldData := firstElementFromSlice(oldState.([]any))
+	newData := firstElementFromSlice(newState.([]any))
+	oldTypeId := oldData["type_id"]
+	newTypeId := newData["type_id"]
 
 	// Remove custom field from resource
-	if new_type_id == nil {
+	if newTypeId == nil {
 		action := T{
 			Type: nil,
 		}
 		return []any{action}, nil
 	}
 
-	if old_type_id == nil || (old_type_id.(string) != new_type_id.(string)) {
-		value, err := CreateCustomFieldDraftRaw(new_data, t)
+	if oldTypeId == nil || (oldTypeId.(string) != newTypeId.(string)) {
+		value, err := CreateCustomFieldDraftRaw(newData, t)
 		if err != nil {
 			return nil, err
 		}
@@ -290,10 +292,10 @@ func CustomFieldUpdateActions[T SetCustomTypeAction, F SetCustomFieldAction](ctx
 	}
 
 	changes := diffSlices(
-		old_data["fields"].(map[string]any),
-		new_data["fields"].(map[string]any))
+		oldData["fields"].(map[string]any),
+		newData["fields"].(map[string]any))
 
-	result := []any{}
+	var result []any
 	for key := range changes {
 		val, err := customFieldEncodeType(t, key, changes[key])
 		if err != nil {

commercetools/custom_fields_test.go

@@ -0,0 +1,68 @@
+package commercetools
+
+import (
+	"github.com/labd/commercetools-go-sdk/platform"
+	"github.com/stretchr/testify/assert"
+	"testing"
+)
+
+var customFieldEncodeValueTests = []struct {
+	typ         any
+	value       any
+	expectedVal any
+	hasError    bool
+}{
+	//CustomFieldLocalizedStringType
+	{typ: platform.CustomFieldLocalizedStringType{}, value: `{"foo":"bar"}`, expectedVal: platform.LocalizedString{"foo": "bar"}},
+	{typ: platform.CustomFieldLocalizedStringType{}, value: `foobar`, hasError: true},
+
+	//CustomFieldBooleanType
+	{typ: platform.CustomFieldBooleanType{}, value: "true", expectedVal: true},
+	{typ: platform.CustomFieldBooleanType{}, value: "false", expectedVal: false},
+	{typ: platform.CustomFieldBooleanType{}, value: "foobar", hasError: true},
+
+	//CustomFieldNumberType
+	{typ: platform.CustomFieldNumberType{}, value: "1", expectedVal: int64(1)},
+	{typ: platform.CustomFieldNumberType{}, value: "foobar", hasError: true},
+
+	//CustomFieldSetType
+	{
+		typ:         platform.CustomFieldSetType{ElementType: platform.CustomFieldStringType{}},
+		value:       `["hello", "world"]`,
+		expectedVal: []interface{}{"hello", "world"},
+	},
+	{
+		typ:         platform.CustomFieldSetType{ElementType: platform.CustomFieldNumberType{}},
+		value:       `[1, 2]`,
+		expectedVal: []interface{}{int64(1), int64(2)},
+	},
+	{
+		typ:   platform.CustomFieldSetType{ElementType: platform.CustomFieldReferenceType{}},
+		value: `[{"id":"98edd6e4-1702-45d5-8bc0-bbb792a4a839","typeId":"zone"},{"id":"8a8efb57-71d3-4a8d-aa77-4d4e6df9ef2a","typeId":"zone"}]`,
+		expectedVal: []interface{}{
+			map[string]interface{}{"id": "98edd6e4-1702-45d5-8bc0-bbb792a4a839", "typeId": "zone"},
+			map[string]interface{}{"id": "8a8efb57-71d3-4a8d-aa77-4d4e6df9ef2a", "typeId": "zone"},
+		},
+	},
+
+	//CustomFieldReferenceType
+	{
+		typ:         platform.CustomFieldReferenceType{},
+		value:       `{"id":"98edd6e4-1702-45d5-8bc0-bbb792a4a839","typeId":"zone"}`,
+		expectedVal: map[string]interface{}{"id": "98edd6e4-1702-45d5-8bc0-bbb792a4a839", "typeId": "zone"},
+	},
+}
+
+func TestCustomFieldEncodeValue(t *testing.T) {
+	for _, tt := range customFieldEncodeValueTests {
+		t.Run("TestCustomFieldEncodeValue", func(t *testing.T) {
+			encodedValue, err := customFieldEncodeValue(tt.typ, "some_field", tt.value)
+			if tt.hasError {
+				assert.Error(t, err)
+			} else {
+				assert.Nil(t, err)
+			}
+			assert.Equal(t, tt.expectedVal, encodedValue)
+		})
+	}
+}