Refactor to thorw exception for upstream api errors

Author: Bingjie Liu

src/main/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/config/HmppsIntegrationApiExceptionHandler.kt

@@ -11,6 +11,7 @@ import org.springframework.http.HttpStatus.NOT_FOUND
 import org.springframework.http.ResponseEntity
 import org.springframework.web.bind.annotation.ExceptionHandler
 import org.springframework.web.bind.annotation.RestControllerAdvice
+import org.springframework.web.reactive.function.client.WebClientResponseException
 import uk.gov.justice.digital.hmpps.hmppsintegrationapi.exception.AuthenticationFailedException
 import uk.gov.justice.digital.hmpps.hmppsintegrationapi.exception.EntityNotFoundException
 
@@ -72,6 +73,20 @@ class HmppsIntegrationApiExceptionHandler {
       )
   }
 
+  @ExceptionHandler(WebClientResponseException::class)
+  fun handleWebClientResponseException(e: WebClientResponseException): ResponseEntity<ErrorResponse?>? {
+    log_and_capture("Authentication error: {}", e)
+    return ResponseEntity
+      .status(INTERNAL_SERVER_ERROR)
+      .body(
+        ErrorResponse(
+          status = INTERNAL_SERVER_ERROR,
+          developerMessage = "Unable to complete request as an upstream service is not responding",
+          userMessage = e.message,
+        ),
+      )
+  }
+
   private fun log_and_capture(message: String, e: Exception) {
     log.error(message, e.message)
     Sentry.captureException(e)

src/main/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/config/TomcatConfig.kt

@@ -2,23 +2,15 @@ package uk.gov.justice.digital.hmpps.hmppsintegrationapi.config
 
 import org.apache.catalina.connector.Connector
 import org.apache.tomcat.util.buf.EncodedSolidusHandling
-import org.springframework.beans.factory.annotation.Autowired
 import org.springframework.boot.web.embedded.tomcat.TomcatConnectorCustomizer
 import org.springframework.boot.web.embedded.tomcat.TomcatServletWebServerFactory
 import org.springframework.boot.web.server.WebServerFactoryCustomizer
 import org.springframework.context.annotation.Bean
 import org.springframework.context.annotation.Configuration
-import org.springframework.web.servlet.config.annotation.InterceptorRegistry
 import org.springframework.web.servlet.config.annotation.WebMvcConfigurer
-import uk.gov.justice.digital.hmpps.hmppsintegrationapi.extensions.ServiceDownInterceptor
 
 @Configuration
-class TomcatConfig(
-  @Autowired val serviceDownInterceptor: ServiceDownInterceptor,
-) : WebMvcConfigurer {
-  override fun addInterceptors(registry: InterceptorRegistry) {
-    registry.addInterceptor(serviceDownInterceptor)
-  }
+class TomcatConfig() : WebMvcConfigurer {
 
   @Bean
   fun tomcatCustomizer(): WebServerFactoryCustomizer<TomcatServletWebServerFactory> {

src/main/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/controllers/v1/person/PersonController.kt

@@ -54,7 +54,6 @@ class PersonController(
 
     auditService.createEvent("SEARCH_PERSON", "Person searched with first name: $firstName, last name: $lastName, search within aliases: $searchWithinAliases, pnc number: $pncNumber, date of birth: $dateOfBirth")
     return response.data.paginateWith(page, perPage, response.errors)
-
   }
 
   @GetMapping("{encodedHmppsId}")

src/main/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/exception/AuthenticationFailedException.kt

@@ -2,7 +2,6 @@ package uk.gov.justice.digital.hmpps.hmppsintegrationapi.exception
 
 import org.springframework.http.HttpStatus
 import org.springframework.web.bind.annotation.ResponseStatus
-import java.lang.RuntimeException
 
 @ResponseStatus(HttpStatus.FORBIDDEN)
 class AuthenticationFailedException(message: String) : RuntimeException(message)

src/main/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/extensions/ServiceDownInterceptor.kt

@@ -68,9 +68,7 @@ class WebClientWrapper(
   fun getErrorType(exception: WebClientResponseException, upstreamApi: UpstreamApi): WebClientWrapperResponse.Error {
     val errorType = when (exception.statusCode) {
       HttpStatus.NOT_FOUND -> UpstreamApiError.Type.ENTITY_NOT_FOUND
-      HttpStatus.FORBIDDEN -> UpstreamApiError.Type.FORBIDDEN
-      HttpStatus.BAD_REQUEST -> UpstreamApiError.Type.BAD_REQUEST
-      else -> UpstreamApiError.Type.INTERNAL_SERVER_ERROR
+      else -> throw exception
     }
     return WebClientWrapperResponse.Error(
       listOf(

src/main/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/extensions/WebClientWrapper.kt

@@ -1,12 +1,11 @@
 package uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps
 
-abstract class BaseResponse (
-  open val errors: List<UpstreamApiError> = emptyList()
+abstract class BaseResponse(
+  open val errors: List<UpstreamApiError> = emptyList(),
 ) {
 
   fun hasError(type: UpstreamApiError.Type): Boolean = this.errors.any { it.type == type }
 
   fun hasErrorCausedBy(type: UpstreamApiError.Type, causedBy: UpstreamApi): Boolean =
     this.errors.any { it.type == type && it.causedBy == causedBy }
-
 }

src/main/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/models/hmpps/BaseResponse.kt

@@ -1,6 +1,5 @@
 package uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps
 
-
 data class Response<T>(val data: T, override val errors: List<UpstreamApiError> = emptyList()) : BaseResponse(errors) {
 
   companion object {

src/main/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/models/hmpps/Response.kt

@@ -4,7 +4,7 @@ import org.springframework.data.domain.Page
 import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.BaseResponse
 import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.UpstreamApiError
 
-class PaginatedResponse<T>(pageableResponse: Page<T>, override val errors: List<UpstreamApiError>): BaseResponse(errors) {
+class PaginatedResponse<T>(pageableResponse: Page<T>, override val errors: List<UpstreamApiError>) : BaseResponse(errors) {
 
   constructor(pageableResponse: Page<T>) : this(pageableResponse, emptyList())
   val data: List<T> = pageableResponse.content