com.palantir.util.SafeShutdownRunner Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of atlasdb-commons Show documentation
Palantir open source project
There is a newer version: 0.1152.0
/*
 * (c) Copyright 2020 Palantir Technologies Inc. All rights reserved.
 *
 * 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 com.palantir.util;

import com.palantir.common.concurrent.PTExecutors;
import com.palantir.logsafe.exceptions.SafeRuntimeException;
import java.time.Duration;
import java.util.ArrayList;
import java.util.List;
import java.util.Optional;
import java.util.concurrent.ExecutionException;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Future;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.TimeoutException;

public final class SafeShutdownRunner implements AutoCloseable {
    private final List failures = new ArrayList<>();
    private final ExecutorService executor;
    private final Optional timeoutDuration;

    private SafeShutdownRunner(Optional timeoutDuration, ExecutorService executorService) {
        this.timeoutDuration = timeoutDuration;
        this.executor = executorService;
    }

    public static SafeShutdownRunner createWithCachedThreadpool(Duration timeoutDuration) {
        return new SafeShutdownRunner(
                Optional.of(timeoutDuration), PTExecutors.newCachedThreadPool("safe-shutdown-runner"));
    }

    public void shutdownSafely(Runnable shutdownCallback) {
        shutdownInternal(shutdownCallback);
    }

    @Override
    public void close() {
        executor.shutdown();
        throwIfFailures();
    }

    private void shutdownInternal(Runnable shutdownCallback) {
        if (timeoutDuration.isPresent()) {
            shutdownTimed(shutdownCallback, timeoutDuration.get());
        } else {
            shutdownUntimed(shutdownCallback);
        }
    }

    private void shutdownTimed(Runnable shutdownCallback, Duration duration) {
        Future future = executor.submit(shutdownCallback);
        try {
            future.get(duration.toMillis(), TimeUnit.MILLISECONDS);
        } catch (InterruptedException e) {
            Thread.currentThread().interrupt();
            failures.add(e);
        } catch (ExecutionException e) {
            failures.add(e.getCause());
        } catch (TimeoutException e) {
            future.cancel(true);
            failures.add(e);
        }
    }

    private void shutdownUntimed(Runnable shutdownCallback) {
        try {
            shutdownCallback.run();
        } catch (Throwable t) {
            failures.add(t);
        }
    }

    private void throwIfFailures() {
        if (!failures.isEmpty()) {
            RuntimeException closeFailed =
                    new SafeRuntimeException("Close failed. Please inspect the code and fix the failures");
            failures.forEach(closeFailed::addSuppressed);
            failures.clear();
            throw closeFailed;
        }
    }
}