FINERACT-2326: Reworked Business date handling (Hibernate validator + separation of concerns between API and service)

Author: adamsaghy

fineract-core/src/main/java/org/apache/fineract/infrastructure/businessdate/api/BusinessDateApiResource.java

@@ -36,8 +36,10 @@
 import lombok.RequiredArgsConstructor;
 import org.apache.fineract.command.core.CommandPipeline;
 import org.apache.fineract.infrastructure.businessdate.command.BusinessDateUpdateCommand;
-import org.apache.fineract.infrastructure.businessdate.data.BusinessDateResponse;
-import org.apache.fineract.infrastructure.businessdate.data.BusinessDateUpdateRequest;
+import org.apache.fineract.infrastructure.businessdate.data.api.BusinessDateResponse;
+import org.apache.fineract.infrastructure.businessdate.data.api.BusinessDateUpdateRequest;
+import org.apache.fineract.infrastructure.businessdate.data.api.BusinessDateUpdateResponse;
+import org.apache.fineract.infrastructure.businessdate.mapper.BusinessDateMapper;
 import org.apache.fineract.infrastructure.businessdate.service.BusinessDateReadPlatformService;
 import org.apache.fineract.infrastructure.core.service.DateUtils;
 import org.springframework.stereotype.Component;
@@ -50,13 +52,14 @@ public class BusinessDateApiResource {
 
     private final BusinessDateReadPlatformService readPlatformService;
     private final CommandPipeline commandPipeline;
+    private final BusinessDateMapper businessDateMapper;
 
     @GET
     @Consumes({ MediaType.TEXT_HTML, MediaType.APPLICATION_JSON })
     @Produces(MediaType.APPLICATION_JSON)
     @Operation(summary = "List all business dates", description = "")
     public List<BusinessDateResponse> getBusinessDates() {
-        return this.readPlatformService.findAll();
+        return businessDateMapper.mapFetchResponse(this.readPlatformService.findAll());
     }
 
     @GET
@@ -65,24 +68,24 @@ public List<BusinessDateResponse> getBusinessDates() {
     @Produces(MediaType.APPLICATION_JSON)
     @Operation(summary = "Retrieve a specific Business date", description = "")
     public BusinessDateResponse getBusinessDate(@PathParam("type") @Parameter(description = "type") final String type) {
-        return this.readPlatformService.findByType(type);
+        return businessDateMapper.mapFetchResponse(this.readPlatformService.findByType(type));
     }
 
     @POST
     @Consumes({ MediaType.APPLICATION_JSON })
     @Produces({ MediaType.APPLICATION_JSON })
     @Operation(summary = "Update Business Date", description = "")
-    public BusinessDateResponse updateBusinessDate(@HeaderParam("Idempotency-Key") String idempotencyKey,
+    public BusinessDateUpdateResponse updateBusinessDate(@HeaderParam("Idempotency-Key") String idempotencyKey,
             @Valid BusinessDateUpdateRequest request) {
 
-        final var command = new BusinessDateUpdateCommand();
+        final BusinessDateUpdateCommand command = new BusinessDateUpdateCommand();
 
         command.setId(UUID.randomUUID());
         command.setIdempotencyKey(idempotencyKey);
         command.setCreatedAt(DateUtils.getAuditOffsetDateTime());
         command.setPayload(request);
 
-        final Supplier<BusinessDateResponse> response = commandPipeline.send(command);
+        final Supplier<BusinessDateUpdateResponse> response = commandPipeline.send(command);
 
         return response.get();
     }

fineract-core/src/main/java/org/apache/fineract/infrastructure/businessdate/command/BusinessDateUpdateCommand.java

@@ -21,7 +21,7 @@
 import lombok.Data;
 import lombok.EqualsAndHashCode;
 import org.apache.fineract.command.core.Command;
-import org.apache.fineract.infrastructure.businessdate.data.BusinessDateUpdateRequest;
+import org.apache.fineract.infrastructure.businessdate.data.api.BusinessDateUpdateRequest;
 
 @Data
 @EqualsAndHashCode(callSuper = true)

fineract-core/src/main/java/org/apache/fineract/infrastructure/businessdate/data/api/BusinessDateResponse.java

@@ -0,0 +1,44 @@
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+package org.apache.fineract.infrastructure.businessdate.data.api;
+
+import java.io.Serial;
+import java.io.Serializable;
+import java.time.LocalDate;
+import lombok.AllArgsConstructor;
+import lombok.Builder;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+import org.apache.fineract.infrastructure.businessdate.domain.BusinessDateType;
+import org.apache.fineract.infrastructure.core.jersey.serializer.legacy.JsonLocalDateArrayFormat;
+
+@Builder
+@Data
+@NoArgsConstructor
+@AllArgsConstructor
+@JsonLocalDateArrayFormat
+public class BusinessDateResponse implements Serializable {
+
+    @Serial
+    private static final long serialVersionUID = 1L;
+
+    private String description;
+    private BusinessDateType type;
+    private LocalDate date;
+}

…date/data/BusinessDateUpdateRequest.java …/data/api/BusinessDateUpdateRequest.javafineract-core/src/main/java/org/apache/fineract/infrastructure/businessdate/data/BusinessDateUpdateRequest.java renamed to fineract-core/src/main/java/org/apache/fineract/infrastructure/businessdate/data/api/BusinessDateUpdateRequest.java fineract-core/src/main/java/org/apache/fineract/infrastructure/businessdate/data/BusinessDateUpdateRequest.java renamed to fineract-core/src/main/java/org/apache/fineract/infrastructure/businessdate/data/api/BusinessDateUpdateRequest.java

@@ -16,8 +16,9 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-package org.apache.fineract.infrastructure.businessdate.data;
+package org.apache.fineract.infrastructure.businessdate.data.api;
 
+import io.swagger.v3.oas.annotations.media.Schema;
 import jakarta.validation.constraints.NotBlank;
 import jakarta.validation.constraints.NotNull;
 import java.io.Serial;
@@ -27,6 +28,7 @@
 import lombok.Data;
 import lombok.NoArgsConstructor;
 import org.apache.fineract.infrastructure.businessdate.domain.BusinessDateType;
+import org.apache.fineract.validation.constraints.EnumValue;
 import org.apache.fineract.validation.constraints.LocalDate;
 import org.apache.fineract.validation.constraints.Locale;
 
@@ -42,8 +44,10 @@ public class BusinessDateUpdateRequest implements Serializable {
 
     @NotBlank(message = "{org.apache.fineract.businessdate.date-format.not-blank}")
     private String dateFormat;
-    @NotNull(message = "{org.apache.fineract.businessdate.type.not-null}")
-    private BusinessDateType type;
+    @Schema(description = "Type of business date", example = "BUSINESS_DATE", allowableValues = { "BUSINESS_DATE", "COB_DATE" })
+    @EnumValue(enumClass = BusinessDateType.class, message = "{org.apache.fineract.businessdate.type.invalid}")
+    @NotNull(message = "{org.apache.fineract.businessdate.type.not-blank}")
+    private String type;
     @NotBlank(message = "{org.apache.fineract.businessdate.date.not-blank}")
     private String date;
     @NotBlank(message = "{org.apache.fineract.businessdate.locale.not-blank}")

fineract-core/src/main/java/org/apache/fineract/infrastructure/businessdate/data/api/BusinessDateUpdateResponse.java

@@ -0,0 +1,46 @@
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+package org.apache.fineract.infrastructure.businessdate.data.api;
+
+import java.io.Serial;
+import java.io.Serializable;
+import java.time.LocalDate;
+import java.util.Map;
+import lombok.AllArgsConstructor;
+import lombok.Builder;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+import org.apache.fineract.infrastructure.businessdate.domain.BusinessDateType;
+import org.apache.fineract.infrastructure.core.jersey.serializer.legacy.JsonLocalDateArrayFormat;
+
+@Builder
+@Data
+@NoArgsConstructor
+@AllArgsConstructor
+@JsonLocalDateArrayFormat
+public class BusinessDateUpdateResponse implements Serializable {
+
+    @Serial
+    private static final long serialVersionUID = 1L;
+
+    private String description;
+    private BusinessDateType type;
+    private LocalDate date;
+    private Map<BusinessDateType, LocalDate> changes;
+}

…inessdate/data/BusinessDateResponse.java …ssdate/data/service/BusinessDateDTO.javafineract-core/src/main/java/org/apache/fineract/infrastructure/businessdate/data/BusinessDateResponse.java renamed to fineract-core/src/main/java/org/apache/fineract/infrastructure/businessdate/data/service/BusinessDateDTO.java fineract-core/src/main/java/org/apache/fineract/infrastructure/businessdate/data/BusinessDateResponse.java renamed to fineract-core/src/main/java/org/apache/fineract/infrastructure/businessdate/data/service/BusinessDateDTO.java

@@ -16,7 +16,7 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-package org.apache.fineract.infrastructure.businessdate.data;
+package org.apache.fineract.infrastructure.businessdate.data.service;
 
 import java.io.Serial;
 import java.io.Serializable;
@@ -33,7 +33,7 @@
 @Data
 @NoArgsConstructor
 @AllArgsConstructor
-public class BusinessDateResponse implements Serializable {
+public class BusinessDateDTO implements Serializable {
 
     @Serial
     private static final long serialVersionUID = 1L;

fineract-core/src/main/java/org/apache/fineract/infrastructure/businessdate/handler/BusinessDateUpdateHandler.java

@@ -22,22 +22,27 @@
 import lombok.extern.slf4j.Slf4j;
 import org.apache.fineract.command.core.Command;
 import org.apache.fineract.command.core.CommandHandler;
-import org.apache.fineract.infrastructure.businessdate.data.BusinessDateResponse;
-import org.apache.fineract.infrastructure.businessdate.data.BusinessDateUpdateRequest;
+import org.apache.fineract.infrastructure.businessdate.data.api.BusinessDateUpdateRequest;
+import org.apache.fineract.infrastructure.businessdate.data.api.BusinessDateUpdateResponse;
+import org.apache.fineract.infrastructure.businessdate.data.service.BusinessDateDTO;
+import org.apache.fineract.infrastructure.businessdate.mapper.BusinessDateMapper;
 import org.apache.fineract.infrastructure.businessdate.service.BusinessDateWritePlatformService;
 import org.springframework.stereotype.Component;
 import org.springframework.transaction.annotation.Transactional;
 
 @Slf4j
 @Component
 @RequiredArgsConstructor
-public class BusinessDateUpdateHandler implements CommandHandler<BusinessDateUpdateRequest, BusinessDateResponse> {
+public class BusinessDateUpdateHandler implements CommandHandler<BusinessDateUpdateRequest, BusinessDateUpdateResponse> {
 
     private final BusinessDateWritePlatformService businessDateWritePlatformService;
+    private final BusinessDateMapper businessDateMapper;
 
     @Transactional
     @Override
-    public BusinessDateResponse handle(Command<BusinessDateUpdateRequest> command) {
-        return businessDateWritePlatformService.updateBusinessDate(command.getPayload());
+    public BusinessDateUpdateResponse handle(Command<BusinessDateUpdateRequest> command) {
+        BusinessDateDTO businessDateDto = businessDateMapper.mapUpdateRequest(command.getPayload());
+        businessDateDto = businessDateWritePlatformService.updateBusinessDate(businessDateDto);
+        return businessDateMapper.mapUpdateResponse(businessDateDto);
     }
 }

fineract-core/src/main/java/org/apache/fineract/infrastructure/businessdate/mapper/BusinessDateMapper.java

@@ -19,7 +19,10 @@
 package org.apache.fineract.infrastructure.businessdate.mapper;
 
 import java.util.List;
-import org.apache.fineract.infrastructure.businessdate.data.BusinessDateResponse;
+import org.apache.fineract.infrastructure.businessdate.data.api.BusinessDateResponse;
+import org.apache.fineract.infrastructure.businessdate.data.api.BusinessDateUpdateRequest;
+import org.apache.fineract.infrastructure.businessdate.data.api.BusinessDateUpdateResponse;
+import org.apache.fineract.infrastructure.businessdate.data.service.BusinessDateDTO;
 import org.apache.fineract.infrastructure.businessdate.domain.BusinessDate;
 import org.apache.fineract.infrastructure.core.config.MapstructMapperConfig;
 import org.mapstruct.Mapper;
@@ -29,8 +32,20 @@
 @Mapper(config = MapstructMapperConfig.class)
 public interface BusinessDateMapper {
 
-    @Mappings({ @Mapping(target = "description", source = "source.type.description"), @Mapping(target = "changes", ignore = true) })
-    BusinessDateResponse map(BusinessDate source);
+    @Mappings({ @Mapping(target = "description", source = "type.description"), @Mapping(target = "changes", ignore = true) })
+    BusinessDateDTO mapEntity(BusinessDate source);
 
-    List<BusinessDateResponse> map(List<BusinessDate> sources);
+    List<BusinessDateDTO> mapEntity(List<BusinessDate> sources);
+
+    @Mapping(target = "description", expression = "java(org.apache.fineract.infrastructure.businessdate.domain.BusinessDateType.valueOf(source.getType()).getDescription())")
+    @Mapping(target = "type", expression = "java(org.apache.fineract.infrastructure.businessdate.domain.BusinessDateType.valueOf(source.getType()))")
+    @Mapping(target = "date", expression = "java(org.apache.fineract.infrastructure.core.service.DateUtils.toLocalDate(source.getLocale(), source.getDate(), source.getDateFormat()))")
+    @Mapping(target = "changes", ignore = true)
+    BusinessDateDTO mapUpdateRequest(BusinessDateUpdateRequest source);
+
+    List<BusinessDateResponse> mapFetchResponse(List<BusinessDateDTO> sources);
+
+    BusinessDateResponse mapFetchResponse(BusinessDateDTO source);
+
+    BusinessDateUpdateResponse mapUpdateResponse(BusinessDateDTO source);
 }

fineract-core/src/main/java/org/apache/fineract/infrastructure/businessdate/mapper/BusinessDateUpdateRequestMapper.java

@@ -21,14 +21,14 @@
 import java.time.LocalDate;
 import java.util.HashMap;
 import java.util.List;
-import org.apache.fineract.infrastructure.businessdate.data.BusinessDateResponse;
+import org.apache.fineract.infrastructure.businessdate.data.service.BusinessDateDTO;
 import org.apache.fineract.infrastructure.businessdate.domain.BusinessDateType;
 
 public interface BusinessDateReadPlatformService {
 
-    List<BusinessDateResponse> findAll();
+    List<BusinessDateDTO> findAll();
 
-    BusinessDateResponse findByType(String type);
+    BusinessDateDTO findByType(String type);
 
     HashMap<BusinessDateType, LocalDate> getBusinessDates();
 }