Properties with custom types inheritance fix - #18052

Merged
wing328 merged 11 commits into
OpenAPITools:masterfrom
dreambrother:custom-types-inheritance
May 15, 2024
Merged

Properties with custom types inheritance fix#18052
wing328 merged 11 commits into
OpenAPITools:masterfrom
dreambrother:custom-types-inheritance

Conversation

@dreambrother

@dreambrotherdreambrother commented Mar 7, 2024•
edited
Loading

Copy link
Copy Markdown
Contributor

Approach to deep clone Schema's introduced in #16992 breaks support for properties with custom types (added using schemaMappings or type/importMappings) when such properties are inherited using allOf. AnnotationsUtils#clone returns null for them. I've replaced AnnotationsUtils#clone with ObjectMapper's typed serialization/deserialization.

@OpenAPITools/generator-core-team

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.

@wing328

wing328 commented Mar 9, 2024

Copy link
Copy Markdown
Member

thanks for the PR

cc @martin-mfg

@wing328

wing328 commented Mar 21, 2024

Copy link
Copy Markdown
Member

@martin-mfg can you please review when you've time? thank you.

@martin-mfg

martin-mfg commented Mar 24, 2024•
edited
Loading

Copy link
Copy Markdown
Contributor

Hi,
the changes look good to me. 👍

just some additional results from my experiments, in case this PR is referenced again in the future:

  • Stringserialized = "{\"type\" : \"custom\"}";
newObjectMapper().readValue(serialized, io.swagger.v3.oas.models.media.Schema.class);

    This works. The relevant difference to what AnnotationsUtils.clone does internally is that a standard ObjectMapper is used above. In AnnotationsUtils.clone, the ObjectMapper is heavily customized.

  • AnnotationsUtils.clone(newSchema().type("custom"), false);

    This does not work. Which means that in general, using allOf is not necessary to trigger the issue. Using an unknown type is sufficient.

  • The changes in the R sample code are not related to the changed cloning logic. Updating the samples with the existing logic results in the same sample changes.

@dreambrother

dreambrother commented Apr 8, 2024

Copy link
Copy Markdown
ContributorAuthor

@wing328 I resolved conflict and removed ModelUtils.cloneSchema added here 6746be9 . It uses AnnotationUtils.clone with the same problems described in this PR

@dreambrother

dreambrother commented Apr 23, 2024

Copy link
Copy Markdown
ContributorAuthor

Any updates?

wing328
wing328 reviewed Apr 23, 2024
View reviewed changes
Comment threadmodules/openapi-generator/src/main/java/org/openapitools/codegen/utils/ModelUtils.java
// in openapi-generator, we also store type in `type` for 3.1 schema
// to make it backward compatible with the rest of the code base.
if (schema.getType() != null) {
clone.setType(schema.getType());

@wing328wing328Apr 23, 2024

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks like this logic is completely removed, right?

@dreambrotherdreambrotherApr 23, 2024

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

SchemaUtils.cloneSchema must not lose a type info after clone (instead of AnnotationUtils), so yep, I've removed it :)

@wing328wing328May 15, 2024•
edited
Loading

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

FYI. we've refactored the code a bit and no longer using type to store the actual type in 3.1 spec: #18577

@wing328wing328 added this to the 7.6.0 milestone Apr 23, 2024
wing328
wing328 reviewed Apr 23, 2024
View reviewed changes
Comment threadmodules/openapi-generator/src/main/java/org/openapitools/codegen/utils/SchemaUtils.java Outdated
return schema;
}
}
}

@wing328wing328Apr 23, 2024

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

personally i prefer not having another class SchemaUtils just for cloneSchema?

can we merge this (or add this back) into model utils instead?

@dreambrotherdreambrotherApr 23, 2024

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👌

@dreambrotherdreambrotherApr 23, 2024

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

@dreambrother

dreambrother commented May 14, 2024

Copy link
Copy Markdown
ContributorAuthor

Hi! Please notify me before merge, I'll resolve merge conflicts.

@wing328

wing328 commented May 14, 2024

Copy link
Copy Markdown
Member

Can you please do so and PM me via Slack when done?

@dreambrother

dreambrother commented May 14, 2024

Copy link
Copy Markdown
ContributorAuthor

@wing328 sorry, I don't use slack. I've resolved merge conflicts. Had to add jackson-annotations dependency explicitly, because openapi-generator right now has different minor versions of jackson in dependencies (lower for jackson-datatype-threetenbp).

wing328
wing328 reviewed May 15, 2024
View reviewed changes
Comment threadsamples/client/echo_api/r/R/data_query.R
#' @param ... Other optional arguments.
#' @export
initialize = function(`id` = NULL, `outcomes` = [SUCCESS, FAILURE], `suffix` = NULL, `text` = NULL, `date` = NULL, ...) {
initialize = function(`id` = NULL, `outcomes` = ["SUCCESS","FAILURE"], `suffix` = NULL, `text` = NULL, `date` = NULL, ...) {

@wing328wing328May 15, 2024

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

one more minor request if you don't mind. can you please add a test for the following schema:

 outcomes:
type: array
items:
type: string
enum:
- SUCCESS
- FAILURE
- SKIPPED
default:
- SUCCESS
- FAILURE

to ensure the default values are clone correctly for string enum?

@dreambrotherdreambrotherMay 15, 2024

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sure! I've added ModelUtilsTest.testCloneArrayOfEnumsSchema

@wing328

wing328 commented May 15, 2024

Copy link
Copy Markdown
Member

fyi @OpenAPITools/generator-core-team

@wing328
wing328 merged commit 70130ed into OpenAPITools:masterMay 15, 2024
@wing328

wing328 commented May 15, 2024

Copy link
Copy Markdown
Member

PR merged. Thanks again for the PR.

@wing328

wing328 commented Jun 5, 2024

Copy link
Copy Markdown
Member
[main] ERROR o.o.codegen.utils.ModelUtils - Can't clone schema class DateTimeSchema {
class Schema {
type: string
format: date-time
$ref: null
description: null
title: null
multipleOf: null
maximum: null
exclusiveMaximum: null
minimum: null
exclusiveMinimum: null
maxLength: null
minLength: null
pattern: null
maxItems: null
minItems: null
uniqueItems: null
maxProperties: null
minProperties: null
required: null
not: null
properties: null
additionalProperties: null
nullable: null
readOnly: null
writeOnly: null
example: 2020-02-02T20:20:20.000222Z
externalDocs: null
deprecated: null
discriminator: null
xml: null
}
}
com.fasterxml.jackson.databind.exc.InvalidDefinitionException: Type id handling not implemented for type java.lang.Object (by serializer of type com.fasterxml.jackson.databind.ser.impl.UnsupportedTypeSerializer) (through reference chain: io.swagger.v3.oas.models.media.DateTimeSchema["example"])
at com.fasterxml.jackson.databind.exc.InvalidDefinitionException.from(InvalidDefinitionException.java:77)
at com.fasterxml.jackson.databind.SerializerProvider.reportBadDefinition(SerializerProvider.java:1330)
at com.fasterxml.jackson.databind.DatabindContext.reportBadDefinition(DatabindContext.java:414)
at com.fasterxml.jackson.databind.JsonSerializer.serializeWithType(JsonSerializer.java:173)
at com.fasterxml.jackson.databind.ser.BeanPropertyWriter.serializeAsField(BeanPropertyWriter.java:734)
at com.fasterxml.jackson.databind.ser.std.BeanSerializerBase.serializeFields(BeanSerializerBase.java:770)
at com.fasterxml.jackson.databind.ser.std.BeanSerializerBase.serializeWithType(BeanSerializerBase.java:653)
at com.fasterxml.jackson.databind.ser.impl.TypeWrappedSerializer.serialize(TypeWrappedSerializer.java:32)
at com.fasterxml.jackson.databind.ser.DefaultSerializerProvider._serialize(DefaultSerializerProvider.java:502)
at com.fasterxml.jackson.databind.ser.DefaultSerializerProvider.serializeValue(DefaultSerializerProvider.java:341)
at com.fasterxml.jackson.databind.ObjectMapper._writeValueAndClose(ObjectMapper.java:4799)
at com.fasterxml.jackson.databind.ObjectMapper.writeValueAsString(ObjectMapper.java:4040)
at org.openapitools.codegen.utils.ModelUtils.cloneSchema(ModelUtils.java:2191)
at org.openapitools.codegen.DefaultCodegen.lambda$mergeProperties$13(DefaultCodegen.java:2865)
at java.base/java.util.LinkedHashMap.forEach(LinkedHashMap.java:721)
at org.openapitools.codegen.DefaultCodegen.mergeProperties(DefaultCodegen.java:2865)
at org.openapitools.codegen.DefaultCodegen.updateModelForComposedSchema(DefaultCodegen.java:2779)
at org.openapitools.codegen.DefaultCodegen.fromModel(DefaultCodegen.java:3120)
at org.openapitools.codegen.languages.AbstractJavaCodegen.fromModel(AbstractJavaCodegen.java:1738)
at org.openapitools.codegen.languages.JavaClientCodegen.fromModel(JavaClientCodegen.java:1055)
at org.openapitools.codegen.DefaultGenerator.processModels(DefaultGenerator.java:1757)
at org.openapitools.codegen.DefaultGenerator.generateModels(DefaultGenerator.java:525)
at org.openapitools.codegen.DefaultGenerator.generateModels(DefaultGenerator.java:449)
at org.openapitools.codegen.DefaultGenerator.generate(DefaultGenerator.java:1302)
at org.openapitools.codegen.cmd.Generate.execute(Generate.java:535)
at org.openapitools.codegen.cmd.OpenApiGeneratorCommand.run(OpenApiGeneratorCommand.java:32)
at org.openapitools.codegen.OpenAPIGenerator.main(OpenAPIGenerator.java:66)

@dreambrother can you please take a look at the above exception when you've time?

To repeat it, please run ./bin/generate-samples.sh ./bin/configs/java-okhttp-gson.yaml

@dreambrotherdreambrother mentioned this pull request Jun 5, 2024
Merged
5 tasks
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@wing328wing328wing328 left review comments
+1 more reviewer
@martin-mfgmartin-mfgmartin-mfg approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

Issue: Regression

Projects

None yet

Milestone

7.6.0

Development

Successfully merging this pull request may close these issues.

3 participants

@dreambrother@wing328@martin-mfg
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
Properties with custom types inheritance fix - #18052
Merged
wing328 merged 11 commits into
OpenAPITools:masterfrom 
dreambrother:custom-types-inheritance
May 15, 2024
Merged
Properties with custom types inheritance fix#18052
wing328 merged 11 commits into
OpenAPITools:masterfrom 
dreambrother:custom-types-inheritance
Conversation
@dreambrother
@dreambrotherdreambrother
commented
Mar 7, 2024•

edited

Loading

Copy link


Copy Markdown

Contributor
Approach to deep clone Schema's introduced in #16992 breaks support for properties with custom types (added using schemaMappings or type/importMappings) when such properties are inherited using allOf. AnnotationsUtils#clone returns null for them. I've replaced AnnotationsUtils#clone with ObjectMapper's typed serialization/deserialization.
@OpenAPITools/generator-core-team
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.
@wing328
wing328
commented
Mar 9, 2024

Copy link


Copy Markdown

Member
thanks for the PR
cc @martin-mfg
@wing328
wing328
commented
Mar 21, 2024

Copy link


Copy Markdown

Member
@martin-mfg can you please review when you've time? thank you.
@martin-mfg
martin-mfg
commented
Mar 24, 2024•

edited

Loading

Copy link


Copy Markdown

Contributor
Hi,

the changes look good to me. 👍
just some additional results from my experiments, in case this PR is referenced again in the future:
  • Stringserialized = "{\"type\" : \"custom\"}";
newObjectMapper().readValue(serialized, io.swagger.v3.oas.models.media.Schema.class);
    This works. The relevant difference to what AnnotationsUtils.clone does internally is that a standard ObjectMapper is used above. In AnnotationsUtils.clone, the ObjectMapper is heavily customized.
  • AnnotationsUtils.clone(newSchema().type("custom"), false);
    This does not work. Which means that in general, using allOf is not necessary to trigger the issue. Using an unknown type is sufficient.
  • The changes in the R sample code are not related to the changed cloning logic. Updating the samples with the existing logic results in the same sample changes.
@dreambrother
dreambrother
commented
Apr 8, 2024

Copy link


Copy Markdown

ContributorAuthor
@wing328 I resolved conflict and removed ModelUtils.cloneSchema added here 6746be9 . It uses AnnotationUtils.clone with the same problems described in this PR
@dreambrother
dreambrother
commented
Apr 23, 2024

Copy link


Copy Markdown

ContributorAuthor
Any updates?
wing328
wing328
reviewed
Apr 23, 2024
View reviewed changes
Comment threadmodules/openapi-generator/src/main/java/org/openapitools/codegen/utils/ModelUtils.java
 // in openapi-generator, we also store type in `type` for 3.1 schema
 // to make it backward compatible with the rest of the code base.
 if (schema.getType() != null) {
 clone.setType(schema.getType());
@wing328wing328Apr 23, 2024

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks like this logic is completely removed, right?
@dreambrotherdreambrotherApr 23, 2024

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

SchemaUtils.cloneSchema must not lose a type info after clone (instead of AnnotationUtils), so yep, I've removed it :)
@wing328wing328May 15, 2024•

edited

Loading

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍
FYI. we've refactored the code a bit and no longer using type to store the actual type in 3.1 spec: #18577
@wing328wing328
added this to the 7.6.0 milestone
Apr 23, 2024
wing328
wing328
reviewed
Apr 23, 2024
View reviewed changes
Comment threadmodules/openapi-generator/src/main/java/org/openapitools/codegen/utils/SchemaUtils.java
Outdated

 return schema;
 }
 }
}
@wing328wing328Apr 23, 2024

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

personally i prefer not having another class SchemaUtils just for cloneSchema?
can we merge this (or add this back) into model utils instead?
@dreambrotherdreambrotherApr 23, 2024

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👌
@dreambrotherdreambrotherApr 23, 2024

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done
@dreambrother
dreambrother
commented
May 14, 2024

Copy link


Copy Markdown

ContributorAuthor
Hi! Please notify me before merge, I'll resolve merge conflicts.
@wing328
wing328
commented
May 14, 2024

Copy link


Copy Markdown

Member
Can you please do so and PM me via Slack when done?
@dreambrother
dreambrother
commented
May 14, 2024

Copy link


Copy Markdown

ContributorAuthor
@wing328 sorry, I don't use slack. I've resolved merge conflicts. Had to add jackson-annotations dependency explicitly, because openapi-generator right now has different minor versions of jackson in dependencies (lower for jackson-datatype-threetenbp).
wing328
wing328
reviewed
May 15, 2024
View reviewed changes
Comment threadsamples/client/echo_api/r/R/data_query.R
 #' @param ... Other optional arguments.
 #' @export
 initialize = function(`id` = NULL, `outcomes` = [SUCCESS, FAILURE], `suffix` = NULL, `text` = NULL, `date` = NULL, ...) {
 initialize = function(`id` = NULL, `outcomes` = ["SUCCESS","FAILURE"], `suffix` = NULL, `text` = NULL, `date` = NULL, ...) {
@wing328wing328May 15, 2024

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

one more minor request if you don't mind. can you please add a test for the following schema:
 outcomes:
type: array
items:
type: string
enum:
- SUCCESS
- FAILURE
- SKIPPED
default:
- SUCCESS
- FAILURE

to ensure the default values are clone correctly for string enum?
@dreambrotherdreambrotherMay 15, 2024

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sure! I've added ModelUtilsTest.testCloneArrayOfEnumsSchema
@wing328
wing328
commented
May 15, 2024

Copy link


Copy Markdown

Member
fyi @OpenAPITools/generator-core-team
@wing328
wing328
merged commit 70130ed
into
OpenAPITools:masterMay 15, 2024
@wing328
wing328
commented
May 15, 2024

Copy link


Copy Markdown

Member
PR merged. Thanks again for the PR.
@wing328
wing328
commented
Jun 5, 2024

Copy link


Copy Markdown

Member
[main] ERROR o.o.codegen.utils.ModelUtils - Can't clone schema class DateTimeSchema {
class Schema {
type: string
format: date-time
$ref: null
description: null
title: null
multipleOf: null
maximum: null
exclusiveMaximum: null
minimum: null
exclusiveMinimum: null
maxLength: null
minLength: null
pattern: null
maxItems: null
minItems: null
uniqueItems: null
maxProperties: null
minProperties: null
required: null
not: null
properties: null
additionalProperties: null
nullable: null
readOnly: null
writeOnly: null
example: 2020-02-02T20:20:20.000222Z
externalDocs: null
deprecated: null
discriminator: null
xml: null
}
}
com.fasterxml.jackson.databind.exc.InvalidDefinitionException: Type id handling not implemented for type java.lang.Object (by serializer of type com.fasterxml.jackson.databind.ser.impl.UnsupportedTypeSerializer) (through reference chain: io.swagger.v3.oas.models.media.DateTimeSchema["example"])
at com.fasterxml.jackson.databind.exc.InvalidDefinitionException.from(InvalidDefinitionException.java:77)
at com.fasterxml.jackson.databind.SerializerProvider.reportBadDefinition(SerializerProvider.java:1330)
at com.fasterxml.jackson.databind.DatabindContext.reportBadDefinition(DatabindContext.java:414)
at com.fasterxml.jackson.databind.JsonSerializer.serializeWithType(JsonSerializer.java:173)
at com.fasterxml.jackson.databind.ser.BeanPropertyWriter.serializeAsField(BeanPropertyWriter.java:734)
at com.fasterxml.jackson.databind.ser.std.BeanSerializerBase.serializeFields(BeanSerializerBase.java:770)
at com.fasterxml.jackson.databind.ser.std.BeanSerializerBase.serializeWithType(BeanSerializerBase.java:653)
at com.fasterxml.jackson.databind.ser.impl.TypeWrappedSerializer.serialize(TypeWrappedSerializer.java:32)
at com.fasterxml.jackson.databind.ser.DefaultSerializerProvider._serialize(DefaultSerializerProvider.java:502)
at com.fasterxml.jackson.databind.ser.DefaultSerializerProvider.serializeValue(DefaultSerializerProvider.java:341)
at com.fasterxml.jackson.databind.ObjectMapper._writeValueAndClose(ObjectMapper.java:4799)
at com.fasterxml.jackson.databind.ObjectMapper.writeValueAsString(ObjectMapper.java:4040)
at org.openapitools.codegen.utils.ModelUtils.cloneSchema(ModelUtils.java:2191)
at org.openapitools.codegen.DefaultCodegen.lambda$mergeProperties$13(DefaultCodegen.java:2865)
at java.base/java.util.LinkedHashMap.forEach(LinkedHashMap.java:721)
at org.openapitools.codegen.DefaultCodegen.mergeProperties(DefaultCodegen.java:2865)
at org.openapitools.codegen.DefaultCodegen.updateModelForComposedSchema(DefaultCodegen.java:2779)
at org.openapitools.codegen.DefaultCodegen.fromModel(DefaultCodegen.java:3120)
at org.openapitools.codegen.languages.AbstractJavaCodegen.fromModel(AbstractJavaCodegen.java:1738)
at org.openapitools.codegen.languages.JavaClientCodegen.fromModel(JavaClientCodegen.java:1055)
at org.openapitools.codegen.DefaultGenerator.processModels(DefaultGenerator.java:1757)
at org.openapitools.codegen.DefaultGenerator.generateModels(DefaultGenerator.java:525)
at org.openapitools.codegen.DefaultGenerator.generateModels(DefaultGenerator.java:449)
at org.openapitools.codegen.DefaultGenerator.generate(DefaultGenerator.java:1302)
at org.openapitools.codegen.cmd.Generate.execute(Generate.java:535)
at org.openapitools.codegen.cmd.OpenApiGeneratorCommand.run(OpenApiGeneratorCommand.java:32)
at org.openapitools.codegen.OpenAPIGenerator.main(OpenAPIGenerator.java:66)

@dreambrother can you please take a look at the above exception when you've time?
To repeat it, please run  ./bin/generate-samples.sh ./bin/configs/java-okhttp-gson.yaml
@dreambrotherdreambrother
mentioned this pull request
Jun 5, 2024
 Merged

5 tasks
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@wing328wing328wing328 left review comments

+1 more reviewer

@martin-mfgmartin-mfgmartin-mfg approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees


No one assigned


Labels

Issue: Regression

Projects


None yet


Milestone

7.6.0

Development

Successfully merging this pull request may close these issues.

3 participants

@dreambrother@wing328@martin-mfg

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Properties with custom types inheritance fix - #18052
Merged
wing328 merged 11 commits into
OpenAPITools:masterfrom 
dreambrother:custom-types-inheritance
May 15, 2024
Merged
Properties with custom types inheritance fix#18052
wing328 merged 11 commits into
OpenAPITools:masterfrom 
dreambrother:custom-types-inheritance
Conversation
@dreambrother
@dreambrotherdreambrother
commented
Mar 7, 2024•

edited

Loading

Copy link


Copy Markdown

Contributor
Approach to deep clone Schema's introduced in #16992 breaks support for properties with custom types (added using schemaMappings or type/importMappings) when such properties are inherited using allOf. AnnotationsUtils#clone returns null for them. I've replaced AnnotationsUtils#clone with ObjectMapper's typed serialization/deserialization.
@OpenAPITools/generator-core-team
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.
@wing328
wing328
commented
Mar 9, 2024

Copy link


Copy Markdown

Member
thanks for the PR
cc @martin-mfg
@wing328
wing328
commented
Mar 21, 2024

Copy link


Copy Markdown

Member
@martin-mfg can you please review when you've time? thank you.
@martin-mfg
martin-mfg
commented
Mar 24, 2024•

edited

Loading

Copy link


Copy Markdown

Contributor
Hi,

the changes look good to me. 👍
just some additional results from my experiments, in case this PR is referenced again in the future:
  • Stringserialized = "{\"type\" : \"custom\"}";
newObjectMapper().readValue(serialized, io.swagger.v3.oas.models.media.Schema.class);
    This works. The relevant difference to what AnnotationsUtils.clone does internally is that a standard ObjectMapper is used above. In AnnotationsUtils.clone, the ObjectMapper is heavily customized.
  • AnnotationsUtils.clone(newSchema().type("custom"), false);
    This does not work. Which means that in general, using allOf is not necessary to trigger the issue. Using an unknown type is sufficient.
  • The changes in the R sample code are not related to the changed cloning logic. Updating the samples with the existing logic results in the same sample changes.
@dreambrother
dreambrother
commented
Apr 8, 2024

Copy link


Copy Markdown

ContributorAuthor
@wing328 I resolved conflict and removed ModelUtils.cloneSchema added here 6746be9 . It uses AnnotationUtils.clone with the same problems described in this PR
@dreambrother
dreambrother
commented
Apr 23, 2024

Copy link


Copy Markdown

ContributorAuthor
Any updates?
wing328
wing328
reviewed
Apr 23, 2024
View reviewed changes
Comment threadmodules/openapi-generator/src/main/java/org/openapitools/codegen/utils/ModelUtils.java
 // in openapi-generator, we also store type in `type` for 3.1 schema
 // to make it backward compatible with the rest of the code base.
 if (schema.getType() != null) {
 clone.setType(schema.getType());
@wing328wing328Apr 23, 2024

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks like this logic is completely removed, right?
@dreambrotherdreambrotherApr 23, 2024

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

SchemaUtils.cloneSchema must not lose a type info after clone (instead of AnnotationUtils), so yep, I've removed it :)
@wing328wing328May 15, 2024•

edited

Loading

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍
FYI. we've refactored the code a bit and no longer using type to store the actual type in 3.1 spec: #18577
@wing328wing328
added this to the 7.6.0 milestone
Apr 23, 2024
wing328
wing328
reviewed
Apr 23, 2024
View reviewed changes
Comment threadmodules/openapi-generator/src/main/java/org/openapitools/codegen/utils/SchemaUtils.java
Outdated

 return schema;
 }
 }
}
@wing328wing328Apr 23, 2024

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

personally i prefer not having another class SchemaUtils just for cloneSchema?
can we merge this (or add this back) into model utils instead?
@dreambrotherdreambrotherApr 23, 2024

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👌
@dreambrotherdreambrotherApr 23, 2024

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done
@dreambrother
dreambrother
commented
May 14, 2024

Copy link


Copy Markdown

ContributorAuthor
Hi! Please notify me before merge, I'll resolve merge conflicts.
@wing328
wing328
commented
May 14, 2024

Copy link


Copy Markdown

Member
Can you please do so and PM me via Slack when done?
@dreambrother
dreambrother
commented
May 14, 2024

Copy link


Copy Markdown

ContributorAuthor
@wing328 sorry, I don't use slack. I've resolved merge conflicts. Had to add jackson-annotations dependency explicitly, because openapi-generator right now has different minor versions of jackson in dependencies (lower for jackson-datatype-threetenbp).
wing328
wing328
reviewed
May 15, 2024
View reviewed changes
Comment threadsamples/client/echo_api/r/R/data_query.R
 #' @param ... Other optional arguments.
 #' @export
 initialize = function(`id` = NULL, `outcomes` = [SUCCESS, FAILURE], `suffix` = NULL, `text` = NULL, `date` = NULL, ...) {
 initialize = function(`id` = NULL, `outcomes` = ["SUCCESS","FAILURE"], `suffix` = NULL, `text` = NULL, `date` = NULL, ...) {
@wing328wing328May 15, 2024

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

one more minor request if you don't mind. can you please add a test for the following schema:
 outcomes:
type: array
items:
type: string
enum:
- SUCCESS
- FAILURE
- SKIPPED
default:
- SUCCESS
- FAILURE

to ensure the default values are clone correctly for string enum?
@dreambrotherdreambrotherMay 15, 2024

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sure! I've added ModelUtilsTest.testCloneArrayOfEnumsSchema
@wing328
wing328
commented
May 15, 2024

Copy link


Copy Markdown

Member
fyi @OpenAPITools/generator-core-team
@wing328
wing328
merged commit 70130ed
into
OpenAPITools:masterMay 15, 2024
@wing328
wing328
commented
May 15, 2024

Copy link


Copy Markdown

Member
PR merged. Thanks again for the PR.
@wing328
wing328
commented
Jun 5, 2024

Copy link


Copy Markdown

Member
[main] ERROR o.o.codegen.utils.ModelUtils - Can't clone schema class DateTimeSchema {
class Schema {
type: string
format: date-time
$ref: null
description: null
title: null
multipleOf: null
maximum: null
exclusiveMaximum: null
minimum: null
exclusiveMinimum: null
maxLength: null
minLength: null
pattern: null
maxItems: null
minItems: null
uniqueItems: null
maxProperties: null
minProperties: null
required: null
not: null
properties: null
additionalProperties: null
nullable: null
readOnly: null
writeOnly: null
example: 2020-02-02T20:20:20.000222Z
externalDocs: null
deprecated: null
discriminator: null
xml: null
}
}
com.fasterxml.jackson.databind.exc.InvalidDefinitionException: Type id handling not implemented for type java.lang.Object (by serializer of type com.fasterxml.jackson.databind.ser.impl.UnsupportedTypeSerializer) (through reference chain: io.swagger.v3.oas.models.media.DateTimeSchema["example"])
at com.fasterxml.jackson.databind.exc.InvalidDefinitionException.from(InvalidDefinitionException.java:77)
at com.fasterxml.jackson.databind.SerializerProvider.reportBadDefinition(SerializerProvider.java:1330)
at com.fasterxml.jackson.databind.DatabindContext.reportBadDefinition(DatabindContext.java:414)
at com.fasterxml.jackson.databind.JsonSerializer.serializeWithType(JsonSerializer.java:173)
at com.fasterxml.jackson.databind.ser.BeanPropertyWriter.serializeAsField(BeanPropertyWriter.java:734)
at com.fasterxml.jackson.databind.ser.std.BeanSerializerBase.serializeFields(BeanSerializerBase.java:770)
at com.fasterxml.jackson.databind.ser.std.BeanSerializerBase.serializeWithType(BeanSerializerBase.java:653)
at com.fasterxml.jackson.databind.ser.impl.TypeWrappedSerializer.serialize(TypeWrappedSerializer.java:32)
at com.fasterxml.jackson.databind.ser.DefaultSerializerProvider._serialize(DefaultSerializerProvider.java:502)
at com.fasterxml.jackson.databind.ser.DefaultSerializerProvider.serializeValue(DefaultSerializerProvider.java:341)
at com.fasterxml.jackson.databind.ObjectMapper._writeValueAndClose(ObjectMapper.java:4799)
at com.fasterxml.jackson.databind.ObjectMapper.writeValueAsString(ObjectMapper.java:4040)
at org.openapitools.codegen.utils.ModelUtils.cloneSchema(ModelUtils.java:2191)
at org.openapitools.codegen.DefaultCodegen.lambda$mergeProperties$13(DefaultCodegen.java:2865)
at java.base/java.util.LinkedHashMap.forEach(LinkedHashMap.java:721)
at org.openapitools.codegen.DefaultCodegen.mergeProperties(DefaultCodegen.java:2865)
at org.openapitools.codegen.DefaultCodegen.updateModelForComposedSchema(DefaultCodegen.java:2779)
at org.openapitools.codegen.DefaultCodegen.fromModel(DefaultCodegen.java:3120)
at org.openapitools.codegen.languages.AbstractJavaCodegen.fromModel(AbstractJavaCodegen.java:1738)
at org.openapitools.codegen.languages.JavaClientCodegen.fromModel(JavaClientCodegen.java:1055)
at org.openapitools.codegen.DefaultGenerator.processModels(DefaultGenerator.java:1757)
at org.openapitools.codegen.DefaultGenerator.generateModels(DefaultGenerator.java:525)
at org.openapitools.codegen.DefaultGenerator.generateModels(DefaultGenerator.java:449)
at org.openapitools.codegen.DefaultGenerator.generate(DefaultGenerator.java:1302)
at org.openapitools.codegen.cmd.Generate.execute(Generate.java:535)
at org.openapitools.codegen.cmd.OpenApiGeneratorCommand.run(OpenApiGeneratorCommand.java:32)
at org.openapitools.codegen.OpenAPIGenerator.main(OpenAPIGenerator.java:66)

@dreambrother can you please take a look at the above exception when you've time?
To repeat it, please run  ./bin/generate-samples.sh ./bin/configs/java-okhttp-gson.yaml
@dreambrotherdreambrother
mentioned this pull request
Jun 5, 2024
 Merged

5 tasks
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@wing328wing328wing328 left review comments

+1 more reviewer

@martin-mfgmartin-mfgmartin-mfg approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees


No one assigned


Labels

Issue: Regression

Projects


None yet


Milestone

7.6.0

Development

Successfully merging this pull request may close these issues.

3 participants

@dreambrother@wing328@martin-mfg

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Properties with custom types inheritance fix - #18052
Merged
wing328 merged 11 commits into
OpenAPITools:masterfrom 
dreambrother:custom-types-inheritance
May 15, 2024
Merged
Properties with custom types inheritance fix#18052
wing328 merged 11 commits into
OpenAPITools:masterfrom 
dreambrother:custom-types-inheritance
Conversation
@dreambrother
@dreambrotherdreambrother
commented
Mar 7, 2024•

edited

Loading

Copy link


Copy Markdown

Contributor
Approach to deep clone Schema's introduced in #16992 breaks support for properties with custom types (added using schemaMappings or type/importMappings) when such properties are inherited using allOf. AnnotationsUtils#clone returns null for them. I've replaced AnnotationsUtils#clone with ObjectMapper's typed serialization/deserialization.
@OpenAPITools/generator-core-team
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.
@wing328
wing328
commented
Mar 9, 2024

Copy link


Copy Markdown

Member
thanks for the PR
cc @martin-mfg
@wing328
wing328
commented
Mar 21, 2024

Copy link


Copy Markdown

Member
@martin-mfg can you please review when you've time? thank you.
@martin-mfg
martin-mfg
commented
Mar 24, 2024•

edited

Loading

Copy link


Copy Markdown

Contributor
Hi,

the changes look good to me. 👍
just some additional results from my experiments, in case this PR is referenced again in the future:
  • Stringserialized = "{\"type\" : \"custom\"}";
newObjectMapper().readValue(serialized, io.swagger.v3.oas.models.media.Schema.class);
    This works. The relevant difference to what AnnotationsUtils.clone does internally is that a standard ObjectMapper is used above. In AnnotationsUtils.clone, the ObjectMapper is heavily customized.
  • AnnotationsUtils.clone(newSchema().type("custom"), false);
    This does not work. Which means that in general, using allOf is not necessary to trigger the issue. Using an unknown type is sufficient.
  • The changes in the R sample code are not related to the changed cloning logic. Updating the samples with the existing logic results in the same sample changes.
@dreambrother
dreambrother
commented
Apr 8, 2024

Copy link


Copy Markdown

ContributorAuthor
@wing328 I resolved conflict and removed ModelUtils.cloneSchema added here 6746be9 . It uses AnnotationUtils.clone with the same problems described in this PR
@dreambrother
dreambrother
commented
Apr 23, 2024

Copy link


Copy Markdown

ContributorAuthor
Any updates?
wing328
wing328
reviewed
Apr 23, 2024
View reviewed changes
Comment threadmodules/openapi-generator/src/main/java/org/openapitools/codegen/utils/ModelUtils.java
 // in openapi-generator, we also store type in `type` for 3.1 schema
 // to make it backward compatible with the rest of the code base.
 if (schema.getType() != null) {
 clone.setType(schema.getType());
@wing328wing328Apr 23, 2024

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks like this logic is completely removed, right?
@dreambrotherdreambrotherApr 23, 2024

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

SchemaUtils.cloneSchema must not lose a type info after clone (instead of AnnotationUtils), so yep, I've removed it :)
@wing328wing328May 15, 2024•

edited

Loading

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍
FYI. we've refactored the code a bit and no longer using type to store the actual type in 3.1 spec: #18577
@wing328wing328
added this to the 7.6.0 milestone
Apr 23, 2024
wing328
wing328
reviewed
Apr 23, 2024
View reviewed changes
Comment threadmodules/openapi-generator/src/main/java/org/openapitools/codegen/utils/SchemaUtils.java
Outdated

 return schema;
 }
 }
}
@wing328wing328Apr 23, 2024

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

personally i prefer not having another class SchemaUtils just for cloneSchema?
can we merge this (or add this back) into model utils instead?
@dreambrotherdreambrotherApr 23, 2024

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👌
@dreambrotherdreambrotherApr 23, 2024

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done
@dreambrother
dreambrother
commented
May 14, 2024

Copy link


Copy Markdown

ContributorAuthor
Hi! Please notify me before merge, I'll resolve merge conflicts.
@wing328
wing328
commented
May 14, 2024

Copy link


Copy Markdown

Member
Can you please do so and PM me via Slack when done?
@dreambrother
dreambrother
commented
May 14, 2024

Copy link


Copy Markdown

ContributorAuthor
@wing328 sorry, I don't use slack. I've resolved merge conflicts. Had to add jackson-annotations dependency explicitly, because openapi-generator right now has different minor versions of jackson in dependencies (lower for jackson-datatype-threetenbp).
wing328
wing328
reviewed
May 15, 2024
View reviewed changes
Comment threadsamples/client/echo_api/r/R/data_query.R
 #' @param ... Other optional arguments.
 #' @export
 initialize = function(`id` = NULL, `outcomes` = [SUCCESS, FAILURE], `suffix` = NULL, `text` = NULL, `date` = NULL, ...) {
 initialize = function(`id` = NULL, `outcomes` = ["SUCCESS","FAILURE"], `suffix` = NULL, `text` = NULL, `date` = NULL, ...) {
@wing328wing328May 15, 2024

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

one more minor request if you don't mind. can you please add a test for the following schema:
 outcomes:
type: array
items:
type: string
enum:
- SUCCESS
- FAILURE
- SKIPPED
default:
- SUCCESS
- FAILURE

to ensure the default values are clone correctly for string enum?
@dreambrotherdreambrotherMay 15, 2024

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sure! I've added ModelUtilsTest.testCloneArrayOfEnumsSchema
@wing328
wing328
commented
May 15, 2024

Copy link


Copy Markdown

Member
fyi @OpenAPITools/generator-core-team
@wing328
wing328
merged commit 70130ed
into
OpenAPITools:masterMay 15, 2024
@wing328
wing328
commented
May 15, 2024

Copy link


Copy Markdown

Member
PR merged. Thanks again for the PR.
@wing328
wing328
commented
Jun 5, 2024

Copy link


Copy Markdown

Member
[main] ERROR o.o.codegen.utils.ModelUtils - Can't clone schema class DateTimeSchema {
class Schema {
type: string
format: date-time
$ref: null
description: null
title: null
multipleOf: null
maximum: null
exclusiveMaximum: null
minimum: null
exclusiveMinimum: null
maxLength: null
minLength: null
pattern: null
maxItems: null
minItems: null
uniqueItems: null
maxProperties: null
minProperties: null
required: null
not: null
properties: null
additionalProperties: null
nullable: null
readOnly: null
writeOnly: null
example: 2020-02-02T20:20:20.000222Z
externalDocs: null
deprecated: null
discriminator: null
xml: null
}
}
com.fasterxml.jackson.databind.exc.InvalidDefinitionException: Type id handling not implemented for type java.lang.Object (by serializer of type com.fasterxml.jackson.databind.ser.impl.UnsupportedTypeSerializer) (through reference chain: io.swagger.v3.oas.models.media.DateTimeSchema["example"])
at com.fasterxml.jackson.databind.exc.InvalidDefinitionException.from(InvalidDefinitionException.java:77)
at com.fasterxml.jackson.databind.SerializerProvider.reportBadDefinition(SerializerProvider.java:1330)
at com.fasterxml.jackson.databind.DatabindContext.reportBadDefinition(DatabindContext.java:414)
at com.fasterxml.jackson.databind.JsonSerializer.serializeWithType(JsonSerializer.java:173)
at com.fasterxml.jackson.databind.ser.BeanPropertyWriter.serializeAsField(BeanPropertyWriter.java:734)
at com.fasterxml.jackson.databind.ser.std.BeanSerializerBase.serializeFields(BeanSerializerBase.java:770)
at com.fasterxml.jackson.databind.ser.std.BeanSerializerBase.serializeWithType(BeanSerializerBase.java:653)
at com.fasterxml.jackson.databind.ser.impl.TypeWrappedSerializer.serialize(TypeWrappedSerializer.java:32)
at com.fasterxml.jackson.databind.ser.DefaultSerializerProvider._serialize(DefaultSerializerProvider.java:502)
at com.fasterxml.jackson.databind.ser.DefaultSerializerProvider.serializeValue(DefaultSerializerProvider.java:341)
at com.fasterxml.jackson.databind.ObjectMapper._writeValueAndClose(ObjectMapper.java:4799)
at com.fasterxml.jackson.databind.ObjectMapper.writeValueAsString(ObjectMapper.java:4040)
at org.openapitools.codegen.utils.ModelUtils.cloneSchema(ModelUtils.java:2191)
at org.openapitools.codegen.DefaultCodegen.lambda$mergeProperties$13(DefaultCodegen.java:2865)
at java.base/java.util.LinkedHashMap.forEach(LinkedHashMap.java:721)
at org.openapitools.codegen.DefaultCodegen.mergeProperties(DefaultCodegen.java:2865)
at org.openapitools.codegen.DefaultCodegen.updateModelForComposedSchema(DefaultCodegen.java:2779)
at org.openapitools.codegen.DefaultCodegen.fromModel(DefaultCodegen.java:3120)
at org.openapitools.codegen.languages.AbstractJavaCodegen.fromModel(AbstractJavaCodegen.java:1738)
at org.openapitools.codegen.languages.JavaClientCodegen.fromModel(JavaClientCodegen.java:1055)
at org.openapitools.codegen.DefaultGenerator.processModels(DefaultGenerator.java:1757)
at org.openapitools.codegen.DefaultGenerator.generateModels(DefaultGenerator.java:525)
at org.openapitools.codegen.DefaultGenerator.generateModels(DefaultGenerator.java:449)
at org.openapitools.codegen.DefaultGenerator.generate(DefaultGenerator.java:1302)
at org.openapitools.codegen.cmd.Generate.execute(Generate.java:535)
at org.openapitools.codegen.cmd.OpenApiGeneratorCommand.run(OpenApiGeneratorCommand.java:32)
at org.openapitools.codegen.OpenAPIGenerator.main(OpenAPIGenerator.java:66)

@dreambrother can you please take a look at the above exception when you've time?
To repeat it, please run  ./bin/generate-samples.sh ./bin/configs/java-okhttp-gson.yaml
@dreambrotherdreambrother
mentioned this pull request
Jun 5, 2024
 Merged

5 tasks
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@wing328wing328wing328 left review comments

+1 more reviewer

@martin-mfgmartin-mfgmartin-mfg approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees


No one assigned


Labels

Issue: Regression

Projects


None yet


Milestone

7.6.0

Development

Successfully merging this pull request may close these issues.

3 participants

@dreambrother@wing328@martin-mfg

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
Properties with custom types inheritance fix - #18052
Merged
wing328 merged 11 commits into
OpenAPITools:masterfrom 
dreambrother:custom-types-inheritance
May 15, 2024
Merged
Properties with custom types inheritance fix#18052
wing328 merged 11 commits into
OpenAPITools:masterfrom 
dreambrother:custom-types-inheritance
Conversation
@dreambrother
@dreambrotherdreambrother
commented
Mar 7, 2024•

edited

Loading

Copy link


Copy Markdown

Contributor
Approach to deep clone Schema's introduced in #16992 breaks support for properties with custom types (added using schemaMappings or type/importMappings) when such properties are inherited using allOf. AnnotationsUtils#clone returns null for them. I've replaced AnnotationsUtils#clone with ObjectMapper's typed serialization/deserialization.
@OpenAPITools/generator-core-team
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.
@wing328
wing328
commented
Mar 9, 2024

Copy link


Copy Markdown

Member
thanks for the PR
cc @martin-mfg
@wing328
wing328
commented
Mar 21, 2024

Copy link


Copy Markdown

Member
@martin-mfg can you please review when you've time? thank you.
@martin-mfg
martin-mfg
commented
Mar 24, 2024•

edited

Loading

Copy link


Copy Markdown

Contributor
Hi,

the changes look good to me. 👍
just some additional results from my experiments, in case this PR is referenced again in the future:
  • Stringserialized = "{\"type\" : \"custom\"}";
newObjectMapper().readValue(serialized, io.swagger.v3.oas.models.media.Schema.class);
    This works. The relevant difference to what AnnotationsUtils.clone does internally is that a standard ObjectMapper is used above. In AnnotationsUtils.clone, the ObjectMapper is heavily customized.
  • AnnotationsUtils.clone(newSchema().type("custom"), false);
    This does not work. Which means that in general, using allOf is not necessary to trigger the issue. Using an unknown type is sufficient.
  • The changes in the R sample code are not related to the changed cloning logic. Updating the samples with the existing logic results in the same sample changes.
@dreambrother
dreambrother
commented
Apr 8, 2024

Copy link


Copy Markdown

ContributorAuthor
@wing328 I resolved conflict and removed ModelUtils.cloneSchema added here 6746be9 . It uses AnnotationUtils.clone with the same problems described in this PR
@dreambrother
dreambrother
commented
Apr 23, 2024

Copy link


Copy Markdown

ContributorAuthor
Any updates?
wing328
wing328
reviewed
Apr 23, 2024
View reviewed changes
Comment threadmodules/openapi-generator/src/main/java/org/openapitools/codegen/utils/ModelUtils.java
 // in openapi-generator, we also store type in `type` for 3.1 schema
 // to make it backward compatible with the rest of the code base.
 if (schema.getType() != null) {
 clone.setType(schema.getType());
@wing328wing328Apr 23, 2024

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks like this logic is completely removed, right?
@dreambrotherdreambrotherApr 23, 2024

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

SchemaUtils.cloneSchema must not lose a type info after clone (instead of AnnotationUtils), so yep, I've removed it :)
@wing328wing328May 15, 2024•

edited

Loading

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍
FYI. we've refactored the code a bit and no longer using type to store the actual type in 3.1 spec: #18577
@wing328wing328
added this to the 7.6.0 milestone
Apr 23, 2024
wing328
wing328
reviewed
Apr 23, 2024
View reviewed changes
Comment threadmodules/openapi-generator/src/main/java/org/openapitools/codegen/utils/SchemaUtils.java
Outdated

 return schema;
 }
 }
}
@wing328wing328Apr 23, 2024

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

personally i prefer not having another class SchemaUtils just for cloneSchema?
can we merge this (or add this back) into model utils instead?
@dreambrotherdreambrotherApr 23, 2024

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👌
@dreambrotherdreambrotherApr 23, 2024

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done
@dreambrother
dreambrother
commented
May 14, 2024

Copy link


Copy Markdown

ContributorAuthor
Hi! Please notify me before merge, I'll resolve merge conflicts.
@wing328
wing328
commented
May 14, 2024

Copy link


Copy Markdown

Member
Can you please do so and PM me via Slack when done?
@dreambrother
dreambrother
commented
May 14, 2024

Copy link


Copy Markdown

ContributorAuthor
@wing328 sorry, I don't use slack. I've resolved merge conflicts. Had to add jackson-annotations dependency explicitly, because openapi-generator right now has different minor versions of jackson in dependencies (lower for jackson-datatype-threetenbp).
wing328
wing328
reviewed
May 15, 2024
View reviewed changes
Comment threadsamples/client/echo_api/r/R/data_query.R
 #' @param ... Other optional arguments.
 #' @export
 initialize = function(`id` = NULL, `outcomes` = [SUCCESS, FAILURE], `suffix` = NULL, `text` = NULL, `date` = NULL, ...) {
 initialize = function(`id` = NULL, `outcomes` = ["SUCCESS","FAILURE"], `suffix` = NULL, `text` = NULL, `date` = NULL, ...) {
@wing328wing328May 15, 2024

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

one more minor request if you don't mind. can you please add a test for the following schema:
 outcomes:
type: array
items:
type: string
enum:
- SUCCESS
- FAILURE
- SKIPPED
default:
- SUCCESS
- FAILURE

to ensure the default values are clone correctly for string enum?
@dreambrotherdreambrotherMay 15, 2024

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sure! I've added ModelUtilsTest.testCloneArrayOfEnumsSchema
@wing328
wing328
commented
May 15, 2024

Copy link


Copy Markdown

Member
fyi @OpenAPITools/generator-core-team
@wing328
wing328
merged commit 70130ed
into
OpenAPITools:masterMay 15, 2024
@wing328
wing328
commented
May 15, 2024

Copy link


Copy Markdown

Member
PR merged. Thanks again for the PR.
@wing328
wing328
commented
Jun 5, 2024

Copy link


Copy Markdown

Member
[main] ERROR o.o.codegen.utils.ModelUtils - Can't clone schema class DateTimeSchema {
class Schema {
type: string
format: date-time
$ref: null
description: null
title: null
multipleOf: null
maximum: null
exclusiveMaximum: null
minimum: null
exclusiveMinimum: null
maxLength: null
minLength: null
pattern: null
maxItems: null
minItems: null
uniqueItems: null
maxProperties: null
minProperties: null
required: null
not: null
properties: null
additionalProperties: null
nullable: null
readOnly: null
writeOnly: null
example: 2020-02-02T20:20:20.000222Z
externalDocs: null
deprecated: null
discriminator: null
xml: null
}
}
com.fasterxml.jackson.databind.exc.InvalidDefinitionException: Type id handling not implemented for type java.lang.Object (by serializer of type com.fasterxml.jackson.databind.ser.impl.UnsupportedTypeSerializer) (through reference chain: io.swagger.v3.oas.models.media.DateTimeSchema["example"])
at com.fasterxml.jackson.databind.exc.InvalidDefinitionException.from(InvalidDefinitionException.java:77)
at com.fasterxml.jackson.databind.SerializerProvider.reportBadDefinition(SerializerProvider.java:1330)
at com.fasterxml.jackson.databind.DatabindContext.reportBadDefinition(DatabindContext.java:414)
at com.fasterxml.jackson.databind.JsonSerializer.serializeWithType(JsonSerializer.java:173)
at com.fasterxml.jackson.databind.ser.BeanPropertyWriter.serializeAsField(BeanPropertyWriter.java:734)
at com.fasterxml.jackson.databind.ser.std.BeanSerializerBase.serializeFields(BeanSerializerBase.java:770)
at com.fasterxml.jackson.databind.ser.std.BeanSerializerBase.serializeWithType(BeanSerializerBase.java:653)
at com.fasterxml.jackson.databind.ser.impl.TypeWrappedSerializer.serialize(TypeWrappedSerializer.java:32)
at com.fasterxml.jackson.databind.ser.DefaultSerializerProvider._serialize(DefaultSerializerProvider.java:502)
at com.fasterxml.jackson.databind.ser.DefaultSerializerProvider.serializeValue(DefaultSerializerProvider.java:341)
at com.fasterxml.jackson.databind.ObjectMapper._writeValueAndClose(ObjectMapper.java:4799)
at com.fasterxml.jackson.databind.ObjectMapper.writeValueAsString(ObjectMapper.java:4040)
at org.openapitools.codegen.utils.ModelUtils.cloneSchema(ModelUtils.java:2191)
at org.openapitools.codegen.DefaultCodegen.lambda$mergeProperties$13(DefaultCodegen.java:2865)
at java.base/java.util.LinkedHashMap.forEach(LinkedHashMap.java:721)
at org.openapitools.codegen.DefaultCodegen.mergeProperties(DefaultCodegen.java:2865)
at org.openapitools.codegen.DefaultCodegen.updateModelForComposedSchema(DefaultCodegen.java:2779)
at org.openapitools.codegen.DefaultCodegen.fromModel(DefaultCodegen.java:3120)
at org.openapitools.codegen.languages.AbstractJavaCodegen.fromModel(AbstractJavaCodegen.java:1738)
at org.openapitools.codegen.languages.JavaClientCodegen.fromModel(JavaClientCodegen.java:1055)
at org.openapitools.codegen.DefaultGenerator.processModels(DefaultGenerator.java:1757)
at org.openapitools.codegen.DefaultGenerator.generateModels(DefaultGenerator.java:525)
at org.openapitools.codegen.DefaultGenerator.generateModels(DefaultGenerator.java:449)
at org.openapitools.codegen.DefaultGenerator.generate(DefaultGenerator.java:1302)
at org.openapitools.codegen.cmd.Generate.execute(Generate.java:535)
at org.openapitools.codegen.cmd.OpenApiGeneratorCommand.run(OpenApiGeneratorCommand.java:32)
at org.openapitools.codegen.OpenAPIGenerator.main(OpenAPIGenerator.java:66)

@dreambrother can you please take a look at the above exception when you've time?
To repeat it, please run  ./bin/generate-samples.sh ./bin/configs/java-okhttp-gson.yaml
@dreambrotherdreambrother
mentioned this pull request
Jun 5, 2024
 Merged

5 tasks
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@wing328wing328wing328 left review comments

+1 more reviewer

@martin-mfgmartin-mfgmartin-mfg approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees


No one assigned


Labels

Issue: Regression

Projects


None yet


Milestone

7.6.0

Development

Successfully merging this pull request may close these issues.

3 participants

@dreambrother@wing328@martin-mfg

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Properties with custom types inheritance fix - #18052
Merged
wing328 merged 11 commits into
OpenAPITools:masterfrom 
dreambrother:custom-types-inheritance
May 15, 2024
Merged
Properties with custom types inheritance fix#18052
wing328 merged 11 commits into
OpenAPITools:masterfrom 
dreambrother:custom-types-inheritance
Conversation
@dreambrother
@dreambrotherdreambrother
commented
Mar 7, 2024•

edited

Loading

Copy link


Copy Markdown

Contributor
Approach to deep clone Schema's introduced in #16992 breaks support for properties with custom types (added using schemaMappings or type/importMappings) when such properties are inherited using allOf. AnnotationsUtils#clone returns null for them. I've replaced AnnotationsUtils#clone with ObjectMapper's typed serialization/deserialization.
@OpenAPITools/generator-core-team
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.
@wing328
wing328
commented
Mar 9, 2024

Copy link


Copy Markdown

Member
thanks for the PR
cc @martin-mfg
@wing328
wing328
commented
Mar 21, 2024

Copy link


Copy Markdown

Member
@martin-mfg can you please review when you've time? thank you.
@martin-mfg
martin-mfg
commented
Mar 24, 2024•

edited

Loading

Copy link


Copy Markdown

Contributor
Hi,

the changes look good to me. 👍
just some additional results from my experiments, in case this PR is referenced again in the future:
  • Stringserialized = "{\"type\" : \"custom\"}";
newObjectMapper().readValue(serialized, io.swagger.v3.oas.models.media.Schema.class);
    This works. The relevant difference to what AnnotationsUtils.clone does internally is that a standard ObjectMapper is used above. In AnnotationsUtils.clone, the ObjectMapper is heavily customized.
  • AnnotationsUtils.clone(newSchema().type("custom"), false);
    This does not work. Which means that in general, using allOf is not necessary to trigger the issue. Using an unknown type is sufficient.
  • The changes in the R sample code are not related to the changed cloning logic. Updating the samples with the existing logic results in the same sample changes.
@dreambrother
dreambrother
commented
Apr 8, 2024

Copy link


Copy Markdown

ContributorAuthor
@wing328 I resolved conflict and removed ModelUtils.cloneSchema added here 6746be9 . It uses AnnotationUtils.clone with the same problems described in this PR
@dreambrother
dreambrother
commented
Apr 23, 2024

Copy link


Copy Markdown

ContributorAuthor
Any updates?
wing328
wing328
reviewed
Apr 23, 2024
View reviewed changes
Comment threadmodules/openapi-generator/src/main/java/org/openapitools/codegen/utils/ModelUtils.java
 // in openapi-generator, we also store type in `type` for 3.1 schema
 // to make it backward compatible with the rest of the code base.
 if (schema.getType() != null) {
 clone.setType(schema.getType());
@wing328wing328Apr 23, 2024

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks like this logic is completely removed, right?
@dreambrotherdreambrotherApr 23, 2024

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

SchemaUtils.cloneSchema must not lose a type info after clone (instead of AnnotationUtils), so yep, I've removed it :)
@wing328wing328May 15, 2024•

edited

Loading

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍
FYI. we've refactored the code a bit and no longer using type to store the actual type in 3.1 spec: #18577
@wing328wing328
added this to the 7.6.0 milestone
Apr 23, 2024
wing328
wing328
reviewed
Apr 23, 2024
View reviewed changes
Comment threadmodules/openapi-generator/src/main/java/org/openapitools/codegen/utils/SchemaUtils.java
Outdated

 return schema;
 }
 }
}
@wing328wing328Apr 23, 2024

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

personally i prefer not having another class SchemaUtils just for cloneSchema?
can we merge this (or add this back) into model utils instead?
@dreambrotherdreambrotherApr 23, 2024

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👌
@dreambrotherdreambrotherApr 23, 2024

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done
@dreambrother
dreambrother
commented
May 14, 2024

Copy link


Copy Markdown

ContributorAuthor
Hi! Please notify me before merge, I'll resolve merge conflicts.
@wing328
wing328
commented
May 14, 2024

Copy link


Copy Markdown

Member
Can you please do so and PM me via Slack when done?
@dreambrother
dreambrother
commented
May 14, 2024

Copy link


Copy Markdown

ContributorAuthor
@wing328 sorry, I don't use slack. I've resolved merge conflicts. Had to add jackson-annotations dependency explicitly, because openapi-generator right now has different minor versions of jackson in dependencies (lower for jackson-datatype-threetenbp).
wing328
wing328
reviewed
May 15, 2024
View reviewed changes
Comment threadsamples/client/echo_api/r/R/data_query.R
 #' @param ... Other optional arguments.
 #' @export
 initialize = function(`id` = NULL, `outcomes` = [SUCCESS, FAILURE], `suffix` = NULL, `text` = NULL, `date` = NULL, ...) {
 initialize = function(`id` = NULL, `outcomes` = ["SUCCESS","FAILURE"], `suffix` = NULL, `text` = NULL, `date` = NULL, ...) {
@wing328wing328May 15, 2024

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

one more minor request if you don't mind. can you please add a test for the following schema:
 outcomes:
type: array
items:
type: string
enum:
- SUCCESS
- FAILURE
- SKIPPED
default:
- SUCCESS
- FAILURE

to ensure the default values are clone correctly for string enum?
@dreambrotherdreambrotherMay 15, 2024

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sure! I've added ModelUtilsTest.testCloneArrayOfEnumsSchema
@wing328
wing328
commented
May 15, 2024

Copy link


Copy Markdown

Member
fyi @OpenAPITools/generator-core-team
@wing328
wing328
merged commit 70130ed
into
OpenAPITools:masterMay 15, 2024
@wing328
wing328
commented
May 15, 2024

Copy link


Copy Markdown

Member
PR merged. Thanks again for the PR.
@wing328
wing328
commented
Jun 5, 2024

Copy link


Copy Markdown

Member
[main] ERROR o.o.codegen.utils.ModelUtils - Can't clone schema class DateTimeSchema {
class Schema {
type: string
format: date-time
$ref: null
description: null
title: null
multipleOf: null
maximum: null
exclusiveMaximum: null
minimum: null
exclusiveMinimum: null
maxLength: null
minLength: null
pattern: null
maxItems: null
minItems: null
uniqueItems: null
maxProperties: null
minProperties: null
required: null
not: null
properties: null
additionalProperties: null
nullable: null
readOnly: null
writeOnly: null
example: 2020-02-02T20:20:20.000222Z
externalDocs: null
deprecated: null
discriminator: null
xml: null
}
}
com.fasterxml.jackson.databind.exc.InvalidDefinitionException: Type id handling not implemented for type java.lang.Object (by serializer of type com.fasterxml.jackson.databind.ser.impl.UnsupportedTypeSerializer) (through reference chain: io.swagger.v3.oas.models.media.DateTimeSchema["example"])
at com.fasterxml.jackson.databind.exc.InvalidDefinitionException.from(InvalidDefinitionException.java:77)
at com.fasterxml.jackson.databind.SerializerProvider.reportBadDefinition(SerializerProvider.java:1330)
at com.fasterxml.jackson.databind.DatabindContext.reportBadDefinition(DatabindContext.java:414)
at com.fasterxml.jackson.databind.JsonSerializer.serializeWithType(JsonSerializer.java:173)
at com.fasterxml.jackson.databind.ser.BeanPropertyWriter.serializeAsField(BeanPropertyWriter.java:734)
at com.fasterxml.jackson.databind.ser.std.BeanSerializerBase.serializeFields(BeanSerializerBase.java:770)
at com.fasterxml.jackson.databind.ser.std.BeanSerializerBase.serializeWithType(BeanSerializerBase.java:653)
at com.fasterxml.jackson.databind.ser.impl.TypeWrappedSerializer.serialize(TypeWrappedSerializer.java:32)
at com.fasterxml.jackson.databind.ser.DefaultSerializerProvider._serialize(DefaultSerializerProvider.java:502)
at com.fasterxml.jackson.databind.ser.DefaultSerializerProvider.serializeValue(DefaultSerializerProvider.java:341)
at com.fasterxml.jackson.databind.ObjectMapper._writeValueAndClose(ObjectMapper.java:4799)
at com.fasterxml.jackson.databind.ObjectMapper.writeValueAsString(ObjectMapper.java:4040)
at org.openapitools.codegen.utils.ModelUtils.cloneSchema(ModelUtils.java:2191)
at org.openapitools.codegen.DefaultCodegen.lambda$mergeProperties$13(DefaultCodegen.java:2865)
at java.base/java.util.LinkedHashMap.forEach(LinkedHashMap.java:721)
at org.openapitools.codegen.DefaultCodegen.mergeProperties(DefaultCodegen.java:2865)
at org.openapitools.codegen.DefaultCodegen.updateModelForComposedSchema(DefaultCodegen.java:2779)
at org.openapitools.codegen.DefaultCodegen.fromModel(DefaultCodegen.java:3120)
at org.openapitools.codegen.languages.AbstractJavaCodegen.fromModel(AbstractJavaCodegen.java:1738)
at org.openapitools.codegen.languages.JavaClientCodegen.fromModel(JavaClientCodegen.java:1055)
at org.openapitools.codegen.DefaultGenerator.processModels(DefaultGenerator.java:1757)
at org.openapitools.codegen.DefaultGenerator.generateModels(DefaultGenerator.java:525)
at org.openapitools.codegen.DefaultGenerator.generateModels(DefaultGenerator.java:449)
at org.openapitools.codegen.DefaultGenerator.generate(DefaultGenerator.java:1302)
at org.openapitools.codegen.cmd.Generate.execute(Generate.java:535)
at org.openapitools.codegen.cmd.OpenApiGeneratorCommand.run(OpenApiGeneratorCommand.java:32)
at org.openapitools.codegen.OpenAPIGenerator.main(OpenAPIGenerator.java:66)

@dreambrother can you please take a look at the above exception when you've time?
To repeat it, please run  ./bin/generate-samples.sh ./bin/configs/java-okhttp-gson.yaml
@dreambrotherdreambrother
mentioned this pull request
Jun 5, 2024
 Merged

5 tasks
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@wing328wing328wing328 left review comments

+1 more reviewer

@martin-mfgmartin-mfgmartin-mfg approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees


No one assigned


Labels

Issue: Regression

Projects


None yet


Milestone

7.6.0

Development

Successfully merging this pull request may close these issues.

3 participants

@dreambrother@wing328@martin-mfg

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Properties with custom types inheritance fix - #18052
Merged
wing328 merged 11 commits into
OpenAPITools:masterfrom 
dreambrother:custom-types-inheritance
May 15, 2024
Merged
Properties with custom types inheritance fix#18052
wing328 merged 11 commits into
OpenAPITools:masterfrom 
dreambrother:custom-types-inheritance
Conversation
@dreambrother
@dreambrotherdreambrother
commented
Mar 7, 2024•

edited

Loading

Copy link


Copy Markdown

Contributor
Approach to deep clone Schema's introduced in #16992 breaks support for properties with custom types (added using schemaMappings or type/importMappings) when such properties are inherited using allOf. AnnotationsUtils#clone returns null for them. I've replaced AnnotationsUtils#clone with ObjectMapper's typed serialization/deserialization.
@OpenAPITools/generator-core-team
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.
@wing328
wing328
commented
Mar 9, 2024

Copy link


Copy Markdown

Member
thanks for the PR
cc @martin-mfg
@wing328
wing328
commented
Mar 21, 2024

Copy link


Copy Markdown

Member
@martin-mfg can you please review when you've time? thank you.
@martin-mfg
martin-mfg
commented
Mar 24, 2024•

edited

Loading

Copy link


Copy Markdown

Contributor
Hi,

the changes look good to me. 👍
just some additional results from my experiments, in case this PR is referenced again in the future:
  • Stringserialized = "{\"type\" : \"custom\"}";
newObjectMapper().readValue(serialized, io.swagger.v3.oas.models.media.Schema.class);
    This works. The relevant difference to what AnnotationsUtils.clone does internally is that a standard ObjectMapper is used above. In AnnotationsUtils.clone, the ObjectMapper is heavily customized.
  • AnnotationsUtils.clone(newSchema().type("custom"), false);
    This does not work. Which means that in general, using allOf is not necessary to trigger the issue. Using an unknown type is sufficient.
  • The changes in the R sample code are not related to the changed cloning logic. Updating the samples with the existing logic results in the same sample changes.
@dreambrother
dreambrother
commented
Apr 8, 2024

Copy link


Copy Markdown

ContributorAuthor
@wing328 I resolved conflict and removed ModelUtils.cloneSchema added here 6746be9 . It uses AnnotationUtils.clone with the same problems described in this PR
@dreambrother
dreambrother
commented
Apr 23, 2024

Copy link


Copy Markdown

ContributorAuthor
Any updates?
wing328
wing328
reviewed
Apr 23, 2024
View reviewed changes
Comment threadmodules/openapi-generator/src/main/java/org/openapitools/codegen/utils/ModelUtils.java
 // in openapi-generator, we also store type in `type` for 3.1 schema
 // to make it backward compatible with the rest of the code base.
 if (schema.getType() != null) {
 clone.setType(schema.getType());
@wing328wing328Apr 23, 2024

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks like this logic is completely removed, right?
@dreambrotherdreambrotherApr 23, 2024

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

SchemaUtils.cloneSchema must not lose a type info after clone (instead of AnnotationUtils), so yep, I've removed it :)
@wing328wing328May 15, 2024•

edited

Loading

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍
FYI. we've refactored the code a bit and no longer using type to store the actual type in 3.1 spec: #18577
@wing328wing328
added this to the 7.6.0 milestone
Apr 23, 2024
wing328
wing328
reviewed
Apr 23, 2024
View reviewed changes
Comment threadmodules/openapi-generator/src/main/java/org/openapitools/codegen/utils/SchemaUtils.java
Outdated

 return schema;
 }
 }
}
@wing328wing328Apr 23, 2024

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

personally i prefer not having another class SchemaUtils just for cloneSchema?
can we merge this (or add this back) into model utils instead?
@dreambrotherdreambrotherApr 23, 2024

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👌
@dreambrotherdreambrotherApr 23, 2024

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done
@dreambrother
dreambrother
commented
May 14, 2024

Copy link


Copy Markdown

ContributorAuthor
Hi! Please notify me before merge, I'll resolve merge conflicts.
@wing328
wing328
commented
May 14, 2024

Copy link


Copy Markdown

Member
Can you please do so and PM me via Slack when done?
@dreambrother
dreambrother
commented
May 14, 2024

Copy link


Copy Markdown

ContributorAuthor
@wing328 sorry, I don't use slack. I've resolved merge conflicts. Had to add jackson-annotations dependency explicitly, because openapi-generator right now has different minor versions of jackson in dependencies (lower for jackson-datatype-threetenbp).
wing328
wing328
reviewed
May 15, 2024
View reviewed changes
Comment threadsamples/client/echo_api/r/R/data_query.R
 #' @param ... Other optional arguments.
 #' @export
 initialize = function(`id` = NULL, `outcomes` = [SUCCESS, FAILURE], `suffix` = NULL, `text` = NULL, `date` = NULL, ...) {
 initialize = function(`id` = NULL, `outcomes` = ["SUCCESS","FAILURE"], `suffix` = NULL, `text` = NULL, `date` = NULL, ...) {
@wing328wing328May 15, 2024

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

one more minor request if you don't mind. can you please add a test for the following schema:
 outcomes:
type: array
items:
type: string
enum:
- SUCCESS
- FAILURE
- SKIPPED
default:
- SUCCESS
- FAILURE

to ensure the default values are clone correctly for string enum?
@dreambrotherdreambrotherMay 15, 2024

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sure! I've added ModelUtilsTest.testCloneArrayOfEnumsSchema
@wing328
wing328
commented
May 15, 2024

Copy link


Copy Markdown

Member
fyi @OpenAPITools/generator-core-team
@wing328
wing328
merged commit 70130ed
into
OpenAPITools:masterMay 15, 2024
@wing328
wing328
commented
May 15, 2024

Copy link


Copy Markdown

Member
PR merged. Thanks again for the PR.
@wing328
wing328
commented
Jun 5, 2024

Copy link


Copy Markdown

Member
[main] ERROR o.o.codegen.utils.ModelUtils - Can't clone schema class DateTimeSchema {
class Schema {
type: string
format: date-time
$ref: null
description: null
title: null
multipleOf: null
maximum: null
exclusiveMaximum: null
minimum: null
exclusiveMinimum: null
maxLength: null
minLength: null
pattern: null
maxItems: null
minItems: null
uniqueItems: null
maxProperties: null
minProperties: null
required: null
not: null
properties: null
additionalProperties: null
nullable: null
readOnly: null
writeOnly: null
example: 2020-02-02T20:20:20.000222Z
externalDocs: null
deprecated: null
discriminator: null
xml: null
}
}
com.fasterxml.jackson.databind.exc.InvalidDefinitionException: Type id handling not implemented for type java.lang.Object (by serializer of type com.fasterxml.jackson.databind.ser.impl.UnsupportedTypeSerializer) (through reference chain: io.swagger.v3.oas.models.media.DateTimeSchema["example"])
at com.fasterxml.jackson.databind.exc.InvalidDefinitionException.from(InvalidDefinitionException.java:77)
at com.fasterxml.jackson.databind.SerializerProvider.reportBadDefinition(SerializerProvider.java:1330)
at com.fasterxml.jackson.databind.DatabindContext.reportBadDefinition(DatabindContext.java:414)
at com.fasterxml.jackson.databind.JsonSerializer.serializeWithType(JsonSerializer.java:173)
at com.fasterxml.jackson.databind.ser.BeanPropertyWriter.serializeAsField(BeanPropertyWriter.java:734)
at com.fasterxml.jackson.databind.ser.std.BeanSerializerBase.serializeFields(BeanSerializerBase.java:770)
at com.fasterxml.jackson.databind.ser.std.BeanSerializerBase.serializeWithType(BeanSerializerBase.java:653)
at com.fasterxml.jackson.databind.ser.impl.TypeWrappedSerializer.serialize(TypeWrappedSerializer.java:32)
at com.fasterxml.jackson.databind.ser.DefaultSerializerProvider._serialize(DefaultSerializerProvider.java:502)
at com.fasterxml.jackson.databind.ser.DefaultSerializerProvider.serializeValue(DefaultSerializerProvider.java:341)
at com.fasterxml.jackson.databind.ObjectMapper._writeValueAndClose(ObjectMapper.java:4799)
at com.fasterxml.jackson.databind.ObjectMapper.writeValueAsString(ObjectMapper.java:4040)
at org.openapitools.codegen.utils.ModelUtils.cloneSchema(ModelUtils.java:2191)
at org.openapitools.codegen.DefaultCodegen.lambda$mergeProperties$13(DefaultCodegen.java:2865)
at java.base/java.util.LinkedHashMap.forEach(LinkedHashMap.java:721)
at org.openapitools.codegen.DefaultCodegen.mergeProperties(DefaultCodegen.java:2865)
at org.openapitools.codegen.DefaultCodegen.updateModelForComposedSchema(DefaultCodegen.java:2779)
at org.openapitools.codegen.DefaultCodegen.fromModel(DefaultCodegen.java:3120)
at org.openapitools.codegen.languages.AbstractJavaCodegen.fromModel(AbstractJavaCodegen.java:1738)
at org.openapitools.codegen.languages.JavaClientCodegen.fromModel(JavaClientCodegen.java:1055)
at org.openapitools.codegen.DefaultGenerator.processModels(DefaultGenerator.java:1757)
at org.openapitools.codegen.DefaultGenerator.generateModels(DefaultGenerator.java:525)
at org.openapitools.codegen.DefaultGenerator.generateModels(DefaultGenerator.java:449)
at org.openapitools.codegen.DefaultGenerator.generate(DefaultGenerator.java:1302)
at org.openapitools.codegen.cmd.Generate.execute(Generate.java:535)
at org.openapitools.codegen.cmd.OpenApiGeneratorCommand.run(OpenApiGeneratorCommand.java:32)
at org.openapitools.codegen.OpenAPIGenerator.main(OpenAPIGenerator.java:66)

@dreambrother can you please take a look at the above exception when you've time?
To repeat it, please run  ./bin/generate-samples.sh ./bin/configs/java-okhttp-gson.yaml
@dreambrotherdreambrother
mentioned this pull request
Jun 5, 2024
 Merged

5 tasks
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@wing328wing328wing328 left review comments

+1 more reviewer

@martin-mfgmartin-mfgmartin-mfg approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees


No one assigned


Labels

Issue: Regression

Projects


None yet


Milestone

7.6.0

Development

Successfully merging this pull request may close these issues.

3 participants

@dreambrother@wing328@martin-mfg

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
Properties with custom types inheritance fix - #18052
Merged
wing328 merged 11 commits into
OpenAPITools:masterfrom 
dreambrother:custom-types-inheritance
May 15, 2024
Merged
Properties with custom types inheritance fix#18052
wing328 merged 11 commits into
OpenAPITools:masterfrom 
dreambrother:custom-types-inheritance
Conversation
@dreambrother
@dreambrotherdreambrother
commented
Mar 7, 2024•

edited

Loading

Copy link


Copy Markdown

Contributor
Approach to deep clone Schema's introduced in #16992 breaks support for properties with custom types (added using schemaMappings or type/importMappings) when such properties are inherited using allOf. AnnotationsUtils#clone returns null for them. I've replaced AnnotationsUtils#clone with ObjectMapper's typed serialization/deserialization.
@OpenAPITools/generator-core-team
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.
@wing328
wing328
commented
Mar 9, 2024

Copy link


Copy Markdown

Member
thanks for the PR
cc @martin-mfg
@wing328
wing328
commented
Mar 21, 2024

Copy link


Copy Markdown

Member
@martin-mfg can you please review when you've time? thank you.
@martin-mfg
martin-mfg
commented
Mar 24, 2024•

edited

Loading

Copy link


Copy Markdown

Contributor
Hi,

the changes look good to me. 👍
just some additional results from my experiments, in case this PR is referenced again in the future:
  • Stringserialized = "{\"type\" : \"custom\"}";
newObjectMapper().readValue(serialized, io.swagger.v3.oas.models.media.Schema.class);
    This works. The relevant difference to what AnnotationsUtils.clone does internally is that a standard ObjectMapper is used above. In AnnotationsUtils.clone, the ObjectMapper is heavily customized.
  • AnnotationsUtils.clone(newSchema().type("custom"), false);
    This does not work. Which means that in general, using allOf is not necessary to trigger the issue. Using an unknown type is sufficient.
  • The changes in the R sample code are not related to the changed cloning logic. Updating the samples with the existing logic results in the same sample changes.
@dreambrother
dreambrother
commented
Apr 8, 2024

Copy link


Copy Markdown

ContributorAuthor
@wing328 I resolved conflict and removed ModelUtils.cloneSchema added here 6746be9 . It uses AnnotationUtils.clone with the same problems described in this PR
@dreambrother
dreambrother
commented
Apr 23, 2024

Copy link


Copy Markdown

ContributorAuthor
Any updates?
wing328
wing328
reviewed
Apr 23, 2024
View reviewed changes
Comment threadmodules/openapi-generator/src/main/java/org/openapitools/codegen/utils/ModelUtils.java
 // in openapi-generator, we also store type in `type` for 3.1 schema
 // to make it backward compatible with the rest of the code base.
 if (schema.getType() != null) {
 clone.setType(schema.getType());
@wing328wing328Apr 23, 2024

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks like this logic is completely removed, right?
@dreambrotherdreambrotherApr 23, 2024

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

SchemaUtils.cloneSchema must not lose a type info after clone (instead of AnnotationUtils), so yep, I've removed it :)
@wing328wing328May 15, 2024•

edited

Loading

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍
FYI. we've refactored the code a bit and no longer using type to store the actual type in 3.1 spec: #18577
@wing328wing328
added this to the 7.6.0 milestone
Apr 23, 2024
wing328
wing328
reviewed
Apr 23, 2024
View reviewed changes
Comment threadmodules/openapi-generator/src/main/java/org/openapitools/codegen/utils/SchemaUtils.java
Outdated

 return schema;
 }
 }
}
@wing328wing328Apr 23, 2024

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

personally i prefer not having another class SchemaUtils just for cloneSchema?
can we merge this (or add this back) into model utils instead?
@dreambrotherdreambrotherApr 23, 2024

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👌
@dreambrotherdreambrotherApr 23, 2024

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done
@dreambrother
dreambrother
commented
May 14, 2024

Copy link


Copy Markdown

ContributorAuthor
Hi! Please notify me before merge, I'll resolve merge conflicts.
@wing328
wing328
commented
May 14, 2024

Copy link


Copy Markdown

Member
Can you please do so and PM me via Slack when done?
@dreambrother
dreambrother
commented
May 14, 2024

Copy link


Copy Markdown

ContributorAuthor
@wing328 sorry, I don't use slack. I've resolved merge conflicts. Had to add jackson-annotations dependency explicitly, because openapi-generator right now has different minor versions of jackson in dependencies (lower for jackson-datatype-threetenbp).
wing328
wing328
reviewed
May 15, 2024
View reviewed changes
Comment threadsamples/client/echo_api/r/R/data_query.R
 #' @param ... Other optional arguments.
 #' @export
 initialize = function(`id` = NULL, `outcomes` = [SUCCESS, FAILURE], `suffix` = NULL, `text` = NULL, `date` = NULL, ...) {
 initialize = function(`id` = NULL, `outcomes` = ["SUCCESS","FAILURE"], `suffix` = NULL, `text` = NULL, `date` = NULL, ...) {
@wing328wing328May 15, 2024

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

one more minor request if you don't mind. can you please add a test for the following schema:
 outcomes:
type: array
items:
type: string
enum:
- SUCCESS
- FAILURE
- SKIPPED
default:
- SUCCESS
- FAILURE

to ensure the default values are clone correctly for string enum?
@dreambrotherdreambrotherMay 15, 2024

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sure! I've added ModelUtilsTest.testCloneArrayOfEnumsSchema
@wing328
wing328
commented
May 15, 2024

Copy link


Copy Markdown

Member
fyi @OpenAPITools/generator-core-team
@wing328
wing328
merged commit 70130ed
into
OpenAPITools:masterMay 15, 2024
@wing328
wing328
commented
May 15, 2024

Copy link


Copy Markdown

Member
PR merged. Thanks again for the PR.
@wing328
wing328
commented
Jun 5, 2024

Copy link


Copy Markdown

Member
[main] ERROR o.o.codegen.utils.ModelUtils - Can't clone schema class DateTimeSchema {
class Schema {
type: string
format: date-time
$ref: null
description: null
title: null
multipleOf: null
maximum: null
exclusiveMaximum: null
minimum: null
exclusiveMinimum: null
maxLength: null
minLength: null
pattern: null
maxItems: null
minItems: null
uniqueItems: null
maxProperties: null
minProperties: null
required: null
not: null
properties: null
additionalProperties: null
nullable: null
readOnly: null
writeOnly: null
example: 2020-02-02T20:20:20.000222Z
externalDocs: null
deprecated: null
discriminator: null
xml: null
}
}
com.fasterxml.jackson.databind.exc.InvalidDefinitionException: Type id handling not implemented for type java.lang.Object (by serializer of type com.fasterxml.jackson.databind.ser.impl.UnsupportedTypeSerializer) (through reference chain: io.swagger.v3.oas.models.media.DateTimeSchema["example"])
at com.fasterxml.jackson.databind.exc.InvalidDefinitionException.from(InvalidDefinitionException.java:77)
at com.fasterxml.jackson.databind.SerializerProvider.reportBadDefinition(SerializerProvider.java:1330)
at com.fasterxml.jackson.databind.DatabindContext.reportBadDefinition(DatabindContext.java:414)
at com.fasterxml.jackson.databind.JsonSerializer.serializeWithType(JsonSerializer.java:173)
at com.fasterxml.jackson.databind.ser.BeanPropertyWriter.serializeAsField(BeanPropertyWriter.java:734)
at com.fasterxml.jackson.databind.ser.std.BeanSerializerBase.serializeFields(BeanSerializerBase.java:770)
at com.fasterxml.jackson.databind.ser.std.BeanSerializerBase.serializeWithType(BeanSerializerBase.java:653)
at com.fasterxml.jackson.databind.ser.impl.TypeWrappedSerializer.serialize(TypeWrappedSerializer.java:32)
at com.fasterxml.jackson.databind.ser.DefaultSerializerProvider._serialize(DefaultSerializerProvider.java:502)
at com.fasterxml.jackson.databind.ser.DefaultSerializerProvider.serializeValue(DefaultSerializerProvider.java:341)
at com.fasterxml.jackson.databind.ObjectMapper._writeValueAndClose(ObjectMapper.java:4799)
at com.fasterxml.jackson.databind.ObjectMapper.writeValueAsString(ObjectMapper.java:4040)
at org.openapitools.codegen.utils.ModelUtils.cloneSchema(ModelUtils.java:2191)
at org.openapitools.codegen.DefaultCodegen.lambda$mergeProperties$13(DefaultCodegen.java:2865)
at java.base/java.util.LinkedHashMap.forEach(LinkedHashMap.java:721)
at org.openapitools.codegen.DefaultCodegen.mergeProperties(DefaultCodegen.java:2865)
at org.openapitools.codegen.DefaultCodegen.updateModelForComposedSchema(DefaultCodegen.java:2779)
at org.openapitools.codegen.DefaultCodegen.fromModel(DefaultCodegen.java:3120)
at org.openapitools.codegen.languages.AbstractJavaCodegen.fromModel(AbstractJavaCodegen.java:1738)
at org.openapitools.codegen.languages.JavaClientCodegen.fromModel(JavaClientCodegen.java:1055)
at org.openapitools.codegen.DefaultGenerator.processModels(DefaultGenerator.java:1757)
at org.openapitools.codegen.DefaultGenerator.generateModels(DefaultGenerator.java:525)
at org.openapitools.codegen.DefaultGenerator.generateModels(DefaultGenerator.java:449)
at org.openapitools.codegen.DefaultGenerator.generate(DefaultGenerator.java:1302)
at org.openapitools.codegen.cmd.Generate.execute(Generate.java:535)
at org.openapitools.codegen.cmd.OpenApiGeneratorCommand.run(OpenApiGeneratorCommand.java:32)
at org.openapitools.codegen.OpenAPIGenerator.main(OpenAPIGenerator.java:66)

@dreambrother can you please take a look at the above exception when you've time?
To repeat it, please run  ./bin/generate-samples.sh ./bin/configs/java-okhttp-gson.yaml
@dreambrotherdreambrother
mentioned this pull request
Jun 5, 2024
 Merged

5 tasks
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@wing328wing328wing328 left review comments

+1 more reviewer

@martin-mfgmartin-mfgmartin-mfg approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees


No one assigned


Labels

Issue: Regression

Projects


None yet


Milestone

7.6.0

Development

Successfully merging this pull request may close these issues.

3 participants

@dreambrother@wing328@martin-mfg