com.nannoq.tools.web.RoutingHelper.kt Maven / Gradle / Ivy

Go to download
/*
 * MIT License
 *
 * Copyright (c) 2017 Anders Mikkelsen
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 *
 */

package com.nannoq.tools.web

import com.nannoq.tools.web.requestHandlers.RequestLogHandler
import com.nannoq.tools.web.responsehandlers.ResponseLogHandler
import com.nannoq.tools.web.responsehandlers.ResponseLogHandler.Companion.BODY_CONTENT_TAG
import io.vertx.core.Handler
import io.vertx.core.json.JsonObject
import io.vertx.core.logging.LoggerFactory
import io.vertx.ext.web.Route
import io.vertx.ext.web.RoutingContext
import io.vertx.ext.web.handler.BodyHandler
import io.vertx.ext.web.handler.ResponseContentTypeHandler
import io.vertx.ext.web.handler.ResponseTimeHandler
import java.io.UnsupportedEncodingException
import java.net.URLDecoder
import java.util.AbstractMap.SimpleImmutableEntry
import java.util.Arrays
import java.util.concurrent.TimeUnit.NANOSECONDS
import java.util.function.Consumer
import java.util.function.Supplier
import java.util.stream.Collectors.groupingBy
import java.util.stream.Collectors.mapping
import java.util.stream.Collectors.toList

/**
 * This class contains helper methods for routing requests.
 *
 * @author Anders Mikkelsen
 * @version 17.11.2017
 */
object RoutingHelper {
    private val logger = LoggerFactory.getLogger(RoutingHelper::class.java.simpleName)

    private const val DATABASE_PROCESS_TIME = "X-Database-Time-To-Process"

    private val requestLogger = RequestLogHandler()
    private val responseLogger = ResponseLogHandler()

    private val bodyHandler = BodyHandler.create().setMergeFormAttributes(true)
    private val timeOutHandler = Handler {
        it.vertx().setTimer(9000L) { _ -> if (!it.request().isEnded) it.fail(503) }
        it.next()
    }

    private val responseContentTypeHandler = ResponseContentTypeHandler.create()
    private val responseTimeHandler = ResponseTimeHandler.create()

    @Suppress("unused")
    fun setStatusCode(
        code: Int,
        routingContext: RoutingContext,
        initialProcessTime: Long
    ) {
        setDatabaseProcessTime(routingContext, initialProcessTime)
        routingContext.response().statusCode = code
    }

    fun setStatusCodeAndAbort(
        code: Int,
        routingContext: RoutingContext,
        initialProcessTime: Long
    ) {
        setDatabaseProcessTime(routingContext, initialProcessTime)
        routingContext.fail(code)
    }

    @Suppress("unused")
    fun setStatusCodeAndContinue(code: Int, routingContext: RoutingContext) {
        routingContext.response().statusCode = code
        routingContext.next()
    }

    fun setStatusCodeAndContinue(
        code: Int,
        routingContext: RoutingContext,
        initialProcessTime: Long
    ) {
        setDatabaseProcessTime(routingContext, initialProcessTime)
        routingContext.response().statusCode = code
        routingContext.next()
    }

    private fun setDatabaseProcessTime(routingContext: RoutingContext, initialTime: Long) {
        val processTimeInNano = System.nanoTime() - initialTime

        routingContext.response().putHeader(DATABASE_PROCESS_TIME, NANOSECONDS.toMillis(processTimeInNano).toString())
    }

    @Suppress("unused")
    fun routeWithAuth(
        routeProducer: Supplier,
        authHandler: Handler,
        routeSetter: Consumer>
    ) {
        routeWithAuth(routeProducer, authHandler, null, routeSetter)
    }

    @Suppress("SameParameterValue")
    private fun routeWithAuth(
        routeProducer: Supplier,
        authHandler: Handler,
        finallyHandler: Handler? = null,
        routeSetter: Consumer>
    ) {
        prependStandards(routeProducer)
        routeProducer.get().handler(authHandler)
        routeSetter.accept(routeProducer)
        appendStandards(routeProducer, finallyHandler)
    }

    @Suppress("unused")
    fun routeWithBodyHandlerAndAuth(
        routeProducer: Supplier,
        authHandler: Handler,
        routeSetter: Consumer>
    ) {
        routeWithBodyHandlerAndAuth(routeProducer, authHandler, null, routeSetter)
    }

    @Suppress("SameParameterValue")
    private fun routeWithBodyHandlerAndAuth(
        routeProducer: Supplier,
        authHandler: Handler,
        finallyHandler: Handler? = null,
        routeSetter: Consumer>
    ) {
        prependStandards(routeProducer)
        routeProducer.get().handler(bodyHandler)
        routeProducer.get().handler(authHandler)
        routeSetter.accept(routeProducer)
        appendStandards(routeProducer, finallyHandler)
    }

    private fun prependStandards(routeProducer: Supplier) {
        routeProducer.get().handler(responseTimeHandler)
        routeProducer.get().handler(timeOutHandler)
        routeProducer.get().handler(responseContentTypeHandler)
        routeProducer.get().handler(requestLogger)
    }

    private fun appendStandards(routeProducer: Supplier, finallyHandler: Handler?) {
        routeProducer.get().failureHandler { handleErrors(it) }
        if (finallyHandler != null) routeProducer.get().handler(finallyHandler)
        routeProducer.get().handler(responseLogger)
    }

    fun routeWithLogger(
        routeProducer: Supplier,
        routeSetter: Consumer>
    ) {
        routeWithLogger(routeProducer, null, routeSetter)
    }

    fun routeWithBodyAndLogger(
        routeProducer: Supplier,
        routeSetter: Consumer>
    ) {
        routeProducer.get().handler(responseTimeHandler)
        routeProducer.get().handler(timeOutHandler)
        routeProducer.get().handler(responseContentTypeHandler)
        routeProducer.get().handler(requestLogger)
        routeProducer.get().handler(bodyHandler)
        routeSetter.accept(routeProducer)
        routeProducer.get().failureHandler { handleErrors(it) }
        routeProducer.get().handler(responseLogger)
    }

    fun routeWithLogger(
        routeProducer: Supplier,
        finallyHandler: Handler?,
        routeSetter: Consumer>
    ) {
        routeProducer.get().handler(responseTimeHandler)
        routeProducer.get().handler(timeOutHandler)
        routeProducer.get().handler(responseContentTypeHandler)
        routeProducer.get().handler(requestLogger)
        routeSetter.accept(routeProducer)
        routeProducer.get().failureHandler { handleErrors(it) }
        if (finallyHandler != null) routeProducer.get().handler(finallyHandler)
        routeProducer.get().handler(responseLogger)
    }

    private fun handleErrors(routingContext: RoutingContext) {
        val statusCode = routingContext.statusCode()

        routingContext.response().statusCode = if (statusCode != -1) statusCode else 500
        routingContext.next()
    }

    fun denyQuery(routingContext: RoutingContext): Boolean {
        val query = routingContext.request().query()

        return when {
            query != null && !routingContext.request().rawMethod().equals("GET", ignoreCase = true) -> true
            query != null -> invalidQuery(query, routingContext)
            else -> false
        }
    }

    private fun invalidQuery(query: String, routingContext: RoutingContext): Boolean {
        val queryMap = splitQuery(query)

        return when {
            queryMap.size > 1 || queryMap.size == 1 && queryMap["projection"] == null -> {
                routingContext.put(BODY_CONTENT_TAG, JsonObject()
                        .put("query_error", "No query accepted for this route"))
                routingContext.fail(400)

                true
            }
            else -> {
                routingContext.put(BODY_CONTENT_TAG, JsonObject()
                        .put("query_error", "Cannot parse this query string, are you sure it is in UTF-8?"))
                routingContext.fail(400)

                false
            }
        }
    }

    fun splitQuery(query: String): MutableMap> {
        val decoded: String

        try {
            decoded = URLDecoder.decode(query, "UTF-8")
        } catch (e: UnsupportedEncodingException) {
            logger.error(e)

            return mutableMapOf()
        }

        return Arrays.stream(decoded.split("&".toRegex()).dropLastWhile { it.isEmpty() }.toTypedArray())
                .map { splitQueryParameter(it) }
                .collect(groupingBy(
                        { it.key },
                        { mutableMapOf>() },
                        mapping({ it.value }, toList())))
    }

    private fun splitQueryParameter(it: String): SimpleImmutableEntry {
        val idx = it.indexOf("=")
        val key = if (idx > 0) it.substring(0, idx) else it
        val value = if (idx > 0 && it.length > idx + 1) it.substring(idx + 1) else null

        return SimpleImmutableEntry(key, value)
    }
}