log4j-layout-json-template/src/main/java/org/apache/logging/log4j/layout/json/template/resolver/TimestampResolver.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements. See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache license, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the license for the specific language governing permissions and
 * limitations under the license.
 */
package org.apache.logging.log4j.layout.json.template.resolver;

import org.apache.logging.log4j.core.LogEvent;
import org.apache.logging.log4j.core.time.Instant;
import org.apache.logging.log4j.core.time.internal.format.FastDateFormat;
import org.apache.logging.log4j.layout.json.template.JsonTemplateLayoutDefaults;
import org.apache.logging.log4j.layout.json.template.util.JsonWriter;
import org.apache.logging.log4j.layout.json.template.util.StringParameterParser;

import java.util.Arrays;
import java.util.Calendar;
import java.util.LinkedHashSet;
import java.util.Locale;
import java.util.Map;
import java.util.Set;
import java.util.TimeZone;

final class TimestampResolver implements EventResolver {

    private final EventResolver internalResolver;

    TimestampResolver(final String key) {
        this.internalResolver = (key != null && key.startsWith("epoch:"))
                ? createEpochResolver(key)
                : createFormatResolver(key);
    }

    /**
     * Context for GC-free formatted timestamp resolver.
     */
    private static final class FormatResolverContext {

        private enum Key {;

            private static final String PATTERN = "pattern";

            private static final String TIME_ZONE = "timeZone";

            private static final String LOCALE = "locale";

        }

        private static final Set<String> KEYS =
                new LinkedHashSet<>(Arrays.asList(
                        Key.PATTERN, Key.TIME_ZONE, Key.LOCALE));

        private final FastDateFormat timestampFormat;

        private final Calendar calendar;

        private final StringBuilder formattedTimestampBuilder;

        private FormatResolverContext(
                final TimeZone timeZone,
                final Locale locale,
                final FastDateFormat timestampFormat) {
            this.timestampFormat = timestampFormat;
            this.formattedTimestampBuilder = new StringBuilder();
            this.calendar = Calendar.getInstance(timeZone, locale);
            timestampFormat.format(calendar, formattedTimestampBuilder);
        }

        private static FormatResolverContext fromKey(final String key) {
            final Map<String, StringParameterParser.Value> keys =
                    StringParameterParser.parse(key, KEYS);
            final String pattern = readPattern(keys);
            final TimeZone timeZone = readTimeZone(keys);
            final Locale locale = readLocale(keys);
            final FastDateFormat fastDateFormat =
                    FastDateFormat.getInstance(pattern, timeZone, locale);
            return new FormatResolverContext(timeZone, locale, fastDateFormat);
        }

        private static String readPattern(
                final Map<String, StringParameterParser.Value> keys) {
            final StringParameterParser.Value patternValue = keys.get(Key.PATTERN);
            if (patternValue == null || patternValue instanceof StringParameterParser.NullValue) {
                return JsonTemplateLayoutDefaults.getTimestampFormatPattern();
            }
            final String pattern = patternValue.toString();
            try {
                FastDateFormat.getInstance(pattern);
            } catch (final IllegalArgumentException error) {
                throw new IllegalArgumentException(
                        "invalid pattern in timestamp key: " + pattern,
                        error);
            }
            return pattern;
        }

        private static TimeZone readTimeZone(
                final Map<String, StringParameterParser.Value> keys) {
            final StringParameterParser.Value timeZoneValue = keys.get(Key.TIME_ZONE);
            if (timeZoneValue == null || timeZoneValue instanceof StringParameterParser.NullValue) {
                return JsonTemplateLayoutDefaults.getTimeZone();
            }
            final String timeZoneId = timeZoneValue.toString();
            boolean found = false;
            for (final String availableTimeZone : TimeZone.getAvailableIDs()) {
                if (availableTimeZone.equalsIgnoreCase(timeZoneId)) {
                    found = true;
                    break;
                }
            }
            if (!found) {
                throw new IllegalArgumentException(
                        "invalid time zone in timestamp key: " + timeZoneId);
            }
            return TimeZone.getTimeZone(timeZoneId);
        }

        private static Locale readLocale(
                final Map<String, StringParameterParser.Value> keys) {
            final StringParameterParser.Value localeValue = keys.get(Key.LOCALE);
            if (localeValue == null || localeValue instanceof StringParameterParser.NullValue) {
                return JsonTemplateLayoutDefaults.getLocale();
            }
            final String locale = localeValue.toString();
            final String[] localeFields = locale.split("_", 3);
            switch (localeFields.length) {
                case 1: return new Locale(localeFields[0]);
                case 2: return new Locale(localeFields[0], localeFields[1]);
                case 3: return new Locale(localeFields[0], localeFields[1], localeFields[2]);
                default:
                    throw new IllegalArgumentException(
                            "invalid locale in timestamp key: " + locale);
            }
        }

    }

    /**
     * GC-free formatted timestamp resolver.
     */
    private static final class FormatResolver implements EventResolver {

        private final FormatResolverContext formatResolverContext;

        private FormatResolver(final FormatResolverContext formatResolverContext) {
            this.formatResolverContext = formatResolverContext;
        }

        @Override
        public synchronized void resolve(
                final LogEvent logEvent,
                final JsonWriter jsonWriter) {

            // Format timestamp if it doesn't match the last cached one.
            final long timestampMillis = logEvent.getTimeMillis();
            if (formatResolverContext.calendar.getTimeInMillis() != timestampMillis) {

                // Format the timestamp.
                formatResolverContext.formattedTimestampBuilder.setLength(0);
                formatResolverContext.calendar.setTimeInMillis(timestampMillis);
                formatResolverContext.timestampFormat.format(
                        formatResolverContext.calendar,
                        formatResolverContext.formattedTimestampBuilder);

                // Write the formatted timestamp.
                final StringBuilder jsonWriterStringBuilder = jsonWriter.getStringBuilder();
                final int startIndex = jsonWriterStringBuilder.length();
                jsonWriter.writeString(formatResolverContext.formattedTimestampBuilder);

                // Cache the written value.
                formatResolverContext.formattedTimestampBuilder.setLength(0);
                formatResolverContext.formattedTimestampBuilder.append(
                        jsonWriterStringBuilder,
                        startIndex,
                        jsonWriterStringBuilder.length());

            }

            // Write the cached formatted timestamp.
            else {
                jsonWriter.writeRawString(
                        formatResolverContext.formattedTimestampBuilder);
            }

        }

    }

    private static EventResolver createFormatResolver(final String key) {
        final FormatResolverContext formatResolverContext =
                FormatResolverContext.fromKey(key);
        return new FormatResolver(formatResolverContext);
    }

    private static EventResolver createEpochResolver(final String key) {
        switch (key) {
            case "epoch:nanos":
                return createEpochNanosResolver();
            case "epoch:micros":
                return createEpochMicrosDoubleResolver();
            case "epoch:micros,integral":
                return createEpochMicrosLongResolver();
            case "epoch:millis":
                return createEpochMillisDoubleResolver();
            case "epoch:millis,integral":
                return createEpochMillisLongResolver();
            case "epoch:secs":
                return createEpochSecsDoubleResolver();
            case "epoch:secs,integral":
                return createEpochSecsLongResolver();
            case "epoch:micros.nanos":
                return createEpochMicrosNanosResolver();
            case "epoch:millis.nanos":
                return createEpochMillisNanosResolver();
            case "epoch:millis.micros":
                return createEpochMillisMicrosResolver();
            case "epoch:secs.nanos":
                return createEpochSecsNanosResolver();
            case "epoch:secs.micros":
                return createEpochSecsMicrosResolver();
            case "epoch:secs.millis":
                return createEpochSecsMillisResolver();
            default:
                throw new IllegalArgumentException(
                        "was expecting an epoch key: " + key);
        }
    }

    private static final int MICROS_PER_SEC = 1_000_000;

    private static final int NANOS_PER_SEC = 1_000_000_000;

    private static final int NANOS_PER_MILLI = 1_000_000;

    private static final int NANOS_PER_MICRO = 1_000;

    private static final class EpochResolutionRecord {

        private static final int MAX_LONG_LENGTH =
                String.valueOf(Long.MAX_VALUE).length();

        private Instant instant;

        private char[] resolution = new char[/* integral: */MAX_LONG_LENGTH + /* dot: */1 + /* fractional: */MAX_LONG_LENGTH ];

        private int resolutionLength;

        private EpochResolutionRecord() {}

    }

    private static abstract class EpochResolver implements EventResolver {

        private final EpochResolutionRecord resolutionRecord =
                new EpochResolutionRecord();

        @Override
        public synchronized void resolve(
                final LogEvent logEvent,
                final JsonWriter jsonWriter) {
            final Instant logEventInstant = logEvent.getInstant();
            if (logEventInstant.equals(resolutionRecord.instant)) {
                jsonWriter.writeRawString(
                        resolutionRecord.resolution,
                        0,
                        resolutionRecord.resolutionLength);
            } else {
                resolutionRecord.instant = logEventInstant;
                final StringBuilder stringBuilder = jsonWriter.getStringBuilder();
                final int startIndex = stringBuilder.length();
                resolve(logEventInstant, jsonWriter);
                resolutionRecord.resolutionLength = stringBuilder.length() - startIndex;
                stringBuilder.getChars(
                        startIndex,
                        stringBuilder.length(),
                        resolutionRecord.resolution,
                        0);
            }
        }

        abstract void resolve(Instant logEventInstant, JsonWriter jsonWriter);

    }

    private static EventResolver createEpochNanosResolver() {
        return new EpochResolver() {
            @Override
            void resolve(final Instant logEventInstant, final JsonWriter jsonWriter) {
                final long nanos = epochNanos(logEventInstant);
                jsonWriter.writeNumber(nanos);
            }
        };
    }

    private static EventResolver createEpochMicrosDoubleResolver() {
        return new EpochResolver() {
            @Override
            void resolve(final Instant logEventInstant, final JsonWriter jsonWriter) {
                final long secs = logEventInstant.getEpochSecond();
                final int nanosOfSecs = logEventInstant.getNanoOfSecond();
                final long micros = MICROS_PER_SEC * secs + nanosOfSecs / NANOS_PER_MICRO;
                final int nanosOfMicros = nanosOfSecs - nanosOfSecs % NANOS_PER_MICRO;
                jsonWriter.writeNumber(micros, nanosOfMicros);
            }
        };
    }

    private static EventResolver createEpochMicrosLongResolver() {
        return new EpochResolver() {
            @Override
            void resolve(final Instant logEventInstant, final JsonWriter jsonWriter) {
                final long nanos = epochNanos(logEventInstant);
                final long micros = nanos / NANOS_PER_MICRO;
                jsonWriter.writeNumber(micros);
            }
        };
    }

    private static EventResolver createEpochMillisDoubleResolver() {
        return new EpochResolver() {
            @Override
            void resolve(final Instant logEventInstant, final JsonWriter jsonWriter) {
                jsonWriter.writeNumber(
                        logEventInstant.getEpochMillisecond(),
                        logEventInstant.getNanoOfMillisecond());
            }
        };
    }

    private static EventResolver createEpochMillisLongResolver() {
        return new EpochResolver() {
            @Override
            void resolve(final Instant logEventInstant, final JsonWriter jsonWriter) {
                jsonWriter.writeNumber(logEventInstant.getEpochMillisecond());
            }
        };
    }

    private static EventResolver createEpochSecsDoubleResolver() {
        return new EpochResolver() {
            @Override
            void resolve(final Instant logEventInstant, final JsonWriter jsonWriter) {
                jsonWriter.writeNumber(
                        logEventInstant.getEpochSecond(),
                        logEventInstant.getNanoOfSecond());
            }
        };
    }

    private static EventResolver createEpochSecsLongResolver() {
        return new EpochResolver() {
            @Override
            void resolve(final Instant logEventInstant, final JsonWriter jsonWriter) {
                jsonWriter.writeNumber(logEventInstant.getEpochSecond());
            }
        };
    }

    private static EventResolver createEpochMicrosNanosResolver() {
        return new EpochResolver() {
            @Override
            void resolve(final Instant logEventInstant, final JsonWriter jsonWriter) {
                final int nanosOfSecs = logEventInstant.getNanoOfSecond();
                final int nanosOfMicros = nanosOfSecs % NANOS_PER_MICRO;
                jsonWriter.writeNumber(nanosOfMicros);
            }
        };
    }

    private static EventResolver createEpochMillisNanosResolver() {
        return new EpochResolver() {
            @Override
            void resolve(final Instant logEventInstant, final JsonWriter jsonWriter) {
                jsonWriter.writeNumber(logEventInstant.getNanoOfMillisecond());
            }
        };
    }

    private static EventResolver createEpochMillisMicrosResolver() {
        return new EpochResolver() {
            @Override
            void resolve(final Instant logEventInstant, final JsonWriter jsonWriter) {
                final int nanosOfMillis = logEventInstant.getNanoOfMillisecond();
                final int microsOfMillis = nanosOfMillis / NANOS_PER_MICRO;
                jsonWriter.writeNumber(microsOfMillis);
            }
        };
    }

    private static EventResolver createEpochSecsNanosResolver() {
        return new EpochResolver() {
            @Override
            void resolve(final Instant logEventInstant, final JsonWriter jsonWriter) {
                jsonWriter.writeNumber(logEventInstant.getNanoOfSecond());
            }
        };
    }

    private static EventResolver createEpochSecsMicrosResolver() {
        return new EpochResolver() {
            @Override
            void resolve(final Instant logEventInstant, final JsonWriter jsonWriter) {
                final int nanosOfSecs = logEventInstant.getNanoOfSecond();
                final int microsOfSecs = nanosOfSecs / NANOS_PER_MICRO;
                jsonWriter.writeNumber(microsOfSecs);
            }
        };
    }

    private static EventResolver createEpochSecsMillisResolver() {
        return new EpochResolver() {
            @Override
            void resolve(final Instant logEventInstant, final JsonWriter jsonWriter) {
                final int nanosOfSecs = logEventInstant.getNanoOfSecond();
                final int millisOfSecs = nanosOfSecs / NANOS_PER_MILLI;
                jsonWriter.writeNumber(millisOfSecs);
            }
        };
    }

    private static long epochNanos(Instant instant) {
        return NANOS_PER_SEC * instant.getEpochSecond() + instant.getNanoOfSecond();
    }

    static String getName() {
        return "timestamp";
    }

    @Override
    public void resolve(
            final LogEvent logEvent,
            final JsonWriter jsonWriter) {
        internalResolver.resolve(logEvent, jsonWriter);
    }

}