JAVA-2404: Prevent DBObjectCodecProvider from providing a Codec for a DBObject that is also a List.

jyemin · jyemin · commit f10bebf2db5b · 2017-01-09T15:27:15.000-05:00
Othewise, it will provide the DBObjectCodec for BasicDBList which is incorrect.  With this change,
   the IterableCodecProvider will end up providing ListCodec, which is the correct thing to do.
diff --git a/driver/src/main/com/mongodb/DBObjectCodecProvider.java b/driver/src/main/com/mongodb/DBObjectCodecProvider.java
@@ -24,6 +24,7 @@
 import org.bson.types.BSONTimestamp;
 
 import java.util.Date;
+import java.util.List;
 
 /**
  * A provider for a DBObjectCodec.
@@ -58,7 +59,7 @@ public <T> Codec<T> get(final Class<T> clazz, final CodecRegistry registry) {
             return (Codec<T>) new BSONTimestampCodec();
         }
 
-        if (DBObject.class.isAssignableFrom(clazz)) {
+        if (DBObject.class.isAssignableFrom(clazz) && !List.class.isAssignableFrom(clazz)) {
             return (Codec<T>) new DBObjectCodec(registry, bsonTypeClassMap);
         }
 
diff --git a/driver/src/test/unit/com/mongodb/DBObjectCodecProviderSpecification.groovy b/driver/src/test/unit/com/mongodb/DBObjectCodecProviderSpecification.groovy
@@ -0,0 +1,53 @@
+/*
+ * Copyright 2016 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.
+ *
+ */
+
+package com.mongodb
+
+import org.bson.codecs.DateCodec
+import org.bson.types.BSONTimestamp
+import spock.lang.Specification
+
+import static com.mongodb.MongoClient.defaultCodecRegistry
+
+class DBObjectCodecProviderSpecification extends Specification {
+    def provider = new DBObjectCodecProvider()
+
+    def 'should provide codec for BSONTimestamp'() {
+        expect:
+        provider.get(BSONTimestamp, defaultCodecRegistry).class == BSONTimestampCodec
+    }
+
+    def 'should provide codec for Date'() {
+        expect:
+        provider.get(Date, defaultCodecRegistry).class == DateCodec
+    }
+
+    def 'should provide codec for class assignable to DBObject'() {
+        expect:
+        provider.get(BasicDBObject, defaultCodecRegistry).class == DBObjectCodec
+    }
+
+    def 'should not provide codec for class assignable to DBObject that is also assignable to List'() {
+        expect:
+        provider.get(BasicDBList, defaultCodecRegistry) == null
+    }
+
+    def 'should not provide codec for unexpected class'() {
+        expect:
+        provider.get(Integer, defaultCodecRegistry) == null
+    }
+}

Original file line number	Diff line number	Diff line change
`@@ -24,6 +24,7 @@`
`24`	`24`	`import org.bson.types.BSONTimestamp;`
`25`	`25`
`26`	`26`	`import java.util.Date;`
	`27`	`+import java.util.List;`
`27`	`28`
`28`	`29`	`/**`
`29`	`30`	`* A provider for a DBObjectCodec.`
`@@ -58,7 +59,7 @@ public <T> Codec<T> get(final Class<T> clazz, final CodecRegistry registry) {`
`58`	`59`	`return (Codec<T>) new BSONTimestampCodec();`
`59`	`60`	`}`
`60`	`61`
`61`		`- if (DBObject.class.isAssignableFrom(clazz)) {`
	`62`	`+ if (DBObject.class.isAssignableFrom(clazz) && !List.class.isAssignableFrom(clazz)) {`
`62`	`63`	`return (Codec<T>) new DBObjectCodec(registry, bsonTypeClassMap);`
`63`	`64`	`}`
`64`	`65`