Add support for collection expiration to @timeseries.

Closes #4099

Author: bpfoster

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

@@ -38,6 +38,7 @@
  * @author Christoph Strobl
  * @author Mark Paluch
  * @author Andreas Zink
+ * @author Ben Foster
  */
 public class CollectionOptions {
 
@@ -629,13 +630,15 @@ public static class TimeSeriesOptions {
 
 		private final GranularityDefinition granularity;
 
-		private TimeSeriesOptions(String timeField, @Nullable String metaField, GranularityDefinition granularity) {
+		private final int expireAfterSeconds;
 
+		private TimeSeriesOptions(String timeField, @Nullable String metaField, GranularityDefinition granularity, int expireAfterSeconds) {
 			Assert.hasText(timeField, "Time field must not be empty or null");
 
 			this.timeField = timeField;
 			this.metaField = metaField;
 			this.granularity = granularity;
+			this.expireAfterSeconds = expireAfterSeconds;
 		}
 
 		/**
@@ -647,7 +650,7 @@ private TimeSeriesOptions(String timeField, @Nullable String metaField, Granular
 		 * @return new instance of {@link TimeSeriesOptions}.
 		 */
 		public static TimeSeriesOptions timeSeries(String timeField) {
-			return new TimeSeriesOptions(timeField, null, Granularity.DEFAULT);
+			return new TimeSeriesOptions(timeField, null, Granularity.DEFAULT, -1);
 		}
 
 		/**
@@ -660,7 +663,7 @@ public static TimeSeriesOptions timeSeries(String timeField) {
 		 * @return new instance of {@link TimeSeriesOptions}.
 		 */
 		public TimeSeriesOptions metaField(String metaField) {
-			return new TimeSeriesOptions(timeField, metaField, granularity);
+			return new TimeSeriesOptions(timeField, metaField, granularity, expireAfterSeconds);
 		}
 
 		/**
@@ -671,7 +674,17 @@ public TimeSeriesOptions metaField(String metaField) {
 		 * @see Granularity
 		 */
 		public TimeSeriesOptions granularity(GranularityDefinition granularity) {
-			return new TimeSeriesOptions(timeField, metaField, granularity);
+			return new TimeSeriesOptions(timeField, metaField, granularity, expireAfterSeconds);
+		}
+
+		/**
+		 * Select the expireAfterSeconds parameter to define automatic removal of documents older than a specified
+		 * number of seconds.
+		 *
+		 * @return new instance of {@link TimeSeriesOptions}.
+		 */
+		public TimeSeriesOptions expireAfterSeconds(int expireAfterSeconds) {
+			return new TimeSeriesOptions(timeField, metaField, granularity, expireAfterSeconds);
 		}
 
 		/**
@@ -697,6 +710,13 @@ public GranularityDefinition getGranularity() {
 			return granularity;
 		}
 
+		/**
+		 * @return {@literal -1} if not specified
+		 */
+		public int getExpireAfterSeconds() {
+			return expireAfterSeconds;
+		}
+
 		@Override
 		public String toString() {
 

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

@@ -20,6 +20,7 @@
 import java.util.LinkedHashMap;
 import java.util.Map;
 import java.util.Optional;
+import java.util.concurrent.TimeUnit;
 
 import org.bson.BsonNull;
 import org.bson.Document;
@@ -74,6 +75,7 @@
  * @author Oliver Gierke
  * @author Mark Paluch
  * @author Christoph Strobl
+ * @author Ben Foster
  * @since 2.1
  * @see MongoTemplate
  * @see ReactiveMongoTemplate
@@ -354,6 +356,10 @@ public CreateCollectionOptions convertToCreateCollectionOptions(@Nullable Collec
 				options.granularity(TimeSeriesGranularity.valueOf(it.getGranularity().name().toUpperCase()));
 			}
 
+			if (it.getExpireAfterSeconds() >= 0) {
+				result.expireAfter(it.getExpireAfterSeconds(), TimeUnit.SECONDS);
+			}
+
 			result.timeSeriesOptions(options);
 		});
 
@@ -1077,6 +1083,9 @@ public CollectionOptions getCollectionOptions() {
 				if (!Granularity.DEFAULT.equals(timeSeries.granularity())) {
 					options = options.granularity(timeSeries.granularity());
 				}
+				if (timeSeries.expireAfterSeconds() >= 0) {
+					options = options.expireAfterSeconds(timeSeries.expireAfterSeconds());
+				}
 				collectionOptions = collectionOptions.timeSeries(options);
 			}
 
@@ -1091,7 +1100,8 @@ public TimeSeriesOptions mapTimeSeriesOptions(TimeSeriesOptions source) {
 			if (StringUtils.hasText(source.getMetaField())) {
 				target = target.metaField(mappedNameOrDefault(source.getMetaField()));
 			}
-			return target.granularity(source.getGranularity());
+			return target.granularity(source.getGranularity())
+					.expireAfterSeconds(source.getExpireAfterSeconds());
 		}
 
 		private String mappedNameOrDefault(String name) {

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

@@ -28,6 +28,7 @@
  * Identifies a domain object to be persisted to a MongoDB Time Series collection.
  *
  * @author Christoph Strobl
+ * @author Ben Foster
  * @since 3.3
  * @see <a href="https://docs.mongodb.com/manual/core/timeseries-collections">https://docs.mongodb.com/manual/core/timeseries-collections</a>
  */
@@ -83,4 +84,12 @@
 	@AliasFor(annotation = Document.class, attribute = "collation")
 	String collation() default "";
 
+	/**
+	 * Configures the number of seconds after which the collection should expire. Defaults to -1 for no expiry.
+	 *
+	 * @return {@literal -1} by default.
+	 * @see <a href=
+	 *      "https://www.mongodb.com/docs/manual/core/timeseries/timeseries-automatic-removal/#set-up-automatic-removal-for-time-series-collections--ttl-</a>
+	 */
+	int expireAfterSeconds() default -1;
 }

spring-data-mongodb/src/test/java/org/springframework/data/mongodb/core/MongoTemplateUnitTests.java

@@ -141,6 +141,7 @@
  * @author Roman Puchkovskiy
  * @author Yadhukrishna S Pai
  * @author Jakub Zurawa
+ * @author Ben Foster
  */
 @MockitoSettings(strictness = Strictness.LENIENT)
 public class MongoTemplateUnitTests extends MongoOperationsUnitTests {
@@ -2386,6 +2387,18 @@ void createCollectionShouldSetUpTimeSeries() {
 						.granularity(TimeSeriesGranularity.HOURS).toString());
 	}
 
+	@Test // GH-4099
+	void createCollectionShouldSetUpTimeSeriesWithExpiration() {
+
+		template.createCollection(TimeSeriesTypeWithExpire.class);
+
+		ArgumentCaptor<CreateCollectionOptions> options = ArgumentCaptor.forClass(CreateCollectionOptions.class);
+		verify(db).createCollection(any(), options.capture());
+
+		assertThat(options.getValue().getExpireAfter(TimeUnit.SECONDS))
+				.isEqualTo(60);
+	}
+
 	@Test // GH-3522
 	void usedCountDocumentsForEmptyQueryByDefault() {
 
@@ -2705,6 +2718,14 @@ static class TimeSeriesType {
 		Object meta;
 	}
 
+	@TimeSeries(timeField = "timestamp", expireAfterSeconds = 60)
+	static class TimeSeriesTypeWithExpire {
+
+		String id;
+		Instant timestamp;
+	}
+
+
 	static class TypeImplementingIterator implements Iterator {
 
 		@Override

spring-data-mongodb/src/test/java/org/springframework/data/mongodb/core/ReactiveMongoTemplateUnitTests.java

@@ -132,6 +132,7 @@
  * @author Roman Puchkovskiy
  * @author Mathieu Ouellet
  * @author Yadhukrishna S Pai
+ * @author Ben Foster
  */
 @ExtendWith(MockitoExtension.class)
 @MockitoSettings(strictness = Strictness.LENIENT)
@@ -1739,6 +1740,18 @@ public WriteConcern resolve(MongoAction action) {
 		verify(collection).withWriteConcern(eq(WriteConcern.UNACKNOWLEDGED));
 	}
 
+    @Test // GH-4099
+    void createCollectionShouldSetUpTimeSeriesWithExpiration() {
+
+        template.createCollection(TimeSeriesTypeWithExpire.class).subscribe();
+
+        ArgumentCaptor<CreateCollectionOptions> options = ArgumentCaptor.forClass(CreateCollectionOptions.class);
+        verify(db).createCollection(any(), options.capture());
+
+        assertThat(options.getValue().getExpireAfter(TimeUnit.SECONDS))
+            .isEqualTo(60);
+    }
+
 	private void stubFindSubscribe(Document document) {
 		stubFindSubscribe(document, new AtomicLong());
 	}
@@ -1887,6 +1900,13 @@ static class TimeSeriesType {
 		Object meta;
 	}
 
+	@TimeSeries(timeField = "timestamp", expireAfterSeconds = 60)
+	static class TimeSeriesTypeWithExpire {
+
+		String id;
+		Instant timestamp;
+	}
+
 	static class ValueCapturingEntityCallback<T> {
 
 		private final List<T> values = new ArrayList<>(1);