fix!: remove duplicate Value field from ResolutionDetail structs (#58)

Signed-off-by: Skye Gill <[email protected]>

Author: skyerus

pkg/openfeature/client.go

@@ -109,7 +109,7 @@ var typeToString = map[Type]string{
 type EvaluationDetails struct {
 	FlagKey  string
 	FlagType Type
-	ResolutionDetail
+	InterfaceResolutionDetail
 }
 
 // BooleanValue return boolean evaluation for flag
@@ -245,7 +245,7 @@ func (c Client) evaluate(
 	evalDetails := EvaluationDetails{
 		FlagKey:  flag,
 		FlagType: flagType,
-		ResolutionDetail: ResolutionDetail{
+		InterfaceResolutionDetail: InterfaceResolutionDetail{
 			Value: defaultValue,
 		},
 	}
@@ -269,26 +269,30 @@ func (c Client) evaluate(
 	}
 
 	flatCtx := flattenContext(evalCtx)
-	var resolution ResolutionDetail
+	var resolution InterfaceResolutionDetail
 	switch flagType {
 	case Object:
 		resolution = api.provider.ObjectEvaluation(flag, defaultValue, flatCtx)
 	case Boolean:
 		defValue := defaultValue.(bool)
 		res := api.provider.BooleanEvaluation(flag, defValue, flatCtx)
-		resolution = res.ResolutionDetail
+		resolution.ResolutionDetail = res.ResolutionDetail
+		resolution.Value = res.Value
 	case String:
 		defValue := defaultValue.(string)
 		res := api.provider.StringEvaluation(flag, defValue, flatCtx)
-		resolution = res.ResolutionDetail
+		resolution.ResolutionDetail = res.ResolutionDetail
+		resolution.Value = res.Value
 	case Float:
 		defValue := defaultValue.(float64)
 		res := api.provider.FloatEvaluation(flag, defValue, flatCtx)
-		resolution = res.ResolutionDetail
+		resolution.ResolutionDetail = res.ResolutionDetail
+		resolution.Value = res.Value
 	case Int:
 		defValue := defaultValue.(int64)
 		res := api.provider.IntEvaluation(flag, defValue, flatCtx)
-		resolution = res.ResolutionDetail
+		resolution.ResolutionDetail = res.ResolutionDetail
+		resolution.Value = res.Value
 	}
 
 	err = resolution.Error()
@@ -302,7 +306,7 @@ func (c Client) evaluate(
 		return evalDetails, err
 	}
 	if resolution.Value != nil {
-		evalDetails.ResolutionDetail = resolution
+		evalDetails.InterfaceResolutionDetail = resolution
 	}
 
 	if err := c.afterHooks(hookCtx, providerInvocationClientApiHooks, evalDetails, options); err != nil {

pkg/openfeature/client_test.go

@@ -224,7 +224,6 @@ func TestRequirement_1_4_9(t *testing.T) {
 			Return(BoolResolutionDetail{
 				Value: false,
 				ResolutionDetail: ResolutionDetail{
-					Value:     false,
 					ErrorCode: "GENERAL",
 					Reason:    "forced test error",
 				},
@@ -260,7 +259,6 @@ func TestRequirement_1_4_9(t *testing.T) {
 			Return(StringResolutionDetail{
 				Value: "foo",
 				ResolutionDetail: ResolutionDetail{
-					Value:     "foo",
 					ErrorCode: "GENERAL",
 					Reason:    "forced test error",
 				},
@@ -296,7 +294,6 @@ func TestRequirement_1_4_9(t *testing.T) {
 			Return(FloatResolutionDetail{
 				Value: 0,
 				ResolutionDetail: ResolutionDetail{
-					Value:     0,
 					ErrorCode: "GENERAL",
 					Reason:    "forced test error",
 				},
@@ -332,7 +329,6 @@ func TestRequirement_1_4_9(t *testing.T) {
 			Return(IntResolutionDetail{
 				Value: 0,
 				ResolutionDetail: ResolutionDetail{
-					Value:     0,
 					ErrorCode: "GENERAL",
 					Reason:    "forced test error",
 				},
@@ -368,10 +364,11 @@ func TestRequirement_1_4_9(t *testing.T) {
 		mockProvider.EXPECT().Metadata().AnyTimes()
 		mockProvider.EXPECT().Hooks().AnyTimes()
 		mockProvider.EXPECT().ObjectEvaluation(flagKey, defaultValue, flatCtx).
-			Return(ResolutionDetail{
-				Value:     obj{foo: "foo"},
-				ErrorCode: "GENERAL",
-				Reason:    "forced test error",
+			Return(InterfaceResolutionDetail{
+				ResolutionDetail: ResolutionDetail{
+					ErrorCode: "GENERAL",
+					Reason:    "forced test error",
+				},
 			}).Times(2)
 		SetProvider(mockProvider)
 
@@ -413,74 +410,6 @@ func TestRequirement_1_4_9(t *testing.T) {
 // The `client` SHOULD transform the `evaluation context` using the `provider's` `context transformer` function
 // if one is defined, before passing the result of the transformation to the provider's flag resolution functions.
 
-func TestClient_ProviderEvaluationReturnsUnexpectedType(t *testing.T) {
-	client := NewClient("test-client")
-
-	t.Run("Boolean", func(t *testing.T) {
-		defer t.Cleanup(initSingleton)
-		ctrl := gomock.NewController(t)
-		mockProvider := NewMockFeatureProvider(ctrl)
-		mockProvider.EXPECT().Metadata().AnyTimes()
-		SetProvider(mockProvider)
-		mockProvider.EXPECT().Hooks().AnyTimes()
-		mockProvider.EXPECT().BooleanEvaluation(gomock.Any(), gomock.Any(), gomock.Any()).
-			Return(BoolResolutionDetail{ResolutionDetail: ResolutionDetail{Value: 3}})
-
-		_, err := client.BooleanValue("", false, EvaluationContext{}, EvaluationOptions{})
-		if err == nil {
-			t.Error("expected BooleanValue to return an error, got nil")
-		}
-	})
-
-	t.Run("String", func(t *testing.T) {
-		defer t.Cleanup(initSingleton)
-		ctrl := gomock.NewController(t)
-		mockProvider := NewMockFeatureProvider(ctrl)
-		mockProvider.EXPECT().Metadata().AnyTimes()
-		SetProvider(mockProvider)
-		mockProvider.EXPECT().Hooks().AnyTimes()
-		mockProvider.EXPECT().StringEvaluation(gomock.Any(), gomock.Any(), gomock.Any()).
-			Return(StringResolutionDetail{ResolutionDetail: ResolutionDetail{Value: 3}})
-
-		_, err := client.StringValue("", "", EvaluationContext{}, EvaluationOptions{})
-		if err == nil {
-			t.Error("expected StringValue to return an error, got nil")
-		}
-	})
-
-	t.Run("Float", func(t *testing.T) {
-		defer t.Cleanup(initSingleton)
-		ctrl := gomock.NewController(t)
-		mockProvider := NewMockFeatureProvider(ctrl)
-		mockProvider.EXPECT().Metadata().AnyTimes()
-		SetProvider(mockProvider)
-		mockProvider.EXPECT().Hooks().AnyTimes()
-		mockProvider.EXPECT().FloatEvaluation(gomock.Any(), gomock.Any(), gomock.Any()).
-			Return(FloatResolutionDetail{ResolutionDetail: ResolutionDetail{Value: false}})
-
-		_, err := client.FloatValue("", 3, EvaluationContext{}, EvaluationOptions{})
-		if err == nil {
-			t.Error("expected FloatValue to return an error, got nil")
-		}
-	})
-
-	t.Run("Int", func(t *testing.T) {
-		defer t.Cleanup(initSingleton)
-		ctrl := gomock.NewController(t)
-		mockProvider := NewMockFeatureProvider(ctrl)
-		mockProvider.EXPECT().Metadata().AnyTimes()
-		SetProvider(mockProvider)
-		mockProvider.EXPECT().Hooks().AnyTimes()
-		mockProvider.EXPECT().IntEvaluation(gomock.Any(), gomock.Any(), gomock.Any()).
-			Return(IntResolutionDetail{ResolutionDetail: ResolutionDetail{Value: false}})
-
-		_, err := client.IntValue("", 3, EvaluationContext{}, EvaluationOptions{})
-		if err == nil {
-			t.Error("expected IntValue to return an error, got nil")
-		}
-	})
-}
-
 func TestFlattenContext(t *testing.T) {
 	tests := map[string]struct {
 		inCtx  EvaluationContext

pkg/openfeature/noop_provider.go

@@ -53,11 +53,13 @@ func (e NoopProvider) IntEvaluation(flag string, defaultValue int64, evalCtx map
 }
 
 // ObjectEvaluation returns an object flag
-func (e NoopProvider) ObjectEvaluation(flag string, defaultValue interface{}, evalCtx map[string]interface{}) ResolutionDetail {
-	return ResolutionDetail{
-		Value:   defaultValue,
-		Variant: "default-variant",
-		Reason:  DEFAULT,
+func (e NoopProvider) ObjectEvaluation(flag string, defaultValue interface{}, evalCtx map[string]interface{}) InterfaceResolutionDetail {
+	return InterfaceResolutionDetail{
+		Value: defaultValue,
+		ResolutionDetail: ResolutionDetail{
+			Variant: "default-variant",
+			Reason:  DEFAULT,
+		},
 	}
 }
 

pkg/openfeature/provider.go

@@ -20,7 +20,7 @@ type FeatureProvider interface {
 	StringEvaluation(flag string, defaultValue string, evalCtx map[string]interface{}) StringResolutionDetail
 	FloatEvaluation(flag string, defaultValue float64, evalCtx map[string]interface{}) FloatResolutionDetail
 	IntEvaluation(flag string, defaultValue int64, evalCtx map[string]interface{}) IntResolutionDetail
-	ObjectEvaluation(flag string, defaultValue interface{}, evalCtx map[string]interface{}) ResolutionDetail
+	ObjectEvaluation(flag string, defaultValue interface{}, evalCtx map[string]interface{}) InterfaceResolutionDetail
 	Hooks() []Hook
 }
 
@@ -30,7 +30,6 @@ type FeatureProvider interface {
 // N.B we could use generics but to support older versions of golang for now we will have type specific resolution
 // detail
 type ResolutionDetail struct {
-	Value     interface{}
 	ErrorCode string
 	Reason    string
 	Variant   string
@@ -67,6 +66,12 @@ type IntResolutionDetail struct {
 	ResolutionDetail
 }
 
+// InterfaceResolutionDetail provides a resolution detail with interface{} type
+type InterfaceResolutionDetail struct {
+	Value interface{}
+	ResolutionDetail
+}
+
 // Metadata provides provider name
 type Metadata struct {
 	Name string

pkg/openfeature/provider_mock_test.go

@@ -45,7 +45,7 @@ func TestRequirement_2_2(t *testing.T) {
 		StringEvaluation(flag string, defaultValue string, evalCtx map[string]interface{}) StringResolutionDetail
 		FloatEvaluation(flag string, defaultValue float64, evalCtx map[string]interface{}) FloatResolutionDetail
 		IntEvaluation(flag string, defaultValue int64, evalCtx map[string]interface{}) IntResolutionDetail
-		ObjectEvaluation(flag string, defaultValue interface{}, evalCtx map[string]interface{}) ResolutionDetail
+		ObjectEvaluation(flag string, defaultValue interface{}, evalCtx map[string]interface{}) InterfaceResolutionDetail
 	}
 
 	var mockProviderI interface{} = mockProvider