DATAMONGO-2255 - Polishing.

Add ticket references. Rename allAsFlow() to flow() to simplify naming. Remove extension for tail() as partial flow consumption for streams requires completion and a tailable cursor represents an infinite stream.

Related ticket: Kotlin/kotlinx.coroutines#1077.

Original pull request: #736.

Author: mp911de

spring-data-mongodb/src/main/kotlin/org/springframework/data/mongodb/core/ExecutableFindOperationExtensions.kt

@@ -39,7 +39,7 @@ inline fun <reified T : Any> ExecutableFindOperation.query(): ExecutableFindOper
 		query(T::class.java)
 
 /**
- * Extension for [ExecutableFindOperation.FindWithProjection. as] providing a [KClass] based variant.
+ * Extension for [ExecutableFindOperation.FindWithProjection.as] providing a [KClass] based variant.
  *
  * @author Sebastien Deleuze
  * @author Mark Paluch
@@ -50,7 +50,7 @@ fun <T : Any> ExecutableFindOperation.FindWithProjection<*>.asType(resultType: K
 		`as`(resultType.java)
 
 /**
- * Extension for [ExecutableFindOperation.FindWithProjection. as] leveraging reified type parameters.
+ * Extension for [ExecutableFindOperation.FindWithProjection.as] leveraging reified type parameters.
  *
  * @author Sebastien Deleuze
  * @author Mark Paluch
@@ -60,7 +60,7 @@ inline fun <reified T : Any> ExecutableFindOperation.FindWithProjection<*>.asTyp
 		`as`(T::class.java)
 
 /**
- * Extension for [ExecutableFindOperation.DistinctWithProjection. as] providing a [KClass] based variant.
+ * Extension for [ExecutableFindOperation.DistinctWithProjection.as] providing a [KClass] based variant.
  *
  * @author Christoph Strobl
  * @since 2.1
@@ -70,7 +70,7 @@ fun <T : Any> ExecutableFindOperation.DistinctWithProjection.asType(resultType:
 		`as`(resultType.java);
 
 /**
- * Extension for [ExecutableFindOperation.DistinctWithProjection. as] leveraging reified type parameters.
+ * Extension for [ExecutableFindOperation.DistinctWithProjection.as] leveraging reified type parameters.
  *
  * @author Christoph Strobl
  * @since 2.1

spring-data-mongodb/src/main/kotlin/org/springframework/data/mongodb/core/ReactiveAggregationOperationExtensions.kt

@@ -49,5 +49,5 @@ inline fun <reified T : Any> ReactiveAggregationOperation.aggregateAndReturn():
  * @since 2.2
  */
 @FlowPreview
-fun <T : Any> ReactiveAggregationOperation.TerminatingAggregationOperation<T>.allAsFlow(batchSize: Int = 1): Flow<T> =
+fun <T : Any> ReactiveAggregationOperation.TerminatingAggregationOperation<T>.flow(batchSize: Int = 1): Flow<T> =
 		all().asFlow(batchSize)

spring-data-mongodb/src/main/kotlin/org/springframework/data/mongodb/core/ReactiveFindOperationExtensions.kt

@@ -143,21 +143,9 @@ suspend fun <T : Any> ReactiveFindOperation.TerminatingFind<T>.awaitExists(): Bo
  * @author Sebastien Deleuze
  */
 @FlowPreview
-fun <T : Any> ReactiveFindOperation.TerminatingFind<T>.allAsFlow(batchSize: Int = 1): Flow<T> =
+fun <T : Any> ReactiveFindOperation.TerminatingFind<T>.flow(batchSize: Int = 1): Flow<T> =
 		all().asFlow(batchSize)
 
-/**
- * Coroutines [Flow] variant of [ReactiveFindOperation.TerminatingFind.tail].
- *
- * Backpressure is controlled by [batchSize] parameter that controls the size of in-flight elements
- * and [org.reactivestreams.Subscription.request] size.
- *
- * @author Sebastien Deleuze
- */
-@FlowPreview
-fun <T : Any> ReactiveFindOperation.TerminatingFind<T>.tailAsFlow(batchSize: Int = 1): Flow<T> =
-		tail().asFlow(batchSize)
-
 /**
  * Coroutines [Flow] variant of [ReactiveFindOperation.TerminatingFindNear.all].
  *
@@ -167,7 +155,7 @@ fun <T : Any> ReactiveFindOperation.TerminatingFind<T>.tailAsFlow(batchSize: Int
  * @author Sebastien Deleuze
  */
 @FlowPreview
-fun <T : Any> ReactiveFindOperation.TerminatingFindNear<T>.allAsFlow(batchSize: Int = 1): Flow<GeoResult<T>> =
+fun <T : Any> ReactiveFindOperation.TerminatingFindNear<T>.flow(batchSize: Int = 1): Flow<GeoResult<T>> =
 		all().asFlow(batchSize)
 
 /**
@@ -180,5 +168,5 @@ fun <T : Any> ReactiveFindOperation.TerminatingFindNear<T>.allAsFlow(batchSize:
  * @since 2.2
  */
 @FlowPreview
-fun <T : Any> ReactiveFindOperation.TerminatingDistinct<T>.allAsFlow(batchSize: Int = 1): Flow<T> =
+fun <T : Any> ReactiveFindOperation.TerminatingDistinct<T>.flow(batchSize: Int = 1): Flow<T> =
 		all().asFlow(batchSize)

spring-data-mongodb/src/main/kotlin/org/springframework/data/mongodb/core/ReactiveInsertOperationExtensions.kt

@@ -60,5 +60,5 @@ suspend inline fun <reified T: Any> ReactiveInsertOperation.TerminatingInsert<T>
  * @since 2.2
  */
 @FlowPreview
-fun <T : Any> ReactiveInsertOperation.TerminatingInsert<T>.allAsFlow(objects: Collection<T>, batchSize: Int = 1): Flow<T> =
+fun <T : Any> ReactiveInsertOperation.TerminatingInsert<T>.flow(objects: Collection<T>, batchSize: Int = 1): Flow<T> =
 		all(objects).asFlow(batchSize)

spring-data-mongodb/src/main/kotlin/org/springframework/data/mongodb/core/ReactiveMapReduceOperationExtensions.kt

@@ -69,5 +69,5 @@ inline fun <reified T : Any> ReactiveMapReduceOperation.MapReduceWithProjection<
  * @since 2.2
  */
 @FlowPreview
-fun <T : Any> ReactiveMapReduceOperation.TerminatingMapReduce<T>.allAsFlow(batchSize: Int = 1): Flow<T> =
+fun <T : Any> ReactiveMapReduceOperation.TerminatingMapReduce<T>.flow(batchSize: Int = 1): Flow<T> =
 		all().asFlow(batchSize)

spring-data-mongodb/src/test/kotlin/org/springframework/data/mongodb/core/ReactiveAggregationOperationExtensionsTests.kt

@@ -22,7 +22,7 @@ import io.mockk.verify
 import kotlinx.coroutines.FlowPreview
 import kotlinx.coroutines.flow.toList
 import kotlinx.coroutines.runBlocking
-import org.assertj.core.api.Assertions
+import org.assertj.core.api.Assertions.assertThat
 import org.junit.Test
 import reactor.core.publisher.Flux
 
@@ -48,15 +48,15 @@ class ReactiveAggregationOperationExtensionsTests {
 		verify { operation.aggregateAndReturn(First::class.java) }
 	}
 
-	@Test
+	@Test // DATAMONGO-2255
 	@FlowPreview
 	fun terminatingAggregationOperationAllAsFlow() {
 
 		val spec = mockk<ReactiveAggregationOperation.TerminatingAggregationOperation<String>>()
 		every { spec.all() } returns Flux.just("foo", "bar", "baz")
 
 		runBlocking {
-			Assertions.assertThat(spec.allAsFlow().toList()).contains("foo", "bar", "baz")
+			assertThat(spec.flow().toList()).contains("foo", "bar", "baz")
 		}
 
 		verify {

spring-data-mongodb/src/test/kotlin/org/springframework/data/mongodb/core/ReactiveFindOperationExtensionsTests.kt

@@ -34,6 +34,7 @@ import reactor.core.publisher.Mono
  * @author Mark Paluch
  * @author Sebastien Deleuze
  */
+@FlowPreview
 class ReactiveFindOperationExtensionsTests {
 
 	val operation = mockk<ReactiveFindOperation>(relaxed = true)
@@ -234,40 +235,22 @@ class ReactiveFindOperationExtensionsTests {
 		}
 	}
 
-	@Test
-	@FlowPreview
+	@Test // DATAMONGO-2255
 	fun terminatingFindAllAsFlow() {
 
 		val spec = mockk<ReactiveFindOperation.TerminatingFind<String>>()
 		every { spec.all() } returns Flux.just("foo", "bar", "baz")
 
 		runBlocking {
-			assertThat(spec.allAsFlow().toList()).contains("foo", "bar", "baz")
+			assertThat(spec.flow().toList()).contains("foo", "bar", "baz")
 		}
 
 		verify {
 			spec.all()
 		}
 	}
 
-	@Test
-	@FlowPreview
-	fun terminatingFindTailAsFlow() {
-
-		val spec = mockk<ReactiveFindOperation.TerminatingFind<String>>()
-		every { spec.tail() } returns Flux.just("foo", "bar", "baz")
-
-		runBlocking {
-			assertThat(spec.tailAsFlow().toList()).contains("foo", "bar", "baz")
-		}
-
-		verify {
-			spec.tail()
-		}
-	}
-
-	@Test
-	@FlowPreview
+	@Test // DATAMONGO-2255
 	fun terminatingFindNearAllAsFlow() {
 
 		val spec = mockk<ReactiveFindOperation.TerminatingFindNear<String>>()
@@ -277,23 +260,22 @@ class ReactiveFindOperationExtensionsTests {
 		every { spec.all() } returns Flux.just(foo, bar, baz)
 
 		runBlocking {
-			assertThat(spec.allAsFlow().toList()).contains(foo, bar, baz)
+			assertThat(spec.flow().toList()).contains(foo, bar, baz)
 		}
 
 		verify {
 			spec.all()
 		}
 	}
 
-	@Test
-	@FlowPreview
+	@Test // DATAMONGO-2255
 	fun terminatingDistinctAllAsFlow() {
 
 		val spec = mockk<ReactiveFindOperation.TerminatingDistinct<String>>()
 		every { spec.all() } returns Flux.just("foo", "bar", "baz")
 
 		runBlocking {
-			assertThat(spec.allAsFlow().toList()).contains("foo", "bar", "baz")
+			assertThat(spec.flow().toList()).contains("foo", "bar", "baz")
 		}
 
 		verify {

spring-data-mongodb/src/test/kotlin/org/springframework/data/mongodb/core/ReactiveInsertOperationExtensionsTests.kt

@@ -64,7 +64,7 @@ class ReactiveInsertOperationExtensionsTests {
 		}
 	}
 
-	@Test
+	@Test // DATAMONGO-2255
 	@FlowPreview
 	fun terminatingInsertAllAsFlow() {
 
@@ -73,7 +73,7 @@ class ReactiveInsertOperationExtensionsTests {
 		every { insert.all(any()) } returns Flux.fromIterable(list)
 
 		runBlocking {
-			assertThat(insert.allAsFlow(list).toList()).containsAll(list)
+			assertThat(insert.flow(list).toList()).containsAll(list)
 		}
 
 		verify {

spring-data-mongodb/src/test/kotlin/org/springframework/data/mongodb/core/ReactiveMapReduceOperationExtensionsTests.kt

@@ -22,7 +22,7 @@ import io.mockk.verify
 import kotlinx.coroutines.FlowPreview
 import kotlinx.coroutines.flow.toList
 import kotlinx.coroutines.runBlocking
-import org.assertj.core.api.Assertions
+import org.assertj.core.api.Assertions.assertThat
 import org.junit.Test
 import reactor.core.publisher.Flux
 
@@ -64,15 +64,15 @@ class ReactiveMapReduceOperationExtensionsTests {
 		verify { operationWithProjection.`as`(User::class.java) }
 	}
 
-	@Test
+	@Test // DATAMONGO-2255
 	@FlowPreview
 	fun terminatingMapReduceAllAsFlow() {
 
 		val spec = mockk<ReactiveMapReduceOperation.TerminatingMapReduce<String>>()
 		every { spec.all() } returns Flux.just("foo", "bar", "baz")
 
 		runBlocking {
-			Assertions.assertThat(spec.allAsFlow().toList()).contains("foo", "bar", "baz")
+			assertThat(spec.flow().toList()).contains("foo", "bar", "baz")
 		}
 
 		verify {

spring-data-mongodb/src/test/kotlin/org/springframework/data/mongodb/core/ReactiveRemoveOperationExtensionsTests.kt

@@ -66,7 +66,7 @@ class ReactiveRemoveOperationExtensionsTests {
 		}
 	}
 
-	@Test
+	@Test // DATAMONGO-2255
 	@FlowPreview
 	fun terminatingRemoveFindAndRemoveAsFlow() {