io.micronaut.flyway.AbstractFlywayMigration Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of micronaut-flyway Show documentation
Integration between Micronaut and Flyway
The newest version!
/*
 * Copyright 2017-2020 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.flyway;

import io.micronaut.context.ApplicationContext;
import io.micronaut.context.event.ApplicationEventPublisher;
import io.micronaut.flyway.event.MigrationFinishedEvent;
import io.micronaut.flyway.event.SchemaCleanedEvent;
import io.micronaut.inject.qualifiers.Qualifiers;
import io.micronaut.scheduling.TaskExecutors;
import io.micronaut.scheduling.annotation.Async;
import jakarta.inject.Singleton;
import org.flywaydb.core.Flyway;
import org.flywaydb.core.api.configuration.FluentConfiguration;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import javax.sql.DataSource;

/**
 * Parent class that runs Flyway database migrations.
 *
 * @author James Kleeh
 * @author Iván López
 * @since 1.0.0
 */
@Singleton
class AbstractFlywayMigration {

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

    protected final ApplicationContext applicationContext;
    private final ApplicationEventPublisher eventPublisher;

    /**
     * @param applicationContext The application context
     * @param eventPublisher     The event publisher
     */
    AbstractFlywayMigration(ApplicationContext applicationContext,
                            ApplicationEventPublisher eventPublisher) {
        this.applicationContext = applicationContext;
        this.eventPublisher = eventPublisher;
    }

    /**
     * Run the Flyway migrations for a specific config and a dataSource only if the config is enabled.
     *
     * @param config     The {@link FlywayConfigurationProperties}
     * @param dataSource The {@link DataSource}
     */
    void run(FlywayConfigurationProperties config, DataSource dataSource) {
        if (config.isEnabled()) {
            forceRun(config, dataSource);
        }
    }

    /**
     * Run the Flyway migrations whether they are enabled or not, for the specific datasource.
     *
     * @param config     The {@link FlywayConfigurationProperties}
     * @param dataSource The {@link DataSource}
     */
    void forceRun(FlywayConfigurationProperties config, DataSource dataSource) {
        FluentConfiguration fluentConfiguration = config.getFluentConfiguration();
        StaticResourceProvider staticResourceProvider = StaticResourceProvider.get();
        if (staticResourceProvider != null) {
            fluentConfiguration.resourceProvider(staticResourceProvider);
        }
        fluentConfiguration.cleanDisabled(!config.isCleanSchema());
        fluentConfiguration.dataSource(dataSource);
        fluentConfiguration.configuration(config.getProperties());
        customizeConfiguration(config.getNameQualifier(), fluentConfiguration);

        Flyway flyway = fluentConfiguration.load();
        applicationContext.registerSingleton(Flyway.class, flyway, Qualifiers.byName(config.getNameQualifier()), false);

        if (config.isAsync()) {
            runAsync(config, flyway);
        } else {
            runFlyway(config, flyway);
        }
    }

    private void customizeConfiguration(String nameQualifier, FluentConfiguration fluentConfiguration) {
        applicationContext.findBean(FlywayConfigurationCustomizer.class, Qualifiers.byName(nameQualifier))
            .orElse(new DefaultFlywayConfigurationCustomizer(applicationContext, nameQualifier))
            .customizeFluentConfiguration(fluentConfiguration);
    }

    private void runFlyway(FlywayConfigurationProperties config, Flyway flyway) {
        if (config.isCleanSchema()) {
            LOG.info("Cleaning schema for database with qualifier [{}]", config.getNameQualifier());
            flyway.clean();
            eventPublisher.publishEvent(new SchemaCleanedEvent(config));
        }
        LOG.info("Running migrations for database with qualifier [{}]", config.getNameQualifier());
        flyway.migrate();
        eventPublisher.publishEvent(new MigrationFinishedEvent(config));
    }

    /**
     * Run a migration asynchronously.
     *
     * @param config The {@link FlywayConfigurationProperties}
     * @param flyway The {@link Flyway} already configured to run the migrations
     */
    @Async(TaskExecutors.IO)
    void runAsync(FlywayConfigurationProperties config, Flyway flyway) {
        runFlyway(config, flyway);
    }

}