Merge pull request #43764 from yrodiere/i43703

Delegate detection of the database version to the Hibernate ORM dialect and enable checks for Hibernate Reactive

Author: yrodiere

docs/src/main/asciidoc/hibernate-orm.adoc

@@ -214,12 +214,6 @@ Hibernate ORM may generate SQL that is invalid which would lead to runtime excep
 If the database cannot be reached, a warning will be logged but startup will proceed.
 You can optionally disable the version check if you know the database won't be reachable on startup
 using <<quarkus-hibernate-orm_quarkus-hibernate-orm-database-version-check-enabled,`quarkus.hibernate-orm.database.version-check.enabled=false`>>.
-
-// TODO change the default to "always enabled" when we solve version detection problems
-//   See https://github.com/quarkusio/quarkus/issues/43703
-//   See https://github.com/quarkusio/quarkus/issues/42255
-The version check is disabled by default when a dialect is set explicitly,
-as a workaround for https://github.com/quarkusio/quarkus/issues/42255[#42255]/link:https://github.com/quarkusio/quarkus/issues/43703[#43703].
 ====
 
 [[hibernate-dialect-other-databases]]

docs/src/main/asciidoc/hibernate-reactive.adoc

@@ -122,6 +122,9 @@ A `Mutiny.SessionFactory` will be created based on the Quarkus `datasource` conf
 
 The dialect will be selected based on the Reactive SQL client - unless you set one explicitly.
 
+NOTE: For more information on dialect selection and database versions,
+see xref:hibernate-orm.adoc#hibernate-dialect[the corresponding section of the Hibernate ORM guide].
+
 You can then happily inject your `Mutiny.SessionFactory`:
 
 [source,java]

extensions/hibernate-orm/deployment/src/test/java/io/quarkus/hibernate/orm/config/dialect/DbVersionCheckDisabledAutomaticallyPersistenceXmlTest.java

@@ -17,13 +17,12 @@
 import io.quarkus.test.QuarkusUnitTest;
 
 /**
- * Tests that the workaround for https://github.com/quarkusio/quarkus/issues/43703 /
+ * Tests that DB version checks can be disabled explicitly.
+ * <p>
+ * This was originally introduced to work around problems with version checks,
+ * such as https://github.com/quarkusio/quarkus/issues/43703 /
  * https://github.com/quarkusio/quarkus/issues/42255
- * is effective.
  */
-// TODO remove this test when change the default to "always enabled" when we solve version detection problems
-//   See https://github.com/quarkusio/quarkus/issues/43703
-//   See https://github.com/quarkusio/quarkus/issues/42255
 public class DbVersionCheckDisabledExplicitlyTest {
 
     private static final String ACTUAL_H2_VERSION = DialectVersions.Defaults.H2;

extensions/hibernate-orm/deployment/src/test/java/io/quarkus/hibernate/orm/config/dialect/DbVersionCheckDisabledAutomaticallyTest.java

@@ -29,11 +29,8 @@ public class DbVersionInvalidPersistenceXmlTest {
                 .doesNotStartWith(CONFIGURED_DB_VERSION);
     }
 
-    private static final String ACTUAL_H2_VERSION_REPORTED;
     private static final String CONFIGURED_DB_VERSION_REPORTED;
     static {
-        // For some reason Hibernate ORM does not catch the actual micro version of H2 and default to 0; no big deal.
-        ACTUAL_H2_VERSION_REPORTED = ACTUAL_H2_VERSION.replaceAll("\\.[\\d]+$", ".0");
         // For some reason Hibernate ORM infers a micro version of 0; no big deal.
         CONFIGURED_DB_VERSION_REPORTED = CONFIGURED_DB_VERSION + ".0";
     }
@@ -52,10 +49,10 @@ public class DbVersionInvalidPersistenceXmlTest {
                     .hasMessageContainingAll(
                             "Persistence unit 'templatePU' was configured to run with a database version"
                                     + " of at least '" + CONFIGURED_DB_VERSION_REPORTED + "', but the actual version is '"
-                                    + ACTUAL_H2_VERSION_REPORTED + "'",
+                                    + ACTUAL_H2_VERSION + "'",
                             "Consider upgrading your database",
                             "Alternatively, rebuild your application with 'jakarta.persistence.database-product-version="
-                                    + ACTUAL_H2_VERSION_REPORTED + "'",
+                                    + ACTUAL_H2_VERSION + "'",
                             "this may disable some features and/or impact performance negatively"));
 
     @Inject

extensions/hibernate-orm/deployment/src/test/java/io/quarkus/hibernate/orm/config/dialect/DbVersionCheckDisabledExplicitlyTest.java

@@ -25,11 +25,8 @@ public class DbVersionInvalidTest {
                 .doesNotStartWith(CONFIGURED_DB_VERSION);
     }
 
-    private static final String ACTUAL_H2_VERSION_REPORTED;
     private static final String CONFIGURED_DB_VERSION_REPORTED;
     static {
-        // For some reason Hibernate ORM does not catch the actual micro version of H2 and default to 0; no big deal.
-        ACTUAL_H2_VERSION_REPORTED = ACTUAL_H2_VERSION.replaceAll("\\.[\\d]+$", ".0");
         // For some reason Hibernate ORM infers a micro version of 0; no big deal.
         CONFIGURED_DB_VERSION_REPORTED = CONFIGURED_DB_VERSION + ".0";
     }
@@ -45,10 +42,10 @@ public class DbVersionInvalidTest {
                     .hasMessageContainingAll(
                             "Persistence unit '<default>' was configured to run with a database version"
                                     + " of at least '" + CONFIGURED_DB_VERSION_REPORTED + "', but the actual version is '"
-                                    + ACTUAL_H2_VERSION_REPORTED + "'",
+                                    + ACTUAL_H2_VERSION + "'",
                             "Consider upgrading your database",
                             "Alternatively, rebuild your application with 'quarkus.datasource.db-version="
-                                    + ACTUAL_H2_VERSION_REPORTED + "'",
+                                    + ACTUAL_H2_VERSION + "'",
                             "this may disable some features and/or impact performance negatively",
                             "disable the check with 'quarkus.hibernate-orm.database.version-check.enabled=false'"));
 

extensions/hibernate-orm/deployment/src/test/java/io/quarkus/hibernate/orm/config/dialect/DbVersionInvalidPersistenceXmlTest.java

@@ -0,0 +1,49 @@
+package io.quarkus.hibernate.orm.offline;
+
+import jakarta.inject.Inject;
+import jakarta.transaction.Transactional;
+
+import org.assertj.core.api.Assertions;
+import org.hibernate.Session;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.RegisterExtension;
+
+import io.quarkus.hibernate.orm.MyEntity;
+import io.quarkus.hibernate.orm.SmokeTestUtils;
+import io.quarkus.test.QuarkusUnitTest;
+
+/**
+ * If nothing requires DB access on startup, we expect startup to proceed even if the database is not reachable.
+ * <p>
+ * There will likely be warnings being logged, but the application will start.
+ */
+public class DbOfflineOnStartupTest {
+
+    @RegisterExtension
+    static QuarkusUnitTest runner = new QuarkusUnitTest()
+            .withApplicationRoot((jar) -> jar
+                    .addClass(SmokeTestUtils.class)
+                    .addClass(MyEntity.class))
+            .withConfigurationResource("application.properties")
+            // Disable schema management
+            .overrideConfigKey("quarkus.hibernate-orm.schema-management.strategy",
+                    "none")
+            // Pick a DB URL that is offline
+            .overrideConfigKey("quarkus.datasource.jdbc.url",
+                    "jdbc:h2:tcp://localhost:9999/~/sample");
+
+    @Inject
+    Session session;
+
+    @Test
+    @Transactional
+    public void smokeTest() {
+        // We expect startup to succeed, but any DB access would obviously fail
+        var entity = new MyEntity("someName");
+        Assertions.assertThatThrownBy(() -> {
+            session.persist(entity);
+            session.flush();
+        })
+                .hasMessageContaining("Connection refused");
+    }
+}

extensions/hibernate-orm/deployment/src/test/java/io/quarkus/hibernate/orm/config/dialect/DbVersionInvalidTest.java

@@ -238,7 +238,12 @@ private RuntimeSettings buildRuntimeSettings(String persistenceUnitName, Recorde
         }
 
         // Allow detection of driver/database capabilities on runtime init (was disabled during static init)
-        runtimeSettingsBuilder.put("hibernate.boot.allow_jdbc_metadata_access", "true");
+        runtimeSettingsBuilder.put(AvailableSettings.ALLOW_METADATA_ON_BOOT, "true");
+        // Remove database version information, if any;
+        // it was necessary during static init to force creation of a dialect,
+        // but now the dialect is there, and we'll reuse it.
+        // Keeping this information would prevent us from getting the actual information from the database on start.
+        runtimeSettingsBuilder.put(AvailableSettings.JAKARTA_HBM2DDL_DB_VERSION, null);
 
         if (!persistenceUnitConfig.unsupportedProperties().isEmpty()) {
             log.warnf("Persistence-unit [%s] sets unsupported properties."