toolchains:3.2.0:select-jdk-toolchain fails with Maven 4.0.0-rc4 due to Guice/NullInjectedIntoNonNullable

[nxglhez]

Affected version

3.2.0

Bug description

Hello,

I am trying to check how Maven 4 will eat my time, and I tried updating my project using mvnup.

While migration worked, it gave me this error when running mvn validate:

com.google.inject.ProvisionException: Unable to provision, see the following errors:

1) [Guice/NullInjectedIntoNonNullable]: null returned by binding at LocatorWiring
 but SelectJdkToolchainMojo.factory(SelectJdkToolchainMojo.java:57) is not @Nullable
  at LocatorWiring
  at SelectJdkToolchainMojo.factory(SelectJdkToolchainMojo.java:57)
      \_ for field factory
  while locating SelectJdkToolchainMojo

Learn more:
  https://github.com/google/guice/wiki/NULL_INJECTED_INTO_NON_NULLABLE

1 error

======================
Full classname legend:
======================
LocatorWiring:          "org.eclipse.sisu.wire.LocatorWiring"
SelectJdkToolchainMojo: "org.apache.maven.plugins.toolchain.jdk.SelectJdkToolchainMojo"
========================
End of classname legend:
========================

The pom I used is very simple (it is more complex in my use case, but this failed as well): the pom below is the Maven 3 compatible POM (modelVersion 4.0.0) and it fails the same with Maven 4 (it works with Maven 3).

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>
  <groupId>com.acme.example</groupId>
  <artifactId>sample</artifactId>
  <version>0.0.1-SNAPSHOT</version>
  <packaging>pom</packaging>

  <properties>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    <project.reporting.outputEncoding>${project.build.sourceEncoding}</project.reporting.outputEncoding>
    <resources.propertiesEncoding>${project.build.sourceEncoding}</resources.propertiesEncoding>
    <java.version>1.8</java.version>
    <maven.compiler.source>${java.version}</maven.compiler.source>
    <maven.compiler.target>${java.version}</maven.compiler.target>
    <toolchain.jdk.version>[8,)</toolchain.jdk.version>
  </properties>

  <build>
    <pluginManagement>
      <plugins>
        <plugin>
          <groupId>org.apache.maven.plugins</groupId>
          <artifactId>maven-toolchains-plugin</artifactId>
          <version>3.2.0</version>
        </plugin>
      </plugins>
    </pluginManagement>

    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-toolchains-plugin</artifactId>
        <executions>
          <execution>
            <goals>
              <goal>select-jdk-toolchain</goal>
            </goals>
          </execution>
        </executions>
      </plugin>
    </plugins>
  </build>
</project>

[norrisjeremy]

@gnodet Since you recently put out a call about releasing Maven 4.0.0, wanted to ping you directly and make you aware that the most recent release of the maven-toolchains-plugin is incompatible with the latest Maven 4.0.0 snapshot due to this error.
I'm not sure if this is something you can investigate and remedy (either in Maven or in this plugin)?

[nielsbasjes]

I did some initial digging and what I found the error occurs somewhere in Guice.

What I found remarkable is that the version of Guice that seems to be used is 4.2.3 which is from 2017 which makes it a library from the Java 1.8 period.

The current version of Guice is version 7.0.0 (which is over 2 years old now).

[nielsbasjes]

It's actually maven itself that is providing the guice version.

Both maven 3.9.x and 4.0.x set it to version 5.1.0
https://github.com/apache/maven/blob/maven-3.9.x/pom.xml#L140
https://github.com/apache/maven/blob/maven-4.0.x/pom.xml#L150

[nielsbasjes]

Seems Guice is only complaining, not the cause

https://github.com/apache/maven-toolchains-plugin/blob/master/src/main/java/org/apache/maven/plugins/toolchain/jdk/SelectJdkToolchainMojo.java#L140

    @Inject
    private ToolchainManagerPrivate toolchainManager;

In Maven 4:
https://github.com/apache/maven/blob/maven-4.0.x/compat/maven-compat/src/main/java/org/apache/maven/toolchain/ToolchainManagerPrivate.java#L35

@Deprecated(since = "4.0.0")
public interface ToolchainManagerPrivate {

So it seems in order to work on Maven 4 the maven-compat is needed.
https://github.com/apache/maven/blob/maven-4.0.x/compat/maven-compat/src/main/java/org/apache/maven/toolchain/ToolchainManagerFactory.java#L61-L66

[nielsbasjes]

This diff fixes it on my machine:

diff --git a/src/main/java/org/apache/maven/plugins/toolchain/jdk/SelectJdkToolchainMojo.java b/src/main/java/org/apache/maven/plugins/toolchain/jdk/SelectJdkToolchainMojo.java
index 7a1276a..5e2b88a 100644
--- a/src/main/java/org/apache/maven/plugins/toolchain/jdk/SelectJdkToolchainMojo.java
+++ b/src/main/java/org/apache/maven/plugins/toolchain/jdk/SelectJdkToolchainMojo.java
@@ -18,15 +18,14 @@
  */
 package org.apache.maven.plugins.toolchain.jdk;
 
-import javax.inject.Inject;
-import javax.inject.Named;
-
 import java.util.HashMap;
 import java.util.Map;
 import java.util.Objects;
 import java.util.Optional;
 import java.util.stream.Stream;
 
+import com.google.inject.Inject;
+import com.google.inject.name.Named;
 import org.apache.maven.execution.MavenSession;
 import org.apache.maven.plugin.AbstractMojo;
 import org.apache.maven.plugin.MojoFailureException;

If this is a correct fix then I suspect that this change must be implemented in more places than just here.

[cstamas]

@gnodet This is not right, the compat should not be needed, this looks like Maven DI vs Sisu DI bridge issue maybe?

[kwin]

Which impl is supposed to kick in for javax.inject.Inject? I thought that Maven DI should take precedence over Sisu however this exception here clearly comes from Sisu/Guice.

[hboutemy]

mvn toolchains:3.2.0:select-jdk-toolchain works with Maven 3 but not 4.0.0-rc-4:

Execution default-cli of goal org.apache.maven.plugins:maven-toolchains-plugin:3.2.0:select-jdk-toolchain failed: Unable to load the mojo 'select-jdk-toolchain' (or one of its required components) from the plugin 'org.apache.maven.plugins:maven-toolchains-plugin:3.2.0': com.google.inject.ProvisionException: Unable to provision, see the following errors:
[ERROR] 
[ERROR] 1) [Guice/NullInjectedIntoNonNullable]: null returned by binding at LocatorWiring
[ERROR]  but SelectJdkToolchainMojo.factory(SelectJdkToolchainMojo.java:57) is not @Nullable

perhaps in Maven 3, the @nonnullable is not enforced, while it is in Maven 4

Guillaume Nodet: No, I suspect guice cannot find the correct implementation for this interface for some reason.
-Dsisu.debug could help

[gnodet]

The following code is supposed to export the implementation to Maven DI. And the DI bridge is supposed to make it available to Sisu. So that looks like a bug in Maven 4 somehow.

https://github.com/apache/maven/blob/f7b19bc72c6de1a14fa635e0c966d5ea9938fdf0/comp[…]in/java/org/apache/maven/toolchain/ToolchainManagerFactory.java