Skip to content

Report property name as found in input in deserialization error paths #368

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
cowtowncoder merged 13 commits into from
Nov 1, 2026
+909 −580
Merged

Report property name as found in input in deserialization error paths #368

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
57f59b1
Report property name as found in input in deserialization error paths
cowtowncoder Nov 1, 2026
a121cda
Add release notes for #368
cowtowncoder Nov 1, 2026
755be3b
Afterburner: keep parser failures out of property error paths
cowtowncoder Nov 1, 2026
8517bcd
Blackbird: cover input names for structured values and views; simplif…
cowtowncoder Nov 1, 2026
e6b7b32
Afterburner: remove unreachable `deserializeFromObject()` overrides
cowtowncoder Nov 1, 2026
b92112c
Add `@since 3.3` to `SuperSonicBDBase._readAndSet()`
cowtowncoder Nov 1, 2026
c7137d1
Blackbird: report unexpected token after unknown property, as stock n…
cowtowncoder Nov 1, 2026
052a4f4
Afterburner: restore per-property call sites, fix update from non-Object
cowtowncoder Nov 1, 2026
b6c4ad4
Simplify tests
cowtowncoder Nov 1, 2026
54ae518
Merge branch '3.x' into tatu-claude/3.x/alias-name-in-error-path
cowtowncoder Nov 1, 2026
1bc50cf
Blackbird: report unexpected token in record codecs, as stock now does
cowtowncoder Nov 1, 2026
ec07c08
Afterburner: wrap non-Jackson exceptions from unknown property handling
cowtowncoder Nov 1, 2026
cd8af35
Wrap unknown property handling failures through handleUnknownProperty…
cowtowncoder Nov 1, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 23 additions & 2 deletions afterburner/src/main/java/tools/jackson/module/afterburner/deser/SuperSonicBDBase.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,20 +125,41 @@ public void resolve(DeserializationContext ctxt)

// public Object deserialize(JsonParser p, DeserializationContext ctxt) throws IOException
// public final Object deserialize(JsonParser p, DeserializationContext ctxt, Object bean) throws IOException;;
// public final Object deserializeFromObject(JsonParser p, DeserializationContext ctxt) throws IOException;

// Non-Jackson exceptions (like ones from a `DeserializationProblemHandler`) get the
// property as their path; stock lets them through as they are. All routes to
// unknown-property handling come here, including those of inherited stock code.
@Override
protected void handleUnknownProperty(JsonParser p, DeserializationContext ctxt,
Object beanOrClass, String propName)
throws JacksonException
{
try {
super.handleUnknownProperty(p, ctxt, beanOrClass, propName);
} catch (JacksonException e) { // has its path already
throw e;
} catch (Exception e) {
throw wrapAndThrow(e, (beanOrClass == null) ? handledType() : beanOrClass,
propName, ctxt);
}
}

protected final Object _deserializeDisordered(JsonParser p, DeserializationContext ctxt,
Object bean)
throws JacksonException
{
// Input name can only differ from logical one with these
final boolean inputNames = _beanProperties.hasAliases() || _beanProperties.isCaseInsensitive();
for (int ix = p.currentNameMatch(_propNameMatcher); ; ix = p.nextNameMatch(_propNameMatcher)) {
if (ix >= 0) {
p.nextToken();
// Report name as found in input, read at the value token as stock does
final String inputName = inputNames ? p.currentName() : null;
SettableBeanProperty prop = _propsByIndex[ix];
try {
prop.deserializeAndSet(p, ctxt, bean);
} catch (Exception e) {
wrapAndThrow(e, bean, prop.getName(), ctxt);
wrapAndThrow(e, bean, _failedPropertyName(inputName, prop), ctxt);
}
continue;
}
Expand Down
249 changes: 81 additions & 168 deletions ...rner/src/main/java/tools/jackson/module/afterburner/deser/SuperSonicBeanDeserializer.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,50 +110,58 @@ public Object deserialize(JsonParser p, DeserializationContext ctxt)
injectValues(ctxt, bean);
}

// We also we have at least 6 properties, so roll out first few
SettableBeanProperty prop = _orderedProperties[0];
do {
try {
if (p.nextName(_orderedPropertyNames[0])) {
p.nextToken();
prop.deserializeAndSet(p, ctxt, bean);
if (p.nextName(_orderedPropertyNames[1])) {
prop = _orderedProperties[1];
p.nextToken();
prop.deserializeAndSet(p, ctxt, bean);
if (p.nextName(_orderedPropertyNames[2])) {
prop = _orderedProperties[2];
p.nextToken();
prop.deserializeAndSet(p, ctxt, bean);
if (p.nextName(_orderedPropertyNames[3])) {
prop = _orderedProperties[3];
p.nextToken();
prop.deserializeAndSet(p, ctxt, bean);
break; // yay! We did it!
}
}
}
}
return _deserializeDisordered(p, ctxt, bean);
} catch (Exception e) {
wrapAndThrow(e, bean, prop.getName(), ctxt);
}
} while (false);
// We also we have at least 6 properties, so roll out first few. Each with a call site
// of its own, for type profiles; parser calls outside of `try`, as stock has them
if (!p.nextName(_orderedPropertyNames[0])) {
return _deserializeDisordered(p, ctxt, bean);
}
p.nextToken();
try {
_orderedProperties[0].deserializeAndSet(p, ctxt, bean);
} catch (Exception e) {
throw wrapAndThrow(e, bean, _orderedProperties[0].getName(), ctxt);
}
if (!p.nextName(_orderedPropertyNames[1])) {
return _deserializeDisordered(p, ctxt, bean);
}
p.nextToken();
try {
_orderedProperties[1].deserializeAndSet(p, ctxt, bean);
} catch (Exception e) {
throw wrapAndThrow(e, bean, _orderedProperties[1].getName(), ctxt);
}
if (!p.nextName(_orderedPropertyNames[2])) {
return _deserializeDisordered(p, ctxt, bean);
}
p.nextToken();
try {
_orderedProperties[2].deserializeAndSet(p, ctxt, bean);
} catch (Exception e) {
throw wrapAndThrow(e, bean, _orderedProperties[2].getName(), ctxt);
}
if (!p.nextName(_orderedPropertyNames[3])) {
return _deserializeDisordered(p, ctxt, bean);
}
p.nextToken();
try {
_orderedProperties[3].deserializeAndSet(p, ctxt, bean);
} catch (Exception e) {
throw wrapAndThrow(e, bean, _orderedProperties[3].getName(), ctxt);
}

for (int i = 4, len = _orderedProperties.length; i < len; ++i) {
prop = _orderedProperties[i];
if (!p.nextName(_orderedPropertyNames[i])) { // miss...
if (p.currentToken() == JsonToken.END_OBJECT) {
return bean;
}
// we likely point to FIELD_NAME still; offline
return _deserializeDisordered(p, ctxt, bean);
}
p.nextToken(); // skip field, returns value token
p.nextToken();
try {
prop.deserializeAndSet(p, ctxt, bean);
_orderedProperties[i].deserializeAndSet(p, ctxt, bean);
} catch (Exception e) {
wrapAndThrow(e, bean, prop.getName(), ctxt);
throw wrapAndThrow(e, bean, _orderedProperties[i].getName(), ctxt);
}
}
// also, need to ensure we get closing END_OBJECT...
Expand Down Expand Up @@ -185,145 +193,52 @@ public Object deserialize(JsonParser p, DeserializationContext ctxt, Object bean
if (_externalTypeIdHandler != null) {
return deserializeWithExternalTypeId(p, ctxt, bean);
}
// We also we have at least 6 properties, so roll out first few
// We also we have at least 6 properties, so roll out first few. Each with a call site
// of its own, for type profiles; parser calls outside of `try`, as stock has them
SettableBeanProperty prop = _orderedProperties[0];
do {
try {
if (p.isExpectedStartObjectToken()) {
if (!p.nextName(_orderedPropertyNames[0])) {
return _deserializeDisordered(p, ctxt, bean);
}
} else if (!p.hasToken(JsonToken.PROPERTY_NAME)
|| !prop.getName().equals(p.currentName())) {
return _deserializeDisordered(p, ctxt, bean);
}
p.nextToken();
prop.deserializeAndSet(p, ctxt, bean);
if (p.nextName(_orderedPropertyNames[1])) {
prop = _orderedProperties[1];
p.nextToken();
prop.deserializeAndSet(p, ctxt, bean);
if (p.nextName(_orderedPropertyNames[2])) {
prop = _orderedProperties[2];
p.nextToken();
prop.deserializeAndSet(p, ctxt, bean);
if (p.nextName(_orderedPropertyNames[3])) {
prop = _orderedProperties[3];
p.nextToken();
prop.deserializeAndSet(p, ctxt, bean);
break; // yay! We did it!
}
}
}
if (p.isExpectedStartObjectToken()) {
if (!p.nextName(_orderedPropertyNames[0])) {
return _deserializeDisordered(p, ctxt, bean);
} catch (Exception e) {
wrapAndThrow(e, bean, prop.getName(), ctxt);
}
} while (false);

// then rest of properties
for (int i = 4, len = _orderedProperties.length; i < len; ++i) {
if (!p.nextName(_orderedPropertyNames[i])) { // miss...
if (p.hasToken(JsonToken.END_OBJECT)) {
return bean;
}
// we likely point to FIELD_NAME, so can just call parent impl
return super.deserialize(p, ctxt, bean);
}
prop = _orderedProperties[i];
p.nextToken(); // skip field, returns value token
try {
prop.deserializeAndSet(p, ctxt, bean);
} catch (Exception e) {
wrapAndThrow(e, bean, prop.getName(), ctxt);
}
}
// also, need to ensure we get closing END_OBJECT...
if (p.nextToken() != JsonToken.END_OBJECT) {
} else if (!p.hasToken(JsonToken.PROPERTY_NAME)) {
// not an Object at all: stock leaves the bean as is
return super.deserialize(p, ctxt, bean);
} else if (!prop.getName().equals(p.currentName())) {
return _deserializeDisordered(p, ctxt, bean);
}
return bean;
}

// much of below is cut'n pasted from BeanSerializer
@Override
public Object deserializeFromObject(JsonParser p, DeserializationContext ctxt)
throws JacksonException
{
// The ordered-property fast path below is only safe when no view filtering,
// non-standard creation or other non-vanilla features are in play; otherwise
// fall back to the parent implementation which handles all of those.
if (!_vanillaProcessing) {
return super.deserializeFromObject(p, ctxt);
p.nextToken();
try {
prop.deserializeAndSet(p, ctxt, bean);
} catch (Exception e) {
throw wrapAndThrow(e, bean, prop.getName(), ctxt);
}
// See BeanDeserializer.deserializeFromObject [databind#622]
// Allow Object Id references to come in as JSON Objects as well...
if ((_objectIdReader != null) && _objectIdReader.maySerializeAsObject()) {
if (p.hasTokenId(JsonTokenId.ID_PROPERTY_NAME)
&& _objectIdReader.isValidReferencePropertyName(p.currentName(), p)) {
return deserializeFromObjectId(p, ctxt);
}
if (!p.nextName(_orderedPropertyNames[1])) {
return _deserializeDisordered(p, ctxt, bean);
}
if (_nonStandardCreation) {
if (_unwrappedPropertyHandler != null) {
return deserializeWithUnwrapped(p, ctxt);
}
if (_externalTypeIdHandler != null) {
return deserializeWithExternalTypeId(p, ctxt);
}
Object bean = deserializeFromObjectUsingNonDefault(p, ctxt);
if (_injectables != null) {
injectValues(ctxt, bean);
}
return bean;
p.nextToken();
try {
_orderedProperties[1].deserializeAndSet(p, ctxt, bean);
} catch (Exception e) {
throw wrapAndThrow(e, bean, _orderedProperties[1].getName(), ctxt);
}
final Object bean = _valueInstantiator.createUsingDefault(ctxt);
// [databind#631]: Assign current value, to be accessible by custom serializers
p.assignCurrentValue(bean);
if (p.canReadObjectId()) {
Object id = p.getObjectId();
if (id != null) {
_handleTypedObjectId(p, ctxt, bean, id);
}
if (!p.nextName(_orderedPropertyNames[2])) {
return _deserializeDisordered(p, ctxt, bean);
}
if (_injectables != null) {
injectValues(ctxt, bean);
p.nextToken();
try {
_orderedProperties[2].deserializeAndSet(p, ctxt, bean);
} catch (Exception e) {
throw wrapAndThrow(e, bean, _orderedProperties[2].getName(), ctxt);
}
if (!p.nextName(_orderedPropertyNames[3])) {
return _deserializeDisordered(p, ctxt, bean);
}
p.nextToken();
try {
_orderedProperties[3].deserializeAndSet(p, ctxt, bean);
} catch (Exception e) {
throw wrapAndThrow(e, bean, _orderedProperties[3].getName(), ctxt);
}
// We also we have at least 6 properties, so roll out first few
SettableBeanProperty prop = _orderedProperties[0];
do {
try {
if (p.isExpectedStartObjectToken()) {
if (!p.nextName(_orderedPropertyNames[0])) {
return _deserializeDisordered(p, ctxt, bean);
}
} else if (!p.hasToken(JsonToken.PROPERTY_NAME)
|| !prop.getName().equals(p.currentName())) {
return _deserializeDisordered(p, ctxt, bean);
}
p.nextToken();
prop.deserializeAndSet(p, ctxt, bean);
if (p.nextName(_orderedPropertyNames[1])) {
prop = _orderedProperties[1];
p.nextToken();
prop.deserializeAndSet(p, ctxt, bean);
if (p.nextName(_orderedPropertyNames[2])) {
prop = _orderedProperties[2];
p.nextToken();
prop.deserializeAndSet(p, ctxt, bean);
if (p.nextName(_orderedPropertyNames[3])) {
prop = _orderedProperties[3];
p.nextToken();
prop.deserializeAndSet(p, ctxt, bean);
break; // yay! We did it!
}
}
}
return _deserializeDisordered(p, ctxt, bean);
} catch (Exception e) {
wrapAndThrow(e, bean, prop.getName(), ctxt);
}
} while (false);

// then rest of properties
for (int i = 4, len = _orderedProperties.length; i < len; ++i) {
Expand All @@ -334,18 +249,16 @@ public Object deserializeFromObject(JsonParser p, DeserializationContext ctxt)
// we likely point to FIELD_NAME, so can just call parent impl
return super.deserialize(p, ctxt, bean);
}
prop = _orderedProperties[i];
p.nextToken(); // skip field, returns value token
p.nextToken();
try {
prop.deserializeAndSet(p, ctxt, bean);
_orderedProperties[i].deserializeAndSet(p, ctxt, bean);
} catch (Exception e) {
wrapAndThrow(e, bean, prop.getName(), ctxt);
throw wrapAndThrow(e, bean, _orderedProperties[i].getName(), ctxt);
}
}
// also, need to ensure we get closing END_OBJECT...
if (p.nextToken() != JsonToken.END_OBJECT) {
// [modules-base#343]: trailing (possibly unknown) properties remain
return _deserializeDisordered(p, ctxt, bean);
return super.deserialize(p, ctxt, bean);
}
return bean;
}
Expand Down
Loading
Loading