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

Jump to bottom

Fix issues 4697 and 2461 (`@JsonUnwrapped` caching) #4722

Merged

cowtowncoder merged 8 commits into FasterXML:2.19 from SandeepGaur2016:fix-4697-2461

Oct 3, 2024

+37 −8

Contributor

SandeepGaur2016 commented Sep 29, 2024 •

edited by cowtowncoder

Loading

I recently raised a bug (4697) and have now had some time to investigate the issue. Although this is my first contribution, I noticed that when we obtain a serializer from the case, the name transformation is reset in the _findAndAddDynamic method of UnwrappingBeanPropertyWriter. However, this method does not account for inner or nested properties. I have implemented a fix to reinitialize the serializer in such cases.

It has also fixed looks same issue from raised earlier (#2461)

Thanks,
Sandeep Gaur


          Fixed issues 4697 and 2461

a996e3d

SandeepGaur2016 mentioned this pull request

Inconsistent serialization with @JsonUnwrapped annotation using shared vs. new ObjectMapper instances #4697

Closed

1 task

SandeepGaur2016 added 2 commits

September 29, 2024 19:46


          removed unwanted changes pushed in last commit

0a304a1


          removed unwanted changes pushed in last commit

1d24c26

JooHyukKim reviewed

View reviewed changes

Member

JooHyukKim left a comment

Added a few notes, thanks!

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

src/main/java/com/fasterxml/jackson/databind/ser/BeanPropertyWriter.java Outdated

@@ @@ -459,7 +470,7 @@ Object readResolve() { @@
                           _field = null;
                       }
                       if (_serializer == null) {
-                          _dynamicSerializers = PropertySerializerMap.emptyForProperties();
+                          _dynamicSerializers = emptyForProperties();

Member

JooHyukKim Sep 29, 2024

Here also, unncessary change (at least for this PR).

Contributor Author

SandeepGaur2016 Sep 29, 2024

done, though it was a clean way to import statically

Member

cowtowncoder Sep 30, 2024

I prefer avoiding static imports for method calls fwtw. Maybe that should be added in style guide (or maybe it is mentioned and CONTRIBUTING.md should refer). I know IDEs can show where method comes from but for me (and I realize this is matter of preference) little bit of redundancy can be helpful.

src/main/java/com/fasterxml/jackson/databind/ser/BeanPropertyWriter.java Outdated

Comment on lines 329 to 334

+                      if(base instanceof UnwrappingBeanPropertyWriter) {
+                          _dynamicSerializers =
+                                  emptyForProperties();
+                      } else {
+                          _dynamicSerializers = base._dynamicSerializers;
+                      }

Member

JooHyukKim Sep 29, 2024

Keep the format consistent.

Contributor Author

SandeepGaur2016 Sep 29, 2024

Agreed, I will set the formatter.

src/main/java/com/fasterxml/jackson/databind/ser/BeanPropertyWriter.java Outdated

Comment on lines 359 to 365

+                      if(base instanceof UnwrappingBeanPropertyWriter) {
+                          _dynamicSerializers =
+                                  emptyForProperties();
+                      } else {
+                          _dynamicSerializers = base._dynamicSerializers;
+                      }
+              		_suppressNulls = base._suppressNulls;

Member

JooHyukKim Sep 29, 2024

Formatting needs to be done.

Contributor Author

SandeepGaur2016 Sep 29, 2024

done

src/main/java/com/fasterxml/jackson/databind/ser/BeanPropertyWriter.java Outdated

                                   base._internalSettings);
                       }
                       _cfgSerializationType = base._cfgSerializationType;
-                      _dynamicSerializers = base._dynamicSerializers;
+                      if(base instanceof UnwrappingBeanPropertyWriter) {

Member

JooHyukKim Sep 29, 2024

Dependency from super class to subclasses doesn't seem to be the right direction.

Contributor Author

SandeepGaur2016 Sep 29, 2024

Yes, did the same thing in a better way now


          Minor chnages as per review comments

6ed3cda

JooHyukKim reviewed

View reviewed changes

src/main/java/com/fasterxml/jackson/databind/ser/BeanPropertyWriter.java Outdated

Comment on lines 359 to 363

+                          _dynamicSerializers = PropertySerializerMap.emptyForProperties();
+                      } else {
+                          _dynamicSerializers = base._dynamicSerializers;
+                      }
+              		_suppressNulls = base._suppressNulls;

Member

JooHyukKim Sep 29, 2024

Where are these constructors called? Does this mean serializer information from 'base' should be lost?

Member

cowtowncoder Sep 30, 2024

_dynamicSerializers is purely performance optimization, caching to avoid unnecessary full introspection -- should never be needed for correctness. Hence if necessary we can just use empty instance for copy constructors.

cowtowncoder reviewed

View reviewed changes

src/main/java/com/fasterxml/jackson/databind/ser/BeanPropertyWriter.java Outdated

                                   base._internalSettings);
                       }
                       _cfgSerializationType = base._cfgSerializationType;
-                      _dynamicSerializers = base._dynamicSerializers;
+                      if (base.needToResetSerialization()) {

Member

cowtowncoder Sep 30, 2024

I am not sure check is needed, should probably simply reset always; I'll add a general note to PR.

cowtowncoder reviewed

View reviewed changes

src/main/java/com/fasterxml/jackson/databind/ser/PropertyWriter.java Outdated

                   /**********************************************************
                    */
+                  /**
+                   * A way to reset serialization to correctly populate serializer

Member

cowtowncoder Sep 30, 2024

This unfortunately doesn't really describe anything....

Member

cowtowncoder commented Sep 30, 2024

Ok: first of all, yes, it does sound like (and makes sense, too) that the issue is incorrect caching of resolved serializers: _dynamicSerializers is strictly for performance optimization. As such, maybe we should just be more aggressively clearing it on copy constructors: I'm fine not requiring checker method for trying to figure out.

Alternatively there is an existing method BeanPropertyWriter.isUnwrapping() which could (and for practical reasons I'd argue) and should be called instead of adding a new method.

But it seems to me simplest to just re-initialize -- empty instances are shared stateless singletons so there's no real cost for constructing. And in most cases this makes no difference anyway.


          Minor chnages as per review comments

db03c14

Contributor Author

SandeepGaur2016 commented Sep 30, 2024 •

edited

Loading

Hi,
I have removed the condition of UnwrappingBeanPropertyWrite, I simply set the _dynamicSerializers as empty list.

Thanks,
Sandeep gaur


          Update release notes

53fd410

cowtowncoder added cla-needed 2.19 labels


          Rm accidentally added test file

09d7973

Member

cowtowncoder commented Oct 1, 2024

Ok, happy to merge this fix. Just one process thing first: since this is (I think) your first contribution, we'd need CLA from:

https://github.com/FasterXML/jackson/blob/master/contributor-agreement.pdf

(this only needs to be done once before the first PR gets merged -- one is good for all future PRs).

It is usually easiest to print, fill & sign, scan/photo, email to cla at fasterxml dot com.
Once I get it, I'll get this merged ASAP.

Thank you again @SandeepGaur2016 for the contribution!

cowtowncoder changed the title ~~Fixed issues 4697 and 2461~~ Fix issues 4697 and 2461 (@JsonUnwrapped caching)


          Merge branch '2.19' into fix-4697-2461

a066fa6

Contributor Author

SandeepGaur2016 commented Oct 2, 2024

I have sent the CLA form.

Thanks,
Sandeep Gaur

cowtowncoder added cla-received and removed cla-needed labels

Member

cowtowncoder commented Oct 3, 2024

CLA received, can proceed!

cowtowncoder approved these changes

View reviewed changes

cowtowncoder merged commit a900b49 into FasterXML:2.19

8 checks passed

cowtowncoder added this to the 2.19.0 milestone

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

2.19 cla-received