POJOCodec Ensure properties can be overridden by explicit types

JAVA-3040

Author: rozza

bson/src/main/org/bson/codecs/pojo/PojoBuilderHelper.java

@@ -157,7 +157,7 @@ private static <T, S> PropertyMetadata<T> getOrCreateMethodPropertyMetadata(fina
                                                                   final List<String> genericTypeNames,
                                                                   final Type genericType) {
         PropertyMetadata<T> propertyMetadata = getOrCreatePropertyMetadata(propertyName, declaringClassName, propertyNameMap, typeData);
-        if (!propertyMetadata.getTypeData().getType().isAssignableFrom(typeData.getType())) {
+        if (!isAssignableClass(propertyMetadata.getTypeData().getType(), typeData.getType())) {
             throw new CodecConfigurationException(format("Property '%s' in %s, has differing data types: %s and %s", propertyName,
                     declaringClassName, propertyMetadata.getTypeData(), typeData));
         }
@@ -166,6 +166,10 @@ private static <T, S> PropertyMetadata<T> getOrCreateMethodPropertyMetadata(fina
         return propertyMetadata;
     }
 
+    private static boolean isAssignableClass(final Class<?> propertyTypeClass, final Class<?> typeDataClass) {
+        return propertyTypeClass.isAssignableFrom(typeDataClass) || typeDataClass.isAssignableFrom(propertyTypeClass);
+    }
+
     private static <T, S> PropertyMetadata<T> getOrCreateFieldPropertyMetadata(final String propertyName,
                                                                                final String declaringClassName,
                                                                                final Map<String, PropertyMetadata<?>> propertyNameMap,

bson/src/test/unit/org/bson/codecs/pojo/ClassModelTest.java

@@ -20,6 +20,10 @@
 import org.bson.codecs.pojo.entities.GenericHolderModel;
 import org.bson.codecs.pojo.entities.NestedGenericHolderMapModel;
 import org.bson.codecs.pojo.entities.PropertySelectionModel;
+import org.bson.codecs.pojo.entities.ShapeHolderCircleModel;
+import org.bson.codecs.pojo.entities.ShapeHolderModel;
+import org.bson.codecs.pojo.entities.ShapeModelAbstract;
+import org.bson.codecs.pojo.entities.ShapeModelCircle;
 import org.bson.codecs.pojo.entities.SimpleGenericsModel;
 import org.bson.codecs.pojo.entities.SimpleModel;
 import org.bson.codecs.pojo.entities.conventions.AnnotationInheritedModel;
@@ -159,4 +163,15 @@ public void testInheritedClassAnnotations() {
         assertTrue(propertyModel.useDiscriminator());
     }
 
+    @Test
+    public void testOverridePropertyWithSubclass() {
+        ClassModel<?> classModel = ClassModel.builder(ShapeHolderModel.class).build();
+        assertEquals(1, classModel.getPropertyModels().size());
+        assertEquals(ShapeModelAbstract.class, classModel.getPropertyModels().get(0).getTypeData().getType());
+
+        ClassModel<?> overriddenImplementationClassModel = ClassModel.builder(ShapeHolderCircleModel.class).build();
+        assertEquals(1, classModel.getPropertyModels().size());
+        assertEquals(ShapeModelCircle.class, overriddenImplementationClassModel.getPropertyModels().get(0).getTypeData().getType());
+    }
+
 }

bson/src/test/unit/org/bson/codecs/pojo/PojoRoundTripTest.java

@@ -51,6 +51,7 @@
 import org.bson.codecs.pojo.entities.PropertyWithMultipleTypeParamsModel;
 import org.bson.codecs.pojo.entities.ReusedGenericsModel;
 import org.bson.codecs.pojo.entities.SelfReferentialGenericModel;
+import org.bson.codecs.pojo.entities.ShapeHolderCircleModel;
 import org.bson.codecs.pojo.entities.ShapeHolderModel;
 import org.bson.codecs.pojo.entities.ShapeModelAbstract;
 import org.bson.codecs.pojo.entities.ShapeModelCircle;
@@ -379,6 +380,11 @@ private static List<TestData> testCases() {
         data.add(new TestData("AnnotationBsonPropertyIdModel", new AnnotationBsonPropertyIdModel(99L),
                 getPojoCodecProviderBuilder(AnnotationBsonPropertyIdModel.class),
                 "{'id': {'$numberLong': '99' }}"));
+
+        data.add(new TestData("Shape model - circle",
+                new ShapeHolderCircleModel(getShapeModelCircle()),
+                getPojoCodecProviderBuilder(ShapeModelCircle.class, ShapeHolderCircleModel.class),
+                "{'shape': {'_t': 'org.bson.codecs.pojo.entities.ShapeModelCircle', 'color': 'orange', 'radius': 4.2}}"));
         return data;
     }
 

bson/src/test/unit/org/bson/codecs/pojo/entities/ShapeHolderCircleModel.java

@@ -0,0 +1,33 @@
+/*
+ * Copyright 2008-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.
+ */
+
+package org.bson.codecs.pojo.entities;
+
+public class ShapeHolderCircleModel extends ShapeHolderModel {
+
+    public ShapeHolderCircleModel() {
+    }
+
+    public ShapeHolderCircleModel(final ShapeModelCircle shape) {
+        super(shape);
+    }
+
+    @Override
+    public ShapeModelCircle getShape() {
+        return (ShapeModelCircle) super.getShape();
+    }
+}
+

bson/src/test/unit/org/bson/codecs/pojo/entities/ShapeHolderModel.java

@@ -16,7 +16,7 @@
 
 package org.bson.codecs.pojo.entities;
 
-public final class ShapeHolderModel {
+public class ShapeHolderModel {
 
     private ShapeModelAbstract shape;