FINERACT-1921: BatchAPI - status code mismatch

fineract-core/src/main/java/org/apache/fineract/batch/exception/ErrorHandler.java

@@ -76,10 +76,14 @@ public final class ErrorHandler {
             Set<String> exceptionMappers = createSet(ctx.getBeanNamesForType(forClassWithGenerics(ExceptionMapper.class, clazz)));
             Set<String> fineractErrorMappers = createSet(ctx.getBeanNamesForType(FineractExceptionMapper.class));
             SetUtils.SetView<String> intersection = SetUtils.intersection(exceptionMappers, fineractErrorMappers);
-            if (intersection.size() > 0) {
+            if (!intersection.isEmpty()) {
                 // noinspection unchecked
                 return (ExceptionMapper<T>) ctx.getBean(intersection.iterator().next());
             }
+            if (!exceptionMappers.isEmpty()) {
+                // noinspection unchecked
+                return (ExceptionMapper<T>) ctx.getBean(exceptionMappers.iterator().next());
+            }
             clazz = clazz.getSuperclass();
         } while (!clazz.equals(Exception.class));
         // noinspection unchecked
@@ -98,8 +102,10 @@ public final class ErrorHandler {
         MultivaluedMap<String, Object> headers = response.getHeaders();
         Set<Header> batchHeaders = headers == null ? null
                 : headers.keySet().stream().map(e -> new Header(e, response.getHeaderString(e))).collect(Collectors.toSet());
-        return new ErrorInfo(response.getStatus(), ((FineractExceptionMapper) exceptionMapper).errorCode(),
-                JSON_HELPER.toJson(response.getEntity()), batchHeaders);
+        Integer errorCode = exceptionMapper instanceof FineractExceptionMapper ? ((FineractExceptionMapper) exceptionMapper).errorCode()
+                : null;
+        Object msg = response.getEntity();
+        return new ErrorInfo(response.getStatus(), errorCode, msg instanceof String ? (String) msg : JSON_HELPER.toJson(msg), batchHeaders);
     }
 
     public RuntimeException getMappable(@NotNull Throwable thr) {

fineract-core/src/main/java/org/apache/fineract/batch/service/BatchApiServiceImpl.java

@@ -223,7 +223,7 @@ public class BatchApiServiceImpl implements BatchApiService {
                 callRequestRecursive(resolvedChildRequest, childNode, responseList, uriInfo, enclosingTransaction);
             });
         } else {
-            responseList.addAll(parentRequestFailedRecursive(request, requestNode, response, true));
+            responseList.addAll(parentRequestFailedRecursive(request, requestNode, response, null));
         }
         // If the current request fails, then all the child requests are not executed. If we want to write out all the
         // child requests, here is the place.
@@ -296,16 +296,17 @@ public class BatchApiServiceImpl implements BatchApiService {
      *            the current request node
      * @return {@code BatchResponse} list of the generated batch responses
      */
-    private List<BatchResponse> parentRequestFailedRecursive(BatchRequest request, BatchRequestNode requestNode, BatchResponse response,
-            boolean root) {
+    private List<BatchResponse> parentRequestFailedRecursive(@NotNull BatchRequest request, @NotNull BatchRequestNode requestNode,
+            @NotNull BatchResponse response, Long parentId) {
         List<BatchResponse> responseList = new ArrayList<>();
-        if (root) {
+        if (parentId == null) { // root
             BatchRequestContextHolder.getEnclosingTransaction().ifPresent(TransactionExecution::setRollbackOnly);
         } else {
-            responseList.add(buildErrorResponse(request.getRequestId(), response.getStatusCode(), response.getBody(), null));
+            responseList.add(buildErrorResponse(request.getRequestId(), response.getStatusCode(),
+                    "Parent request with id " + parentId + " was erroneous!", null));
         }
-        requestNode.getChildNodes().forEach(
-                childNode -> responseList.addAll(parentRequestFailedRecursive(childNode.getRequest(), childNode, response, false)));
+        requestNode.getChildNodes().forEach(childNode -> responseList
+                .addAll(parentRequestFailedRecursive(childNode.getRequest(), childNode, response, request.getRequestId())));
         return responseList;
     }
 

fineract-core/src/main/java/org/apache/fineract/commands/domain/CommandProcessingResultType.java

@@ -18,6 +18,9 @@
  */
 package org.apache.fineract.commands.domain;
 
+import java.util.Arrays;
+import java.util.Map;
+import java.util.stream.Collectors;
 import lombok.Getter;
 import lombok.RequiredArgsConstructor;
 
@@ -32,6 +35,14 @@ public enum CommandProcessingResultType {
     UNDER_PROCESSING(4, "commandProcessingResultType.underProcessing"), //
     ERROR(5, "commandProcessingResultType.error");
 
+    private static final Map<Integer, CommandProcessingResultType> BY_ID = Arrays.stream(values())
+            .collect(Collectors.toMap(CommandProcessingResultType::getValue, v -> v));
+
     private final Integer value;
     private final String code;
+
+    public static CommandProcessingResultType fromInt(final Integer value) {
+        CommandProcessingResultType transactionType = BY_ID.get(value);
+        return transactionType == null ? INVALID : transactionType;
+    }
 }

fineract-core/src/main/java/org/apache/fineract/commands/service/CommandWrapperBuilder.java

@@ -737,7 +737,6 @@ public class CommandWrapperBuilder {
     }
 
     private void commonDatatableSettings(final String datatable, final Long apptableId, final Long datatableId) {
-
         this.entityName = datatable;
         this.entityId = apptableId;
         this.subentityId = datatableId;

fineract-core/src/main/java/org/apache/fineract/commands/service/SynchronousCommandProcessingService.java

@@ -30,7 +30,6 @@ import java.lang.reflect.Type;
 import java.time.Instant;
 import java.util.HashMap;
 import java.util.Map;
-import java.util.function.Function;
 import lombok.RequiredArgsConstructor;
 import lombok.extern.slf4j.Slf4j;
 import org.apache.fineract.batch.exception.ErrorHandler;
@@ -48,7 +47,6 @@ import org.apache.fineract.infrastructure.core.data.CommandProcessingResult;
 import org.apache.fineract.infrastructure.core.data.CommandProcessingResultBuilder;
 import org.apache.fineract.infrastructure.core.domain.BatchRequestContextHolder;
 import org.apache.fineract.infrastructure.core.domain.FineractRequestContextHolder;
-import org.apache.fineract.infrastructure.core.exception.AbstractIdempotentCommandException;
 import org.apache.fineract.infrastructure.core.exception.IdempotentCommandProcessFailedException;
 import org.apache.fineract.infrastructure.core.exception.IdempotentCommandProcessSucceedException;
 import org.apache.fineract.infrastructure.core.exception.IdempotentCommandProcessUnderProcessingException;
@@ -174,23 +172,21 @@ public class SynchronousCommandProcessingService implements CommandProcessingSer
     }
 
     private void exceptionWhenTheRequestAlreadyProcessed(CommandWrapper wrapper, String idempotencyKey, boolean retry) {
-        CommandSource existingCommand = commandSourceService.findCommandSource(wrapper, idempotencyKey);
-        if (existingCommand != null) {
-            idempotentExceptionByStatus(UNDER_PROCESSING, existingCommand,
-                    command -> new IdempotentCommandProcessUnderProcessingException(wrapper));
-            if (!retry) {
-                idempotentExceptionByStatus(ERROR, existingCommand,
-                        command -> new IdempotentCommandProcessFailedException(wrapper, command));
-            }
-            idempotentExceptionByStatus(PROCESSED, existingCommand,
-                    command -> new IdempotentCommandProcessSucceedException(wrapper, command.getResult(), command.getResultStatusCode()));
+        CommandSource command = commandSourceService.findCommandSource(wrapper, idempotencyKey);
+        if (command == null) {
+            return;
         }
-    }
-
-    private void idempotentExceptionByStatus(CommandProcessingResultType status, CommandSource command,
-            Function<CommandSource, AbstractIdempotentCommandException> exceptionMapper) {
-        if (status.getValue().equals(command.getStatus())) {
-            throw exceptionMapper.apply(command);
+        CommandProcessingResultType status = CommandProcessingResultType.fromInt(command.getStatus());
+        switch (status) {
+            case UNDER_PROCESSING -> throw new IdempotentCommandProcessUnderProcessingException(wrapper, idempotencyKey);
+            case PROCESSED -> throw new IdempotentCommandProcessSucceedException(wrapper, idempotencyKey, command);
+            case ERROR -> {
+                if (!retry) {
+                    throw new IdempotentCommandProcessFailedException(wrapper, idempotencyKey, command);
+                }
+            }
+            default -> {
+            }
         }
     }
 

fineract-core/src/main/java/org/apache/fineract/infrastructure/core/data/ApiGlobalErrorResponse.java

@@ -23,6 +23,7 @@ import static org.apache.http.HttpStatus.SC_BAD_REQUEST;
 import static org.apache.http.HttpStatus.SC_CONFLICT;
 import static org.apache.http.HttpStatus.SC_FORBIDDEN;
 import static org.apache.http.HttpStatus.SC_INTERNAL_SERVER_ERROR;
+import static org.apache.http.HttpStatus.SC_LOCKED;
 import static org.apache.http.HttpStatus.SC_METHOD_NOT_ALLOWED;
 import static org.apache.http.HttpStatus.SC_NOT_FOUND;
 import static org.apache.http.HttpStatus.SC_SERVICE_UNAVAILABLE;
@@ -106,7 +107,7 @@ public class ApiGlobalErrorResponse {
         return create(SC_CONFLICT, "error.msg.loan.locked", msg, msg);
     }
 
-    public static ApiGlobalErrorResponse conflict(String type, String identifier) {
+    public static ApiGlobalErrorResponse locked(String type, String identifier) {
         String details = "";
         if (type == null) {
             type = "unknown";
@@ -117,7 +118,7 @@ public class ApiGlobalErrorResponse {
             details += " [" + identifier + ']';
         }
         String msg = "The server is currently unable to handle the request due to concurrent modification" + details + ", please try again";
-        return create(SC_CONFLICT, "error.msg.platform.service." + type + ".conflict", msg, msg);
+        return create(SC_LOCKED, "error.msg.platform.service." + type + ".conflict", msg, msg);
     }
 
     public static ApiGlobalErrorResponse unAuthorized(final String defaultUserMessage) {

fineract-core/src/main/java/org/apache/fineract/infrastructure/core/exception/IdempotentCommandProcessFailedException.java

@@ -18,6 +18,9 @@
  */
 package org.apache.fineract.infrastructure.core.exception;
 
+import static org.apache.http.HttpStatus.SC_INTERNAL_SERVER_ERROR;
+
+import jakarta.validation.constraints.NotNull;
 import org.apache.fineract.commands.domain.CommandSource;
 import org.apache.fineract.commands.domain.CommandWrapper;
 
@@ -28,16 +31,14 @@ public class IdempotentCommandProcessFailedException extends AbstractIdempotentC
 
     private final Integer statusCode;
 
-    public IdempotentCommandProcessFailedException(CommandWrapper wrapper, CommandSource commandSource) {
-        super(wrapper.actionName(), wrapper.entityName(), wrapper.getIdempotencyKey(), commandSource.getResult());
-        this.statusCode = commandSource.getResultStatusCode();
+    public IdempotentCommandProcessFailedException(CommandWrapper wrapper, String idempotencyKey, CommandSource command) {
+        super(wrapper.actionName(), wrapper.actionName(), idempotencyKey, command.getResult());
+        this.statusCode = command.getResultStatusCode();
     }
 
+    @NotNull
     public Integer getStatusCode() {
         // If the database inconsistent we return http 500 instead of null pointer exception
-        if (statusCode == null) {
-            return 500;
-        }
-        return statusCode;
+        return statusCode == null ? SC_INTERNAL_SERVER_ERROR : statusCode;
     }
 }

fineract-core/src/main/java/org/apache/fineract/infrastructure/core/exception/IdempotentCommandProcessSucceedException.java

@@ -18,6 +18,7 @@
  */
 package org.apache.fineract.infrastructure.core.exception;
 
+import org.apache.fineract.commands.domain.CommandSource;
 import org.apache.fineract.commands.domain.CommandWrapper;
 
 /**
@@ -27,9 +28,9 @@ public class IdempotentCommandProcessSucceedException extends AbstractIdempotent
 
     private final Integer statusCode;
 
-    public IdempotentCommandProcessSucceedException(CommandWrapper wrapper, String response, Integer statusCode) {
-        super(wrapper.actionName(), wrapper.entityName(), wrapper.getIdempotencyKey(), response);
-        this.statusCode = statusCode;
+    public IdempotentCommandProcessSucceedException(CommandWrapper wrapper, String idempotencyKey, CommandSource command) {
+        super(wrapper.actionName(), wrapper.entityName(), idempotencyKey, command.getResult());
+        this.statusCode = command.getResultStatusCode();
     }
 
     public Integer getStatusCode() {

fineract-core/src/main/java/org/apache/fineract/infrastructure/core/exception/IdempotentCommandProcessUnderProcessingException.java

@@ -25,7 +25,7 @@ import org.apache.fineract.commands.domain.CommandWrapper;
  */
 public class IdempotentCommandProcessUnderProcessingException extends AbstractIdempotentCommandException {
 
-    public IdempotentCommandProcessUnderProcessingException(CommandWrapper wrapper) {
-        super(wrapper.actionName(), wrapper.entityName(), wrapper.getIdempotencyKey(), wrapper.getJson());
+    public IdempotentCommandProcessUnderProcessingException(CommandWrapper wrapper, String idempotencyKey) {
+        super(wrapper.actionName(), wrapper.entityName(), idempotencyKey, wrapper.getJson());
     }
 }

fineract-core/src/main/java/org/apache/fineract/infrastructure/core/exceptionmapper/ConcurrencyFailureExceptionMapper.java

@@ -18,9 +18,10 @@
  */
 package org.apache.fineract.infrastructure.core.exceptionmapper;
 
+import static org.apache.http.HttpStatus.SC_LOCKED;
+
 import jakarta.ws.rs.core.MediaType;
 import jakarta.ws.rs.core.Response;
-import jakarta.ws.rs.core.Response.Status;
 import jakarta.ws.rs.ext.ExceptionMapper;
 import jakarta.ws.rs.ext.Provider;
 import lombok.extern.slf4j.Slf4j;
@@ -49,8 +50,8 @@ public class ConcurrencyFailureExceptionMapper implements FineractExceptionMappe
             type = olex.getPersistentClassName();
             identifier = olex.getIdentifier() == null ? null : String.valueOf(olex.getIdentifier());
         }
-        final ApiGlobalErrorResponse dataIntegrityError = ApiGlobalErrorResponse.conflict(type, identifier);
-        return Response.status(Status.CONFLICT).entity(dataIntegrityError).type(MediaType.APPLICATION_JSON).build();
+        final ApiGlobalErrorResponse dataIntegrityError = ApiGlobalErrorResponse.locked(type, identifier);
+        return Response.status(SC_LOCKED).entity(dataIntegrityError).type(MediaType.APPLICATION_JSON).build();
     }
 
     @Override

fineract-core/src/main/java/org/apache/fineract/infrastructure/core/exceptionmapper/IdempotentCommandExceptionMapper.java

@@ -48,8 +48,10 @@ public class IdempotentCommandExceptionMapper implements FineractExceptionMapper
         log.warn("Processing {} request: {}", exception.getClass().getName(), exception.getMessage());
         Status status = null;
         if (exception instanceof IdempotentCommandProcessSucceedException pse) {
-            status = Status.fromStatusCode(pse.getStatusCode());
-        } else if (exception instanceof IdempotentCommandProcessUnderProcessingException) {
+            Integer statusCode = pse.getStatusCode();
+            status = statusCode == null ? Status.OK : Status.fromStatusCode(statusCode);
+        }
+        if (exception instanceof IdempotentCommandProcessUnderProcessingException) {
             status = Status.CONFLICT;
         } else if (exception instanceof IdempotentCommandProcessFailedException pfe) {
             status = Status.fromStatusCode(pfe.getStatusCode());

fineract-core/src/main/java/org/apache/fineract/infrastructure/core/exceptionmapper/OptimisticLockExceptionMapper.java

@@ -18,9 +18,10 @@
  */
 package org.apache.fineract.infrastructure.core.exceptionmapper;
 
+import static org.apache.http.HttpStatus.SC_LOCKED;
+
 import jakarta.ws.rs.core.MediaType;
 import jakarta.ws.rs.core.Response;
-import jakarta.ws.rs.core.Response.Status;
 import jakarta.ws.rs.ext.ExceptionMapper;
 import jakarta.ws.rs.ext.Provider;
 import lombok.extern.slf4j.Slf4j;
@@ -45,8 +46,8 @@ public class OptimisticLockExceptionMapper implements FineractExceptionMapper, E
         log.warn("Exception: {}, Message: {}", exception.getClass().getName(), exception.getMessage());
         String type = exception.getQuery() == null ? "unknown" : "query";
         String identifier = "unknown";
-        final ApiGlobalErrorResponse dataIntegrityError = ApiGlobalErrorResponse.conflict(type, identifier);
-        return Response.status(Status.CONFLICT).entity(dataIntegrityError).type(MediaType.APPLICATION_JSON).build();
+        final ApiGlobalErrorResponse dataIntegrityError = ApiGlobalErrorResponse.locked(type, identifier);
+        return Response.status(SC_LOCKED).entity(dataIntegrityError).type(MediaType.APPLICATION_JSON).build();
     }
 
     @Override

fineract-core/src/test/java/org/apache/fineract/infrastructure/core/exception/IdempotencyCommandProcessFailedExceptionTest.java

@@ -54,7 +54,7 @@ public class IdempotencyCommandProcessFailedExceptionTest {
         CommandWrapper command = new CommandWrapper(null, null, null, null, null, null, null, null, null, null, null, null, null, null,
                 null, null, null, null);
         CommandSource source = CommandSource.fullEntryFrom(command, JsonCommand.from("{}"), null, "dummy-key", null);
-        IdempotentCommandProcessFailedException exception = new IdempotentCommandProcessFailedException(command, source);
+        IdempotentCommandProcessFailedException exception = new IdempotentCommandProcessFailedException(command, null, source);
         Response result = mapper.toResponse(exception);
         assertEquals(500, result.getStatus());
         assertEquals("true", result.getHeaderString(IDEMPOTENT_CACHE_HEADER));