Skip to content
GitLab
Projects Groups Snippets
  • /
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in / Register
  • O openapi-generator
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
  • Issues 3,476
    • Issues 3,476
    • List
    • Boards
    • Service Desk
    • Milestones
  • Merge requests 402
    • Merge requests 402
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Schedules
  • Deployments
    • Deployments
    • Environments
    • Releases
  • Packages and registries
    • Packages and registries
    • Package Registry
    • Infrastructure Registry
  • Monitor
    • Monitor
    • Incidents
  • Analytics
    • Analytics
    • Value stream
    • CI/CD
    • Repository
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • OpenAPI Tools
  • openapi-generator
  • Merge requests
  • !11973

[GoClient] Fixed StringIndexOutOfBoundsException when multiple properties has the same required $ref oneOf objects

  • Review changes

  • Download
  • Email patches
  • Plain diff
Merged Administrator requested to merge github/fork/kandaaaaa/master into master Mar 27, 2022
  • Overview 0
  • Commits 2
  • Pipelines 0
  • Changes 3

Created by: kandaaaaa

Go client generator will hit StringIndexOutOfBoundsException when the object (petPreference) has multiple (2+) required fields (pet1, pet2, pet3) that pointing to the same object (pet).

The code triggering the error coming from the processedMap that checks if the same model is in an infinite loop, and returns an empty string when more than two stimes cause this error.

The fix introduces the depth of the recursion to the function and the processedMap, so the processedMap tracks the depth of the model wherever it processes

Example

    pet:
      oneOf:
        - $ref: '#/components/schemas/dog'
        - $ref: '#/components/schemas/cat'
      discriminator:
        propertyName: attr
        mapping:
          DOG: '#/components/schemas/dog'
          CAT: '#/components/schemas/cat'

    petPreference:
      type: object
      required:
        - pet1
        - pet2
        - pet3
      properties:
        pet1:
          $ref: '#/components/schemas/pet'
        pet2:
          $ref: '#/components/schemas/pet'
        pet3:
          $ref: '#/components/schemas/pet'

Stacktrace:

[main] INFO  o.o.codegen.TemplateManager - writing file /local/gen/docs/PetPreference.md                                                                                                                 
Exception in thread "main" java.lang.RuntimeException: Could not generate api file for 'Pet'                                                                                                             
        at org.openapitools.codegen.DefaultGenerator.generateApis(DefaultGenerator.java:665)                                                                                                             
        at org.openapitools.codegen.DefaultGenerator.generate(DefaultGenerator.java:891)                                                                                                                 
        at org.openapitools.codegen.cmd.Generate.execute(Generate.java:441)                         
        at org.openapitools.codegen.cmd.OpenApiGeneratorCommand.run(OpenApiGeneratorCommand.java:32)                                                                                                     
        at org.openapitools.codegen.OpenAPIGenerator.main(OpenAPIGenerator.java:66)                                                                                                                      
Caused by: java.lang.StringIndexOutOfBoundsException: String index out of range: -1                                                                                                                      
        at java.base/java.lang.String.substring(Unknown Source)                                                                                                                                          
        at org.openapitools.codegen.languages.GoClientCodegen.constructExampleCode(GoClientCodegen.java:632)                                                                                             
        at org.openapitools.codegen.languages.GoClientCodegen.constructExampleCode(GoClientCodegen.java:593)                                                                                             
        at org.openapitools.codegen.languages.GoClientCodegen.constructExampleCode(GoClientCodegen.java:640)                                                                                             
        at org.openapitools.codegen.languages.GoClientCodegen.constructExampleCode(GoClientCodegen.java:523)                                                                                             
        at org.openapitools.codegen.languages.GoClientCodegen.postProcessOperationsWithModels(GoClientCodegen.java:460)                                                                                  
        at org.openapitools.codegen.DefaultGenerator.processOperations(DefaultGenerator.java:1212)  
        at org.openapitools.codegen.DefaultGenerator.generateApis(DefaultGenerator.java:568)        
        ... 4 more  

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/utils/export_docs_generators.sh
    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*. For Windows users, please run the script in Git BASH.
  • File the PR against the correct branch: master (5.3.0), 6.0.x
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

@ph4r5h4d

Assignee
Assign to
Reviewers
Request review from
Time tracking
Source branch: github/fork/kandaaaaa/master