[BUG][JAVA] Since 6.5.0 Generated Lists no longer default to empty List but null #15891

kinsleyT · 2023-06-21T23:54:22Z

Bug Report Checklist

Have you provided a full/minimal spec to reproduce the issue?
Have you validated the input using an OpenAPI validator (example)?
Have you tested with the latest master to confirm the issue still exists?
Have you searched for related issues/PRs?
What's the actual output vs expected output?
[Optional] Sponsorship to speed up the bug fix or feature request (example)

Description

For nullable arrays, our generated POJOs in 6.5.0 (and 6.6.0) no longer generate initialized to an empty ArrayList (e.g private @Valid List<String> options = new ArrayList<>(); ), but instead are generated just as a non-initialized private variable private @Valid List<String> options;

Attempts to use containerDefaultToNull: 'false', and default: [] to hack our way through are not working: The first has no noticeable effect, and the second fails due to the generator failing to import the java.utils.Arrays package.

openapi-generator version

Using 6.4.0, breaks in 6.5.0 and 6.6.0

OpenAPI declaration file content or url

title: AttributeDto
properties:
    blah:
        type: string
        format: uuid
    ....
    options:
        description: |
            description
        type: array
        items:
            type: string
required:
    - blah

Generation Details

./gradlew generateApi

task cleanGeneratedApi (type: Delete) {
delete fileTree("${project.buildDir}/generated/api")
}

def openApiSpec = "${project.projectDir}/src/main/resources/api.yml"
// Generate REST API specification
task generateApi( type: org.openapitools.generator.gradle.plugin.tasks.GenerateTask ) {
inputSpec = openApiSpec
outputDir = "${project.buildDir}/generated/api"
templateDir = "${rootDir}/openapi"
invokerPackage = 'com.api'
apiPackage = 'com.api'
modelPackage = 'com.model'
generatorName = 'jaxrs-spec'
configOptions = [
interfaceOnly : 'true',
returnResponse : 'true',
useTags: 'true'
]
// Represent date-time objects as Timestamp rather than Date
typeMappings = [Date : "Timestamp"]
importMappings = ["java.util.Date" : "java.sql.Timestamp"]

dependsOn(cleanGeneratedApi)

}

Steps to reproduce

Model with attribute type of array, jaxrs-spec generator, configOptions as defined above
Run the gradle generate task with ./gradlew generateApi
Attempting to use obj.getOptions() returns a null value instead of an empty list as before

Related issues/PRs

Potentially related? #14583
#14959
#14961

Suggest a fix

Check if the property's type is array, initialize it with an empty ArrayList, as before.

The text was updated successfully, but these errors were encountered:

wing328 · 2023-06-22T01:18:57Z

can you please try the latest master? we recently merged a fix.

kinsleyT · 2023-06-22T23:34:14Z

This still fails to generate unfortunately: We still get

  private @Valid List<String> options;
...


  /**
   * A list of options only applicable if the attributeType is a List. 
   **/
  public AttributeDto options(List<String> options) {
    this.options = options;
    return this;
  }

  
  @ApiModelProperty(value = "A list of options only applicable if the attributeType is a List. ")
  @JsonProperty("options")
  public List<String> getOptions() {
    return options;
  }

  @JsonProperty("options")
  public void setOptions(List<String> options) {
    this.options = options;
  }

  public AttributeDto addOptionsItem(String optionsItem) {
    if (this.options == null) {
      this.options = new ArrayList<>();
    }

    this.options.add(optionsItem);
    return this;
  }

  public AttributeDto removeOptionsItem(String optionsItem) {
    if (optionsItem != null && this.options != null) {
      this.options.remove(optionsItem);
    }

    return this;
  }

We'd want to either initialize to an empty List or when attempting to get or set initialize that list and check for its existence for parity with past behavior

wing328 · 2023-06-23T02:09:51Z

can you please share a minimal spec to reproduce the issue?

kinsleyT · 2023-06-23T22:45:01Z

Spec used

openapi: 3.0.3

info:
    title: Test API
    version: 1.0.0

paths:
    /test:
         post:
            summary: Test
            operationId: test
            requestBody:
                content:
                    application/json:
                        schema:
                            type: array
                            items:
                                $ref: '#/components/schemas/TestSchema'
            responses:
              '200':
                description: Created
components:
    schemas:
        TestSchema:
            type: object
            properties:
              options:
                description: |
                    A list of options
                type: array
                items:
                    type: string

Output model file:

package org.openapitools.model;

import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import java.util.ArrayList;
import java.util.List;
import javax.validation.constraints.*;
import javax.validation.Valid;

import io.swagger.annotations.*;
import java.util.Objects;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonValue;
import com.fasterxml.jackson.annotation.JsonTypeName;



@JsonTypeName("TestSchema")
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaJAXRSSpecServerCodegen", date = "2023-06-23T15:43:33.853525-07:00[America/Los_Angeles]")
public class TestSchema   {
  private @Valid List<String> options;

  /**
   * A list of options 
   **/
  public TestSchema options(List<String> options) {
    this.options = options;
    return this;
  }

  
  @ApiModelProperty(value = "A list of options ")
  @JsonProperty("options")
  public List<String> getOptions() {
    return options;
  }

  @JsonProperty("options")
  public void setOptions(List<String> options) {
    this.options = options;
  }

  public TestSchema addOptionsItem(String optionsItem) {
    if (this.options == null) {
      this.options = new ArrayList<>();
    }

    this.options.add(optionsItem);
    return this;
  }

  public TestSchema removeOptionsItem(String optionsItem) {
    if (optionsItem != null && this.options != null) {
      this.options.remove(optionsItem);
    }

    return this;
  }

  @Override
  public boolean equals(Object o) {
    if (this == o) {
      return true;
    }
    if (o == null || getClass() != o.getClass()) {
      return false;
    }
    TestSchema testSchema = (TestSchema) o;
    return Objects.equals(this.options, testSchema.options);
  }

  @Override
  public int hashCode() {
    return Objects.hash(options);
  }

  @Override
  public String toString() {
    StringBuilder sb = new StringBuilder();
    sb.append("class TestSchema {\n");
    
    sb.append("    options: ").append(toIndentedString(options)).append("\n");
    sb.append("}");
    return sb.toString();
  }

  /**
   * Convert the given object to string with each line indented by 4 spaces
   * (except the first line).
   */
  private String toIndentedString(Object o) {
    if (o == null) {
      return "null";
    }
    return o.toString().replace("\n", "\n    ");
  }


}

Generated off latest master using command line: java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate -g jaxrs-spec -i ... etc

Example when generated off of 6.4.0 gradle plugin

package org.openapitools.model;

import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import java.util.ArrayList;
import java.util.List;
import javax.validation.constraints.*;
import javax.validation.Valid;

import io.swagger.annotations.*;
import java.util.Objects;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonValue;
import com.fasterxml.jackson.annotation.JsonTypeName;



@JsonTypeName("TestSchema")
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaJAXRSSpecServerCodegen", date = "2023-06-23T15:56:21.770244-07:00[America/Los_Angeles]")
public class TestSchema   {
  private @Valid List<String> options = new ArrayList<>();

  /**
   * A list of options 
   **/
  public TestSchema options(List<String> options) {
    this.options = options;
    return this;
  }

  
  @ApiModelProperty(value = "A list of options ")
  @JsonProperty("options")
  public List<String> getOptions() {
    return options;
  }

  @JsonProperty("options")
  public void setOptions(List<String> options) {
    this.options = options;
  }

  public TestSchema addOptionsItem(String optionsItem) {
    if (this.options == null) {
      this.options = new ArrayList<>();
    }

    this.options.add(optionsItem);
    return this;
  }

  public TestSchema removeOptionsItem(String optionsItem) {
    if (optionsItem != null && this.options != null) {
      this.options.remove(optionsItem);
    }

    return this;
  }

  @Override
  public boolean equals(Object o) {
    if (this == o) {
      return true;
    }
    if (o == null || getClass() != o.getClass()) {
      return false;
    }
    TestSchema testSchema = (TestSchema) o;
    return Objects.equals(this.options, testSchema.options);
  }

  @Override
  public int hashCode() {
    return Objects.hash(options);
  }

  @Override
  public String toString() {
    StringBuilder sb = new StringBuilder();
    sb.append("class TestSchema {\n");
    
    sb.append("    options: ").append(toIndentedString(options)).append("\n");
    sb.append("}");
    return sb.toString();
  }

  /**
   * Convert the given object to string with each line indented by 4 spaces
   * (except the first line).
   */
  private String toIndentedString(Object o) {
    if (o == null) {
      return "null";
    }
    return o.toString().replace("\n", "\n    ");
  }


}

Notably I tried this with the 6.4.0 branch checkout using CLI, but it also failed to generate initializing the options to a new ArrayList<>();, so I'm not sure if this is has always failed on command line generation but worked on Gradle previously.

So to summarize:
CLI on all versions I checked (6.4.0, 6.6.0, master) all give the first response, as does Gradle 6.6.0.

Gradle 6.4.0 gives the second response (correct response)

VinceGall · 2023-07-10T09:18:26Z

Same issue (Swagger 2.0 specs).
Not required arrays should be initialized to null. Required arrays should be initialized with new ...

wing328 · 2023-07-16T02:21:37Z

can you please give it another with 7.0.0-beta released last week?

https://github.com/OpenAPITools/openapi-generator/pull/new/7.0.0-beta

kinsleyT · 2023-07-20T18:15:12Z

Hi, thanks for following up. Using the Gradle plugin id 'org.openapi.generator' version '7.0.0-beta' still leads to the same results unfortunately, and containerDefaultToNull: 'false', is still not being respected

frankjkelly · 2023-07-25T21:52:50Z

FYI just upgraded to 6.4.0 and seeing a similar thing for the Spring generator (similarly tested with 6.5.0, 6.5.0 and 7.0.0-beta and using containerDefaultToNull: true. Should I file a separate bug?
This was working for me in 5.3.1.

I had

 private Map<String, String> tags = null;

now I get

  private Map<String, String> tags = new HashMap<>();

wing328 · 2023-07-26T07:13:14Z

Another way is to add nullalble: true to the schema if you want the map to initialise with null.

The containerDefaultToNull option should work though (as a fallback). Can you please file a separate issue with a minimal spec to reproduce the issue?

frankjkelly · 2023-07-26T13:28:07Z

Thanks @wing328 that helped a little bit - the model definition now shows

  private JsonNullable<Map<String, String>> tags = JsonNullable.<Map<String, String>>undefined();

however the associated DTO objects don't seem to be aware of this change - I see the following

@JsonTypeName("signal-type")
@Generated(value = "org.openapitools.codegen.languages.SpringCodegen", date = "2023-07-26T09:25:31.425703-04:00[America/New_York]")
public class SignalType {
.
.
  @Valid
  private JsonNullable<Map<String, String>> tags = JsonNullable.undefined();
.
.
  public SignalType putTagsItem(String key, String tagsItem) {
    if (this.tags == null) {
      this.tags = new HashMap<>(); <--- This does not compile
    }
    this.tags.put(key, tagsItem); <-- Neither does this
    return this;
  }

Am I missing something?

wing328 · 2023-07-26T13:47:04Z

Can you please share a spec to reproduce the issue?

frankjkelly · 2023-07-31T12:55:04Z

@wing328 Sorry for the delay - will try to code up a spec to help repro today.

frankjkelly · 2023-08-01T13:21:35Z

@wing328 For my issue above, all my problems went away when

Upgraded to 7.0.0-beta gradle plugin
Set containerDefaultToNull : true for client code
Left containerDefaultToNull to the default(false) for server-side stubs.
Thanks for your help and advice and assistance.

wing328 · 2023-08-02T06:36:58Z

@frankjkelly thanks for confirming the fix.

twbecker · 2023-10-31T15:12:27Z

I'm seeing this also after moving from 6.3.0 to 7.0.1 but given #14875 this seems like the intended behavior. But the containerDefaultToNull option seems broken. Based on #14130 it is supposed to allow fallback to the previous behavior but it doesn't. It only allows you to opt into null defaults, not out of them.

mimkorn · 2023-11-23T16:02:37Z

We actually get an empty list always and can't get it to null.

We have a query parameter defined like

        - in: query
          name: slices
          required: false
          schema:
            type: array
            nullable: true
            items:
              type: string

It is set to be a non-required nullable array and config option containerDefaultToNull was set to true (tried false as well)
and it always generates empty array.

There's this in ApiClient generated:

public List<Pair> parameterToPairs(String collectionFormat, String name, Object value){
    List<Pair> params = new ArrayList<Pair>();

    // preconditions
    if (name == null || name.isEmpty() || value == null) return params;

as you can see, when value is null, empty arrayList is returned. This is in 6.6.0 and 7.1.0

jorgerod · 2024-03-08T12:32:49Z

Hi

Any news? Is there a workaround?

frankjkelly · 2024-03-08T13:52:42Z

Hi

Any news? Is there a workaround?

This worked for me #15891 (comment)

MelleD · 2024-03-11T15:16:31Z

@wing328 is there a reason why optional and required handles differently here:

https://github.com/OpenAPITools/openapi-generator/blob/master/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/AbstractJavaCodegen.java#L1182

I would expect for both a empty list/set when containerDefaultToNull is false

IMHO we should change this to, because the required field is not important with the containerDefaultToNull option

 if (cp.isNullable || containerDefaultToNull) {
          return null;
        }

wing328 · 2024-03-11T16:32:33Z

can you please submit a PR with the suggested fix?

MelleD · 2024-03-11T16:36:04Z

can you please submit a PR with the suggested fix?

Yes I will do

MelleD · 2024-03-12T07:49:47Z

See here: #18080

wing328 · 2024-03-18T16:49:15Z

please give it a try with the latest snapshot version: https://oss.sonatype.org/content/repositories/snapshots/org/openapitools/openapi-generator-cli/7.5.0-SNAPSHOT/

you may need a normalizer rule to rollback to previous behavior: #18128

kinsleyT added the Issue: Bug label Jun 21, 2023

jpraet mentioned this issue Sep 5, 2023

Evaluate OpenAPI tooling belgif/rest-guide#25

Closed

mimkorn mentioned this issue Nov 28, 2023

[BUG][JAVA] Generated Lists default to empty List even when using nullable: true and containerDefaultToNull: true #17206

Open

6 tasks

Benoit12345 mentioned this issue Jan 23, 2024

[BUG] [Go] XML array is always present even if nullable and not required (missing pointer on slice) #17687

Open

MelleD mentioned this issue Mar 12, 2024

Fix default empty collections when collection is optional #18080

Merged

5 tasks

wing328 closed this as completed Mar 18, 2024

jpfinne mentioned this issue May 22, 2024

[BUG][JAVA] optional collection fields are initialized since 7.5.0 #18735

Open

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[BUG][JAVA] Since 6.5.0 Generated Lists no longer default to empty List but null #15891

[BUG][JAVA] Since 6.5.0 Generated Lists no longer default to empty List but null #15891

kinsleyT commented Jun 21, 2023 •

edited

Loading

wing328 commented Jun 22, 2023

kinsleyT commented Jun 22, 2023

wing328 commented Jun 23, 2023

kinsleyT commented Jun 23, 2023 •

edited

Loading

VinceGall commented Jul 10, 2023 •

edited

Loading

wing328 commented Jul 16, 2023

kinsleyT commented Jul 20, 2023 •

edited

Loading

frankjkelly commented Jul 25, 2023 •

edited

Loading

wing328 commented Jul 26, 2023 •

edited

Loading

frankjkelly commented Jul 26, 2023 •

edited

Loading

wing328 commented Jul 26, 2023

frankjkelly commented Jul 31, 2023

frankjkelly commented Aug 1, 2023 •

edited

Loading

wing328 commented Aug 2, 2023

twbecker commented Oct 31, 2023

mimkorn commented Nov 23, 2023 •

edited

Loading

jorgerod commented Mar 8, 2024

frankjkelly commented Mar 8, 2024

MelleD commented Mar 11, 2024

wing328 commented Mar 11, 2024

MelleD commented Mar 11, 2024

MelleD commented Mar 12, 2024

wing328 commented Mar 18, 2024

[BUG][JAVA] Since 6.5.0 Generated Lists no longer default to empty List but null #15891

[BUG][JAVA] Since 6.5.0 Generated Lists no longer default to empty List but null #15891

Comments

kinsleyT commented Jun 21, 2023 • edited Loading

Bug Report Checklist

Description

openapi-generator version

OpenAPI declaration file content or url

Generation Details

Steps to reproduce

Related issues/PRs

Suggest a fix

wing328 commented Jun 22, 2023

kinsleyT commented Jun 22, 2023

wing328 commented Jun 23, 2023

kinsleyT commented Jun 23, 2023 • edited Loading

VinceGall commented Jul 10, 2023 • edited Loading

wing328 commented Jul 16, 2023

kinsleyT commented Jul 20, 2023 • edited Loading

frankjkelly commented Jul 25, 2023 • edited Loading

wing328 commented Jul 26, 2023 • edited Loading

frankjkelly commented Jul 26, 2023 • edited Loading

wing328 commented Jul 26, 2023

frankjkelly commented Jul 31, 2023

frankjkelly commented Aug 1, 2023 • edited Loading

wing328 commented Aug 2, 2023

twbecker commented Oct 31, 2023

mimkorn commented Nov 23, 2023 • edited Loading

jorgerod commented Mar 8, 2024

frankjkelly commented Mar 8, 2024

MelleD commented Mar 11, 2024

wing328 commented Mar 11, 2024

MelleD commented Mar 11, 2024

MelleD commented Mar 12, 2024

wing328 commented Mar 18, 2024

kinsleyT commented Jun 21, 2023 •

edited

Loading

kinsleyT commented Jun 23, 2023 •

edited

Loading

VinceGall commented Jul 10, 2023 •

edited

Loading

kinsleyT commented Jul 20, 2023 •

edited

Loading

frankjkelly commented Jul 25, 2023 •

edited

Loading

wing328 commented Jul 26, 2023 •

edited

Loading

frankjkelly commented Jul 26, 2023 •

edited

Loading

frankjkelly commented Aug 1, 2023 •

edited

Loading

mimkorn commented Nov 23, 2023 •

edited

Loading