Core: fail if null is produced for a SimpleBuildItem

- to avoid unexpected NullPointerException - build steps should consume java.util.Optional instead - follow-up to quarkusio#39408
mkouba · Mar 14, 2024 · 4ed365a · 4ed365a
1 parent 8713495
commit 4ed365a
Show file tree

Hide file tree

Showing 4 changed files with 36 additions and 28 deletions.
diff --git a/core/deployment/src/main/java/io/quarkus/deployment/ExtensionLoader.java b/core/deployment/src/main/java/io/quarkus/deployment/ExtensionLoader.java
@@ -496,7 +496,14 @@ private static Consumer<BuildChainBuilder> loadStepsFromClass(Class<?> clazz,
                         final Class<? extends SimpleBuildItem> buildItemClass = parameterClass
                                 .asSubclass(SimpleBuildItem.class);
                         methodStepConfig = methodStepConfig.andThen(bsb -> bsb.consumes(buildItemClass));
-                        methodParamFns.add((bc, bri) -> bc.consume(buildItemClass));
+                        methodParamFns.add((bc, bri) -> {
+                            SimpleBuildItem bi = bc.consume(buildItemClass);
+                            if (bi == null) {
+                                throw reportError(parameter,
+                                        "Cannot consume 'null' build item, use java.util.Optional build step method parameter instead");
+                            }
+                            return bi;
+                        });
                     } else if (isAnEmptyBuildItemConsumer(parameterType)) {
                         throw reportError(parameter,
                                 "Cannot consume an empty build item, use @Consume(class) on the build step method instead");

diff --git a/core/deployment/src/main/java/io/quarkus/deployment/console/ConsoleProcessor.java b/core/deployment/src/main/java/io/quarkus/deployment/console/ConsoleProcessor.java
@@ -7,6 +7,7 @@
 import java.nio.file.Path;
 import java.util.ArrayList;
 import java.util.List;
+import java.util.Optional;
 import java.util.concurrent.TimeUnit;
 import java.util.concurrent.atomic.AtomicReference;
 import java.util.function.BiConsumer;
@@ -125,8 +126,8 @@ public void run() {
     @Consume(ConsoleInstalledBuildItem.class)
     @BuildStep
     void setupExceptionHandler(BuildProducer<ExceptionNotificationBuildItem> exceptionNotificationBuildItem,
-            EffectiveIdeBuildItem ideSupport, LaunchModeBuildItem launchModeBuildItem) {
-        if (launchModeBuildItem.isAuxiliaryApplication()) {
+            Optional<EffectiveIdeBuildItem> ideSupport, LaunchModeBuildItem launchModeBuildItem) {
+        if (launchModeBuildItem.isAuxiliaryApplication() || ideSupport.isEmpty()) {
             return;
         }
         final AtomicReference<StackTraceElement> lastUserCode = new AtomicReference<>();
@@ -162,7 +163,7 @@ public String get() {
                             public void run() {
                                 StackTraceElement throwable = lastUserCode.get();
                                 if (throwable == null) {
-                                    launchInIDE(ideSupport.getIde(), List.of("."));
+                                    launchInIDE(ideSupport.get().getIde(), List.of("."));
                                     return;
                                 }
                                 String className = throwable.getClassName();
@@ -177,10 +178,10 @@ public void run() {
                                     log.error("Unable to find file: " + file);
                                     return;
                                 }
-                                List<String> args = ideSupport.getIde().createFileOpeningArgs(
+                                List<String> args = ideSupport.get().getIde().createFileOpeningArgs(
                                         fileName.toAbsolutePath().toString(),
                                         "" + throwable.getLineNumber());
-                                launchInIDE(ideSupport.getIde(), args);
+                                launchInIDE(ideSupport.get().getIde(), args);
                             }
                         }));
     }

diff --git a/core/deployment/src/main/java/io/quarkus/deployment/ide/IdeProcessor.java b/core/deployment/src/main/java/io/quarkus/deployment/ide/IdeProcessor.java
@@ -76,8 +76,8 @@ public class IdeProcessor {
 
     @BuildStep
     public EffectiveIdeBuildItem effectiveIde(LaunchModeBuildItem launchModeBuildItem, IdeConfig ideConfig,
-            IdeFileBuildItem ideFile,
-            IdeRunningProcessBuildItem ideRunningProcess) {
+            Optional<IdeFileBuildItem> ideFile,
+            Optional<IdeRunningProcessBuildItem> ideRunningProcess) {
         if (launchModeBuildItem.getDevModeType().orElse(null) != DevModeType.LOCAL) {
             return null;
         }
@@ -86,26 +86,27 @@ public EffectiveIdeBuildItem effectiveIde(LaunchModeBuildItem launchModeBuildIte
 
             // the idea here is to auto-detect the special files that IDEs create
             // and also the running IDE process if need be
-
-            if (ideFile.getDetectedIDEs().size() == 1) {
-                result = ideFile.getDetectedIDEs().iterator().next();
-            } else {
-                Set<Ide> runningIdes = ideRunningProcess.getDetectedIDEs();
-                if (runningIdes.size() == 1) {
-                    result = runningIdes.iterator().next();
-                } else {
-                    List<Ide> matches = new ArrayList<>();
-                    for (Ide file : ideFile.getDetectedIDEs()) {
-                        for (Ide process : runningIdes) {
-                            if (file == process) {
-                                matches.add(file);
+            if (ideFile.isPresent()) {
+                if (ideFile.get().getDetectedIDEs().size() == 1) {
+                    result = ideFile.get().getDetectedIDEs().iterator().next();
+                } else if (ideRunningProcess.isPresent()) {
+                    Set<Ide> runningIdes = ideRunningProcess.get().getDetectedIDEs();
+                    if (runningIdes.size() == 1) {
+                        result = runningIdes.iterator().next();
+                    } else {
+                        List<Ide> matches = new ArrayList<>();
+                        for (Ide file : ideFile.get().getDetectedIDEs()) {
+                            for (Ide process : runningIdes) {
+                                if (file == process) {
+                                    matches.add(file);
+                                }
                             }
                         }
-                    }
-                    if ((matches.size() == 0 && runningIdes.size() > 0)) {
-                        result = runningIdes.iterator().next();
-                    } else if (matches.size() >= 1) {
-                        result = matches.get(0);
+                        if ((matches.size() == 0 && runningIdes.size() > 0)) {
+                            result = runningIdes.iterator().next();
+                        } else if (matches.size() >= 1) {
+                            result = matches.get(0);
+                        }
                     }
                 }
             }

diff --git a/core/deployment/src/main/java/io/quarkus/deployment/logging/LoggingResourceProcessor.java b/core/deployment/src/main/java/io/quarkus/deployment/logging/LoggingResourceProcessor.java
@@ -82,7 +82,6 @@
 import io.quarkus.deployment.dev.ExceptionNotificationBuildItem;
 import io.quarkus.deployment.dev.testing.MessageFormat;
 import io.quarkus.deployment.dev.testing.TestSetupBuildItem;
-import io.quarkus.deployment.ide.EffectiveIdeBuildItem;
 import io.quarkus.deployment.metrics.MetricsCapabilityBuildItem;
 import io.quarkus.deployment.metrics.MetricsFactoryConsumerBuildItem;
 import io.quarkus.deployment.pkg.builditem.BuildSystemTargetBuildItem;
@@ -367,7 +366,7 @@ private DiscoveredLogComponents discoverLogComponents(IndexView index) {
     @Produce(TestSetupBuildItem.class)
     @Produce(LogConsoleFormatBuildItem.class)
     @Consume(ConsoleInstalledBuildItem.class)
-    void setupStackTraceFormatter(ApplicationArchivesBuildItem item, EffectiveIdeBuildItem ideSupport,
+    void setupStackTraceFormatter(ApplicationArchivesBuildItem item,
             BuildSystemTargetBuildItem buildSystemTargetBuildItem,
             List<ExceptionNotificationBuildItem> exceptionNotificationBuildItems,
             CuratedApplicationShutdownBuildItem curatedApplicationShutdownBuildItem) {