@JsonUnwrapped is still broken since 2.5

[wingsofovnia]

Describe the bug

Since @JsonUnwrapped has been broken in 2.6.0 I still not able to make @JsonUnwrapped work with my Kotlin data classes despite numerous fixes:

• 2.6.0 of springdoc-openapi-starter-webmvc-ui seems to introduce a regression when using @JsonUnwrapped & @Delegate #2682
• @JsonUnwrapped is ignored in new version of lib #2856

To Reproduce

data class ContactCreateRequest(
    @JsonUnwrapped
    val person: Person,

    @Schema(required = false)
    @JsonProperty("labels", required = false)
    val labels: List<String>? = null,
)

data class Person(
    @Schema(required = true, example = "Oscar Claude Monet")
    @JsonProperty("name", required = true)
    val name: String,

    @Schema(example = "+38051231412")
    @JsonProperty("phone")
    val phone: String? = null,

    @Schema(required = true, example = "oscar.monet@lafrance.fr")
    @JsonProperty(value = "email", required = true)
    val email: String,
)

This example in a sample Spring Boot project:

• spring-demo-reproduce.zip

Dependencies

• Kotlin 2.1.10
• org.springdoc:springdoc-openapi-starter-webmvc-api:2.8.4
• org.springdoc:springdoc-openapi-starter-webmvc-ui:2.8.4
• org.springframework.boot:spring-boot-....:3.4.2

Expected Behavior (v2.5.0)

Actual Behavior (v2.8.4)

[wingsofovnia]

I did some research and figured out that while this does not work:

data class ContactCreateRequest(
	@JsonUnwrapped
	val person: Person,
)

this does:

data class ContactCreateRequest(
	@field:JsonUnwrapped // Apply @JsonUnwrapped to field
	val person: Person,
)

The decompiled byte code for those look like that:

public final class ContactCreateRequest {
   @NotNull
   private final Person person;

   public ContactCreateRequest(@JsonUnwrapped @NotNull Person person) {
      Intrinsics.checkNotNullParameter(person, "person");
      super();
      this.person = person;
   }
   
   @NotNull
   public final Person getPerson() {
      return this.person;
   }
// ....
}

vs

public final class ContactCreateRequest {
   @JsonUnwrapped
   @NotNull
   private final Person person;

   public ContactCreateRequest(@NotNull Person person) {
      Intrinsics.checkNotNullParameter(person, "person");
      super();
      this.person = person;
   }
   
   @NotNull
   public final Person getPerson() {
      return this.person;
   }
// ....
}

Funny thing is that if I try to replicate the first approach with pure Java, @JsonCreators with @JsonUnwrapped are not supported yet:

public class Book {
    private final Author author;
    private final String title;

    public Book(@JsonUnwrapped(prefix = "author_") Author author, @JsonProperty("title") String title) {
        this.author = author;
        this.title = title;
    }
}

Exception in thread "main" com.fasterxml.jackson.databind.exc.InvalidDefinitionException: Invalid type definition for type `com.example.demo.Book`: 
   Cannot define Creator parameter 0 as `@JsonUnwrapped`: combination not yet supported

This must be the Kotlin plugin doing some magic on top of default Jackson. This however is expected to change in the next Jackson minor release with FasterXML/jackson-databind#1467 merge.

Given that in this example ContactCreateRequest used for request body, it is deserialisation "view" that should be considered. It looks like the lookup for @JsonUnwrapped since 2.5.0 has been reduced to looking at field annotations only.
Both for Kotlin support and upcoming support of creators + unwrapped, I believe springdoc should bring the support back at looking for @JsonUnwrapped in creators and should distinguish between deserialisation and serialisation configurations.

[bnasslahsen]

@wingsofovnia,

There is no code in Springdoc responsible for JsonUnwrapped causing this behavior.
Looks like i will count on your deeper analysis!

[wingsofovnia]

@bnasslahsen there is though. I am afraid this is a bug in PolymorphicModelConverter#resolve.

I've just replicated the issue on 2.8.4. This condiiton:

springdoc-openapi/springdoc-openapi-starter-common/src/main/java/org/springdoc/core/converters/PolymorphicModelConverter.java

Lines 123 to 126 in 28c66e1

	for (Field field : FieldUtils.getAllFields(javaType.getRawClass())) {
	if (field.isAnnotationPresent(JsonUnwrapped.class)) {
	if (!TypeNameResolver.std.getUseFqn())
	PARENT_TYPES_TO_IGNORE.add(javaType.getRawClass().getSimpleName());

Is not going through because the annotation is on the getter, which is valid placement of this annotation too. Once I force this via debugger:

springdoc-openapi/springdoc-openapi-starter-common/src/main/java/org/springdoc/core/converters/PolymorphicModelConverter.java

Line 126 in 28c66e1

PARENT_TYPES_TO_IGNORE.add(javaType.getRawClass().getSimpleName());

The type is properly unwrapped.

Please re-open the ticket.

[bnasslahsen]

@wingsofovnia,

I am merging your PR now.

[didjoman]

Hi,
I have an issue with the fix.

If you have a class like the next one, then the isUnwrapped boolean in the PolymorphicModelConverter is now false, but it was true before :

public final class ContactCreateRequest {

   @JsonProperty(access = JsonProperty.Access.READ_ONLY)
   @JsonUnwrapped
   private final Person person;

   public ContactCreateRequest(Person person) {
      this.person = person;
   }
   
   public final Person getPerson() {
      return this.person;
   }
}

I am talking about this line:
Before, isUnwrapped was true:

springdoc-openapi/springdoc-openapi-starter-common/src/main/java/org/springdoc/core/converters/PolymorphicModelConverter.java

Lines 123 to 124 in 6b7c7eb

	for (Field field : FieldUtils.getAllFields(javaType.getRawClass())) {
	if (field.isAnnotationPresent(JsonUnwrapped.class)) {

Now, isUnwrapped is false:

springdoc-openapi/springdoc-openapi-starter-common/src/main/java/org/springdoc/core/converters/PolymorphicModelConverter.java

Lines 125 to 128 in 165f0eb

	BeanDescription javaTypeIntrospection = springDocObjectMapper.jsonMapper().getDeserializationConfig().introspect(javaType);
	for (BeanPropertyDefinition property : javaTypeIntrospection.findProperties()) {
	boolean isUnwrapped = (property.getField() != null && property.getField().hasAnnotation(JsonUnwrapped.class)) ||
	(property.getGetter() != null && property.getGetter().hasAnnotation(JsonUnwrapped.class));

Wouldn't there be an other way to get the annotation ?

[wingsofovnia]

Thank you, @didjoman, for reporting. Filed #2909 to fix it.

On that note, are you using read only / write only fields extensively for GET/POST requests? I couldn't find any test that checks for readOnly: true or writeOnly: true. Is it supported by springdoc at all?

[wingsofovnia]

@didjoman #2909 merged, you should be all good with the upcoming patch or minor version. Thank you for the report!