Skip to content
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.

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

[Java][Jersey2] Add JsonTypeName annotation #6551

Merged
merged 63 commits into from
Jul 18, 2020

Conversation

sebastien-rosset
Copy link
Contributor

@sebastien-rosset sebastien-rosset commented Jun 4, 2020

This is a fix for #6462.

When a schema name includes special characters such as ".", the name of the generated Java is different from the OpenAPI schema name. For example, when the name of the schema is _special_model.name_ in the OAS doc, the name of the generated class is SpecialModelName.

This PR adds a mapping in the @JsonSubTypes annotation to ensure serialization/deserialization works as expected.

Without this PR, I am getting the following error:

Caused by: com.fasterxml.jackson.databind.exc.InvalidTypeIdException: Could not resolve type id 'aaa.AuditRecord.List' as a subtype of `.....AaaAuditRecordList`: known type ids = [AaaAuditRecordList]
 at [Source: (org.glassfish.jersey.message.internal.ReaderInterceptorExecutor$UnCloseableInputStream); line: 2, column: 17]
	at com.fasterxml.jackson.databind.exc.InvalidTypeIdException.from(InvalidTypeIdException.java:43)
	at com.fasterxml.jackson.databind.DeserializationContext.invalidTypeIdException(DeserializationContext.java:1761)
	at com.fasterxml.jackson.databind.DeserializationContext.handleUnknownTypeId(DeserializationContext.java:1268)
	at com.fasterxml.jackson.databind.jsontype.impl.TypeDeserializerBase._handleUnknownTypeId(TypeDeserializerBase.java:290)
	at com.fasterxml.jackson.databind.jsontype.impl.TypeDeserializerBase._findDeserializer(TypeDeserializerBase.java:162)
	at com.fasterxml.jackson.databind.jsontype.impl.AsPropertyTypeDeserializer._deserializeTypedForId(AsPropertyTypeDeserializer.java:113)
	at com.fasterxml.jackson.databind.jsontype.impl.AsPropertyTypeDeserializer.deserializeTypedFromObject(AsPropertyTypeDeserializer.java:97)
	at com.fasterxml.jackson.databind.deser.BeanDeserializerBase.deserializeWithType(BeanDeserializerBase.java:1196)
	at com.fasterxml.jackson.databind.deser.impl.TypeWrappedDeserializer.deserialize(TypeWrappedDeserializer.java:68)
	at com.fasterxml.jackson.databind.ObjectReader._bind(ObjectReader.java:1682)
	at com.fasterxml.jackson.databind.ObjectReader.readValue(ObjectReader.java:977)
	at org.glassfish.jersey.jackson.internal.jackson.jaxrs.base.ProviderBase.readFrom(ProviderBase.java:837)

PR checklist

  • Read the contribution guidelines.
  • If contributing template-only or documentation-only changes which will change sample output, build the project before.
  • Run the shell script(s) under ./bin/ (or Windows batch scripts under.\bin\windows) to update Petstore samples related to your fix. This is important, as CI jobs will verify all generator outputs of your HEAD commit, and these must match the expectations made by your contribution. You only need to run ./bin/{LANG}-petstore.sh, ./bin/openapi3/{LANG}-petstore.sh if updating the code or mustache templates for a language ({LANG}) (e.g. php, ruby, python, etc).
  • File the PR against the correct branch: master, 4.3.x, 5.0.x. Default: master.
  • Copy the technical committee to review the pull request if your PR is targeting a particular programming language.

@@ -5,4 +5,7 @@
{{#discriminator.mappedModels}}
@JsonSubTypes.Type(value = {{modelName}}.class, name = "{{^vendorExtensions.x-discriminator-value}}{{mappingName}}{{/vendorExtensions.x-discriminator-value}}{{#vendorExtensions.x-discriminator-value}}{{{vendorExtensions.x-discriminator-value}}}{{/vendorExtensions.x-discriminator-value}}"),
{{/discriminator.mappedModels}}
{{#isClassnameSanitized}}
@JsonSubTypes.Type(value = {{classname}}.class, name = "{{name}}"),
Copy link
Contributor Author

@sebastien-rosset sebastien-rosset Jul 7, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When the OpenAPI schema name has special characters, we need to have a mapping between the class name and the OpenAPI name.

For example, if the OpenAPI schema name is MySchemaName._-Characters, then the generated code should have a @JsonSubTypes.Type mapping as shown below.

@JsonSubTypes({
  @JsonSubTypes.Type(value = MySchemaNameCharacters.class, name = "MySchemaName._-Characters"),
})

public class MySchemaNameCharacters extends Parent {

# A string is a sequence of zero or more Unicode characters [UNICODE].
# Note that this citation references the latest version of Unicode
# rather than a specific release. Any character may be escaped.
# MySchemaNameWithUnusual#$12.3!@#%🍇🍅😀🏄🏾‍♂️Characters:
Copy link
Contributor Author

@sebastien-rosset sebastien-rosset Jul 13, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@wing328 , fyi MySchemaNameWithUnusual#$12.3!@#%🍇🍅😀🏄🏾‍♂️Characters is a valid JSON schema name, but OpenAPI generator does not allow this.

@sebastien-rosset
Copy link
Contributor Author

sebastien-rosset commented Jul 14, 2020

There are two unit tests:

  1. Unmarshal schema object with discriminator that does not have special characters:
    https://github.com/OpenAPITools/openapi-generator/pull/6551/files#diff-1e19593f04baed57a09c82d4ae1ee29cR43

  2. Unmarshal schema object with discriminator that has special characters:
    https://github.com/OpenAPITools/openapi-generator/pull/6551/files#diff-c899dee0e475c27980f0361141998efcR42

To run the unit tests:

  1. Generate the sample Java client from the java-jersey2-special-characters.yaml schema:
bin/generate-samples.sh bin/configs/java-jersey2-special-characters.yaml
  1. Run the unit tests. This should succeed.
cd samples/openapi3/client/petstore/java/jersey2-java8-special-characters/
mvn package
  1. To show without this PR, the same unit test fails in master, you can comment out the following line in the mustache template:
//@JsonSubTypes.Type(value = {{classname}}.class, name = "{{name}}"),

@wing328 wing328 changed the title [Java][Jersey2] Add missing JsonSubtypes annotation [Java][Jersey2] Add JsonTypeName annotation Jul 18, 2020
@wing328 wing328 added this to the 5.0.0 milestone Jul 18, 2020
@wing328 wing328 merged commit 968f32b into OpenAPITools:master Jul 18, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants