Merge pull request #79 from it-at-m/feature/replace-hazelcast-with-database

Replace Hazelcast with database

Author: tobiasholler

captchaservice-backend/pom.xml

@@ -56,6 +56,12 @@
 
         <!-- Additional required dependencies -->
         <lombok-mapstruct-binding.version>0.2.0</lombok-mapstruct-binding.version> <!-- Needed to make MapStruct and Lombok work together -->
+
+        <!-- Flyway maven plugin configuration for local stack database -->
+        <flyway.url>jdbc:postgresql://localhost:5432/postgres</flyway.url>
+        <flyway.user>admin</flyway.user>
+        <flyway.password>admin</flyway.password>
+        <flyway.locations>classpath:db/migration/schema,classpath:db/migration/testdata</flyway.locations>
     </properties>
 
 
@@ -76,6 +82,14 @@
     <dependencies>
 
         <!-- Spring Boot -->
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-data-rest</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-data-jpa</artifactId>
+        </dependency>
         <dependency>
             <groupId>org.springframework.boot</groupId>
             <artifactId>spring-boot-starter-web</artifactId>
@@ -131,6 +145,30 @@
             <artifactId>json-path</artifactId>
         </dependency>
 
+        <!-- Database -->
+        <dependency>
+            <groupId>org.postgresql</groupId>
+            <artifactId>postgresql</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.hibernate.orm</groupId>
+            <artifactId>hibernate-core</artifactId>
+        </dependency>
+        <!-- Hibernate Model Gen for type safe criterias -->
+        <dependency>
+            <groupId>org.hibernate.orm</groupId>
+            <artifactId>hibernate-jpamodelgen</artifactId>
+        </dependency>
+        <!-- Database migrations -->
+        <dependency>
+            <groupId>org.flywaydb</groupId>
+            <artifactId>flyway-core</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.flywaydb</groupId>
+            <artifactId>flyway-database-postgresql</artifactId>
+        </dependency>
+
         <!-- Other -->
         <dependency>
             <groupId>org.apache.httpcomponents.client5</groupId>
@@ -189,6 +227,11 @@
             <artifactId>junit-jupiter</artifactId>
             <scope>test</scope>
         </dependency>
+        <dependency>
+            <groupId>org.testcontainers</groupId>
+            <artifactId>postgresql</artifactId>
+            <scope>test</scope>
+        </dependency>
         <dependency>
             <groupId>org.junit.jupiter</groupId>
             <artifactId>junit-jupiter-api</artifactId>
@@ -270,11 +313,6 @@
             <artifactId>altcha</artifactId>
             <version>1.1.2</version>
         </dependency>
-        <dependency>
-            <groupId>com.hazelcast</groupId>
-            <artifactId>hazelcast</artifactId>
-            <version>5.3.8</version>
-        </dependency>
     </dependencies>
 
     <scm>
@@ -447,6 +485,18 @@
                     </execution>
                 </executions>
             </plugin>
+            <plugin>
+                <!-- Flyway Maven plugin for local database management
+                     Usage:
+                     - Clean database: mvn flyway:clean
+                     - Apply migrations: mvn flyway:migrate
+                     - Reset and migrate: mvn flyway:clean flyway:migrate
+
+                     Note: Use -Dflyway.cleanDisabled=false when running clean command
+                -->
+                <groupId>org.flywaydb</groupId>
+                <artifactId>flyway-maven-plugin</artifactId>
+            </plugin>
         </plugins>
     </build>
 

captchaservice-backend/src/main/java/de/muenchen/captchaservice/MicroServiceApplication.java

@@ -3,12 +3,14 @@
 import org.springframework.boot.SpringApplication;
 import org.springframework.boot.autoconfigure.SpringBootApplication;
 import org.springframework.boot.context.properties.ConfigurationPropertiesScan;
+import org.springframework.scheduling.annotation.EnableScheduling;
 
 /**
  * Application class for starting the microservice.
  */
 @SpringBootApplication
 @ConfigurationPropertiesScan
+@EnableScheduling
 @SuppressWarnings("PMD.UseUtilityClass")
 public class MicroServiceApplication {
     public static void main(final String[] args) {

captchaservice-backend/src/main/java/de/muenchen/captchaservice/common/BaseEntity.java

@@ -0,0 +1,33 @@
+package de.muenchen.captchaservice.common;
+
+import jakarta.persistence.Column;
+import jakarta.persistence.GeneratedValue;
+import jakarta.persistence.GenerationType;
+import jakarta.persistence.Id;
+import jakarta.persistence.MappedSuperclass;
+import java.io.Serial;
+import java.io.Serializable;
+import java.util.UUID;
+import lombok.EqualsAndHashCode;
+import lombok.Getter;
+import lombok.NoArgsConstructor;
+import lombok.Setter;
+import lombok.ToString;
+
+@MappedSuperclass
+@NoArgsConstructor
+@Getter
+@Setter
+@ToString
+@EqualsAndHashCode
+public abstract class BaseEntity implements Serializable {
+
+    @Serial
+    private static final long serialVersionUID = 1L;
+
+    @Column(name = "id", length = 36)
+    @Id
+    @GeneratedValue(strategy = GenerationType.UUID)
+    private UUID id;
+
+}

captchaservice-backend/src/main/java/de/muenchen/captchaservice/common/HazelcastConstants.java

@@ -0,0 +1,45 @@
+package de.muenchen.captchaservice.entity;
+
+import de.muenchen.captchaservice.common.BaseEntity;
+import jakarta.persistence.Column;
+import jakarta.persistence.Entity;
+import jakarta.persistence.Index;
+import jakarta.persistence.Table;
+import jakarta.validation.constraints.NotNull;
+import jakarta.validation.constraints.Size;
+import lombok.*;
+
+import java.time.Instant;
+
+@Entity
+@Table(
+        indexes = {
+                @Index(name = "idx_captcha_request_source_address_hash", columnList = "sourceAddressHash"),
+                @Index(name = "idx_captcha_request_expires_at", columnList = "expiresAt")
+        }
+)
+
+// Definition of getter, setter, ...
+@Getter
+@Setter
+@ToString(callSuper = true)
+@EqualsAndHashCode(callSuper = true)
+@NoArgsConstructor
+@AllArgsConstructor
+public class CaptchaRequest extends BaseEntity {
+
+    private static final long serialVersionUID = 1L;
+
+    // ========= //
+    // Variables //
+    // ========= //
+
+    @Column(nullable = false, length = 64)
+    @NotNull
+    @Size(min = 64, max = 64)
+    private String sourceAddressHash;
+
+    @NotNull
+    private Instant expiresAt;
+
+}

captchaservice-backend/src/main/java/de/muenchen/captchaservice/configuration/hazelcast/HazelcastConfiguration.java

@@ -0,0 +1,44 @@
+package de.muenchen.captchaservice.entity;
+
+import de.muenchen.captchaservice.common.BaseEntity;
+import jakarta.persistence.Column;
+import jakarta.persistence.Entity;
+import jakarta.persistence.Index;
+import jakarta.persistence.Table;
+import jakarta.validation.constraints.NotNull;
+import jakarta.validation.constraints.Size;
+import lombok.*;
+
+import java.time.Instant;
+
+@Entity
+@Table(
+        indexes = {
+                @Index(name = "idx_invalidated_payload_payload_hash", columnList = "payloadHash"),
+                @Index(name = "idx_invalidated_payload_expires_at", columnList = "expiresAt")
+        }
+)
+// Definition of getter, setter, ...
+@Getter
+@Setter
+@ToString(callSuper = true)
+@EqualsAndHashCode(callSuper = true)
+@NoArgsConstructor
+@AllArgsConstructor
+public class InvalidatedPayload extends BaseEntity {
+
+    private static final long serialVersionUID = 1L;
+
+    // ========= //
+    // Variables //
+    // ========= //
+
+    @Column(nullable = false, length = 64)
+    @NotNull
+    @Size(min = 64, max = 64)
+    private String payloadHash;
+
+    @NotNull
+    private Instant expiresAt;
+
+}

captchaservice-backend/src/main/java/de/muenchen/captchaservice/configuration/hazelcast/HazelcastProperties.java

@@ -0,0 +1,16 @@
+package de.muenchen.captchaservice.repository;
+
+import de.muenchen.captchaservice.entity.CaptchaRequest;
+import org.springframework.data.repository.CrudRepository;
+import org.springframework.data.repository.PagingAndSortingRepository;
+
+import java.time.Instant;
+import java.util.UUID;
+
+public interface CaptchaRequestRepository extends PagingAndSortingRepository<CaptchaRequest, UUID>, CrudRepository<CaptchaRequest, UUID> {
+    long countBySourceAddressHashIgnoreCaseAndExpiresAtGreaterThanEqual(String sourceAddressHash, Instant validUntil);
+
+    long deleteByExpiresAtLessThan(Instant validUntil);
+
+    int countBySourceAddressHashIgnoreCase(String sourceAddressHash);
+}

captchaservice-backend/src/main/java/de/muenchen/captchaservice/entity/CaptchaRequest.java

@@ -0,0 +1,16 @@
+package de.muenchen.captchaservice.repository;
+
+import de.muenchen.captchaservice.entity.InvalidatedPayload;
+import org.springframework.data.repository.CrudRepository;
+import org.springframework.data.repository.PagingAndSortingRepository;
+
+import java.time.Instant;
+import java.util.UUID;
+
+public interface InvalidatedPayloadRepository extends PagingAndSortingRepository<InvalidatedPayload, UUID>, CrudRepository<InvalidatedPayload, UUID> {
+    long countByPayloadHashIgnoreCaseAndExpiresAtGreaterThanEqual(String payloadHash, Instant validUntil);
+
+    long deleteByExpiresAtLessThan(Instant validUntil);
+
+    long countByPayloadHash(String payloadHash);
+}