generate flyway migrations from hibernate update scripts

quarkusio · Oct 10, 2024 · 2d565ee · 2d565ee
1 parent 691dd46
commit 2d565ee
Show file tree

Hide file tree

Showing 9 changed files with 193 additions and 5 deletions.
diff --git a/...sions/agroal/spi/src/main/java/io/quarkus/agroal/spi/JdbcUpdateSQLGeneratorBuildItem.java b/...sions/agroal/spi/src/main/java/io/quarkus/agroal/spi/JdbcUpdateSQLGeneratorBuildItem.java
@@ -0,0 +1,24 @@
+package io.quarkus.agroal.spi;
+
+import java.util.function.Supplier;
+
+import io.quarkus.builder.item.MultiBuildItem;
+
+public final class JdbcUpdateSQLGeneratorBuildItem extends MultiBuildItem {
+
+    final String databaseName;
+    final Supplier<String> sqlSupplier;
+
+    public JdbcUpdateSQLGeneratorBuildItem(String databaseName, Supplier<String> sqlSupplier) {
+        this.databaseName = databaseName;
+        this.sqlSupplier = sqlSupplier;
+    }
+
+    public String getDatabaseName() {
+        return databaseName;
+    }
+
+    public Supplier<String> getSqlSupplier() {
+        return sqlSupplier;
+    }
+}
diff --git a/...way/deployment/src/main/java/io/quarkus/flyway/deployment/devui/FlywayDevUIProcessor.java b/...way/deployment/src/main/java/io/quarkus/flyway/deployment/devui/FlywayDevUIProcessor.java
@@ -8,6 +8,7 @@
 import java.util.function.Supplier;
 
 import io.quarkus.agroal.spi.JdbcInitialSQLGeneratorBuildItem;
+import io.quarkus.agroal.spi.JdbcUpdateSQLGeneratorBuildItem;
 import io.quarkus.deployment.IsDevelopment;
 import io.quarkus.deployment.annotations.BuildStep;
 import io.quarkus.deployment.annotations.Record;
@@ -24,17 +25,23 @@ public class FlywayDevUIProcessor {
     @BuildStep(onlyIf = IsDevelopment.class)
     @Record(value = RUNTIME_INIT, optional = true)
     CardPageBuildItem create(FlywayDevUIRecorder recorder, FlywayBuildTimeConfig buildTimeConfig,
-            List<JdbcInitialSQLGeneratorBuildItem> generatorBuildItem,
+            List<JdbcInitialSQLGeneratorBuildItem> createGeneratorBuildItem,
+            List<JdbcUpdateSQLGeneratorBuildItem> updateGeneratorBuildItem,
             CurateOutcomeBuildItem curateOutcomeBuildItem) {
 
         Map<String, Supplier<String>> initialSqlSuppliers = new HashMap<>();
-        for (JdbcInitialSQLGeneratorBuildItem buildItem : generatorBuildItem) {
+        for (JdbcInitialSQLGeneratorBuildItem buildItem : createGeneratorBuildItem) {
             initialSqlSuppliers.put(buildItem.getDatabaseName(), buildItem.getSqlSupplier());
         }
 
+        Map<String, Supplier<String>> updateSqlSuppliers = new HashMap<>();
+        for (JdbcUpdateSQLGeneratorBuildItem buildItem : updateGeneratorBuildItem) {
+            updateSqlSuppliers.put(buildItem.getDatabaseName(), buildItem.getSqlSupplier());
+        }
+
         String artifactId = curateOutcomeBuildItem.getApplicationModel().getAppArtifact().getArtifactId();
 
-        recorder.setInitialSqlSuppliers(initialSqlSuppliers, artifactId);
+        recorder.setSqlSuppliers(initialSqlSuppliers, updateSqlSuppliers, artifactId);
 
         CardPageBuildItem card = new CardPageBuildItem();
 

diff --git a/extensions/flyway/deployment/src/main/resources/dev-ui/qwc-flyway-datasources.js b/extensions/flyway/deployment/src/main/resources/dev-ui/qwc-flyway-datasources.js
@@ -76,6 +76,7 @@ export class QwcFlywayDatasources extends QwcHotReloadElement {
 
     _actionRenderer(ds) {
         return html`${this._renderMigrationButtons(ds)}
+                    ${this._renderUpdateButton(ds)}
                     ${this._renderCreateButton(ds)}`;
     }
 
@@ -90,7 +91,16 @@ export class QwcFlywayDatasources extends QwcHotReloadElement {
                 </vaadin-button>`;
         }
     }
-
+
+    _renderUpdateButton(ds) {
+        if(ds.hasMigrations){
+            return html`
+                <vaadin-button theme="small" @click=${() => this._showCreateDialog(ds)} class="button" title="Create update migration file. Always manually review the created file as it can cause data loss">
+                    <vaadin-icon icon="font-awesome-solid:plus"></vaadin-icon> Generate Migration File
+                </vaadin-button>`;
+        }
+    }
+
     _renderCreateButton(ds) {
         if(ds.createPossible){
             return html`

diff --git a/...deployment/src/test/java/io/quarkus/flyway/test/FlywayDevModeUpdateFromHibernateTest.java b/...deployment/src/test/java/io/quarkus/flyway/test/FlywayDevModeUpdateFromHibernateTest.java
@@ -0,0 +1,43 @@
+package io.quarkus.flyway.test;
+
+import java.util.Map;
+
+import org.jboss.shrinkwrap.api.ShrinkWrap;
+import org.jboss.shrinkwrap.api.asset.StringAsset;
+import org.jboss.shrinkwrap.api.spec.JavaArchive;
+import org.junit.jupiter.api.Assertions;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.RegisterExtension;
+
+import com.fasterxml.jackson.databind.JsonNode;
+
+import io.quarkus.devui.tests.DevUIJsonRPCTest;
+import io.quarkus.test.QuarkusDevModeTest;
+
+public class FlywayDevModeUpdateFromHibernateTest extends DevUIJsonRPCTest {
+
+    public FlywayDevModeUpdateFromHibernateTest() {
+        super("io.quarkus.quarkus-flyway");
+    }
+
+    @RegisterExtension
+    static final QuarkusDevModeTest config = new QuarkusDevModeTest()
+            .setArchiveProducer(() -> ShrinkWrap.create(JavaArchive.class)
+                    .addClasses(FlywayDevModeUpdateFromHibernateTest.class, Fruit.class)
+                    .addAsResource(new StringAsset(
+                            "quarkus.flyway.migrate-at-start=true\nquarkus.flyway.locations=db/update"), "application.properties"));
+
+    @Test
+    public void testGenerateMigrationFromHibernate() throws Exception {
+
+        Map<String, Object> params = Map.of("ds", "<default>");
+        JsonNode devuiresponse = super.executeJsonRPCMethod("update", params);
+
+        Assertions.assertNotNull(devuiresponse);
+        String type = devuiresponse.get("type").asText();
+        Assertions.assertNotNull(type);
+        Assertions.assertEquals("success", type);
+
+    }
+
+}
diff --git a/extensions/flyway/deployment/src/test/resources/db/update/V2.0.0__Quarkus.sql b/extensions/flyway/deployment/src/test/resources/db/update/V2.0.0__Quarkus.sql
@@ -0,0 +1,4 @@
+CREATE TABLE fruit
+(
+    id   INT
+);
diff --git a/...ons/flyway/runtime/src/main/java/io/quarkus/flyway/runtime/devui/FlywayDevUIRecorder.java b/...ons/flyway/runtime/src/main/java/io/quarkus/flyway/runtime/devui/FlywayDevUIRecorder.java
@@ -10,9 +10,11 @@
 @Recorder
 public class FlywayDevUIRecorder {
 
-    public RuntimeValue<Boolean> setInitialSqlSuppliers(Map<String, Supplier<String>> initialSqlSuppliers, String artifactId) {
+    public RuntimeValue<Boolean> setSqlSuppliers(Map<String, Supplier<String>> initialSqlSuppliers,
+            Map<String, Supplier<String>> updateSuppliers, String artifactId) {
         FlywayJsonRpcService rpcService = Arc.container().instance(FlywayJsonRpcService.class).get();
         rpcService.setInitialSqlSuppliers(initialSqlSuppliers);
+        rpcService.setUpdateSqlSuppliers(updateSuppliers);
         rpcService.setArtifactId(artifactId);
         return new RuntimeValue<>(true);
     }

diff --git a/...ns/flyway/runtime/src/main/java/io/quarkus/flyway/runtime/devui/FlywayJsonRpcService.java b/...ns/flyway/runtime/src/main/java/io/quarkus/flyway/runtime/devui/FlywayJsonRpcService.java
@@ -2,8 +2,11 @@
 
 import static java.util.List.of;
 
+import java.math.BigInteger;
 import java.nio.file.Files;
 import java.nio.file.Path;
+import java.sql.Timestamp;
+import java.text.SimpleDateFormat;
 import java.util.Collection;
 import java.util.HashMap;
 import java.util.List;
@@ -24,6 +27,7 @@
 public class FlywayJsonRpcService {
 
     private Map<String, Supplier<String>> initialSqlSuppliers;
+    private Map<String, Supplier<String>> updateSqlSuppliers;
     private String artifactId;
     private Map<String, FlywayDatasource> datasources;
 
@@ -34,6 +38,10 @@ public void setInitialSqlSuppliers(Map<String, Supplier<String>> initialSqlSuppl
         this.initialSqlSuppliers = initialSqlSuppliers;
     }
 
+    public void setUpdateSqlSuppliers(Map<String, Supplier<String>> updateSqlSuppliers) {
+        this.updateSqlSuppliers = updateSqlSuppliers;
+    }
+
     public void setArtifactId(String artifactId) {
         this.artifactId = artifactId;
     }
@@ -161,6 +169,50 @@ public FlywayActionResponse create(String ds) {
         return errorNoDatasource(ds);
     }
 
+    public FlywayActionResponse update(String ds) {
+        try {
+            Supplier<String> found = updateSqlSuppliers.get(ds);
+            if (found == null) {
+                return new FlywayActionResponse("error", "Unable to find SQL Update generator");
+            }
+            String script = found.get();
+            if (script == null) {
+                return new FlywayActionResponse("error", "Missing Flyway update script for [" + ds + "]");
+            }
+            Flyway flyway = getFlyway(ds);
+            if (flyway == null) {
+                return errorNoDatasource(ds);
+            }
+            if (locations.isEmpty()) {
+                return new FlywayActionResponse("error", "Datasource has no locations configured");
+            }
+
+            List<Path> resourcesDir = DevConsoleManager.getHotReplacementContext().getResourcesDir();
+            if (resourcesDir.isEmpty()) {
+                return new FlywayActionResponse("error", "No resource directory found");
+            }
+            // In the current project only
+            Path path = resourcesDir.get(0);
+
+            Path migrationDir = path.resolve(locations.get(0));
+            Files.createDirectories(migrationDir);
+            SimpleDateFormat format = new SimpleDateFormat("yyyyMMddHHmmss");
+            String timestamp = format.format(new Timestamp(System.currentTimeMillis()));
+            BigInteger major = flyway.info().current().isVersioned() ? flyway.info().current().getVersion().getMajor()
+                    : BigInteger.ONE;
+            Path file = migrationDir.resolve(
+                    "V" + major + "." + timestamp + "__" + artifactId + ".sql");
+
+            Files.writeString(file, script);
+
+            return new FlywayActionResponse("success",
+                    "migration created");
+
+        } catch (Throwable t) {
+            return new FlywayActionResponse("error", t.getMessage());
+        }
+    }
+
     public int getNumberOfDatasources() {
         Collection<FlywayContainer> flywayContainers = new FlywayContainersSupplier().get();
         return flywayContainers.size();

diff --git a/...ent/src/main/java/io/quarkus/hibernate/orm/deployment/dev/HibernateOrmDevUIProcessor.java b/...ent/src/main/java/io/quarkus/hibernate/orm/deployment/dev/HibernateOrmDevUIProcessor.java
@@ -3,6 +3,7 @@
 import java.util.List;
 
 import io.quarkus.agroal.spi.JdbcInitialSQLGeneratorBuildItem;
+import io.quarkus.agroal.spi.JdbcUpdateSQLGeneratorBuildItem;
 import io.quarkus.arc.deployment.AdditionalBeanBuildItem;
 import io.quarkus.arc.processor.DotNames;
 import io.quarkus.deployment.IsDevelopment;
@@ -16,6 +17,7 @@
 import io.quarkus.hibernate.orm.deployment.PersistenceUnitDescriptorBuildItem;
 import io.quarkus.hibernate.orm.runtime.PersistenceUnitUtil;
 import io.quarkus.hibernate.orm.runtime.dev.HibernateOrmDevInfoCreateDDLSupplier;
+import io.quarkus.hibernate.orm.runtime.dev.HibernateOrmDevInfoUpdateDDLSupplier;
 import io.quarkus.hibernate.orm.runtime.dev.HibernateOrmDevJsonRpcService;
 
 @BuildSteps(onlyIf = { HibernateOrmEnabled.class, IsDevelopment.class })
@@ -69,4 +71,15 @@ void handleInitialSql(List<PersistenceUnitDescriptorBuildItem> persistenceUnitDe
         }
     }
 
+    @BuildStep
+    void handleUpdateSql(List<PersistenceUnitDescriptorBuildItem> persistenceUnitDescriptorBuildItems,
+            BuildProducer<JdbcUpdateSQLGeneratorBuildItem> initialSQLGeneratorBuildItemBuildProducer) {
+        for (PersistenceUnitDescriptorBuildItem puDescriptor : persistenceUnitDescriptorBuildItems) {
+            String puName = puDescriptor.getPersistenceUnitName();
+            String dsName = puDescriptor.getConfig().getDataSource().orElse(PersistenceUnitUtil.DEFAULT_PERSISTENCE_UNIT_NAME);
+            initialSQLGeneratorBuildItemBuildProducer
+                    .produce(new JdbcUpdateSQLGeneratorBuildItem(dsName, new HibernateOrmDevInfoUpdateDDLSupplier(puName)));
+        }
+    }
+
 }
diff --git a/.../main/java/io/quarkus/hibernate/orm/runtime/dev/HibernateOrmDevInfoUpdateDDLSupplier.java b/.../main/java/io/quarkus/hibernate/orm/runtime/dev/HibernateOrmDevInfoUpdateDDLSupplier.java
@@ -0,0 +1,33 @@
+package io.quarkus.hibernate.orm.runtime.dev;
+
+import java.util.Collection;
+import java.util.Objects;
+import java.util.function.Supplier;
+
+import io.quarkus.runtime.annotations.RecordableConstructor;
+
+public class HibernateOrmDevInfoUpdateDDLSupplier implements Supplier<String> {
+
+    private final String puName;
+
+    @RecordableConstructor
+    public HibernateOrmDevInfoUpdateDDLSupplier(String puName) {
+        this.puName = puName;
+    }
+
+    @Override
+    public String get() {
+        Collection<HibernateOrmDevInfo.PersistenceUnit> persistenceUnits = HibernateOrmDevController.get()
+                .getInfo().getPersistenceUnits();
+        for (var p : persistenceUnits) {
+            if (Objects.equals(puName, p.getName())) {
+                return p.getCreateDDL();
+            }
+        }
+        return null;
+    }
+
+    public String getPuName() {
+        return puName;
+    }
+}