feat: P4ADEV-4387 handle error code (#355)

Author: antocalo

src/main/java/it/gov/pagopa/pu/workflow/event/payments/consumer/PaymentsConsumer.java

@@ -73,7 +73,7 @@ public void accept(PaymentEventDTO paymentEventDTO) {
               .transferIndexes(i.getTransfers().stream()
                 .filter(t ->{
                   Organization organization = organizationService.getOrganizationByFiscalCode(t.getOrgFiscalCode())
-                    .orElseThrow(() -> new WorkflowNotFoundException("Organization not found with fiscalCode " + t.getOrgFiscalCode()));
+                    .orElseThrow(() -> new WorkflowNotFoundException("[ORGANIZATION_NOT_FOUND] Organization not found with fiscalCode " + t.getOrgFiscalCode()));
                   return debtPosition.getOrganizationId().equals(organization.getOrganizationId());
                 })
                 .map(TransferDTO::getTransferIndex)

src/main/java/it/gov/pagopa/pu/workflow/exception/WorkflowExceptionHandler.java

@@ -31,6 +31,7 @@
 import tools.jackson.core.JacksonException;
 import tools.jackson.databind.DatabindException;
 
+import java.util.Optional;
 import java.util.stream.Collectors;
 
 /**
@@ -41,6 +42,8 @@
 @Order(Ordered.HIGHEST_PRECEDENCE)
 public class WorkflowExceptionHandler {
 
+  private static final String ERROR_MESSAGE_FORMAT = "[%s] %s";
+
   @ExceptionHandler(WorkflowExecutionAlreadyStarted.class)
   public ResponseEntity<WorkflowErrorDTO> handleWorkflowExecutionAlreadyStarted(WorkflowExecutionAlreadyStarted ex, HttpServletRequest request) {
     return handleException(ex, request, HttpStatus.CONFLICT, WorkflowErrorDTO.CodeEnum.WORKFLOW_CONFLICT);
@@ -78,10 +81,10 @@ public ResponseEntity<WorkflowErrorDTO> handleTooManyAttemptsException(RuntimeEx
 
   @ExceptionHandler({ServletException.class, ErrorResponseException.class})
   public ResponseEntity<WorkflowErrorDTO> handleServletException(Exception ex, HttpServletRequest request) {
-    HttpStatusCode httpStatus = HttpStatus.INTERNAL_SERVER_ERROR;
+    HttpStatus httpStatus = HttpStatus.INTERNAL_SERVER_ERROR;
     WorkflowErrorDTO.CodeEnum errorCode = WorkflowErrorDTO.CodeEnum.WORKFLOW_GENERIC_ERROR;
     if (ex instanceof ErrorResponse errorResponse) {
-      httpStatus = errorResponse.getStatusCode();
+      httpStatus = HttpStatus.valueOf((errorResponse.getStatusCode().value()));
       if (httpStatus.isSameCodeAs(HttpStatus.NOT_FOUND)) {
         errorCode = WorkflowErrorDTO.CodeEnum.WORKFLOW_NOT_FOUND;
       } else if (httpStatus.is4xxClientError()) {
@@ -105,17 +108,26 @@ public ResponseEntity<WorkflowErrorDTO> handleRuntimeException(RuntimeException
     return handleException(ex, request, HttpStatus.INTERNAL_SERVER_ERROR, WorkflowErrorDTO.CodeEnum.WORKFLOW_GENERIC_ERROR);
   }
 
-  static ResponseEntity<WorkflowErrorDTO> handleException(Exception ex, HttpServletRequest request, HttpStatusCode httpStatus, WorkflowErrorDTO.CodeEnum errorEnum) {
+  static ResponseEntity<WorkflowErrorDTO> handleException(Exception ex, HttpServletRequest request, HttpStatus httpStatus, WorkflowErrorDTO.CodeEnum errorEnum) {
     logException(ex, request, httpStatus);
 
-    String message = buildReturnedMessage(ex);
+    String message = Optional.of(request.getRequestURI())
+      .filter(path -> path.contains("/crud/"))
+      .map(path -> buildCrudErrorMessage(path, httpStatus, ex))
+      .orElseGet(() -> buildReturnedMessage(ex));
 
     return ResponseEntity
       .status(httpStatus)
       .contentType(MediaType.APPLICATION_JSON)
       .body(new WorkflowErrorDTO(errorEnum, message, Utilities.getTraceId()));
   }
 
+  private static String buildCrudErrorMessage(String requestPath, HttpStatus httpStatus, Exception ex) {
+    String entity = requestPath.split("/crud/")[1].split("/")[0].replaceAll("s$", "");
+    String entityCode = entity.replace("-", "_").toUpperCase();
+    return String.format(ERROR_MESSAGE_FORMAT, entityCode + "_" + httpStatus.name(), ex.getMessage());
+  }
+
   private static void logException(Exception ex, HttpServletRequest request, HttpStatusCode httpStatus) {
     boolean printStackTrace = httpStatus.is5xxServerError();
     Level logLevel = printStackTrace ? Level.ERROR : Level.INFO;
@@ -136,31 +148,35 @@ private static String buildReturnedMessage(Exception ex) {
     switch (ex) {
       case HttpMessageNotReadableException httpMessageNotReadableException -> {
         if (httpMessageNotReadableException.getCause() instanceof DatabindException jsonMappingException) {
-          return "Cannot parse body. " +
+          return String.format(ERROR_MESSAGE_FORMAT, WorkflowErrorDTO.CodeEnum.WORKFLOW_BAD_REQUEST.name(),
+            "Cannot parse body. " +
             jsonMappingException.getPath().stream()
               .map(JacksonException.Reference::getPropertyName)
               .collect(Collectors.joining(".")) +
-            ": " + jsonMappingException.getOriginalMessage();
+            ": " + jsonMappingException.getOriginalMessage());
         }
-        return "Required request body is missing";
+        return String.format(ERROR_MESSAGE_FORMAT, WorkflowErrorDTO.CodeEnum.WORKFLOW_BAD_REQUEST.name(),
+          "Required request body is missing");
       }
       case MethodArgumentNotValidException methodArgumentNotValidException -> {
-        return "Invalid request content." +
+        return String.format(ERROR_MESSAGE_FORMAT, WorkflowErrorDTO.CodeEnum.WORKFLOW_BAD_REQUEST.name(),
+          "Invalid request content." +
           methodArgumentNotValidException.getBindingResult()
             .getAllErrors().stream()
             .map(e -> " " +
               (e instanceof FieldError fieldError ? fieldError.getField() : e.getObjectName()) +
               ": " + e.getDefaultMessage())
             .sorted()
-            .collect(Collectors.joining(";"));
+            .collect(Collectors.joining(";")));
       }
       case ConstraintViolationException constraintViolationException -> {
-        return "Invalid request content." +
+        return String.format(ERROR_MESSAGE_FORMAT, WorkflowErrorDTO.CodeEnum.WORKFLOW_BAD_REQUEST.name(),
+          "Invalid request content." +
           constraintViolationException.getConstraintViolations()
             .stream()
             .map(e -> " " + e.getPropertyPath() + ": " + e.getMessage())
             .sorted()
-            .collect(Collectors.joining(";"));
+            .collect(Collectors.joining(";")));
       }
       default -> {
         return ex.getMessage();

src/main/java/it/gov/pagopa/pu/workflow/service/DataCipherService.java

@@ -32,15 +32,15 @@ public <T> byte[] encryptObj(T obj) {
         try {
             return encrypt(jsonMapper.writeValueAsString(obj));
         } catch (JacksonException e) {
-            throw new IllegalStateException("Cannot serialize object as JSON", e);
+            throw new IllegalStateException("[JSON_SERIALIZATION_ERROR] Cannot serialize object as JSON", e);
         }
     }
 
     public <T> T decryptObj(byte[] cipherData, Class<T> clazz) {
         try {
             return jsonMapper.readValue(decrypt(cipherData), clazz);
         } catch (JacksonException e) {
-            throw new IllegalStateException("Cannot deserialize object as JSON", e);
+            throw new IllegalStateException("[JSON_DESERIALIZATION_ERROR] Cannot deserialize object as JSON", e);
         }
     }
 }

src/main/java/it/gov/pagopa/pu/workflow/service/WorkflowTypeOrgSaveServiceImpl.java

@@ -27,7 +27,7 @@ public WorkflowTypeOrgSaveServiceImpl(WorkflowTypeRepository workflowTypeReposit
   public WorkflowTypeOrg save(WorkflowTypeOrg entity) {
     Long workflowTypeId = entity.getWorkflowTypeId();
     WorkflowType workflowType = workflowTypeRepository.findById(workflowTypeId)
-      .orElseThrow(() -> new WorkflowTypeNotFoundException("Cannot find WorkflowType having id " + workflowTypeId));
+      .orElseThrow(() -> new WorkflowTypeNotFoundException("[WORKFLOW_TYPE_NOT_FOUND] Cannot find WorkflowType having id " + workflowTypeId));
 
     validateWfExecutionConfigType(entity, workflowType, workflowTypeId);
 
@@ -39,7 +39,7 @@ public WorkflowTypeOrg save(WorkflowTypeOrg entity) {
   private static void validateWfExecutionConfigType(WorkflowTypeOrg entity, WorkflowType workflowType, Long workflowTypeId) {
     if (!entity.getDefaultExecutionConfig().getClass().equals(workflowType.getDefaultExecutionConfig().getClass())) {
       throw new InvalidWfExecutionConfigException(
-        "Invalid execution config type for workflowTypeId: %d. Expected: %s, Found: %s".formatted(
+        "[INVALID_EXECUTION_CONFIG_TYPE] Invalid execution config type for workflowTypeId: %d. Expected: %s, Found: %s".formatted(
           workflowTypeId,
           workflowType.getDefaultExecutionConfig().getClass().getSimpleName(),
           entity.getDefaultExecutionConfig().getClass().getSimpleName()));

src/main/java/it/gov/pagopa/pu/workflow/service/temporal/WorkflowCompletionService.java

@@ -68,6 +68,6 @@ public WorkflowStatusDTO waitTerminationStatus(String workflowId, int maxAttempt
         } while (attempts <= maxAttempts);
 
         log.info("Workflow {} did not complete after {} retries. No further attempts will be made.", workflowId, maxAttempts);
-        throw new TooManyAttemptsException("Maximum number of retries reached for workflow " + workflowId);
+        throw new TooManyAttemptsException("[TOO_MANY_ATTEMPTS] Maximum number of retries reached for workflow " + workflowId);
     }
 }

src/main/java/it/gov/pagopa/pu/workflow/service/temporal/WorkflowServiceImpl.java

@@ -81,16 +81,16 @@ public WorkflowStatusDTO getWorkflowStatus(String workflowId) {
     } catch (StatusRuntimeException e) {
       if(Status.NOT_FOUND.getCode().equals(e.getStatus().getCode())) {
         log.error("Workflow with ID {} not found", workflowId);
-        throw new WorkflowNotFoundException(e.getMessage());
+        throw new WorkflowNotFoundException("[WORKFLOW_NOT_FOUND] "+e.getMessage());
       }
       log.error("An error occurred while retrieving the workflow status: {}", e.getMessage());
-      throw new WorkflowInternalErrorException(e.getMessage());
+      throw new WorkflowInternalErrorException("[WORKFLOW_INTERNAL_ERROR] "+e.getMessage());
     }  catch (io.temporal.client.WorkflowNotFoundException e) {
       log.error("Workflow with ID {} not found", workflowId);
-      throw new WorkflowNotFoundException(e.getMessage());
+      throw new WorkflowNotFoundException("[WORKFLOW_NOT_FOUND] "+e.getMessage());
     } catch (TemporalException e) {
       log.error("An error occurred while retrieving the workflow status: {}", e.getMessage());
-      throw new WorkflowInternalErrorException(e.getMessage());
+      throw new WorkflowInternalErrorException("[WORKFLOW_INTERNAL_ERROR] "+e.getMessage());
     }
   }
 

src/main/java/it/gov/pagopa/pu/workflow/service/wf/debtposition/sync/complete/custom/DebtPositionCustomWfSyncService.java

@@ -30,7 +30,7 @@ public WorkflowCreatedDTO invokeWorkflow(DebtPositionDTO debtPositionDTO, Paymen
     if (wfExecutionConfig instanceof FineWfExecutionConfig fineWfExecutionConfig) {
       return fineClient.synchronizeFineDP(debtPositionDTO, paymentEventRequest, wfExecutionParameters.isMassive(), fineWfExecutionConfig);
     } else {
-      throw new IllegalStateException("WfExecutionConfig not supported: " + wfExecutionConfig.getClass());
+      throw new IllegalStateException("[INVALID_CONFIG] WfExecutionConfig not supported: " + wfExecutionConfig.getClass());
     }
   }
 }

src/main/java/it/gov/pagopa/pu/workflow/service/wf/debtposition/sync/complete/generic/PagoPASyncInteractionModelRetrieverService.java

@@ -17,6 +17,6 @@ public PagoPASyncInteractionModelRetrieverService(BrokerService brokerService) {
   public PagoPaInteractionModel retrieveInteractionModel(long organizationId, String accessToken){
     return brokerService.findByBrokeredOrganizationId(organizationId, accessToken)
       .map(Broker::getPagoPaInteractionModel)
-      .orElseThrow(() -> new IllegalStateException("Cannot find a broker for organization " + organizationId));
+      .orElseThrow(() -> new IllegalStateException("[BROKER_NOT_FOUND] Cannot find a broker for organization " + organizationId));
   }
 }

src/main/java/it/gov/pagopa/pu/workflow/service/wf/debtposition/sync/config/WfExecutionConfigHandlerService.java

@@ -71,10 +71,10 @@ public void persistAndConfigure(DebtPositionDTO debtPositionDTO, WfExecutionPara
 
   public <T extends WfExecutionConfig> T findStoredExecutionConfig(Long debtPositionId, Class<T> wfExecConfigClass) {
     WfExecutionConfig config = findWfExecutionConfigById(debtPositionId)
-      .orElseThrow(() -> new InvalidWfExecutionConfigException("Execution config not found for debtPositionId: " + debtPositionId));
+      .orElseThrow(() -> new InvalidWfExecutionConfigException("[INVALID_EXECUTION_CONFIG] Execution config not found for debtPositionId: " + debtPositionId));
 
     if (!wfExecConfigClass.isInstance(config)) {
-      throw new InvalidWfExecutionConfigException(String.format("Invalid execution config type for debtPositionId: %d. Expected: %s, Found: %s",
+      throw new InvalidWfExecutionConfigException(String.format("[INVALID_EXECUTION_CONFIG] Invalid execution config type for debtPositionId: %d. Expected: %s, Found: %s",
         debtPositionId,
         wfExecConfigClass.getSimpleName(),
         config.getClass().getSimpleName()

src/main/java/it/gov/pagopa/pu/workflow/service/wf/debtposition/sync/config/WfExecutionConfigMergeService.java

@@ -41,7 +41,7 @@ private WfExecutionConfig clone(WfExecutionConfig wfConfig) {
     try {
       return objectMapper.readValue(objectMapper.writeValueAsString(wfConfig), wfConfig.getClass());
     } catch (JsonProcessingException e) {
-      throw new IllegalStateException("Cannot clone WfExecutionConfig class " + wfConfig.getClass().getSimpleName(), e);
+      throw new IllegalStateException("[INVALID_EXECUTION_CONFIG] Cannot clone WfExecutionConfig class " + wfConfig.getClass().getSimpleName(), e);
     }
   }
 
@@ -58,7 +58,7 @@ private WfExecutionConfig mergeInner(WfExecutionConfig defaultConfig, WfExecutio
           .readValue(objectMapper.writeValueAsString(wfExecutionConfig)),
         defaultConfig.getClass());
     } catch (IOException e) {
-      throw new IllegalStateException("Cannot merge WfExecutionConfig from class " + wfExecutionConfig.getClass().getSimpleName() + " to class " + defaultConfig.getClass().getSimpleName(), e);
+      throw new IllegalStateException("[INVALID_EXECUTION_CONFIG] Cannot merge WfExecutionConfig from class " + wfExecutionConfig.getClass().getSimpleName() + " to class " + defaultConfig.getClass().getSimpleName(), e);
     }
   }
 }