Spring/spring-framework
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Improve Coroutines transaction API

Browse Source 
As a follow-up of gh-22915, the purpose of this commit is to improve
Coroutines programmatic transaction API to make it more consistent with
the Java one and more idiomatic.

For suspending functions, this commit changes the
TransactionalOperator.transactional extension with a suspending lambda
parameter to a TransactionalOperator.executeAndAwait one which is
conceptually closer to TransactionalOperator.execute Java API so more
consistent.

For Flow, the TransactionalOperator.transactional extension is correct
but would be more idiomatic as a Flow extension.

This commit also adds code samples to the reference documentation.

Closes gh-23627
This commit is contained in:
Sebastien Deleuze
2019-09-12 14:35:31 +02:00
parent e62cb6bc56
commit fc6480631e
3 changed files with 56 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
spring-tx/src/main/kotlin/org/springframework/transaction/reactive/TransactionalOperatorExtensions.kt
View File

@@ -7,23 +7,24 @@ import kotlinx.coroutines.reactive.asFlow
import kotlinx.coroutines.reactive.awaitFirstOrNull
import kotlinx.coroutines.reactor.asFlux
import kotlinx.coroutines.reactor.mono
import org.springframework.transaction.ReactiveTransaction
/**
* Coroutines variant of [TransactionalOperator.transactional] with a [Flow] parameter.
* Coroutines variant of [TransactionalOperator.transactional] as a [Flow] extension.
*
* @author Sebastien Deleuze
* @since 5.2
*/
@ExperimentalCoroutinesApi
fun <T : Any> TransactionalOperator.transactional(flow: Flow<T>): Flow<T> =
transactional(flow.asFlux()).asFlow()
fun <T : Any> Flow<T>.transactional(operator: TransactionalOperator): Flow<T> =
operator.transactional(asFlux()).asFlow()
/**
* Coroutines variant of [TransactionalOperator.transactional] with a suspending lambda
* Coroutines variant of [TransactionalOperator.execute] with a suspending lambda
* parameter.
*
* @author Sebastien Deleuze
* @since 5.2
*/
suspend fun <T : Any> TransactionalOperator.transactional(f: suspend () -> T?): T? =
transactional(mono(Dispatchers.Unconfined) { f() }).awaitFirstOrNull()
suspend fun <T : Any> TransactionalOperator.executeAndAwait(f: suspend (ReactiveTransaction) -> T?): T? =
execute { status -> mono(Dispatchers.Unconfined) { f(status) } }.awaitFirstOrNull()

8
spring-tx/src/test/kotlin/org/springframework/transaction/reactive/TransactionalOperatorExtensionsTests.kt
View File

@@ -34,7 +34,7 @@ class TransactionalOperatorExtensionsTests {
fun commitWithSuspendingFunction() {
val operator = TransactionalOperator.create(tm, DefaultTransactionDefinition())
runBlocking {
operator.transactional {
operator.executeAndAwait {
delay(1)
true
}
@@ -48,7 +48,7 @@ class TransactionalOperatorExtensionsTests {
val operator = TransactionalOperator.create(tm, DefaultTransactionDefinition())
runBlocking {
try {
operator.transactional {
operator.executeAndAwait {
delay(1)
throw IllegalStateException()
}
@@ -72,7 +72,7 @@ class TransactionalOperatorExtensionsTests {
emit(4)
}
runBlocking {
val list = operator.transactional(flow).toList()
val list = flow.transactional(operator).toList()
assertThat(list).hasSize(4)
}
assertThat(tm.commit).isTrue()
@@ -89,7 +89,7 @@ class TransactionalOperatorExtensionsTests {
}
runBlocking {
try {
operator.transactional(flow).toList()
flow.transactional(operator).toList()
} catch (ex: IllegalStateException) {
assertThat(tm.commit).isFalse()
assertThat(tm.rollback).isTrue()