From 4a0aebce8248a2fcb486af575e76cf1a85e66c5a Mon Sep 17 00:00:00 2001
From: Teriuihi <teriuihi@alttd.com>
Date: Sun, 11 Aug 2024 18:21:16 +0200
Subject: [PATCH] Improve email handling with Mailable interface

Added a new Mailable interface for extracting email-related data like receiver and subject. Updated StaffAppFormData and ContactFormData to implement this interface, and refactored MailForm to utilize these details. This enhances flexibility and decouples email details from form classes.
---
 .idea/workspace.xml                           | 41 +++++++++++++++----
 .../controlers/apply/StaffAppFormData.java    |  9 +++-
 .../controlers/contact/ContactFormData.java   |  9 +++-
 src/main/java/com/alttd/forms/form/Form.java  |  2 -
 .../alttd/forms/mail/mail_forms/MailForm.java |  6 +--
 .../alttd/forms/mail/mail_forms/Mailable.java |  9 ++++
 .../forms/verify_mail/VerifyController.java   |  5 ++-
 7 files changed, 66 insertions(+), 15 deletions(-)
 create mode 100644 src/main/java/com/alttd/forms/mail/mail_forms/Mailable.java

diff --git a/.idea/workspace.xml b/.idea/workspace.xml
index f41ce3c..7b2c1af 100644
--- a/.idea/workspace.xml
+++ b/.idea/workspace.xml
@@ -4,8 +4,12 @@
     <option name="autoReloadType" value="SELECTIVE" />
   </component>
   <component name="ChangeListManager">
-    <list default="true" id="ce59df2a-8d56-446a-867b-80e627daf479" name="Changes" comment="Add JSON response handling for form activity check&#10;&#10;Refactor `FormActiveController` to return JSON responses using `BooleanResponse`. Introduce exception handling for JSON processing errors and update `FormActiveData` to allow object initialization without parameters.">
+    <list default="true" id="ce59df2a-8d56-446a-867b-80e627daf479" name="Changes" comment="Add branch condition to Discord notification stage&#10;&#10;The Discord notification stage now runs only on 'main' or 'master' branches. This helps to avoid unnecessary notifications for feature or bugfix branches.">
+      <change afterPath="$PROJECT_DIR$/src/main/java/com/alttd/forms/mail/mail_forms/Mailable.java" afterDir="false" />
       <change beforePath="$PROJECT_DIR$/.idea/workspace.xml" beforeDir="false" afterPath="$PROJECT_DIR$/.idea/workspace.xml" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/src/main/java/com/alttd/forms/controlers/contact/ContactFormData.java" beforeDir="false" afterPath="$PROJECT_DIR$/src/main/java/com/alttd/forms/controlers/contact/ContactFormData.java" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/src/main/java/com/alttd/forms/form/Form.java" beforeDir="false" afterPath="$PROJECT_DIR$/src/main/java/com/alttd/forms/form/Form.java" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/src/main/java/com/alttd/forms/mail/mail_forms/MailForm.java" beforeDir="false" afterPath="$PROJECT_DIR$/src/main/java/com/alttd/forms/mail/mail_forms/MailForm.java" afterDir="false" />
     </list>
     <option name="SHOW_DIALOG" value="false" />
     <option name="HIGHLIGHT_CONFLICTS" value="true" />
@@ -50,6 +54,7 @@
         <option value="package.json" />
         <option value="Class" />
         <option value="Record" />
+        <option value="Interface" />
       </list>
     </option>
   </component>
@@ -76,6 +81,14 @@
     &quot;accountId&quot;: &quot;ad9eb076-a98f-40c2-b7e5-9fc28b23038f&quot;
   }
 }</component>
+  <component name="HighlightingSettingsPerFile">
+    <setting file="jar://$USER_HOME$/.gradle/caches/modules-2/files-2.1/javax.mail/mail/1.4/1aa1579ae5ecd41920c4f355b0a9ef40b68315dd/mail-1.4.jar!/javax/mail/Part.class" root0="SKIP_INSPECTION" />
+  </component>
+  <component name="Jenkins.Settings">
+    <option name="jenkinsUrl" value="https://jenkins.alttd.com" />
+    <option name="lastSelectedView" value="all" />
+    <option name="username" value="stijn" />
+  </component>
   <component name="KubernetesApiProvider">{
   &quot;isMigrated&quot;: true
 }</component>
@@ -117,7 +130,6 @@
     "RequestMappingsPanelWidth1": "75",
     "RunOnceActivity.OpenProjectViewOnStart": "true",
     "RunOnceActivity.ShowReadmeOnStart": "true",
-    "SHARE_PROJECT_CONFIGURATION_FILES": "true",
     "Spring Boot.Main.executor": "Run",
     "Tomcat Server.Tomcat 10.1.17.executor": "Run",
     "git-widget-placeholder": "master",
@@ -133,7 +145,7 @@
     "project.structure.proportion": "0.0",
     "project.structure.side.proportion": "0.0",
     "run.code.analysis.last.selected.profile": "pProject Default",
-    "settings.editor.selected.configurable": "preferences.lookFeel",
+    "settings.editor.selected.configurable": "org.codinjutsu.tools.jenkins.servers",
     "vue.rearranger.settings.migration": "true"
   },
   "keyToStringList": {
@@ -382,6 +394,9 @@
       <workItem from="1723138548381" duration="1949000" />
       <workItem from="1723230192640" duration="55000" />
       <workItem from="1723242314809" duration="9799000" />
+      <workItem from="1723307861750" duration="2179000" />
+      <workItem from="1723392202182" duration="258000" />
+      <workItem from="1723392471077" duration="533000" />
     </task>
     <task id="LOCAL-00001" summary="Initial commit for site for forms">
       <option name="closed" value="true" />
@@ -647,7 +662,15 @@
       <option name="project" value="LOCAL" />
       <updated>1723249968746</updated>
     </task>
-    <option name="localTasksCounter" value="34" />
+    <task id="LOCAL-00034" summary="Add branch condition to Discord notification stage&#10;&#10;The Discord notification stage now runs only on 'main' or 'master' branches. This helps to avoid unnecessary notifications for feature or bugfix branches.">
+      <option name="closed" value="true" />
+      <created>1723392636255</created>
+      <option name="number" value="00034" />
+      <option name="presentableId" value="LOCAL-00034" />
+      <option name="project" value="LOCAL" />
+      <updated>1723392636255</updated>
+    </task>
+    <option name="localTasksCounter" value="35" />
     <servers />
   </component>
   <component name="TypeScriptGeneratedFilesManager">
@@ -665,8 +688,6 @@
     </option>
   </component>
   <component name="VcsManagerConfiguration">
-    <MESSAGE value="Configure system property for conditional test execution&#10;&#10;Added a system property 'doNotRunDatabaseTests' in the test configuration to allow conditional skipping of database tests. This helps in running tests selectively during different build scenarios." />
-    <MESSAGE value="Add CORS support for production server&#10;&#10;Updated the CORS configuration to include the production server URL. This change ensures that requests from the production environment are properly handled." />
     <MESSAGE value="Refactor logging for better granularity&#10;&#10;Updated logging levels in multiple classes to differentiate between debug and trace information. Improved log messages to support parameterized logs, ensuring sensitive or variable information is handled appropriately without concatenation." />
     <MESSAGE value="Enhance logging for mail verification details&#10;&#10;Updated logging to provide more detailed information about user credentials and email actions. This helps in debugging and monitoring mail verification processes more effectively. Adjusted trace messages to include username and password for better traceability." />
     <MESSAGE value="Update URI to point to Discord bot endpoint&#10;&#10;Changed the URI in VerifyController to use the Discord bot's endpoint for form submission. This adjustment is part of the process to route form data correctly through the specified internal service." />
@@ -690,6 +711,12 @@
     <MESSAGE value="Refactor form request handling and add rate limiting.&#10;&#10;Consolidate email verification logic into FormRequestHandler to simplify code maintenance. Implement a new rate limiting feature to restrict form submissions based on IP and email address, improving server security and performance." />
     <MESSAGE value="Add form activity checking and global rate limiting&#10;&#10;Implemented new features to track form activity and enforce global rate limits. Added a `form_active` table and created endpoints to check form activity. Also, introduced a rate-limiting filter to restrict API requests to 30 per minute per IP." />
     <MESSAGE value="Ensure NOT NULL constraints in SQL tables&#10;&#10;Refactor SQL table creation scripts to add NOT NULL constraints where necessary. This change ensures data integrity by preventing null values in critical columns across the 'verify_form', 'form', 'rate_limit', and 'form_active' tables." />
-    <option name="LAST_COMMIT_MESSAGE" value="Ensure NOT NULL constraints in SQL tables&#10;&#10;Refactor SQL table creation scripts to add NOT NULL constraints where necessary. This change ensures data integrity by preventing null values in critical columns across the 'verify_form', 'form', 'rate_limit', and 'form_active' tables." />
+    <MESSAGE value="Add JSON response handling for form activity check&#10;&#10;Refactor `FormActiveController` to return JSON responses using `BooleanResponse`. Introduce exception handling for JSON processing errors and update `FormActiveData` to allow object initialization without parameters." />
+    <MESSAGE value="Add branch condition to Discord notification stage&#10;&#10;The Discord notification stage now runs only on 'main' or 'master' branches. This helps to avoid unnecessary notifications for feature or bugfix branches." />
+    <option name="LAST_COMMIT_MESSAGE" value="Add branch condition to Discord notification stage&#10;&#10;The Discord notification stage now runs only on 'main' or 'master' branches. This helps to avoid unnecessary notifications for feature or bugfix branches." />
+  </component>
+  <component name="XSLT-Support.FileAssociations.UIState">
+    <expand />
+    <select />
   </component>
 </project>
\ No newline at end of file
diff --git a/src/main/java/com/alttd/forms/controlers/apply/StaffAppFormData.java b/src/main/java/com/alttd/forms/controlers/apply/StaffAppFormData.java
index 44adb25..da4cdd8 100644
--- a/src/main/java/com/alttd/forms/controlers/apply/StaffAppFormData.java
+++ b/src/main/java/com/alttd/forms/controlers/apply/StaffAppFormData.java
@@ -1,6 +1,7 @@
 package com.alttd.forms.controlers.apply;
 
 import com.alttd.forms.form.Form;
+import com.alttd.forms.mail.mail_forms.Mailable;
 import com.fasterxml.jackson.annotation.JsonIgnore;
 import jakarta.validation.constraints.*;
 import org.hibernate.validator.constraints.Length;
@@ -9,7 +10,7 @@ import org.hibernate.validator.constraints.Range;
 import java.time.LocalDate;
 import java.util.Optional;
 
-public class StaffAppFormData extends Form {
+public class StaffAppFormData extends Form implements Mailable {
 
     public StaffAppFormData() {}
 
@@ -125,6 +126,12 @@ public class StaffAppFormData extends Form {
         return "apply@alttd.com";
     }
 
+    @JsonIgnore
+    @Override
+    public String getSubject() {
+        return "Staff Application: " + username;
+    }
+
     @JsonIgnore
     @Override
     public String getSender() {
diff --git a/src/main/java/com/alttd/forms/controlers/contact/ContactFormData.java b/src/main/java/com/alttd/forms/controlers/contact/ContactFormData.java
index 2ca646e..417d0a8 100644
--- a/src/main/java/com/alttd/forms/controlers/contact/ContactFormData.java
+++ b/src/main/java/com/alttd/forms/controlers/contact/ContactFormData.java
@@ -1,6 +1,7 @@
 package com.alttd.forms.controlers.contact;
 
 import com.alttd.forms.form.Form;
+import com.alttd.forms.mail.mail_forms.Mailable;
 import com.fasterxml.jackson.annotation.JsonIgnore;
 import jakarta.validation.constraints.Email;
 import jakarta.validation.constraints.NotEmpty;
@@ -9,7 +10,7 @@ import org.hibernate.validator.constraints.Length;
 
 import java.util.Optional;
 
-public class ContactFormData extends Form {
+public class ContactFormData extends Form implements Mailable {
 
     public ContactFormData() {}
 
@@ -54,6 +55,12 @@ public class ContactFormData extends Form {
         return "support@alttd.com";
     }
 
+    @JsonIgnore
+    @Override
+    public String getSubject() {
+        return "Contact form: " + username;
+    }
+
     @JsonIgnore
     @Override
     public String getSender() {
diff --git a/src/main/java/com/alttd/forms/form/Form.java b/src/main/java/com/alttd/forms/form/Form.java
index 7f4cd7c..d0a722a 100644
--- a/src/main/java/com/alttd/forms/form/Form.java
+++ b/src/main/java/com/alttd/forms/form/Form.java
@@ -45,7 +45,5 @@ public abstract class Form {
 
     public abstract Optional<String> getDiscordBotUrl();
 
-    public abstract String getReceiver();
-
     public abstract String getSender();
 }
diff --git a/src/main/java/com/alttd/forms/mail/mail_forms/MailForm.java b/src/main/java/com/alttd/forms/mail/mail_forms/MailForm.java
index 4ce0f2d..1bb8b25 100644
--- a/src/main/java/com/alttd/forms/mail/mail_forms/MailForm.java
+++ b/src/main/java/com/alttd/forms/mail/mail_forms/MailForm.java
@@ -15,7 +15,8 @@ public class MailForm {
 
     private static final Logger logger = LoggerFactory.getLogger(MailForm.class);
 
-    public static void sendForm(String receiver, Form form) {
+    public static void sendForm(Form form, Mailable mailable) {
+        String receiver = mailable.getReceiver();
         Properties mailProperties = MailSettings.getMailProperties();
         Optional<PasswordAuthentication> accountDetails = MailSettings.getAccountDetails();
         if (accountDetails.isEmpty()) {
@@ -32,8 +33,7 @@ public class MailForm {
                     Message.RecipientType.TO,
                     InternetAddress.parse(receiver)
             );
-            message.setSubject("Altitude Form");
-            //TODO add something above the html form probably
+            message.setSubject(mailable.getSubject());
             message.setContent(form.toHtml(), "text/html");
             try {
                 Transport.send(message);
diff --git a/src/main/java/com/alttd/forms/mail/mail_forms/Mailable.java b/src/main/java/com/alttd/forms/mail/mail_forms/Mailable.java
new file mode 100644
index 0000000..690a1d0
--- /dev/null
+++ b/src/main/java/com/alttd/forms/mail/mail_forms/Mailable.java
@@ -0,0 +1,9 @@
+package com.alttd.forms.mail.mail_forms;
+
+public interface Mailable {
+
+    String getReceiver();
+
+    String getSubject();
+
+}
diff --git a/src/main/java/com/alttd/forms/verify_mail/VerifyController.java b/src/main/java/com/alttd/forms/verify_mail/VerifyController.java
index d84e0f8..eb991ad 100644
--- a/src/main/java/com/alttd/forms/verify_mail/VerifyController.java
+++ b/src/main/java/com/alttd/forms/verify_mail/VerifyController.java
@@ -1,7 +1,9 @@
 package com.alttd.forms.verify_mail;
 
+import com.alttd.forms.controlers.apply.StaffAppFormData;
 import com.alttd.forms.form.Form;
 import com.alttd.forms.mail.mail_forms.MailForm;
+import com.alttd.forms.mail.mail_forms.Mailable;
 import com.fasterxml.jackson.core.JsonProcessingException;
 import jakarta.validation.Valid;
 import org.slf4j.Logger;
@@ -41,7 +43,8 @@ public class VerifyController {
                             return stringResponseEntity.get();
                         }
                     }
-                    MailForm.sendForm(form.getReceiver(), form);
+                    if (form instanceof Mailable mailable)
+                        MailForm.sendForm(form, mailable);
                     try {
                         return ResponseEntity.ok(form.toJsonString());
                     } catch (JsonProcessingException e) {