io.yupiik.batch.runtime.tracing.BaseExecutionTracer Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of yupiik-batch-runtime Show documentation
There is a newer version: 1.0.6
/*
 * Copyright (c) 2021 - Yupiik SAS - https://www.yupiik.com
 * Licensed 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 io.yupiik.batch.runtime.tracing;

import io.yupiik.batch.runtime.batch.builder.BatchChain;
import io.yupiik.batch.runtime.batch.builder.Executable;
import io.yupiik.batch.runtime.batch.builder.RunConfiguration;

import java.time.Clock;
import java.time.LocalDateTime;
import java.util.List;
import java.util.UUID;
import java.util.concurrent.CopyOnWriteArrayList;

public abstract class BaseExecutionTracer {
    private final Clock clock;
    private final String batchName;

    private final List steps = new CopyOnWriteArrayList<>();

    public BaseExecutionTracer(final String batchName, final Clock clock) {
        this.clock = clock;
        this.batchName = batchName;
    }

    protected abstract void save(final JobExecution execution, final List steps);

    public Executable.Result traceStep(final RunConfiguration configuration,
                                          final BatchChain batchChain, final BatchChain.Result previous) {
        if (batchChain.skipTracing()) {
            return batchChain.execute(configuration, Executable.Result.class.cast(previous));
        }

        final var start = clock.instant();
        var status = Status.SUCCESS;
        String comment = null;
        try {
            final var executed = batchChain.execute(configuration, Executable.Result.class.cast(previous));
            if (BatchChain.Commentifiable.class.isInstance(batchChain)) {
                comment = BatchChain.Commentifiable.class.cast(batchChain).toComment();
            }
            if (executed != null && executed.value() != null && BatchChain.Commentifiable.class.isInstance(executed.value())) {
                comment = (comment == null || comment.isBlank() ? "" : (comment + '\n')) + BatchChain.Commentifiable.class.cast(executed.value()).toComment();
            }
            return executed;
        } catch (final Error | RuntimeException err) {
            status = Status.FAILURE;
            comment = err.getMessage();
            throw err;
        } finally {
            final var end = clock.instant();
            final var execution = new StepExecution(
                    UUID.randomUUID().toString(), batchChain.name(), status, comment,
                    LocalDateTime.ofInstant(start, clock.getZone()), LocalDateTime.ofInstant(end, clock.getZone()),
                    steps.isEmpty() ? null : steps.get(steps.size() - 1).id());
            steps.add(execution);
        }
    }

    public Runnable traceExecution(final Runnable runnable) {
        return () -> {
            final var start = clock.instant();
            var status = Status.SUCCESS;
            String error = null;
            try {
                runnable.run();
            } catch (final Error | RuntimeException err) {
                status = Status.FAILURE;
                error = err.getMessage();
                throw err;
            } finally {
                final var end = clock.instant();
                final var execution = new JobExecution(
                        UUID.randomUUID().toString(), batchName, status, error,
                        LocalDateTime.ofInstant(start, clock.getZone()), LocalDateTime.ofInstant(end, clock.getZone()));
                save(execution, steps);
            }
        };
    }

    public enum Status {
        SUCCESS, FAILURE
    }

    public static record StepExecution(
            String id, String name, Status status, String comment,
            LocalDateTime started, LocalDateTime finished, String previous) {
    }

    public static record JobExecution(
            String id, String name, Status status, String comment,
            LocalDateTime started, LocalDateTime finished) {
    }
}