com.zepben.vertxutils.routing.handlers.UtilHandlers Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of vertx-utils Show documentation

Helpers and utils for working with Vert.x in Zepben projects.

There is a newer version: 1.5.0-SNAPSHOT2

/*
 * Copyright 2020 Zeppelin Bend Pty Ltd
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at https://mozilla.org/MPL/2.0/.
 */

package com.zepben.vertxutils.routing.handlers;

import com.zepben.annotations.EverythingIsNonnullByDefault;
import com.zepben.vertxutils.routing.ErrorFormatter;
import com.zepben.vertxutils.routing.Respond;
import io.vertx.core.Handler;
import io.vertx.core.VertxException;
import io.vertx.ext.web.RoutingContext;
import org.slf4j.Logger;

import java.util.function.Function;

import static io.netty.handler.codec.http.HttpResponseStatus.INTERNAL_SERVER_ERROR;
import static io.netty.handler.codec.http.HttpResponseStatus.MOVED_PERMANENTLY;

@EverythingIsNonnullByDefault
public class UtilHandlers {

    /**
     * Returns the default failure handler that if the {@link RoutingContext#failure()} is not null responds with a
     * 500 message with our own "standardised" errors JSON response (See {@link ErrorFormatter#asJson(String)})
     * containing the message from the failure. If a logger is specified, it will also log the stacktrace on the server side
     */
    public static final Function> CATCH_ALL_API_FAILURE_HANDLER_WITH_EXCEPTION_LOGGING = logger -> (context) -> {
        Throwable failure = context.failure();
        if (failure != null && !context.response().ended()) {
            if (logger != null) {
                logger.error("Error stack trace:", failure);
            }
            Respond.withJson(context, INTERNAL_SERVER_ERROR, ErrorFormatter.asJson(failure.toString()));
            return;
        } else if (failure instanceof VertxException && failure.getMessage().equals("Connection was closed")) {
            // Don't call context.next() in this case because it logs it. We don't care.
            return;
        }

        context.next();
    };


    public static final Handler CATCH_ALL_API_FAILURE_HANDLER = context -> {
        CATCH_ALL_API_FAILURE_HANDLER_WITH_EXCEPTION_LOGGING.apply(null).handle(context);
    };

    @Deprecated
    public static final Handler DEFAULT_FAILURE_HANDLER = CATCH_ALL_API_FAILURE_HANDLER;

    /**
     * Route handler to redirect routes with no trailing slash to one with a trailing slash.
     */
    public static final Handler REDIRECT_NO_TRAILING_SLASH_TO_TRAILING_SLASH_HANDLER = context -> {
        String location = context.request().path() + "/";
        if (context.request().query() != null)
            location += "?" + context.request().query();

        context.response().putHeader("Location", location);
        Respond.with(context, MOVED_PERMANENTLY);
    };
}