Fikser plugin for å kreve callId på endepunkter.

Author: ramrock93

Diff for: dusseldorf-ktor-core/src/main/kotlin/no/nav/helse/dusseldorf/ktor/core/CallIdExt.kt

@@ -1,18 +1,9 @@
 package no.nav.helse.dusseldorf.ktor.core
 
-import io.ktor.server.application.ApplicationCall
-import io.ktor.server.application.ApplicationCallPipeline
-import io.ktor.server.application.BaseApplicationPlugin
-import io.ktor.server.plugins.callid.callId
-import io.ktor.server.plugins.callid.CallIdConfig
 import io.ktor.http.HttpHeaders
 import io.ktor.http.encodeURLParameter
-import io.ktor.server.application.PipelineCall
+import io.ktor.server.plugins.callid.CallIdConfig
 import io.ktor.server.request.header
-import io.ktor.server.routing.Route
-import io.ktor.server.routing.application
-import io.ktor.util.AttributeKey
-import io.ktor.util.pipeline.PipelineContext
 import org.slf4j.Logger
 import org.slf4j.LoggerFactory
 import java.util.*
@@ -22,21 +13,27 @@ internal object IdVerifier {
     private const val NorskeBokstaver = "æøåÆØÅ"
     private const val GeneratedIdPrefix = "generated-"
 
-    private val idRegex  = "[a-zA-Z0-9_.\\-${NorskeBokstaver}]{5,200}".toRegex()
-    internal fun verifyId(type: String, id:String) = idRegex.matches(id).also { valid ->
+    private val idRegex = "[a-zA-Z0-9_.\\-${NorskeBokstaver}]{5,200}".toRegex()
+    internal fun verifyId(type: String, id: String) = idRegex.matches(id).also { valid ->
         if (!valid) logger.warn("Ugyldig $type=[${id.encodeURLParameter()}] (url-encoded)")
     }
+
     internal fun generate() = "$GeneratedIdPrefix${UUID.randomUUID()}"
     internal fun String.trimId() = removePrefix(GeneratedIdPrefix)
 }
 
-fun CallIdConfig.fromFirstNonNullHeader(headers: List<String>, generateOnInvalid: Boolean = false, generateOnNotSet: Boolean = false) {
+fun CallIdConfig.fromFirstNonNullHeader(
+    headers: List<String>,
+    generateOnInvalid: Boolean = false,
+    generateOnNotSet: Boolean = false,
+) {
     retrieve { call ->
         when (val fromHeaders = headers.mapNotNull { call.request.header(it) }.firstOrNull()) {
             null -> when (generateOnNotSet) {
                 true -> IdVerifier.generate()
                 false -> fromHeaders
             }
+
             else -> when (IdVerifier.verifyId(type = HttpHeaders.XCorrelationId, id = fromHeaders)) {
                 true -> fromHeaders
                 false -> when (generateOnInvalid) {
@@ -51,52 +48,12 @@ fun CallIdConfig.fromFirstNonNullHeader(headers: List<String>, generateOnInvalid
 }
 
 // Henter fra CorrelationID (backend tjenester)
-fun CallIdConfig.fromXCorrelationIdHeader(generateOnInvalid: Boolean = false, generateOnNotSet: Boolean = false) = fromFirstNonNullHeader(
-    headers = listOf(HttpHeaders.XCorrelationId), generateOnInvalid = generateOnInvalid, generateOnNotSet = false
-)
+fun CallIdConfig.fromXCorrelationIdHeader(generateOnInvalid: Boolean = false, generateOnNotSet: Boolean = false) =
+    fromFirstNonNullHeader(
+        headers = listOf(HttpHeaders.XCorrelationId), generateOnInvalid = generateOnInvalid, generateOnNotSet = false
+    )
 
 // Genererer CorrelationID (frontend tjeneste)
 fun CallIdConfig.generated() {
     generate { IdVerifier.generate() }
 }
-
-class Configuration
-class CallIdRequired(private val configure: Configuration) {
-
-    private val logger = LoggerFactory.getLogger("no.nav.helse.dusseldorf.ktor.core.CallIdRequired")
-
-    private val problemDetails = ValidationProblemDetails(
-            setOf(Violation(
-                    parameterName = HttpHeaders.XCorrelationId,
-                    parameterType = ParameterType.HEADER,
-                    reason = "Correlation ID må settes.",
-                    invalidValue = null
-            ))
-    )
-
-    fun interceptPipeline(route: Route) {
-        route.application.intercept(ApplicationCallPipeline.Monitoring) {
-            require(this)
-        }
-    }
-
-    private suspend fun require(context: PipelineContext<Unit, PipelineCall>) {
-        val callId = context.context.callId
-        if (callId == null) {
-            context.context.respondProblemDetails(problemDetails, logger)
-            context.finish()
-        } else {
-            context.proceed()
-        }
-    }
-
-    companion object Feature :
-        BaseApplicationPlugin<ApplicationCallPipeline, Configuration, CallIdRequired> {
-
-        override fun install(pipeline: ApplicationCallPipeline, configure: Configuration.() -> Unit): CallIdRequired {
-            return CallIdRequired(Configuration().apply(configure))
-        }
-
-        override val key = AttributeKey<CallIdRequired>("CallIdRequired")
-    }
-}

Diff for: dusseldorf-ktor-core/src/main/kotlin/no/nav/helse/dusseldorf/ktor/core/RouteExt.kt

@@ -1,21 +1,41 @@
 package no.nav.helse.dusseldorf.ktor.core
 
-import io.ktor.server.application.plugin
-import io.ktor.server.routing.*
+import io.ktor.http.HttpHeaders
+import io.ktor.server.application.PipelineCall
+import io.ktor.server.application.createRouteScopedPlugin
+import io.ktor.server.plugins.callid.callId
+import io.ktor.server.routing.Route
+import io.ktor.server.routing.RouteSelector
+import io.ktor.server.routing.RouteSelectorEvaluation
+import io.ktor.server.routing.RoutingResolveContext
 
-fun Route.requiresCallId(
-        build: Route.() -> Unit
-): Route {
-    val requiresCallIdRoutes: Route = createChild(RequiresCallIdRouteSelector())
-    application.plugin(CallIdRequired).interceptPipeline(requiresCallIdRoutes)
-    requiresCallIdRoutes.build()
-    return requiresCallIdRoutes
+fun Route.requiresCallId(build: Route.() -> Unit): Route {
+    return createChild(object : RouteSelector() {
+        override suspend fun evaluate(context: RoutingResolveContext, segmentIndex: Int): RouteSelectorEvaluation {
+            return RouteSelectorEvaluation.Constant
+        }
+        override fun toString(): String = "RequiresCallId"
+    }).apply {
+        install(CallIdRequiredPlugin)
+        build()
+    }
 }
 
-private class RequiresCallIdRouteSelector : RouteSelector() {
-    override suspend fun evaluate(context: RoutingResolveContext, segmentIndex: Int): RouteSelectorEvaluation {
-        return RouteSelectorEvaluation.Constant
-    }
+// Definerer route-scoped plugin som sjekker at det eksisterer callId på request.
+val CallIdRequiredPlugin = createRouteScopedPlugin("CallIdRequiredPlugin") {
+    val problemDetails = ValidationProblemDetails(
+        setOf(Violation(
+            parameterName = HttpHeaders.XCorrelationId,
+            parameterType = ParameterType.HEADER,
+            reason = "Correlation ID må settes.",
+            invalidValue = null
+        ))
+    )
 
-    override fun toString() = "RequiresCallId"
+    onCall { call: PipelineCall ->
+        if (call.callId == null) {
+            call.respondProblemDetails(problemDetails)
+            return@onCall
+        }
+    }
 }

Diff for: dusseldorf-ktor-testapp/src/main/kotlin/no/nav/App.kt

@@ -18,7 +18,6 @@ import no.nav.helse.dusseldorf.ktor.client.HttpRequestHealthCheck
 import no.nav.helse.dusseldorf.ktor.client.HttpRequestHealthConfig
 import no.nav.helse.dusseldorf.ktor.client.SimpleHttpClient.httpGet
 import no.nav.helse.dusseldorf.ktor.client.SimpleHttpClient.readTextOrThrow
-import no.nav.helse.dusseldorf.ktor.core.CallIdRequired
 import no.nav.helse.dusseldorf.ktor.core.DefaultProbeRoutes
 import no.nav.helse.dusseldorf.ktor.core.FullførAktiveRequester
 import no.nav.helse.dusseldorf.ktor.core.PreStopRoute
@@ -46,7 +45,6 @@ fun Application.app() {
         jackson {}
     }
 
-    install(CallIdRequired)
     install(CallId) {
         fromXCorrelationIdHeader()
     }

Diff for: dusseldorf-ktor-testapp/src/test/kotlin/no/nav/AppTest.kt

@@ -48,6 +48,18 @@ internal class AppTest {
         }
     }
 
+    @Test
+    fun `Tester health og metrics endepunkter ikke trenger callId`() {
+        withNettyEngine(appPort = 1337) {
+            listOf("/isready", "/isalive", "/metrics", "/health").forEach {
+                val getResponse: Pair<HttpRequestData, Result<HttpResponse>> = "http://localhost:1337$it".httpGet()
+
+                val responseText = getResponse.readTextOrThrow()
+                assertEquals(HttpStatusCode.OK, responseText.first, responseText.second)
+            }
+        }
+    }
+
     private suspend fun doNTimes(n: Int = 20, block: suspend () -> Any) {
         for (i in 1..n) { block() }
     }