Skip to content

Commit

Permalink
GH-31 Support auto-boxing of nullable parameters with Optional (Resolve
Browse files Browse the repository at this point in the history 
#31)
  • Loading branch information
@dzikoysk
dzikoysk committed Jan 1, 2025
1 parent 8bc81d6 commit eaf6490
Show file tree
Hide file tree
Showing 2 changed files with 49 additions and 19 deletions.
64 changes: 45 additions & 19 deletions ...ated/src/main/kotlin/io/javalin/community/routing/annotations/ReflectiveEndpointLoader.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,13 @@ import io.javalin.event.JavalinLifecycleEvent
import io.javalin.http.Context
import io.javalin.http.HttpStatus
import io.javalin.validation.Validation
import io.javalin.validation.Validator
import java.lang.reflect.AnnotatedElement
import java.lang.reflect.Method
import java.lang.reflect.Parameter
import java.lang.reflect.ParameterizedType
import java.lang.reflect.Type
import java.util.*
import kotlin.reflect.KClass

typealias AnnotatedRoute = DefaultDslRoute<Context, Unit>
Expand Down Expand Up @@ -62,8 +66,9 @@ internal class ReflectiveEndpointLoader(
"Unable to access method $method in class $endpointClass"
}

val argumentSuppliers = method.parameters.map {
createArgumentSupplier<Unit>(it) ?: throw IllegalArgumentException("Unsupported parameter type: $it")
val types = method.genericParameterTypes
val argumentSuppliers = method.parameters.mapIndexed { idx, parameter ->
createArgumentSupplier<Unit>(parameter, types[idx]) ?: throw IllegalArgumentException("Unsupported parameter type: $parameter")
}

val status = method.getAnnotation<Status>()
Expand Down Expand Up @@ -103,8 +108,9 @@ internal class ReflectiveEndpointLoader(
"Unable to access method $method in class $endpointClass"
}

val argumentSuppliers = method.parameters.map {
createArgumentSupplier<Exception>(it) ?: throw IllegalArgumentException("Unsupported parameter type: $it")
val types = method.genericParameterTypes
val argumentSuppliers = method.parameters.mapIndexed { idx, parameter ->
createArgumentSupplier<Exception>(parameter, types[idx]) ?: throw IllegalArgumentException("Unsupported parameter type: $parameter")
}

val status = method.getAnnotation<Status>()
Expand Down Expand Up @@ -194,56 +200,76 @@ internal class ReflectiveEndpointLoader(

private inline fun <reified CUSTOM : Any> createArgumentSupplier(
parameter: Parameter,
parameterType: Type,
noinline custom: (Context, CUSTOM) -> Any? = { _, self -> self }
): ((Context, CUSTOM) -> Any?)? =
with (parameter) {
): ((Context, CUSTOM) -> Any?)? {
val isOptional = parameter.type.isAssignableFrom(Optional::class.java)

val expectedType = when {
isOptional -> (parameterType as ParameterizedType).actualTypeArguments[0]
else -> parameterType
}
val expectedTypeAsClass = expectedType as Class<*>

return with(parameter) {
when {
CUSTOM::class.java.isAssignableFrom(type) ->
custom
type.isAssignableFrom(Context::class.java) -> { ctx, _ ->
CUSTOM::class.java.isAssignableFrom(expectedTypeAsClass) -> { ctx, c ->
when {
isOptional -> Optional.ofNullable(custom(ctx, c))
else -> custom(ctx, c)
}
}
expectedTypeAsClass.isAssignableFrom(Context::class.java) -> { ctx, _ ->
ctx
}
isAnnotationPresent<Param>() -> { ctx, _ ->
getAnnotationOrThrow<Param>()
.value
.ifEmpty { name }
.let { ctx.pathParamAsClass(it, type) }
.get()
.let { ctx.pathParamAsClass(it, expectedTypeAsClass) }
.getValidatorValue(optional = isOptional)
}
isAnnotationPresent<Header>() -> { ctx, _ ->
getAnnotationOrThrow<Header>()
.value
.ifEmpty { name }
.let { ctx.headerAsClass(it, type) }
.get()
.let { ctx.headerAsClass(it, expectedTypeAsClass) }
.getValidatorValue(optional = isOptional)
}
isAnnotationPresent<Query>() -> { ctx, _ ->
getAnnotationOrThrow<Query>()
.value
.ifEmpty { name }
.let { ctx.queryParamAsClass(it, type) }
.get()
.let { ctx.queryParamAsClass(it, expectedTypeAsClass) }
.getValidatorValue(optional = isOptional)
}
isAnnotationPresent<Form>() -> { ctx, _ ->
getAnnotationOrThrow<Form>()
.value
.ifEmpty { name }
.let { ctx.formParamAsClass(it, type) }
.get()
.let { ctx.formParamAsClass(it, expectedTypeAsClass) }
.getValidatorValue(optional = isOptional)
}
isAnnotationPresent<Cookie>() -> { ctx, _ ->
getAnnotationOrThrow<Cookie>()
.value
.ifEmpty { name }
.let { Validation().validator(it, type, ctx.cookie(it)) }
.get()
.let { Validation().validator(it, expectedTypeAsClass, ctx.cookie(it)) }
.getValidatorValue(optional = isOptional)
}
isAnnotationPresent<Body>() -> { ctx, _ ->
ctx.bodyAsClass(parameter.parameterizedType)
}
else -> null
}
}
}

private fun <T : Any> Validator<T>.getValidatorValue(optional: Boolean): Any =
when {
optional -> Optional.ofNullable(allowNullable().get())
else -> get()
}

private inline fun <reified A : Annotation> AnnotatedElement.isAnnotationPresent(): Boolean =
isAnnotationPresent(A::class.java)
Expand Down
4 changes: 4 additions & 0 deletions ...-annotated/src/test/java/io/javalin/community/routing/annotations/AnnotatedRoutingTest.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ import org.assertj.core.api.Assertions.assertThat
import org.assertj.core.api.Assertions.assertThatThrownBy
import org.junit.jupiter.api.Test
import org.junit.jupiter.api.assertDoesNotThrow
import java.util.*

class AnnotatedRoutingTest {

Expand Down Expand Up @@ -145,12 +146,14 @@ class AnnotatedRoutingTest {
ctx: Context,
@Param param: Int,
@Header header: Int,
@Header optionalHeader: Optional<String>,
@Query query: Int,
@Cookie cookie: Int,
@Body body: Int,
) {
ctx.header("param", param.toString())
ctx.header("header", header.toString())
ctx.header("optionalHeader", optionalHeader.orElse("default"))
ctx.header("query", query.toString())
ctx.header("cookie", cookie.toString())
ctx.header("body", body.toString())
Expand All @@ -170,6 +173,7 @@ class AnnotatedRoutingTest {

assertThat(responseHeaders.getFirst("param")).isEqualTo("1")
assertThat(responseHeaders.getFirst("header")).isEqualTo("2")
assertThat(responseHeaders.getFirst("optionalHeader")).isEqualTo("default")
assertThat(responseHeaders.getFirst("query")).isEqualTo("3")
assertThat(responseHeaders.getFirst("cookie")).isEqualTo("4")
assertThat(responseHeaders.getFirst("body")).isEqualTo("5")
Expand Down

0 comments on commit eaf6490

Please sign in to comment.