fix(kotlin-spring): add parentCtorCallNeeded model template property

[petermetz]

The new parentCtorCallNeeded property can be used by the template to
determine if there should be a constructor invocation on the parent type.

Right now its value is computed in a way that could probably use some
improvement because it is language specifically checking if the base type
is a kotlin map or not.
This might seem overly brittle, but was the only way I could differentiate
between the two different edge cases that are present in the repro spec.

This was the previous commit that changed the default behavior from one
edge case to the other (both are wrong because we can only know for sure
at generation time whether a constructor call will be necessary or not).

0bb08a7

Below is a yaml OpenAPI spec document that can be used to test/verify
the currently known edge cases (which were also mentioned in the GH
issue tracker's comments)

openapi: 3.0.3
info:
  version: "1.0.0"
  title: ""
paths:
  /documents/v1:
    get:
      responses:
        200:
          description: lorem
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: "#/components/schemas/ParentSchema"
components:
  schemas:
    JarFiles:
      type: array
      items:
        $ref: "#/components/schemas/JarFile"
    JarFile:
      type: object
      required:
      - filename
      - contentBase64
      - hasDbMigrations
      additionalProperties: true
      properties:
        filename:
          type: string
          nullable: false
          minLength: 1
          maxLength: 255
        hasDbMigrations:
          description: Indicates whether the cordapp jar in question contains any
            embedded migrations that Cactus can/should execute between copying the
            jar into the cordapp directory and starting the node back up.
          type: boolean
          nullable: false
        contentBase64:
          type: string
          format: base64
          nullable: false
          minLength: 1
          maxLength: 1073741824

    ParentSchema:
      type: object
      properties:
        id:
          type: string
        type:
          $ref: "#/components/schemas/DiscriminatingType"
      discriminator:
        propertyName: type
        mapping:
          subtypeA: "#/components/schemas/SubtypeA"
          subtypeB: "#/components/schemas/SubtypeB"
          subtypeC: "#/components/schemas/SubtypeC"
    SubtypeA:
      type: object
      allOf:
        - $ref: '#/components/schemas/ParentSchema'
        - type: object
          properties:
            subtypeAproperty:
              type: integer
    SubtypeB:
      type: object
      allOf:
        - $ref: '#/components/schemas/ParentSchema'
        - type: object
          properties:
            subtypeBproperty:
              type: string
    SubtypeC:
      type: object
      additionalProperties: true
      allOf:
        - $ref: '#/components/schemas/ParentSchema'
        - type: object
          properties:
            subtypeAproperty:
              type: integer

    DiscriminatingType:
      type: string
      enum:
        - subtypeA
        - subtypeB
        - subtypeC

Fixes #8366

Signed-off-by: Peter Somogyvari [email protected]

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 
  ./bin/generate-samples.sh ./bin/configs/*.yaml
  ./bin/utils/export_docs_generators.sh
  

  (For Windows users, please run the script in Git BASH)
  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.1.0 minor release - breaking changes with fallbacks), 8.0.x (breaking changes without fallbacks)
• If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

@jimschubert (2017/09) ❤️, @dr4ke616 (2018/08) @karismann (2019/03) @Zomzog (2019/04) @andrewemery (2019/10) @4brunu (2019/11) @yutaka0m (2020/03) @stefankoppier (2022/06)

[benjamineckstein]

Any update on this PR? I would love to have this fix released.

[petermetz]

Any update on this PR? I would love to have this fix released.

@benjamineckstein I haven't heard anything yet unfortunately.

[wing328]

these logics are only for kotlin. what about moving these to postProcessModels in abstract kotlin generators (or just kotlin spring generator) and store the value in x-is-parent-ctor-call-needed instead?

e.g.

openapi-generator/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/KotlinClientCodegen.java

Line 873 in f323a3e

for (ModelMap mo : objects.getModels()) {

[petermetz]

@wing328 Thank you for the review!

these logics are only for kotlin. what about moving these to postProcessModels in abstract kotlin generators (or just kotlin spring generator) and store the value in x-is-parent-ctor-call-needed instead

Sure, but please bear with me. I've lost the dev env in the meantime so will have to set everything up from scratch for a full test again.

Quick question: Would I also have to move property out of modules/openapi-generator/src/main/java/org/openapitools/codegen/CodegenModel.java onto some kotlin specific model (if that exists) or is that OK where it is right now?

[wing328]

openapi-generator/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/KotlinClientCodegen.java

Line 876 in f323a3e

cm.vendorExtensions.put("x-has-data-class-body", true);

is a good example where to store it