Upgraded MongoDB driver dependency to mongodb-driver-legacy 4.11.3

* Use mongodb-driver-legacy since mongo-java-driver uber jar is not published as of 4.0.
* Replace find modifiers, which were removed in 4.0, with calls to `FindIterable` methods
* Remove support for $maxScan, which is no longer supported by MongoDB
* Remove support for $explain.  The only way to explain with the 4.x driver is by calling `FindIterable#explain`.  We could do that, and then use `SingleTupleIterator`, but is it worth it?  Is explain only supported by OGM as a native query?
* Handle breaking changes in WriteConcern class
* Handle breaking changes related to MongoCredential

bom/pom.xml

@@ -69,7 +69,7 @@
         <!-- MongoDB -->
 
         <version.org.mongodb>3.6.2</version.org.mongodb>
-        <version.org.mongodb.mongo-java-driver>3.11.2</version.org.mongodb.mongo-java-driver>
+        <version.org.mongodb.mongo-java-driver>4.11.3</version.org.mongodb.mongo-java-driver>
 
         <!-- Neo4j -->
 
@@ -489,7 +489,7 @@
             <!-- MongoDB -->
             <dependency>
                 <groupId>org.mongodb</groupId>
-                <artifactId>mongo-java-driver</artifactId>
+                <artifactId>mongodb-driver-legacy</artifactId>
                 <version>${version.org.mongodb.mongo-java-driver}</version>
             </dependency>
 

featurepack/mongodb/pom.xml

@@ -29,7 +29,7 @@
 
         <dependency>
             <groupId>org.mongodb</groupId>
-            <artifactId>mongo-java-driver</artifactId>
+            <artifactId>mongodb-driver-legacy</artifactId>
             <exclusions>
                 <exclusion>
                     <artifactId>*</artifactId>

featurepack/mongodb/src/main/modules/ogm/mongodb/module.xml

@@ -8,7 +8,7 @@
 <module xmlns="urn:jboss:module:1.3" name="org.hibernate.ogm.mongodb" slot="${module-slot.org.hibernate.ogm.short-id}">
     <resources>
         <artifact name="${org.hibernate.ogm:hibernate-ogm-mongodb}" />
-        <artifact name="${org.mongodb:mongo-java-driver}" />
+        <artifact name="${org.mongodb:mongodb-driver-legacy}" />
     </resources>
     <dependencies>
         <module name="org.hibernate.ogm" slot="${module-slot.org.hibernate.ogm.short-id}" />

mongodb/pom.xml

@@ -67,7 +67,7 @@
         </dependency>
         <dependency>
             <groupId>org.mongodb</groupId>
-            <artifactId>mongo-java-driver</artifactId>
+            <artifactId>mongodb-driver-legacy</artifactId>
         </dependency>
         <dependency>
             <groupId>org.parboiled</groupId>

mongodb/src/main/java/org/hibernate/ogm/datastore/mongodb/MongoDBDialect.java

@@ -30,6 +30,7 @@
 
 import org.bson.BsonDocument;
 import org.bson.Document;
+import org.bson.conversions.Bson;
 import org.bson.types.ObjectId;
 import org.hibernate.AssertionFailure;
 import org.hibernate.ogm.datastore.document.association.impl.DocumentHelpers;
@@ -1230,36 +1231,51 @@ private ClosableIterator<Tuple> doFind(MongoDBQueryDescriptor query, QueryParame
 			EntityKeyMetadata entityKeyMetadata) {
 		Document criteria = query.getCriteria();
 		Document orderby = query.getOrderBy();
-		int maxTimeMS = -1;
 
-		Document modifiers = new Document();
-		// We need to extract the different parts of the criteria and pass them to the cursor API
+        FindIterable<Document> prepareFind = collection.find();
+
+        // We need to extract the different parts of the criteria and pass them to the cursor API
 		if ( criteria.containsKey( "$query" ) ) {
+
+			prepareFind.filter( (Bson) criteria.get( "$query" ) );
+
 			if ( orderby == null ) {
 				orderby = (Document) criteria.get( "$orderby" );
 			}
-			maxTimeMS = criteria.getInteger( "$maxTimeMS", -1 );
 
-			addModifier( modifiers, criteria, "$hint" );
-			addModifier( modifiers, criteria, "$maxScan" );
-			addModifier( modifiers, criteria, "$snapshot", false );
-			addModifier( modifiers, criteria, "$min" );
-			addModifier( modifiers, criteria, "$max" );
-			addModifier( modifiers, criteria, "$comment" );
-			addModifier( modifiers, criteria, "$explain", false );
+			if ( criteria.containsKey( "$maxTimeMS") ) {
+				prepareFind.maxTime(criteria.getInteger("$maxTimeMS"), TimeUnit.MILLISECONDS);
+			}
+
+			if ( criteria.containsKey( "$hint") ) {
+				Object hint = criteria.get( "$hint" );
+				if ( hint instanceof String ) {
+					prepareFind.hintString( (String) hint );
+				} else if ( hint instanceof Bson ) {
+					prepareFind.hint( (Bson) hint );
+				}
+			}
+
+			if ( criteria.containsKey( "$min" ) ) {
+				prepareFind.min( (Bson) criteria.get( "$min" ) );
+			}
 
-			criteria = (Document) criteria.get( "$query" );
+			if ( criteria.containsKey( "$max" ) ) {
+				prepareFind.max( (Bson) criteria.get( "$max" ) );
+			}
+
+			if ( criteria.containsKey( "$comment" ) ) {
+				prepareFind.comment( criteria.getString( "$comment" ) );
+			}
 		}
 
-		FindIterable<Document> prepareFind = collection.find( criteria ).modifiers( modifiers ).projection( query.getProjection() );
+		prepareFind = prepareFind.projection( query.getProjection() );
+
 		if ( orderby != null ) {
 			prepareFind.sort( orderby );
 		}
-		if ( maxTimeMS > 0 ) {
-			prepareFind.maxTime( maxTimeMS, TimeUnit.MILLISECONDS );
-		}
 
-		// apply firstRow/maxRows if present
+        // apply firstRow/maxRows if present
 		if ( queryParameters.getRowSelection().getFirstRow() != null ) {
 			prepareFind.skip( queryParameters.getRowSelection().getFirstRow() );
 		}
@@ -1492,18 +1508,23 @@ private static int doDrop(MongoCollection<Document> collection) {
 	 * @param obj A JSON object representing a write concern.
 	 * @return The parsed write concern or <code>null</code> if <code>obj</code> is <code>null</code>.
 	 */
-	@SuppressWarnings("deprecation")
 	private static WriteConcern getWriteConcern(Document obj) {
 		WriteConcern wc = null;
 		if ( obj != null ) {
 			Object w = obj.get( "w" );
 			Boolean j = (Boolean) obj.get( "j" );
 			Integer t = (Integer) obj.get( "wtimeout" );
 			if ( w instanceof String ) {
-				wc = new WriteConcern( (String) w, ( t != null ? t : 0 ), false, ( j != null ? j : false ) );
+				wc = new WriteConcern( (String) w );
 			}
 			if ( w instanceof Number ) {
-				wc = new WriteConcern( ( (Number) w ).intValue(), ( t != null ? t : 0 ), false, ( j != null ? j : false ) );
+				wc = new WriteConcern( ( (Number) w ).intValue() );
+			}
+			if (t != null) {
+				wc = wc.withWTimeout(t, TimeUnit.MILLISECONDS);
+			}
+			if (j != null) {
+				wc = wc.withJournal(j);
 			}
 		}
 		return wc;
@@ -1814,7 +1835,6 @@ private static WriteConcern getWriteConcern(AssociationContext associationContex
 	 *
 	 * Thus, for each parameter of the write concern, we keep the stricter one for the resulting merged write concern.
 	 */
-	@SuppressWarnings("deprecation")
 	private static WriteConcern mergeWriteConcern(WriteConcern original, WriteConcern writeConcern) {
 		if ( original == null ) {
 			return writeConcern;
@@ -1828,7 +1848,6 @@ else if ( original.equals( writeConcern ) ) {
 
 		Object wObject;
 		int wTimeoutMS;
-		boolean fsync;
 		Boolean journal;
 
 		if ( original.getWObject() instanceof String ) {
@@ -1841,9 +1860,7 @@ else if ( writeConcern.getWObject() instanceof String ) {
 			wObject = Math.max( original.getW(), writeConcern.getW() );
 		}
 
-		wTimeoutMS = Math.min( original.getWtimeout(), writeConcern.getWtimeout() );
-
-		fsync = original.getFsync() || writeConcern.getFsync();
+		wTimeoutMS = Math.min( original.getWTimeout(TimeUnit.MILLISECONDS), writeConcern.getWTimeout(TimeUnit.MILLISECONDS) );
 
 		if ( original.getJournal() == null ) {
 			journal = writeConcern.getJournal();
@@ -1856,10 +1873,10 @@ else if ( writeConcern.getJournal() == null ) {
 		}
 
 		if ( wObject instanceof String ) {
-			return new WriteConcern( (String) wObject, wTimeoutMS, fsync, journal );
+			return new WriteConcern( (String) wObject).withWTimeout(wTimeoutMS, TimeUnit.MILLISECONDS).withJournal(journal);
 		}
 		else {
-			return new WriteConcern( (int) wObject, wTimeoutMS, fsync, journal );
+			return new WriteConcern( (int) wObject).withWTimeout(wTimeoutMS, TimeUnit.MILLISECONDS).withJournal(journal);
 		}
 	}
 

mongodb/src/main/java/org/hibernate/ogm/datastore/mongodb/configuration/impl/MongoDBConfiguration.java

@@ -8,9 +8,7 @@
 
 import java.lang.reflect.InvocationTargetException;
 import java.lang.reflect.Method;
-import java.util.Collections;
 import java.util.HashMap;
-import java.util.List;
 import java.util.Map;
 
 import com.mongodb.ReadConcern;
@@ -144,15 +142,12 @@ private String getAuthenticationDatabaseName() {
 		return authenticationDatabaseName;
 	}
 
-	public List<MongoCredential> buildCredentials() {
+	public MongoCredential buildCredential() {
 		if ( getUsername() != null ) {
-			return Collections.singletonList(
-					authenticationMechanism.createCredential(
+			return authenticationMechanism.createCredential(
 							getUsername(),
 							getAuthenticationDatabaseName(),
-							getPassword()
-					)
-			);
+							getPassword());
 		}
 		return null;
 	}

mongodb/src/main/java/org/hibernate/ogm/datastore/mongodb/impl/MongoDBDatastoreProvider.java

@@ -153,16 +153,16 @@ private void startClientAndExtractDatabase() {
 
 	protected MongoClient createMongoClient(MongoDBConfiguration config) {
 		MongoClientOptions clientOptions = config.buildOptions();
-		List<MongoCredential> credentials = config.buildCredentials();
+		MongoCredential credential = config.buildCredential();
 		log.connectingToMongo( config.getHosts().toString(), clientOptions.getConnectTimeout() );
 		try {
 			List<ServerAddress> serverAddresses = new ArrayList<>( config.getHosts().size() );
 			for ( Hosts.HostAndPort hostAndPort : config.getHosts() ) {
 				serverAddresses.add( new ServerAddress( hostAndPort.getHost(), hostAndPort.getPort() ) );
 			}
-			return credentials == null
+			return credential == null
 					? new MongoClient( serverAddresses, clientOptions )
-					: new MongoClient( serverAddresses, credentials, clientOptions );
+					: new MongoClient( serverAddresses, credential, clientOptions );
 		}
 		catch (RuntimeException e) {
 			throw log.unableToInitializeMongoDB( e );

mongodb/src/main/java/org/hibernate/ogm/datastore/mongodb/options/AuthenticationMechanismType.java

@@ -32,7 +32,7 @@ public MongoCredential createCredential(String username, String databaseName, St
 
 		@Override
 		public MongoCredential createCredential(String username, String databaseName, String password) {
-			return MongoCredential.createMongoCRCredential( username, databaseName, asCharArray( password ) );
+			return MongoCredential.createCredential( username, databaseName, asCharArray( password ) );
 		}
 	},
 	PLAIN {

mongodb/src/main/java/org/hibernate/ogm/datastore/mongodb/options/WriteConcernType.java

@@ -34,7 +34,7 @@ public enum WriteConcernType {
 	 * Exceptions are raised for network issues, and server errors; the write operation waits for the server to flush
 	 * the data to disk.
 	 */
-	FSYNCED(WriteConcern.FSYNCED),
+	FSYNCED(WriteConcern.JOURNALED),
 
 	/**
 	 * Exceptions are raised for network issues, and server errors; the write operation waits for the server to group
@@ -46,7 +46,7 @@ public enum WriteConcernType {
 	 * Exceptions are raised for network issues, and server errors; waits for at least 2 servers for the write
 	 * operation.
 	 */
-	REPLICA_ACKNOWLEDGED(WriteConcern.REPLICA_ACKNOWLEDGED),
+	REPLICA_ACKNOWLEDGED(WriteConcern.W2),
 
 	/**
 	 * Exceptions are raised for network issues, and server errors; waits on a majority of servers for the write

mongodb/src/test/java/org/hibernate/ogm/datastore/mongodb/test/datastore/DatastoreInitializationTest.java

@@ -81,7 +81,7 @@ public void testDefaultAuthenticationMechanism() throws Exception {
 		// will start the service
 		TestHelper.getDefaultTestStandardServiceRegistry( cfg ).getService( DatastoreProvider.class );
 
-		assertThat( provider.leakingClient.getCredentialsList().get( 0 ).getMechanism() ).isEqualTo( null );
+		assertThat( provider.leakingClient.getCredential().getMechanism() ).isEqualTo( null );
 	}
 
 	@Test
@@ -94,8 +94,7 @@ public void testSCRAMSHA1AuthenticationMechanism() throws Exception {
 		TestHelper.getDefaultTestStandardServiceRegistry( cfg ).getService( DatastoreProvider.class );
 
 		assertThat(
-				provider.leakingClient.getCredentialsList()
-						.get( 0 )
+				provider.leakingClient.getCredential()
 						.getMechanism()
 		).isEqualTo( MongoCredential.SCRAM_SHA_1_MECHANISM );
 	}
@@ -111,8 +110,7 @@ public void testX509AuthenticationMechanism() throws Exception {
 		TestHelper.getDefaultTestStandardServiceRegistry( cfg ).getService( DatastoreProvider.class );
 
 		assertThat(
-				provider.leakingClient.getCredentialsList()
-						.get( 0 )
+				provider.leakingClient.getCredential()
 						.getMechanism()
 		).isEqualTo( MongoCredential.MONGODB_X509_MECHANISM );
 	}
@@ -127,8 +125,7 @@ public void testGSSAPIAuthenticationMechanism() throws Exception {
 		TestHelper.getDefaultTestStandardServiceRegistry( cfg ).getService( DatastoreProvider.class );
 
 		assertThat(
-				provider.leakingClient.getCredentialsList()
-						.get( 0 )
+				provider.leakingClient.getCredential()
 						.getMechanism()
 		).isEqualTo( MongoCredential.GSSAPI_MECHANISM );
 	}
@@ -143,8 +140,7 @@ public void testPlainAuthenticationMechanism() throws Exception {
 		TestHelper.getDefaultTestStandardServiceRegistry( cfg ).getService( DatastoreProvider.class );
 
 		assertThat(
-				provider.leakingClient.getCredentialsList()
-						.get( 0 )
+				provider.leakingClient.getCredential()
 						.getMechanism()
 		).isEqualTo( MongoCredential.PLAIN_MECHANISM );
 	}

mongodb/src/test/java/org/hibernate/ogm/datastore/mongodb/test/datastore/WriteConcernTest.java

@@ -75,10 +75,10 @@ public void shouldApplyValueGivenViaProperties() {
 
 	@Test
 	public void shouldApplyValueGivenViaGlobalOptions() {
-		configuration.writeConcern( WriteConcernType.FSYNCED );
+		configuration.writeConcern( WriteConcernType.MAJORITY );
 
 		MongoDBConfiguration config = new MongoDBConfiguration( reader, getGlobalOptions() );
-		assertEquals( config.buildOptions().getWriteConcern(), WriteConcern.FSYNCED );
+		assertEquals( config.buildOptions().getWriteConcern(), WriteConcern.MAJORITY );
 	}
 
 	@Test

mongodb/src/test/java/org/hibernate/ogm/datastore/mongodb/test/options/writeconcern/WriteConcernAnnotationTest.java

@@ -31,7 +31,7 @@ public void setupBuilder() {
 	@Test
 	public void testWriteConcernForEntity() throws Exception {
 		OptionsContainer options = source.getEntityOptions( EntityWriteConcernExample.class );
-		assertThat( options.getUnique( WriteConcernOption.class ) ).isEqualTo( com.mongodb.WriteConcern.REPLICA_ACKNOWLEDGED );
+		assertThat( options.getUnique( WriteConcernOption.class ) ).isEqualTo( com.mongodb.WriteConcern.W2 );
 	}
 
 	@Test

mongodb/src/test/java/org/hibernate/ogm/datastore/mongodb/test/options/writeconcern/WriteConcernOptionTest.java

@@ -43,10 +43,10 @@ public void setupBuilder() {
 	@Test
 	public void testWriteConcernGivenByTypeOnGlobalLevel() throws Exception {
 		mongoOptions
-			.writeConcern( WriteConcernType.REPLICA_ACKNOWLEDGED );
+			.writeConcern( WriteConcernType.REPLICA_ACKNOWLEDGED);
 
 		OptionsContainer options = getSource().getGlobalOptions();
-		assertThat( options.getUnique( WriteConcernOption.class ) ).isEqualTo( WriteConcern.REPLICA_ACKNOWLEDGED );
+		assertThat( options.getUnique( WriteConcernOption.class ) ).isEqualTo( WriteConcern.W2 );
 	}
 
 	@Test
@@ -62,20 +62,20 @@ public void testWriteConcernGivenByInstanceOnGlobalLevel() throws Exception {
 	@Test
 	public void testWriteConcernGivenByTypePriority() throws Exception {
 		mongoOptions
-			.writeConcern( WriteConcernType.REPLICA_ACKNOWLEDGED )
+			.writeConcern( WriteConcernType.REPLICA_ACKNOWLEDGED)
 			.entity( ExampleForMongoDBMapping.class )
 				.writeConcern( WriteConcernType.MAJORITY )
 				.property( "content", ElementType.FIELD )
-					.writeConcern( WriteConcernType.FSYNCED );
+					.writeConcern( WriteConcernType.JOURNALED );
 
 		OptionsContainer options = getSource().getGlobalOptions();
-		assertThat( options.getUnique( WriteConcernOption.class ) ).isEqualTo( WriteConcern.REPLICA_ACKNOWLEDGED );
+		assertThat( options.getUnique( WriteConcernOption.class ) ).isEqualTo( WriteConcern.W2 );
 
 		options = getSource().getEntityOptions( ExampleForMongoDBMapping.class );
 		assertThat( options.getUnique( WriteConcernOption.class ) ).isEqualTo( WriteConcern.MAJORITY );
 
 		options = getSource().getPropertyOptions( ExampleForMongoDBMapping.class, "content" );
-		assertThat( options.getUnique( WriteConcernOption.class ) ).isEqualTo( WriteConcern.FSYNCED );
+		assertThat( options.getUnique( WriteConcernOption.class ) ).isEqualTo( WriteConcern.ACKNOWLEDGED.withJournal(true) );
 	}
 
 	@Test
@@ -135,7 +135,7 @@ private static final class ExampleForMongoDBMapping {
 	private static class ReplicaConfigurableWriteConcern extends WriteConcern {
 
 		public ReplicaConfigurableWriteConcern(int numberOfRequiredReplicas) {
-			super( numberOfRequiredReplicas, 0, false, true );
+			super( numberOfRequiredReplicas );
 		}
 	}
 }