Merge pull request #1 from hndrs/add-exception-handler

MarvinSchramm · web-flow · commit df416e1dd3f5 · 2021-02-09T00:30:02.000+01:00
Adds ExceptionHandler and ResponseAdvise Autoconfiguration
diff --git a/README.md b/README.md
diff --git a/build.gradle.kts b/build.gradle.kts
@@ -1,7 +1,7 @@
 import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
 
 object Versions {
-    const val KOTLIN_VERSION = "1.4.10"
+    const val KOTLIN_VERSION = "1.4.30"
 }
 
 buildscript {
@@ -18,9 +18,9 @@ plugins {
     id("org.sonarqube").version("3.0")
     `maven-publish`
     id("io.spring.dependency-management") version "1.0.10.RELEASE"
-    kotlin("jvm").version("1.4.0")
-    kotlin("plugin.spring").version("1.4.0")
-    kotlin("kapt").version("1.4.0")
+    kotlin("jvm").version("1.4.30")
+    kotlin("plugin.spring").version("1.4.30")
+    kotlin("kapt").version("1.4.30")
     id("java")
     id("maven-publish")
     id("idea")
@@ -54,7 +54,7 @@ subprojects {
             cacheChangingModulesFor(0, "seconds")
         }
         imports {
-            mavenBom("org.springframework.boot:spring-boot-dependencies:2.4.2.RELEASE") {
+            mavenBom("org.springframework.boot:spring-boot-dependencies:2.4.2") {
                 bomProperty("kotlin.version", Versions.KOTLIN_VERSION)
             }
         }
@@ -76,7 +76,7 @@ subprojects {
     tasks.withType<KotlinCompile> {
         kotlinOptions {
             freeCompilerArgs = listOf("-Xjsr305=strict")
-            jvmTarget = "11"
+            jvmTarget = "15"
         }
     }
 
@@ -86,25 +86,28 @@ subprojects {
         from(sourceSets["main"].allSource)
     }
 
-    publishing {
-        repositories {
-            
-        }
-        publications {
-            create<MavenPublication>(project.name) {
-                from(components["java"])
-                artifact(sourcesJarSubProject)
-
-                groupId = rootProject.group as? String
-                artifactId = project.name
-                version = "${rootProject.version}${project.findProperty("version.appendix") ?: ""}"
+    if (project.name != "sample") {
+        println(project.name)
+        publishing {
+            repositories {
+
+            }
+            publications {
+                create<MavenPublication>(project.name) {
+                    from(components["java"])
+                    artifact(sourcesJarSubProject)
+
+                    groupId = rootProject.group as? String
+                    artifactId = project.name
+                    version = "${rootProject.version}${project.findProperty("version.appendix") ?: ""}"
+                }
             }
-        }
 
+        }
     }
 
     configure<JacocoPluginExtension> {
-        toolVersion = "0.8.5"
+        toolVersion = "0.8.6"
     }
 
     tasks.withType<JacocoReport> {
diff --git a/sample/build.gradle.kts b/sample/build.gradle.kts
@@ -0,0 +1,11 @@
+plugins {
+    id("org.springframework.boot").version("2.4.2")
+}
+repositories {
+    mavenCentral()
+}
+
+dependencies {
+    implementation(group = "org.springframework.boot", name = "spring-boot-starter-web")
+    implementation(project(":spring-json-api-starter"))
+}
diff --git a/sample/src/main/kotlin/io/hndrs/api/sample/SampleApplication.kt b/sample/src/main/kotlin/io/hndrs/api/sample/SampleApplication.kt
@@ -0,0 +1,13 @@
+package io.hndrs.api.sample
+
+import org.springframework.boot.autoconfigure.SpringBootApplication
+import org.springframework.boot.runApplication
+
+@SpringBootApplication
+open class SampleApplication {
+
+}
+
+fun main(args: Array<String>) {
+    runApplication<SampleApplication>(*args)
+}
diff --git a/sample/src/main/kotlin/io/hndrs/api/sample/SampleController.kt b/sample/src/main/kotlin/io/hndrs/api/sample/SampleController.kt
@@ -0,0 +1,42 @@
+package io.hndrs.api.sample
+
+import io.hndrs.api.response.JsonApiResponse
+import io.hndrs.api.response.Response
+import org.springframework.http.HttpStatus
+import org.springframework.http.ResponseEntity
+import org.springframework.web.bind.annotation.GetMapping
+import org.springframework.web.bind.annotation.RestController
+import org.springframework.web.server.ResponseStatusException
+
+@RestController
+class SampleController {
+
+
+    @GetMapping("/test-errors")
+    fun errors() {
+        throw ResponseStatusException(HttpStatus.CONFLICT)
+    }
+
+    @GetMapping("/address1")
+    @JsonApiResponse
+    fun annotated(): Address {
+        return Address()
+    }
+
+    @GetMapping("/address2")
+    fun wrapped(): Response<Address> {
+        return Response(Address())
+    }
+
+    @GetMapping("/address3")
+    @JsonApiResponse
+    fun annotatedResponseEntity(): ResponseEntity<Address> {
+        return ResponseEntity.ok(Address())
+    }
+
+    data class Address(
+        val street: String = "147 Bleecker St",
+        val locality: String = "New York",
+        val zip: String = "10012"
+    )
+}
diff --git a/settings.gradle.kts b/settings.gradle.kts
@@ -5,3 +5,6 @@ project(":spring-json-api").projectDir = File("spring-json-api")
 
 include("spring-json-api-starter")
 project(":spring-json-api-starter").projectDir = File("spring-json-api-starter")
+
+include("sample")
+project(":sample").projectDir = File("sample")
diff --git a/spring-json-api-starter/build.gradle.kts b/spring-json-api-starter/build.gradle.kts
@@ -1,2 +1,4 @@
 dependencies {
+    api(project(":spring-json-api"))
+    testImplementation(group = "org.springframework.boot", name = "spring-boot-starter-test")
 }
diff --git a/spring-json-api-starter/src/main/kotlin/io/hndrs/api/autoconfigure/JsonApiAutoConfiguration.kt b/spring-json-api-starter/src/main/kotlin/io/hndrs/api/autoconfigure/JsonApiAutoConfiguration.kt
@@ -0,0 +1,20 @@
+package io.hndrs.api.autoconfigure
+
+import io.hndrs.api.exception.ExceptionHandler
+import io.hndrs.api.response.ResponseAdvice
+import org.springframework.context.annotation.Bean
+import org.springframework.context.annotation.Configuration
+
+@Configuration
+open class JsonApiAutoConfiguration {
+
+    @Bean
+    open fun exceptionAdvice(): ExceptionHandler {
+        return ExceptionHandler()
+    }
+
+    @Bean
+    open fun responseAdvice(): ResponseAdvice {
+        return ResponseAdvice()
+    }
+}
diff --git a/spring-json-api-starter/src/main/resources/META-INF/spring.factories b/spring-json-api-starter/src/main/resources/META-INF/spring.factories
@@ -0,0 +1,2 @@
+org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
+io.hndrs.api.autoconfigure.JsonApiAutoConfiguration
diff --git a/spring-json-api-starter/src/test/kotlin/io/hndrs/api/autoconfigure/JsonApiAutoConfigurationTest.kt b/spring-json-api-starter/src/test/kotlin/io/hndrs/api/autoconfigure/JsonApiAutoConfigurationTest.kt
@@ -0,0 +1,24 @@
+package io.hndrs.api.autoconfigure
+
+import io.hndrs.api.exception.ExceptionHandler
+import io.hndrs.api.response.ResponseAdvice
+import org.junit.jupiter.api.Assertions
+import org.junit.jupiter.api.DisplayName
+import org.junit.jupiter.api.Test
+import org.springframework.boot.autoconfigure.AutoConfigurations
+import org.springframework.boot.test.context.runner.WebApplicationContextRunner
+
+@DisplayName("JsonApi Autoconfiguration")
+internal class JsonApiAutoConfigurationTest {
+
+    @Test
+    fun test() {
+        WebApplicationContextRunner()
+            .withConfiguration(
+                AutoConfigurations.of(JsonApiAutoConfiguration::class.java)
+            ).run {
+                Assertions.assertNotNull(it.getBean(ExceptionHandler::class.java))
+                Assertions.assertNotNull(it.getBean(ResponseAdvice::class.java))
+            }
+    }
+}
diff --git a/spring-json-api/build.gradle.kts b/spring-json-api/build.gradle.kts
@@ -1,2 +1,3 @@
 dependencies {
+    api(group = "org.springframework.boot", name = "spring-boot-starter-web")
 }
diff --git a/spring-json-api/src/main/kotlin/io/hndrs/api/exception/ExceptionHandler.kt b/spring-json-api/src/main/kotlin/io/hndrs/api/exception/ExceptionHandler.kt
@@ -0,0 +1,43 @@
+package io.hndrs.api.exception
+
+import io.hndrs.api.response.ErrorResponse
+import org.slf4j.Logger
+import org.slf4j.LoggerFactory
+import org.springframework.http.HttpHeaders
+import org.springframework.http.HttpStatus
+import org.springframework.http.ResponseEntity
+import org.springframework.web.bind.annotation.ControllerAdvice
+import org.springframework.web.bind.annotation.ExceptionHandler
+import org.springframework.web.context.request.WebRequest
+import org.springframework.web.server.ResponseStatusException
+import org.springframework.web.servlet.mvc.method.annotation.ResponseEntityExceptionHandler
+
+@ControllerAdvice
+class ExceptionHandler : ResponseEntityExceptionHandler() {
+
+    @ExceptionHandler(ResponseStatusException::class)
+    fun handleResponseStatusExceptions(ex: ResponseStatusException, request: WebRequest): ResponseEntity<Any> {
+        return ResponseEntity.status(ex.status).body(ErrorResponse(ex.status, ex.reason))
+    }
+
+    @ExceptionHandler(Exception::class)
+    fun handleExceptions(ex: Exception, request: WebRequest): ResponseEntity<Any> {
+        return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR)
+            .body(ErrorResponse(HttpStatus.INTERNAL_SERVER_ERROR, ex.message))
+    }
+
+    override fun handleExceptionInternal(
+        ex: Exception,
+        body: Any?,
+        headers: HttpHeaders,
+        status: HttpStatus,
+        request: WebRequest
+    ): ResponseEntity<Any> {
+        return ResponseEntity.status(status).body(ErrorResponse(status, ex.message))
+    }
+
+    companion object {
+        private val LOG: Logger = LoggerFactory.getLogger(ExceptionHandler::class.java)
+    }
+}
+
diff --git a/spring-json-api/src/main/kotlin/io/hndrs/api/response/ErrorResponse.kt b/spring-json-api/src/main/kotlin/io/hndrs/api/response/ErrorResponse.kt
@@ -0,0 +1,40 @@
+package io.hndrs.api.response
+
+import com.fasterxml.jackson.annotation.JsonProperty
+import org.springframework.http.HttpStatus
+
+
+data class ErrorResponse(
+    @field:JsonProperty("errors") val errors: List<Error>
+) {
+
+    /**
+     * Convenience constructor to create response for one error
+     */
+    constructor(error: Error) : this(listOf(error))
+
+    /**
+     * Convenience constructor to create a simple response based on the http status
+     */
+    constructor(httpStatus: HttpStatus, detail: String? = null) : this(
+        Error(
+            httpStatus.value().toString(),
+            httpStatus.reasonPhrase,
+            detail
+        )
+    )
+
+    data class Error(
+        @field:JsonProperty("status") val status: String,
+        @field:JsonProperty("title") val title: String,
+        @field:JsonProperty("detail") val detail: String? = null
+    )
+
+
+    /**
+     * Empty companion object to allow extensions
+     */
+    companion object
+
+}
+
diff --git a/spring-json-api/src/main/kotlin/io/hndrs/api/response/Meta.kt b/spring-json-api/src/main/kotlin/io/hndrs/api/response/Meta.kt
@@ -0,0 +1,19 @@
+package io.hndrs.api.response
+
+import com.fasterxml.jackson.annotation.JsonProperty
+
+data class ListMeta(
+
+    @field:JsonProperty("offset") val offset: Int,
+
+    @field:JsonProperty("limit") val limit: Int,
+
+    @field:JsonProperty("isLast") val isLast: Boolean,
+
+    @field:JsonProperty("totalElements") val totalElements: Int,
+) {
+    /**
+     * Empty companion object to allow extensions
+     */
+    companion object
+}
diff --git a/spring-json-api/src/main/kotlin/io/hndrs/api/response/Response.kt b/spring-json-api/src/main/kotlin/io/hndrs/api/response/Response.kt
@@ -0,0 +1,11 @@
+package io.hndrs.api.response
+
+import com.fasterxml.jackson.annotation.JsonProperty
+
+data class Response<T>(
+
+    @field:JsonProperty("data") val data: T,
+
+    @field:JsonProperty("meta") val meta: Any? = null
+)
+
diff --git a/spring-json-api/src/main/kotlin/io/hndrs/api/response/ResponseAdvice.kt b/spring-json-api/src/main/kotlin/io/hndrs/api/response/ResponseAdvice.kt
@@ -0,0 +1,38 @@
+package io.hndrs.api.response
+
+import org.springframework.core.MethodParameter
+import org.springframework.http.MediaType
+import org.springframework.http.ResponseEntity
+import org.springframework.http.converter.HttpMessageConverter
+import org.springframework.http.server.ServerHttpRequest
+import org.springframework.http.server.ServerHttpResponse
+import org.springframework.web.bind.annotation.ControllerAdvice
+import org.springframework.web.servlet.mvc.method.annotation.ResponseBodyAdvice
+
+@ControllerAdvice
+class ResponseAdvice : ResponseBodyAdvice<Any> {
+
+    override fun beforeBodyWrite(
+        value: Any?,
+        returnType: MethodParameter,
+        selectedContentType: MediaType,
+        selectedConverterType: Class<out HttpMessageConverter<*>>,
+        request: ServerHttpRequest,
+        response: ServerHttpResponse
+    ): Any? {
+        return when (value) {
+            is ResponseEntity<*> -> ResponseEntity.status(value.statusCode).headers(value.headers).body(value.body)
+            null -> null
+            else -> Response(value)
+        }
+    }
+
+    override fun supports(returnType: MethodParameter, converterType: Class<out HttpMessageConverter<*>>): Boolean {
+        return returnType.method?.isAnnotationPresent(JsonApiResponse::class.java) ?: false
+    }
+}
+
+@Retention(AnnotationRetention.RUNTIME)
+@Target(AnnotationTarget.FUNCTION)
+annotation class JsonApiResponse
+
diff --git a/version.txt b/version.txt
@@ -1 +1 @@
-0.0.1
+1.0.0

Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,4 @@`
`1`	`1`	`dependencies {`
	`2`	`+ api(project(":spring-json-api"))`
	`3`	`+ testImplementation(group = "org.springframework.boot", name = "spring-boot-starter-test")`
`2`	`4`	`}`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+org.springframework.boot.autoconfigure.EnableAutoConfiguration=\`
	`2`	`+io.hndrs.api.autoconfigure.JsonApiAutoConfiguration`