com.varmateo.yawg.logging.Logs Maven / Gradle / Ivy

Go to download
/**************************************************************************
 *
 * Copyright (c) 2018-2020 Yawg project contributors.
 *
 **************************************************************************/

package com.varmateo.yawg.logging;

import java.util.function.BiConsumer;
import java.util.function.BiFunction;
import java.util.function.Supplier;

import io.vavr.Function0;
import io.vavr.control.Try;


/**
 * Utility functions related with logging.
 */
public final class Logs {


    /**
     * No instance of this class are to be created.
     */
    private Logs() {
        // Nothing to do.
    }


    /**
     *
     */
    public static  T logDuration(
            final Log log,
            final String subject,
            final Supplier action) {

        final Supplier> liftedAction = Function0.liftTry(action);
        final boolean isVerbose = false;
        final Try result = logTryDuration(log, subject, liftedAction, isVerbose);

        return result.get();
    }


    /**
     *
     */
    public static void logDuration(
            final Log log,
            final String subject,
            final Runnable action) {

        final Supplier wrappedAction = () -> {
            action.run();
            return null;
        };

        logDuration(log, subject, wrappedAction);
    }


    /**
     *
     */
    public static Runnable decorateWithLogDuration(
            final Log log,
            final String description,
            final Runnable function) {

        return () -> logDuration(
                log,
                description,
                () -> {
                    function.run();
                    return null;
                });
    }


    /**
     *
     */
    public static  BiConsumer decorateWithLogDuration(
            final Log log,
            final BiFunction description,
            final BiConsumer function) {

        return (t, u) -> logDuration(
                log,
                description.apply(t, u),
                () -> {
                    function.accept(t, u);
                    return null;
                });
    }


    /**
     *
     */
    private static  Try logTryDuration(
            final Log log,
            final String subject,
            final Supplier> action,
            final boolean isVerbose) {

        log.info("Starting {0}...", subject);

        final long startTime = System.currentTimeMillis();
        final Try result = Try.of(action::get).flatMap(x -> x);
        final long delay = System.currentTimeMillis() - startTime;

        if (result.isSuccess()) {
            log.info("Done {0} ({1} ms)", subject, delay);
        } else {
            final Throwable cause = result.getCause();

            if (isVerbose) {
                // Log with stack trace.
                log.warning(cause, "Failed {0} ({1} ms)", subject, delay);
            } else {
                // Log without stack trace.
                log.warning(
                        "Failed {0} ({1} ms) - {2} - {3}",
                        subject, delay,
                        cause.getClass().getName(), cause.getMessage());
            }
        }

        return result;
    }

}