Skip to content

Commit cec6f23

Browse files
Include missing unknown-property paths for Jackson exceptions
1 parent 15db491 commit cec6f23

2 files changed

Lines changed: 97 additions & 1 deletion

File tree

‎src/main/java/tools/jackson/databind/deser/bean/BeanDeserializerBase.java‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2061,7 +2061,13 @@ protected void handleUnknownProperty(JsonParser p, DeserializationContext ctxt,
20612061
try {
20622062
super.handleUnknownProperty(p, ctxt, beanOrClass, propName);
20632063
} catch (JacksonException e) {
2064-
// Already contains the path to the unknown property.
2064+
// Include the unknown property unless the handler already added it.
2065+
Object bean = (beanOrClass == null) ? handledType() : beanOrClass;
2066+
List<JacksonException.Reference> path = e.getPath();
2067+
if (path.isEmpty() || (path.get(0).from() != bean)
2068+
|| !Objects.equals(path.get(0).getPropertyName(), propName)) {
2069+
e.prependPath(bean, propName);
2070+
}
20652071
throw e;
20662072
} catch (Exception e) {
20672073
throw wrapAndThrow(e, (beanOrClass == null) ? handledType() : beanOrClass,

‎src/test/java/tools/jackson/databind/deser/filter/UnknownPropertyException6375Test.java‎

Lines changed: 90 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44

55
import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
66

7+
import tools.jackson.core.JacksonException;
78
import tools.jackson.core.JsonParser;
89
import tools.jackson.databind.*;
910
import tools.jackson.databind.annotation.JsonDeserialize;
@@ -99,6 +100,95 @@ public boolean handleUnknownProperty(DeserializationContext ctxt, JsonParser p,
99100
assertEquals(1, exception.getPath().size());
100101
}
101102

103+
@Test
104+
void jacksonExceptionWithoutPathGetsUnknownPropertyPath() {
105+
for (boolean wrap : new boolean[] { true, false }) {
106+
DatabindException[] original = new DatabindException[1];
107+
Object[] bean = new Object[1];
108+
ObjectMapper jacksonFailure = JsonMapper.builder()
109+
.configure(DeserializationFeature.WRAP_EXCEPTIONS, wrap)
110+
.addHandler(new DeserializationProblemHandler() {
111+
@Override
112+
public boolean handleUnknownProperty(DeserializationContext ctxt, JsonParser p,
113+
ValueDeserializer<?> deser, Object beanOrClass, String propName) {
114+
bean[0] = beanOrClass;
115+
original[0] = DatabindException.from(p, "handler failure");
116+
throw original[0];
117+
}
118+
}).build();
119+
DatabindException exception = assertThrows(DatabindException.class,
120+
() -> jacksonFailure.readValue("{\"unknown\":1}", Bean.class));
121+
assertSame(original[0], exception);
122+
assertEquals(1, exception.getPath().size());
123+
assertSame(bean[0], exception.getPath().get(0).from());
124+
assertEquals("unknown", exception.getPath().get(0).getPropertyName());
125+
}
126+
}
127+
128+
@Test
129+
void inputMismatchGetsUnknownPropertyPath() {
130+
ObjectMapper jacksonFailure = JsonMapper.builder()
131+
.addHandler(new DeserializationProblemHandler() {
132+
@Override
133+
public boolean handleUnknownProperty(DeserializationContext ctxt, JsonParser p,
134+
ValueDeserializer<?> deser, Object beanOrClass, String propName) {
135+
return ctxt.reportInputMismatch(Bean.class, "handler failure");
136+
}
137+
}).build();
138+
DatabindException exception = assertThrows(DatabindException.class,
139+
() -> jacksonFailure.readValue("{\"unknown\":1}", Bean.class));
140+
assertEquals(1, exception.getPath().size());
141+
assertEquals("unknown", exception.getPath().get(0).getPropertyName());
142+
assertInstanceOf(Bean.class, exception.getPath().get(0).from());
143+
}
144+
145+
@Test
146+
void nestedReadFailureGetsUnknownPropertyPrefix() {
147+
JacksonException[] original = new JacksonException[1];
148+
ObjectMapper jacksonFailure = JsonMapper.builder()
149+
.addHandler(new DeserializationProblemHandler() {
150+
@Override
151+
public boolean handleUnknownProperty(DeserializationContext ctxt, JsonParser p,
152+
ValueDeserializer<?> deser, Object beanOrClass, String propName) {
153+
try {
154+
ctxt.readValue(p, Bean.class);
155+
} catch (JacksonException e) {
156+
original[0] = e;
157+
throw e;
158+
}
159+
return true;
160+
}
161+
}).build();
162+
DatabindException exception = assertThrows(DatabindException.class,
163+
() -> jacksonFailure.readValue("{\"unknown\":{\"value\":\"invalid\"}}", Bean.class));
164+
assertSame(original[0], exception);
165+
assertEquals(2, exception.getPath().size());
166+
assertEquals("unknown", exception.getPath().get(0).getPropertyName());
167+
assertEquals("value", exception.getPath().get(1).getPropertyName());
168+
}
169+
170+
@Test
171+
void existingUnknownPropertyPrefixIsNotDuplicated() {
172+
DatabindException[] original = new DatabindException[1];
173+
ObjectMapper jacksonFailure = JsonMapper.builder()
174+
.addHandler(new DeserializationProblemHandler() {
175+
@Override
176+
public boolean handleUnknownProperty(DeserializationContext ctxt, JsonParser p,
177+
ValueDeserializer<?> deser, Object beanOrClass, String propName) {
178+
original[0] = DatabindException.from(p, "handler failure");
179+
original[0].prependPath(Bean.class, "value");
180+
original[0].prependPath(beanOrClass, propName);
181+
throw original[0];
182+
}
183+
}).build();
184+
DatabindException exception = assertThrows(DatabindException.class,
185+
() -> jacksonFailure.readValue("{\"unknown\":1}", Bean.class));
186+
assertSame(original[0], exception);
187+
assertEquals(2, exception.getPath().size());
188+
assertEquals("unknown", exception.getPath().get(0).getPropertyName());
189+
assertEquals("value", exception.getPath().get(1).getPropertyName());
190+
}
191+
102192
@Test
103193
void defaultUnknownPropertyHasOnePathSegment() {
104194
ObjectMapper strict = JsonMapper.builder()

0 commit comments

Comments
 (0)