[java][jackson] fix double serialization of discriminator

Merged
DS
9mo ago
+5-1

This change fixes this issue #22923

The implementation now includes a conditional @JsonTypeInfo which doesn't change default behavior, but if disableDiscriminatorFieldIgnore is set to true the include parameter will be set to JsonyTypeInfo.As.EXISTING_PROPERTY.
This will prevent the discriminator from being serialized twice.

@bbdouglas (2017/07) @sreeshas (2017/08) @jfiala (2017/08) @lukoyanov (2017/09) @cbornet (2017/09) @jeff9finger (2018/01) @karismann (2019/03) @Zomzog (2019/04) @lwlee2608 (2019/10) @martin-mfg (2023/08)

PR checklist

  • Read the contribution guidelines.
  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • Run the following to build the project and update samples: 
    ./mvnw clean package || exit
./bin/generate-samples.sh ./bin/configs/*.yaml || exit
./bin/utils/export_docs_generators.sh || exit
    (For Windows users, please run the script in WSL)
    Commit all changed files.
    This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
    These must match the expectations made by your contribution.
    You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*.
    IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
  • File the PR against the correct branch: master (upcoming 7.x.0 minor release - breaking changes with fallbacks), 8.0.x (breaking changes without fallbacks)
  • If your PR solves a reported issue, reference it using GitHub's linking syntax (e.g., having "fixes #123" present in the PR description)
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

Summary by cubic

Prevents double serialization of the discriminator in Java (Jackson) models by making @JsonTypeInfo include conditional. Defaults to PROPERTY; when discriminator field ignore is disabled, uses EXISTING_PROPERTY to avoid duplicate output. Fixes #22923.

  • Bug Fixes
    • Update typeInfoAnnotation.mustache to use JsonTypeInfo.As.PROPERTY by default.
    • When disableDiscriminatorJsonIgnoreProperties/disableDiscriminatorFieldIgnore is true, use JsonTypeInfo.As.EXISTING_PROPERTY so Jackson reuses the existing discriminator field instead of adding another.