From 146b90a7555bb4f54eb0c48befe182f6489a181e Mon Sep 17 00:00:00 2001 From: Christoph Strobl Date: Thu, 19 May 2022 15:28:02 +0200 Subject: [PATCH 1/2] Prepare issue branch. --- pom.xml | 2 +- spring-data-mongodb-benchmarks/pom.xml | 2 +- spring-data-mongodb-distribution/pom.xml | 2 +- spring-data-mongodb/pom.xml | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/pom.xml b/pom.xml index 79e5353b7f..4d94952716 100644 --- a/pom.xml +++ b/pom.xml @@ -5,7 +5,7 @@ org.springframework.data spring-data-mongodb-parent - 4.0.0-SNAPSHOT + 4.0.0-GH-4038-SNAPSHOT pom Spring Data MongoDB diff --git a/spring-data-mongodb-benchmarks/pom.xml b/spring-data-mongodb-benchmarks/pom.xml index c28a240d2c..d62eca71cb 100644 --- a/spring-data-mongodb-benchmarks/pom.xml +++ b/spring-data-mongodb-benchmarks/pom.xml @@ -7,7 +7,7 @@ org.springframework.data spring-data-mongodb-parent - 4.0.0-SNAPSHOT + 4.0.0-GH-4038-SNAPSHOT ../pom.xml diff --git a/spring-data-mongodb-distribution/pom.xml b/spring-data-mongodb-distribution/pom.xml index 5dedcf81ed..23f1c64f69 100644 --- a/spring-data-mongodb-distribution/pom.xml +++ b/spring-data-mongodb-distribution/pom.xml @@ -15,7 +15,7 @@ org.springframework.data spring-data-mongodb-parent - 4.0.0-SNAPSHOT + 4.0.0-GH-4038-SNAPSHOT ../pom.xml diff --git a/spring-data-mongodb/pom.xml b/spring-data-mongodb/pom.xml index b26a926c7a..d60bdd8e3c 100644 --- a/spring-data-mongodb/pom.xml +++ b/spring-data-mongodb/pom.xml @@ -12,7 +12,7 @@ org.springframework.data spring-data-mongodb-parent - 4.0.0-SNAPSHOT + 4.0.0-GH-4038-SNAPSHOT ../pom.xml From 65517e9bc387eb3d448c29b0242d1049e893b190 Mon Sep 17 00:00:00 2001 From: Christoph Strobl Date: Fri, 20 May 2022 09:44:45 +0200 Subject: [PATCH 2/2] Simplify usage of user provided aggregation operations. Introduce Aggregation.stage which allows to use a plain JSON String or any valid Bson representation to be used within an aggregation pipeline stage, without having to implement AggregationOperation directly. The change allows to make use of driver native builder API for aggregates. --- .../mongodb/core/aggregation/Aggregation.java | 35 ++++++++ .../AggregationOperationContext.java | 11 ++- .../BasicAggregationOperation.java | 61 +++++++++++++ ...osedFieldsAggregationOperationContext.java | 6 ++ ...ExpressionAggregationOperationContext.java | 6 ++ ...DelegatingAggregationOperationContext.java | 6 ++ .../TypeBasedAggregationOperationContext.java | 6 ++ .../core/convert/MappingMongoConverter.java | 6 ++ .../mongodb/core/convert/MongoConverter.java | 11 ++- .../mongodb/core/convert/QueryMapper.java | 4 + .../data/mongodb/util/BsonUtils.java | 55 +++++++++--- .../aggregation/TestAggregationContext.java | 6 ++ .../aggregation/AggregationUnitTests.java | 40 +++++++-- .../BasicAggregationOperationUnitTests.java | 89 +++++++++++++++++++ .../reference/aggregation-framework.adoc | 20 +++++ 15 files changed, 340 insertions(+), 22 deletions(-) create mode 100644 spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/aggregation/BasicAggregationOperation.java create mode 100644 spring-data-mongodb/src/test/java/org/springframework/data/mongodb/core/aggregation/BasicAggregationOperationUnitTests.java diff --git a/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/aggregation/Aggregation.java b/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/aggregation/Aggregation.java index f8e56e1106..68940846fa 100644 --- a/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/aggregation/Aggregation.java +++ b/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/aggregation/Aggregation.java @@ -21,6 +21,7 @@ import java.util.List; import org.bson.Document; +import org.bson.conversions.Bson; import org.springframework.data.domain.Sort; import org.springframework.data.domain.Sort.Direction; import org.springframework.data.mongodb.core.aggregation.AddFieldsOperation.AddFieldsOperationBuilder; @@ -238,6 +239,40 @@ public static AddFieldsOperationBuilder addFields() { return AddFieldsOperation.builder(); } + /** + * Creates a new {@link AggregationOperation} taking the given {@link Bson bson value} as is.
+ * + * 
+	 * Aggregation.stage(Aggregates.search(exists(fieldPath("..."))));
+	 *
+ * + * Field mapping against a potential domain type or previous aggregation stages will not happen. + * + * @param aggregationOperation the must not be {@literal null}. + * @return new instance of {@link AggregationOperation}. + * @since 4.0 + */ + public static AggregationOperation stage(Bson aggregationOperation) { + return new BasicAggregationOperation(aggregationOperation); + } + + /** + * Creates a new {@link AggregationOperation} taking the given {@link String json value} as is.
+ * + * 
+	 * Aggregation.stage("{ $search : { near : { path : 'released' , origin : ... } } }");
+	 *
+ * + * Field mapping against a potential domain type or previous aggregation stages will not happen. + * + * @param json the JSON representation of the pipeline stage. Must not be {@literal null}. + * @return new instance of {@link AggregationOperation}. + * @since 4.0 + */ + public static AggregationOperation stage(String json) { + return new BasicAggregationOperation(json); + } + /** * Creates a new {@link ProjectionOperation} including the given fields. * diff --git a/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/aggregation/AggregationOperationContext.java b/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/aggregation/AggregationOperationContext.java index 89029952eb..6e483e969a 100644 --- a/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/aggregation/AggregationOperationContext.java +++ b/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/aggregation/AggregationOperationContext.java @@ -20,12 +20,16 @@ import java.util.Arrays; import org.bson.Document; +import org.bson.codecs.configuration.CodecRegistry; import org.springframework.beans.BeanUtils; +import org.springframework.data.mongodb.CodecRegistryProvider; import org.springframework.data.mongodb.core.aggregation.ExposedFields.FieldReference; import org.springframework.lang.Nullable; import org.springframework.util.Assert; import org.springframework.util.ReflectionUtils; +import com.mongodb.MongoClientSettings; + /** * The context for an {@link AggregationOperation}. * @@ -33,7 +37,7 @@ * @author Christoph Strobl * @since 1.3 */ -public interface AggregationOperationContext { +public interface AggregationOperationContext extends CodecRegistryProvider { /** * Returns the mapped {@link Document}, potentially converting the source considering mapping metadata etc. @@ -114,4 +118,9 @@ default Fields getFields(Class type) { default AggregationOperationContext continueOnMissingFieldReference() { return this; } + + @Override + default CodecRegistry getCodecRegistry() { + return MongoClientSettings.getDefaultCodecRegistry(); + } } diff --git a/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/aggregation/BasicAggregationOperation.java b/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/aggregation/BasicAggregationOperation.java new file mode 100644 index 0000000000..9f4eeb2239 --- /dev/null +++ b/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/aggregation/BasicAggregationOperation.java @@ -0,0 +1,61 @@ +/* + * Copyright 2022 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.aggregation; + +import java.util.Map; + +import org.bson.Document; +import org.bson.conversions.Bson; +import org.springframework.data.mongodb.util.BsonUtils; +import org.springframework.util.ObjectUtils; + +/** + * {@link AggregationOperation} implementation that c + * + * @author Christoph Strobl + * @since 4.0 + */ +class BasicAggregationOperation implements AggregationOperation { + + private final Object value; + + BasicAggregationOperation(Object value) { + this.value = value; + } + + @Override + public Document toDocument(AggregationOperationContext context) { + + if (value instanceof Document document) { + return document; + } + + if (value instanceof Bson bson) { + return BsonUtils.asDocument(bson, context.getCodecRegistry()); + } + + if (value instanceof Map map) { + return new Document(map); + } + + if (value instanceof String json && BsonUtils.isJsonDocument(json)) { + return BsonUtils.parse(json, context); + } + + throw new IllegalStateException( + String.format("%s cannot be converted to org.bson.Document.", ObjectUtils.nullSafeClassName(value))); + } +} diff --git a/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/aggregation/ExposedFieldsAggregationOperationContext.java b/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/aggregation/ExposedFieldsAggregationOperationContext.java index fc640c36bb..451ace94cf 100644 --- a/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/aggregation/ExposedFieldsAggregationOperationContext.java +++ b/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/aggregation/ExposedFieldsAggregationOperationContext.java @@ -16,6 +16,7 @@ package org.springframework.data.mongodb.core.aggregation; import org.bson.Document; +import org.bson.codecs.configuration.CodecRegistry; import org.springframework.data.mongodb.core.aggregation.ExposedFields.DirectFieldReference; import org.springframework.data.mongodb.core.aggregation.ExposedFields.ExposedField; import org.springframework.data.mongodb.core.aggregation.ExposedFields.FieldReference; @@ -141,4 +142,9 @@ protected FieldReference resolveExposedField(@Nullable Field field, String name) AggregationOperationContext getRootContext() { return rootContext; } + + @Override + public CodecRegistry getCodecRegistry() { + return getRootContext().getCodecRegistry(); + } } diff --git a/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/aggregation/NestedDelegatingExpressionAggregationOperationContext.java b/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/aggregation/NestedDelegatingExpressionAggregationOperationContext.java index e7094e0ed1..a9e596d41c 100644 --- a/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/aggregation/NestedDelegatingExpressionAggregationOperationContext.java +++ b/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/aggregation/NestedDelegatingExpressionAggregationOperationContext.java @@ -19,6 +19,7 @@ import org.bson.Document; +import org.bson.codecs.configuration.CodecRegistry; import org.springframework.data.mongodb.core.aggregation.ExposedFields.ExpressionFieldReference; import org.springframework.data.mongodb.core.aggregation.ExposedFields.FieldReference; import org.springframework.util.Assert; @@ -92,4 +93,9 @@ public FieldReference getReference(String name) { public Fields getFields(Class type) { return delegate.getFields(type); } + + @Override + public CodecRegistry getCodecRegistry() { + return delegate.getCodecRegistry(); + } } diff --git a/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/aggregation/PrefixingDelegatingAggregationOperationContext.java b/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/aggregation/PrefixingDelegatingAggregationOperationContext.java index 500106a275..bf4b0d2dc3 100644 --- a/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/aggregation/PrefixingDelegatingAggregationOperationContext.java +++ b/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/aggregation/PrefixingDelegatingAggregationOperationContext.java @@ -24,6 +24,7 @@ import java.util.Set; import org.bson.Document; +import org.bson.codecs.configuration.CodecRegistry; import org.springframework.data.mongodb.core.aggregation.ExposedFields.FieldReference; import org.springframework.lang.Nullable; @@ -80,6 +81,11 @@ public Fields getFields(Class type) { return delegate.getFields(type); } + @Override + public CodecRegistry getCodecRegistry() { + return delegate.getCodecRegistry(); + } + @SuppressWarnings("unchecked") private Document doPrefix(Document source) { diff --git a/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/aggregation/TypeBasedAggregationOperationContext.java b/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/aggregation/TypeBasedAggregationOperationContext.java index 1cd0fd7426..f59a631a13 100644 --- a/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/aggregation/TypeBasedAggregationOperationContext.java +++ b/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/aggregation/TypeBasedAggregationOperationContext.java @@ -22,6 +22,7 @@ import org.bson.Document; +import org.bson.codecs.configuration.CodecRegistry; import org.springframework.data.mapping.PersistentPropertyPath; import org.springframework.data.mapping.context.MappingContext; import org.springframework.data.mongodb.core.aggregation.ExposedFields.DirectFieldReference; @@ -147,4 +148,9 @@ protected FieldReference getReferenceFor(Field field) { public Class getType() { return type; } + + @Override + public CodecRegistry getCodecRegistry() { + return this.mapper.getConverter().getCodecRegistry(); + } } diff --git a/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/convert/MappingMongoConverter.java b/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/convert/MappingMongoConverter.java index 9c45821023..719c1e7a94 100644 --- a/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/convert/MappingMongoConverter.java +++ b/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/convert/MappingMongoConverter.java @@ -26,6 +26,7 @@ import org.bson.Document; import org.bson.codecs.Codec; import org.bson.codecs.DecoderContext; +import org.bson.codecs.configuration.CodecRegistry; import org.bson.conversions.Bson; import org.bson.json.JsonReader; import org.bson.types.ObjectId; @@ -1793,6 +1794,11 @@ public Class getWriteTarget(Class source) { return conversions.getCustomWriteTarget(source).orElse(source); } + @Override + public CodecRegistry getCodecRegistry() { + return codecRegistryProvider != null ? codecRegistryProvider.getCodecRegistry() : super.getCodecRegistry(); + } + /** * Create a new {@link MappingMongoConverter} using the given {@link MongoDatabaseFactory} when loading {@link DBRef}. * diff --git a/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/convert/MongoConverter.java b/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/convert/MongoConverter.java index 489b3ddfbe..8fe754084d 100644 --- a/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/convert/MongoConverter.java +++ b/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/convert/MongoConverter.java @@ -15,16 +15,18 @@ */ package org.springframework.data.mongodb.core.convert; +import com.mongodb.MongoClientSettings; import org.bson.BsonValue; import org.bson.Document; +import org.bson.codecs.configuration.CodecRegistry; import org.bson.conversions.Bson; import org.bson.types.ObjectId; - import org.springframework.core.convert.ConversionException; import org.springframework.data.convert.CustomConversions; import org.springframework.data.convert.EntityConverter; import org.springframework.data.convert.EntityReader; import org.springframework.data.convert.TypeMapper; +import org.springframework.data.mongodb.CodecRegistryProvider; import org.springframework.data.mongodb.core.mapping.MongoPersistentEntity; import org.springframework.data.mongodb.core.mapping.MongoPersistentProperty; import org.springframework.data.mongodb.util.BsonUtils; @@ -48,7 +50,7 @@ */ public interface MongoConverter extends EntityConverter, MongoPersistentProperty, Object, Bson>, MongoWriter, - EntityReader { + EntityReader, CodecRegistryProvider { /** * Returns the {@link TypeMapper} being used to write type information into {@link Document}s created with that @@ -188,4 +190,9 @@ default Object convertId(@Nullable Object id, Class targetType) { } } + @Override + default CodecRegistry getCodecRegistry() { + return MongoClientSettings.getDefaultCodecRegistry(); + } + } diff --git a/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/convert/QueryMapper.java b/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/convert/QueryMapper.java index 2a6e7fb4a5..6361137af6 100644 --- a/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/convert/QueryMapper.java +++ b/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/convert/QueryMapper.java @@ -1486,4 +1486,8 @@ public String convert(MongoPersistentProperty source) { public MappingContext, MongoPersistentProperty> getMappingContext() { return mappingContext; } + + public MongoConverter getConverter() { + return converter; + } } diff --git a/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/util/BsonUtils.java b/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/util/BsonUtils.java index a6f7b4d5f2..4ae026a3e2 100644 --- a/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/util/BsonUtils.java +++ b/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/util/BsonUtils.java @@ -35,6 +35,7 @@ import org.bson.BsonValue; import org.bson.Document; import org.bson.codecs.DocumentCodec; +import org.bson.codecs.configuration.CodecRegistry; import org.bson.conversions.Bson; import org.bson.json.JsonParseException; import org.bson.types.ObjectId; @@ -81,18 +82,36 @@ public static T get(Bson bson, String key) { * @return */ public static Map asMap(Bson bson) { + return asMap(bson, MongoClientSettings.getDefaultCodecRegistry()); + } - if (bson instanceof Document) { - return (Document) bson; + /** + * Return the {@link Bson} object as {@link Map}. Depending on the input type, the return value can be either a casted + * version of {@code bson} or a converted (detached from the original value) using the given {@link CodecRegistry} to + * obtain {@link org.bson.codecs.Codec codecs} that might be required for conversion. + * + * @param bson can be {@literal null}. + * @param codecRegistry must not be {@literal null}. + * @return never {@literal null}. Returns an empty {@link Map} if input {@link Bson} is {@literal null}. + * @since 4.0 + */ + public static Map asMap(@Nullable Bson bson, CodecRegistry codecRegistry) { + + if (bson == null) { + return Collections.emptyMap(); } - if (bson instanceof BasicDBObject) { - return ((BasicDBObject) bson); + + if (bson instanceof Document document) { + return document; } - if (bson instanceof DBObject) { - return ((DBObject) bson).toMap(); + if (bson instanceof BasicDBObject dbo) { + return dbo; + } + if (bson instanceof DBObject dbo) { + return dbo.toMap(); } - return (Map) bson.toBsonDocument(Document.class, MongoClientSettings.getDefaultCodecRegistry()); + return new Document((Map) bson.toBsonDocument(Document.class, codecRegistry)); } /** @@ -104,12 +123,26 @@ public static Map asMap(Bson bson) { * @since 3.2.5 */ public static Document asDocument(Bson bson) { + return asDocument(bson, MongoClientSettings.getDefaultCodecRegistry()); + } - if (bson instanceof Document) { - return (Document) bson; + /** + * Return the {@link Bson} object as {@link Document}. Depending on the input type, the return value can be either a + * casted version of {@code bson} or a converted (detached from the original value) using the given + * {@link CodecRegistry} to obtain {@link org.bson.codecs.Codec codecs} that might be required for conversion. + * + * @param bson + * @param codecRegistry must not be {@literal null}. + * @return never {@literal null}. + * @since 4.0 + */ + public static Document asDocument(Bson bson, CodecRegistry codecRegistry) { + + if (bson instanceof Document document) { + return document; } - Map map = asMap(bson); + Map map = asMap(bson, codecRegistry); if (map instanceof Document) { return (Document) map; @@ -413,7 +446,7 @@ public static String toJson(@Nullable Document source) { */ public static boolean isJsonDocument(@Nullable String value) { - if(!StringUtils.hasText(value)) { + if (!StringUtils.hasText(value)) { return false; } diff --git a/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/util/aggregation/TestAggregationContext.java b/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/util/aggregation/TestAggregationContext.java index ffd98a5c06..d8924237c4 100644 --- a/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/util/aggregation/TestAggregationContext.java +++ b/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/util/aggregation/TestAggregationContext.java @@ -16,6 +16,7 @@ package org.springframework.data.mongodb.util.aggregation; import org.bson.Document; +import org.bson.codecs.configuration.CodecRegistry; import org.springframework.data.mongodb.core.aggregation.Aggregation; import org.springframework.data.mongodb.core.aggregation.AggregationOperationContext; import org.springframework.data.mongodb.core.aggregation.ExposedFields.FieldReference; @@ -72,4 +73,9 @@ public FieldReference getReference(Field field) { public FieldReference getReference(String name) { return delegate.getReference(name); } + + @Override + public CodecRegistry getCodecRegistry() { + return delegate.getCodecRegistry(); + } } diff --git a/spring-data-mongodb/src/test/java/org/springframework/data/mongodb/core/aggregation/AggregationUnitTests.java b/spring-data-mongodb/src/test/java/org/springframework/data/mongodb/core/aggregation/AggregationUnitTests.java index e843de1b15..43e15cac5d 100755 --- a/spring-data-mongodb/src/test/java/org/springframework/data/mongodb/core/aggregation/AggregationUnitTests.java +++ b/spring-data-mongodb/src/test/java/org/springframework/data/mongodb/core/aggregation/AggregationUnitTests.java @@ -24,6 +24,7 @@ import java.util.Arrays; import java.util.Collections; import java.util.List; +import java.util.Map; import org.bson.Document; import org.junit.jupiter.api.Test; @@ -37,6 +38,9 @@ import org.springframework.data.mongodb.core.mapping.MongoMappingContext; import org.springframework.data.mongodb.core.query.Criteria; +import com.mongodb.client.model.Aggregates; +import com.mongodb.client.model.Projections; + /** * Unit tests for {@link Aggregation}. * @@ -599,31 +603,51 @@ void projectOnIdIsAlwaysValid() { assertThat(extractPipelineElement(target, 1, "$project")).isEqualTo(Document.parse(" { \"_id\" : \"$_id\" }")); } - @Test // GH-3898 void shouldNotConvertIncludeExcludeValuesForProjectOperation() { MongoMappingContext mappingContext = new MongoMappingContext(); - RelaxedTypeBasedAggregationOperationContext context = new RelaxedTypeBasedAggregationOperationContext(WithRetypedIdField.class, mappingContext, + RelaxedTypeBasedAggregationOperationContext context = new RelaxedTypeBasedAggregationOperationContext( + WithRetypedIdField.class, mappingContext, new QueryMapper(new MappingMongoConverter(NoOpDbRefResolver.INSTANCE, mappingContext))); Document document = project(WithRetypedIdField.class).toDocument(context); assertThat(document).isEqualTo(new Document("$project", new Document("_id", 1).append("renamed-field", 1))); } + @Test // GH-4038 + void createsBasicAggregationOperationFromJsonString() { + + AggregationOperation stage = stage("{ $project : { name : 1} }"); + Document target = newAggregation(stage).toDocument("col-1", DEFAULT_CONTEXT); + assertThat(extractPipelineElement(target, 0, "$project")).containsEntry("name", 1); + } + + @Test // GH-4038 + void createsBasicAggregationOperationFromBson() { + + AggregationOperation stage = stage(Aggregates.project(Projections.fields(Projections.include("name")))); + Document target = newAggregation(stage).toDocument("col-1", DEFAULT_CONTEXT); + assertThat(extractPipelineElement(target, 0, "$project")).containsKey("name"); + } + private Document extractPipelineElement(Document agg, int index, String operation) { List pipeline = (List) agg.get("pipeline"); - return (Document) pipeline.get(index).get(operation); + Object value = pipeline.get(index).get(operation); + if (value instanceof Document document) { + return document; + } + if (value instanceof Map map) { + return new Document(map); + } + throw new IllegalArgumentException(); } public class WithRetypedIdField { - @Id - @org.springframework.data.mongodb.core.mapping.Field - private String id; + @Id @org.springframework.data.mongodb.core.mapping.Field private String id; - @org.springframework.data.mongodb.core.mapping.Field("renamed-field") - private String foo; + @org.springframework.data.mongodb.core.mapping.Field("renamed-field") private String foo; } } diff --git a/spring-data-mongodb/src/test/java/org/springframework/data/mongodb/core/aggregation/BasicAggregationOperationUnitTests.java b/spring-data-mongodb/src/test/java/org/springframework/data/mongodb/core/aggregation/BasicAggregationOperationUnitTests.java new file mode 100644 index 0000000000..eda2309cf5 --- /dev/null +++ b/spring-data-mongodb/src/test/java/org/springframework/data/mongodb/core/aggregation/BasicAggregationOperationUnitTests.java @@ -0,0 +1,89 @@ +/* + * Copyright 2022 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.aggregation; + +import static org.assertj.core.api.Assertions.*; +import static org.mockito.Mockito.*; + +import org.bson.Document; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.extension.ExtendWith; +import org.mockito.Mock; +import org.mockito.junit.jupiter.MockitoExtension; +import org.mockito.junit.jupiter.MockitoSettings; +import org.mockito.quality.Strictness; +import org.springframework.data.mongodb.core.convert.MongoConverter; +import org.springframework.data.mongodb.core.convert.QueryMapper; +import org.springframework.data.mongodb.core.mapping.Field; +import org.springframework.data.mongodb.core.mapping.MongoMappingContext; + +import com.mongodb.MongoClientSettings; + +/** + * @author Christoph Strobl + */ +@ExtendWith(MockitoExtension.class) +@MockitoSettings(strictness = Strictness.LENIENT) +class BasicAggregationOperationUnitTests { + + @Mock QueryMapper queryMapper; + @Mock MongoConverter converter; + + TypeBasedAggregationOperationContext ctx; + + @BeforeEach + void beforeEach() { + + // no field mapping though having a type based context + ctx = new TypeBasedAggregationOperationContext(Person.class, new MongoMappingContext(), queryMapper); + when(queryMapper.getConverter()).thenReturn(converter); + when(converter.getCodecRegistry()).thenReturn(MongoClientSettings.getDefaultCodecRegistry()); + } + + @Test // GH-4038 + void usesGivenDocumentAsIs() { + + Document source = new Document("value", 1); + assertThat(new BasicAggregationOperation(source).toDocument(ctx)).isSameAs(source); + } + + @Test // GH-4038 + void parsesJson() { + + Document source = new Document("value", 1); + assertThat(new BasicAggregationOperation(source.toJson()).toDocument(ctx)).isEqualTo(source); + } + + @Test // GH-4038 + void errorsOnInvalidValue() { + + BasicAggregationOperation agg = new BasicAggregationOperation(new Object()); + assertThatExceptionOfType(IllegalStateException.class).isThrownBy(() -> agg.toDocument(ctx)); + } + + @Test // GH-4038 + void errorsOnNonJsonSting() { + + BasicAggregationOperation agg = new BasicAggregationOperation("#005BBB #FFD500"); + assertThatExceptionOfType(IllegalStateException.class).isThrownBy(() -> agg.toDocument(ctx)); + } + + private static class Person { + + @Field("v-a-l-u-e") Object value; + } +} diff --git a/src/main/asciidoc/reference/aggregation-framework.adoc b/src/main/asciidoc/reference/aggregation-framework.adoc index 3530ada881..eece93524d 100644 --- a/src/main/asciidoc/reference/aggregation-framework.adoc +++ b/src/main/asciidoc/reference/aggregation-framework.adoc @@ -126,6 +126,26 @@ At the time of this writing, we provide support for the following Aggregation Op Note that the aggregation operations not listed here are currently not supported by Spring Data MongoDB. Comparison aggregation operators are expressed as `Criteria` expressions. +[TIP] +==== +Unsupported aggregation operations/operators can be provided by implementing either `AggregationOperation` or `AggregationExpression`. +`Aggregation.stage` is a shortcut for registering a pipeline stage by providing its JSON or `Bson` representation. + +[source,java] +---- +Aggregation.stage(""" + { $search : { + "near": { + "path": "released", + "origin": { "$date": { "$numberLong": "..." } } , + "pivot": 7 + } + } + } +"""); +---- +==== + [[mongo.aggregation.projection]] === Projection Expressions