Skip to content
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.

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

Feat/handle no payload #687

Merged
merged 7 commits into from
Apr 26, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,32 @@ public class MonetaryAmountConverter implements ModelConverter {

@Override
public Schema resolve(AnnotatedType type, ModelConverterContext context, Iterator<ModelConverter> chain) {
JavaType javaType = Json.mapper().constructType(type.getType());
if (javaType != null) {
Class<?> cls = javaType.getRawClass();
if (javax.money.MonetaryAmount.class.isAssignableFrom(cls))
type = new AnnotatedType(MonetaryAmount.class).resolveAsRef(true);
Class<?> rawClass = getRawClass(type);
boolean isMonetaryAmount = isMonetaryAmountType(rawClass);

if (isMonetaryAmount) {
type = new AnnotatedType(MonetaryAmount.class).resolveAsRef(true);
}

Schema<?> schema = proceedWithChain(type, context, chain);

if (isMonetaryAmount && schema != null && rawClass != null) {
schema.name(rawClass.getName());
}

return schema;
}

private Class<?> getRawClass(AnnotatedType type) {
JavaType javaType = Json.mapper().constructType(type.getType());
return javaType != null ? javaType.getRawClass() : null;
}

private Schema proceedWithChain(AnnotatedType type, ModelConverterContext context, Iterator<ModelConverter> chain) {
return (chain.hasNext()) ? chain.next().resolve(type, context, chain) : null;
}

private boolean isMonetaryAmountType(Class<?> rawClass) {
return javax.money.MonetaryAmount.class.isAssignableFrom(rawClass);
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -6,26 +6,30 @@
import io.swagger.v3.oas.models.media.Schema;
import org.junit.jupiter.api.Test;

import javax.money.MonetaryAmount;
import java.util.Map;

import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertNotNull;
import static org.junit.jupiter.api.Assertions.assertNull;

class MonetaryAmountConverterTest {

private MonetaryAmountConverter modelsConverter = new MonetaryAmountConverter();
private final MonetaryAmountConverter modelsConverter = new MonetaryAmountConverter();

private ModelConverters converters = new ModelConverters();
private final ModelConverters converters = new ModelConverters();

@Test
void testMonetaryAmountConverter() {

// given
converters.addConverter(modelsConverter);

final Schema model =
converters.readAll(new AnnotatedType(MonetaryAmount.class)).get("MonetaryAmount");
// when
final Map<String, Schema> models = converters.readAll(new AnnotatedType(javax.money.MonetaryAmount.class));

// then
final Schema model = models.get("MonetaryAmount");
assertNotNull(model);

assertEquals(2, model.getProperties().size());

final Schema amountProperty = (Schema) model.getProperties().get("amount");
Expand All @@ -36,5 +40,12 @@ void testMonetaryAmountConverter() {

final Schema missingProperty = (Schema) model.getProperties().get("missing");
assertNull(missingProperty);

// then
final Schema originalModel = models.get("javax.money.MonetaryAmount");
assertNotNull(originalModel);

assertNull(originalModel.getType());
assertEquals("#/components/schemas/MonetaryAmount", originalModel.get$ref());
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,12 @@
import io.github.springwolf.asyncapi.v3.model.schema.SchemaObject;
import lombok.EqualsAndHashCode;
import lombok.Getter;
import lombok.ToString;

@Getter
@JsonSerialize(using = MessagePayloadSerializer.class)
@EqualsAndHashCode
@ToString
public class MessagePayload {
private MultiFormatSchema multiFormatSchema;
private SchemaObject schema;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
import lombok.ToString;

@EqualsAndHashCode
@ToString
@NoArgsConstructor
@AllArgsConstructor
public class MessageReference implements Message, Reference {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
import lombok.Data;
import lombok.EqualsAndHashCode;
import lombok.NoArgsConstructor;
import lombok.ToString;

import java.math.BigDecimal;
import java.util.List;
Expand All @@ -31,6 +32,7 @@
@NoArgsConstructor
@AllArgsConstructor
@EqualsAndHashCode(callSuper = true)
@ToString
public class SchemaObject extends ExtendableObject implements Schema {
/**
* Adds support for polymorphism. The discriminator is the schema property name that is used to differentiate
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
import lombok.ToString;

@EqualsAndHashCode
@ToString
@NoArgsConstructor
@AllArgsConstructor
public class SchemaReference implements Schema, Reference {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ public interface ComponentsService {

Map<String, SchemaObject> getSchemas();

SchemaObject resolveSchema(String schemaName);

String registerSchema(SchemaObject headers);

String registerSchema(Class<?> type);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
import io.swagger.v3.oas.models.media.ObjectSchema;
import io.swagger.v3.oas.models.media.Schema;
import io.swagger.v3.oas.models.media.StringSchema;
import jakarta.annotation.Nullable;
import lombok.extern.slf4j.Slf4j;
import org.apache.commons.lang3.StringUtils;

Expand Down Expand Up @@ -60,6 +61,15 @@ public Map<String, SchemaObject> getSchemas() {
.collect(Collectors.toMap(Map.Entry::getKey, Map.Entry::getValue));
}

@Override
@Nullable
public SchemaObject resolveSchema(String schemaName) {
if (schemas.containsKey(schemaName)) {
return swaggerSchemaUtil.mapSchema(schemas.get(schemaName));
}
return null;
}

@Override
public String registerSchema(SchemaObject headers) {
log.debug("Registering schema for {}", headers.getTitle());
Expand All @@ -81,6 +91,7 @@ public String registerSchema(SchemaObject headers) {

@Override
public String registerSchema(Class<?> type) {
// FIXME: Move this to the new HeadersService
return this.registerSchema(type, properties.getDocket().getDefaultContentType());
}

Expand All @@ -90,13 +101,13 @@ public String registerSchema(Class<?> type, String contentType) {
String actualContentType =
StringUtils.isBlank(contentType) ? properties.getDocket().getDefaultContentType() : contentType;

Map<String, Schema> schemas = new LinkedHashMap<>(runWithFqnSetting((unused) -> converter.readAll(type)));
Map<String, Schema> newSchemas = new LinkedHashMap<>(runWithFqnSetting((unused) -> converter.readAll(type)));

String schemaName = getSchemaName(type, schemas);
String schemaName = getSchemaName(type, newSchemas);

preProcessSchemas(schemas, schemaName, type);
schemas.forEach(this.schemas::putIfAbsent);
schemas.values().forEach(schema -> postProcessSchema(schema, actualContentType));
preProcessSchemas(newSchemas, schemaName, type);
newSchemas.forEach(this.schemas::putIfAbsent);
newSchemas.values().forEach(schema -> postProcessSchema(schema, actualContentType));

return schemaName;
}
Expand Down Expand Up @@ -130,11 +141,40 @@ private String getSchemaName(Class<?> type, Map<String, Schema> schemas) {
return new ArrayList<>(resolvedPayloadModelName).get(0);
}

return type.getSimpleName();
return getNameFromClass(type);
}

private void preProcessSchemas(Map<String, Schema> schemas, String schemaName, Class<?> type) {
processCommonModelConverters(schemas);
processAsyncApiPayloadAnnotation(schemas, schemaName, type);
processSchemaAnnotation(schemas, schemaName, type);
}

private void processCommonModelConverters(Map<String, Schema> schemas) {
schemas.values().stream()
.filter(schema -> schema.getType() == null)
.filter(schema -> schema.get$ref() != null)
.forEach(schema -> {
String targetSchemaName = schema.getName();
String sourceSchemaName = StringUtils.substringAfterLast(schema.get$ref(), "/");

Schema<?> actualSchema = schemas.get(sourceSchemaName);
sam0r040 marked this conversation as resolved.
Show resolved Hide resolved

if (actualSchema != null) {
schemas.put(targetSchemaName, actualSchema);
schemas.remove(sourceSchemaName);
}
});
}

private void processSchemaAnnotation(Map<String, Schema> schemas, String schemaName, Class<?> type) {
Schema schemaForType = schemas.get(schemaName);
if (schemaForType != null) {
var schemaAnnotation = type.getAnnotation(io.swagger.v3.oas.annotations.media.Schema.class);
if (schemaAnnotation != null) {
schemaForType.setDescription(schemaAnnotation.description());
}
}
}

private void processAsyncApiPayloadAnnotation(Map<String, Schema> schemas, String schemaName, Class<?> type) {
Expand All @@ -161,9 +201,9 @@ private void processAsyncApiPayloadAnnotation(Map<String, Schema> schemas, Strin
}

private String registerString() {
String schemaName = "String";
String schemaName = getNameFromClass(String.class);
StringSchema schema = new StringSchema();
schema.setName(String.class.getName());
schema.setName(schemaName);

this.schemas.put(schemaName, schema);
postProcessSchema(schema, DEFAULT_CONTENT_TYPE);
Expand All @@ -181,6 +221,13 @@ private <R> R runWithFqnSetting(Function<Void, R> callable) {
return result;
}

private String getNameFromClass(Class<?> type) {
if (properties.isUseFqn()) {
return type.getName();
}
return type.getSimpleName();
}

private void postProcessSchema(Schema schema, String contentType) {
for (SchemasPostProcessor processor : schemaPostProcessors) {
processor.process(schema, schemas, contentType);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@
package io.github.springwolf.core.asyncapi.components.headers;

import io.github.springwolf.asyncapi.v3.model.schema.SchemaObject;
import io.github.springwolf.core.asyncapi.scanners.common.payload.NamedSchemaObject;

public interface AsyncHeadersBuilder {
SchemaObject buildHeaders(Class<?> payloadType);
SchemaObject buildHeaders(NamedSchemaObject payloadSchema);
}
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
package io.github.springwolf.core.asyncapi.components.headers;

import io.github.springwolf.asyncapi.v3.model.schema.SchemaObject;
import io.github.springwolf.core.asyncapi.scanners.common.payload.NamedSchemaObject;

import java.util.List;
import java.util.Map;
Expand All @@ -22,7 +23,7 @@ public class AsyncHeadersNotDocumented implements AsyncHeadersBuilder {
}

@Override
public SchemaObject buildHeaders(Class<?> payloadType) {
public SchemaObject buildHeaders(NamedSchemaObject payloadSchema) {
return NOT_DOCUMENTED;
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
package io.github.springwolf.core.asyncapi.components.headers;

import io.github.springwolf.asyncapi.v3.model.schema.SchemaObject;
import io.github.springwolf.core.asyncapi.scanners.common.payload.NamedSchemaObject;

import java.util.List;
import java.util.Map;
Expand All @@ -21,7 +22,7 @@ public class AsyncHeadersNotUsed implements AsyncHeadersBuilder {
}

@Override
public SchemaObject buildHeaders(Class<?> payloadType) {
public SchemaObject buildHeaders(NamedSchemaObject payloadSchema) {
return NOT_USED;
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
import io.github.springwolf.core.asyncapi.scanners.classes.ClassScanner;
import io.github.springwolf.core.asyncapi.scanners.common.AsyncAnnotationScanner;
import io.github.springwolf.core.asyncapi.scanners.common.payload.PayloadClassExtractor;
import io.github.springwolf.core.asyncapi.scanners.common.payload.PayloadService;
import io.github.springwolf.core.asyncapi.scanners.common.utils.AsyncAnnotationUtil;
import io.github.springwolf.core.configuration.docket.AsyncApiDocketService;
import lombok.extern.slf4j.Slf4j;
Expand All @@ -36,11 +37,13 @@ public AsyncAnnotationChannelsScanner(
ComponentsService componentsService,
AsyncApiDocketService asyncApiDocketService,
PayloadClassExtractor payloadClassExtractor,
PayloadService payloadService,
List<OperationBindingProcessor> operationBindingProcessors,
List<MessageBindingProcessor> messageBindingProcessors) {
super(
asyncAnnotationProvider,
payloadClassExtractor,
payloadService,
componentsService,
operationBindingProcessors,
messageBindingProcessors);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
import io.github.springwolf.core.asyncapi.components.headers.AsyncHeadersBuilder;
import io.github.springwolf.core.asyncapi.scanners.bindings.BindingFactory;
import io.github.springwolf.core.asyncapi.scanners.common.ClassLevelAnnotationScanner;
import io.github.springwolf.core.asyncapi.scanners.common.payload.PayloadClassExtractor;
import io.github.springwolf.core.asyncapi.scanners.common.payload.PayloadService;
import io.github.springwolf.core.asyncapi.scanners.common.utils.AnnotationScannerUtil;
import lombok.extern.slf4j.Slf4j;

Expand All @@ -30,14 +30,14 @@ public SpringAnnotationClassLevelChannelsScanner(
Class<MethodAnnotation> methodAnnotationClass,
BindingFactory<ClassAnnotation> bindingFactory,
AsyncHeadersBuilder asyncHeadersBuilder,
PayloadClassExtractor payloadClassExtractor,
PayloadService payloadService,
ComponentsService componentsService) {
super(
classAnnotationClass,
methodAnnotationClass,
bindingFactory,
asyncHeadersBuilder,
payloadClassExtractor,
payloadService,
componentsService);
}

Expand Down
Loading