feat: add getNumberEvaluation method delegating to getDoubleEvaluation (#501)

Signed-off-by: Carla Köberl <[email protected]>

Author: carla-was-not-available

src/main/java/dev/openfeature/sdk/FeatureProvider.java

@@ -15,12 +15,39 @@ default List<Hook> getProviderHooks() {
         return new ArrayList<>();
     }
 
+    /**
+     * Resolves a feature flag value as a {@link Number}.
+     *
+     * @param key          the unique identifier for the flag
+     * @param defaultValue the default value to return if the flag cannot be resolved
+     * @param ctx          the evaluation context containing any relevant information for resolution
+     * @return a {@link ProviderEvaluation} containing the resolved {@code Number} value and additional evaluation details
+     */
+    default ProviderEvaluation<Number> getNumberEvaluation(String key, Number defaultValue, EvaluationContext ctx) {
+        ProviderEvaluation<Double> dep = getDoubleEvaluation(key, defaultValue.doubleValue(), ctx);
+        return new ProviderEvaluation<>(
+                dep.getValue(),
+                dep.getReason(),
+                dep.getVariant(),
+                dep.getErrorCode(),
+                dep.getErrorMessage(),
+                dep.getFlagMetadata());
+    }
+
     ProviderEvaluation<Boolean> getBooleanEvaluation(String key, Boolean defaultValue, EvaluationContext ctx);
 
     ProviderEvaluation<String> getStringEvaluation(String key, String defaultValue, EvaluationContext ctx);
 
+    /**
+     * @deprecated please use {@link #getNumberEvaluation(String, Number, EvaluationContext)}
+     */
+    @Deprecated
     ProviderEvaluation<Integer> getIntegerEvaluation(String key, Integer defaultValue, EvaluationContext ctx);
 
+    /**
+     * @deprecated please use {@link #getNumberEvaluation(String, Number, EvaluationContext)}
+     */
+    @Deprecated
     ProviderEvaluation<Double> getDoubleEvaluation(String key, Double defaultValue, EvaluationContext ctx);
 
     ProviderEvaluation<Value> getObjectEvaluation(String key, Value defaultValue, EvaluationContext ctx);

src/main/java/dev/openfeature/sdk/FlagValueType.java

@@ -3,6 +3,7 @@
 @SuppressWarnings("checkstyle:MissingJavadocType")
 public enum FlagValueType {
     STRING,
+    NUMBER,
     INTEGER,
     DOUBLE,
     OBJECT,

src/main/java/dev/openfeature/sdk/NoOpProvider.java

@@ -41,6 +41,7 @@ public ProviderEvaluation<String> getStringEvaluation(String key, String default
     }
 
     @Override
+    @Deprecated
     public ProviderEvaluation<Integer> getIntegerEvaluation(String key, Integer defaultValue, EvaluationContext ctx) {
         return ProviderEvaluation.<Integer>builder()
                 .value(defaultValue)
@@ -50,6 +51,7 @@ public ProviderEvaluation<Integer> getIntegerEvaluation(String key, Integer defa
     }
 
     @Override
+    @Deprecated
     public ProviderEvaluation<Double> getDoubleEvaluation(String key, Double defaultValue, EvaluationContext ctx) {
         return ProviderEvaluation.<Double>builder()
                 .value(defaultValue)

src/main/java/dev/openfeature/sdk/OpenFeatureClient.java

@@ -287,9 +287,11 @@ private <T> ProviderEvaluation<?> createProviderEvaluation(
             case STRING:
                 return provider.getStringEvaluation(key, (String) defaultValue, invocationContext);
             case INTEGER:
-                return provider.getIntegerEvaluation(key, (Integer) defaultValue, invocationContext);
+                return provider.getNumberEvaluation(key, (Integer) defaultValue, invocationContext);
+            case NUMBER:
+                return provider.getNumberEvaluation(key, (Number) defaultValue, invocationContext);
             case DOUBLE:
-                return provider.getDoubleEvaluation(key, (Double) defaultValue, invocationContext);
+                return provider.getNumberEvaluation(key, (Double) defaultValue, invocationContext);
             case OBJECT:
                 return provider.getObjectEvaluation(key, (Value) defaultValue, invocationContext);
             default:

src/test/java/dev/openfeature/sdk/NoOpProviderTest.java

@@ -41,4 +41,11 @@ void value() {
         ProviderEvaluation<Value> eval = p.getObjectEvaluation("key", s, null);
         assertEquals(s, eval.getValue());
     }
+
+    @Test
+    void noOpNumber() {
+        NoOpProvider p = new NoOpProvider();
+        ProviderEvaluation<Number> eval = p.getNumberEvaluation("key", 123456789L, null);
+        assertEquals(123456789.0, eval.getValue());
+    }
 }

src/test/java/dev/openfeature/sdk/ProviderSpecTest.java

@@ -40,6 +40,9 @@ void flag_value_set() {
         ProviderEvaluation<Integer> int_result = p.getIntegerEvaluation("key", 4, new ImmutableContext());
         assertNotNull(int_result.getValue());
 
+        ProviderEvaluation<Number> number_result = p.getNumberEvaluation("key", 2L, new ImmutableContext());
+        assertNotNull(number_result.getValue());
+
         ProviderEvaluation<Double> double_result = p.getDoubleEvaluation("key", 0.4, new ImmutableContext());
         assertNotNull(double_result.getValue());
 
@@ -97,6 +100,9 @@ void variant_set() {
         ProviderEvaluation<Integer> int_result = p.getIntegerEvaluation("key", 4, new ImmutableContext());
         assertNotNull(int_result.getReason());
 
+        ProviderEvaluation<Number> number_result = p.getNumberEvaluation("key", 2L, new ImmutableContext());
+        assertNotNull(number_result.getReason());
+
         ProviderEvaluation<Double> double_result = p.getDoubleEvaluation("key", 0.4, new ImmutableContext());
         assertNotNull(double_result.getReason());