Fix #5151: add MissingInjectableValueExcepion (#5156)

Author: cowtowncoder

release-notes/VERSION-2.x

@@ -14,6 +14,8 @@ Project: jackson-databind
   from 2.20
 #5103: Use `writeStartObject(Object forValue, int size)` for `ObjectNode`
   serialization
+#5151: Add new exception type, `MissingInjectValueException`, to be used
+  for failed `@JacksonInject`
 - Generate SBOMs [JSTEP-14]
 
 2.19.1 (not yet released)

src/main/java/com/fasterxml/jackson/databind/DeserializationContext.java

@@ -22,6 +22,7 @@
 import com.fasterxml.jackson.databind.exc.InvalidFormatException;
 import com.fasterxml.jackson.databind.exc.InvalidTypeIdException;
 import com.fasterxml.jackson.databind.exc.MismatchedInputException;
+import com.fasterxml.jackson.databind.exc.MissingInjectableValueExcepion;
 import com.fasterxml.jackson.databind.exc.UnrecognizedPropertyException;
 import com.fasterxml.jackson.databind.exc.ValueInstantiationException;
 import com.fasterxml.jackson.databind.introspect.Annotated;
@@ -474,7 +475,7 @@ public final Object findInjectableValue(Object valueId,
                     || (optional == null && !isEnabled(DeserializationFeature.FAIL_ON_UNKNOWN_INJECT_VALUE))) {
                 return JacksonInject.Value.empty();
             }
-            throw missingInjectValueException(String.format(
+            throw missingInjectableValueException(String.format(
 "No 'injectableValues' configured, cannot inject value with id '%s'", valueId),
                     valueId, forProperty, beanInstance);
         }
@@ -2099,11 +2100,11 @@ public JsonMappingException missingTypeIdException(JavaType baseType,
     /**
      * @since 2.20
      */
-    public JsonMappingException missingInjectValueException(String msg,
+    public JsonMappingException missingInjectableValueException(String msg,
             Object valueId,
             BeanProperty forProperty, Object beanInstance) {
-        return InvalidDefinitionException.from(_parser, msg,
-                constructType(ClassUtil.classOf(beanInstance)));
+        return MissingInjectableValueExcepion.from(_parser, msg,
+                valueId, forProperty, beanInstance);
     }
 
     /*

src/main/java/com/fasterxml/jackson/databind/InjectableValues.java

@@ -87,18 +87,19 @@ public Object findInjectableValue(DeserializationContext ctxt, Object valueId,
             throws JsonMappingException
         {
             if (!(valueId instanceof String)) {
-                ctxt.reportBadDefinition(ClassUtil.classOf(valueId),
+                throw ctxt.missingInjectableValueException(
                         String.format(
-                        "Unrecognized inject value id type (%s), expecting String",
-                        ClassUtil.classNameOf(valueId)));
+                        "Unsupported injectable value id type (%s), expecting String",
+                        ClassUtil.classNameOf(valueId)),
+                        valueId, forProperty, beanInstance);
             }
             String key = (String) valueId;
             Object ob = _values.get(key);
             if (ob == null && !_values.containsKey(key)) {
                 if (Boolean.FALSE.equals(optional)
                         || ((optional == null)
                                 && ctxt.isEnabled(DeserializationFeature.FAIL_ON_UNKNOWN_INJECT_VALUE))) {
-                    throw ctxt.missingInjectValueException(
+                    throw ctxt.missingInjectableValueException(
                             String.format("No injectable value with id '%s' found (for property '%s')",
                             key, forProperty.getName()),
                             valueId, forProperty, beanInstance);

src/main/java/com/fasterxml/jackson/databind/exc/MissingInjectableValueExcepion.java

@@ -0,0 +1,38 @@
+package com.fasterxml.jackson.databind.exc;
+
+import com.fasterxml.jackson.core.JsonParser;
+
+import com.fasterxml.jackson.databind.BeanProperty;
+import com.fasterxml.jackson.databind.JsonMappingException;
+
+/**
+ * @since 2.20
+ */
+public class MissingInjectableValueExcepion
+    extends JsonMappingException
+{
+    private static final long serialVersionUID = 1L;
+
+    protected final Object _valueId;
+    protected final BeanProperty _forProperty;
+    protected final Object _beanInstance;
+
+    protected MissingInjectableValueExcepion(JsonParser p, String msg,
+            Object valueId, BeanProperty forProperty, Object beanInstance)
+    {
+        super(p, msg);
+        _valueId = valueId;
+        _forProperty = forProperty;
+        _beanInstance = beanInstance;
+    }
+
+    public static MissingInjectableValueExcepion from(JsonParser p, String msg,
+            Object valueId, BeanProperty forProperty, Object beanInstance)
+    {
+        return new MissingInjectableValueExcepion(p, msg, valueId, forProperty, beanInstance);
+    }
+
+    public Object getValueId() { return _valueId; }
+    public BeanProperty getForProperty() { return _forProperty; }
+    public Object getBeanInstance() { return _beanInstance; }
+}

src/test/java/com/fasterxml/jackson/databind/deser/inject/JacksonInject3072Test.java

@@ -7,6 +7,7 @@
 
 import com.fasterxml.jackson.databind.*;
 import com.fasterxml.jackson.databind.exc.InvalidDefinitionException;
+import com.fasterxml.jackson.databind.exc.MissingInjectableValueExcepion;
 import com.fasterxml.jackson.databind.testutil.DatabindTestUtil;
 
 import static org.assertj.core.api.AssertionsForClassTypes.assertThat;
@@ -66,8 +67,8 @@ void testOptionalFieldNotFound() throws Exception {
 
     @Test
     void testMandatoryFieldNotFound() {
-        InvalidDefinitionException exception = assertThrows(
-                InvalidDefinitionException.class, () -> READER.readValue("{}"));
+        MissingInjectableValueExcepion exception = assertThrows(
+                MissingInjectableValueExcepion.class, () -> READER.readValue("{}"));
 
         assertThat(exception.getMessage())
             .startsWith("No 'injectableValues' configured, cannot inject value with id 'id'");
@@ -80,8 +81,8 @@ void testRequiredAnnotatedField() throws Exception {
         ObjectReader reader = READER.forType(DtoWithRequired.class)
             .without(DeserializationFeature.FAIL_ON_UNKNOWN_INJECT_VALUE);
 
-        InvalidDefinitionException exception = assertThrows(
-                InvalidDefinitionException.class, () -> reader.readValue("{}"));
+        MissingInjectableValueExcepion exception = assertThrows(
+                MissingInjectableValueExcepion.class, () -> reader.readValue("{}"));
 
         assertThat(exception.getMessage())
             .startsWith("No 'injectableValues' configured, cannot inject value with id 'requiredValue'");
@@ -91,7 +92,7 @@ void testRequiredAnnotatedField() throws Exception {
                 .addValue("id", "idValue"));
 
         exception = assertThrows(
-                    InvalidDefinitionException.class, () -> reader2.readValue("{}"));
+                MissingInjectableValueExcepion.class, () -> reader2.readValue("{}"));
 
         assertThat(exception.getMessage())
              .startsWith("No injectable value with id 'requiredValue' found (for property 'requiredField')");
@@ -108,8 +109,8 @@ void testMandatoryFieldNotFoundWithInjectableValues() {
         ObjectReader reader = READER
                 .with(new InjectableValues.Std());
 
-        InvalidDefinitionException exception = assertThrows(
-                InvalidDefinitionException.class, () -> reader.readValue("{}"));
+        MissingInjectableValueExcepion exception = assertThrows(
+                MissingInjectableValueExcepion.class, () -> reader.readValue("{}"));
 
         assertThat(exception.getMessage())
             .startsWith("No injectable value with id 'id' found (for property 'id')");