fix: adding reason, and removing stacktraces from errors

Signed-off-by: Simon Schrottner <[email protected]>

Author: aepfli

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

@@ -135,7 +135,7 @@ private <T> FlagEvaluationDetails<T> evaluateFlag(FlagValueType type, String key
                 OpenFeatureError error = ExceptionUtils.instantiateErrorByErrorCode(
                         details.getErrorCode(),
                         details.getErrorMessage());
-                details.setValue(defaultValue);
+                enrichDetailsWithErrorDefaults(defaultValue, details);
                 hookSupport.errorHooks(type, afterHookContext, error, mergedHooks, hints);
             } else {
                 hookSupport.afterHooks(type, afterHookContext, details, mergedHooks, hints);
@@ -150,8 +150,7 @@ private <T> FlagEvaluationDetails<T> evaluateFlag(FlagValueType type, String key
                 details.setErrorCode(ErrorCode.GENERAL);
             }
             details.setErrorMessage(e.getMessage());
-            details.setValue(defaultValue);
-            details.setReason(Reason.ERROR.toString());
+            enrichDetailsWithErrorDefaults(defaultValue, details);
             hookSupport.errorHooks(type, afterHookContext, e, mergedHooks, hints);
         } finally {
             hookSupport.afterAllHooks(type, afterHookContext, mergedHooks, hints);
@@ -160,6 +159,11 @@ private <T> FlagEvaluationDetails<T> evaluateFlag(FlagValueType type, String key
         return details;
     }
 
+    private static <T> void enrichDetailsWithErrorDefaults(T defaultValue, FlagEvaluationDetails<T> details) {
+        details.setValue(defaultValue);
+        details.setReason(Reason.ERROR.toString());
+    }
+
     /**
      * Merge invocation contexts with API, transaction and client contexts.
      * Does not merge before context.

src/main/java/dev/openfeature/sdk/exceptions/FlagNotFoundError.java

@@ -6,12 +6,8 @@
 
 @SuppressWarnings("checkstyle:MissingJavadocType")
 @StandardException
-public class FlagNotFoundError extends OpenFeatureError {
+public class FlagNotFoundError extends OpenFeatureErrorWithoutStacktrace {
     private static final long serialVersionUID = 1L;
     @Getter private final ErrorCode errorCode = ErrorCode.FLAG_NOT_FOUND;
 
-    @Override
-    public synchronized Throwable fillInStackTrace() {
-        return this;
-    }
 }

src/main/java/dev/openfeature/sdk/exceptions/OpenFeatureErrorWithoutStacktrace.java

@@ -0,0 +1,15 @@
+package dev.openfeature.sdk.exceptions;
+
+import dev.openfeature.sdk.ErrorCode;
+import lombok.experimental.StandardException;
+
+@SuppressWarnings("checkstyle:MissingJavadocType")
+@StandardException
+public abstract class OpenFeatureErrorWithoutStacktrace extends OpenFeatureError {
+    private static final long serialVersionUID = 1L;
+
+    @Override
+    public synchronized Throwable fillInStackTrace() {
+        return this;
+    }
+}

src/main/java/dev/openfeature/sdk/exceptions/ProviderNotReadyError.java

@@ -6,7 +6,7 @@
 
 @SuppressWarnings("checkstyle:MissingJavadocType")
 @StandardException
-public class ProviderNotReadyError extends OpenFeatureError {
+public class ProviderNotReadyError extends OpenFeatureErrorWithoutStacktrace {
     private static final long serialVersionUID = 1L;
     @Getter private final ErrorCode errorCode = ErrorCode.PROVIDER_NOT_READY;
 }

src/main/java/dev/openfeature/sdk/exceptions/TypeMismatchError.java

@@ -8,7 +8,7 @@
  * The type of the flag value does not match the expected type.
  */
 @StandardException
-public class TypeMismatchError extends OpenFeatureError {
+public class TypeMismatchError extends OpenFeatureErrorWithoutStacktrace {
     private static final long serialVersionUID = 1L;
 
     @Getter private final ErrorCode errorCode = ErrorCode.TYPE_MISMATCH;

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

@@ -264,6 +264,7 @@ public void initialize(EvaluationContext evaluationContext) throws Exception {
         FlagEvaluationDetails<Boolean> details = c.getBooleanDetails("key", defaultValue);
         assertEquals(ErrorCode.FLAG_NOT_FOUND, details.getErrorCode());
         assertEquals(TestConstants.BROKEN_MESSAGE, details.getErrorMessage());
+        assertEquals(Reason.ERROR.toString(), details.getReason());
         assertEquals(defaultValue, details.getValue());
     }
 
@@ -279,6 +280,7 @@ public void initialize(EvaluationContext evaluationContext) throws Exception {
         FlagEvaluationDetails<Boolean> details = c.getBooleanDetails("key", defaultValue);
         assertEquals(ErrorCode.FLAG_NOT_FOUND, details.getErrorCode());
         assertEquals(TestConstants.BROKEN_MESSAGE, details.getErrorMessage());
+        assertEquals(Reason.ERROR.toString(), details.getReason());
         assertEquals(defaultValue, details.getValue());
     }