From 514aaeb367b4762704516012cf29e748346bc2ae Mon Sep 17 00:00:00 2001
From: Teriuihi <teriuihi@alttd.com>
Date: Wed, 7 Aug 2024 21:34:03 +0200
Subject: [PATCH] Refactor packages and add exception handler.

Renamed various classes to follow the "controlers" package structure for better organization and consistency. Added `ControllerExceptionHandler` to manage validation exceptions globally and improve error logging.
---
 .idea/workspace.xml                           | 20 ++++++--
 .../ControllerExceptionHandler.java           | 47 +++++++++++++++++++
 .../apply/StaffAppController.java             |  7 +--
 .../apply/StaffAppFormData.java               |  2 +-
 .../contact/ContactController.java            |  2 +-
 .../contact/ContactFormData.java              |  2 +-
 .../alttd/forms/verify_mail/FormQuery.java    |  2 +-
 src/test/java/TestForm.java                   |  2 +-
 8 files changed, 69 insertions(+), 15 deletions(-)
 create mode 100644 src/main/java/com/alttd/forms/controlers/ControllerExceptionHandler.java
 rename src/main/java/com/alttd/forms/{ => controlers}/apply/StaffAppController.java (87%)
 rename src/main/java/com/alttd/forms/{ => controlers}/apply/StaffAppFormData.java (99%)
 rename src/main/java/com/alttd/forms/{ => controlers}/contact/ContactController.java (97%)
 rename src/main/java/com/alttd/forms/{ => controlers}/contact/ContactFormData.java (98%)

diff --git a/.idea/workspace.xml b/.idea/workspace.xml
index dd94b6d..74660eb 100644
--- a/.idea/workspace.xml
+++ b/.idea/workspace.xml
@@ -4,7 +4,7 @@
     <option name="autoReloadType" value="SELECTIVE" />
   </component>
   <component name="ChangeListManager">
-    <list default="true" id="ce59df2a-8d56-446a-867b-80e627daf479" name="Changes" comment="Add getDiscordBotUrl method to form classes&#10;&#10;Implemented getDiscordBotUrl in form classes for dynamic URL handling. Updated VerifyController to use this method for constructing Discord bot URIs. This enhances flexibility and maintainability in form submission handling.">
+    <list default="true" id="ce59df2a-8d56-446a-867b-80e627daf479" name="Changes" comment="Refactor form submission to use dynamic Discord URLs and emails&#10;&#10;Updated form classes to return Optional URLs for Discord bot submissions. Refactored VerifyController to handle these Optionals and improved error handling when sending forms. Added receiver email method in form classes for more flexible form submissions.">
       <change beforePath="$PROJECT_DIR$/.idea/workspace.xml" beforeDir="false" afterPath="$PROJECT_DIR$/.idea/workspace.xml" afterDir="false" />
     </list>
     <option name="SHOW_DIALOG" value="false" />
@@ -323,8 +323,8 @@
   <component name="SharedIndexes">
     <attachedChunks>
       <set>
-        <option value="bundled-jdk-9f38398b9061-39b83d9b5494-intellij.indexing.shared.core-IU-241.18968.26" />
-        <option value="bundled-js-predefined-1d06a55b98c1-0b3e54e931b4-JavaScript-IU-241.18968.26" />
+        <option value="bundled-jdk-9823dce3aa75-b114ca120d71-intellij.indexing.shared.core-IU-242.20224.300" />
+        <option value="bundled-js-predefined-d6986cc7102b-410509235cf1-JavaScript-IU-242.20224.300" />
       </set>
     </attachedChunks>
   </component>
@@ -364,6 +364,7 @@
       <workItem from="1722801254695" duration="6135000" />
       <workItem from="1722879625782" duration="358000" />
       <workItem from="1722973564053" duration="6695000" />
+      <workItem from="1723057624940" duration="36000" />
     </task>
     <task id="LOCAL-00001" summary="Initial commit for site for forms">
       <option name="closed" value="true" />
@@ -549,7 +550,15 @@
       <option name="project" value="LOCAL" />
       <updated>1722981675331</updated>
     </task>
-    <option name="localTasksCounter" value="24" />
+    <task id="LOCAL-00024" summary="Refactor form submission to use dynamic Discord URLs and emails&#10;&#10;Updated form classes to return Optional URLs for Discord bot submissions. Refactored VerifyController to handle these Optionals and improved error handling when sending forms. Added receiver email method in form classes for more flexible form submissions.">
+      <option name="closed" value="true" />
+      <created>1722983786557</created>
+      <option name="number" value="00024" />
+      <option name="presentableId" value="LOCAL-00024" />
+      <option name="project" value="LOCAL" />
+      <updated>1722983786557</updated>
+    </task>
+    <option name="localTasksCounter" value="25" />
     <servers />
   </component>
   <component name="TypeScriptGeneratedFilesManager">
@@ -591,6 +600,7 @@
     <MESSAGE value="Add REST annotations and refactor properties file handling&#10;&#10;Introduced `@RestController` and `@RequestMapping` in `StaffAppController` for standardized API endpoints. Refactored properties file handling in `PropertiesLoader` and `PropertiesWriter` to simplify file creation logic." />
     <MESSAGE value="Update Jackson config and refactor JSON handling&#10;&#10;Introduced Jackson dependencies to replace Gson for JSON processing. Updated application properties and controllers to handle Jackson-specific exceptions. Refactored form serialization to use Jackson's `ObjectMapper` for better date handling and consistency." />
     <MESSAGE value="Add getDiscordBotUrl method to form classes&#10;&#10;Implemented getDiscordBotUrl in form classes for dynamic URL handling. Updated VerifyController to use this method for constructing Discord bot URIs. This enhances flexibility and maintainability in form submission handling." />
-    <option name="LAST_COMMIT_MESSAGE" value="Add getDiscordBotUrl method to form classes&#10;&#10;Implemented getDiscordBotUrl in form classes for dynamic URL handling. Updated VerifyController to use this method for constructing Discord bot URIs. This enhances flexibility and maintainability in form submission handling." />
+    <MESSAGE value="Refactor form submission to use dynamic Discord URLs and emails&#10;&#10;Updated form classes to return Optional URLs for Discord bot submissions. Refactored VerifyController to handle these Optionals and improved error handling when sending forms. Added receiver email method in form classes for more flexible form submissions." />
+    <option name="LAST_COMMIT_MESSAGE" value="Refactor form submission to use dynamic Discord URLs and emails&#10;&#10;Updated form classes to return Optional URLs for Discord bot submissions. Refactored VerifyController to handle these Optionals and improved error handling when sending forms. Added receiver email method in form classes for more flexible form submissions." />
   </component>
 </project>
\ No newline at end of file
diff --git a/src/main/java/com/alttd/forms/controlers/ControllerExceptionHandler.java b/src/main/java/com/alttd/forms/controlers/ControllerExceptionHandler.java
new file mode 100644
index 0000000..278903b
--- /dev/null
+++ b/src/main/java/com/alttd/forms/controlers/ControllerExceptionHandler.java
@@ -0,0 +1,47 @@
+package com.alttd.forms.controlers;
+
+import com.fasterxml.jackson.core.JsonProcessingException;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.springframework.http.HttpStatus;
+import org.springframework.http.ResponseEntity;
+import org.springframework.validation.FieldError;
+import org.springframework.web.bind.MethodArgumentNotValidException;
+import org.springframework.web.bind.annotation.ControllerAdvice;
+import org.springframework.web.bind.annotation.ExceptionHandler;
+import org.springframework.web.bind.annotation.ResponseStatus;
+
+import java.util.HashMap;
+import java.util.Map;
+
+@ControllerAdvice
+public class ControllerExceptionHandler {
+
+    private static final Logger logger = LoggerFactory.getLogger(ControllerExceptionHandler.class);
+
+    public ControllerExceptionHandler() {
+        logger.info("ControllerExceptionHandler initialized");  // Ensure this gets logged
+    }
+
+    @ExceptionHandler(MethodArgumentNotValidException.class)
+    @ResponseStatus(HttpStatus.BAD_REQUEST)
+    public ResponseEntity<Map<String, String>> handleValidationExceptions(MethodArgumentNotValidException ex) {
+        logger.debug("invalid request", ex);
+        Map<String, String> errors = new HashMap<>();
+        ex.getBindingResult().getAllErrors().forEach((error) -> {
+            String fieldName = ((FieldError) error).getField();
+            String errorMessage = error.getDefaultMessage();
+            errors.put(fieldName, errorMessage);
+        });
+        if (logger.isDebugEnabled()) {
+            try {
+                String errorsAsString = new ObjectMapper().writeValueAsString(errors);
+                logger.debug("Invalid parameters\n{}", errorsAsString);
+            } catch (JsonProcessingException e) {
+                logger.warn("Failed to parse errors to json", e);
+            }
+        }
+        return ResponseEntity.badRequest().body(errors);
+    }
+}
diff --git a/src/main/java/com/alttd/forms/apply/StaffAppController.java b/src/main/java/com/alttd/forms/controlers/apply/StaffAppController.java
similarity index 87%
rename from src/main/java/com/alttd/forms/apply/StaffAppController.java
rename to src/main/java/com/alttd/forms/controlers/apply/StaffAppController.java
index 8383ea5..ee20cdd 100644
--- a/src/main/java/com/alttd/forms/apply/StaffAppController.java
+++ b/src/main/java/com/alttd/forms/controlers/apply/StaffAppController.java
@@ -1,4 +1,4 @@
-package com.alttd.forms.apply;
+package com.alttd.forms.controlers.apply;
 
 import com.alttd.forms.form.StoreFormQuery;
 import com.alttd.forms.mail.verification.VerificationResult;
@@ -8,10 +8,7 @@ import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springframework.http.HttpStatus;
 import org.springframework.http.ResponseEntity;
-import org.springframework.web.bind.annotation.PostMapping;
-import org.springframework.web.bind.annotation.RequestBody;
-import org.springframework.web.bind.annotation.RequestMapping;
-import org.springframework.web.bind.annotation.RestController;
+import org.springframework.web.bind.annotation.*;
 
 import java.util.concurrent.CompletableFuture;
 
diff --git a/src/main/java/com/alttd/forms/apply/StaffAppFormData.java b/src/main/java/com/alttd/forms/controlers/apply/StaffAppFormData.java
similarity index 99%
rename from src/main/java/com/alttd/forms/apply/StaffAppFormData.java
rename to src/main/java/com/alttd/forms/controlers/apply/StaffAppFormData.java
index 10d366d..52dc5a1 100644
--- a/src/main/java/com/alttd/forms/apply/StaffAppFormData.java
+++ b/src/main/java/com/alttd/forms/controlers/apply/StaffAppFormData.java
@@ -1,4 +1,4 @@
-package com.alttd.forms.apply;
+package com.alttd.forms.controlers.apply;
 
 import com.alttd.forms.form.Form;
 import jakarta.validation.constraints.*;
diff --git a/src/main/java/com/alttd/forms/contact/ContactController.java b/src/main/java/com/alttd/forms/controlers/contact/ContactController.java
similarity index 97%
rename from src/main/java/com/alttd/forms/contact/ContactController.java
rename to src/main/java/com/alttd/forms/controlers/contact/ContactController.java
index ff4b86c..715a4d0 100644
--- a/src/main/java/com/alttd/forms/contact/ContactController.java
+++ b/src/main/java/com/alttd/forms/controlers/contact/ContactController.java
@@ -1,4 +1,4 @@
-package com.alttd.forms.contact;
+package com.alttd.forms.controlers.contact;
 import com.alttd.forms.form.StoreFormQuery;
 import com.alttd.forms.mail.verification.VerificationResult;
 import com.alttd.forms.mail.verification.Verify;
diff --git a/src/main/java/com/alttd/forms/contact/ContactFormData.java b/src/main/java/com/alttd/forms/controlers/contact/ContactFormData.java
similarity index 98%
rename from src/main/java/com/alttd/forms/contact/ContactFormData.java
rename to src/main/java/com/alttd/forms/controlers/contact/ContactFormData.java
index 17111eb..01fdb46 100644
--- a/src/main/java/com/alttd/forms/contact/ContactFormData.java
+++ b/src/main/java/com/alttd/forms/controlers/contact/ContactFormData.java
@@ -1,4 +1,4 @@
-package com.alttd.forms.contact;
+package com.alttd.forms.controlers.contact;
 
 import com.alttd.forms.form.Form;
 import jakarta.validation.constraints.Email;
diff --git a/src/main/java/com/alttd/forms/verify_mail/FormQuery.java b/src/main/java/com/alttd/forms/verify_mail/FormQuery.java
index e351cbf..01e1283 100644
--- a/src/main/java/com/alttd/forms/verify_mail/FormQuery.java
+++ b/src/main/java/com/alttd/forms/verify_mail/FormQuery.java
@@ -1,6 +1,6 @@
 package com.alttd.forms.verify_mail;
 
-import com.alttd.forms.contact.ContactFormData;
+import com.alttd.forms.controlers.contact.ContactFormData;
 import com.alttd.forms.database.DatabaseConnection;
 import com.alttd.forms.form.Form;
 import com.fasterxml.jackson.core.JsonProcessingException;
diff --git a/src/test/java/TestForm.java b/src/test/java/TestForm.java
index a7060da..3d4db08 100644
--- a/src/test/java/TestForm.java
+++ b/src/test/java/TestForm.java
@@ -1,4 +1,4 @@
-import com.alttd.forms.contact.ContactFormData;
+import com.alttd.forms.controlers.contact.ContactFormData;
 import com.alttd.forms.form.StoreFormQuery;
 import com.alttd.forms.database.DatabaseConnection;
 import com.alttd.forms.form.Form;