Develop exception collection and lookup

Author: PENEKhun

springdog-project/springdog-agent/src/main/java/org/easypeelsecurity/springdog/agent/CommonResponse.java

@@ -0,0 +1,119 @@
+/*
+ * Copyright 2024 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.easypeelsecurity.springdog.agent;
+
+import java.time.LocalDateTime;
+
+import org.springframework.http.HttpStatus;
+import org.springframework.http.ResponseEntity;
+
+import com.fasterxml.jackson.annotation.JsonFormat;
+
+/**
+ * Common response.
+ *
+ * @param <T> The type of the response detail
+ */
+public class CommonResponse<T> {
+
+  @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
+  private final LocalDateTime timestamp = LocalDateTime.now();
+  private final T detail;
+  private final String message;
+  private final ResponseStatus result;
+
+  /**
+   * Constructor.
+   */
+  public CommonResponse(T detail, String message, ResponseStatus result) {
+    this.detail = detail;
+    this.message = message;
+    this.result = result;
+  }
+
+  /**
+   * Constructor for success response.
+   *
+   * @param detail The response detail
+   */
+  public CommonResponse(T detail) {
+    this(detail, "The request was successfully processed.", ResponseStatus.SUCCESS);
+  }
+
+  /**
+   * Create a error response.
+   *
+   * @param message The error message
+   * @return The error response
+   */
+  public static <T> ResponseEntity<CommonResponse<T>> responseError(String message) {
+    return ResponseEntity
+        .status(HttpStatus.BAD_REQUEST)
+        .body(new CommonResponse<>(
+            null,
+            message,
+            ResponseStatus.FAILURE));
+  }
+
+  /**
+   * Create a error response with exception's message.
+   *
+   * @param message The error message
+   * @param e       The exception to contain the message
+   * @return The error response
+   */
+  public static <T> ResponseEntity<CommonResponse<T>> responseError(String message, Exception e) {
+    return ResponseEntity
+        .status(HttpStatus.BAD_REQUEST)
+        .body(new CommonResponse<>(
+            null,
+            message + " " + e.getLocalizedMessage(),
+            ResponseStatus.FAILURE));
+  }
+
+  /**
+   * Get the timestamp.
+   */
+  public LocalDateTime getTimestamp() {
+    return timestamp;
+  }
+
+  /**
+   * Get the response detail.
+   */
+  public T getDetail() {
+    return detail;
+  }
+
+  /**
+   * Get the response message.
+   *
+   * @return The message
+   */
+  public String getMessage() {
+    return message;
+  }
+
+  /**
+   * Get the response status.
+   *
+   * @return The status
+   */
+  public String getResult() {
+    return result.name();
+  }
+}

springdog-project/springdog-agent/src/main/java/org/easypeelsecurity/springdog/agent/ResponseStatus.java

@@ -0,0 +1,25 @@
+/*
+ * Copyright 2024 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.easypeelsecurity.springdog.agent;
+
+/**
+ * Response status.
+ */
+enum ResponseStatus {
+  SUCCESS,
+  FAILURE
+}

springdog-project/springdog-agent/src/main/java/org/easypeelsecurity/springdog/agent/SpringdogAPI.java

@@ -16,31 +16,41 @@
 
 package org.easypeelsecurity.springdog.agent;
 
+import static org.springframework.http.HttpStatus.NO_CONTENT;
+
 import org.springframework.web.bind.annotation.GetMapping;
 import org.springframework.web.bind.annotation.PathVariable;
 import org.springframework.web.bind.annotation.RequestParam;
 import org.springframework.web.bind.annotation.RestController;
 
 import org.easypeelsecurity.springdog.domain.errortracing.model.ExceptionListingService;
+import org.easypeelsecurity.springdog.shared.dto.ErrorTracingDto;
 
 /**
  * RestController for springdog.
  */
 @RestController
 @SpringdogAgentController
 @SuppressWarnings("checkstyle:MissingJavadocMethod")
-public class SpringdogAPI {
+public class SpringdogAPI extends SpringdogAPIExceptionHandler {
 
   private final ExceptionListingService exceptionListingService;
 
   public SpringdogAPI(ExceptionListingService exceptionListingService) {
     this.exceptionListingService = exceptionListingService;
   }
 
+  @org.springframework.web.bind.annotation.ResponseStatus(NO_CONTENT)
   @GetMapping("/error-tracing/configuration/{exceptionClassId}")
   public void errorExceptionMonitoringStatus(
       @PathVariable(name = "exceptionClassId") long exceptionClassId,
       @RequestParam("enabled") boolean enabled) {
     exceptionListingService.changeMonitoringStatus(exceptionClassId, enabled);
   }
+
+  @GetMapping("/error-tracing/{errorTracingId}")
+  public CommonResponse<ErrorTracingDto> getErrorTracing(
+      @PathVariable(name = "errorTracingId") long errorTracingId) {
+    return new CommonResponse<>(exceptionListingService.getErrorTrace(errorTracingId));
+  }
 }

springdog-project/springdog-agent/src/main/java/org/easypeelsecurity/springdog/agent/SpringdogAPIExceptionHandler.java

@@ -0,0 +1,52 @@
+/*
+ * Copyright 2024 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.easypeelsecurity.springdog.agent;
+
+import static org.easypeelsecurity.springdog.agent.CommonResponse.responseError;
+import static org.springframework.http.HttpStatus.BAD_REQUEST;
+
+import org.springframework.http.ResponseEntity;
+import org.springframework.http.converter.HttpMessageNotReadableException;
+import org.springframework.web.bind.MethodArgumentNotValidException;
+import org.springframework.web.bind.annotation.ExceptionHandler;
+
+/**
+ * Springdog API Exception Handler.
+ */
+abstract class SpringdogAPIExceptionHandler {
+  /**
+   * If an Exception related invalid input is thrown, return an error message conforming to the Response
+   * specification.
+   */
+  @org.springframework.web.bind.annotation.ResponseStatus(BAD_REQUEST)
+  @ExceptionHandler({
+      MethodArgumentNotValidException.class,
+      IllegalArgumentException.class,
+      HttpMessageNotReadableException.class})
+  protected ResponseEntity<CommonResponse<Void>> handleInvalidInput(Exception e) {
+    return responseError("Invalid input value.", e);
+  }
+
+  /**
+   * If an IllegalStateException is thrown, return an error message conforming to the Response specification.
+   */
+  @org.springframework.web.bind.annotation.ResponseStatus(BAD_REQUEST)
+  @ExceptionHandler(value = {IllegalStateException.class})
+  protected ResponseEntity<CommonResponse<Void>> handleIllegalStateException(IllegalStateException e) {
+    return responseError("This is an inappropriate call.", e);
+  }
+}

springdog-project/springdog-agent/src/main/java/org/easypeelsecurity/springdog/agent/SpringdogAgentView.java

@@ -38,6 +38,7 @@
 import org.easypeelsecurity.springdog.domain.statistics.StatisticsService;
 import org.easypeelsecurity.springdog.shared.configuration.SpringdogProperties;
 import org.easypeelsecurity.springdog.shared.dto.EndpointDto;
+import org.easypeelsecurity.springdog.shared.dto.ErrorTracingDto;
 import org.easypeelsecurity.springdog.shared.util.Assert;
 
 /**
@@ -134,6 +135,13 @@ public String modifyRateLimit(@PathVariable(name = "endpointId") long endpointId
     return viewRateLimitSpecific(endpointId, model);
   }
 
+  @GetMapping("/error-tracing")
+  public String errorTracingHome(Model model) {
+    List<ErrorTracingDto> causes = exceptionListingService.getAllParentCauses();
+    model.addAttribute("causes", causes);
+    return "/templates/content/error-tracing/list.html";
+  }
+
   @GetMapping("/error-tracing/configuration")
   public String errorTracingConfiguration(Model model) {
     model.addAttribute("exceptionClasses", exceptionListingService.getExceptionListing());

springdog-project/springdog-agent/src/main/resources/static/css/bootstrap.min.css

@@ -54,18 +54,18 @@ tbody {
   --bs-gray-700: #495057;
   --bs-gray-800: #343a40;
   --bs-gray-900: #212529;
-  --bs-primary: #0d6efd;
+  --bs-primary: #239560;
   --bs-secondary: #6c757d;
   --bs-success: #198754;
-  --bs-info: #0dcaf0;
+  --bs-info: #529978;
   --bs-warning: #ffc107;
   --bs-danger: #dc3545;
   --bs-light: #f8f9fa;
   --bs-dark: #212529;
-  --bs-primary-rgb: 13, 110, 253;
-  --bs-secondary-rgb: 108, 117, 125;
+  --bs-primary-rgb: 35, 149, 96;
+  --bs-secondary-rgb: 25, 135, 84;
   --bs-success-rgb: 25, 135, 84;
-  --bs-info-rgb: 13, 202, 240;
+  --bs-info-rgb: 82, 153, 120;
   --bs-warning-rgb: 255, 193, 7;
   --bs-danger-rgb: 220, 53, 69;
   --bs-light-rgb: 248, 249, 250;

springdog-project/springdog-agent/src/main/resources/static/css/styles.css

@@ -14,8 +14,7 @@
  * limitations under the License.
  */
 
-window.springdogFetch = function (url, options, data, successCallback,
-    errorCallback) {
+window.springdogFetch = function (url, options, data) {
   if (springdogBasePath === undefined) {
     console.error(
         `springdogBasePath is not defined. Please define it in your HTML file.
@@ -45,12 +44,40 @@ window.springdogFetch = function (url, options, data, successCallback,
   }
 
   return fetch(springdogBasePath + url, fetchOptions)
-  .then(response => {
-    if (!response.ok) {
-      return response.json().then(errorData => {
-        throw new Error(errorData.message || 'Network response was not ok');
-      });
+  .then(async response => {
+    if (response.status === 204) {
+      return;
     }
-    return response.json().catch(() => ({}));
+
+    let json;
+    try {
+      json = await response.json();
+    } catch (error) {
+      throw new Error('Invalid JSON response');
+    }
+
+    if (response.status === 201) {
+      return json.message;
+    } else if (response.status === 200) {
+      if (json.result === undefined) {
+        throw new Error('Unexpected response');
+      }
+
+      if (json.result === 'SUCCESS') {
+        return json.detail;
+      } else {
+        throw new Error(json.message);
+      }
+    } else {
+      if (json.message === undefined) {
+        throw new Error('Unexpected response');
+      } else {
+        throw new Error(json.message);
+      }
+    }
+  })
+  .catch(error => {
+    console.error('Error fetching data:', error);
+    throw error;
   });
 }

springdog-project/springdog-agent/src/main/resources/static/js/bootstrap.min.js

@@ -77,10 +77,6 @@
           springdogFetch(`/error-tracing/configuration/${exceptionId}?enabled=${isChecked}`, {
             method: 'GET'
           })
-          .then(data => {
-            console.log(`Exception ${exceptionId} monitoring status changed to ${isChecked}`);
-            // 성공 시 추가 작업이 필요하다면 여기에 작성
-          })
           .catch(error => {
             console.error('There was a problem with the fetch operation:', error);
             // Revert the checkbox state if the API call fails