feat: convert solver to JPMS (TimefoldAI#2149)

Author: triceo

CONTRIBUTING.md

@@ -91,7 +91,7 @@ CI checks enforce those conventions too, so be sure to build your project with M
 ./mvnw clean install
 ```
 
-For information about how to set up code style checks in your IDE, see [IDE Setup Instructions](https://github.com/TimefoldAI/timefold-solver/blob/main/build/ide-config/ide-configuration.adoc).
+For information about how to set up code style checks in your IDE, see [IDE Setup Instructions](build/ide-config/ide-configuration.adoc).
 
 **Key code style conventions** (see [Constitution](.specify/memory/constitution.md) for complete details):
 - Automatic formatting via Maven build

build/bom/pom.xml

@@ -48,23 +48,6 @@
         <type>test-jar</type>
         <version>${version.ai.timefold.solver}</version>
       </dependency>
-      <dependency>
-        <groupId>ai.timefold.solver</groupId>
-        <artifactId>timefold-solver-persistence-common</artifactId>
-        <version>${version.ai.timefold.solver}</version>
-      </dependency>
-      <dependency>
-        <groupId>ai.timefold.solver</groupId>
-        <artifactId>timefold-solver-persistence-common</artifactId>
-        <version>${version.ai.timefold.solver}</version>
-        <classifier>sources</classifier>
-      </dependency>
-      <dependency>
-        <groupId>ai.timefold.solver</groupId>
-        <artifactId>timefold-solver-persistence-common</artifactId>
-        <type>test-jar</type>
-        <version>${version.ai.timefold.solver}</version>
-      </dependency>
       <dependency>
         <groupId>ai.timefold.solver</groupId>
         <artifactId>timefold-solver-jaxb</artifactId>

build/build-parent/pom.xml

@@ -26,6 +26,7 @@
     <version.org.apache.logging.log4j>2.25.3</version.org.apache.logging.log4j>
     <version.org.assertj>3.27.7</version.org.assertj>
     <version.org.awaitility>4.3.0</version.org.awaitility>
+    <version.org.eclipse.microprofile.config>3.1.1-RC1</version.org.eclipse.microprofile.config>
     <version.org.freemarker>2.3.34</version.org.freemarker>
     <version.org.jfree.jfreechart>1.5.6</version.org.jfree.jfreechart>
     <version.org.jspecify>1.0.0</version.org.jspecify>
@@ -60,9 +61,6 @@
     <!-- Plugin configuration properties -->
     <maven.min.version>3.9.11</maven.min.version> <!-- The same as the version in .mvn/maven-wrapper.properties -->
     <maven.compiler.release>21</maven.compiler.release>
-    <!-- This property needs to be defined in all modules that use the packaging 'jar'.
-         It is used by different plugins to make sure the module/bundle names are consistent. -->
-    <java.module.name/>
     <spotless.skip>false</spotless.skip>
     <spotless.goal>apply</spotless.goal>
     <!-- JaCoCo coverage data file location -->
@@ -369,16 +367,6 @@
           <artifactId>maven-jar-plugin</artifactId>
           <version>${version.jar.plugin}</version>
           <executions>
-            <execution>
-              <id>default-jar</id>
-              <configuration>
-                <archive>
-                  <manifestEntries combine.children="append">
-                    <Automatic-Module-Name>${java.module.name}</Automatic-Module-Name>
-                  </manifestEntries>
-                </archive>
-              </configuration>
-            </execution>
             <execution>
               <id>test-jar</id>
               <goals>
@@ -454,6 +442,28 @@
               <compilerArgument>-Xlint:none</compilerArgument>
             </compilerArgs>
           </configuration>
+          <executions>
+            <execution>
+              <id>default-compile</id>
+              <phase>compile</phase>
+              <goals>
+                <goal>compile</goal>
+              </goals>
+              <!-- no useModulePath override here -->
+            </execution>
+
+            <!-- test compile: force classpath (no module-path) -->
+            <execution>
+              <id>default-testCompile</id>
+              <phase>test-compile</phase>
+              <goals>
+                <goal>testCompile</goal>
+              </goals>
+              <configuration>
+                <useModulePath>false</useModulePath>
+              </configuration>
+            </execution>
+          </executions>
         </plugin>
         <plugin>
           <groupId>org.jacoco</groupId>
@@ -568,13 +578,17 @@
         <artifactId>maven-surefire-plugin</artifactId>
         <version>${version.surefire.plugin}</version>
         <configuration>
+          <!-- Currently not running on the module path, despite including JPMS -->
+          <useModulePath>false</useModulePath>
           <redirectTestOutputToFile>true</redirectTestOutputToFile>
         </configuration>
       </plugin>
       <plugin>
         <artifactId>maven-failsafe-plugin</artifactId>
         <version>${version.surefire.plugin}</version>
         <configuration>
+          <!-- Currently not running on the module path, despite including JPMS -->
+          <useModulePath>false</useModulePath>
           <redirectTestOutputToFile>true</redirectTestOutputToFile>
         </configuration>
         <executions>

build/ide-config/ide-configuration.adoc

@@ -1,11 +1,21 @@
-= IDE code style setup
+= Configuring your IDE for Timefold Solver
+
+== Running tests in your IDE
+
+Timefold Solver is https://en.wikipedia.org/wiki/Java_Platform_Module_System[a modular project].
+However, its test coverage runs on the classpath, not the module path.
+Maven respects this and runs the tests on the classpath, but IDEs don't always do that by default.
+If you're running your tests in the IDE and seeing errors about missing modules,
+you need to configure your IDE to run the tests on the classpath.
+
+== IDE code style setup
 
 Every Maven build formats the source code with the standard code style.
 This avoids merge conflicts and code style discussions.
 
 Configure it in your favorite IDE too:
 
-== IDEA setup
+=== IDEA setup
 
 . Open the _Settings_ window (or _Preferences_ depending on your edition) and navigate to _Plugins_.
 
@@ -26,7 +36,7 @@ file in the `build/ide-config/src/main/resources/` directory.
 
 . Open the _Editor -> Code Style -> Java -> Imports_ settings and set the _Class count to use import with '\*'_ to 999. This is to avoid the `*` imports, which should only be used in special cases.
 
-== Eclipse setup
+=== Eclipse setup
 
 . Open the _Preferences_ window, and then navigate to _Java -> Code Style -> Formatter_.
 
@@ -36,7 +46,7 @@ file in the `build/ide-config/src/main/resources/` directory.
 
 . Click Import and select the `build/ide-config/src/main/resources/eclipse.importorder` file.
 
-== VS Code setup
+=== VS Code setup
 
 . Open the _Extensions_ window (Ctrl+Shift+X) and search for _Language Support for Java(TM)_ and install it.
 

build/ide-config/pom.xml

@@ -20,8 +20,4 @@
   </description>
   <url>https://solver.timefold.ai</url>
 
-  <properties>
-    <java.module.name>ai.timefold.solver.ide.config</java.module.name>
-  </properties>
-
 </project>

core/pom.xml

@@ -22,10 +22,6 @@
   </description>
   <url>https://solver.timefold.ai</url>
 
-  <properties>
-    <java.module.name>ai.timefold.solver.core</java.module.name>
-  </properties>
-
   <dependencies>
 
     <!-- Gizmo dependencies -->

…/api/domain/solution/SolutionFileIO.java …/api/domain/solution/SolutionFileIO.javapersistence/common/src/main/java/ai/timefold/solver/persistence/common/api/domain/solution/SolutionFileIO.java renamed to core/src/main/java/ai/timefold/solver/core/api/domain/solution/SolutionFileIO.java persistence/common/src/main/java/ai/timefold/solver/persistence/common/api/domain/solution/SolutionFileIO.java renamed to core/src/main/java/ai/timefold/solver/core/api/domain/solution/SolutionFileIO.java

@@ -1,9 +1,7 @@
-package ai.timefold.solver.persistence.common.api.domain.solution;
+package ai.timefold.solver.core.api.domain.solution;
 
 import java.io.File;
 
-import ai.timefold.solver.core.api.domain.solution.PlanningSolution;
-
 /**
  * Reads or writes a {@link PlanningSolution} from or to a {@link File}.
  * <p>

core/src/main/java/ai/timefold/solver/core/config/heuristic/selector/move/factory/MoveIteratorFactoryConfig.java

@@ -9,7 +9,7 @@
 import ai.timefold.solver.core.config.heuristic.selector.move.MoveSelectorConfig;
 import ai.timefold.solver.core.config.util.ConfigUtils;
 import ai.timefold.solver.core.impl.heuristic.selector.move.factory.MoveIteratorFactory;
-import ai.timefold.solver.core.impl.io.jaxb.adapter.JaxbCustomPropertiesAdapter;
+import ai.timefold.solver.core.impl.io.jaxb.JaxbCustomPropertiesAdapter;
 
 import org.jspecify.annotations.NonNull;
 import org.jspecify.annotations.Nullable;
@@ -25,7 +25,7 @@ public class MoveIteratorFactoryConfig extends MoveSelectorConfig<MoveIteratorFa
     protected Class<? extends MoveIteratorFactory> moveIteratorFactoryClass = null;
 
     @XmlJavaTypeAdapter(JaxbCustomPropertiesAdapter.class)
-    protected Map<String, String> moveIteratorFactoryCustomProperties = null;
+    protected @Nullable Map<String, String> moveIteratorFactoryCustomProperties = null;
 
     public @Nullable Class<? extends MoveIteratorFactory> getMoveIteratorFactoryClass() {
         return moveIteratorFactoryClass;

core/src/main/java/ai/timefold/solver/core/config/heuristic/selector/move/factory/MoveListFactoryConfig.java

@@ -9,7 +9,7 @@
 import ai.timefold.solver.core.config.heuristic.selector.move.MoveSelectorConfig;
 import ai.timefold.solver.core.config.util.ConfigUtils;
 import ai.timefold.solver.core.impl.heuristic.selector.move.factory.MoveListFactory;
-import ai.timefold.solver.core.impl.io.jaxb.adapter.JaxbCustomPropertiesAdapter;
+import ai.timefold.solver.core.impl.io.jaxb.JaxbCustomPropertiesAdapter;
 
 import org.jspecify.annotations.NonNull;
 import org.jspecify.annotations.Nullable;

core/src/main/java/ai/timefold/solver/core/config/partitionedsearch/PartitionedSearchPhaseConfig.java

@@ -16,7 +16,7 @@
 import ai.timefold.solver.core.config.phase.PhaseConfig;
 import ai.timefold.solver.core.config.phase.custom.CustomPhaseConfig;
 import ai.timefold.solver.core.config.util.ConfigUtils;
-import ai.timefold.solver.core.impl.io.jaxb.adapter.JaxbCustomPropertiesAdapter;
+import ai.timefold.solver.core.impl.io.jaxb.JaxbCustomPropertiesAdapter;
 import ai.timefold.solver.core.impl.partitionedsearch.partitioner.SolutionPartitioner;
 
 import org.jspecify.annotations.NonNull;