From 757f94c76f0aea936d2b46e817d738d9650925e2 Mon Sep 17 00:00:00 2001 From: Owen O'Brien <87416725+owen-obrien@users.noreply.github.com> Date: Mon, 22 Sep 2025 10:48:44 +0100 Subject: [PATCH 1/2] Reverse equals check to avoid NPEs --- .../codecs/pojo/ConventionAnnotationImpl.java | 2 +- .../pojo/PojoCodecDiscriminatorTest.java | 9 +++ .../DiscriminatorWithPropertyAndIgnore.java | 59 +++++++++++++++++++ 3 files changed, 69 insertions(+), 1 deletion(-) create mode 100644 bson/src/test/unit/org/bson/codecs/pojo/entities/DiscriminatorWithPropertyAndIgnore.java diff --git a/bson/src/main/org/bson/codecs/pojo/ConventionAnnotationImpl.java b/bson/src/main/org/bson/codecs/pojo/ConventionAnnotationImpl.java index 83da176b563..9c3568d6642 100644 --- a/bson/src/main/org/bson/codecs/pojo/ConventionAnnotationImpl.java +++ b/bson/src/main/org/bson/codecs/pojo/ConventionAnnotationImpl.java @@ -244,7 +244,7 @@ private void cleanPropertyBuilders(final ClassModelBuilder classModelBuilder) if (!propertyModelBuilder.isReadable() && !propertyModelBuilder.isWritable()) { propertiesToRemove.add(propertyModelBuilder.getName()); } - if (classModelBuilder.useDiscriminator() && propertyModelBuilder.getReadName().equals(classModelBuilder.getDiscriminatorKey())) { + if (classModelBuilder.useDiscriminator() && classModelBuilder.getDiscriminatorKey().equals(propertyModelBuilder.getReadName())) { propertiesToRemove.add(propertyModelBuilder.getName()); LOGGER.warn( format( diff --git a/bson/src/test/unit/org/bson/codecs/pojo/PojoCodecDiscriminatorTest.java b/bson/src/test/unit/org/bson/codecs/pojo/PojoCodecDiscriminatorTest.java index 60cb94d4e87..b95e7bcefda 100644 --- a/bson/src/test/unit/org/bson/codecs/pojo/PojoCodecDiscriminatorTest.java +++ b/bson/src/test/unit/org/bson/codecs/pojo/PojoCodecDiscriminatorTest.java @@ -19,6 +19,7 @@ import org.bson.codecs.pojo.entities.DiscriminatorModel; import org.bson.codecs.pojo.entities.DiscriminatorWithGetterModel; import org.bson.codecs.pojo.entities.DiscriminatorWithProperty; +import org.bson.codecs.pojo.entities.DiscriminatorWithPropertyAndIgnore; import org.junit.jupiter.api.Test; import static org.junit.jupiter.api.Assertions.assertArrayEquals; @@ -70,4 +71,12 @@ public void testDiscriminatorRoundTripWhenItIsAlsoAProperty() { "{discriminatorKey:'discriminatorValue'}" ); } + + @Test + public void testDiscriminatorRoundTripWhenItIsAlsoAPropertyWithIgnoredProperty() { + roundTrip( + new DiscriminatorWithPropertyAndIgnore(), + "{discriminatorKey:'discriminatorValue'}" + ); + } } diff --git a/bson/src/test/unit/org/bson/codecs/pojo/entities/DiscriminatorWithPropertyAndIgnore.java b/bson/src/test/unit/org/bson/codecs/pojo/entities/DiscriminatorWithPropertyAndIgnore.java new file mode 100644 index 00000000000..ea92fbea928 --- /dev/null +++ b/bson/src/test/unit/org/bson/codecs/pojo/entities/DiscriminatorWithPropertyAndIgnore.java @@ -0,0 +1,59 @@ +/* + * 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; + +import org.bson.codecs.pojo.annotations.BsonDiscriminator; +import org.bson.codecs.pojo.annotations.BsonIgnore; +import org.bson.codecs.pojo.annotations.BsonProperty; + +import java.util.Objects; + +@BsonDiscriminator(key = "discriminatorKey", value = "discriminatorValue") +public class DiscriminatorWithPropertyAndIgnore { + + public DiscriminatorWithPropertyAndIgnore() { + } + + @BsonIgnore + public String getFoo() { + return "foo"; + } + + @BsonProperty("discriminatorKey") + public String getDiscriminator() { + return "discriminatorValue"; + } + + @Override + public boolean equals(final Object o) { + if (o == null || getClass() != o.getClass()){ + return false; + } + final DiscriminatorWithPropertyAndIgnore that = (DiscriminatorWithPropertyAndIgnore) o; + return Objects.equals(getDiscriminator(), that.getDiscriminator()); + } + + @Override + public int hashCode() { + return Objects.hashCode(getDiscriminator()); + } + + @Override + public String toString() { + return "DiscriminatorWithProperty{}"; + } +} From 2ea681ec7fab37a8253eb0b023ece900c7c4d1bf Mon Sep 17 00:00:00 2001 From: Ross Lawley Date: Mon, 22 Sep 2025 14:36:36 +0100 Subject: [PATCH 2/2] Use Objects.equals for discriminator key comparison --- .../main/org/bson/codecs/pojo/ConventionAnnotationImpl.java | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/bson/src/main/org/bson/codecs/pojo/ConventionAnnotationImpl.java b/bson/src/main/org/bson/codecs/pojo/ConventionAnnotationImpl.java index 9c3568d6642..e9adcaa9024 100644 --- a/bson/src/main/org/bson/codecs/pojo/ConventionAnnotationImpl.java +++ b/bson/src/main/org/bson/codecs/pojo/ConventionAnnotationImpl.java @@ -34,6 +34,7 @@ import java.lang.reflect.Type; import java.util.ArrayList; import java.util.List; +import java.util.Objects; import java.util.Map; import static java.lang.String.format; @@ -244,7 +245,7 @@ private void cleanPropertyBuilders(final ClassModelBuilder classModelBuilder) if (!propertyModelBuilder.isReadable() && !propertyModelBuilder.isWritable()) { propertiesToRemove.add(propertyModelBuilder.getName()); } - if (classModelBuilder.useDiscriminator() && classModelBuilder.getDiscriminatorKey().equals(propertyModelBuilder.getReadName())) { + if (classModelBuilder.useDiscriminator() && Objects.equals(classModelBuilder.getDiscriminatorKey(), propertyModelBuilder.getReadName())) { propertiesToRemove.add(propertyModelBuilder.getName()); LOGGER.warn( format(