feat!: use value for object resolver

toddbaert · toddbaert · commit 5d262470e8ec · 2022-09-09T11:27:29.000-04:00
Signed-off-by: Todd Baert &lt;toddbaert@gmail.com&gt;
diff --git a/src/main/java/dev/openfeature/javasdk/FeatureProvider.java b/src/main/java/dev/openfeature/javasdk/FeatureProvider.java
@@ -21,5 +21,5 @@ default List<Hook> getProviderHooks() {
 
     ProviderEvaluation<Double> getDoubleEvaluation(String key, Double defaultValue, EvaluationContext ctx);
 
-    ProviderEvaluation<Structure> getObjectEvaluation(String key, Structure defaultValue, EvaluationContext ctx);
+    ProviderEvaluation<Value> getObjectEvaluation(String key, Value defaultValue, EvaluationContext ctx);
 }
diff --git a/src/main/java/dev/openfeature/javasdk/Features.java b/src/main/java/dev/openfeature/javasdk/Features.java
@@ -57,19 +57,19 @@ FlagEvaluationDetails<Integer> getIntegerDetails(String key, Integer defaultValu
     FlagEvaluationDetails<Double> getDoubleDetails(String key, Double defaultValue, EvaluationContext ctx,
                                                    FlagEvaluationOptions options);
 
-    Structure getObjectValue(String key, Structure defaultValue);
+    Value getObjectValue(String key, Value defaultValue);
 
-    Structure getObjectValue(String key, Structure defaultValue, EvaluationContext ctx);
+    Value getObjectValue(String key, Value defaultValue, EvaluationContext ctx);
 
-    Structure getObjectValue(String key, Structure defaultValue, EvaluationContext ctx,
+    Value getObjectValue(String key, Value defaultValue, EvaluationContext ctx,
             FlagEvaluationOptions options);
 
-    FlagEvaluationDetails<Structure> getObjectDetails(String key, Structure defaultValue);
+    FlagEvaluationDetails<Value> getObjectDetails(String key, Value defaultValue);
 
-    FlagEvaluationDetails<Structure> getObjectDetails(String key, Structure defaultValue,
+    FlagEvaluationDetails<Value> getObjectDetails(String key, Value defaultValue,
             EvaluationContext ctx);
 
-    FlagEvaluationDetails<Structure> getObjectDetails(String key, Structure defaultValue,
+    FlagEvaluationDetails<Value> getObjectDetails(String key, Value defaultValue,
             EvaluationContext ctx,
             FlagEvaluationOptions options);
 }
diff --git a/src/main/java/dev/openfeature/javasdk/NoOpProvider.java b/src/main/java/dev/openfeature/javasdk/NoOpProvider.java
@@ -57,9 +57,9 @@ public ProviderEvaluation<Double> getDoubleEvaluation(String key, Double default
     }
 
     @Override
-    public ProviderEvaluation<Structure> getObjectEvaluation(String key, Structure defaultValue,
+    public ProviderEvaluation<Value> getObjectEvaluation(String key, Value defaultValue,
                                                          EvaluationContext invocationContext) {
-        return ProviderEvaluation.<Structure>builder()
+        return ProviderEvaluation.<Value>builder()
                 .value(defaultValue)
                 .variant(PASSED_IN_DEFAULT)
                 .reason(Reason.DEFAULT)
diff --git a/src/main/java/dev/openfeature/javasdk/OpenFeatureClient.java b/src/main/java/dev/openfeature/javasdk/OpenFeatureClient.java
@@ -122,7 +122,7 @@ private <T> ProviderEvaluation<?> createProviderEvaluation(
             case DOUBLE:
                 return provider.getDoubleEvaluation(key, (Double) defaultValue, invocationContext);
             case OBJECT:
-                return provider.getObjectEvaluation(key, (Structure) defaultValue, invocationContext);
+                return provider.getObjectEvaluation(key, (Value) defaultValue, invocationContext);
             default:
                 throw new GeneralError("Unknown flag type");
         }
@@ -257,34 +257,34 @@ public FlagEvaluationDetails<Double> getDoubleDetails(String key, Double default
     }
 
     @Override
-    public Structure getObjectValue(String key, Structure defaultValue) {
+    public Value getObjectValue(String key, Value defaultValue) {
         return getObjectDetails(key, defaultValue).getValue();
     }
 
     @Override
-    public Structure getObjectValue(String key, Structure defaultValue, EvaluationContext ctx) {
+    public Value getObjectValue(String key, Value defaultValue, EvaluationContext ctx) {
         return getObjectDetails(key, defaultValue, ctx).getValue();
     }
 
     @Override
-    public Structure getObjectValue(String key, Structure defaultValue, EvaluationContext ctx,
+    public Value getObjectValue(String key, Value defaultValue, EvaluationContext ctx,
             FlagEvaluationOptions options) {
         return getObjectDetails(key, defaultValue, ctx, options).getValue();
     }
 
     @Override
-    public FlagEvaluationDetails<Structure> getObjectDetails(String key, Structure defaultValue) {
+    public FlagEvaluationDetails<Value> getObjectDetails(String key, Value defaultValue) {
         return getObjectDetails(key, defaultValue, null);
     }
 
     @Override
-    public FlagEvaluationDetails<Structure> getObjectDetails(String key, Structure defaultValue,
+    public FlagEvaluationDetails<Value> getObjectDetails(String key, Value defaultValue,
                                 EvaluationContext ctx) {
         return getObjectDetails(key, defaultValue, ctx, FlagEvaluationOptions.builder().build());
     }
 
     @Override
-    public FlagEvaluationDetails<Structure> getObjectDetails(String key, Structure defaultValue, EvaluationContext ctx,
+    public FlagEvaluationDetails<Value> getObjectDetails(String key, Value defaultValue, EvaluationContext ctx,
                                  FlagEvaluationOptions options) {
         return this.evaluateFlag(FlagValueType.OBJECT, key, defaultValue, ctx, options);
     }
diff --git a/src/main/java/dev/openfeature/javasdk/Value.java b/src/main/java/dev/openfeature/javasdk/Value.java
@@ -7,7 +7,7 @@
 import lombok.ToString;
 
 /**
- * Values serve as a return type for provider objects.
+ * Values serve as a generic return type for structure data from providers.
  * Providers may deal in JSON, protobuf, XML or some other data-interchange format.
  * This intermediate representation provides a good medium of exchange.
  */
diff --git a/src/test/java/dev/openfeature/javasdk/AlwaysBrokenProvider.java b/src/test/java/dev/openfeature/javasdk/AlwaysBrokenProvider.java
@@ -33,7 +33,7 @@ public ProviderEvaluation<Double> getDoubleEvaluation(String key, Double default
     }
 
     @Override
-    public ProviderEvaluation<Structure> getObjectEvaluation(String key, Structure defaultValue, EvaluationContext invocationContext) {
+    public ProviderEvaluation<Value> getObjectEvaluation(String key, Value defaultValue, EvaluationContext invocationContext) {
         throw new NotImplementedException("BORK");
     }
 }
diff --git a/src/test/java/dev/openfeature/javasdk/DoSomethingProvider.java b/src/test/java/dev/openfeature/javasdk/DoSomethingProvider.java
@@ -44,9 +44,9 @@ public ProviderEvaluation<Double> getDoubleEvaluation(String key, Double default
     }
 
     @Override
-    public ProviderEvaluation<Structure> getObjectEvaluation(String key, Structure defaultValue, EvaluationContext invocationContext) {
+    public ProviderEvaluation<Value> getObjectEvaluation(String key, Value defaultValue, EvaluationContext invocationContext) {
         savedContext = invocationContext;
-        return ProviderEvaluation.<Structure>builder()
+        return ProviderEvaluation.<Value>builder()
                 .value(null)
                 .build();
     }
diff --git a/src/test/java/dev/openfeature/javasdk/FlagEvaluationSpecTest.java b/src/test/java/dev/openfeature/javasdk/FlagEvaluationSpecTest.java
@@ -115,9 +115,9 @@ private Client _client() {
         assertEquals(40.0, c.getDoubleValue(key, .4, new EvaluationContext()));
         assertEquals(40.0, c.getDoubleValue(key, .4, new EvaluationContext(), FlagEvaluationOptions.builder().build()));
 
-        assertEquals(null, c.getObjectValue(key, new Structure()));
-        assertEquals(null, c.getObjectValue(key, new Structure(), new EvaluationContext()));
-        assertEquals(null, c.getObjectValue(key, new Structure(), new EvaluationContext(), FlagEvaluationOptions.builder().build()));
+        assertEquals(null, c.getObjectValue(key, new Value()));
+        assertEquals(null, c.getObjectValue(key, new Value(), new EvaluationContext()));
+        assertEquals(null, c.getObjectValue(key, new Value(), new EvaluationContext(), FlagEvaluationOptions.builder().build()));
     }
 
     @Specification(number="1.4.1", text="The client MUST provide methods for detailed flag value evaluation with parameters flag key (string, required), default value (boolean | number | string | structure, required), evaluation context (optional), and evaluation options (optional), which returns an evaluation details structure.")
diff --git a/src/test/java/dev/openfeature/javasdk/NoOpProviderTest.java b/src/test/java/dev/openfeature/javasdk/NoOpProviderTest.java
@@ -30,10 +30,10 @@ public class NoOpProviderTest {
         assertEquals(0.4, eval.getValue());
     }
 
-    @Test void structure() {
+    @Test void value() {
         NoOpProvider p = new NoOpProvider();
-        Structure s = new Structure();
-        ProviderEvaluation<Structure> eval = p.getObjectEvaluation("key", s, null);
+        Value s = new Value();
+        ProviderEvaluation<Value> eval = p.getObjectEvaluation("key", s, null);
         assertEquals(s, eval.getValue());
     }
 }
diff --git a/src/test/java/dev/openfeature/javasdk/ProviderSpecTest.java b/src/test/java/dev/openfeature/javasdk/ProviderSpecTest.java
@@ -36,7 +36,7 @@ public class ProviderSpecTest {
         ProviderEvaluation<Boolean> boolean_result = p.getBooleanEvaluation("key", false, new EvaluationContext());
         assertNotNull(boolean_result.getValue());
 
-        ProviderEvaluation<Structure> object_result = p.getObjectEvaluation("key", new Structure(), new EvaluationContext());
+        ProviderEvaluation<Value> object_result = p.getObjectEvaluation("key", new Value(), new EvaluationContext());
         assertNotNull(object_result.getValue());
 
     }

Original file line number	Diff line number	Diff line change
`@@ -21,5 +21,5 @@ default List<Hook> getProviderHooks() {`
`21`	`21`
`22`	`22`	`ProviderEvaluation<Double> getDoubleEvaluation(String key, Double defaultValue, EvaluationContext ctx);`
`23`	`23`
`24`		`- ProviderEvaluation<Structure> getObjectEvaluation(String key, Structure defaultValue, EvaluationContext ctx);`
	`24`	`+ ProviderEvaluation<Value> getObjectEvaluation(String key, Value defaultValue, EvaluationContext ctx);`
`25`	`25`	`}`
Original file line number	Diff line number	Diff line change
`@@ -122,7 +122,7 @@ private <T> ProviderEvaluation<?> createProviderEvaluation(`
`122`	`122`	`case DOUBLE:`
`123`	`123`	`return provider.getDoubleEvaluation(key, (Double) defaultValue, invocationContext);`
`124`	`124`	`case OBJECT:`
`125`		`- return provider.getObjectEvaluation(key, (Structure) defaultValue, invocationContext);`
	`125`	`+ return provider.getObjectEvaluation(key, (Value) defaultValue, invocationContext);`
`126`	`126`	`default:`
`127`	`127`	`throw new GeneralError("Unknown flag type");`
`128`	`128`	`}`
`@@ -257,34 +257,34 @@ public FlagEvaluationDetails<Double> getDoubleDetails(String key, Double default`
`257`	`257`	`}`
`258`	`258`
`259`	`259`	`@Override`
`260`		`- public Structure getObjectValue(String key, Structure defaultValue) {`
	`260`	`+ public Value getObjectValue(String key, Value defaultValue) {`
`261`	`261`	`return getObjectDetails(key, defaultValue).getValue();`
`262`	`262`	`}`
`263`	`263`
`264`	`264`	`@Override`
`265`		`- public Structure getObjectValue(String key, Structure defaultValue, EvaluationContext ctx) {`
	`265`	`+ public Value getObjectValue(String key, Value defaultValue, EvaluationContext ctx) {`
`266`	`266`	`return getObjectDetails(key, defaultValue, ctx).getValue();`
`267`	`267`	`}`
`268`	`268`
`269`	`269`	`@Override`
`270`		`- public Structure getObjectValue(String key, Structure defaultValue, EvaluationContext ctx,`
	`270`	`+ public Value getObjectValue(String key, Value defaultValue, EvaluationContext ctx,`
`271`	`271`	`FlagEvaluationOptions options) {`
`272`	`272`	`return getObjectDetails(key, defaultValue, ctx, options).getValue();`
`273`	`273`	`}`
`274`	`274`
`275`	`275`	`@Override`
`276`		`- public FlagEvaluationDetails<Structure> getObjectDetails(String key, Structure defaultValue) {`
	`276`	`+ public FlagEvaluationDetails<Value> getObjectDetails(String key, Value defaultValue) {`
`277`	`277`	`return getObjectDetails(key, defaultValue, null);`
`278`	`278`	`}`
`279`	`279`
`280`	`280`	`@Override`
`281`		`- public FlagEvaluationDetails<Structure> getObjectDetails(String key, Structure defaultValue,`
	`281`	`+ public FlagEvaluationDetails<Value> getObjectDetails(String key, Value defaultValue,`
`282`	`282`	`EvaluationContext ctx) {`
`283`	`283`	`return getObjectDetails(key, defaultValue, ctx, FlagEvaluationOptions.builder().build());`
`284`	`284`	`}`
`285`	`285`
`286`	`286`	`@Override`
`287`		`- public FlagEvaluationDetails<Structure> getObjectDetails(String key, Structure defaultValue, EvaluationContext ctx,`
	`287`	`+ public FlagEvaluationDetails<Value> getObjectDetails(String key, Value defaultValue, EvaluationContext ctx,`
`288`	`288`	`FlagEvaluationOptions options) {`
`289`	`289`	`return this.evaluateFlag(FlagValueType.OBJECT, key, defaultValue, ctx, options);`
`290`	`290`	`}`
Original file line number	Diff line number	Diff line change
`@@ -33,7 +33,7 @@ public ProviderEvaluation<Double> getDoubleEvaluation(String key, Double default`
`33`	`33`	`}`
`34`	`34`
`35`	`35`	`@Override`
`36`		`- public ProviderEvaluation<Structure> getObjectEvaluation(String key, Structure defaultValue, EvaluationContext invocationContext) {`
	`36`	`+ public ProviderEvaluation<Value> getObjectEvaluation(String key, Value defaultValue, EvaluationContext invocationContext) {`
`37`	`37`	`throw new NotImplementedException("BORK");`
`38`	`38`	`}`
`39`	`39`	`}`
Original file line number	Diff line number	Diff line change
`@@ -44,9 +44,9 @@ public ProviderEvaluation<Double> getDoubleEvaluation(String key, Double default`
`44`	`44`	`}`
`45`	`45`
`46`	`46`	`@Override`
`47`		`- public ProviderEvaluation<Structure> getObjectEvaluation(String key, Structure defaultValue, EvaluationContext invocationContext) {`
	`47`	`+ public ProviderEvaluation<Value> getObjectEvaluation(String key, Value defaultValue, EvaluationContext invocationContext) {`
`48`	`48`	`savedContext = invocationContext;`
`49`		`- return ProviderEvaluation.<Structure>builder()`
	`49`	`+ return ProviderEvaluation.<Value>builder()`
`50`	`50`	`.value(null)`
`51`	`51`	`.build();`
`52`	`52`	`}`
Original file line number	Diff line number	Diff line change
`@@ -30,10 +30,10 @@ public class NoOpProviderTest {`
`30`	`30`	`assertEquals(0.4, eval.getValue());`
`31`	`31`	`}`
`32`	`32`
`33`		`- @Test void structure() {`
	`33`	`+ @Test void value() {`
`34`	`34`	`NoOpProvider p = new NoOpProvider();`
`35`		`- Structure s = new Structure();`
`36`		`- ProviderEvaluation<Structure> eval = p.getObjectEvaluation("key", s, null);`
	`35`	`+ Value s = new Value();`
	`36`	`+ ProviderEvaluation<Value> eval = p.getObjectEvaluation("key", s, null);`
`37`	`37`	`assertEquals(s, eval.getValue());`
`38`	`38`	`}`
`39`	`39`	`}`
Original file line number	Diff line number	Diff line change
`@@ -36,7 +36,7 @@ public class ProviderSpecTest {`
`36`	`36`	`ProviderEvaluation<Boolean> boolean_result = p.getBooleanEvaluation("key", false, new EvaluationContext());`
`37`	`37`	`assertNotNull(boolean_result.getValue());`
`38`	`38`
`39`		`- ProviderEvaluation<Structure> object_result = p.getObjectEvaluation("key", new Structure(), new EvaluationContext());`
	`39`	`+ ProviderEvaluation<Value> object_result = p.getObjectEvaluation("key", new Value(), new EvaluationContext());`
`40`	`40`	`assertNotNull(object_result.getValue());`
`41`	`41`
`42`	`42`	`}`