DATAMONGO-1849 - Schema derivation from domain type.

JsonSchemaCreator extracts the MongoJsonSchema for a given Class by applying the following mapping rules:

Required Properties:
- All Constructor arguments annotated with Nullable.
- Properties of primitive type.

Ignored Properties:
- All properties annotated with Transient.

Property Type Mapping:
- java.lang.Object -> { type : 'object' }
- java.util.Arrays -> { type : 'array' }
- java.util.Collection -> { type : 'array'}
- java.util.Map -> { type : 'object'}
- java.lang.Enum -> { type : 'string', enum : [ ... ] }
- Simple Types -> { type : 'the corresponding bson type' }
- Domain Types -> { type : 'object', properties : { ... } }

_id properties using types that can be converted into
ObjectId like String will be mapped to { type : 'object' } unless there is more specific information available via the MongoId annotation.

Author: christophstrobl

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/JsonSchemaCreator.java

@@ -0,0 +1,73 @@
+/*
+ * Copyright 2019 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.springframework.data.mongodb.core;
+
+import org.springframework.data.mongodb.core.convert.MongoConverter;
+import org.springframework.data.mongodb.core.schema.MongoJsonSchema;
+import org.springframework.util.Assert;
+
+/**
+ * {@link JsonSchemaCreator} extracts the {@link MongoJsonSchema} for a given {@link Class} by applying the following
+ * mapping rules.
+ * <p>
+ * <strong>Required Properties</strong><br />
+ * - All Constructor arguments annotated with {@link org.springframework.lang.Nullable}. <br />
+ * - Properties of primitive type. <br />
+ * </p>
+ * <p>
+ * <strong>Ignored Properties</strong><br />
+ * - All properties annotated with {@link org.springframework.data.annotation.Transient}. <br />
+ * </p>
+ * <p>
+ * <strong>Property Type Mapping</strong><br />
+ * - {@link java.lang.Object} -> {@code type : 'object'} <br />
+ * - {@link java.util.Arrays} -> {@code type : 'array'} <br />
+ * - {@link java.util.Collection} -> {@code type : 'array'} <br />
+ * - {@link java.util.Map} -> {@code type : 'object'} <br />
+ * - {@link java.lang.Enum} -> {@code type : 'string', enum : [the enum values]} <br />
+ * - Simple Types -> {@code type : 'the corresponding bson type' } <br />
+ * - Domain Types -> {@code type : 'object', properties : &#123;the types properties&#125; } <br />
+ * <br />
+ * {@link org.springframework.data.annotation.Id _id} properties using types that can be converted into
+ * {@link org.bson.types.ObjectId} like {@link String} will be mapped to {@code type : 'object'} unless there is more
+ * specific information available via the {@link org.springframework.data.mongodb.core.mapping.MongoId} annotation.
+ * </p>
+ * 
+ * @author Christoph Strobl
+ * @since 2.2
+ */
+public interface JsonSchemaCreator {
+
+	/**
+	 * Create the {@link MongoJsonSchema} for the given {@link Class type}.
+	 *
+	 * @param type must not be {@literal null}.
+	 * @return never {@literal null}.
+	 */
+	MongoJsonSchema createSchemaFor(Class<?> type);
+
+	/**
+	 * Creates a new {@link JsonSchemaCreator} that is aware of conversions applied by the given {@link MongoConverter}.
+	 *
+	 * @param mongoConverter must not be {@literal null}.
+	 * @return new instance of {@link JsonSchemaCreator}.
+	 */
+	default JsonSchemaCreator jsonSchemaCreator(MongoConverter mongoConverter) {
+
+		Assert.notNull(mongoConverter, "MongoConverter must not be null!");
+		return new MappingJsonSchemaCreator(mongoConverter);
+	}
+}

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/MappingJsonSchemaCreator.java

@@ -0,0 +1,213 @@
+/*
+ * Copyright 2019 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.springframework.data.mongodb.core;
+
+import java.util.ArrayList;
+import java.util.Collection;
+import java.util.Collections;
+import java.util.EnumSet;
+import java.util.List;
+
+import org.springframework.data.mapping.PersistentEntity;
+import org.springframework.data.mapping.PersistentProperty;
+import org.springframework.data.mapping.SimplePropertyHandler;
+import org.springframework.data.mapping.context.MappingContext;
+import org.springframework.data.mongodb.core.convert.MongoConverter;
+import org.springframework.data.mongodb.core.mapping.MongoId;
+import org.springframework.data.mongodb.core.mapping.MongoPersistentProperty;
+import org.springframework.data.mongodb.core.schema.IdentifiableJsonSchemaProperty.ObjectJsonSchemaProperty;
+import org.springframework.data.mongodb.core.schema.JsonSchemaObject;
+import org.springframework.data.mongodb.core.schema.JsonSchemaObject.Type;
+import org.springframework.data.mongodb.core.schema.JsonSchemaProperty;
+import org.springframework.data.mongodb.core.schema.MongoJsonSchema;
+import org.springframework.data.mongodb.core.schema.MongoJsonSchema.MongoJsonSchemaBuilder;
+import org.springframework.data.mongodb.core.schema.TypedJsonSchemaObject;
+import org.springframework.lang.Nullable;
+import org.springframework.util.Assert;
+import org.springframework.util.ClassUtils;
+import org.springframework.util.CollectionUtils;
+import org.springframework.util.ObjectUtils;
+
+/**
+ * {@link JsonSchemaCreator} implementation using both {@link MongoConverter} and {@link MappingContext} to obtain
+ * domain type meta information which considers {@link org.springframework.data.mongodb.core.mapping.Field field names}
+ * and {@link org.springframework.data.mongodb.core.convert.MongoCustomConversions custom conversions}.
+ * 
+ * @author Christoph Strobl
+ * @since 2.2
+ */
+class MappingJsonSchemaCreator implements JsonSchemaCreator {
+
+	private MongoConverter converter;
+	private MappingContext mappingContext;
+
+	/**
+	 * Create a new instance of {@link MappingJsonSchemaCreator}.
+	 *
+	 * @param converter must not be {@literal null}.
+	 */
+	MappingJsonSchemaCreator(MongoConverter converter) {
+
+		Assert.notNull(converter, "Converter must not be null!");
+		this.converter = converter;
+		this.mappingContext = converter.getMappingContext();
+
+	}
+
+	/*
+	 * (non-Javadoc)
+	 * org.springframework.data.mongodb.core.JsonSchemaCreator#createSchemaFor(java.lang.Class)
+	 */
+	@Override
+	public MongoJsonSchema createSchemaFor(Class<?> type) {
+
+		PersistentEntity<?, ?> entity = mappingContext.getPersistentEntity(type);
+		MongoJsonSchemaBuilder schemaBuilder = MongoJsonSchema.builder();
+
+		List<JsonSchemaProperty> schemaProperties = computePropertiesForEntity(Collections.emptyList(), entity);
+		schemaBuilder.properties(schemaProperties.toArray(new JsonSchemaProperty[0]));
+
+		return schemaBuilder.build();
+
+	}
+
+	private List<JsonSchemaProperty> computePropertiesForEntity(List<PersistentProperty> path,
+			PersistentEntity<?, ?> entity) {
+
+		List<JsonSchemaProperty> schemaProperties = new ArrayList<>();
+		entity.doWithProperties((SimplePropertyHandler) nested -> {
+
+			ArrayList<PersistentProperty> currentPath = new ArrayList<>(path);
+
+			if (path.contains(nested)) { // cycle guard
+				schemaProperties.add(createSchemaProperty(computePropertyFieldName(CollectionUtils.lastElement(currentPath)),
+						Object.class, false));
+				return;
+			}
+
+			currentPath.add(nested);
+			JsonSchemaProperty jsonSchemaProperty = computeSchemaForProperty(currentPath, entity);
+			if (jsonSchemaProperty != null) {
+				schemaProperties.add(jsonSchemaProperty);
+			}
+		});
+
+		return schemaProperties;
+	}
+
+	private JsonSchemaProperty computeSchemaForProperty(List<PersistentProperty> path, PersistentEntity<?, ?> parent) {
+
+		PersistentProperty property = CollectionUtils.lastElement(path);
+
+		boolean required = isRequiredProperty(parent, property);
+		Class<?> rawTargetType = computeTargetType(property); // target type before conversion
+		Class<?> targetType = converter.computeWriteTarget(rawTargetType); // conversion target type
+
+		if (property.isEntity() && ObjectUtils.nullSafeEquals(rawTargetType, targetType)) {
+			return createObjectSchemaPropertyForEntity(path, property, required);
+		}
+
+		String fieldName = computePropertyFieldName(property);
+
+		if (property.isCollectionLike()) {
+			return createSchemaProperty(fieldName, targetType, required);
+		} else if (property.isMap()) {
+			return createSchemaProperty(fieldName, Type.objectType(), required);
+		} else if (ClassUtils.isAssignable(Enum.class, targetType)) {
+			return createEnumSchemaProperty(fieldName, targetType, required);
+		}
+
+		return createSchemaProperty(fieldName, targetType, required);
+	}
+
+	private JsonSchemaProperty createObjectSchemaPropertyForEntity(List<PersistentProperty> path,
+			PersistentProperty property, boolean required) {
+
+		ObjectJsonSchemaProperty target = JsonSchemaProperty.object(property.getName());
+		List<JsonSchemaProperty> nestedProperties = computePropertiesForEntity(path,
+				mappingContext.getPersistentEntity(property));
+
+		return createPotentiallyRequiredSchemaProperty(
+				target.properties(nestedProperties.toArray(new JsonSchemaProperty[0])), required);
+	}
+
+	private JsonSchemaProperty createEnumSchemaProperty(String fieldName, Class<?> targetType, boolean required) {
+
+		List<Object> possibleValues = new ArrayList<>();
+		for (Object enumValue : EnumSet.allOf((Class) targetType)) {
+			possibleValues.add(converter.convertToMongoType(enumValue));
+		}
+
+		targetType = possibleValues.isEmpty() ? targetType : possibleValues.iterator().next().getClass();
+		return createSchemaProperty(fieldName, targetType, required, possibleValues);
+	}
+
+	JsonSchemaProperty createSchemaProperty(String fieldName, Object type, boolean required) {
+		return createSchemaProperty(fieldName, type, required, Collections.emptyList());
+	}
+
+	JsonSchemaProperty createSchemaProperty(String fieldName, Object type, boolean required,
+			Collection<?> possibleValues) {
+
+		TypedJsonSchemaObject schemaObject = type instanceof Type ? JsonSchemaObject.of(Type.class.cast(type))
+				: JsonSchemaObject.of(Class.class.cast(type));
+
+		if (!CollectionUtils.isEmpty(possibleValues)) {
+			schemaObject = schemaObject.possibleValues(possibleValues);
+		}
+
+		return createPotentiallyRequiredSchemaProperty(JsonSchemaProperty.named(fieldName).with(schemaObject), required);
+	}
+
+	private String computePropertyFieldName(PersistentProperty property) {
+
+		return property instanceof MongoPersistentProperty ? ((MongoPersistentProperty) property).getFieldName()
+				: property.getName();
+	}
+
+	private boolean isRequiredProperty(PersistentEntity<?, ?> parent, PersistentProperty property) {
+
+		return (parent.isConstructorArgument(property) && !property.isAnnotationPresent(Nullable.class))
+				|| property.getType().isPrimitive();
+	}
+
+	private Class<?> computeTargetType(PersistentProperty<?> property) {
+
+		if (!(property instanceof MongoPersistentProperty)) {
+			return property.getType();
+		}
+
+		MongoPersistentProperty mongoProperty = (MongoPersistentProperty) property;
+		if (!mongoProperty.isIdProperty()) {
+			return mongoProperty.getFieldType();
+		}
+
+		if (mongoProperty.isAnnotationPresent(MongoId.class)) {
+			return mongoProperty.findAnnotation(MongoId.class).value().getJavaClass();
+		}
+
+		return mongoProperty.getFieldType() != mongoProperty.getActualType() ? Object.class : mongoProperty.getFieldType();
+	}
+
+	static JsonSchemaProperty createPotentiallyRequiredSchemaProperty(JsonSchemaProperty property, boolean required) {
+
+		if (!required) {
+			return property;
+		}
+
+		return JsonSchemaProperty.required(property);
+	}
+}

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/convert/AbstractMongoConverter.java

@@ -105,6 +105,15 @@ public ConversionService getConversionService() {
 		return conversionService;
 	}
 
+	/*
+	 * (non-Javadoc)
+	 * @see org.springframework.data.mongodb.core.convert.MongoConverter#computeWriteTarget(java.lang.class)
+	 */
+	@Override
+	public Class<?> computeWriteTarget(Class<?> source) {
+		return conversions.getCustomWriteTarget(source).orElse(source);
+	}
+
 	/* (non-Javadoc)
 	 * @see org.springframework.beans.factory.InitializingBean#afterPropertiesSet()
 	 */

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/convert/MongoConverter.java

@@ -149,4 +149,15 @@ default Object convertId(@Nullable Object id, Class<?> targetType) {
 			return convertToMongoType(id, null);
 		}
 	}
+
+	/**
+	 * Compute the target type for a given source considering {@link org.springframework.data.convert.CustomConversions}.
+	 *
+	 * @param source the source type.
+	 * @return never {@literal null}.
+	 * @since 2.2
+	 */
+	default Class<?> computeWriteTarget(Class<?> source) {
+		return source;
+	}
 }

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/schema/IdentifiableJsonSchemaProperty.java

@@ -953,7 +953,7 @@ public DateJsonSchemaProperty description(String description) {
 
 		/**
 		 * @return new instance of {@link DateJsonSchemaProperty}.
-		 * @see DateJsonSchemaProperty#generateDescription()
+		 * @see DateJsonSchemaProperty#generatedDescription()
 		 */
 		public DateJsonSchemaProperty generatedDescription() {
 			return new DateJsonSchemaProperty(identifier, jsonSchemaObjectDelegate.generatedDescription());
@@ -983,10 +983,65 @@ public TimestampJsonSchemaProperty description(String description) {
 
 		/**
 		 * @return new instance of {@link TimestampJsonSchemaProperty}.
-		 * @see TimestampJsonSchemaProperty#generateDescription()
+		 * @see TimestampJsonSchemaProperty#generatedDescription()
 		 */
 		public TimestampJsonSchemaProperty generatedDescription() {
 			return new TimestampJsonSchemaProperty(identifier, jsonSchemaObjectDelegate.generatedDescription());
 		}
 	}
+
+	/**
+	 * Delegating {@link JsonSchemaProperty} implementation having a {@literal required} flag for evaluation during schema
+	 * creation process.
+	 *
+	 * @author Christoph Strobl
+	 * @since 2.2
+	 */
+	public static class RequiredJsonSchemaProperty implements JsonSchemaProperty {
+
+		private final JsonSchemaProperty delegate;
+		private final boolean required;
+
+		RequiredJsonSchemaProperty(JsonSchemaProperty delegate, boolean required) {
+
+			this.delegate = delegate;
+			this.required = required;
+		}
+
+		/*
+		 * (non-Javadoc)
+		 * @see org.springframework.data.mongodb.core.schema.JsonSchemaProperty#getIdentifier()
+		 */
+		@Override
+		public String getIdentifier() {
+			return delegate.getIdentifier();
+		}
+
+		/*
+		 * (non-Javadoc)
+		 * @see org.springframework.data.mongodb.core.schema.JsonSchemaObject#getTypes()
+		 */
+		@Override
+		public Set<Type> getTypes() {
+			return delegate.getTypes();
+		}
+
+		/*
+		 * (non-Javadoc)
+		 * @see org.springframework.data.mongodb.core.schema.JsonSchemaObject#toDocument()
+		 */
+		@Override
+		public Document toDocument() {
+			return delegate.toDocument();
+		}
+
+		/*
+		 * (non-Javadoc)
+		 * @see org.springframework.data.mongodb.core.schema.JsonSchemaProperty#isRequired()
+		 */
+		@Override
+		public boolean isRequired() {
+			return required;
+		}
+	}
 }