chore: simplify error reasons to use ErrorMessage enum

Author: kaushalkapasi

src/main/java/com/devcycle/sdk/server/cloud/api/DevCycleCloudClient.java

@@ -117,13 +117,11 @@ public <T> Variable<T> variable(DevCycleUser user, String key, T defaultValue) {
         validateUser(user);
 
         if (key == null || key.equals("")) {
-            ErrorResponse errorResponse = new ErrorResponse(500, "Missing parameter: key", null);
-            throw new IllegalArgumentException("Missing parameter: key");
+            throw new IllegalArgumentException(ErrorResponse.ErrorMessage.MISSING_PARAMETER.getMessage("key"));
         }
 
         if (defaultValue == null) {
-            ErrorResponse errorResponse = new ErrorResponse(500, "Missing parameter: defaultValue", null);
-            throw new IllegalArgumentException("Missing parameter: defaultValue");
+            throw new IllegalArgumentException(ErrorResponse.ErrorMessage.MISSING_PARAMETER.getMessage("defaultValue"));
         }
 
         TypeEnum variableType = TypeEnum.fromClass(defaultValue.getClass());
@@ -145,7 +143,7 @@ public <T> Variable<T> variable(DevCycleUser user, String key, T defaultValue) {
             Call<Variable> response = api.getVariableByKey(user, key, dvcOptions.getEnableEdgeDB());
             variable = getResponseWithRetries(response, 5);
             if (variable.getType() != variableType) {
-                throw new IllegalArgumentException("Variable type mismatch, returning default value");
+                throw new IllegalArgumentException(ErrorResponse.ErrorMessage.VARIABLE_TYPE_MISMATCH.getMessage());
             }
             if (beforeError != null) {
                 throw beforeError;
@@ -163,7 +161,7 @@ public <T> Variable<T> variable(DevCycleUser user, String key, T defaultValue) {
                         .isDefaulted(true)
                         .build();
 
-                if (exception.getMessage().equals("Variable type mismatch, returning default value")) {
+                if (exception.getMessage().equals(ErrorResponse.ErrorMessage.VARIABLE_TYPE_MISMATCH.getMessage())) {
                     variable.setEval(EvalReason.defaultReason(EvalReason.DefaultReasonDetailsEnum.VARIABLE_TYPE_MISMATCH));
                 } else {
                     variable.setEval(EvalReason.defaultReason(EvalReason.DefaultReasonDetailsEnum.ERROR));
@@ -227,7 +225,7 @@ public void track(DevCycleUser user, DevCycleEvent event) throws DevCycleExcepti
         validateUser(user);
 
         if (event == null || event.getType() == null || event.getType().equals("")) {
-            throw new IllegalArgumentException("Invalid DevCycleEvent");
+            throw new IllegalArgumentException(ErrorResponse.ErrorMessage.INVALID_EVENT.getMessage());
         }
 
         DevCycleUserAndEvents userAndEvents = DevCycleUserAndEvents.builder()
@@ -338,10 +336,10 @@ private boolean isValidServerKey(String serverKey) {
 
     private void validateUser(DevCycleUser user) {
         if (user == null) {
-            throw new IllegalArgumentException("DevCycleUser cannot be null");
+            throw new IllegalArgumentException(ErrorResponse.ErrorMessage.NULL_USER.getMessage());
         }
         if (user.getUserId().equals("")) {
-            throw new IllegalArgumentException("userId cannot be empty");
+            throw new IllegalArgumentException(ErrorResponse.ErrorMessage.USER_ID_MISSING.getMessage());
         }
     }
 }

src/main/java/com/devcycle/sdk/server/common/model/ErrorResponse.java

@@ -13,6 +13,7 @@
 package com.devcycle.sdk.server.common.model;
 
 import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
+
 import io.swagger.v3.oas.annotations.media.Schema;
 import lombok.AllArgsConstructor;
 import lombok.Builder;
@@ -33,4 +34,22 @@ public class ErrorResponse {
 
     @Schema(description = "Additional error information detailing the error reasoning")
     private Object data;
+
+    public enum ErrorMessage {
+        MISSING_PARAMETER("Missing parameter: %s"),
+        NULL_USER("DevCycleUser cannot be null"),
+        USER_ID_MISSING("userId cannot be empty"),
+        INVALID_EVENT("Invalid DevCycleEvent"),
+        VARIABLE_TYPE_MISMATCH("Variable type mismatch, returning default value");
+
+        private final String message;
+
+        ErrorMessage(String message) {
+            this.message = message;
+        }
+
+        public String getMessage(String... args) {
+            return String.format(message, args);
+        }
+    }
 }

src/main/java/com/devcycle/sdk/server/local/api/DevCycleLocalClient.java

@@ -12,6 +12,7 @@
 import com.devcycle.sdk.server.common.model.BaseVariable;
 import com.devcycle.sdk.server.common.model.DevCycleEvent;
 import com.devcycle.sdk.server.common.model.DevCycleUser;
+import com.devcycle.sdk.server.common.model.ErrorResponse;
 import com.devcycle.sdk.server.common.model.EvalHook;
 import com.devcycle.sdk.server.common.model.EvalHooksRunner;
 import com.devcycle.sdk.server.common.model.EvalReason;
@@ -137,11 +138,11 @@ public <T> Variable<T> variable(DevCycleUser user, String key, T defaultValue) {
         validateUser(user);
 
         if (key == null || key.equals("")) {
-            throw new IllegalArgumentException("Missing parameter: key");
+            throw new IllegalArgumentException(ErrorResponse.ErrorMessage.MISSING_PARAMETER.getMessage("key"));
         }
 
         if (defaultValue == null) {
-            throw new IllegalArgumentException("Missing parameter: defaultValue");
+            throw new IllegalArgumentException(ErrorResponse.ErrorMessage.MISSING_PARAMETER.getMessage("defaultValue"));
         }
 
         TypeEnum variableType = TypeEnum.fromClass(defaultValue.getClass());
@@ -266,7 +267,7 @@ public void track(DevCycleUser user, DevCycleEvent event) {
         validateUser(user);
 
         if (event == null || event.getType().equals("")) {
-            throw new IllegalArgumentException("Invalid DevCycleEvent");
+            throw new IllegalArgumentException(ErrorResponse.ErrorMessage.INVALID_EVENT.getMessage());
         }
 
         try {
@@ -347,10 +348,10 @@ public String getSDKPlatform() {
 
     private void validateUser(DevCycleUser user) {
         if (user == null) {
-            throw new IllegalArgumentException("DevCycleUser cannot be null");
+            throw new IllegalArgumentException(ErrorResponse.ErrorMessage.NULL_USER.getMessage());
         }
         if (user.getUserId().equals("")) {
-            throw new IllegalArgumentException("userId cannot be empty");
+            throw new IllegalArgumentException(ErrorResponse.ErrorMessage.USER_ID_MISSING.getMessage());
         }
     }