feature/conluz-108 to main (#117)

* [conluz-108] Added field addressRef to supply. Added new exception filter to catch unexpected errors

* [conluz-108] Changed position of global exception handler to delegate invalid token errors to the specific filter. Fixed tests.

* [conluz-108] Configured error builder to add same trace ID for logs and API error responses

Author: viktorKhan

src/main/java/org/lucoenergia/conluz/domain/admin/supply/Supply.java

@@ -23,6 +23,7 @@ public class Supply {
     private String name;
     @NotBlank
     private String address;
+    private String addressRef;
     @NotNull
     @PositiveOrZero
     private Float partitionCoefficient;
@@ -44,6 +45,7 @@ private Supply(Builder builder) {
         this.user = builder.user;
         this.name = builder.name;
         this.address = builder.address;
+        this.addressRef = builder.addressRef;
         this.partitionCoefficient = builder.partitionCoefficient;
         this.enabled = builder.enabled;
         this.validDateFrom = builder.validDateFrom;
@@ -70,6 +72,7 @@ public static class Builder {
         private User user;
         private String name;
         private String address;
+        private String addressRef;
         private Float partitionCoefficient;
         private Boolean enabled;
         private LocalDate validDateFrom;
@@ -106,6 +109,11 @@ public Builder withAddress(String address) {
             return this;
         }
 
+        public Builder withAddressRef(String addressRef) {
+            this.addressRef = addressRef;
+            return this;
+        }
+
         public Builder withPartitionCoefficient(Float partitionCoefficient) {
             this.partitionCoefficient = partitionCoefficient;
             return this;
@@ -185,6 +193,10 @@ public String getAddress() {
         return address;
     }
 
+    public String getAddressRef() {
+        return addressRef;
+    }
+
     public Float getPartitionCoefficient() {
         return partitionCoefficient;
     }
@@ -217,6 +229,10 @@ public void setAddress(String address) {
         this.address = address;
     }
 
+    public void setAddressRef(String addressRef) {
+        this.addressRef = addressRef;
+    }
+
     public void setValidDateFrom(LocalDate validDateFrom) {
         this.validDateFrom = validDateFrom;
     }

src/main/java/org/lucoenergia/conluz/infrastructure/admin/supply/SharingAgreementExceptionHandler.java

@@ -1,9 +1,8 @@
 package org.lucoenergia.conluz.infrastructure.admin.supply;
 
 import org.lucoenergia.conluz.domain.admin.supply.SharingAgreementNotFoundException;
+import org.lucoenergia.conluz.infrastructure.shared.error.ErrorBuilder;
 import org.lucoenergia.conluz.infrastructure.shared.web.error.RestError;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
 import org.springframework.context.MessageSource;
 import org.springframework.context.i18n.LocaleContextHolder;
 import org.springframework.http.HttpStatus;
@@ -16,13 +15,12 @@
 @RestControllerAdvice
 public class SharingAgreementExceptionHandler {
 
-
-    private static final Logger LOGGER = LoggerFactory.getLogger(SharingAgreementExceptionHandler.class);
-
     private final MessageSource messageSource;
+    private final ErrorBuilder errorBuilder;
 
-    public SharingAgreementExceptionHandler(MessageSource messageSource) {
+    public SharingAgreementExceptionHandler(MessageSource messageSource, ErrorBuilder errorBuilder) {
         this.messageSource = messageSource;
+        this.errorBuilder = errorBuilder;
     }
 
     @ExceptionHandler(SharingAgreementNotFoundException.class)
@@ -35,7 +33,6 @@ public ResponseEntity<RestError> handleException(SharingAgreementNotFoundExcepti
                 Collections.singletonList(sharingAgreementId).toArray(),
                 LocaleContextHolder.getLocale()
         );
-        LOGGER.error(message);
-        return new ResponseEntity<>(new RestError(HttpStatus.BAD_REQUEST.value(), message), HttpStatus.BAD_REQUEST);
+        return errorBuilder.build(message, HttpStatus.BAD_REQUEST);
     }
 }

src/main/java/org/lucoenergia/conluz/infrastructure/admin/supply/SupplyEntity.java

@@ -21,6 +21,7 @@ public class SupplyEntity {
 
     private String name;
     private String address;
+    private String addressRef;
     private Float partitionCoefficient;
     private Boolean enabled;
     private LocalDate validDateFrom;
@@ -58,6 +59,7 @@ public static class Builder {
         private UserEntity user;
         private String name;
         private String address;
+        private String addressRef;
         private Float partitionCoefficient;
         private Boolean enabled;
 
@@ -95,6 +97,11 @@ public Builder withAddress(String address) {
             return this;
         }
 
+        public Builder withAddressRef(String addressRef) {
+            this.addressRef = addressRef;
+            return this;
+        }
+
         public Builder withPartitionCoefficient(Float partitionCoefficient) {
             this.partitionCoefficient = partitionCoefficient;
             return this;
@@ -152,6 +159,7 @@ public SupplyEntity build() {
             entity.user = this.user;
             entity.name = this.name;
             entity.address = this.address;
+            entity.addressRef = this.addressRef;
             entity.partitionCoefficient = this.partitionCoefficient;
             entity.enabled = this.enabled;
             entity.validDateFrom = this.validDateFrom;
@@ -206,11 +214,18 @@ public String getAddress() {
         return address;
     }
 
+    public String getAddressRef() {
+        return addressRef;
+    }
 
     public void setAddress(String address) {
         this.address = address;
     }
 
+    public void setAddressRef(String addressRef) {
+        this.addressRef = addressRef;
+    }
+
     public Float getPartitionCoefficient() {
         return partitionCoefficient;
     }

src/main/java/org/lucoenergia/conluz/infrastructure/admin/supply/SupplyEntityMapper.java

@@ -23,6 +23,7 @@ public Supply map(SupplyEntity entity) {
                 .withCode(entity.getCode())
                 .withName(entity.getName())
                 .withAddress(entity.getAddress())
+                .withAddressRef(entity.getAddressRef())
                 .withPartitionCoefficient(entity.getPartitionCoefficient())
                 .withEnabled(entity.getEnabled())
                 .withUser(userEntityMapper.map(entity.getUser()))

src/main/java/org/lucoenergia/conluz/infrastructure/admin/supply/SupplyExceptionHandler.java

@@ -3,6 +3,7 @@
 import org.lucoenergia.conluz.domain.admin.supply.SupplyAlreadyExistsException;
 import org.lucoenergia.conluz.domain.admin.supply.SupplyNotFoundException;
 import org.lucoenergia.conluz.domain.admin.user.UserAlreadyExistsException;
+import org.lucoenergia.conluz.infrastructure.shared.error.ErrorBuilder;
 import org.lucoenergia.conluz.infrastructure.shared.web.error.RestError;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -22,9 +23,11 @@ public class SupplyExceptionHandler {
     private static final Logger LOGGER = LoggerFactory.getLogger(SupplyExceptionHandler.class);
 
     private final MessageSource messageSource;
+    private final ErrorBuilder errorBuilder;
 
-    public SupplyExceptionHandler(MessageSource messageSource) {
+    public SupplyExceptionHandler(MessageSource messageSource, ErrorBuilder errorBuilder) {
         this.messageSource = messageSource;
+        this.errorBuilder = errorBuilder;
     }
 
     @ExceptionHandler(SupplyNotFoundException.class)
@@ -37,8 +40,7 @@ public ResponseEntity<RestError> handleException(SupplyNotFoundException e) {
                 Collections.singletonList(supplyId).toArray(),
                 LocaleContextHolder.getLocale()
         );
-        LOGGER.error(message);
-        return new ResponseEntity<>(new RestError(HttpStatus.NOT_FOUND.value(), message), HttpStatus.NOT_FOUND);
+        return errorBuilder.build(message, HttpStatus.NOT_FOUND);
     }
 
     @ExceptionHandler(SupplyAlreadyExistsException.class)
@@ -49,7 +51,6 @@ public ResponseEntity<RestError> handleException(SupplyAlreadyExistsException e)
                 List.of(e.getCode().getCode()).toArray(),
                 LocaleContextHolder.getLocale()
         );
-        LOGGER.error(message);
-        return new ResponseEntity<>(new RestError(HttpStatus.BAD_REQUEST.value(), message), HttpStatus.BAD_REQUEST);
+        return errorBuilder.build(message, HttpStatus.BAD_REQUEST);
     }
 }

src/main/java/org/lucoenergia/conluz/infrastructure/admin/supply/SupplyResponse.java

@@ -19,6 +19,8 @@ public class SupplyResponse {
     private final String name;
     @Schema(description = "Address of the supply", example = "Fake Street 123")
     private final String address;
+    @Schema(description = "Reference ID of the address", example = "4ASDF654ASDF89ASD")
+    private final String addressRef;
     @Schema(description = "Address of the supply", example = "2.403561")
     private final Float partitionCoefficient;
     @Schema(description = "Whether the supply is enabled or disabled", example = "true")
@@ -46,6 +48,7 @@ public SupplyResponse(Supply supply) {
         this.code = supply.getCode();
         this.name = supply.getName();
         this.address = supply.getAddress();
+        this.addressRef = supply.getAddressRef();
         this.partitionCoefficient = supply.getPartitionCoefficient();
         this.enabled = supply.getEnabled();
         this.user = supply.getUser() != null ? new UserResponse(supply.getUser()) : null;
@@ -78,6 +81,10 @@ public String getAddress() {
         return address;
     }
 
+    public String getAddressRef() {
+        return addressRef;
+    }
+
     public Float getPartitionCoefficient() {
         return partitionCoefficient;
     }

src/main/java/org/lucoenergia/conluz/infrastructure/admin/supply/create/CreateSuppliesPartitionsWithFileController.java

@@ -12,6 +12,7 @@
 import org.lucoenergia.conluz.domain.admin.supply.SupplyPartition;
 import org.lucoenergia.conluz.domain.admin.supply.create.CreateSupplyPartitionService;
 import org.lucoenergia.conluz.infrastructure.admin.supply.InvalidSupplyPartitionCoefficientException;
+import org.lucoenergia.conluz.infrastructure.shared.error.ErrorBuilder;
 import org.lucoenergia.conluz.infrastructure.shared.io.CsvFileParser;
 import org.lucoenergia.conluz.infrastructure.shared.io.CsvFileRequestValidator;
 import org.lucoenergia.conluz.infrastructure.shared.web.apidocs.ApiTag;
@@ -62,15 +63,17 @@ public class CreateSuppliesPartitionsWithFileController {
     private final MessageSource messageSource;
     private final CreateSupplyPartitionService createSupplyPartitionService;
     private final CsvParseExceptionHandler csvParseExceptionHandler;
+    private final ErrorBuilder errorBuilder;
 
     public CreateSuppliesPartitionsWithFileController(CsvFileRequestValidator csvFileRequestValidator,
                                                       CsvFileParser csvFileParser, MessageSource messageSource,
-                                                      CreateSupplyPartitionService createSupplyPartitionService, CsvParseExceptionHandler csvParseExceptionHandler) {
+                                                      CreateSupplyPartitionService createSupplyPartitionService, CsvParseExceptionHandler csvParseExceptionHandler, ErrorBuilder errorBuilder) {
         this.csvFileRequestValidator = csvFileRequestValidator;
         this.csvFileParser = csvFileParser;
         this.messageSource = messageSource;
         this.createSupplyPartitionService = createSupplyPartitionService;
         this.csvParseExceptionHandler = csvParseExceptionHandler;
+        this.errorBuilder = errorBuilder;
     }
 
     @PostMapping
@@ -127,14 +130,10 @@ public ResponseEntity importSuppliesWithFile(
         try {
             suppliesPartitions = csvFileParser.parse(file.getInputStream(), CreateSupplyPartitionDto.class, ';');
         } catch (NumberFormatException ex) {
-            LOGGER.error("Invalid number format.", ex);
             String message = messageSource.getMessage("error.supply.partitions.invalid.number.format",
                     Collections.emptyList().toArray(),
                     LocaleContextHolder.getLocale());
-            return new ResponseEntity<>(
-                    new RestError(HttpStatus.BAD_REQUEST.value(), message),
-                    HttpStatus.BAD_REQUEST
-            );
+            return errorBuilder.build(message, HttpStatus.BAD_REQUEST);
         } catch (Exception ex) {
             return csvParseExceptionHandler.handleCsvParsingError(ex);
         }
@@ -143,19 +142,12 @@ public ResponseEntity importSuppliesWithFile(
         try {
             response = createSupplyPartitionService.createInBulk(suppliesPartitions, SharingAgreementId.of(sharingAgreementId));
         } catch (InvalidSupplyPartitionCoefficientException e) {
-            return new ResponseEntity<>(
-                    new RestError(HttpStatus.BAD_REQUEST.value(), e.getMessage()),
-                    HttpStatus.BAD_REQUEST
-            );
+            return errorBuilder.build(e.getMessage(), HttpStatus.BAD_REQUEST);
         } catch (SharingAgreementNotFoundException e) {
-            LOGGER.error("Sharing agreement with id {} not found", sharingAgreementId, e);
             String message = messageSource.getMessage("error.sharing.agreement.not.found",
                             Collections.singletonList(sharingAgreementId).toArray(),
                             LocaleContextHolder.getLocale());
-            return new ResponseEntity<>(
-                    new RestError(HttpStatus.BAD_REQUEST.value(), message),
-                    HttpStatus.BAD_REQUEST
-            );
+            return errorBuilder.build(message, HttpStatus.NOT_FOUND);
         }
 
         return new ResponseEntity<>(response, HttpStatus.OK);

src/main/java/org/lucoenergia/conluz/infrastructure/admin/supply/create/CreateSupplyBody.java

@@ -17,6 +17,8 @@ public class CreateSupplyBody {
     private String personalId;
     @NotEmpty
     private String address;
+    @NotEmpty
+    private String addressRef;
     @Positive
     private Float partitionCoefficient;
     private String name;
@@ -37,6 +39,14 @@ public void setAddress(String address) {
         this.address = address;
     }
 
+    public String getAddressRef() {
+        return addressRef;
+    }
+
+    public void setAddressRef(String addressRef) {
+        this.addressRef = addressRef;
+    }
+
     public Float getPartitionCoefficient() {
         return partitionCoefficient;
     }
@@ -65,12 +75,16 @@ public Supply mapToSupply() {
         Supply.Builder builder = new Supply.Builder();
         builder.withCode(code.trim())
                 .withAddress(address.trim())
+                .withAddressRef(addressRef.trim())
                 .withPartitionCoefficient(partitionCoefficient)
                 .withUser(new User.Builder().personalId(personalId.trim()).build());
 
         if (name != null && !name.isBlank()) {
             builder.withName(name.trim());
         }
+        if (addressRef != null && !addressRef.isBlank()) {
+            builder.withAddressRef(addressRef.trim());
+        }
 
         return builder.build();
     }

src/main/java/org/lucoenergia/conluz/infrastructure/admin/supply/create/CreateSupplyRepositoryDatabase.java

@@ -52,6 +52,7 @@ public Supply create(Supply supply, UserId id) {
                 .withCode(supply.getCode())
                 .withName(supply.getName())
                 .withAddress(supply.getAddress())
+                .withAddressRef(supply.getAddressRef())
                 .withPartitionCoefficient(supply.getPartitionCoefficient())
                 .withEnabled(supply.getEnabled())
 

src/main/java/org/lucoenergia/conluz/infrastructure/admin/supply/create/CreateSupplyServiceImpl.java

@@ -39,6 +39,7 @@ public Supply create(Supply supply, UserId id) {
                     .withUser(supply.getUser())
                     .withName(supply.getAddress())
                     .withAddress(supply.getAddress())
+                    .withAddressRef(supply.getAddressRef())
                     .withPartitionCoefficient(supply.getPartitionCoefficient())
                     .withEnabled(supply.getEnabled())
                     .withValidDateFrom(supply.getValidDateFrom())