In REST API, improve exception handling

[yanavasileva]

Created on behalf of #4600

Context

While implementing custom exception handling for my Camunda REST API, I used the ExceptionHandlerHelper class from the engine-rest module to ensure that the behavior of error handling is consistent with the built-in Camunda REST API error handling. The custom exception handler code is as follows:

@ControllerAdvice
public class CustomExceptionHandler extends ResponseEntityExceptionHandler {

    protected static final ExceptionLogger LOGGER = ExceptionLogger.REST_LOGGER;
    private static final ExceptionHandlerHelper DELEGATE = ExceptionHandlerHelper.getInstance();

    @ExceptionHandler
    public ResponseEntity<Object> handleAnyException(Throwable ex, NativeWebRequest request) {
         ExceptionDto exceptionDto = DELEGATE.fromException(ex);
         return handleExceptionInternal((Exception) ex, exceptionDto, buildHeaders(ex), HttpStatusCode.valueOf(DELEGATE.getStatus(ex).getStatusCode()), request);
    }

    @Nullable
    @Override
    protected ResponseEntity<Object> handleExceptionInternal(
            Exception ex,
            @Nullable Object body,
            HttpHeaders headers,
            HttpStatusCode statusCode,
            WebRequest request
    ) {
        LOGGER.log(ex);
        if (body == null) {
            return super.handleExceptionInternal(ex, DELEGATE.fromException(ex), headers, statusCode, request);
        }
        return super.handleExceptionInternal(ex, body, headers, statusCode, request);
    }

    private HttpHeaders buildHeaders(Throwable err) {
        // ...
    }

}

However, the code field value in the response body (ExceptionDto) was always null, resulting in outputs like the following:

{
    "type": "AuthorizationException",
    "message": "The user with id 'tom' does not have 'CREATE' permission on resource 'Deployment'.",
    "code": null,
    "userId": "tom",
    "resourceName": "Deployment",
    "resourceId": null,
    "permissionName": "CREATE",
    "missingAuthorizations": [
        {
            "permissionName": "CREATE",
            "resourceName": "Deployment",
            "resourceId": null
        }
    ]
}

Acceptance Criteria (Required on creation)

• Enable easier inheritance of ExceptionHandlerHelper by providing exception code already in org.camunda.bpm.engine.rest.exception.ExceptionHandlerHelper.fromException(Throwable)

Hints

Links

Breakdown

Pull Requests

Preview Give feedback

1. refactor(engine-rest): Ensure Proper Exception Code Assignment in ExceptionHandlerHelper #4600
   +0
   
2. refactor(engine-rest): Ensure Proper Exception Code Assignment in ExceptionHandlerHelper #4825
   ci:all-as ci:rest-api ci:webapp-integration +3
   

Dev2QA handover

• Does this ticket need a QA test and the testing goals are not clear from the description? Add a Dev2QA handover comment