Part of databind#3072: Make @JacksonInject not fail when there's no corresponding value #5131

giulong · 2025-05-01T17:38:48Z

As requested in #3072, deserialization will not fail if the injectable values provided to the object reader does not contain a property and:

that property is explicitly annotated with @JacksonInject(optional = OptBoolean.TRUE) or

the DeserializationFeature.FAIL_ON_UNKNOWN_INJECT_VALUE is switched off, i.e.:

new ObjectMapper()
    .reader()
    .without(DeserializationFeature.FAIL_ON_UNKNOWN_INJECT_VALUE)

⚠️ Depends on jackson-annotations#291

… optional now

…NOWN_INJECT_VALUE to determine whether to throw an exception when JacksonInject properties are not found

cowtowncoder · 2025-05-01T19:07:37Z

First of all: thank you for contributing this!

Added a note on CLA in the other PR -- only needs to be done once to cover both.

giulong · 2025-05-02T10:35:59Z

gonna provide the CLA asap

giulong · 2025-05-02T14:46:24Z

CLA just sent

cowtowncoder · 2025-05-02T22:43:46Z

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

        if (_injectableValues == null) {
-            return reportBadDefinition(ClassUtil.classOf(valueId), String.format(
-"No 'injectableValues' configured, cannot inject value with id [%s]", valueId));
+            final JacksonInject.Value injectableValue = getAnnotationIntrospector()


Ideally we would not be doing annotation introspection during actual deserialization; pretty much everything is and should be introspected during deserializer construction.
Need to figure out how to avoid that.

Agree. I opened this PR on my fork to let you evaluate the idea before pushing here a quite different approach.
Basically, I added the _optional field in the ValueInjector so that the BeanDeserializerFactory constructs them with it.

Tests are passing. If it's ok, i'll do the usual overload-and-deprecate before merging it on this one and continue the review.

Additionally: should I try to move the FAIL_ON_UNKNOWN_INJECT_VALUE feature in some other early phase, or it's fine to evaluate it in DeserializationContext and InjectableValues? We cannot do that in the same place (BeanDeserializerFactory) since it's called too early:

ObjectReader reader = newReader() // the BeanDeserializerFactory kicks in here, before de-activating the feature .without(FAIL_ON_UNKNOWN_INJECT_VALUE);

I'll have to look deeper to have an informed opinion, but by default I assume you know what you are doing (seems that way), i.e. your intuition is probably right. And yes, DeserializationFeatures can be change on per-call basis (so decision based on them need to be more dynamic), whereas annotations are static (even mix-ins) and decision likewise more dynamic. In this case we then we have "interesting" combination.

@giulong Ok yes, checking DeserializationFeature.FAIL_ON_UNKNOWN_INJECT_VALUE is cheap and can/should be done as needed, not earlier. Only annotation access need to be front-loaded.

And yes, I think the approach in referenced PR makes sense -- let's go with that!

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

cowtowncoder · 2025-05-02T22:52:20Z

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

            Object ob = _values.get(key);
            if (ob == null && !_values.containsKey(key)) {
-                throw new IllegalArgumentException("No injectable id with value '"+key+"' found (for property '"+forProperty.getName()+"')");
+                final JacksonInject.Value injectableValue = ctxt.getAnnotationIntrospector()


Same here too; really should handle introspection so we would not need to do that processing every time injectable value not found. Not sure if that is doable.

cowtowncoder · 2025-05-02T23:03:45Z

CLA just sent

Received, we are good to go wrt that.

…uring deserializer construction

…ect-spike feat(FasterXML#3072): moving JacksonInject annotation introspection during des…

cowtowncoder · 2025-05-09T22:46:33Z

src/main/java/com/fasterxml/jackson/databind/deser/impl/ValueInjector.java

    {
-        _member.setValue(beanInstance, findValue(context, beanInstance));
+        final Object value = findValue(context, beanInstance);
+        if (!JacksonInject.Value.empty().equals(value)) {


Not quite sure why this test is needed... ?

cowtowncoder · 2025-05-09T22:49:26Z

src/test/java/com/fasterxml/jackson/databind/tofix/JacksonInject3072Test.java

@@ -0,0 +1,124 @@
+package com.fasterxml.jackson.databind.tofix;


Wrong package: this is for failing tests :)

(I will move to under .../deser/inject)

cowtowncoder

LGTM. Filed #5151 for some follow-up work.

cowtowncoder · 2025-05-10T01:52:09Z

@giulong Merged and #3072 fixed -- thank you very much for contributing this!

Also realized there is older unresolved issue #1381, for which @JacksonInject.useInput was added (in Jackson 2.9) but which is not supported.
Would be great to implement that but I am not sure I have time to work on it.

giulong added 3 commits May 1, 2025 17:56

feat: jackson-databind#3072 values injected with JacksonInject can be…

2f1ccd5

… optional now

feat: jackson-databind#3072 adding DeserializationFeature.FAIL_ON_UNK…

4ad53a0

…NOWN_INJECT_VALUE to determine whether to throw an exception when JacksonInject properties are not found

Merge branch '2.x' into feature/databind-3072-optional-inject

f69e5c3

giulong changed the title ~~Part of #3072: Make @JacksonInject not fail when there's no corresponding value~~ Part of databind#3072: Make @JacksonInject not fail when there's no corresponding value May 1, 2025

cowtowncoder added cla-needed PR looks good (although may also require code review), but CLA needed from submitter 2.20 Issues planned at 2.20 or later labels May 1, 2025

cowtowncoder added cla-received PR already covered by CLA (optional label) and removed cla-needed PR looks good (although may also require code review), but CLA needed from submitter labels May 2, 2025

cowtowncoder added 3 commits May 2, 2025 15:21

Merge branch '2.x' into feature/databind-3072-optional-inject

d3e7c26

Merge branch '2.x' into feature/databind-3072-optional-inject

91af4a2

stylistic change

7b318aa

cowtowncoder reviewed May 2, 2025

View reviewed changes

src/main/java/com/fasterxml/jackson/databind/DeserializationContext.java Outdated Show resolved Hide resolved

Fix logic of global/override handling

11edc9f

cowtowncoder reviewed May 2, 2025

View reviewed changes

cowtowncoder added 3 commits May 2, 2025 15:54

More clean up

9516422

Merge branch '2.x' into feature/databind-3072-optional-inject

602bfbb

Fix test wrt fixed message

1e8b910

giulong and others added 7 commits May 3, 2025 17:12

feat(FasterXML#3072): moving JacksonInject annotation introspection d…

774deb5

…uring deserializer construction

Merge branch '2.x' into feature/databind-3072-optional-inject

f95db10

Merge branch '2.x' into feature/databind-3072-optional-inject

4d7f37e

feat(FasterXML#3072): overloading methods and deprecating old ones

edcfb22

Merge pull request #1 from giulong/feature/databind-3072-optional-inj…

c0094be

…ect-spike feat(FasterXML#3072): moving JacksonInject annotation introspection during des…

Merge branch '2.x' into feature/databind-3072-optional-inject

b9d6c92

chore(FasterXML#3072): code cleaning

91b7ff2

giulong requested a review from cowtowncoder May 9, 2025 16:48

cowtowncoder reviewed May 9, 2025

View reviewed changes

cowtowncoder added 5 commits May 9, 2025 15:51

Minor changes

2d8f9f7

Add release notes

2e094e7

Minor clean up

59fdc76

Add a test, fix problem found wrt precedence/checking

378e630

More fixes

1fcd267

cowtowncoder mentioned this pull request May 10, 2025

Add new exception type, MissingInjectValueException, to be used for failed @JacksonInject #5151

Closed

...

e88234a

cowtowncoder approved these changes May 10, 2025

View reviewed changes

Last minor test add

a7d7083

cowtowncoder merged commit f15b71d into FasterXML:2.x May 10, 2025
8 checks passed

cowtowncoder mentioned this pull request May 10, 2025

Allow specifying @JacksonInject does not fail when there's no corresponding value #3072

Closed

giulong mentioned this pull request May 21, 2025

Add a way to specify "inject-only" with @JacksonInject #1381

Open

giulong mentioned this pull request Aug 22, 2025

feat(#1381): Add a way to specify "inject-only" with @JacksonInject #5175

Open

		@@ -0,0 +1,124 @@
		package com.fasterxml.jackson.databind.tofix;

Uh oh!

Part of databind#3072: Make @JacksonInject not fail when there's no corresponding value #5131

Part of databind#3072: Make @JacksonInject not fail when there's no corresponding value #5131

Uh oh!

Conversation

giulong commented May 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

cowtowncoder commented May 1, 2025

Uh oh!

giulong commented May 2, 2025

Uh oh!

giulong commented May 2, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

cowtowncoder commented May 2, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

cowtowncoder May 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

cowtowncoder left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

cowtowncoder commented May 10, 2025

Uh oh!

Uh oh!

giulong commented May 1, 2025 •

edited

Loading

cowtowncoder May 9, 2025 •

edited

Loading