Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add support for SuspendingTransacter in QueryPagingSource #4292

Merged
merged 1 commit into from
Jun 20, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -21,14 +21,17 @@ import app.cash.paging.PagingSourceLoadResultError
import app.cash.paging.PagingSourceLoadResultPage
import app.cash.paging.PagingState
import app.cash.sqldelight.Query
import app.cash.sqldelight.SuspendingTransacter
import app.cash.sqldelight.Transacter
import app.cash.sqldelight.TransacterBase
import app.cash.sqldelight.TransactionCallbacks
import kotlinx.coroutines.withContext
import kotlin.coroutines.CoroutineContext

internal class KeyedQueryPagingSource<Key : Any, RowType : Any>(
private val queryProvider: (beginInclusive: Key, endExclusive: Key?) -> Query<RowType>,
private val pageBoundariesProvider: (anchor: Key?, limit: Long) -> Query<Key>,
private val transacter: Transacter,
private val transacter: TransacterBase,
private val context: CoroutineContext,
) : QueryPagingSource<Key, RowType>() {

Expand All @@ -48,7 +51,7 @@ internal class KeyedQueryPagingSource<Key : Any, RowType : Any>(
override suspend fun load(params: PagingSourceLoadParams<Key>): PagingSourceLoadResult<Key, RowType> {
return withContext(context) {
try {
transacter.transactionWithResult {
val getPagingSourceLoadResult: TransactionCallbacks.() -> PagingSourceLoadResult<Key, RowType> = {
val boundaries = pageBoundaries
?: pageBoundariesProvider(params.key, params.loadSize.toLong())
.executeAsList()
Expand All @@ -71,6 +74,10 @@ internal class KeyedQueryPagingSource<Key : Any, RowType : Any>(
nextKey = nextKey,
) as PagingSourceLoadResult<Key, RowType>
}
when (transacter) {
is Transacter -> transacter.transactionWithResult(bodyWithReturn = getPagingSourceLoadResult)
is SuspendingTransacter -> transacter.transactionWithResult(bodyWithReturn = getPagingSourceLoadResult)
}
} catch (e: Exception) {
if (e is IllegalArgumentException) throw e
PagingSourceLoadResultError<Key, RowType>(e) as PagingSourceLoadResult<Key, RowType>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,14 +24,17 @@ import app.cash.paging.PagingSourceLoadResultInvalid
import app.cash.paging.PagingSourceLoadResultPage
import app.cash.paging.PagingState
import app.cash.sqldelight.Query
import app.cash.sqldelight.SuspendingTransacter
import app.cash.sqldelight.Transacter
import app.cash.sqldelight.TransacterBase
import app.cash.sqldelight.TransactionCallbacks
import kotlinx.coroutines.withContext
import kotlin.coroutines.CoroutineContext

internal class OffsetQueryPagingSource<RowType : Any>(
private val queryProvider: (limit: Int, offset: Int) -> Query<RowType>,
private val countQuery: Query<Int>,
private val transacter: Transacter,
private val transacter: TransacterBase,
private val context: CoroutineContext,
) : QueryPagingSource<Int, RowType>() {

Expand All @@ -45,7 +48,7 @@ internal class OffsetQueryPagingSource<RowType : Any>(
is PagingSourceLoadParamsPrepend<*> -> minOf(key, params.loadSize)
else -> params.loadSize
}
val loadResult = transacter.transactionWithResult {
val getPagingSourceLoadResult: TransactionCallbacks.() -> PagingSourceLoadResultPage<Int, RowType> = {
val count = countQuery.executeAsOne()
val offset = when (params) {
is PagingSourceLoadParamsPrepend<*> -> maxOf(0, key - params.loadSize)
Expand All @@ -65,6 +68,10 @@ internal class OffsetQueryPagingSource<RowType : Any>(
itemsAfter = maxOf(0, count - nextPosToLoad),
)
}
val loadResult = when (transacter) {
is Transacter -> transacter.transactionWithResult(bodyWithReturn = getPagingSourceLoadResult)
is SuspendingTransacter -> transacter.transactionWithResult(bodyWithReturn = getPagingSourceLoadResult)
}
(if (invalid) PagingSourceLoadResultInvalid<Int, RowType>() else loadResult) as PagingSourceLoadResult<Int, RowType>
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ package app.cash.sqldelight.paging3
import app.cash.paging.PagingConfig
import app.cash.paging.PagingSource
import app.cash.sqldelight.Query
import app.cash.sqldelight.Transacter
import app.cash.sqldelight.TransacterBase
import app.cash.sqldelight.db.QueryResult
import app.cash.sqldelight.db.SqlCursor
import kotlin.coroutines.CoroutineContext
Expand Down Expand Up @@ -63,7 +63,7 @@ internal abstract class QueryPagingSource<Key : Any, RowType : Any> :
@JvmName("QueryPagingSourceInt")
fun <RowType : Any> QueryPagingSource(
countQuery: Query<Int>,
transacter: Transacter,
transacter: TransacterBase,
context: CoroutineContext,
queryProvider: (limit: Int, offset: Int) -> Query<RowType>,
): PagingSource<Int, RowType> = OffsetQueryPagingSource(
Expand All @@ -86,7 +86,7 @@ fun <RowType : Any> QueryPagingSource(
@JvmName("QueryPagingSourceLong")
fun <RowType : Any> QueryPagingSource(
countQuery: Query<Long>,
transacter: Transacter,
transacter: TransacterBase,
context: CoroutineContext,
queryProvider: (limit: Long, offset: Long) -> Query<RowType>,
): PagingSource<Int, RowType> = OffsetQueryPagingSource(
Expand Down Expand Up @@ -165,7 +165,7 @@ private fun Query<Long>.toInt(): Query<Int> =
*/
@Suppress("FunctionName")
fun <Key : Any, RowType : Any> QueryPagingSource(
transacter: Transacter,
transacter: TransacterBase,
context: CoroutineContext,
pageBoundariesProvider: (anchor: Key?, limit: Long) -> Query<Key>,
queryProvider: (beginInclusive: Key, endExclusive: Key?) -> Query<RowType>,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,8 @@ import app.cash.paging.PagingSourceLoadParamsRefresh
import app.cash.paging.PagingSourceLoadResultPage
import app.cash.paging.PagingState
import app.cash.sqldelight.Query
import app.cash.sqldelight.Transacter
import app.cash.sqldelight.SuspendingTransacterImpl
import app.cash.sqldelight.TransacterBase
import app.cash.sqldelight.TransacterImpl
import app.cash.sqldelight.db.QueryResult
import app.cash.sqldelight.db.SqlCursor
Expand All @@ -32,17 +33,33 @@ import kotlin.test.assertEquals
import kotlin.test.assertNull

@ExperimentalCoroutinesApi
class KeyedQueryPagingSourceTest : DbTest {
class KeyedQueryPagingSourceTest : BaseKeyedQueryPagingSourceTest() {
override fun createTransacter(driver: SqlDriver): TransacterBase {
return object : TransacterImpl(driver) {}
}
}

@ExperimentalCoroutinesApi
class KeyedQueryPagingSourceWithSuspendingTransacterTest : BaseKeyedQueryPagingSourceTest() {
override fun createTransacter(driver: SqlDriver): TransacterBase {
return object : SuspendingTransacterImpl(driver) {}
}
}

@ExperimentalCoroutinesApi
abstract class BaseKeyedQueryPagingSourceTest : DbTest {

private lateinit var driver: SqlDriver
private lateinit var transacter: Transacter
private lateinit var transacter: TransacterBase
private lateinit var source: KeyedQueryPagingSource<Long, Long>

abstract fun createTransacter(driver: SqlDriver): TransacterBase

override suspend fun setup(driver: SqlDriver) {
this.driver = driver
driver.execute(null, "CREATE TABLE testTable(value INTEGER PRIMARY KEY)", 0)
(0L until 10L).forEach { this.insert(it) }
transacter = object : TransacterImpl(driver) {}
transacter = createTransacter(driver)
source = KeyedQueryPagingSource(
queryProvider = this::query,
pageBoundariesProvider = this::pageBoundaries,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,8 @@ import app.cash.paging.PagingSourceLoadResultInvalid
import app.cash.paging.PagingSourceLoadResultPage
import app.cash.paging.PagingState
import app.cash.sqldelight.Query
import app.cash.sqldelight.Transacter
import app.cash.sqldelight.SuspendingTransacterImpl
import app.cash.sqldelight.TransacterBase
import app.cash.sqldelight.TransacterImpl
import app.cash.sqldelight.db.QueryResult
import app.cash.sqldelight.db.SqlCursor
Expand All @@ -47,16 +48,32 @@ import kotlin.test.assertNull
import kotlin.test.assertTrue

@ExperimentalCoroutinesApi
class OffsetQueryPagingSourceTest : DbTest {
class OffsetQueryPagingSourceTest : BaseOffsetQueryPagingSourceTest() {
override fun createTransacter(driver: SqlDriver): TransacterBase {
return object : TransacterImpl(driver) {}
}
}

@ExperimentalCoroutinesApi
class OffsetQueryPagingSourceWithSuspendingTransacterTest : BaseOffsetQueryPagingSourceTest() {
override fun createTransacter(driver: SqlDriver): TransacterBase {
return object : SuspendingTransacterImpl(driver) {}
}
}

@ExperimentalCoroutinesApi
abstract class BaseOffsetQueryPagingSourceTest : DbTest {

private lateinit var driver: SqlDriver
private lateinit var transacter: Transacter
private lateinit var transacter: TransacterBase
private lateinit var pagingSource: PagingSource<Int, TestItem>

abstract fun createTransacter(driver: SqlDriver): TransacterBase

override suspend fun setup(driver: SqlDriver) {
this.driver = driver
driver.execute(null, "CREATE TABLE TestItem(id INTEGER NOT NULL PRIMARY KEY);", 0)
transacter = object : TransacterImpl(driver) {}
transacter = createTransacter(driver)
pagingSource = QueryPagingSource(
countQuery(),
transacter,
Expand Down