Skip to content

Support multi-level polymorphism #2781

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

Merged
alzimmermsft merged 5 commits into from
May 24, 2024
Merged

Support multi-level polymorphism #2781

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
45d40f9
Support multi-level polymorphism
alzimmermsft May 22, 2024
c27f32d
Fix tests
alzimmermsft May 22, 2024
03022ac
Merge branch 'main' into MultiLevelPolymorphismSupport
alzimmermsft May 23, 2024
1f8fbcd
Clean up diff in ModelMapper
alzimmermsft May 23, 2024
f22fd8d
Merge in main
alzimmermsft May 24, 2024
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
3 changes: 1 addition & 2 deletions .../com/azure/ai/formrecognizer/documentanalysis/implementation/models/OperationDetails.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ public class OperationDetails implements JsonSerializable<OperationDetails> {
/*
* Type of operation.
*/
private String kind;
private String kind = "OperationDetails";

/*
* Operation ID
Expand Down Expand Up @@ -73,7 +73,6 @@ public class OperationDetails implements JsonSerializable<OperationDetails> {
* Creates an instance of OperationDetails class.
*/
public OperationDetails() {
this.kind = "OperationDetails";
}

/**
Expand Down
3 changes: 1 addition & 2 deletions customization-tests/src/main/java/fixtures/bodycomplex/implementation/models/DotFish.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ public class DotFish implements JsonSerializable<DotFish> {
/*
* The fish.type property.
*/
private String fishType;
private String fishType = "DotFish";

/*
* The species property.
Expand All @@ -30,7 +30,6 @@ public class DotFish implements JsonSerializable<DotFish> {
* Creates an instance of DotFish class.
*/
public DotFish() {
this.fishType = "DotFish";
}

/**
Expand Down
3 changes: 1 addition & 2 deletions customization-tests/src/main/java/fixtures/bodycomplex/implementation/models/Fish.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ public class Fish implements JsonSerializable<Fish> {
/*
* The fishtype property.
*/
private String fishtype;
private String fishtype = "Fish";

/*
* The species property.
Expand All @@ -41,7 +41,6 @@ public class Fish implements JsonSerializable<Fish> {
* Creates an instance of Fish class.
*/
public Fish() {
this.fishtype = "Fish";
}

/**
Expand Down
3 changes: 1 addition & 2 deletions customization-tests/src/main/java/fixtures/bodycomplex/implementation/models/MyBaseType.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ public class MyBaseType implements JsonSerializable<MyBaseType> {
/*
* The kind property.
*/
private MyKind kind;
private MyKind kind = MyKind.fromString("MyBaseType");

/*
* The propB1 property.
Expand All @@ -35,7 +35,6 @@ public class MyBaseType implements JsonSerializable<MyBaseType> {
* Creates an instance of MyBaseType class.
*/
public MyBaseType() {
this.kind = MyKind.fromString("MyBaseType");
}

/**
Expand Down
124 changes: 91 additions & 33 deletions javagen/src/main/java/com/azure/autorest/mapper/ModelMapper.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,18 +73,16 @@ public ClientModel map(ObjectSchema compositeType) {
}
}

ClientModel.Builder builder = createModelBuilder()
.name(modelName)
ClientModel.Builder builder = createModelBuilder().name(modelName)
.packageName(modelType.getPackage())
.type(modelType)
.stronglyTypedHeader(compositeType.isStronglyTypedHeader())
.usedInXml(SchemaUtil.treatAsXml(compositeType))
.serializationFormats(compositeType.getSerializationFormats())
.implementationDetails(new ImplementationDetails.Builder()
.usages(usages)
.build());
.implementationDetails(new ImplementationDetails.Builder().usages(usages).build());

boolean isPolymorphic = compositeType.getDiscriminator() != null || compositeType.getDiscriminatorValue() != null;
boolean isPolymorphic = compositeType.getDiscriminator() != null
|| compositeType.getDiscriminatorValue() != null;
builder.polymorphic(isPolymorphic);

HashSet<String> modelImports = new HashSet<>();
Expand All @@ -93,7 +91,9 @@ public ClientModel map(ObjectSchema compositeType) {
boolean hasAdditionalProperties = false;
List<ObjectSchema> parentsNeedFlatten = Collections.emptyList();
if (compositeType.getParents() != null && compositeType.getParents().getImmediate() != null) {
hasAdditionalProperties = compositeType.getParents().getImmediate().stream()
hasAdditionalProperties = compositeType.getParents()
.getImmediate()
.stream()
.anyMatch(s -> s instanceof DictionarySchema);

ParentSchemaInfo parentSchemaInfo = getParentSchemaInfo(compositeType);
Expand All @@ -108,15 +108,20 @@ public ClientModel map(ObjectSchema compositeType) {
builder.parentModelName(parentModelName);

List<Property> compositeTypeProperties = compositeType.getProperties()
.stream().filter(p -> !p.isIsDiscriminator()).collect(Collectors.toList());
.stream()
.filter(p -> !p.isIsDiscriminator())
.collect(Collectors.toList());
if (!parentsNeedFlatten.isEmpty()) {
// Take properties from base class of multiple inheritance as properties of this class.
for (ObjectSchema parent : parentsNeedFlatten) {
compositeTypeProperties.addAll(parent.getProperties().stream()
compositeTypeProperties.addAll(parent.getProperties()
.stream()
.filter(p -> !p.isIsDiscriminator())
.collect(Collectors.toList()));
if (parent.getParents() != null) {
compositeTypeProperties.addAll(parent.getParents().getAll().stream()
compositeTypeProperties.addAll(parent.getParents()
.getAll()
.stream()
.filter(s -> s instanceof ObjectSchema)
.flatMap(s -> ((ObjectSchema) s).getProperties().stream())
.filter(p -> !p.isIsDiscriminator())
Expand Down Expand Up @@ -145,7 +150,8 @@ public ClientModel map(ObjectSchema compositeType) {
}

if (compositeTypeProperties.stream().anyMatch(p -> {
if (p.getSchema().getSerialization() == null || p.getSchema().getSerialization().getXml() == null) {
if (p.getSchema().getSerialization() == null
|| p.getSchema().getSerialization().getXml() == null) {
return false;
}

Expand All @@ -156,7 +162,8 @@ public ClientModel map(ObjectSchema compositeType) {
}

if (compositeTypeProperties.stream().anyMatch(p -> {
if (p.getSchema().getSerialization() == null || p.getSchema().getSerialization().getXml() == null) {
if (p.getSchema().getSerialization() == null
|| p.getSchema().getSerialization().getXml() == null) {
return false;
}

Expand All @@ -165,14 +172,21 @@ public ClientModel map(ObjectSchema compositeType) {
modelImports.add("com.fasterxml.jackson.dataformat.xml.annotation.JacksonXmlText");
}

if (compositeTypeProperties.stream().anyMatch(p -> p.getSchema().getSerialization() == null
|| p.getSchema().getSerialization().getXml() == null || !p.getSchema().getSerialization()
.getXml().isAttribute())) {
if (compositeTypeProperties.stream()
.anyMatch(p -> p.getSchema().getSerialization() == null
|| p.getSchema().getSerialization().getXml() == null || !p.getSchema()
.getSerialization()
.getXml()
.isAttribute())) {
modelImports.add(JsonProperty.class.getName());
}

if (compositeTypeProperties.stream().anyMatch(p -> p.getSchema().getSerialization() != null
&& p.getSchema().getSerialization().getXml() != null && p.getSchema().getSerialization().getXml().isWrapped())) {
if (compositeTypeProperties.stream()
.anyMatch(p -> p.getSchema().getSerialization() != null
&& p.getSchema().getSerialization().getXml() != null && p.getSchema()
.getSerialization()
.getXml()
.isWrapped())) {
modelImports.add(JsonCreator.class.getName());
}

Expand All @@ -189,7 +203,9 @@ public ClientModel map(ObjectSchema compositeType) {
}

String summary = compositeType.getSummary();
String description = compositeType.getLanguage().getJava() == null ? null : compositeType.getLanguage().getJava().getDescription();
String description = compositeType.getLanguage().getJava() == null
? null
: compositeType.getLanguage().getJava().getDescription();
if (CoreUtils.isNullOrEmpty(summary) && CoreUtils.isNullOrEmpty(description)) {
builder.description(String.format("The %s model.", compositeType.getLanguage().getJava().getName()));
} else {
Expand All @@ -203,14 +219,16 @@ public ClientModel map(ObjectSchema compositeType) {
builder.serializedName(modelSerializedName);

List<ClientModel> derivedTypes = new ArrayList<>();
boolean hasChildren = compositeType.getChildren() != null && compositeType.getChildren().getImmediate() != null;
boolean hasChildren = compositeType.getChildren() != null
&& compositeType.getChildren().getImmediate() != null;
if (hasChildren) {
for (Schema childSchema : compositeType.getChildren().getImmediate()) {
if (childSchema instanceof ObjectSchema) {
ClientModel model = this.map((ObjectSchema) childSchema);
derivedTypes.add(model);
} else {
throw new RuntimeException("Wait what? How? Child is not an object but a " + childSchema.getClass() + "?");
throw new RuntimeException(
"Wait what? How? Child is not an object but a " + childSchema.getClass() + "?");
}
}
}
Expand All @@ -222,9 +240,9 @@ public ClientModel map(ObjectSchema compositeType) {
&& compositeType.getSerialization().getXml() != null;
if (hasXmlFormat) {
final XmlSerializationFormat xml = compositeType.getSerialization().getXml();
String xmlName = CoreUtils.isNullOrEmpty(xml.getName())
? compositeType.getLanguage().getDefault().getName()
: xml.getName();
String xmlName = CoreUtils.isNullOrEmpty(xml.getName()) ? compositeType.getLanguage()
.getDefault()
.getName() : xml.getName();
builder.xmlName(xmlName);
builder.xmlNamespace(xml.getNamespace());
} else {
Expand All @@ -249,10 +267,9 @@ public ClientModel map(ObjectSchema compositeType) {
: discriminatorSerializedName;

final String finalPolymorphicDiscriminator = polymorphicDiscriminator;
ClientModelProperty discriminatorProperty = createDiscriminatorProperty(
settings, hasChildren, compositeType,
annotationArgs -> annotationArgs.replace(discriminatorSerializedName, finalPolymorphicDiscriminator),
polymorphicDiscriminator);
ClientModelProperty discriminatorProperty = createDiscriminatorProperty(settings, hasChildren,
compositeType, annotationArgs -> annotationArgs.replace(discriminatorSerializedName,
finalPolymorphicDiscriminator), polymorphicDiscriminator);

if (discriminatorProperty != null) {
properties.add(discriminatorProperty);
Expand All @@ -269,10 +286,12 @@ public ClientModel map(ObjectSchema compositeType) {
builder.needsFlatten(needsFlatten);
builder.imports(new ArrayList<>(modelImports));

final boolean mutablePropertyAsOptional = usages.contains(ImplementationDetails.Usage.JSON_MERGE_PATCH) && settings.isStreamStyleSerialization();
final boolean mutablePropertyAsOptional = usages.contains(ImplementationDetails.Usage.JSON_MERGE_PATCH)
&& settings.isStreamStyleSerialization();
List<ClientModelPropertyReference> propertyReferences = new ArrayList<>();
for (Property property : compositeTypeProperties) {
ClientModelProperty modelProperty = Mappers.getModelPropertyMapper().map(property, mutablePropertyAsOptional);
ClientModelProperty modelProperty = Mappers.getModelPropertyMapper()
.map(property, mutablePropertyAsOptional);
if (Objects.equals(polymorphicDiscriminator, modelProperty.getSerializedName())) {
// Discriminator is defined both as the discriminator and a property in the model.
// Make the discriminator property required if the property is required. But don't add the property
Expand All @@ -287,7 +306,8 @@ public ClientModel map(ObjectSchema compositeType) {
// be null or an infinite loop would happen.
if (!CoreUtils.isNullOrEmpty(derivedTypes)) {
for (ClientModel derivedType : derivedTypes) {
if (Objects.equals(derivedType.getPolymorphicDiscriminator().getSerializedName(), polymorphicDiscriminator)) {
if (Objects.equals(derivedType.getPolymorphicDiscriminator().getSerializedName(),
polymorphicDiscriminator)) {
derivedType.getPolymorphicDiscriminator().setRequired(modelProperty.isRequired());
}
}
Expand All @@ -298,13 +318,18 @@ public ClientModel map(ObjectSchema compositeType) {

properties.add(modelProperty);

if (modelProperty.getClientFlatten() && settings.getClientFlattenAnnotationTarget() == JavaSettings.ClientFlattenAnnotationTarget.NONE) {
propertyReferences.addAll(collectPropertiesFromFlattenedModel(compositeType, property, modelProperty, propertyReferences));
if (modelProperty.getClientFlatten()
&& settings.getClientFlattenAnnotationTarget() == JavaSettings.ClientFlattenAnnotationTarget.NONE) {
propertyReferences.addAll(
collectPropertiesFromFlattenedModel(compositeType, property, modelProperty,
propertyReferences));
}
}

if (hasAdditionalProperties) {
DictionarySchema schema = (DictionarySchema) compositeType.getParents().getImmediate().stream()
DictionarySchema schema = (DictionarySchema) compositeType.getParents()
.getImmediate()
.stream()
.filter(s -> s instanceof DictionarySchema)
.findFirst()
.orElseThrow(() -> new IllegalStateException(
Expand All @@ -331,12 +356,45 @@ public ClientModel map(ObjectSchema compositeType) {
builder.crossLanguageDefinitionId(compositeType.getCrossLanguageDefinitionId());

result = builder.build();

if (isPolymorphic && !CoreUtils.isNullOrEmpty(derivedTypes)) {
// Walk the polymorphic hierarchy finding places where the parent model and child model have different
// polymorphic discriminators. When this case is found add the parent polymorphic discriminator as a parent
// polymorphic discriminator to the child model. This is necessary to ensure that the child model generates
// the correct serialization in multi-level polymorphic structures.
for (ClientModel derivedType : derivedTypes) {
if (!Objects.equals(polymorphicDiscriminator, derivedType.getPolymorphicDiscriminatorName())) {
ClientModelProperty parentDiscriminator = result.getPolymorphicDiscriminator()
.newBuilder()
.defaultValue(derivedType.getPolymorphicDiscriminator().getDefaultValue())
.build();

passPolymorphicDiscriminatorToChildren(parentDiscriminator, derivedType);
}
}
}

serviceModels.addModel(result);
}

return result;
}

private static void passPolymorphicDiscriminatorToChildren(ClientModelProperty parentDiscriminator,
ClientModel child) {
// Due to the execution order of ModelMapper, where children models complete mapping before the parent model,
// the parent polymorphic discriminator needs to be added at index 0. Reason, given an example where there are
// three models, where model #1 is the root parent with discriminator type, model #2 is a child of model #2 with
// discriminator kind, and model #3 is a child of model #3 with discriminator form. The order if this running
// will have model #2 add its discriminator to model #3 before model #1 runs adding its discriminator to #2 and
// #3. We want #3 to have the ordering of [type, kind], to represent the ordering of the parent models.
child.getParentPolymorphicDiscriminators().add(0, parentDiscriminator);

for (ClientModel derived : child.getDerivedModels()) {
passPolymorphicDiscriminatorToChildren(parentDiscriminator, derived);
}
}

private static class ParentSchemaInfo {
private final ObjectSchema parentSchema;
private final List<ObjectSchema> flattenedParentSchemas;
Expand Down
Loading