org.swisspush.gateleen.hook.Route Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gateleen-hook Show documentation
The newest version!
package org.swisspush.gateleen.hook;

import javax.annotation.Nullable;

import io.micrometer.core.instrument.MeterRegistry;
import io.vertx.core.Handler;
import io.vertx.core.Vertx;
import io.vertx.core.buffer.Buffer;
import io.vertx.core.http.HttpClient;
import io.vertx.core.http.HttpClientOptions;
import io.vertx.ext.web.RoutingContext;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.swisspush.gateleen.core.storage.ResourceStorage;
import org.swisspush.gateleen.logging.LogAppenderRepository;
import org.swisspush.gateleen.logging.LoggingResourceManager;
import org.swisspush.gateleen.monitoring.MonitoringHandler;
import org.swisspush.gateleen.routing.Forwarder;
import org.swisspush.gateleen.routing.Rule;

import java.util.regex.Matcher;
import java.util.regex.Pattern;

/**
 * Represents a Route for a specific
 * hook. Each source (eg. listener) has its own Route!
 * The Route forwards a request for a source (eg. listener) to
 * the destination specified by the HttpHook.
 *
 * @author https://github.com/ljucam [Mario Ljuca]
 */
public class Route {
    /** How long to let the http clients live before closing them after a update on the forwarder */
    private static final int GRACE_PERIOD = 30000;
    private static final int CLIENT_DEFAULT_TIMEOUT_SEC = 30;
    private static final boolean CLIENT_DEFAULT_KEEP_ALIVE = true;
    private static final boolean CLIENT_DEFAULT_EXPAND_ON_BACKEND = false;
    private static final boolean CLIENT_DEFAULT_EXPAND_IN_STORAGE = false;
    private static final int CLIENT_DEFAULT_LOG_EXPIRY = 4 * 3600;

    private static final String HTTP_CONNECTION_KEEP_ALIVE_TIMEOUT = "org.swisspush.gateleen.routing.rule.http.connection.keep.alive.timeout";
    private static int keepAliveTimeout;

    private static final Pattern URL_PARSE_PATTERN = Pattern.compile("^(?https?)://(?[^/:]+)(:(?[0-9]+))?(?/.*)$");
    private static final Logger LOG = LoggerFactory.getLogger(Route.class);
    private static final Logger CLEANUP_LOGGER = LoggerFactory.getLogger(Route.class.getName() + "Cleanup");

    private Vertx vertx;
    private LoggingResourceManager loggingResourceManager;
    private LogAppenderRepository logAppenderRepository;
    private MonitoringHandler monitoringHandler;
    private String userProfilePath;
    private ResourceStorage storage;
    private String hookDisplayText;

    private String urlPattern;
    private HttpHook httpHook;

    private Rule rule;
    private HttpClient client;
    private Forwarder forwarder;
    private HttpClient selfClient;

    static {
        String keepAliveTimeoutProperty =  System.getProperty(HTTP_CONNECTION_KEEP_ALIVE_TIMEOUT);
        if (keepAliveTimeoutProperty != null) {
            keepAliveTimeout = Integer.parseInt(keepAliveTimeoutProperty);
        } else {
            keepAliveTimeout = HttpClientOptions.DEFAULT_KEEP_ALIVE_TIMEOUT;
        }
    }

    /**
     * Creates a new instance of a Route.
     *
     * @param vertx vertx
     * @param storage storage
     * @param loggingResourceManager loggingResourceManager
     * @param monitoringHandler monitoringHandler
     * @param userProfilePath userProfilePath
     * @param httpHook httpHook
     * @param urlPattern - this can be a listener or a normal urlPattern (eg. for a route)
     */
    public Route(Vertx vertx, ResourceStorage storage, LoggingResourceManager loggingResourceManager,
                 LogAppenderRepository logAppenderRepository, @Nullable MonitoringHandler monitoringHandler, String userProfilePath,
                 HttpHook httpHook, String urlPattern, HttpClient selfClient, String hookDisplayText) {
        this.vertx = vertx;
        this.storage = storage;
        this.loggingResourceManager = loggingResourceManager;
        this.logAppenderRepository = logAppenderRepository;
        this.monitoringHandler = monitoringHandler;
        this.userProfilePath = userProfilePath;
        this.httpHook = httpHook;
        this.urlPattern = urlPattern;
        this.selfClient = selfClient;
        this.hookDisplayText = hookDisplayText;

        createRule();

        createHttpClient();

        createForwarder();
    }

    public void setMeterRegistry(MeterRegistry meterRegistry) {
        forwarder.setMeterRegistry(meterRegistry);
    }

    /**
     * Creates the forwarder for this hook.
     */
    private void createForwarder() {
        forwarder = new Forwarder(vertx, client, rule, storage, loggingResourceManager, logAppenderRepository,
                monitoringHandler, userProfilePath, null);
    }

    /**
     * Creates a new rule for the forwarder,
     * depending on the given httpHook.
     */
    private void createRule() {
        rule = new Rule();
        rule.setUrlPattern(urlPattern);

        prepareUrl(rule, httpHook);

        rule.setTimeout(1000 * CLIENT_DEFAULT_TIMEOUT_SEC);
        rule.setKeepAlive(CLIENT_DEFAULT_KEEP_ALIVE);
        rule.setKeepAliveTimeout(keepAliveTimeout);
        rule.setExpandOnBackend(CLIENT_DEFAULT_EXPAND_ON_BACKEND);
        rule.setStorageExpand(CLIENT_DEFAULT_EXPAND_IN_STORAGE);
        rule.setLogExpiry(CLIENT_DEFAULT_LOG_EXPIRY);
        rule.setHeaderFunction(httpHook.getHeaderFunction());
        rule.setProxyOptions(httpHook.getProxyOptions());

        { // Evaluate connection pool size
            Integer connectionPoolSize = httpHook.getConnectionPoolSize();
            if (connectionPoolSize == null) {
                LOG.trace("No connectionPoolSize specified for route '{}' using default of {}.", rule.getRuleIdentifier(), HttpHook.CONNECTION_POOL_SIZE_DEFAULT_VALUE);
                rule.setPoolSize(HttpHook.CONNECTION_POOL_SIZE_DEFAULT_VALUE);
            } else {
                LOG.trace("Using connectionPoolSize {} for route '{}'.", connectionPoolSize, rule.getRuleIdentifier());
                rule.setPoolSize(connectionPoolSize);
            }
        }

        { // Evaluate connection wait queue size
            Integer maxWaitQueueSize = httpHook.getMaxWaitQueueSize();
            if (maxWaitQueueSize == null) {
                LOG.trace("No maxWaitQueueSize specified for route '{}' using default of {}.", rule.getRuleIdentifier(), HttpHook.CONNECTION_MAX_WAIT_QUEUE_SIZE_DEFAULT_VALUE);
                rule.setMaxWaitQueueSize(HttpHook.CONNECTION_MAX_WAIT_QUEUE_SIZE_DEFAULT_VALUE);
            } else {
                LOG.trace("Using maxWaitQueueSize {} for route '{}'.", maxWaitQueueSize, rule.getRuleIdentifier());
                rule.setMaxWaitQueueSize(maxWaitQueueSize);
            }
        }
        { // Evaluate timeout
            Integer timeout = httpHook.getTimeout();
            if (timeout == null) {
                LOG.trace("No timeout specified for route '{}' using default of {}.", rule.getRuleIdentifier(), HttpHook.CONNECTION_TIMEOUT_SEC_DEFAULT_VALUE);
                rule.setTimeout(1000 * HttpHook.CONNECTION_TIMEOUT_SEC_DEFAULT_VALUE);
            } else {
                LOG.trace("Using timeout {} for route '{}'.", timeout, rule.getRuleIdentifier());
                rule.setTimeout(timeout);
            }
        }

        if (!httpHook.getMethods().isEmpty()) {
            rule.setMethods(httpHook.getMethods().toArray(new String[0]));
        }

        if(!httpHook.getTranslateStatus().isEmpty()){
            rule.addTranslateStatus(httpHook.getTranslateStatus());
        }
    }

    public Rule getRule() {
        return rule;
    }

    /**
     * Checks if the given destination either is a valid url or a valid path.
     * If neither is the case, an exception is thrown.
     *
     * @param rule the rule object
     * @param httpHook the http hook for this rule
     */
    private void prepareUrl(final Rule rule, final HttpHook httpHook) {
        Matcher urlMatcher = URL_PARSE_PATTERN.matcher(httpHook.getDestination());

        // valid url
        if (urlMatcher.matches()) {
            rule.setHost(urlMatcher.group("host"));
            rule.setScheme(urlMatcher.group("scheme"));
            rule.setPort(rule.getScheme().equals("https") ? 443 : 80);

            String portString = urlMatcher.group("port");
            if (portString != null) {
                rule.setPort(Integer.parseInt(portString));
            }

            rule.setPath(urlMatcher.group("path"));
        }
        // valid path
        else if ( httpHook.getDestination().startsWith("/") ) {
            rule.setPath(httpHook.getDestination());
            rule.setHost("localhost");
            rule.setScheme("local");
        }
        // neither a valid url, nor a valid path
        else {
            throw new IllegalArgumentException("Destination (" + httpHook.getDestination() + ") is neither a valid url, nor a valid path.");
        }
    }

    /**
     * Creates an instance of the http client for this
     * request forwarder. If it's a local request, the
     * selfClient will ne used instead!
     *
     */
    private void createHttpClient() {
        // local request (path)
        if (rule.getScheme().equals("local")) {
            client = selfClient;
        }
        // url request
        else {
            HttpClientOptions options = rule.buildHttpClientOptions();
            client = vertx.createHttpClient(options);
        }
    }

    /**
     * Handles the request (consumed) and forwards it
     * to the hook specific destination.
     *
     * @param ctx - the original but already consumed request
     * @param requestBody - saved buffer with the data of body from the original request
     */
    public void forward(RoutingContext ctx, final Buffer requestBody, @Nullable final Handler afterHandler) {

        // checking if the forwarder is for all methods
        if (httpHook.getMethods().isEmpty()) {
            forwarder.handle(ctx, requestBody, afterHandler);
        } else {
            // checking if the method from the request is handled by this forwarder
            if (httpHook.getMethods().contains(ctx.request().method().name())) {
                forwarder.handle(ctx, requestBody, afterHandler);
            }
        }
    }

    /**
     * Handles the request and forwards it
     * to the hook specific destination.
     *
     * @param ctx request context
     */
    public void forward(RoutingContext ctx) {
        forward(ctx, null, null);
    }

    /**
     * Closes the http client of the route.
     */
    public void cleanup() {
        if ( ! rule.getScheme().equals("local") ) {
            vertx.setTimer(GRACE_PERIOD, event -> {
                CLEANUP_LOGGER.debug("Cleaning up one client for route of {}", urlPattern);
                client.close();
            });
        }
    }

    /**
     * Returns the hook associated
     * with this route.
     *
     * @return the hook
     */
    public HttpHook getHook() {
        return httpHook;
    }

    public String getHookDisplayText() {
        return hookDisplayText;
    }
}