fix(awslambda): extends path param normalisation to all adapters.

Author: outofcoffee

adapter/awslambda/build.gradle

@@ -2,7 +2,6 @@ apply plugin: 'java-library'
 apply plugin: 'kotlin'
 
 ext {
-    version_junit_jupiter = '5.10.0'
     version_lambda_logger = '1.5.1'
 }
 

adapter/awslambda/src/main/java/io/gatehill/imposter/awslambda/impl/ServerV1.kt

@@ -59,7 +59,7 @@ import io.gatehill.imposter.util.HttpUtil
  */
 class ServerV1(
     responseService: ResponseService,
-    router: HttpRouter,
+    private val router: HttpRouter,
 ) : LambdaServer<APIGatewayProxyRequestEvent, APIGatewayProxyResponseEvent>(responseService, router) {
 
     init {
@@ -74,7 +74,7 @@ class ServerV1(
         return HttpUtil.readAcceptedContentTypes(event.headers["Accept"]).contains(HttpUtil.CONTENT_TYPE_HTML)
     }
 
-    override fun buildRequest(event: APIGatewayProxyRequestEvent, route: HttpRoute?) = LambdaHttpRequestV1(event, route)
+    override fun buildRequest(event: APIGatewayProxyRequestEvent, route: HttpRoute?) = LambdaHttpRequestV1(event, router, route)
 
     override fun buildResponse(response: LambdaHttpResponse) = APIGatewayProxyResponseEvent().apply {
         // read status again in case modified by error handler

adapter/awslambda/src/main/java/io/gatehill/imposter/awslambda/impl/ServerV2.kt

@@ -59,7 +59,7 @@ import io.gatehill.imposter.util.HttpUtil
  */
 class ServerV2(
     responseService: ResponseService,
-    router: HttpRouter,
+    private val router: HttpRouter,
 ) : LambdaServer<APIGatewayV2HTTPEvent, APIGatewayV2HTTPResponse>(responseService, router) {
 
     init {
@@ -74,7 +74,7 @@ class ServerV2(
         return HttpUtil.readAcceptedContentTypes(event.headers["Accept"]).contains(HttpUtil.CONTENT_TYPE_HTML)
     }
 
-    override fun buildRequest(event: APIGatewayV2HTTPEvent, route: HttpRoute?) = LambdaHttpRequestV2(event, route)
+    override fun buildRequest(event: APIGatewayV2HTTPEvent, route: HttpRoute?) = LambdaHttpRequestV2(event, router, route)
 
     override fun buildResponse(response: LambdaHttpResponse) = APIGatewayV2HTTPResponse().apply {
         // read status again in case modified by error handler

adapter/awslambda/src/main/java/io/gatehill/imposter/awslambda/impl/model/LambdaHttpRequestV1.kt

@@ -49,6 +49,8 @@ import io.gatehill.imposter.awslambda.util.FormParserUtil
 import io.gatehill.imposter.http.HttpMethod
 import io.gatehill.imposter.http.HttpRequest
 import io.gatehill.imposter.http.HttpRoute
+import io.gatehill.imposter.http.HttpRouter
+import io.gatehill.imposter.http.util.PathNormaliser
 import io.gatehill.imposter.script.LowercaseKeysMap
 import io.vertx.core.buffer.Buffer
 import io.vertx.core.json.JsonObject
@@ -58,6 +60,7 @@ import io.vertx.core.json.JsonObject
  */
 class LambdaHttpRequestV1(
     private val event: APIGatewayProxyRequestEvent,
+    private val router: HttpRouter,
     private val currentRoute: HttpRoute?,
 ) : HttpRequest {
     private val baseUrl: String
@@ -91,10 +94,10 @@ class LambdaHttpRequestV1(
     }
 
     override val pathParams: Map<String, String>
-        get() = pathParameters
+        get() = PathNormaliser.denormaliseParams(router.normalisedParams, pathParameters)
 
     override fun getPathParam(paramName: String): String? {
-        return pathParameters[paramName]
+        return pathParameters[PathNormaliser.getNormalisedParamName(router.normalisedParams, paramName)]
     }
 
     override val queryParams: Map<String, String>

adapter/awslambda/src/main/java/io/gatehill/imposter/awslambda/impl/model/LambdaHttpRequestV2.kt

@@ -49,6 +49,8 @@ import io.gatehill.imposter.awslambda.util.FormParserUtil
 import io.gatehill.imposter.http.HttpMethod
 import io.gatehill.imposter.http.HttpRequest
 import io.gatehill.imposter.http.HttpRoute
+import io.gatehill.imposter.http.HttpRouter
+import io.gatehill.imposter.http.util.PathNormaliser
 import io.gatehill.imposter.script.LowercaseKeysMap
 import io.vertx.core.buffer.Buffer
 import io.vertx.core.json.JsonObject
@@ -58,6 +60,7 @@ import io.vertx.core.json.JsonObject
  */
 class LambdaHttpRequestV2(
     private val event: APIGatewayV2HTTPEvent,
+    private val router: HttpRouter,
     private val currentRoute: HttpRoute?,
 ) : HttpRequest {
     private val baseUrl: String
@@ -91,10 +94,10 @@ class LambdaHttpRequestV2(
     }
 
     override val pathParams: Map<String, String>
-        get() = pathParameters
+        get() = PathNormaliser.denormaliseParams(router.normalisedParams, pathParameters)
 
     override fun getPathParam(paramName: String): String? {
-        return pathParameters[paramName]
+        return pathParameters[PathNormaliser.getNormalisedParamName(router.normalisedParams, paramName)]
     }
 
     override val queryParams: Map<String, String>

adapter/vertxweb/build.gradle

@@ -2,10 +2,6 @@ apply plugin: 'java-library'
 apply plugin: 'kotlin'
 apply plugin: 'maven-publish'
 
-ext {
-    version_junit_jupiter = '5.10.0'
-}
-
 compileJava {
     sourceCompatibility = JavaVersion.VERSION_11
 }

adapter/vertxweb/src/main/java/io/gatehill/imposter/server/vertxweb/VertxWebServerFactoryImpl.kt

@@ -134,22 +134,21 @@ class VertxWebServerFactoryImpl : ServerFactory {
     }
 
     private fun convertRouterToVertx(router: HttpRouter) = Router.router(router.vertx).also { vertxRouter ->
-        val normalisedParams = mutableMapOf<String, String>()
         router.routes.forEach { httpRoute ->
             val vertxRoute = httpRoute.regex?.let { regex ->
                 httpRoute.method?.let { method -> vertxRouter.routeWithRegex(method.convertMethodToVertx(), regex) }
                     ?: vertxRouter.routeWithRegex(regex)
 
             } ?: httpRoute.path?.let { path ->
-                val normalisedPath = VertxResourceUtil.normalisePath(normalisedParams, path)
-                httpRoute.method?.let { method -> vertxRouter.route(method.convertMethodToVertx(), normalisedPath) }
-                    ?: vertxRouter.route(normalisedPath)
+                val convertedPath = VertxResourceUtil.convertPath(path)
+                httpRoute.method?.let { method -> vertxRouter.route(method.convertMethodToVertx(), convertedPath) }
+                    ?: vertxRouter.route(convertedPath)
 
             } ?: vertxRouter.route()
 
             val handler = httpRoute.handler ?: throw IllegalStateException("No route handler set for: $httpRoute")
             vertxRoute.handler { rc ->
-                val exchange = VertxHttpExchange(router, normalisedParams, rc, httpRoute)
+                val exchange = VertxHttpExchange(router, httpRoute, rc)
 
                 // don't block the event loop
                 handler(exchange).handle { _, t ->
@@ -161,7 +160,7 @@ class VertxWebServerFactoryImpl : ServerFactory {
 
         router.errorHandlers.forEach { (statusCode, errorHandler) ->
             vertxRouter.errorHandler(statusCode) { rc ->
-                errorHandler(VertxHttpExchange(router, normalisedParams, rc, null))
+                errorHandler(VertxHttpExchange(router, null, rc))
             }
         }
     }

adapter/vertxweb/src/main/java/io/gatehill/imposter/server/vertxweb/impl/VertxHttpExchange.kt

@@ -56,14 +56,13 @@ import io.vertx.ext.web.impl.ParsableMIMEValue
  */
 class VertxHttpExchange(
     private val router: HttpRouter,
-    normalisedParams: Map<String, String>,
-    internal val routingContext: RoutingContext,
     override val currentRoute: HttpRoute?,
+    internal val routingContext: RoutingContext,
 ) : HttpExchange {
     override var phase = ExchangePhase.REQUEST_RECEIVED
 
     override val request: HttpRequest by lazy {
-        VertxHttpRequest(normalisedParams, routingContext)
+        VertxHttpRequest(router, routingContext)
     }
 
     override val response: HttpResponse by lazy {

adapter/vertxweb/src/main/java/io/gatehill/imposter/server/vertxweb/impl/VertxHttpRequest.kt

@@ -44,7 +44,8 @@ package io.gatehill.imposter.server.vertxweb.impl
 
 import io.gatehill.imposter.http.HttpMethod
 import io.gatehill.imposter.http.HttpRequest
-import io.gatehill.imposter.server.vertxweb.util.VertxResourceUtil
+import io.gatehill.imposter.http.HttpRouter
+import io.gatehill.imposter.http.util.PathNormaliser
 import io.gatehill.imposter.server.vertxweb.util.VertxResourceUtil.convertMethodFromVertx
 import io.gatehill.imposter.util.CollectionUtil
 import io.vertx.core.buffer.Buffer
@@ -55,7 +56,7 @@ import io.vertx.ext.web.RoutingContext
  * @author Pete Cornish
  */
 class VertxHttpRequest(
-    private val normalisedParams: Map<String, String>,
+    private val router: HttpRouter,
     private val routingContext: RoutingContext,
 ) : HttpRequest {
     private val vertxRequest = routingContext.request()
@@ -80,10 +81,10 @@ class VertxHttpRequest(
     }
 
     override val pathParams: Map<String, String>
-        get() = VertxResourceUtil.denormaliseParams(normalisedParams, routingContext.pathParams())
+        get() = PathNormaliser.denormaliseParams(router.normalisedParams, routingContext.pathParams())
 
     override fun getPathParam(paramName: String): String? {
-        return routingContext.pathParam(VertxResourceUtil.getNormalisedParamName(normalisedParams, paramName))
+        return routingContext.pathParam(PathNormaliser.getNormalisedParamName(router.normalisedParams, paramName))
     }
 
     override val queryParams: Map<String, String>

adapter/vertxweb/src/main/java/io/gatehill/imposter/server/vertxweb/util/VertxResourceUtil.kt

@@ -42,32 +42,16 @@
  */
 package io.gatehill.imposter.server.vertxweb.util
 
-import com.google.common.base.Strings
 import com.google.common.collect.BiMap
 import com.google.common.collect.HashBiMap
 import io.gatehill.imposter.config.util.EnvVars
 import io.gatehill.imposter.http.HttpMethod
 import io.gatehill.imposter.http.HttpRoute
-import org.apache.logging.log4j.LogManager
-import java.util.UUID
 
 /**
  * @author Pete Cornish
  */
 object VertxResourceUtil {
-    private val LOGGER = LogManager.getLogger(VertxResourceUtil::class.java)
-
-    /**
-     * Vert.x documentation says:
-     * > The placeholders consist of : followed by the parameter name.
-     * > Parameter names consist of any alphabetic character, numeric character or underscore.
-     *
-     * See: https://vertx.io/docs/vertx-web/java/#_capturing_path_parameters
-     *
-     * This regex pattern does not include the colon prefix.
-     */
-    private val VERTX_PATH_PARAM_NAME = Regex("[a-zA-Z0-9_]+")
-
     private val METHODS: BiMap<HttpMethod, io.vertx.core.http.HttpMethod?> = HashBiMap.create()
 
     /**
@@ -100,10 +84,7 @@ object VertxResourceUtil {
         METHODS.inverse()[this] ?: throw UnsupportedOperationException("Unknown method: $this")
 
     /**
-     * Normalises path parameters to Vert.x format.
-     *
-     * If a path parameter name does not match the Vert.x format, it is replaced with a UUID,
-     * and a mapping is added to the `normalisedParams` map.
+     * Converts path parameters to Vert.x format.
      *
      * For example:
      * ```
@@ -113,62 +94,27 @@ object VertxResourceUtil {
      * ```
      * /:pathParam/notParam
      * ```
-     *
-     * A path parameter name that does not match the Vert.x format, such as:
-     * ```
-     * /{param-with-dashes}
-     * ```
-     * will be converted to:
-     * ```
-     * /:123e4567e89b12d3a4564266141740000
-     * ```
-     * and the mapping `param-with-dashes -> 123e4567e89b12d3a4564266141740000`
-     * will be added to the `normalisedParams` map.
-     *
-     * @param normalisedParams a map to store the normalised parameter names
      * @param rawPath the path to normalise
      */
-    fun normalisePath(normalisedParams: MutableMap<String, String>, rawPath: String): String {
+    fun convertPath(rawPath: String): String {
         var path = rawPath
-        if (!Strings.isNullOrEmpty(path)) {
+        if (path.isNotEmpty()) {
             if (escapeColonsInPath) {
                 path = path.replace(":", "%3A")
             }
 
+            // convert to colon format
             var matchFound: Boolean
             do {
                 val matcher = HttpRoute.PATH_PARAM_PLACEHOLDER.matcher(path)
                 matchFound = matcher.find()
                 if (matchFound) {
-                    val finalParamName = matcher.group(1).let { paramName ->
-                        if (paramName.matches(VERTX_PATH_PARAM_NAME)) {
-                            paramName
-                        } else {
-                            val existingMapping = normalisedParams.entries.find { it.value == paramName }
-                            if (null != existingMapping) {
-                                return@let existingMapping.key
-                            }
-                            val normalisedName = UUID.randomUUID().toString().replace("-", "")
-                            normalisedParams[normalisedName] = paramName
-                            normalisedName
-                        }
-                    }
-                    path = matcher.replaceFirst(":$finalParamName")
+                    val paramName = matcher.group(1)
+                    path = matcher.replaceFirst(":$paramName")
                 }
             } while (matchFound)
         }
-        return path
-    }
-
-    fun getNormalisedParamName(normalisedParams: Map<String, String>, originalParamName: String): String {
-        if (originalParamName.matches(VERTX_PATH_PARAM_NAME)) {
-            return originalParamName
-        }
-        return normalisedParams.entries.find { it.value == originalParamName }?.key ?: originalParamName
-    }
 
-    fun denormaliseParams(normalisedParams: Map<String, String>, vertxParams: Map<String, String>): Map<String, String> {
-        // if it's not in the map it doesn't need to be denormalised
-        return vertxParams.mapKeys { normalisedParams[it.key] ?: it.key }
+        return path
     }
 }