Make mongo-hibernate.jar a Java module

HIBERNATE-52

Author: stIncMale

.evergreen/java-config.sh

@@ -3,7 +3,6 @@
 # Java configurations for evergreen
 
 export JDK17="/opt/java/jdk17"
-export JDK21="/opt/java/jdk21"
 
 if [ -d "$JDK17" ]; then
   export JAVA_HOME=$JDK17

README.md

@@ -35,7 +35,7 @@ instead of SQL. This product works by:
 - [Manual](https://www.mongodb.com/docs/languages/java/mongodb-hibernate/current)
 - [API](https://javadoc.io/doc/org.mongodb/mongodb-hibernate/latest/index.html)
 
-[Standalone deployments](https://www.mongodb.com/docs/manual/reference/glossary/#std-term-standalone) are not supported,
+MongoDB [standalone deployments](https://www.mongodb.com/docs/manual/reference/glossary/#std-term-standalone) are not supported,
 because they [do not support transactions](https://www.mongodb.com/docs/manual/core/transactions-production-consideration/).
 If you use one, you may [convert it to a replica set](https://www.mongodb.com/docs/manual/tutorial/convert-standalone-to-replica-set/).
 
@@ -102,7 +102,7 @@ This project uses separate directories for unit and integration tests:
 - [`./src/test`](src/test)
 - [`./src/integrationTest`](src/integrationTest)
 
-Integration tests require a MongoDB deployment with test commands enabled,  which may be achieved with the
+Integration tests require a MongoDB deployment with test commands enabled, which may be achieved with the
 [`--setParameter enableTestCommands=1`](https://www.mongodb.com/docs/manual/reference/parameters/)
 command-line arguments.
 

build.gradle.kts

@@ -39,20 +39,28 @@ java {
 }
 
 tasks.withType<Javadoc> {
-    exclude("/com/mongodb/hibernate/internal/**")
-    exclude("com/mongodb/hibernate/dialect/**")
-    exclude("com/mongodb/hibernate/jdbc/**")
-
     val standardDocletOptions = options as StandardJavadocDocletOptions
     standardDocletOptions.apply {
+        addBooleanOption("Werror", false)
+        // TODO-HIBERNATE-129 addStringOption("-link-modularity-mismatch", "info")
+        addBooleanOption("serialwarn", true)
+        addBooleanOption("Xdoclint:all", true)
+        addBooleanOption(
+            "Xdoclint/package:-" +
+                "com.mongodb.hibernate.internal.*" +
+                ",com.mongodb.hibernate.dialect.*" +
+                ",com.mongodb.hibernate.jdbc.*",
+            true)
+        addStringOption("-show-module-contents", "api")
+        addStringOption("-show-packages", "exported")
+        addStringOption("-show-types", "protected")
         author(true)
         version(true)
-        encoding = "UTF-8"
+        encoding("UTF-8")
         charSet("UTF-8")
         docEncoding("UTF-8")
         addBooleanOption("html5", true)
         addBooleanOption("-allow-script-in-comments", true)
-        // TODO-HIBERNATE-129 addStringOption("-link-modularity-mismatch", "info")
         links =
             listOf(
                 "https://docs.oracle.com/en/java/javase/17/docs/api/",
@@ -141,11 +149,15 @@ spotless {
 tasks.check { dependsOn(tasks.spotlessApply) }
 
 tasks.withType<JavaCompile>().configureEach {
-    options.compilerArgs.addAll(listOf("-Xlint:all", "-Werror"))
+    options.compilerArgs.addAll(
+        listOf("-Xlint:all", "-Xlint:-requires-automatic", "-Xlint:-requires-transitive-automatic", "-Werror"))
     when (this) {
         tasks.compileJava.get() ->
             options.errorprone {
                 disableWarningsInGeneratedCode = true
+                // Error Prone does not understand the `@hidden` standard tag
+                disable("InvalidBlockTag")
+                disable("AssignmentExpression")
                 option("NullAway:AnnotatedPackages", "com.mongodb.hibernate")
                 error("NullAway")
             }
@@ -159,6 +171,8 @@ tasks.withType<JavaCompile>().configureEach {
 buildConfig {
     useJavaOutput()
     packageName("com.mongodb.hibernate.internal")
+    documentation.set(
+        "Generated by the <a href=\"https://github.com/gmazzo/gradle-buildconfig-plugin\">BuildConfig</a> plugin.\n\n@hidden")
     buildConfigField("NAME", provider { project.name })
     buildConfigField("VERSION", provider { "${project.version}" })
 }
@@ -205,6 +219,9 @@ publishing {
     repositories {
         // publish to local build dir for testing
         // `./gradlew publishMavenPublicationToLocalBuildRepository`
+        //
+        // publish to the local Maven cache
+        // `./gradlew publishToMavenLocal`
         maven {
             url = uri(localBuildRepo.get())
             name = "LocalBuild"
@@ -222,8 +239,8 @@ publishing {
                 url = "https://www.mongodb.com/"
                 licenses {
                     license {
-                        name = "The Apache License, Version 2.0"
-                        url = "http://www.apache.org/licenses/LICENSE-2.0.txt"
+                        name = "Apache License, Version 2.0"
+                        url = "https://www.apache.org/licenses/LICENSE-2.0"
                     }
                 }
                 developers {
@@ -234,8 +251,8 @@ publishing {
                 }
                 scm {
                     url.set("https://github.com/mongodb/mongo-hibernate")
-                    connection.set("scm:https://github.com/mongodb/mongo-hibernate.git")
-                    developerConnection.set("scm:https://github.com/mongodb/mongo-hibernate.git")
+                    connection.set("scm:git:https://github.com/mongodb/mongo-hibernate.git")
+                    developerConnection.set("scm:git:https://github.com/mongodb/mongo-hibernate.git")
                 }
             }
         }

gradle/libs.versions.toml

@@ -15,19 +15,19 @@
 [versions]
 junit-jupiter = "5.13.4"
 assertj = "3.27.3"
-google-errorprone-core = "2.36.0"
+google-errorprone-core = "2.42.0"
 nullaway = "0.12.4"
 jspecify = "1.0.0"
 hibernate-orm = "6.6.34.Final" # Remember to update javadoc links
 mongo-java-driver-sync = "5.6.1" # Remember to update javadoc links
 findbugs-jsr = "3.0.2"
-slf4j-api = "2.0.16"
-logback-classic = "1.5.16"
+slf4j-api = "2.0.17"
+logback-classic = "1.5.21"
 mockito = "5.16.0"
 checker-qual = "3.49.1"
 
 plugin-spotless = "7.0.2"
-plugin-errorprone = "4.1.0"
+plugin-errorprone = "4.3.0"
 plugin-buildconfig = "5.5.4"
 plugin-palantir = "2.58.0"
 plugin-ktfmt = "0.54"

src/integrationTest/java/com/mongodb/hibernate/query/AbstractQueryIntegrationTests.java

@@ -26,7 +26,7 @@
 
 import com.mongodb.client.MongoCollection;
 import com.mongodb.hibernate.TestCommandListener;
-import com.mongodb.hibernate.dialect.MongoDialect;
+import com.mongodb.hibernate.internal.dialect.TestMongoDialect;
 import com.mongodb.hibernate.junit.MongoExtension;
 import java.util.Set;
 import java.util.function.Consumer;
@@ -251,7 +251,7 @@ private void assertAffectedCollections(Set<String> expectedAffectedCollections)
                 .containsExactlyInAnyOrderElementsOf(expectedAffectedCollections);
     }
 
-    protected static final class TranslateResultAwareDialect extends MongoDialect {
+    protected static final class TranslateResultAwareDialect extends TestMongoDialect {
         private AbstractJdbcOperationQuery capturedTranslateResult;
 
         public TranslateResultAwareDialect(DialectResolutionInfo info) {

src/integrationTest/java/com/mongodb/hibernate/query/select/LimitOffsetFetchClauseIntegrationTests.java

@@ -23,9 +23,9 @@
 import static org.hibernate.cfg.AvailableSettings.QUERY_PLAN_CACHE_ENABLED;
 import static org.junit.jupiter.params.provider.EnumSource.Mode.EXCLUDE;
 
-import com.mongodb.hibernate.dialect.MongoDialect;
 import com.mongodb.hibernate.internal.FeatureNotSupportedException;
 import com.mongodb.hibernate.internal.MongoConstants;
+import com.mongodb.hibernate.internal.dialect.TestMongoDialect;
 import com.mongodb.hibernate.query.AbstractQueryIntegrationTests;
 import com.mongodb.hibernate.query.Book;
 import java.util.Arrays;
@@ -625,7 +625,7 @@ private void setQueryOptionsAndQuery(
      * the query plan cache is hit, not whether {@link SqlAstTranslator} is reused afterwards (e.g., incompatible
      * {@link org.hibernate.query.spi.QueryOptions QueryOptions}s will end up with new translator bing created).
      */
-    protected static final class TranslatingCacheTestingDialect extends MongoDialect {
+    protected static final class TranslatingCacheTestingDialect extends TestMongoDialect {
         private final AtomicInteger selectTranslatingCounter = new AtomicInteger();
 
         public TranslatingCacheTestingDialect(DialectResolutionInfo info) {

src/integrationTest/resources/META-INF/services/org.hibernate.service.spi.ServiceContributor

@@ -1 +1 @@
-com.mongodb.hibernate.TestServiceContributor
+com.mongodb.hibernate.TestServiceContributor

src/integrationTest/resources/hibernate.properties

@@ -1,4 +1,4 @@
 hibernate.dialect=com.mongodb.hibernate.dialect.MongoDialect
 hibernate.connection.provider_class=com.mongodb.hibernate.jdbc.MongoConnectionProvider
 jakarta.persistence.jdbc.url=mongodb://localhost/mongo-hibernate-test?directConnection=false
-hibernate.query.plan_cache_enabled=false #make tests more isolated from each other
+hibernate.query.plan_cache_enabled=false #make tests more isolated from each other

src/integrationTest/resources/logback-test.xml

@@ -1,11 +1,32 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<!--
+Copyright 2025-present MongoDB, Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+  http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+-->
+
+<!DOCTYPE configuration>
 <configuration>
-    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
-        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
-            <Pattern>
-                %d{HH:mm:ss} [%thread] %-5level %logger{36} - %msg%n
-            </Pattern>
+    <import class="ch.qos.logback.classic.encoder.PatternLayoutEncoder"/>
+    <import class="ch.qos.logback.core.ConsoleAppender"/>
+    <appender name="STDOUT" class="ConsoleAppender">
+        <encoder class="PatternLayoutEncoder">
+            <pattern>%date{STRICT} [%thread] %level %logger{36} - %message%n</pattern>
         </encoder>
     </appender>
+    <root level="info">
+        <appender-ref ref="STDOUT"/>
+    </root>
     <logger name="org.hibernate" level="warn" additivity="true"/>
     <logger name="org.hibernate.SQL" level="debug" additivity="true"/>
     <logger name="org.hibernate.orm.jdbc.bind" level="trace" additivity="true"/>
@@ -14,7 +35,4 @@
     <logger name="org.hibernate.orm.sql.ast.tree" level="debug" additivity="true"/>
     <logger name="org.mongodb.driver" level="warn" additivity="true"/>
     <logger name="com.mongodb.hibernate" level="debug" additivity="true"/>
-    <root level="info">
-        <appender-ref ref="STDOUT"/>
-    </root>
-</configuration>
+</configuration>

src/main/java/com/mongodb/hibernate/cfg/MongoConfigurator.java

@@ -18,7 +18,7 @@
 
 import com.mongodb.ConnectionString;
 import com.mongodb.MongoClientSettings;
-import com.mongodb.hibernate.internal.Sealed;
+import com.mongodb.hibernate.internal.cfg.MongoConfigurationBuilder;
 import com.mongodb.hibernate.service.spi.MongoConfigurationContributor;
 import java.util.Map;
 import java.util.function.Consumer;
@@ -74,8 +74,7 @@
  *
  * @see MongoConfigurationContributor
  */
-@Sealed
-public interface MongoConfigurator {
+public sealed interface MongoConfigurator permits MongoConfigurationBuilder {
     /**
      * Configures {@link MongoClientSettings}.
      *