Skip to content

Commit

Permalink
GH-42 Support beforeMatched/afterMatched handlers in annotations module
Browse files Browse the repository at this point in the history
  • Loading branch information
@dzikoysk
dzikoysk committed Feb 16, 2024
1 parent 46196df commit 801b377
Show file tree
Hide file tree
Showing 3 changed files with 50 additions and 25 deletions.
8 changes: 8 additions & 0 deletions ...cification/src/main/kotlin/io/javalin/community/routing/annotations/RoutingAnnotations.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -50,10 +50,18 @@ annotation class Options(val value: String = "", val async: Boolean = false)
@Target(FUNCTION)
annotation class Before(val value: String = "*", val async: Boolean = false)

@Retention(RUNTIME)
@Target(FUNCTION)
annotation class BeforeMatched(val value: String = "*", val async: Boolean = false)

@Retention(RUNTIME)
@Target(FUNCTION)
annotation class After(val value: String = "*", val async: Boolean = false)

@Retention(RUNTIME)
@Target(FUNCTION)
annotation class AfterMatched(val value: String = "*", val async: Boolean = false)

@Retention(RUNTIME)
@Target(FUNCTION)
annotation class Version(val value: String)
Expand Down
63 changes: 38 additions & 25 deletions ...ated/src/main/kotlin/io/javalin/community/routing/annotations/ReflectiveEndpointLoader.kt
View file
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
package io.javalin.community.routing.annotations

import io.javalin.community.routing.Route
import io.javalin.community.routing.Route.BEFORE_MATCHED
import io.javalin.community.routing.dsl.DefaultDslException
import io.javalin.community.routing.dsl.DefaultDslRoute
import io.javalin.http.Context
import io.javalin.http.HttpStatus
import io.javalin.validation.Validation
import java.lang.reflect.AnnotatedElement
import java.lang.reflect.Method
import java.lang.reflect.Parameter
import kotlin.reflect.KClass
Expand All @@ -22,23 +24,25 @@ internal class ReflectiveEndpointLoader(
fun loadRoutesFromEndpoint(endpoint: Any): List<AnnotatedRoute> {
val endpointClass = endpoint::class.java

val endpointPath = endpointClass.getAnnotation(Endpoints::class.java)
val endpointPath = endpointClass.getAnnotation<Endpoints>()
?.value
?: ""

val endpointRoutes = mutableListOf<AnnotatedRoute>()

endpointClass.declaredMethods.forEach { method ->
val (httpMethod, path, async) = when {
method.isAnnotationPresent(Before::class.java) -> method.getAnnotation(Before::class.java).let { Triple(Route.BEFORE, it.value, it.async) }
method.isAnnotationPresent(After::class.java) -> method.getAnnotation(After::class.java).let { Triple(Route.AFTER, it.value, it.async) }
method.isAnnotationPresent(Get::class.java) -> method.getAnnotation(Get::class.java).let { Triple(Route.GET, it.value, it.async) }
method.isAnnotationPresent(Put::class.java) -> method.getAnnotation(Put::class.java).let { Triple(Route.PUT, it.value, it.async) }
method.isAnnotationPresent(Post::class.java) -> method.getAnnotation(Post::class.java).let { Triple(Route.POST, it.value, it.async) }
method.isAnnotationPresent(Delete::class.java) -> method.getAnnotation(Delete::class.java).let { Triple(Route.DELETE, it.value, it.async) }
method.isAnnotationPresent(Head::class.java) -> method.getAnnotation(Head::class.java).let { Triple(Route.HEAD, it.value, it.async) }
method.isAnnotationPresent(Patch::class.java) -> method.getAnnotation(Patch::class.java).let { Triple(Route.PATCH, it.value, it.async) }
method.isAnnotationPresent(Options::class.java) -> method.getAnnotation(Options::class.java).let { Triple(Route.OPTIONS, it.value, it.async) }
method.isAnnotationPresent<Before>() -> method.getAnnotation<Before>()!!.let { Triple(Route.BEFORE, it.value, it.async) }
method.isAnnotationPresent<BeforeMatched>() -> method.getAnnotation<BeforeMatched>()!!.let { Triple(BEFORE_MATCHED, it.value, it.async) }
method.isAnnotationPresent<After>() -> method.getAnnotation<After>()!!.let { Triple(Route.AFTER, it.value, it.async) }
method.isAnnotationPresent<AfterMatched>() -> method.getAnnotation<AfterMatched>()!!.let { Triple(Route.AFTER_MATCHED, it.value, it.async) }
method.isAnnotationPresent<Get>() -> method.getAnnotation<Get>()!!.let { Triple(Route.GET, it.value, it.async) }
method.isAnnotationPresent<Put>() -> method.getAnnotation<Put>()!!.let { Triple(Route.PUT, it.value, it.async) }
method.isAnnotationPresent<Post>() -> method.getAnnotation<Post>()!!.let { Triple(Route.POST, it.value, it.async) }
method.isAnnotationPresent<Delete>() -> method.getAnnotation<Delete>()!!.let { Triple(Route.DELETE, it.value, it.async) }
method.isAnnotationPresent<Head>() -> method.getAnnotation<Head>()!!.let { Triple(Route.HEAD, it.value, it.async) }
method.isAnnotationPresent<Patch>() -> method.getAnnotation<Patch>()!!.let { Triple(Route.PATCH, it.value, it.async) }
method.isAnnotationPresent<Options>() -> method.getAnnotation<Options>()!!.let { Triple(Route.OPTIONS, it.value, it.async) }
else -> return@forEach
}

Expand All @@ -50,13 +54,13 @@ internal class ReflectiveEndpointLoader(
createArgumentSupplier<Unit>(it) ?: throw IllegalArgumentException("Unsupported parameter type: $it")
}

val status = method.getAnnotation(Status::class.java)
val status = method.getAnnotation<Status>()
val resultHandler = findResultHandler(method)

val route = AnnotatedRoute(
method = httpMethod,
path = ("/$endpointPath/$path").replace(repeatedPathSeparatorRegex, "/"),
version = method.getAnnotation(Version::class.java)?.value,
version = method.getAnnotation<Version>()?.value,
handler = {
val arguments = argumentSuppliers
.map { it(this, Unit) }
Expand All @@ -81,7 +85,7 @@ internal class ReflectiveEndpointLoader(
val dslExceptions = mutableListOf<AnnotatedException>()

endpointClass.declaredMethods.forEach { method ->
val exceptionHandlerAnnotation = method.getAnnotation(ExceptionHandler::class.java) ?: return@forEach
val exceptionHandlerAnnotation = method.getAnnotation<ExceptionHandler>() ?: return@forEach

require(method.trySetAccessible()) {
"Unable to access method $method in class $endpointClass"
Expand All @@ -91,7 +95,7 @@ internal class ReflectiveEndpointLoader(
createArgumentSupplier<Exception>(it) ?: throw IllegalArgumentException("Unsupported parameter type: $it")
}

val status = method.getAnnotation(Status::class.java)
val status = method.getAnnotation<Status>()
val resultHandler = findResultHandler(method)

val dslException = AnnotatedException(
Expand Down Expand Up @@ -166,46 +170,55 @@ internal class ReflectiveEndpointLoader(
type.isAssignableFrom(Context::class.java) -> { ctx, _ ->
ctx
}
isAnnotationPresent(Param::class.java) -> { ctx, _ ->
getAnnotation(Param::class.java)
isAnnotationPresent<Param>() -> { ctx, _ ->
getAnnotationOrThrow<Param>()
.value
.ifEmpty { name }
.let { ctx.pathParamAsClass(it, type) }
.get()
}
isAnnotationPresent(Header::class.java) -> { ctx, _ ->
getAnnotation(Header::class.java)
isAnnotationPresent<Header>() -> { ctx, _ ->
getAnnotationOrThrow<Header>()
.value
.ifEmpty { name }
.let { ctx.headerAsClass(it, type) }
.get()
}
isAnnotationPresent(Query::class.java) -> { ctx, _ ->
getAnnotation(Query::class.java)
isAnnotationPresent<Query>() -> { ctx, _ ->
getAnnotationOrThrow<Query>()
.value
.ifEmpty { name }
.let { ctx.queryParamAsClass(it, type) }
.get()
}
isAnnotationPresent(Form::class.java) -> { ctx, _ ->
getAnnotation(Form::class.java)
isAnnotationPresent<Form>() -> { ctx, _ ->
getAnnotationOrThrow<Form>()
.value
.ifEmpty { name }
.let { ctx.formParamAsClass(it, type) }
.get()
}
isAnnotationPresent(Cookie::class.java) -> { ctx, _ ->
getAnnotation(Cookie::class.java)
isAnnotationPresent<Cookie>() -> { ctx, _ ->
getAnnotationOrThrow<Cookie>()
.value
.ifEmpty { name }
.let { Validation().validator(it, type, ctx.cookie(it)) }
.get()
}
isAnnotationPresent(Body::class.java) -> { ctx, _ ->
isAnnotationPresent<Body>() -> { ctx, _ ->
ctx.bodyAsClass(parameter.parameterizedType)
}
else -> null
}
}

private inline fun <reified A : Annotation> AnnotatedElement.isAnnotationPresent(): Boolean =
isAnnotationPresent(A::class.java)

private inline fun <reified A : Annotation> AnnotatedElement.getAnnotationOrThrow(): A =
getAnnotation(A::class.java) ?: throw IllegalStateException("Annotation ${A::class.java.name} not found")

private inline fun <reified A : Annotation> AnnotatedElement.getAnnotation(): A? =
getAnnotation(A::class.java)

}
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 @@ -74,6 +74,8 @@ class AnnotatedRoutingTest {
object {
// formatter:off
@Before fun beforeEach(ctx: Context) { ctx.header("before", "true") }
@BeforeMatched fun beforeEachMatched(ctx: Context) { ctx.header("before-matched", "true") }
@AfterMatched fun afterEachMatched(ctx: Context) { ctx.header("after-matched", "true") }
@After fun afterEach(ctx: Context) { ctx.header("after", "true") }
@Get("/get") fun testGet(ctx: Context) { ctx.header("get", "true") }
@Post("/post") fun testPost(ctx: Context) { ctx.header("post", "true") }
Expand All @@ -94,7 +96,9 @@ class AnnotatedRoutingTest {
val response = request(it.name, "${client.origin}/test/${it.name.lowercase()}").asEmpty()
assertThat(response.headers.getFirst(it.name.lowercase())).isEqualTo("true")
assertThat(response.headers.getFirst("before")).isEqualTo("true")
assertThat(response.headers.getFirst("before-matched")).isEqualTo("true")
assertThat(response.headers.getFirst("after")).isEqualTo("true")
assertThat(response.headers.getFirst("after-matched")).isEqualTo("true")
}
}

Expand Down

0 comments on commit 801b377

Please sign in to comment.