Skip to content

[TypeScript-Consolidated] Fixes invalid type enum array & incorrect discriminator value if mapping is present #15272

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open

[TypeScript-Consolidated] Fixes invalid type enum array & incorrect discriminator value if mapping is present #15272

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
7527911
Fix invalid discrimnator value and enum type
TiFu Apr 20, 2023
cd79f5e
Remove printlns
TiFu Apr 20, 2023
9546218
Regenerated samples
TiFu Apr 20, 2023
6f1d1c0
Remove space from "type"
TiFu Apr 20, 2023
4f788e7
Extract enum type fix to abstract client codegen
TiFu Apr 29, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion ...tor/src/main/java/org/openapitools/codegen/languages/AbstractTypeScriptClientCodegen.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -610,6 +610,7 @@ public String getTypeDeclaration(Schema p) {
} else if (ModelUtils.isBinarySchema(p)) {
return "ArrayBuffer";
}

return super.getTypeDeclaration(p);
}

Expand Down Expand Up @@ -885,7 +886,8 @@ public String toEnumVarName(String name, String datatype) {
public String toEnumName(CodegenProperty property) {
String enumName = property.name;
enumName = addSuffix(enumName, enumSuffix);
return toTypescriptTypeName(enumName, "_");
String tsName = toTypescriptTypeName(enumName, "_");
return tsName;
}

protected void setEnumPropertyNaming(String naming) {
Expand Down
42 changes: 39 additions & 3 deletions ...i-generator/src/main/java/org/openapitools/codegen/languages/TypeScriptClientCodegen.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -293,6 +293,40 @@ public String toEnumValue(String value, String datatype) {
}
}

/**
Copy link
Contributor Author

Choose a reason for hiding this comment

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

TODO: Extract to AbstractTSClientCodegen

* Update datatypeWithEnum for array container
*
* @param property Codegen property
*/
protected void updateDataTypeWithEnumForArray(CodegenProperty property) {
CodegenProperty baseItem = property.items;
while (baseItem != null && (Boolean.TRUE.equals(baseItem.isMap)
|| Boolean.TRUE.equals(baseItem.isArray))) {
baseItem = baseItem.items;
}
if (baseItem != null) {
/*
* Note: There are cases where we have datatypeWithEnum == Array<{ [key: string]: string}
* In these cases, we then have Array <{ [key: EnumName]: EnumName}> - which is invalid typescript
* To protect agains this we first replace [key: string] with a special/reserved placeholder (i.e. *[key]* )
*/
property.datatypeWithEnum = property.datatypeWithEnum.replace("[key: string]", "*key*")
Copy link
Contributor

Choose a reason for hiding this comment

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

*key*

can be constant with PLACEHOLDER name.

#PLACEHOLDER# or something else.

Copy link
Contributor

@wtrocki wtrocki Apr 20, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

Actually using regular expression with replaceAll might help avoiding placeholder. We always looking to replace last occurence

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Is it always the last occurrence?

Wondering whether there are more complicated examples where this does not hold - mainly thinking about cases where the same type appears twice (e.g., Tuple<string, string> to Tuple<FancyEnum, FancyEnum>).

In cases like this, our model is anyway broken because we lose type information when generating the initial type.

.replace(baseItem.baseType, toEnumName(baseItem))
.replace("*key*", "[key: string]");

// naming the enum with respect to the language enum naming convention
// e.g. remove [], {} from array/map of enum
property.enumName = toEnumName(property);

// set default value for variable with inner enum
if (property.defaultValue != null) {
property.defaultValue = property.defaultValue.replace(baseItem.baseType, toEnumName(baseItem));
}

updateCodegenPropertyEnum(property);
}
}

@Override
public ModelsMap postProcessModels(ModelsMap objs) {
// process enum in models
Expand All @@ -303,13 +337,15 @@ public ModelsMap postProcessModels(ModelsMap objs) {
// name enum with model name, e.g. StatusEnum => Pet.StatusEnum
for (CodegenProperty var : cm.vars) {
if (Boolean.TRUE.equals(var.isEnum)) {
String replaceName = var.isInnerEnum ? "Inner" + super.enumSuffix : var.enumName;
var.datatypeWithEnum = var.datatypeWithEnum.replace(replaceName, var.enumName);
var.datatypeWithEnum = var.datatypeWithEnum.replace(var.enumName, cm.classname + var.enumName);
}
}
if (cm.parent != null) {
for (CodegenProperty var : cm.allVars) {
if (Boolean.TRUE.equals(var.isEnum)) {
var.datatypeWithEnum = var.datatypeWithEnum
var.datatypeWithEnum = var.datatypeWithEnum
.replace(var.enumName, cm.classname + var.enumName);
}
}
Expand Down Expand Up @@ -422,8 +458,8 @@ public String getTypeDeclaration(Schema p) {
if (ModelUtils.isArraySchema(p)) {
inner = ((ArraySchema) p).getItems();
return this.getSchemaType(p) + "<" + this.getTypeDeclaration(unaliasSchema(inner)) + ">";
} else if (ModelUtils.isMapSchema(p)) {
inner = getSchemaAdditionalProperties(p);
} else if (ModelUtils.isMapSchema(p)) { // it is an object schema
inner = getSchemaAdditionalProperties(p); // additional properties?
String postfix = "";
if (Boolean.TRUE.equals(inner.getNullable())) {
postfix = " | null";
Expand Down
4 changes: 3 additions & 1 deletion modules/openapi-generator/src/main/resources/typescript/model/ObjectSerializer.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,9 @@ export class ObjectSerializer {
return expectedType; // the type does not have a discriminator. use it.
} else {
if (data[discriminatorProperty]) {
var discriminatorType = data[discriminatorProperty];
var discriminatorValue = data[discriminatorProperty];
// if it has a mapping we need to map from discriminatorvalue to the actual type name
var discriminatorType = data.discriminatorTypeMap[discriminatorValue] || discriminatorValue;
if(typeMap[discriminatorType]){
return discriminatorType; // use the type given in the discriminator
} else {
Expand Down
16 changes: 13 additions & 3 deletions modules/openapi-generator/src/main/resources/typescript/model/model.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,11 @@ export class {{classname}} {{#parent}}extends {{{.}}} {{/parent}}{

{{#discriminator}}
static readonly discriminator: string | undefined = "{{discriminatorName}}";
static readonly discriminatorTypeMap = {
{{#mappedModels}}
"{{mappingName}}": "{{modelName}}"{{^-last}},{{/-last}}
{{/mappedModels}}
}
{{/discriminator}}
{{^discriminator}}
static readonly discriminator: string | undefined = undefined;
Expand All @@ -35,7 +40,7 @@ export class {{classname}} {{#parent}}extends {{{.}}} {{/parent}}{
{
"name": "{{name}}",
"baseName": "{{baseName}}",
"type": "{{#isEnum}}{{{datatypeWithEnum}}}{{/isEnum}}{{^isEnum}}{{{dataType}}}{{/isEnum}}",
"type": "{{#isEnum}}{{{datatypeWithEnum}}}{{/isEnum}}{{^isEnum}}{{{dataType}}}{{/isEnum}}{{#isNullable}} | null{{/isNullable}} ",
"format": "{{dataFormat}}"
}{{^-last}},
{{/-last}}
Expand All @@ -61,9 +66,14 @@ export class {{classname}} {{#parent}}extends {{{.}}} {{/parent}}{
this.{{name}} = "{{discriminatorValue}}";
{{/discriminatorValue}}
{{/allVars}}
{{#discriminatorName}}

{{#discriminator}}
{{^hasDiscriminatorWithNonEmptyMapping}}
{{#discriminatorName}}
this.{{discriminatorName}} = "{{classname}}";
{{/discriminatorName}}
{{/discriminatorName}}
{{/hasDiscriminatorWithNonEmptyMapping}}
{{/discriminator}}
}
}

Expand Down
4 changes: 3 additions & 1 deletion samples/client/others/typescript/builds/with-unique-items/models/ObjectSerializer.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,9 @@ export class ObjectSerializer {
return expectedType; // the type does not have a discriminator. use it.
} else {
if (data[discriminatorProperty]) {
var discriminatorType = data[discriminatorProperty];
var discriminatorValue = data[discriminatorProperty];
// if it has a mapping we need to map from discriminatorvalue to the actual type name
var discriminatorType = data.discriminatorTypeMap[discriminatorValue] || discriminatorValue;
if(typeMap[discriminatorType]){
return discriminatorType; // use the type given in the discriminator
} else {
Expand Down
5 changes: 3 additions & 2 deletions samples/client/others/typescript/builds/with-unique-items/models/Response.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,13 +22,13 @@ export class Response {
{
"name": "nonUniqueArray",
"baseName": "non-unique-array",
"type": "Array<string>",
"type": "Array<string> ",
"format": ""
},
{
"name": "uniqueArray",
"baseName": "unique-array",
"type": "Set<string>",
"type": "Set<string> ",
"format": ""
} ];

Expand All @@ -37,6 +37,7 @@ export class Response {
}

public constructor() {

}
}

7 changes: 4 additions & 3 deletions samples/openapi3/client/petstore/typescript/builds/browser/models/ApiResponse.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,19 +26,19 @@ export class ApiResponse {
{
"name": "code",
"baseName": "code",
"type": "number",
"type": "number ",
"format": "int32"
},
{
"name": "type",
"baseName": "type",
"type": "string",
"type": "string ",
"format": ""
},
{
"name": "message",
"baseName": "message",
"type": "string",
"type": "string ",
"format": ""
} ];

Expand All @@ -47,6 +47,7 @@ export class ApiResponse {
}

public constructor() {

}
}

5 changes: 3 additions & 2 deletions samples/openapi3/client/petstore/typescript/builds/browser/models/Category.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,13 +25,13 @@ export class Category {
{
"name": "id",
"baseName": "id",
"type": "number",
"type": "number ",
"format": "int64"
},
{
"name": "name",
"baseName": "name",
"type": "string",
"type": "string ",
"format": ""
} ];

Expand All @@ -40,6 +40,7 @@ export class Category {
}

public constructor() {

}
}

4 changes: 3 additions & 1 deletion samples/openapi3/client/petstore/typescript/builds/browser/models/ObjectSerializer.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,9 @@ export class ObjectSerializer {
return expectedType; // the type does not have a discriminator. use it.
} else {
if (data[discriminatorProperty]) {
var discriminatorType = data[discriminatorProperty];
var discriminatorValue = data[discriminatorProperty];
// if it has a mapping we need to map from discriminatorvalue to the actual type name
var discriminatorType = data.discriminatorTypeMap[discriminatorValue] || discriminatorValue;
if(typeMap[discriminatorType]){
return discriminatorType; // use the type given in the discriminator
} else {
Expand Down
13 changes: 7 additions & 6 deletions samples/openapi3/client/petstore/typescript/builds/browser/models/Order.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,37 +32,37 @@ export class Order {
{
"name": "id",
"baseName": "id",
"type": "number",
"type": "number ",
"format": "int64"
},
{
"name": "petId",
"baseName": "petId",
"type": "number",
"type": "number ",
"format": "int64"
},
{
"name": "quantity",
"baseName": "quantity",
"type": "number",
"type": "number ",
"format": "int32"
},
{
"name": "shipDate",
"baseName": "shipDate",
"type": "Date",
"type": "Date ",
"format": "date-time"
},
{
"name": "status",
"baseName": "status",
"type": "OrderStatusEnum",
"type": "OrderStatusEnum ",
"format": ""
},
{
"name": "complete",
"baseName": "complete",
"type": "boolean",
"type": "boolean ",
"format": ""
} ];

Expand All @@ -71,6 +71,7 @@ export class Order {
}

public constructor() {

}
}

Expand Down
13 changes: 7 additions & 6 deletions samples/openapi3/client/petstore/typescript/builds/browser/models/Pet.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,37 +34,37 @@ export class Pet {
{
"name": "id",
"baseName": "id",
"type": "number",
"type": "number ",
"format": "int64"
},
{
"name": "category",
"baseName": "category",
"type": "Category",
"type": "Category ",
"format": ""
},
{
"name": "name",
"baseName": "name",
"type": "string",
"type": "string ",
"format": ""
},
{
"name": "photoUrls",
"baseName": "photoUrls",
"type": "Array<string>",
"type": "Array<string> ",
"format": ""
},
{
"name": "tags",
"baseName": "tags",
"type": "Array<Tag>",
"type": "Array<Tag> ",
"format": ""
},
{
"name": "status",
"baseName": "status",
"type": "PetStatusEnum",
"type": "PetStatusEnum ",
"format": ""
} ];

Expand All @@ -73,6 +73,7 @@ export class Pet {
}

public constructor() {

}
}

Expand Down
5 changes: 3 additions & 2 deletions samples/openapi3/client/petstore/typescript/builds/browser/models/Tag.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,13 +25,13 @@ export class Tag {
{
"name": "id",
"baseName": "id",
"type": "number",
"type": "number ",
"format": "int64"
},
{
"name": "name",
"baseName": "name",
"type": "string",
"type": "string ",
"format": ""
} ];

Expand All @@ -40,6 +40,7 @@ export class Tag {
}

public constructor() {

}
}

Loading