Skip to content

Commit

Permalink
NUM-1962 - Enhance error-handling in EHRbase
Browse files Browse the repository at this point in the history
  • Loading branch information
Marin committed Jun 29, 2023
1 parent 39e4a2e commit 46f0161
Show file tree
Hide file tree
Showing 82 changed files with 1,563 additions and 672 deletions.
8 changes: 8 additions & 0 deletions api/pom.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,14 @@
<artifactId>junit-jupiter</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-webmvc</artifactId>
</dependency>

</dependencies>

Expand Down
14 changes: 7 additions & 7 deletions api/src/main/java/org/ehrbase/api/exception/BadGatewayException.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,18 +17,18 @@
*/
package org.ehrbase.api.exception;

import lombok.AllArgsConstructor;
import lombok.Getter;

/**
* Project-custom exception that allows outbound APIs to react on backend problems. Shall be thrown to invoke
* status 502 "Bad gateway" or whatever is appropriate.
* Proxied connection failed, e.g. the server could not contact the clustered note that processes the specified query (EhrScape API example).
*/
@AllArgsConstructor
@Getter
public class BadGatewayException extends RuntimeException {

public BadGatewayException(String message) {
super(message);
}

public BadGatewayException(String message, Throwable cause) {
super(message, cause);
}
private final Class<?> entity;
private final String entityId;
}
273 changes: 273 additions & 0 deletions api/src/main/java/org/ehrbase/api/exception/CustomizedExceptionHandler.java
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,273 @@
package org.ehrbase.api.exception;

import static java.util.Objects.nonNull;
import static org.ehrbase.api.exception.ExceptionsTemplate.errorMap;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.util.Objects;

import org.ehrbase.api.exception.dto.ErrorDetails;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.servlet.mvc.method.annotation.ResponseEntityExceptionHandler;

import lombok.extern.slf4j.Slf4j;

@Slf4j
public class CustomizedExceptionHandler extends ResponseEntityExceptionHandler {

@ExceptionHandler(BadGatewayException.class)
public ResponseEntity<ErrorDetails> handleBadGatewayException(
BadGatewayException exception) {

var errors = Map.of( exception.getEntity().getSimpleName(),
exception.getEntityId() );
var className = nonNull(exception.getEntity()) ? exception.getEntity().getSimpleName() : null;
var description = exception.getMessage();

ErrorDetails errorDetails = ErrorDetails
.builder()
.messageId( nonNull(errorMap.get( exception.getEntityId())) ? errorMap.get( exception.getEntityId() ).getId() : -1)
.argumentsList( nonNull(exception.getEntity()) ? Arrays.asList(className, description) : new ArrayList<>() )
.message(Objects.isNull(exception.getCause()) ? exception.getMessage() : exception.getCause().getMessage() )
.details( errors )
.build();
log.debug(exception.getMessage(), exception);
return ResponseEntity.status(HttpStatus.BAD_GATEWAY).body( errorDetails );
}

@ExceptionHandler(GeneralRequestProcessingException.class)
public ResponseEntity<ErrorDetails> handleGeneralRequestProcessingException(
GeneralRequestProcessingException exception) {

var errors = Map.of( exception.getEntity().getSimpleName(),
exception.getEntityId() );
var className = nonNull(exception.getEntity()) ? exception.getEntity().getSimpleName() : null;
var description = exception.getMessage();

ErrorDetails errorDetails = ErrorDetails
.builder()
.messageId( nonNull(errorMap.get( exception.getEntityId())) ? errorMap.get( exception.getEntityId() ).getId() : -1)
.argumentsList( nonNull(exception.getEntity()) ? Arrays.asList(className, description) : new ArrayList<>() )
.message(Objects.isNull(exception.getCause()) ? exception.getMessage() : exception.getCause().getMessage() )
.details( errors )
.build();
log.debug(exception.getMessage(), exception);
return ResponseEntity.status(HttpStatus.BAD_REQUEST).body( errorDetails );
}

@ExceptionHandler(InternalServerException.class)
public ResponseEntity<ErrorDetails> handleInternalServerException(
InternalServerException exception) {

var errors = Map.of( exception.getEntity().getSimpleName(),
exception.getEntityId() );
var className = nonNull(exception.getEntity()) ? exception.getEntity().getSimpleName() : null;
var description = exception.getMessage();

ErrorDetails errorDetails = ErrorDetails
.builder()
.messageId( nonNull(errorMap.get( exception.getEntityId())) ? errorMap.get( exception.getEntityId() ).getId() : -1)
.argumentsList( nonNull(exception.getEntity()) ? Arrays.asList(className, description) : new ArrayList<>() )
.message(Objects.isNull(exception.getCause()) ? exception.getMessage() : exception.getCause().getMessage() )
.details( errors )
.build();
log.debug(exception.getMessage(), exception);
return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).body( errorDetails );
}

@ExceptionHandler(InvalidApiParameterException.class)
public ResponseEntity<ErrorDetails> handleInvalidApiParameterException(
InvalidApiParameterException exception) {

var errors = Map.of( exception.getEntity().getSimpleName(),
exception.getEntityId() );
var className = nonNull(exception.getEntity()) ? exception.getEntity().getSimpleName() : null;
var description = exception.getMessage();


ErrorDetails errorDetails = ErrorDetails
.builder()
.messageId( nonNull(errorMap.get( exception.getEntityId())) ? errorMap.get( exception.getEntityId() ).getId() : -1)
.argumentsList( nonNull(exception.getEntity()) ? Arrays.asList(className, description) : new ArrayList<>() )
.message(Objects.isNull(exception.getCause()) ? exception.getMessage() : exception.getCause().getMessage() )
.details( errors )
.build();
log.debug(exception.getMessage(), exception);
return ResponseEntity.status(HttpStatus.NOT_ACCEPTABLE).body( errorDetails );
}

@ExceptionHandler(NotAcceptableException.class)
public ResponseEntity<ErrorDetails> handleNotAcceptableException(
NotAcceptableException exception) {

var errors = Map.of( exception.getEntity().getSimpleName(),
exception.getEntityId() );
var className = nonNull(exception.getEntity()) ? exception.getEntity().getSimpleName() : null;
var description = exception.getMessage();


ErrorDetails errorDetails = ErrorDetails
.builder()
.messageId( nonNull(errorMap.get( exception.getEntityId())) ? errorMap.get( exception.getEntityId() ).getId() : -1)
.argumentsList( nonNull(exception.getEntity()) ? Arrays.asList(className, description) : new ArrayList<>() )
.message(Objects.isNull(exception.getCause()) ? exception.getMessage() : exception.getCause().getMessage() )
.details( errors )
.build();
log.debug(exception.getMessage(), exception);
return ResponseEntity.status(HttpStatus.NOT_ACCEPTABLE).body( errorDetails );
}

@ExceptionHandler(ObjectNotFoundException.class)
public ResponseEntity<ErrorDetails> handleObjectNotFoundException(
ObjectNotFoundException exception) {

var errors = Map.of( exception.getEntity().getSimpleName(),
exception.getEntityId() );
var className = nonNull(exception.getEntity()) ? exception.getEntity().getSimpleName() : null;
var description = exception.getMessage();


ErrorDetails errorDetails = ErrorDetails
.builder()
.messageId( nonNull(errorMap.get( exception.getEntityId())) ? errorMap.get( exception.getEntityId() ).getId() : -1)
.argumentsList( nonNull(exception.getEntity()) ? Arrays.asList(className, description) : new ArrayList<>() )
.message("Type: [" + exception.getType() + "] " + (Objects.isNull(exception.getCause()) ? exception.getMessage() : exception.getCause().getMessage()))
.details( errors )
.build();
log.debug(exception.getMessage(), exception);
return ResponseEntity.status(HttpStatus.NOT_FOUND).body( errorDetails );
}

@ExceptionHandler(PreconditionFailedException.class)
public ResponseEntity<ErrorDetails> handlePreconditionFailedException(
PreconditionFailedException exception) {

var errors = Map.of( exception.getEntity().getSimpleName(),
exception.getEntityId() );
var className = nonNull(exception.getEntity()) ? exception.getEntity().getSimpleName() : null;
var description = exception.getMessage();


ErrorDetails errorDetails = ErrorDetails
.builder()
.messageId( nonNull(errorMap.get( exception.getEntityId())) ? errorMap.get( exception.getEntityId() ).getId() : -1)
.argumentsList( nonNull(exception.getEntity()) ? Arrays.asList(className, description) : new ArrayList<>() )
.message(Objects.isNull(exception.getCause()) ? exception.getMessage() : exception.getCause().getMessage() )
.details( errors )
.build();
log.debug(exception.getMessage(), exception);
return ResponseEntity.status(HttpStatus.PRECONDITION_FAILED).body( errorDetails );
}

@ExceptionHandler(StateConflictException.class)
public ResponseEntity<ErrorDetails> handleStateConflictException(
StateConflictException exception) {

var errors = Map.of( exception.getEntity().getSimpleName(),
exception.getEntityId() );
var className = nonNull(exception.getEntity()) ? exception.getEntity().getSimpleName() : null;
var description = exception.getMessage();


ErrorDetails errorDetails = ErrorDetails
.builder()
.messageId( nonNull(errorMap.get( exception.getEntityId())) ? errorMap.get( exception.getEntityId() ).getId() : -1)
.argumentsList( nonNull(exception.getEntity()) ? Arrays.asList(className, description) : new ArrayList<>() )
.message(Objects.isNull(exception.getCause()) ? exception.getMessage() : exception.getCause().getMessage() )
.details( errors )
.build();
log.debug(exception.getMessage(), exception);
return ResponseEntity.status(HttpStatus.CONFLICT).body( errorDetails );
}

@ExceptionHandler(UnexpectedSwitchCaseException.class)
public ResponseEntity<ErrorDetails> handleUnexpectedSwitchCaseException(
UnexpectedSwitchCaseException exception) {

var errors = Map.of( exception.getEntity().getSimpleName(),
exception.getEntityId() );
var className = nonNull(exception.getEntity()) ? exception.getEntity().getSimpleName() : null;
var description = exception.getMessage();


ErrorDetails errorDetails = ErrorDetails
.builder()
.messageId( nonNull(errorMap.get( exception.getEntityId())) ? errorMap.get( exception.getEntityId() ).getId() : -1)
.argumentsList( nonNull(exception.getEntity()) ? Arrays.asList(className, description) : new ArrayList<>() )
.message(Objects.isNull(exception.getCause()) ? exception.getMessage() : exception.getCause().getMessage() )
.details( errors )
.build();
log.debug(exception.getMessage(), exception);
return ResponseEntity.status(HttpStatus.UNPROCESSABLE_ENTITY).body( errorDetails );
}

@ExceptionHandler(UnprocessableEntityException.class)
public ResponseEntity<ErrorDetails> handleUnprocessableEntityException(
UnprocessableEntityException exception) {

var errors = Map.of( exception.getEntity().getSimpleName(),
exception.getEntityId() );
var className = nonNull(exception.getEntity()) ? exception.getEntity().getSimpleName() : null;
var description = exception.getMessage();


ErrorDetails errorDetails = ErrorDetails
.builder()
.messageId( nonNull(errorMap.get( exception.getEntityId())) ? errorMap.get( exception.getEntityId() ).getId() : -1)
.argumentsList( nonNull(exception.getEntity()) ? Arrays.asList(className, description) : new ArrayList<>() )
.message(Objects.isNull(exception.getCause()) ? exception.getMessage() : exception.getCause().getMessage() )
.details( errors )
.build();
log.debug(exception.getMessage(), exception);
return ResponseEntity.status(HttpStatus.UNPROCESSABLE_ENTITY).body( errorDetails );
}

@ExceptionHandler(UnsupportedMediaTypeException.class)
public ResponseEntity<ErrorDetails> handleUnsupportedMediaTypeException(
UnsupportedMediaTypeException exception) {

var errors = Map.of( exception.getEntity().getSimpleName(),
exception.getEntityId() );
var className = nonNull(exception.getEntity()) ? exception.getEntity().getSimpleName() : null;
var description = exception.getMessage();


ErrorDetails errorDetails = ErrorDetails
.builder()
.messageId( nonNull(errorMap.get( exception.getEntityId())) ? errorMap.get( exception.getEntityId() ).getId() : -1)
.argumentsList( nonNull(exception.getEntity()) ? Arrays.asList(className, description) : new ArrayList<>() )
.message(Objects.isNull(exception.getCause()) ? exception.getMessage() : exception.getCause().getMessage() )
.details( errors )
.build();
log.debug(exception.getMessage(), exception);
return ResponseEntity.status(HttpStatus.UNSUPPORTED_MEDIA_TYPE).body( errorDetails );
}

@ExceptionHandler(ValidationException.class)
public ResponseEntity<ErrorDetails> handleValidationException(
ValidationException exception) {

var errors = Map.of( exception.getEntity().getSimpleName(),
exception.getEntityId() );
var className = nonNull(exception.getEntity()) ? exception.getEntity().getSimpleName() : null;
var description = exception.getMessage();


ErrorDetails errorDetails = ErrorDetails
.builder()
.messageId( nonNull(errorMap.get( exception.getEntityId())) ? errorMap.get( exception.getEntityId() ).getId() : -1)
.argumentsList( nonNull(exception.getEntity()) ? Arrays.asList(className, description) : new ArrayList<>() )
.message(Objects.isNull(exception.getCause()) ? exception.getMessage() : exception.getCause().getMessage() )
.details( errors )
.build();
log.debug(exception.getMessage(), exception);
return ResponseEntity.status(HttpStatus.NOT_ACCEPTABLE).body( errorDetails );
}



}
41 changes: 0 additions & 41 deletions api/src/main/java/org/ehrbase/api/exception/DuplicateObjectException.java
View file

This file was deleted.

Loading

0 comments on commit 46f0161

Please sign in to comment.