Lazy providers and better error reporting

If scanning, injection or construction fails,
log a comprehensive error message on top of throwing a
NoSuchCompilerException.

Fixes #347.

Co-authored-by: Alexander Kriegisch <Alexander@Kriegisch.name>

Author: cstamas

plexus-compiler-manager/src/main/java/org/codehaus/plexus/compiler/manager/DefaultCompilerManager.java

@@ -25,30 +25,52 @@
  */
 import javax.inject.Inject;
 import javax.inject.Named;
+import javax.inject.Provider;
 
 import java.util.Map;
 
 import org.codehaus.plexus.compiler.Compiler;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 /**
  * @author <a href="mailto:trygvis@inamo.no">Trygve Laugst&oslash;l</a>
  */
 @Named
 public class DefaultCompilerManager implements CompilerManager {
     @Inject
-    private Map<String, Compiler> compilers;
+    private Map<String, Provider<Compiler>> compilers;
+
+    private final Logger log = LoggerFactory.getLogger(getClass());
 
     // ----------------------------------------------------------------------
     // CompilerManager Implementation
     // ----------------------------------------------------------------------
 
     public Compiler getCompiler(String compilerId) throws NoSuchCompilerException {
-        Compiler compiler = compilers.get(compilerId);
+        // Provider<Class> is lazy -> presence of provider means compiler is present, but not yet constructed
+        Provider<Compiler> compilerProvider = compilers.get(compilerId);
 
-        if (compiler == null) {
+        if (compilerProvider == null) {
+            // Compiler could not be injected for some reason
+            String errorMessage = "Compiler '{}' either was not found (e.g. wrong compiler ID, missing dependencies) "
+                    + "or its class could not be scanned. "
+                    + "Running the build with -Dsisu.debug, looking for exceptions might help. "
+                    + "A TypeNotPresentException might indicate, that the compiler needs more recent Java runtime. "
+                    + "An IllegalArgumentException in ClassReader.<init> might mean, that you need to upgrade Maven.";
+            log.error(errorMessage, compilerId);
             throw new NoSuchCompilerException(compilerId);
         }
 
-        return compiler;
+        // Provider exists, but compiler was not created yet
+        try {
+            return compilerProvider.get();
+        } catch (Exception e) {
+            // DI could not construct compiler
+            String errorMessage = "Compiler '{}' could not be instantiated or injected properly. "
+                    + "Running the build with -Dsisu.debug, looking for exceptions might help.";
+            log.error(errorMessage, compilerId);
+            throw new NoSuchCompilerException(compilerId);
+        }
     }
 }