Fail on startup when inactive datasources are injected

By reimplementing Datasource eager startup through Arc's `startup` feature,
and active/inactive through Arc's `checkActive` feature.

extensions/agroal/deployment/src/main/java/io/quarkus/agroal/deployment/AgroalDataSourceBuildUtil.java

@@ -0,0 +1,21 @@
+package io.quarkus.agroal.deployment;
+
+import jakarta.enterprise.inject.Default;
+
+import org.jboss.jandex.AnnotationInstance;
+
+import io.quarkus.agroal.DataSource;
+import io.quarkus.datasource.common.runtime.DataSourceUtil;
+
+public final class AgroalDataSourceBuildUtil {
+    private AgroalDataSourceBuildUtil() {
+    }
+
+    public static AnnotationInstance qualifier(String dataSourceName) {
+        if (dataSourceName == null || DataSourceUtil.isDefault(dataSourceName)) {
+            return AnnotationInstance.builder(Default.class).build();
+        } else {
+            return AnnotationInstance.builder(DataSource.class).value(dataSourceName).build();
+        }
+    }
+}

extensions/agroal/deployment/src/main/java/io/quarkus/agroal/deployment/AgroalProcessor.java

@@ -25,7 +25,6 @@
 import io.agroal.api.AgroalPoolInterceptor;
 import io.quarkus.agroal.DataSource;
 import io.quarkus.agroal.runtime.AgroalDataSourceSupport;
-import io.quarkus.agroal.runtime.AgroalDataSourcesInitializer;
 import io.quarkus.agroal.runtime.AgroalRecorder;
 import io.quarkus.agroal.runtime.DataSourceJdbcBuildTimeConfig;
 import io.quarkus.agroal.runtime.DataSources;
@@ -35,6 +34,7 @@
 import io.quarkus.agroal.spi.JdbcDataSourceBuildItem;
 import io.quarkus.agroal.spi.JdbcDriverBuildItem;
 import io.quarkus.agroal.spi.OpenTelemetryInitBuildItem;
+import io.quarkus.arc.BeanDestroyer;
 import io.quarkus.arc.deployment.AdditionalBeanBuildItem;
 import io.quarkus.arc.deployment.SyntheticBeanBuildItem;
 import io.quarkus.arc.deployment.UnremovableBeanBuildItem;
@@ -241,8 +241,6 @@ void generateDataSourceSupportBean(AgroalRecorder recorder,
                 .setDefaultScope(DotNames.SINGLETON).build());
         // add the @DataSource class otherwise it won't be registered as a qualifier
         additionalBeans.produce(AdditionalBeanBuildItem.builder().addBeanClass(DataSource.class).build());
-        // make sure datasources are initialized at startup
-        additionalBeans.produce(new AdditionalBeanBuildItem(AgroalDataSourcesInitializer.class));
 
         // make AgroalPoolInterceptor beans unremovable, users still have to make them beans
         unremovableBeans.produce(UnremovableBeanBuildItem.beanTypes(AgroalPoolInterceptor.class));
@@ -285,9 +283,12 @@ void generateDataSourceBeans(AgroalRecorder recorder,
                     .setRuntimeInit()
                     .unremovable()
                     .addInjectionPoint(ClassType.create(DotName.createSimple(DataSources.class)))
+                    .startup()
+                    .checkActive(recorder.agroalDataSourceActiveChecker(dataSourceName))
                     // pass the runtime config into the recorder to ensure that the DataSource related beans
                     // are created after runtime configuration has been set up
-                    .createWith(recorder.agroalDataSourceSupplier(dataSourceName, dataSourcesRuntimeConfig));
+                    .createWith(recorder.agroalDataSourceSupplier(dataSourceName, dataSourcesRuntimeConfig))
+                    .destroyer(BeanDestroyer.AutoCloseableDestroyer.class);
 
             if (aggregatedBuildTimeConfigBuildItem.isDefault()) {
                 configurator.addQualifier(Default.class);

extensions/agroal/deployment/src/test/java/io/quarkus/agroal/test/ConfigActiveFalseDefaultDatasourceTest.java → extensions/agroal/deployment/src/test/java/io/quarkus/agroal/test/ConfigActiveFalseDefaultDatasourceProgrammaticallyRetrievedTest.java

@@ -3,44 +3,33 @@
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.assertj.core.api.Assertions.assertThatThrownBy;
 
-import java.sql.SQLException;
-
 import javax.sql.DataSource;
 
-import jakarta.enterprise.context.ApplicationScoped;
-import jakarta.enterprise.inject.CreationException;
-import jakarta.inject.Inject;
-
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.extension.RegisterExtension;
 
 import io.agroal.api.AgroalDataSource;
 import io.quarkus.arc.Arc;
-import io.quarkus.runtime.configuration.ConfigurationException;
+import io.quarkus.arc.InactiveBeanException;
 import io.quarkus.test.QuarkusUnitTest;
 
-public class ConfigActiveFalseDefaultDatasourceTest {
+public class ConfigActiveFalseDefaultDatasourceProgrammaticallyRetrievedTest {
 
     @RegisterExtension
     static final QuarkusUnitTest config = new QuarkusUnitTest()
             .overrideConfigKey("quarkus.datasource.active", "false");
 
-    @Inject
-    MyBean myBean;
-
     @Test
     public void dataSource() {
         DataSource ds = Arc.container().instance(DataSource.class).get();
 
         // The bean is always available to be injected during static init
         // since we don't know whether the datasource will be active at runtime.
-        // So the bean cannot be null.
+        // So the bean proxy cannot be null.
         assertThat(ds).isNotNull();
         // However, any attempt to use it at runtime will fail.
         assertThatThrownBy(() -> ds.getConnection())
-                .isInstanceOf(RuntimeException.class)
-                .cause()
-                .isInstanceOf(ConfigurationException.class)
+                .isInstanceOf(InactiveBeanException.class)
                 .hasMessageContainingAll("Datasource '<default>' was deactivated through configuration properties.",
                         "To solve this, avoid accessing this datasource at runtime, for instance by deactivating consumers (persistence units, ...).",
                         "Alternatively, activate the datasource by setting configuration property 'quarkus.datasource.active'"
@@ -54,38 +43,15 @@ public void agroalDataSource() {
 
         // The bean is always available to be injected during static init
         // since we don't know whether the datasource will be active at runtime.
-        // So the bean cannot be null.
+        // So the bean proxy cannot be null.
         assertThat(ds).isNotNull();
         // However, any attempt to use it at runtime will fail.
         assertThatThrownBy(() -> ds.getConnection())
-                .isInstanceOf(RuntimeException.class)
-                .cause()
-                .isInstanceOf(ConfigurationException.class)
-                .hasMessageContainingAll("Datasource '<default>' was deactivated through configuration properties.",
-                        "To solve this, avoid accessing this datasource at runtime, for instance by deactivating consumers (persistence units, ...).",
-                        "Alternatively, activate the datasource by setting configuration property 'quarkus.datasource.active'"
-                                + " to 'true' and configure datasource '<default>'",
-                        "Refer to https://quarkus.io/guides/datasource for guidance.");
-    }
-
-    @Test
-    public void injectedBean() {
-        assertThatThrownBy(() -> myBean.useDatasource())
-                .isInstanceOf(CreationException.class)
+                .isInstanceOf(InactiveBeanException.class)
                 .hasMessageContainingAll("Datasource '<default>' was deactivated through configuration properties.",
                         "To solve this, avoid accessing this datasource at runtime, for instance by deactivating consumers (persistence units, ...).",
                         "Alternatively, activate the datasource by setting configuration property 'quarkus.datasource.active'"
                                 + " to 'true' and configure datasource '<default>'",
                         "Refer to https://quarkus.io/guides/datasource for guidance.");
     }
-
-    @ApplicationScoped
-    public static class MyBean {
-        @Inject
-        DataSource ds;
-
-        public void useDatasource() throws SQLException {
-            ds.getConnection();
-        }
-    }
 }

extensions/agroal/deployment/src/test/java/io/quarkus/agroal/test/ConfigActiveFalseDefaultDatasourceStaticallyInjectedTest.java

@@ -0,0 +1,50 @@
+package io.quarkus.agroal.test;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+import java.sql.SQLException;
+
+import javax.sql.DataSource;
+
+import jakarta.enterprise.context.ApplicationScoped;
+import jakarta.inject.Inject;
+
+import org.assertj.core.api.Assertions;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.RegisterExtension;
+
+import io.quarkus.arc.InactiveBeanException;
+import io.quarkus.test.QuarkusUnitTest;
+
+public class ConfigActiveFalseDefaultDatasourceStaticallyInjectedTest {
+
+    @RegisterExtension
+    static final QuarkusUnitTest config = new QuarkusUnitTest()
+            .overrideConfigKey("quarkus.datasource.active", "false")
+            .assertException(e -> assertThat(e).isInstanceOf(InactiveBeanException.class)
+                    .hasMessageContainingAll("Datasource '<default>' was deactivated through configuration properties.",
+                            "To solve this, avoid accessing this datasource at runtime, for instance by deactivating consumers (persistence units, ...).",
+                            "Alternatively, activate the datasource by setting configuration property 'quarkus.datasource.active'"
+                                    + " to 'true' and configure datasource '<default>'",
+                            "Refer to https://quarkus.io/guides/datasource for guidance.",
+                            "This bean is injected into",
+                            MyBean.class.getName() + "#ds"));
+
+    @Inject
+    MyBean myBean;
+
+    @Test
+    public void test() {
+        Assertions.fail("Startup should have failed");
+    }
+
+    @ApplicationScoped
+    public static class MyBean {
+        @Inject
+        DataSource ds;
+
+        public void useDatasource() throws SQLException {
+            ds.getConnection();
+        }
+    }
+}

extensions/agroal/deployment/src/test/java/io/quarkus/agroal/test/ConfigActiveFalseNamedDatasourceTest.java → extensions/agroal/deployment/src/test/java/io/quarkus/agroal/test/ConfigActiveFalseNamedDatasourceProgrammaticallyRetrievedTest.java

@@ -3,22 +3,16 @@
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.assertj.core.api.Assertions.assertThatThrownBy;
 
-import java.sql.SQLException;
-
 import javax.sql.DataSource;
 
-import jakarta.enterprise.context.ApplicationScoped;
-import jakarta.enterprise.inject.CreationException;
-import jakarta.inject.Inject;
-
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.extension.RegisterExtension;
 
 import io.quarkus.arc.Arc;
-import io.quarkus.runtime.configuration.ConfigurationException;
+import io.quarkus.arc.InactiveBeanException;
 import io.quarkus.test.QuarkusUnitTest;
 
-public class ConfigActiveFalseNamedDatasourceTest {
+public class ConfigActiveFalseNamedDatasourceProgrammaticallyRetrievedTest {
 
     @RegisterExtension
     static final QuarkusUnitTest config = new QuarkusUnitTest()
@@ -27,9 +21,6 @@ public class ConfigActiveFalseNamedDatasourceTest {
             // otherwise it's considered unconfigured at build time...
             .overrideConfigKey("quarkus.datasource.users.db-kind", "h2");
 
-    @Inject
-    MyBean myBean;
-
     @Test
     public void dataSource() {
         DataSource ds = Arc.container().instance(DataSource.class,
@@ -41,9 +32,7 @@ public void dataSource() {
         assertThat(ds).isNotNull();
         // However, any attempt to use it at runtime will fail.
         assertThatThrownBy(() -> ds.getConnection())
-                .isInstanceOf(RuntimeException.class)
-                .cause()
-                .isInstanceOf(ConfigurationException.class)
+                .isInstanceOf(InactiveBeanException.class)
                 .hasMessageContainingAll("Datasource 'users' was deactivated through configuration properties.",
                         "To solve this, avoid accessing this datasource at runtime, for instance by deactivating consumers (persistence units, ...).",
                         "Alternatively, activate the datasource by setting configuration property 'quarkus.datasource.\"users\".active'"
@@ -62,35 +51,11 @@ public void agroalDataSource() {
         assertThat(ds).isNotNull();
         // However, any attempt to use it at runtime will fail.
         assertThatThrownBy(() -> ds.getConnection())
-                .isInstanceOf(RuntimeException.class)
-                .cause()
-                .isInstanceOf(ConfigurationException.class)
-                .hasMessageContainingAll("Datasource 'users' was deactivated through configuration properties.",
-                        "To solve this, avoid accessing this datasource at runtime, for instance by deactivating consumers (persistence units, ...).",
-                        "Alternatively, activate the datasource by setting configuration property 'quarkus.datasource.\"users\".active'"
-                                + " to 'true' and configure datasource 'users'",
-                        "Refer to https://quarkus.io/guides/datasource for guidance.");
-    }
-
-    @Test
-    public void injectedBean() {
-        assertThatThrownBy(() -> myBean.useDatasource())
-                .isInstanceOf(CreationException.class)
+                .isInstanceOf(InactiveBeanException.class)
                 .hasMessageContainingAll("Datasource 'users' was deactivated through configuration properties.",
                         "To solve this, avoid accessing this datasource at runtime, for instance by deactivating consumers (persistence units, ...).",
                         "Alternatively, activate the datasource by setting configuration property 'quarkus.datasource.\"users\".active'"
                                 + " to 'true' and configure datasource 'users'",
                         "Refer to https://quarkus.io/guides/datasource for guidance.");
     }
-
-    @ApplicationScoped
-    public static class MyBean {
-        @Inject
-        @io.quarkus.agroal.DataSource("users")
-        DataSource ds;
-
-        public void useDatasource() throws SQLException {
-            ds.getConnection();
-        }
-    }
 }

extensions/agroal/deployment/src/test/java/io/quarkus/agroal/test/ConfigActiveFalseNamedDatasourceStaticallyInjectedTest.java

@@ -0,0 +1,54 @@
+package io.quarkus.agroal.test;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+import java.sql.SQLException;
+
+import javax.sql.DataSource;
+
+import jakarta.enterprise.context.ApplicationScoped;
+import jakarta.inject.Inject;
+
+import org.assertj.core.api.Assertions;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.RegisterExtension;
+
+import io.quarkus.arc.InactiveBeanException;
+import io.quarkus.test.QuarkusUnitTest;
+
+public class ConfigActiveFalseNamedDatasourceStaticallyInjectedTest {
+
+    @RegisterExtension
+    static final QuarkusUnitTest config = new QuarkusUnitTest()
+            .overrideConfigKey("quarkus.datasource.users.active", "false")
+            // We need at least one build-time property for the datasource,
+            // otherwise it's considered unconfigured at build time...
+            .overrideConfigKey("quarkus.datasource.users.db-kind", "h2")
+            .assertException(e -> assertThat(e).isInstanceOf(InactiveBeanException.class)
+                    .hasMessageContainingAll("Datasource 'users' was deactivated through configuration properties.",
+                            "To solve this, avoid accessing this datasource at runtime, for instance by deactivating consumers (persistence units, ...).",
+                            "Alternatively, activate the datasource by setting configuration property 'quarkus.datasource.active'"
+                                    + " to 'true' and configure datasource 'users'",
+                            "Refer to https://quarkus.io/guides/datasource for guidance.",
+                            "This bean is injected into",
+                            MyBean.class.getName() + "#ds"));
+
+    @Inject
+    MyBean myBean;
+
+    @Test
+    public void test() {
+        Assertions.fail("Startup should have failed");
+    }
+
+    @ApplicationScoped
+    public static class MyBean {
+        @Inject
+        @io.quarkus.agroal.DataSource("users")
+        DataSource ds;
+
+        public void useDatasource() throws SQLException {
+            ds.getConnection();
+        }
+    }
+}

extensions/agroal/deployment/src/test/java/io/quarkus/agroal/test/EagerStartupTest.java

@@ -2,12 +2,13 @@
 
 import static org.assertj.core.api.Assertions.assertThat;
 
-import jakarta.inject.Singleton;
+import jakarta.enterprise.context.ApplicationScoped;
 
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.extension.RegisterExtension;
 
-import io.quarkus.agroal.runtime.DataSources;
+import io.agroal.api.AgroalDataSource;
+import io.quarkus.agroal.runtime.AgroalDataSourceUtil;
 import io.quarkus.arc.Arc;
 import io.quarkus.datasource.common.runtime.DataSourceUtil;
 import io.quarkus.test.QuarkusUnitTest;
@@ -26,16 +27,13 @@ public class EagerStartupTest {
     @Test
     public void shouldStartEagerly() {
         var container = Arc.container();
-        var instanceHandle = container.instance(DataSources.class);
-        // Check that the following call won't trigger a lazy initialization:
-        // the DataSources bean must be eagerly initialized.
-        assertThat(container.getActiveContext(Singleton.class).getState()
+        var instanceHandle = container.instance(AgroalDataSource.class,
+                AgroalDataSourceUtil.qualifier(DataSourceUtil.DEFAULT_DATASOURCE_NAME));
+        // Check that the datasource has already been eagerly created.
+        assertThat(container.getActiveContext(ApplicationScoped.class).getState()
                 .getContextualInstances().get(instanceHandle.getBean()))
-                .as("Eagerly instantiated DataSources bean")
+                .as("Eagerly instantiated DataSource bean")
                 .isNotNull();
-        // Check that the datasource has already been eagerly created.
-        assertThat(instanceHandle.get().isDataSourceCreated(DataSourceUtil.DEFAULT_DATASOURCE_NAME))
-                .isTrue();
     }
 
 }