fix: entity bugs fixed (#12)

 - using mappers properly
 - entity bugs fixed: lombok `@Data` annotation is risky with JPA
 - input validations done via jakarka
 - exceptions added
 - using `BigDecimal` for money instead of `Double`

---------

Signed-off-by: Rajdeep Roy Chowdhury <rrajdeeproychowdhury@gmail.com>

Author: Razdeep

build.gradle.kts

@@ -44,14 +44,15 @@ dependencies {
     implementation(libs.gson)
     implementation(libs.spring.boot.starter.freemarker)
     implementation(libs.openhtml)
+    implementation(libs.spring.boot.starter.validation)
 
     compileOnly(libs.lombok)
     annotationProcessor(libs.lombok)
 
     implementation(libs.mapstruct)
     annotationProcessor(libs.mapstruct.processor)
 
-    annotationProcessor("org.projectlombok:lombok-mapstruct-binding:0.2.0")
+    annotationProcessor(libs.lombok.mapstruct.binding)
 
     implementation(libs.spring.boot.starter.actuator)
     implementation(libs.springdoc.openapi.ui)

gradle/libs.versions.toml

@@ -5,7 +5,8 @@ jaxb = "2.4.0-b180830.0359"
 postgres = "42.7.8"
 gson = "2.10"
 lombok = "1.18.30" # put actual version you use
-mapstruct = "1.5.3.Final"
+lombokmapstruct = "0.2.0"
+mapstruct = "1.6.3"
 springdoc = "1.6.14"
 jedis = "4.4.2"
 jackson = "2.15.0"
@@ -23,12 +24,14 @@ spring-boot-starter-data-redis = { module = "org.springframework.boot:spring-boo
 spring-boot-starter-cache = { module = "org.springframework.boot:spring-boot-starter-cache", version = "2.4.3" }
 spring-boot-starter-test = { module = "org.springframework.boot:spring-boot-starter-test" }
 spring-boot-starter-freemarker = { module = "org.springframework.boot:spring-boot-starter-freemarker" }
+spring-boot-starter-validation = { module = "org.springframework.boot:spring-boot-starter-validation" }
 
 jjwt = { module = "io.jsonwebtoken:jjwt", version.ref = "jjwt" }
 jaxb-api = { module = "javax.xml.bind:jaxb-api", version.ref = "jaxb" }
 postgres-connector = { module = "org.postgresql:postgresql", version.ref = "postgres" }
 gson = { module = "com.google.code.gson:gson", version.ref = "gson" }
 lombok = { module = "org.projectlombok:lombok", version.ref = "lombok" }
+lombok-mapstruct-binding = { module = "org.projectlombok:lombok-mapstruct-binding", version.ref = "lombokmapstruct" }
 
 mapstruct = { module = "org.mapstruct:mapstruct", version.ref = "mapstruct" }
 mapstruct-processor = { module = "org.mapstruct:mapstruct-processor", version.ref = "mapstruct" }

src/main/java/com/razdeep/konsignapi/controller/AuthenticationController.java

@@ -7,6 +7,7 @@
 import com.razdeep.konsignapi.service.RefreshTokenService;
 import com.razdeep.konsignapi.token.TokenPair;
 import jakarta.servlet.http.HttpServletResponse;
+import jakarta.validation.Valid;
 import org.springframework.http.HttpHeaders;
 import org.springframework.http.HttpStatus;
 import org.springframework.http.ResponseCookie;
@@ -29,7 +30,7 @@ public AuthenticationController(
 
     @PostMapping("/login")
     public ResponseEntity<KonsignApiResponse> login(
-            @RequestBody AuthenticationRequest authenticationRequest, HttpServletResponse response) {
+            @Valid @RequestBody AuthenticationRequest authenticationRequest, HttpServletResponse response) {
 
         TokenPair tokenPair = authenticationService.login(authenticationRequest);
 
@@ -42,8 +43,7 @@ public ResponseEntity<KonsignApiResponse> login(
 
         response.addHeader(HttpHeaders.SET_COOKIE, cookie.toString());
 
-        AuthenticationResponse authenticationResponse = new AuthenticationResponse();
-        authenticationResponse.setAccessToken(tokenPair.accessToken());
+        AuthenticationResponse authenticationResponse = new AuthenticationResponse(tokenPair.accessToken());
 
         return ResponseEntity.ok(KonsignApiResponse.builder()
                 .success(true)
@@ -64,7 +64,7 @@ public ResponseEntity<KonsignApiResponse> refresh(
     }
 
     @PostMapping(value = "/signup")
-    public ResponseEntity<KonsignApiResponse> signup(@RequestBody UserRegistration userRegistration)
+    public ResponseEntity<KonsignApiResponse> signup(@Valid @RequestBody UserRegistration userRegistration)
             throws UsernameAlreadyExists {
         authenticationService.register(userRegistration);
         KonsignApiResponse konsignApiResponse = KonsignApiResponse.builder()

src/main/java/com/razdeep/konsignapi/controller/BillController.java

@@ -5,6 +5,7 @@
 import com.razdeep.konsignapi.model.KonsignApiResponse;
 import com.razdeep.konsignapi.service.BillService;
 import io.micrometer.core.annotation.Timed;
+import jakarta.validation.Valid;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springframework.http.HttpStatus;
@@ -27,34 +28,24 @@ public BillController(BillService billService) {
 
     @Timed
     @PostMapping
-    public ResponseEntity<KonsignApiResponse> addBillEntry(@RequestBody Bill bill) {
-        ResponseEntity<KonsignApiResponse> response;
-        KonsignApiResponse konsignApiResponse = new KonsignApiResponse();
+    public ResponseEntity<KonsignApiResponse> addBillEntry(@Valid @RequestBody Bill bill) {
 
-        if (bill.anyFieldEmpty()) {
-            konsignApiResponse.setMessage("Saving bill failed because all fields are not properly filled");
-            response = new ResponseEntity<>(konsignApiResponse, HttpStatus.NOT_ACCEPTABLE);
-        } else if (billService.enterBill(bill)) {
-            konsignApiResponse.setMessage("Successfully saved bill");
-            response = new ResponseEntity<>(konsignApiResponse, HttpStatus.OK);
-        } else {
-            konsignApiResponse.setMessage("Saving bill failed");
-            response = new ResponseEntity<>(konsignApiResponse, HttpStatus.NOT_ACCEPTABLE);
-        }
-        return response;
+        billService.addBill(bill);
+        KonsignApiResponse konsignApiResponse = KonsignApiResponse.builder()
+                .message("Successfully saved bill")
+                .success(true)
+                .build();
+
+        return ResponseEntity.ok(konsignApiResponse);
     }
 
     @Timed
     @GetMapping("/{billNo}")
     public ResponseEntity<KonsignApiResponse> getBill(@PathVariable String billNo) {
         final var bill = billService.getBill(billNo);
-        KonsignApiResponse konsignApiResponse = new KonsignApiResponse();
-        if (bill == null) {
-            konsignApiResponse.setMessage("Bill not found");
-            return new ResponseEntity<>(konsignApiResponse, HttpStatus.NOT_FOUND);
-        }
-        konsignApiResponse.setData(bill);
-        return new ResponseEntity<>(konsignApiResponse, HttpStatus.OK);
+        KonsignApiResponse konsignApiResponse =
+                KonsignApiResponse.builder().success(true).data(bill).build();
+        return ResponseEntity.ok(konsignApiResponse);
     }
 
     @Timed
@@ -66,13 +57,8 @@ public ResponseEntity<KonsignApiResponse> getAllBills(
         final var bills = billService.getAllBills(offset, pageSize);
         stopWatch.stop();
         LOG.info("billEntryService.getAllBills() took {} ms", stopWatch.getLastTaskTimeMillis());
-        KonsignApiResponse konsignApiResponse = new KonsignApiResponse();
-        if (bills == null) {
-            konsignApiResponse.setMessage("Bill not found");
-            return new ResponseEntity<>(konsignApiResponse, HttpStatus.NOT_FOUND);
-        }
-        konsignApiResponse.setData(bills);
-        return new ResponseEntity<>(konsignApiResponse, HttpStatus.OK);
+        return new ResponseEntity<>(
+                KonsignApiResponse.builder().success(true).data(bills).build(), HttpStatus.OK);
     }
 
     @Timed

src/main/java/com/razdeep/konsignapi/entity/BaseTimestamp.java

@@ -3,12 +3,14 @@
 import jakarta.persistence.Column;
 import jakarta.persistence.MappedSuperclass;
 import java.time.LocalDateTime;
-import lombok.Data;
+import lombok.Getter;
+import lombok.Setter;
 import org.hibernate.annotations.CreationTimestamp;
 import org.hibernate.annotations.UpdateTimestamp;
 
 @MappedSuperclass
-@Data
+@Getter
+@Setter
 public class BaseTimestamp {
 
     @CreationTimestamp

src/main/java/com/razdeep/konsignapi/entity/BillEntity.java

@@ -1,6 +1,7 @@
 package com.razdeep.konsignapi.entity;
 
 import jakarta.persistence.*;
+import java.math.BigDecimal;
 import java.time.LocalDate;
 import java.util.List;
 import lombok.*;
@@ -31,7 +32,9 @@ public class BillEntity extends BaseTimestamp {
     private TransportEntity transportEntity;
 
     private LocalDate lrDate;
-    private Double billAmount;
+
+    @Column(nullable = false, precision = 15, scale = 2)
+    private BigDecimal billAmount;
 
     @OneToMany(cascade = CascadeType.ALL, mappedBy = "billEntry")
     private List<LrPmEntity> lrPmEntityList;

src/main/java/com/razdeep/konsignapi/entity/CollectionVoucherItemEntity.java

@@ -1,6 +1,7 @@
 package com.razdeep.konsignapi.entity;
 
 import jakarta.persistence.*;
+import java.math.BigDecimal;
 import java.time.LocalDate;
 import lombok.*;
 
@@ -25,7 +26,8 @@ public class CollectionVoucherItemEntity extends BaseTimestamp {
     @JoinColumn(name = "bill_bill_no")
     BillEntity bill;
 
-    Double amountCollected;
+    @Column(nullable = false, precision = 15, scale = 2)
+    BigDecimal amountCollected;
 
     String bank;
 

src/main/java/com/razdeep/konsignapi/entity/RefreshTokenEntity.java

@@ -3,14 +3,12 @@
 import jakarta.persistence.*;
 import java.time.Instant;
 import java.util.UUID;
-import lombok.AllArgsConstructor;
-import lombok.Builder;
-import lombok.Data;
-import lombok.NoArgsConstructor;
+import lombok.*;
 
 @Entity
 @Table(name = "refresh_tokens")
-@Data
+@Getter
+@Setter
 @AllArgsConstructor
 @NoArgsConstructor
 @Builder

src/main/java/com/razdeep/konsignapi/exception/GlobalExceptionHandler.java

@@ -1,11 +1,14 @@
 package com.razdeep.konsignapi.exception;
 
 import com.razdeep.konsignapi.model.KonsignApiResponse;
+import java.util.ArrayList;
+import java.util.List;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springframework.http.HttpStatus;
 import org.springframework.http.ResponseEntity;
 import org.springframework.security.authentication.BadCredentialsException;
+import org.springframework.web.bind.MethodArgumentNotValidException;
 import org.springframework.web.bind.annotation.ExceptionHandler;
 import org.springframework.web.bind.annotation.RestControllerAdvice;
 
@@ -56,4 +59,36 @@ public ResponseEntity<KonsignApiResponse> handleGenericException(Exception ex) {
         return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR)
                 .body(new KonsignApiResponse(false, "An unexpected error occurred", null));
     }
+
+    @ExceptionHandler(MethodArgumentNotValidException.class)
+    public ResponseEntity<KonsignApiResponse> handleValidationErrors(MethodArgumentNotValidException ex) {
+
+        List<String> missingFields = new ArrayList<>();
+
+        ex.getBindingResult().getFieldErrors().forEach(error -> missingFields.add(error.getField()));
+
+        String message = String.join(",", missingFields) + " not properly passed";
+
+        return ResponseEntity.badRequest()
+                .body(KonsignApiResponse.builder()
+                        .success(false)
+                        .message(message)
+                        .build());
+    }
+
+    @ExceptionHandler(ResourceNotFoundException.class)
+    public ResponseEntity<KonsignApiResponse> handleValidationErrors(ResourceNotFoundException ex) {
+
+        LOG.info("Resource not found", ex);
+
+        return ResponseEntity.status(HttpStatus.NOT_FOUND).body(new KonsignApiResponse(false, ex.getMessage(), null));
+    }
+
+    @ExceptionHandler(SaveResourceException.class)
+    public ResponseEntity<KonsignApiResponse> handleValidationErrors(SaveResourceException ex) {
+
+        LOG.info("Resource could not be saved", ex);
+
+        return ResponseEntity.status(HttpStatus.BAD_REQUEST).body(new KonsignApiResponse(false, ex.getMessage(), null));
+    }
 }

src/main/java/com/razdeep/konsignapi/exception/ResourceNotFoundException.java

@@ -0,0 +1,7 @@
+package com.razdeep.konsignapi.exception;
+
+public class ResourceNotFoundException extends RuntimeException {
+    public ResourceNotFoundException(String message) {
+        super(message);
+    }
+}