expose ExceptionClass only in debug mode (#584)

Co-authored-by: Tatu Saloranta <tatu.saloranta@datastax.com>
stargate · Oct 25, 2023 · c74956d · c74956d
1 parent 0164be7
commit c74956d
Show file tree

Hide file tree

Showing 9 changed files with 55 additions and 5 deletions.
diff --git a/src/main/java/io/stargate/sgv2/jsonapi/JsonApiStartUp.java b/src/main/java/io/stargate/sgv2/jsonapi/JsonApiStartUp.java
@@ -3,6 +3,7 @@
 import io.quarkus.runtime.Quarkus;
 import io.quarkus.runtime.StartupEvent;
 import io.stargate.sgv2.api.common.properties.datastore.DataStoreProperties;
+import io.stargate.sgv2.jsonapi.config.DebugModeConfig;
 import jakarta.enterprise.context.ApplicationScoped;
 import jakarta.enterprise.event.Observes;
 import jakarta.inject.Inject;
@@ -14,13 +15,16 @@ public class JsonApiStartUp {
 
   private static final Logger LOGGER = LoggerFactory.getLogger(JsonApiStartUp.class);
   private final DataStoreProperties dataStoreProperties;
+  private final DebugModeConfig config;
 
   @Inject
-  public JsonApiStartUp(DataStoreProperties dataStoreProperties) {
+  public JsonApiStartUp(DataStoreProperties dataStoreProperties, DebugModeConfig config) {
     this.dataStoreProperties = dataStoreProperties;
+    this.config = config;
   }
 
   void onStart(@Observes StartupEvent ev) {
+    LOGGER.info(String.format("DEBUG mode Enabled: %s", config.enabled()));
     LOGGER.info(
         String.format("VectorSearch Enabled: %s", dataStoreProperties.vectorSearchEnabled()));
     LOGGER.info(

diff --git a/src/main/java/io/stargate/sgv2/jsonapi/config/DebugModeConfig.java b/src/main/java/io/stargate/sgv2/jsonapi/config/DebugModeConfig.java
@@ -0,0 +1,11 @@
+package io.stargate.sgv2.jsonapi.config;
+
+import io.smallrye.config.ConfigMapping;
+import io.smallrye.config.WithDefault;
+
+@ConfigMapping(prefix = "stargate.debug")
+public interface DebugModeConfig {
+
+  @WithDefault("false")
+  boolean enabled();
+}
diff --git a/src/main/java/io/stargate/sgv2/jsonapi/exception/JsonApiException.java b/src/main/java/io/stargate/sgv2/jsonapi/exception/JsonApiException.java
@@ -1,11 +1,14 @@
 package io.stargate.sgv2.jsonapi.exception;
 
+import io.smallrye.config.SmallRyeConfig;
 import io.stargate.sgv2.jsonapi.api.model.command.CommandResult;
+import io.stargate.sgv2.jsonapi.config.DebugModeConfig;
 import io.stargate.sgv2.jsonapi.exception.mappers.ThrowableToErrorMapper;
 import jakarta.ws.rs.core.Response;
 import java.util.List;
 import java.util.Map;
 import java.util.function.Supplier;
+import org.eclipse.microprofile.config.ConfigProvider;
 
 /**
  * Our own {@link RuntimeException} that uses {@link ErrorCode} to describe the exception cause.
@@ -58,8 +61,17 @@ public CommandResult get() {
   }
 
   public CommandResult.Error getCommandResultError(String message) {
-    Map<String, Object> fields =
-        Map.of("errorCode", errorCode.name(), "exceptionClass", this.getClass().getSimpleName());
+    Map<String, Object> fields = null;
+    SmallRyeConfig config = ConfigProvider.getConfig().unwrap(SmallRyeConfig.class);
+    // enable debug mode for unit tests, since it can not be injected
+    DebugModeConfig debugModeConfig = config.getConfigMapping(DebugModeConfig.class);
+    final boolean debugEnabled = debugModeConfig.enabled();
+    if (debugEnabled) {
+      fields =
+          Map.of("errorCode", errorCode.name(), "exceptionClass", this.getClass().getSimpleName());
+    } else {
+      fields = Map.of("errorCode", errorCode.name());
+    }
     return new CommandResult.Error(message, fields, Response.Status.OK);
   }
 

diff --git a/src/main/java/io/stargate/sgv2/jsonapi/exception/mappers/ThrowableToErrorMapper.java b/src/main/java/io/stargate/sgv2/jsonapi/exception/mappers/ThrowableToErrorMapper.java
@@ -2,12 +2,15 @@
 
 import io.grpc.Status;
 import io.grpc.StatusRuntimeException;
+import io.smallrye.config.SmallRyeConfig;
 import io.stargate.sgv2.jsonapi.api.model.command.CommandResult;
+import io.stargate.sgv2.jsonapi.config.DebugModeConfig;
 import io.stargate.sgv2.jsonapi.exception.JsonApiException;
 import jakarta.ws.rs.core.Response;
 import java.util.Map;
 import java.util.function.BiFunction;
 import java.util.function.Function;
+import org.eclipse.microprofile.config.ConfigProvider;
 
 /**
  * Simple mapper for mapping {@link Throwable}s to {@link CommandResult.Error}, with a default
@@ -22,9 +25,12 @@ public final class ThrowableToErrorMapper {
           return jae.getCommandResultError(message);
         }
         // Override response error code
+        SmallRyeConfig config = ConfigProvider.getConfig().unwrap(SmallRyeConfig.class);
+        DebugModeConfig debugModeConfig = config.getConfigMapping(DebugModeConfig.class);
+        final boolean debugEnabled = debugModeConfig.enabled();
         if (throwable instanceof StatusRuntimeException sre) {
           Map<String, Object> fields =
-              Map.of("exceptionClass", throwable.getClass().getSimpleName());
+              debugEnabled ? Map.of("exceptionClass", throwable.getClass().getSimpleName()) : null;
           if (sre.getStatus().getCode() == Status.Code.UNAUTHENTICATED) {
             return new CommandResult.Error(message, fields, Response.Status.UNAUTHORIZED);
           } else if (sre.getStatus().getCode() == Status.Code.INTERNAL) {
@@ -36,7 +42,8 @@ public final class ThrowableToErrorMapper {
           }
         }
         // add error code as error field
-        Map<String, Object> fields = Map.of("exceptionClass", throwable.getClass().getSimpleName());
+        Map<String, Object> fields =
+            debugEnabled ? Map.of("exceptionClass", throwable.getClass().getSimpleName()) : null;
         return new CommandResult.Error(message, fields, Response.Status.OK);
       };
 

diff --git a/src/main/resources/application.yaml b/src/main/resources/application.yaml
@@ -3,6 +3,9 @@
 
 stargate:
 
+  debug:
+    enabled: false
+
   # disable all sgv2 exception mappers, handled differently
   exception-mappers:
     enabled: false

diff --git a/src/test/java/io/stargate/sgv2/jsonapi/exception/JsonApiExceptionTest.java b/src/test/java/io/stargate/sgv2/jsonapi/exception/JsonApiExceptionTest.java
@@ -2,10 +2,15 @@
 
 import static org.assertj.core.api.Assertions.assertThat;
 
+import io.quarkus.test.junit.QuarkusTest;
+import io.quarkus.test.junit.TestProfile;
+import io.stargate.sgv2.common.testprofiles.NoGlobalResourcesTestProfile;
 import io.stargate.sgv2.jsonapi.api.model.command.CommandResult;
 import org.junit.jupiter.api.Nested;
 import org.junit.jupiter.api.Test;
 
+@QuarkusTest
+@TestProfile(NoGlobalResourcesTestProfile.Impl.class)
 class JsonApiExceptionTest {
 
   @Nested

diff --git a/...t/java/io/stargate/sgv2/jsonapi/exception/mappers/ThrowableCommandResultSupplierTest.java b/...t/java/io/stargate/sgv2/jsonapi/exception/mappers/ThrowableCommandResultSupplierTest.java
@@ -4,11 +4,16 @@
 
 import io.grpc.Status;
 import io.grpc.StatusRuntimeException;
+import io.quarkus.test.junit.QuarkusTest;
+import io.quarkus.test.junit.TestProfile;
+import io.stargate.sgv2.common.testprofiles.NoGlobalResourcesTestProfile;
 import io.stargate.sgv2.jsonapi.api.model.command.CommandResult;
 import jakarta.ws.rs.core.Response;
 import org.junit.jupiter.api.Nested;
 import org.junit.jupiter.api.Test;
 
+@QuarkusTest
+@TestProfile(NoGlobalResourcesTestProfile.Impl.class)
 class ThrowableCommandResultSupplierTest {
 
   @Nested

diff --git a/src/test/java/io/stargate/sgv2/jsonapi/testresource/DseTestResource.java b/src/test/java/io/stargate/sgv2/jsonapi/testresource/DseTestResource.java
@@ -39,6 +39,7 @@ public Map<String, String> start() {
     propsBuilder.put(
         "stargate.jsonapi.embedding.service.custom.clazz",
         "io.stargate.sgv2.jsonapi.service.embedding.operation.test.CustomITEmbeddingService");
+    propsBuilder.put("stargate.debug.enabled", "true");
     return propsBuilder.build();
   }
 }
diff --git a/src/test/resources/application.yaml b/src/test/resources/application.yaml
@@ -3,6 +3,8 @@
 stargate:
   data-store:
     ignore-bridge: true
+  debug:
+    enabled: true
 
 # change test port from 8081 (used by other SG services)
 quarkus: