Upgrade to Quarkus 3.19.0.CR1 (#37492)

Closes #37436

Signed-off-by: Martin Bartoš <[email protected]>

Author: mabartos

docs/documentation/upgrading/topics/changes/changes-26_2_0.adoc

@@ -13,3 +13,8 @@ would now be `http://example.com`.
 
 To mitigate that, either make your reverse proxy include the port in the `X-Forwarded-Host` header or configure it to set
 the `X-Forwarded-Port` header with the desired port.
+
+=== Changes to installing Oracle JDBC driver
+
+The required JAR for the Oracle JDBC driver that needs to be explicitly added to the distribution has changed.
+Instead of providing `ojdbc11` JAR, use `ojdbc17` JAR as stated in the https://www.keycloak.org/server/db#_installing_the_oracle_database_driver[Installing the Oracle Database driver] guide.

docs/guides/server/db.adoc

@@ -53,15 +53,15 @@ or skip this section if you want to connect to a different database for which th
 
 To install the Oracle Database driver for {project_name}:
 
-. Download the `ojdbc11` and `orai18n` JAR files from one of the following sources:
+. Download the `ojdbc17` and `orai18n` JAR files from one of the following sources:
 
 .. *Zipped JDBC driver and Companion Jars* version ${properties["oracle-jdbc.version"]} from the https://www.oracle.com/database/technologies/appdev/jdbc-downloads.html[Oracle driver download page].
 
-.. Maven Central via `link:++https://repo1.maven.org/maven2/com/oracle/database/jdbc/ojdbc11/${properties["oracle-jdbc.version"]}/ojdbc11-${properties["oracle-jdbc.version"]}.jar++[ojdbc11]` and `link:++https://repo1.maven.org/maven2/com/oracle/database/nls/orai18n/${properties["oracle-jdbc.version"]}/orai18n-${properties["oracle-jdbc.version"]}.jar++[orai18n]`.
+.. Maven Central via `link:++https://repo1.maven.org/maven2/com/oracle/database/jdbc/ojdbc17/${properties["oracle-jdbc.version"]}/ojdbc17-${properties["oracle-jdbc.version"]}.jar++[ojdbc17]` and `link:++https://repo1.maven.org/maven2/com/oracle/database/nls/orai18n/${properties["oracle-jdbc.version"]}/orai18n-${properties["oracle-jdbc.version"]}.jar++[orai18n]`.
 
 .. Installation media recommended by the database vendor for the specific database in use.
 
-. When running the unzipped distribution: Place the `ojdbc11` and `orai18n` JAR files in {project_name}'s `providers` folder
+. When running the unzipped distribution: Place the `ojdbc17` and `orai18n` JAR files in {project_name}'s `providers` folder
 
 . When running containers: Build a custom {project_name} image and add the JARs in the `providers` folder. When building a custom image for the Operator, those images need to be optimized images with all build-time options of {project_name} set.
 +
@@ -70,7 +70,7 @@ A minimal Containerfile to build an image which can be used with the {project_na
 [source,dockerfile,subs="attributes+"]
 ----
 FROM quay.io/keycloak/keycloak:{containerlabel}
-ADD --chown=keycloak:keycloak --chmod=644 https://repo1.maven.org/maven2/com/oracle/database/jdbc/ojdbc11/${properties["oracle-jdbc.version"]}/ojdbc11-${properties["oracle-jdbc.version"]}.jar /opt/keycloak/providers/ojdbc11.jar
+ADD --chown=keycloak:keycloak --chmod=644 https://repo1.maven.org/maven2/com/oracle/database/jdbc/ojdbc17/${properties["oracle-jdbc.version"]}/ojdbc17-${properties["oracle-jdbc.version"]}.jar /opt/keycloak/providers/ojdbc17.jar
 ADD --chown=keycloak:keycloak --chmod=644 https://repo1.maven.org/maven2/com/oracle/database/nls/orai18n/${properties["oracle-jdbc.version"]}/orai18n-${properties["oracle-jdbc.version"]}.jar /opt/keycloak/providers/orai18n.jar
 # Setting the build parameter for the database:
 ENV KC_DB=oracle

pom.xml

@@ -52,8 +52,8 @@
         <jboss.snapshots.repo.id>jboss-snapshots-repository</jboss.snapshots.repo.id>
         <jboss.snapshots.repo.url>https://s01.oss.sonatype.org/content/repositories/snapshots/</jboss.snapshots.repo.url>
 
-        <quarkus.version>3.18.3</quarkus.version>
-        <quarkus.build.version>3.18.3</quarkus.build.version>
+        <quarkus.version>3.19.0.CR1</quarkus.version>
+        <quarkus.build.version>3.19.0.CR1</quarkus.build.version>
 
         <project.build-time>${timestamp}</project.build-time>
 
@@ -176,7 +176,7 @@
         <oracledb.version>23.5</oracledb.version>
         <oracledb.container>mirror.gcr.io/gvenzl/oracle-free:${oracledb.version}-slim-faststart</oracledb.container>
         <!-- this is the oracle driver version also used in the Quarkus BOM -->
-        <oracle-jdbc.version>23.5.0.24.07</oracle-jdbc.version>
+        <oracle-jdbc.version>23.6.0.24.10</oracle-jdbc.version>
 
         <!-- Test -->
         <greenmail.version>2.1.0-alpha-1</greenmail.version>

quarkus/config-api/src/main/java/org/keycloak/config/OptionBuilder.java

@@ -9,6 +9,7 @@
 import java.util.stream.Collectors;
 import java.util.stream.Stream;
 
+@SuppressWarnings({"unchecked", "OptionalUsedAsFieldOrParameterType", "rawtypes"})
 public class OptionBuilder<T> {
 
     private static final List<String> BOOLEAN_TYPE_VALUES = List.of(Boolean.TRUE.toString(), Boolean.FALSE.toString());

quarkus/config-api/src/main/java/org/keycloak/config/database/Database.java

@@ -210,8 +210,8 @@ private String amendH2(String jdbcUrl) {
                 "mssql"
         ),
         ORACLE("oracle",
-                "oracle.jdbc.xa.client.OracleXADataSource",
-                "oracle.jdbc.driver.OracleDriver",
+                "oracle.jdbc.datasource.OracleXADataSource",
+                "oracle.jdbc.OracleDriver",
                 "org.hibernate.dialect.OracleDialect",
                 "jdbc:oracle:thin:@//${kc.db-url-host:localhost}:${kc.db-url-port:1521}/${kc.db-url-database:keycloak}",
                 asList("liquibase.database.core.OracleDatabase")

quarkus/deployment/src/main/java/org/keycloak/quarkus/deployment/KeycloakProcessor.java

@@ -305,7 +305,7 @@ void checkJdbcDriver(BuildProducer<JdbcDriverBuildItem> ignore) {
     @BuildStep
     @Produce(CheckMultipleDatasourcesBuildStep.class)
     void checkMultipleDatasourcesUseXA(TransactionManagerBuildTimeConfig transactionManagerConfig, DataSourcesBuildTimeConfig dataSourcesConfig, DataSourcesJdbcBuildTimeConfig jdbcConfig) {
-        if (transactionManagerConfig.unsafeMultipleLastResources
+        if (transactionManagerConfig.unsafeMultipleLastResources()
                 .orElse(UnsafeMultipleLastResourcesMode.DEFAULT) != UnsafeMultipleLastResourcesMode.FAIL) {
             return;
         }
@@ -383,7 +383,7 @@ void configurePersistenceUnits(HibernateOrmConfig config,
                 Properties properties = descriptor.getProperties();
                 // register a listener for customizing the unit configuration at runtime
                 runtimeConfigured.produce(new HibernateOrmIntegrationRuntimeConfiguredBuildItem("keycloak", descriptor.getName())
-                        .setInitListener(recorder.createUserDefinedUnitListener(properties.getProperty(AvailableSettings.DATASOURCE))));
+                        .setInitListener(recorder.createUserDefinedUnitListener(properties.getProperty(AvailableSettings.JAKARTA_JTA_DATASOURCE))));
                 userManagedEntities.addAll(descriptor.getManagedClassNames());
             }
         }

quarkus/runtime/pom.xml

@@ -81,7 +81,7 @@
             <exclusions>
                 <exclusion>
                     <groupId>com.oracle.database.jdbc</groupId>
-                    <artifactId>ojdbc11</artifactId>
+                    <artifactId>ojdbc17</artifactId>
                 </exclusion>
                 <exclusion>
                     <groupId>com.oracle.database.nls</groupId>

quarkus/runtime/src/main/java/org/keycloak/quarkus/runtime/KeycloakRecorder.java

@@ -23,7 +23,6 @@
 import io.quarkus.arc.InstanceHandle;
 import io.quarkus.hibernate.orm.runtime.integration.HibernateOrmIntegrationRuntimeInitListener;
 import io.quarkus.runtime.RuntimeValue;
-import io.quarkus.runtime.ShutdownContext;
 import io.quarkus.runtime.annotations.Recorder;
 import io.vertx.core.Handler;
 import io.vertx.ext.web.RoutingContext;
@@ -70,9 +69,6 @@
 @Recorder
 public class KeycloakRecorder {
 
-    public static final String DEFAULT_HEALTH_ENDPOINT = "/health";
-    public static final String DEFAULT_METRICS_ENDPOINT = "/metrics";
-
     private static final Logger logger = Logger.getLogger(KeycloakRecorder.class);
 
     public void initConfig() {
@@ -169,20 +165,11 @@ public void setDefaultUserProfileConfiguration(UPConfig configuration) {
         DeclarativeUserProfileProviderFactory.setDefaultConfig(configuration);
     }
 
-    public void registerShutdownHook(ShutdownContext shutdownContext) {
-        shutdownContext.addShutdownTask(new Runnable() {
-            @Override
-            public void run() {
-                QuarkusKeycloakSessionFactory.getInstance().close();
-            }
-        });
-    }
-
     public HibernateOrmIntegrationRuntimeInitListener createUserDefinedUnitListener(String name) {
         return new HibernateOrmIntegrationRuntimeInitListener() {
             @Override
             public void contributeRuntimeProperties(BiConsumer<String, Object> propertyCollector) {
-                InstanceHandle<AgroalDataSource> instance = Arc.container().instance(
+                try (InstanceHandle<AgroalDataSource> instance = Arc.container().instance(
                         AgroalDataSource.class, new DataSource() {
                             @Override public Class<? extends Annotation> annotationType() {
                                 return DataSource.class;
@@ -191,8 +178,9 @@ AgroalDataSource.class, new DataSource() {
                             @Override public String value() {
                                 return name;
                             }
-                        });
-                propertyCollector.accept(AvailableSettings.DATASOURCE, instance.get());
+                        })) {
+                    propertyCollector.accept(AvailableSettings.JAKARTA_JTA_DATASOURCE, instance.get());
+                }
             }
         };
     }

quarkus/runtime/src/main/java/org/keycloak/quarkus/runtime/cli/ExecutionExceptionHandler.java

@@ -32,38 +32,45 @@
 import picocli.CommandLine;
 import picocli.CommandLine.ParseResult;
 
+import java.util.HashMap;
+import java.util.Map;
+import java.util.function.Function;
+
 public final class ExecutionExceptionHandler implements CommandLine.IExecutionExceptionHandler {
 
-    private Logger logger;
+    private static Logger logger;
     private boolean verbose;
+    private static Map<String, Function<Throwable, Throwable>> exceptionTransformers = new HashMap<>();
 
     public ExecutionExceptionHandler() {}
 
     @Override
     public int handleExecutionException(Exception cause, CommandLine cmd, ParseResult parseResult) {
-        if (cause instanceof PropertyException) {
+        var exception = handleExceptionTransformers(cause);
+        if (exception instanceof PropertyException) {
             PrintWriter writer = cmd.getErr();
-            writer.println(cmd.getColorScheme().errorText(cause.getMessage()));
-            if (verbose && cause.getCause() != null) {
-                dumpException(writer, cause.getCause());
+            writer.println(cmd.getColorScheme().errorText(exception.getMessage()));
+            if (verbose && exception.getCause() != null) {
+                dumpException(writer, exception.getCause());
             }
-            return ShortErrorMessageHandler.getInvalidInputExitCode(cause, cmd);
+            return ShortErrorMessageHandler.getInvalidInputExitCode(exception, cmd);
         }
         error(cmd.getErr(), "Failed to run '" + parseResult.subcommands().stream()
                 .map(ParseResult::commandSpec)
                 .map(CommandLine.Model.CommandSpec::name)
                 .findFirst()
-                .orElse(Environment.getCommand()) + "' command.", cause);
+                .orElse(Environment.getCommand()) + "' command.", exception);
         return cmd.getCommandSpec().exitCodeOnExecutionException();
     }
 
     public void error(PrintWriter errorWriter, String message, Throwable cause) {
+        var exception = handleExceptionTransformers(cause);
         if (message != null) {
             logError(errorWriter, "ERROR: " + message);
         }
 
-        if (cause != null) {
-            dumpException(errorWriter, cause);
+        if (exception != null) {
+            dumpException(errorWriter, exception);
 
             if (!verbose) {
                 logError(errorWriter, "For more details run the same command passing the '--verbose' option. Also you can use '--help' to see the details about the usage of the particular command.");
@@ -121,7 +128,7 @@ private void logError(PrintWriter errorWriter, String errorMessage, Throwable ca
         }
     }
 
-    private Logger getLogger() {
+    private static Logger getLogger() {
         if (logger == null) {
             logger = Logger.getLogger(ExecutionExceptionHandler.class);
         }
@@ -131,4 +138,34 @@ private Logger getLogger() {
     public void setVerbose(boolean verbose) {
         this.verbose = verbose;
     }
+
+    public static void addExceptionTransformer(Class<?> fromClass, Function<Throwable, Throwable> transformer) {
+        if (exceptionTransformers.get(fromClass.getName()) != null) {
+            getLogger().warnf("Transformer for the '%s' class is overridden", fromClass.getName());
+        }
+        exceptionTransformers.put(fromClass.getName(), transformer);
+    }
+
+    public static void resetExceptionTransformers() {
+        exceptionTransformers = new HashMap<>();
+    }
+
+    private static Throwable handleExceptionTransformers(Throwable exception) {
+        if (exception == null) {
+            return null;
+        }
+
+        if (exceptionTransformers.isEmpty()) {
+            return exception;
+        }
+
+        var stackTrace = exception.getStackTrace();
+        for (var trace : stackTrace) {
+            var transformer = exceptionTransformers.get(trace.getClassName());
+            if (transformer != null) {
+                return transformer.apply(exception);
+            }
+        }
+        return exception;
+    }
 }

quarkus/runtime/src/main/java/org/keycloak/quarkus/runtime/cli/ShortErrorMessageHandler.java

@@ -95,7 +95,7 @@ public int handleParseException(ParameterException ex, String[] args) {
         return getInvalidInputExitCode(ex, cmd);
     }
 
-    static int getInvalidInputExitCode(Exception ex, CommandLine cmd) {
+    static int getInvalidInputExitCode(Throwable ex, CommandLine cmd) {
         return cmd.getExitCodeExceptionMapper() != null
                 ? cmd.getExitCodeExceptionMapper().getExitCode(ex)
                 : cmd.getCommandSpec().exitCodeOnInvalidInput();