com.applitools.eyes.Logger Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of eyes-common-java5 Show documentation
Common code for Applitools Eyes Java SDK projects
There is a newer version: 5.66.0
package com.applitools.eyes;

import com.applitools.eyes.logging.*;
import com.applitools.utils.GeneralUtils;
import org.apache.commons.lang3.tuple.Pair;

import java.util.*;

/**
 * Logs trace messages.
 */
public class Logger {
    private final MultiLogHandler logHandler;
    private String agentId;

    public Logger() {
        logHandler = new MultiLogHandler();
    }

    public Logger(LogHandler handler) {
        this();
        logHandler.addLogHandler(handler);
    }

    public void setAgentId(String agentId) {
        this.agentId = agentId;
    }

    /**
     * @return The currently set log handler.
     */
    public LogHandler getLogHandler() {
        return logHandler;
    }

    /**
     * Sets the log handler.
     *
     * @param handler The log handler to set. If you want a log handler which
     *                does nothing, use {@link
     *                com.applitools.eyes.NullLogHandler}.
     */
    public void setLogHandler(LogHandler handler) {
        if (handler == null) {
            logHandler.clear();
        } else {
            logHandler.addLogHandler(handler);
        }
    }

    @SafeVarargs
    public final void log(String testId, Stage stage, Pair... data) {
        logInner(TraceLevel.Notice, testId == null ? null : Collections.singleton(testId), stage, null, data);
    }

    @SafeVarargs
    public final void log(Set testIds, Stage stage, Pair... data) {
        logInner(TraceLevel.Notice, testIds, stage, null, data);
    }

    @SafeVarargs
    public final void log(String testId, Stage stage, Type type, Pair... data) {
        logInner(TraceLevel.Notice, testId == null ? null : Collections.singleton(testId), stage, type, data);
    }

    @SafeVarargs
    public final void log(Set testIds, Stage stage, Type type, Pair... data) {
        logInner(TraceLevel.Notice, testIds, stage, type, data);
    }

    @SafeVarargs
    public final void log(TraceLevel level, String testId, Stage stage, Pair... data) {
        logInner(level, testId == null ? null : Collections.singleton(testId), stage, null, data);
    }

    @SafeVarargs
    public final void log(TraceLevel level, Set testIds, Stage stage, Type type, Pair... data) {
        logInner(level, testIds, stage, type, data);
    }

    @SafeVarargs
    public final void log(TraceLevel level, Stage stage, Type type, Pair... data) {
        logInner(level, null, stage, type, data);
    }

    @SafeVarargs
    public final void log(TraceLevel level, Stage stage, Pair... data) {
        logInner(level, null, stage, null, data);
    }

    public final void log(TraceLevel level, Set testIds, Stage stage, Type type, String message) {
        logInner(level, testIds, stage, type, Pair.of("message", message));
    }

    public final void log(TraceLevel level, String testId, Stage stage, Type type, String message) {
        logInner(level, testId == null ? null : Collections.singleton(testId), stage, type, Pair.of("message", message));
    }

    public final void log(TraceLevel level, String testId, Stage stage, String message) {
        logInner(level, testId == null ? null : Collections.singleton(testId), stage, null, Pair.of("message", message));
    }

    public final void log(TraceLevel level, Stage stage, String message) {
        logInner(level, null, stage, null, Pair.of("message", message));
    }

    public final void log(String testId, Stage stage, String message) {
        logInner(TraceLevel.Notice, testId == null ? null : Collections.singleton(testId), stage, null, Pair.of("message", message));
    }

    @SafeVarargs
    private final void logInner(TraceLevel level, Set testIds, Stage stage, Type type, Pair... data) {
        String currentTime = GeneralUtils.toISO8601DateTime(Calendar.getInstance(TimeZone.getTimeZone("UTC")));
        ClientEvent event = new ClientEvent(currentTime, createMessageFromLog(testIds, stage, type, 4, data), level);
        logHandler.onMessage(event);
    }

    @SafeVarargs
    private final Message createMessageFromLog(Set testIds, Stage stage, Type type, int methodsBack, Pair... data) {
        Map map = new HashMap<>();
        if (data != null && data.length > 0) {
            for (Pair pair : data) {
                map.put(pair.getLeft(), pair.getRight());
            }
        }

        StackTraceElement[] stackTraceElements =
                Thread.currentThread().getStackTrace();
        String stackTrace = "";
        if (stackTraceElements.length > methodsBack) {
            stackTrace += stackTraceElements[methodsBack].getClassName() + "." + stackTraceElements[methodsBack].getMethodName() + "()";
        }

        return new Message(agentId, stage, type, testIds, Thread.currentThread().getId(), stackTrace, map);
    }

    @SafeVarargs
    public final Message createMessageFromLog(Set testIds, Stage stage, Type type, Pair... data) {
        return createMessageFromLog(testIds, stage, type, 3, data);
    }
}