Dependencies convergence (enforcement) #1494

PrimosK · 2024-07-19T10:02:26Z

PrimosK
Jul 19, 2024

I've added the following Maven Enforcer Plugin configuration to the project > build > plugins section of both the root pom.xml and the parent module pom.xml:

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-enforcer-plugin</artifactId>
    <version>1.4.1</version>
    <executions>
        <execution>
            <id>enforce</id>
            <configuration>
                <rules>
                    <dependencyConvergence/>
                </rules>
            </configuration>
            <goals>
                <goal>enforce</goal>
            </goals>
        </execution>
    </executions>
</plugin>

After running mvn compile -fn, various dependency convergence errors were reported in multiple langchain4j Maven modules. Here's an example from langchain4j-core:

[INFO] Scanning for projects...
[INFO] Inspecting build with total of 1 modules...
[INFO] Installing Nexus Staging features:
[INFO]   ... total of 1 executions of maven-deploy-plugin replaced with nexus-staging-maven-plugin
[INFO]
[INFO] ------------------< dev.langchain4j:langchain4j-core >------------------
[INFO] Building LangChain4j :: Core 0.33.0-SNAPSHOT
[INFO]   from pom.xml
[INFO] --------------------------------[ jar ]---------------------------------
[INFO] 
[INFO] --- enforcer:1.4.1:enforce (enforce) @ langchain4j-core ---
[WARNING] 
Dependency convergence error for org.junit.jupiter:junit-jupiter-api:5.10.0 paths to dependency are:
+-dev.langchain4j:langchain4j-core:0.33.0-SNAPSHOT
  +-org.junit.jupiter:junit-jupiter-engine:5.10.0
    +-org.junit.jupiter:junit-jupiter-api:5.10.0
and
+-dev.langchain4j:langchain4j-core:0.33.0-SNAPSHOT
  +-org.junit.jupiter:junit-jupiter-params:5.10.0
    +-org.junit.jupiter:junit-jupiter-api:5.10.0
and
+-dev.langchain4j:langchain4j-core:0.33.0-SNAPSHOT
  +-org.mockito:mockito-junit-jupiter:4.11.0
    +-org.junit.jupiter:junit-jupiter-api:5.9.1

[WARNING] Rule 0: org.apache.maven.plugins.enforcer.DependencyConvergence failed with message:
Failed while enforcing releasability the error(s) are [
Dependency convergence error for org.junit.jupiter:junit-jupiter-api:5.10.0 paths to dependency are:
+-dev.langchain4j:langchain4j-core:0.33.0-SNAPSHOT
  +-org.junit.jupiter:junit-jupiter-engine:5.10.0
    +-org.junit.jupiter:junit-jupiter-api:5.10.0
and
+-dev.langchain4j:langchain4j-core:0.33.0-SNAPSHOT
  +-org.junit.jupiter:junit-jupiter-params:5.10.0
    +-org.junit.jupiter:junit-jupiter-api:5.10.0
and
+-dev.langchain4j:langchain4j-core:0.33.0-SNAPSHOT
  +-org.mockito:mockito-junit-jupiter:4.11.0
    +-org.junit.jupiter:junit-jupiter-api:5.9.1
]
[INFO] ------------------------------------------------------------------------
[INFO] BUILD FAILURE
[INFO] ------------------------------------------------------------------------
[INFO] Total time:  1.680 s
[INFO] Finished at: 2024-07-19T11:31:33+02:00
[INFO] ------------------------------------------------------------------------
[ERROR] Failed to execute goal org.apache.maven.plugins:maven-enforcer-plugin:1.4.1:enforce (enforce) on project langchain4j-core: Some Enforcer rules have failed. Look above for specific messages explaining why the rule failed. -> [Help 1]
[ERROR]
[ERROR] To see the full stack trace of the errors, re-run Maven with the -e switch.
[ERROR] Re-run Maven using the -X switch to enable full debug logging.
[ERROR]
[ERROR] For more information about the errors and possible solutions, please read the following articles:
[ERROR] [Help 1] http://cwiki.apache.org/confluence/display/MAVEN/MojoExecutionException
[INFO] Build failures were ignored.

Issues Identified

Existing Dependency Convergence Errors: Various modules have unresolved dependency convergence issues, as highlighted by the example above.
Need for Enforcing Dependency Convergence: It might be beneficial configure the dependency convergence plugin to error out the build when such issues are detected.

Proposed Solutions

Resolve Existing Dependency Convergence Errors: Address current dependency convergence errors in each affected module (or at least in core modules).
Enforce Dependency Convergence: Set up the Maven Enforcer Plugin as shown in the XML snippet to ensure that the build fails (at least for core modules) if dependency convergence errors are detected.

I recommend creating high-priority (P1) issues to tackle these dependency convergence errors ASAP. This will help prevent additional convergence errors from appearing.

Side note:

It may be beneficial to approach this incrementally by fixing and enforcing the rules first in langchain, then in langchain-core, and so on...
This is red flag for anyone who's Enforcing Dependency Convergence in their projects as they will have to explicitly specify and enforce the version of the conflicting dependency (might be tidious task)

langchain4j · 2024-07-19T10:42:50Z

langchain4j
Jul 19, 2024
Maintainer

Hi @PrimosK thanks a lot for raising this issue! Would you like to take a lead here?

0 replies

PrimosK · 2024-07-23T06:00:43Z

PrimosK
Jul 23, 2024
Author

I guess I could do that.

Will think about what would be the best way to tackle it ...

5 replies

PrimosK Jul 23, 2024
Author

I've created new issue for this: #1506

langchain4j Jul 23, 2024
Maintainer

@PrimosK thank you! 🙏

PrimosK Jul 23, 2024
Author

You're welcome...

Update:
I did some initial work (#1506) mainly to demonstrate how we could tackle this.

I will now put this on hold to get some feedback (hopefully from you and also someone else given how critical this improvement is).

Once the proposed solution is polished and confirmed, we can proceed with resolving conflicts in the remaining modules (hopefully with the help of the community).

Side note:
No hard feelings if you decide that these changes are not something you'd like to include. We can manage these conflicts within our project, but I believe that by addressing this together, it will benefit both the Langchain4j and its users.

langchain4j Jul 24, 2024
Maintainer

@PrimosK thank you again! I will push to review it till the end of this week (I will be out the whole next week) when I am done with the release

PrimosK Jul 24, 2024
Author

Ack.

Please note that I will also be out next week and the following week.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Dependencies convergence (enforcement) #1494

{{title}}

Replies: 2 comments 5 replies

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

Select a reply

Dependencies convergence (enforcement) #1494

PrimosK Jul 19, 2024

Replies: 2 comments · 5 replies

langchain4j Jul 19, 2024 Maintainer

PrimosK Jul 23, 2024 Author

PrimosK Jul 23, 2024 Author

langchain4j Jul 23, 2024 Maintainer

PrimosK Jul 23, 2024 Author

langchain4j Jul 24, 2024 Maintainer

PrimosK Jul 24, 2024 Author

PrimosK
Jul 19, 2024

Replies: 2 comments 5 replies

langchain4j
Jul 19, 2024
Maintainer

PrimosK
Jul 23, 2024
Author

PrimosK Jul 23, 2024
Author

langchain4j Jul 23, 2024
Maintainer

PrimosK Jul 23, 2024
Author

langchain4j Jul 24, 2024
Maintainer

PrimosK Jul 24, 2024
Author