Skip to content

[kotlin] fix: enumUnknownDefaultCase's moshi fallback adapters break nullable enum fields #24894

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.

Sign up for GitHub

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

Open
wiebren wants to merge 1 commit into
base: master
Choose a base branch
from
+36 −7
Open

[kotlin] fix: enumUnknownDefaultCase's moshi fallback adapters break nullable enum fields #24894

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions ...r/src/main/resources/kotlin-client/jvm-common/infrastructure/SerializerHelper.kt.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ import com.squareup.moshi.adapters.EnumJsonAdapter
{{#enumVars}}
{{#-last}}
.add({{modelPackage}}.{{classname}}::class.java, EnumJsonAdapter.create({{modelPackage}}.{{classname}}::class.java)
.withUnknownFallback({{modelPackage}}.{{classname}}.{{&name}}))
.withUnknownFallback({{modelPackage}}.{{classname}}.{{&name}}).nullSafe())
{{/-last}}
{{/enumVars}}
{{/allowableValues}}
Expand All @@ -33,7 +33,7 @@ import com.squareup.moshi.adapters.EnumJsonAdapter
{{#enumVars}}
{{#-last}}
.add({{modelPackage}}.{{classname}}.{{{nameInPascalCase}}}::class.java, EnumJsonAdapter.create({{modelPackage}}.{{classname}}.{{{nameInPascalCase}}}::class.java)
.withUnknownFallback({{modelPackage}}.{{classname}}.{{{nameInPascalCase}}}.{{&name}}))
.withUnknownFallback({{modelPackage}}.{{classname}}.{{{nameInPascalCase}}}.{{&name}}).nullSafe())
{{/-last}}
{{/enumVars}}
{{/allowableValues}}
Expand Down
29 changes: 29 additions & 0 deletions ...generator/src/test/java/org/openapitools/codegen/kotlin/KotlinClientCodegenModelTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -988,6 +988,35 @@ public void testJacksonEnumsExposeDecodeOrNullHelper() throws IOException {
"Expected exactly one @JsonCreator annotation in the generated enum, found " + jsonCreatorCount);
}

@Test
public void testMoshiEnumUnknownDefaultCaseAdaptersAreNullSafe() throws IOException {
File output = Files.createTempDirectory("test").toFile();
output.deleteOnExit();

final CodegenConfigurator configurator = new CodegenConfigurator()
.setGeneratorName(KOTLIN_GENERATOR)
.setLibrary("jvm-okhttp4")
.setAdditionalProperties(new HashMap<>() {{
put(CodegenConstants.SERIALIZATION_LIBRARY, "moshi");
put(CodegenConstants.ENUM_UNKNOWN_DEFAULT_CASE, "true");
}})
.setInputSpec("src/test/resources/3_0/enum.yaml")
.setOutputDir(output.getAbsolutePath().replace("\\", "/"));

final ClientOptInput clientOptInput = configurator.toClientOptInput();
DefaultGenerator generator = new DefaultGenerator();

generator.opts(clientOptInput).generate();

final Path helperKt = Paths.get(output + "/src/main/kotlin/org/openapitools/client/infrastructure/SerializerHelper.kt");

// EnumJsonAdapter is not null-safe: registered bare, any model with a nullable enum
// property throws "value was null! Wrap in .nullSafe() to write nullable values" on
// a null value - reading and writing alike - so the flag broke every optional enum field
TestUtils.assertFileContains(helperKt, ".nullSafe())");
TestUtils.assertFileNotContains(helperKt, "unknown_default_open_api))");
}

@Test
public void testJacksonEnumsWithUnknownDefaultCase() throws IOException {
File output = Files.createTempDirectory("test").toFile();
Expand Down
10 changes: 5 additions & 5 deletions ...-default-value/src/main/kotlin/org/openapitools/client/infrastructure/SerializerHelper.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,14 @@ object SerializerHelper {
fun addEnumUnknownDefaultCase(moshiBuilder: Moshi.Builder): Moshi.Builder {
return moshiBuilder
.add(org.openapitools.client.models.ComplexEnum::class.java, EnumJsonAdapter.create(org.openapitools.client.models.ComplexEnum::class.java)
.withUnknownFallback(org.openapitools.client.models.ComplexEnum.unknown_default_open_api))
.withUnknownFallback(org.openapitools.client.models.ComplexEnum.unknown_default_open_api).nullSafe())
.add(org.openapitools.client.models.ModelWithEnumPropertyHavingDefault.PropertyName::class.java, EnumJsonAdapter.create(org.openapitools.client.models.ModelWithEnumPropertyHavingDefault.PropertyName::class.java)
.withUnknownFallback(org.openapitools.client.models.ModelWithEnumPropertyHavingDefault.PropertyName.unknown_default_open_api))
.withUnknownFallback(org.openapitools.client.models.ModelWithEnumPropertyHavingDefault.PropertyName.unknown_default_open_api).nullSafe())
.add(org.openapitools.client.models.PropertyOfDay.DaysOfWeek::class.java, EnumJsonAdapter.create(org.openapitools.client.models.PropertyOfDay.DaysOfWeek::class.java)
.withUnknownFallback(org.openapitools.client.models.PropertyOfDay.DaysOfWeek.unknown_default_open_api))
.withUnknownFallback(org.openapitools.client.models.PropertyOfDay.DaysOfWeek.unknown_default_open_api).nullSafe())
.add(org.openapitools.client.models.PropertyOfDay.MonthOfYear::class.java, EnumJsonAdapter.create(org.openapitools.client.models.PropertyOfDay.MonthOfYear::class.java)
.withUnknownFallback(org.openapitools.client.models.PropertyOfDay.MonthOfYear.unknown_default_open_api))
.withUnknownFallback(org.openapitools.client.models.PropertyOfDay.MonthOfYear.unknown_default_open_api).nullSafe())
.add(org.openapitools.client.models.PropertyOfDay.HolidayTypes::class.java, EnumJsonAdapter.create(org.openapitools.client.models.PropertyOfDay.HolidayTypes::class.java)
.withUnknownFallback(org.openapitools.client.models.PropertyOfDay.HolidayTypes.unknown_default_open_api))
.withUnknownFallback(org.openapitools.client.models.PropertyOfDay.HolidayTypes.unknown_default_open_api).nullSafe())
}
}
Loading