io.micronaut.crac.resources.datasources.HikariDataSourceResource Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of micronaut-crac Show documentation
Adds support for CRaC (Coordinated Restore at Checkpoint) to the Micronaut Framework.
The newest version!
/*
 * Copyright 2017-2022 original authors
 *
 * 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
 *
 * https://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.micronaut.crac.resources.datasources;

import com.zaxxer.hikari.HikariDataSource;
import com.zaxxer.hikari.HikariPoolMXBean;
import io.micronaut.context.exceptions.ConfigurationException;
import io.micronaut.core.annotation.Experimental;
import io.micronaut.crac.CracConfiguration;
import org.crac.Context;
import org.crac.Resource;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.time.Duration;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.TimeUnit;

/**
 * Handler for Hikari DataSources.
 *
 * @author Tim Yates
 * @since 1.1.0
 */
@Experimental
public class HikariDataSourceResource implements Resource {

    private static final Logger LOG = LoggerFactory.getLogger(HikariDataSourceResource.class);

    private final HikariPoolMXBean poolBean;
    private final HikariDataSource dataSource;
    private final Duration datasourcePauseTimeout;

    public HikariDataSourceResource(HikariDataSource dataSource, CracConfiguration configuration) {
        this.dataSource = dataSource;
        if (!dataSource.isAllowPoolSuspension()) {
            throw new ConfigurationException(dataSource + " is not configured to allow pool suspension. This will cause problems when the application is checkpointed. Please set configuration datasources.*.allow-pool-suspension to fix this");
        }
        this.datasourcePauseTimeout = configuration.getDatasourcePauseTimeout();
        this.poolBean = dataSource.getHikariPoolMXBean();
    }

    @Override
    public void beforeCheckpoint(Context context) throws Exception {
        if (LOG.isDebugEnabled()) {
            LOG.debug("Suspending Hikari pool for {}", dataSource);
        }
        poolBean.suspendPool();
        poolBean.softEvictConnections();

        if (LOG.isDebugEnabled()) {
            LOG.debug("Waiting {} for connections to be closed", datasourcePauseTimeout);
        }
        CompletableFuture awaitClosure = CompletableFuture.runAsync(this::waitForConnectionClosure);
        awaitClosure.get(datasourcePauseTimeout.getSeconds(), TimeUnit.SECONDS);
    }

    @Override
    public void afterRestore(Context context) throws Exception {
        if (LOG.isDebugEnabled()) {
            LOG.debug("Resuming hikari datasource {}", dataSource);
        }
        poolBean.resumePool();
    }

    private void waitForConnectionClosure() {
        while (poolBean.getActiveConnections() > 0) {
            try {
                TimeUnit.MILLISECONDS.sleep(100);
            } catch (InterruptedException e) {
                if (LOG.isErrorEnabled()) {
                    LOG.error("Interrupted while waiting for connections to be closed", e);
                }
                Thread.currentThread().interrupt();
            }
        }
    }
}