mirror of
https://github.com/InsanusMokrassar/MicroUtils.git
synced 2026-09-23 17:05:12 +00:00
Compare commits
10 Commits
renovate/o
...
0.25.8.3
| Author | SHA1 | Date | |
|---|---|---|---|
| 89eb46ed6b | |||
| 0e98281fa3 | |||
| 7a75c7e03d | |||
| bdbb00d51f | |||
| af5bb50f19 | |||
| 651233bb84 | |||
| 30fcd16074 | |||
| dd0d445519 | |||
| 0359b3a380 | |||
| df5fa86c8e |
23
CHANGELOG.md
23
CHANGELOG.md
@@ -1,5 +1,28 @@
|
||||
# Changelog
|
||||
|
||||
## 0.25.8.3
|
||||
|
||||
* `Coroutines`:
|
||||
* `SmartRWLocker`:
|
||||
* Fix of `unlockWrite`, `lockWrite` and `releaseRead` calls to pass correct number of permits
|
||||
* `SmartMutex`:
|
||||
* Fix `unlock` call
|
||||
* `SmartSemaphore`:
|
||||
* Fix same issues to avoid cancellation exceptions handling errors and several other problems
|
||||
|
||||
## 0.25.8.2
|
||||
|
||||
* `Coroutines`:
|
||||
* `runCatchingLogging` updated to rethrow `CancellationException` and log other exceptions
|
||||
|
||||
## 0.25.8.1
|
||||
|
||||
* `Coroutines`:
|
||||
* New function `suspendPoint` to check coroutine cancellation status
|
||||
* `SpecialMutableStateFlow` renamed to `MutableRedeliverStateFlow` (old name deprecated with `ReplaceWith`)
|
||||
* `SmartSemaphore`:
|
||||
* Fix of `waitRelease` call to pass correct number of permits
|
||||
|
||||
## 0.25.8
|
||||
|
||||
* `Pagination`:
|
||||
|
||||
@@ -2,7 +2,7 @@ import androidx.compose.runtime.remember
|
||||
import androidx.compose.ui.test.ExperimentalTestApi
|
||||
import androidx.compose.ui.test.runComposeUiTest
|
||||
import dev.inmo.micro_utils.common.compose.LoadableComponent
|
||||
import dev.inmo.micro_utils.coroutines.SpecialMutableStateFlow
|
||||
import dev.inmo.micro_utils.coroutines.MutableRedeliverStateFlow
|
||||
import kotlinx.coroutines.flow.MutableSharedFlow
|
||||
import kotlinx.coroutines.flow.filter
|
||||
import kotlinx.coroutines.flow.first
|
||||
@@ -16,8 +16,8 @@ class LoadableComponentTests {
|
||||
@Test
|
||||
@TestOnly
|
||||
fun testSimpleLoad() = runComposeUiTest {
|
||||
val loadingFlow = SpecialMutableStateFlow<Int>(0)
|
||||
val loadedFlow = SpecialMutableStateFlow<Int>(0)
|
||||
val loadingFlow = MutableRedeliverStateFlow<Int>(0)
|
||||
val loadedFlow = MutableRedeliverStateFlow<Int>(0)
|
||||
setContent {
|
||||
LoadableComponent<Int>({
|
||||
loadingFlow.filter { it == 1 }.first()
|
||||
|
||||
@@ -3,7 +3,7 @@ package dev.inmo.micro_utils.coroutines.compose
|
||||
import androidx.compose.runtime.Composable
|
||||
import androidx.compose.runtime.collectAsState
|
||||
import androidx.compose.runtime.remember
|
||||
import dev.inmo.micro_utils.coroutines.SpecialMutableStateFlow
|
||||
import dev.inmo.micro_utils.coroutines.MutableRedeliverStateFlow
|
||||
import kotlinx.coroutines.flow.StateFlow
|
||||
import kotlinx.coroutines.flow.asStateFlow
|
||||
import kotlinx.coroutines.flow.debounce
|
||||
@@ -16,7 +16,7 @@ import org.jetbrains.compose.web.css.StyleSheet
|
||||
* to add `Style(stylesheet)` on every compose function call
|
||||
*/
|
||||
object StyleSheetsAggregator {
|
||||
private val _stylesFlow = SpecialMutableStateFlow<Set<CSSRulesHolder>>(emptySet())
|
||||
private val _stylesFlow = MutableRedeliverStateFlow<Set<CSSRulesHolder>>(emptySet())
|
||||
val stylesFlow: StateFlow<Set<CSSRulesHolder>> = _stylesFlow.asStateFlow()
|
||||
|
||||
@Composable
|
||||
|
||||
@@ -2,7 +2,7 @@ import androidx.compose.material.Button
|
||||
import androidx.compose.material.Text
|
||||
import androidx.compose.runtime.collectAsState
|
||||
import androidx.compose.ui.test.*
|
||||
import dev.inmo.micro_utils.coroutines.SpecialMutableStateFlow
|
||||
import dev.inmo.micro_utils.coroutines.MutableRedeliverStateFlow
|
||||
import org.jetbrains.annotations.TestOnly
|
||||
import kotlin.test.Test
|
||||
|
||||
@@ -11,7 +11,7 @@ class FlowStateTests {
|
||||
@Test
|
||||
@TestOnly
|
||||
fun simpleTest() = runComposeUiTest {
|
||||
val flowState = SpecialMutableStateFlow(0)
|
||||
val flowState = MutableRedeliverStateFlow(0)
|
||||
setContent {
|
||||
Button({ flowState.value++ }) { Text("Click") }
|
||||
Text(flowState.collectAsState().value.toString())
|
||||
|
||||
@@ -1,7 +1,5 @@
|
||||
package dev.inmo.micro_utils.coroutines
|
||||
|
||||
import kotlinx.coroutines.CoroutineScope
|
||||
import kotlinx.coroutines.Dispatchers
|
||||
import kotlinx.coroutines.ExperimentalCoroutinesApi
|
||||
import kotlinx.coroutines.InternalCoroutinesApi
|
||||
import kotlinx.coroutines.channels.BufferOverflow
|
||||
@@ -11,13 +9,12 @@ import kotlinx.coroutines.flow.MutableStateFlow
|
||||
import kotlinx.coroutines.flow.StateFlow
|
||||
import kotlinx.coroutines.internal.SynchronizedObject
|
||||
import kotlinx.coroutines.internal.synchronized
|
||||
import kotlin.coroutines.CoroutineContext
|
||||
|
||||
/**
|
||||
* Works like [StateFlow], but guarantee that latest value update will always be delivered to
|
||||
* each active subscriber
|
||||
*/
|
||||
open class SpecialMutableStateFlow<T>(
|
||||
open class MutableRedeliverStateFlow<T>(
|
||||
initialValue: T
|
||||
) : MutableStateFlow<T>, FlowCollector<T>, MutableSharedFlow<T> {
|
||||
@OptIn(InternalCoroutinesApi::class)
|
||||
@@ -2,11 +2,27 @@ package dev.inmo.micro_utils.coroutines
|
||||
|
||||
import dev.inmo.kslog.common.KSLog
|
||||
import dev.inmo.kslog.common.e
|
||||
import kotlin.coroutines.cancellation.CancellationException
|
||||
|
||||
/**
|
||||
* Executes the given [block] within a `runCatching` context and logs any exceptions that occur, excluding
|
||||
* `CancellationException` which is rethrown. This method simplifies error handling by automatically logging
|
||||
* the errors using the provided [logger].
|
||||
*
|
||||
* @param T The result type of the [block].
|
||||
* @param R The receiver type on which this function operates.
|
||||
* @param errorMessageBuilder A lambda to build the error log message. By default, it returns a generic error message.
|
||||
* @param logger The logging instance used for logging errors. Defaults to [KSLog].
|
||||
* @param block The code block to execute within the `runCatching` context.
|
||||
* @return A [Result] representing the outcome of executing the [block].
|
||||
*/
|
||||
inline fun <T, R> R.runCatchingLogging(
|
||||
noinline errorMessageBuilder: R.(Throwable) -> Any = { "Something web wrong" },
|
||||
logger: KSLog = KSLog,
|
||||
block: R.() -> T
|
||||
) = runCatching(block).onFailure {
|
||||
logger.e(it) { errorMessageBuilder(it) }
|
||||
when (it) {
|
||||
is CancellationException -> throw it
|
||||
else -> logger.e(it) { errorMessageBuilder(it) }
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,13 +1,14 @@
|
||||
package dev.inmo.micro_utils.coroutines
|
||||
|
||||
import kotlinx.coroutines.NonCancellable
|
||||
import kotlinx.coroutines.currentCoroutineContext
|
||||
import kotlinx.coroutines.flow.MutableStateFlow
|
||||
import kotlinx.coroutines.flow.StateFlow
|
||||
import kotlinx.coroutines.flow.asStateFlow
|
||||
import kotlinx.coroutines.flow.first
|
||||
import kotlinx.coroutines.isActive
|
||||
import kotlinx.coroutines.sync.Mutex
|
||||
import kotlinx.coroutines.sync.withLock
|
||||
import kotlinx.coroutines.withContext
|
||||
import kotlin.contracts.ExperimentalContracts
|
||||
import kotlin.contracts.InvocationKind
|
||||
import kotlin.contracts.contract
|
||||
@@ -44,7 +45,7 @@ sealed interface SmartMutex {
|
||||
* @param locked Preset state of [isLocked] and its internal [_lockStateFlow]
|
||||
*/
|
||||
class Mutable(locked: Boolean = false) : SmartMutex {
|
||||
private val _lockStateFlow = SpecialMutableStateFlow<Boolean>(locked)
|
||||
private val _lockStateFlow = MutableRedeliverStateFlow<Boolean>(locked)
|
||||
override val lockStateFlow: StateFlow<Boolean> = _lockStateFlow.asStateFlow()
|
||||
|
||||
private val internalChangesMutex = Mutex()
|
||||
@@ -93,8 +94,8 @@ sealed interface SmartMutex {
|
||||
* If [isLocked] == true - will change it to false and return true. If current call will not unlock this
|
||||
* [SmartMutex] - false
|
||||
*/
|
||||
suspend fun unlock(): Boolean {
|
||||
return if (_lockStateFlow.value) {
|
||||
suspend fun unlock(): Boolean = withContext(NonCancellable) {
|
||||
if (_lockStateFlow.value) {
|
||||
internalChangesMutex.withLock {
|
||||
if (_lockStateFlow.value) {
|
||||
_lockStateFlow.value = false
|
||||
|
||||
@@ -1,6 +1,8 @@
|
||||
package dev.inmo.micro_utils.coroutines
|
||||
|
||||
import kotlinx.coroutines.CancellationException
|
||||
import kotlinx.coroutines.NonCancellable
|
||||
import kotlinx.coroutines.withContext
|
||||
import kotlin.contracts.ExperimentalContracts
|
||||
import kotlin.contracts.InvocationKind
|
||||
import kotlin.contracts.contract
|
||||
@@ -21,6 +23,7 @@ class SmartRWLocker(private val readPermits: Int = Int.MAX_VALUE, writeIsLocked:
|
||||
val readSemaphore: SmartSemaphore.Immutable = _readSemaphore.immutable()
|
||||
val writeMutex: SmartMutex.Immutable = _writeMutex.immutable()
|
||||
|
||||
|
||||
/**
|
||||
* Do lock in [readSemaphore] inside of [writeMutex] locking
|
||||
*/
|
||||
@@ -32,8 +35,8 @@ class SmartRWLocker(private val readPermits: Int = Int.MAX_VALUE, writeIsLocked:
|
||||
/**
|
||||
* Release one read permit in [readSemaphore]
|
||||
*/
|
||||
suspend fun releaseRead(): Boolean {
|
||||
return _readSemaphore.release()
|
||||
suspend fun releaseRead(): Boolean = withContext(NonCancellable) {
|
||||
_readSemaphore.release()
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -44,7 +47,9 @@ class SmartRWLocker(private val readPermits: Int = Int.MAX_VALUE, writeIsLocked:
|
||||
try {
|
||||
_readSemaphore.acquire(readPermits)
|
||||
} catch (e: CancellationException) {
|
||||
_writeMutex.unlock()
|
||||
withContext(NonCancellable) {
|
||||
_writeMutex.unlock()
|
||||
}
|
||||
throw e
|
||||
}
|
||||
}
|
||||
@@ -52,9 +57,9 @@ class SmartRWLocker(private val readPermits: Int = Int.MAX_VALUE, writeIsLocked:
|
||||
/**
|
||||
* Unlock [writeMutex]
|
||||
*/
|
||||
suspend fun unlockWrite(): Boolean {
|
||||
return _writeMutex.unlock().also {
|
||||
if (it) {
|
||||
suspend fun unlockWrite(): Boolean = withContext(NonCancellable) {
|
||||
_writeMutex.unlock().also { unlocked ->
|
||||
if (unlocked) {
|
||||
_readSemaphore.release(readPermits)
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
package dev.inmo.micro_utils.coroutines
|
||||
|
||||
import kotlinx.coroutines.NonCancellable
|
||||
import kotlinx.coroutines.currentCoroutineContext
|
||||
import kotlinx.coroutines.flow.MutableStateFlow
|
||||
import kotlinx.coroutines.flow.StateFlow
|
||||
import kotlinx.coroutines.flow.asStateFlow
|
||||
import kotlinx.coroutines.flow.first
|
||||
@@ -9,6 +9,7 @@ import kotlinx.coroutines.isActive
|
||||
import kotlinx.coroutines.sync.Mutex
|
||||
import kotlinx.coroutines.sync.Semaphore
|
||||
import kotlinx.coroutines.sync.withLock
|
||||
import kotlinx.coroutines.withContext
|
||||
import kotlin.contracts.ExperimentalContracts
|
||||
import kotlin.contracts.InvocationKind
|
||||
import kotlin.contracts.contract
|
||||
@@ -47,7 +48,7 @@ sealed interface SmartSemaphore {
|
||||
*/
|
||||
class Mutable(permits: Int, acquiredPermits: Int = 0) : SmartSemaphore {
|
||||
override val maxPermits: Int = permits
|
||||
private val _freePermitsStateFlow = SpecialMutableStateFlow<Int>(permits - acquiredPermits)
|
||||
private val _freePermitsStateFlow = MutableRedeliverStateFlow<Int>(permits - acquiredPermits)
|
||||
override val permitsStateFlow: StateFlow<Int> = _freePermitsStateFlow.asStateFlow()
|
||||
|
||||
private val internalChangesMutex = Mutex(false)
|
||||
@@ -73,11 +74,13 @@ sealed interface SmartSemaphore {
|
||||
acquiredPermits != checkedPermits
|
||||
}
|
||||
if (shouldContinue) {
|
||||
waitRelease()
|
||||
waitRelease(checkedPermits - acquiredPermits)
|
||||
}
|
||||
} while (shouldContinue && currentCoroutineContext().isActive)
|
||||
} catch (e: Throwable) {
|
||||
release(acquiredPermits)
|
||||
if (acquiredPermits > 0) {
|
||||
release(acquiredPermits)
|
||||
}
|
||||
throw e
|
||||
}
|
||||
}
|
||||
@@ -108,9 +111,9 @@ sealed interface SmartSemaphore {
|
||||
*/
|
||||
suspend fun tryAcquire(permits: Int = 1): Boolean {
|
||||
val checkedPermits = checkedPermits(permits)
|
||||
return if (_freePermitsStateFlow.value < checkedPermits) {
|
||||
return if (_freePermitsStateFlow.value >= checkedPermits) {
|
||||
internalChangesMutex.withLock {
|
||||
if (_freePermitsStateFlow.value < checkedPermits) {
|
||||
if (_freePermitsStateFlow.value >= checkedPermits) {
|
||||
_freePermitsStateFlow.value -= checkedPermits
|
||||
true
|
||||
} else {
|
||||
@@ -126,12 +129,12 @@ sealed interface SmartSemaphore {
|
||||
* If [freePermits] == true - will change it to false and return true. If current call will not unlock this
|
||||
* [SmartSemaphore] - false
|
||||
*/
|
||||
suspend fun release(permits: Int = 1): Boolean {
|
||||
suspend fun release(permits: Int = 1): Boolean = withContext(NonCancellable) {
|
||||
val checkedPermits = checkedPermits(permits)
|
||||
return if (_freePermitsStateFlow.value < this.maxPermits) {
|
||||
if (_freePermitsStateFlow.value < maxPermits) {
|
||||
internalChangesMutex.withLock {
|
||||
if (_freePermitsStateFlow.value < this.maxPermits) {
|
||||
_freePermitsStateFlow.value = minOf(_freePermitsStateFlow.value + checkedPermits, this.maxPermits)
|
||||
if (_freePermitsStateFlow.value < maxPermits) {
|
||||
_freePermitsStateFlow.value = minOf(_freePermitsStateFlow.value + checkedPermits, maxPermits)
|
||||
true
|
||||
} else {
|
||||
false
|
||||
|
||||
@@ -0,0 +1,15 @@
|
||||
package dev.inmo.micro_utils.coroutines
|
||||
|
||||
import kotlinx.coroutines.currentCoroutineContext
|
||||
import kotlinx.coroutines.ensureActive
|
||||
|
||||
/**
|
||||
* Ensures that the current coroutine context is still active and throws a [kotlinx.coroutines.CancellationException]
|
||||
* if the coroutine has been canceled.
|
||||
*
|
||||
* This function provides a convenient way to check the active status of a coroutine, which is useful
|
||||
* to identify cancellation points in long-running or suspendable operations.
|
||||
*
|
||||
* @throws kotlinx.coroutines.CancellationException if the coroutine context is no longer active.
|
||||
*/
|
||||
suspend fun suspendPoint() = currentCoroutineContext().ensureActive()
|
||||
@@ -4,6 +4,7 @@ import kotlinx.coroutines.flow.first
|
||||
import kotlinx.coroutines.sync.Mutex
|
||||
import kotlinx.coroutines.sync.withLock
|
||||
import kotlinx.coroutines.test.runTest
|
||||
import kotlin.test.BeforeTest
|
||||
import kotlin.test.Test
|
||||
import kotlin.test.assertEquals
|
||||
import kotlin.test.assertFails
|
||||
@@ -13,184 +14,517 @@ import kotlin.time.Duration.Companion.milliseconds
|
||||
import kotlin.time.Duration.Companion.seconds
|
||||
|
||||
class SmartKeyRWLockerTests {
|
||||
@Test
|
||||
fun writeLockKeyFailedOnGlobalWriteLockTest() = runTest {
|
||||
val locker = SmartKeyRWLocker<String>()
|
||||
val testKey = "test"
|
||||
locker.lockWrite()
|
||||
private lateinit var locker: SmartKeyRWLocker<String>
|
||||
|
||||
assertTrue { locker.isWriteLocked() }
|
||||
|
||||
assertFails {
|
||||
realWithTimeout(1.seconds) {
|
||||
locker.lockWrite(testKey)
|
||||
}
|
||||
}
|
||||
assertFalse { locker.isWriteLocked(testKey) }
|
||||
|
||||
locker.unlockWrite()
|
||||
assertFalse { locker.isWriteLocked() }
|
||||
|
||||
realWithTimeout(1.seconds) {
|
||||
locker.lockWrite(testKey)
|
||||
}
|
||||
assertTrue { locker.isWriteLocked(testKey) }
|
||||
assertTrue { locker.unlockWrite(testKey) }
|
||||
assertFalse { locker.isWriteLocked(testKey) }
|
||||
@BeforeTest
|
||||
fun setup() {
|
||||
locker = SmartKeyRWLocker()
|
||||
}
|
||||
|
||||
// ==================== Global Read Tests ====================
|
||||
|
||||
@Test
|
||||
fun writeLockKeyFailedOnGlobalReadLockTest() = runTest {
|
||||
val locker = SmartKeyRWLocker<String>()
|
||||
val testKey = "test"
|
||||
fun testGlobalReadAllowsMultipleConcurrentReads() = runTest {
|
||||
val results = mutableListOf<Boolean>()
|
||||
|
||||
locker.acquireRead()
|
||||
|
||||
assertEquals(Int.MAX_VALUE - 1, locker.readSemaphore().freePermits)
|
||||
|
||||
assertFails {
|
||||
realWithTimeout(1.seconds) {
|
||||
locker.lockWrite(testKey)
|
||||
val jobs = List(5) {
|
||||
launch {
|
||||
locker.acquireRead()
|
||||
delay(100.milliseconds)
|
||||
results.add(true)
|
||||
locker.releaseRead()
|
||||
}
|
||||
}
|
||||
assertFalse { locker.isWriteLocked(testKey) }
|
||||
|
||||
jobs.joinAll()
|
||||
locker.releaseRead()
|
||||
|
||||
assertEquals(5, results.size)
|
||||
}
|
||||
|
||||
@Test
|
||||
fun testGlobalReadBlocksGlobalWrite() = runTest {
|
||||
locker.acquireRead()
|
||||
|
||||
var writeAcquired = false
|
||||
val writeJob = launch {
|
||||
locker.lockWrite()
|
||||
writeAcquired = true
|
||||
locker.unlockWrite()
|
||||
}
|
||||
|
||||
delay(200.milliseconds)
|
||||
assertFalse(writeAcquired, "Write should be blocked by global read")
|
||||
|
||||
locker.releaseRead()
|
||||
assertEquals(Int.MAX_VALUE, locker.readSemaphore().freePermits)
|
||||
writeJob.join()
|
||||
|
||||
realWithTimeout(1.seconds) {
|
||||
locker.lockWrite(testKey)
|
||||
}
|
||||
assertTrue { locker.isWriteLocked(testKey) }
|
||||
assertTrue { locker.unlockWrite(testKey) }
|
||||
assertFalse { locker.isWriteLocked(testKey) }
|
||||
assertTrue(writeAcquired, "Write should succeed after read released")
|
||||
}
|
||||
|
||||
@Test
|
||||
fun readLockFailedOnWriteLockKeyTest() = runTest {
|
||||
val locker = SmartKeyRWLocker<String>()
|
||||
val testKey = "test"
|
||||
locker.lockWrite(testKey)
|
||||
fun testGlobalReadBlocksAllKeyWrites() = runTest {
|
||||
locker.acquireRead()
|
||||
|
||||
assertTrue { locker.isWriteLocked(testKey) }
|
||||
val writeFlags = mutableMapOf<String, Boolean>()
|
||||
val keys = listOf("key1", "key2", "key3")
|
||||
|
||||
assertFails {
|
||||
realWithTimeout(1.seconds) {
|
||||
val jobs = keys.map { key ->
|
||||
launch {
|
||||
locker.lockWrite(key)
|
||||
writeFlags[key] = true
|
||||
locker.unlockWrite(key)
|
||||
}
|
||||
}
|
||||
|
||||
delay(200.milliseconds)
|
||||
assertTrue(writeFlags.isEmpty(), "No writes should succeed while global read active")
|
||||
|
||||
locker.releaseRead()
|
||||
jobs.joinAll()
|
||||
|
||||
assertEquals(keys.size, writeFlags.size, "All writes should succeed after global read released")
|
||||
}
|
||||
|
||||
// ==================== Global Write Tests ====================
|
||||
|
||||
@Test
|
||||
fun testGlobalWriteBlocksAllOperations() = runTest {
|
||||
locker.lockWrite()
|
||||
|
||||
var globalReadAcquired = false
|
||||
var keyReadAcquired = false
|
||||
var keyWriteAcquired = false
|
||||
|
||||
val jobs = listOf(
|
||||
launch {
|
||||
locker.acquireRead()
|
||||
globalReadAcquired = true
|
||||
locker.releaseRead()
|
||||
},
|
||||
launch {
|
||||
locker.acquireRead("key1")
|
||||
keyReadAcquired = true
|
||||
locker.releaseRead("key1")
|
||||
},
|
||||
launch {
|
||||
locker.lockWrite("key2")
|
||||
keyWriteAcquired = true
|
||||
locker.unlockWrite("key2")
|
||||
}
|
||||
}
|
||||
assertEquals(locker.readSemaphore().maxPermits - 1, locker.readSemaphore().freePermits)
|
||||
)
|
||||
|
||||
locker.unlockWrite(testKey)
|
||||
assertFalse { locker.isWriteLocked(testKey) }
|
||||
delay(200.milliseconds)
|
||||
assertFalse(globalReadAcquired, "Global read should be blocked")
|
||||
assertFalse(keyReadAcquired, "Key read should be blocked")
|
||||
assertFalse(keyWriteAcquired, "Key write should be blocked")
|
||||
|
||||
realWithTimeout(1.seconds) {
|
||||
locker.acquireRead()
|
||||
}
|
||||
assertEquals(locker.readSemaphore().maxPermits - 1, locker.readSemaphore().freePermits)
|
||||
assertTrue { locker.releaseRead() }
|
||||
assertEquals(locker.readSemaphore().maxPermits, locker.readSemaphore().freePermits)
|
||||
locker.unlockWrite()
|
||||
jobs.joinAll()
|
||||
|
||||
assertTrue(globalReadAcquired)
|
||||
assertTrue(keyReadAcquired)
|
||||
assertTrue(keyWriteAcquired)
|
||||
}
|
||||
|
||||
@Test
|
||||
fun writeLockFailedOnWriteLockKeyTest() = runTest {
|
||||
val locker = SmartKeyRWLocker<String>()
|
||||
val testKey = "test"
|
||||
locker.lockWrite(testKey)
|
||||
fun testGlobalWriteIsExclusive() = runTest {
|
||||
locker.lockWrite()
|
||||
|
||||
assertTrue { locker.isWriteLocked(testKey) }
|
||||
|
||||
assertFails {
|
||||
realWithTimeout(1.seconds) {
|
||||
locker.lockWrite()
|
||||
}
|
||||
}
|
||||
assertFalse(locker.isWriteLocked())
|
||||
|
||||
locker.unlockWrite(testKey)
|
||||
assertFalse { locker.isWriteLocked(testKey) }
|
||||
|
||||
realWithTimeout(1.seconds) {
|
||||
var secondWriteAcquired = false
|
||||
val job = launch {
|
||||
locker.lockWrite()
|
||||
secondWriteAcquired = true
|
||||
locker.unlockWrite()
|
||||
}
|
||||
assertTrue(locker.isWriteLocked())
|
||||
assertTrue { locker.unlockWrite() }
|
||||
assertFalse(locker.isWriteLocked())
|
||||
|
||||
delay(200.milliseconds)
|
||||
assertFalse(secondWriteAcquired, "Second global write should be blocked")
|
||||
|
||||
locker.unlockWrite()
|
||||
job.join()
|
||||
|
||||
assertTrue(secondWriteAcquired)
|
||||
}
|
||||
|
||||
// ==================== Key Read Tests ====================
|
||||
|
||||
@Test
|
||||
fun readsBlockingGlobalWrite() = runTest {
|
||||
val locker = SmartKeyRWLocker<String>()
|
||||
fun testKeyReadAllowsMultipleConcurrentReadsForSameKey() = runTest {
|
||||
val key = "testKey"
|
||||
val results = mutableListOf<Boolean>()
|
||||
|
||||
val testKeys = (0 until 100).map { "test$it" }
|
||||
locker.acquireRead(key)
|
||||
|
||||
for (i in testKeys.indices) {
|
||||
val it = testKeys[i]
|
||||
locker.acquireRead(it)
|
||||
val previous = testKeys.take(i)
|
||||
val next = testKeys.drop(i + 1)
|
||||
|
||||
previous.forEach {
|
||||
assertTrue { locker.readSemaphoreOrNull(it) ?.freePermits == Int.MAX_VALUE - 1 }
|
||||
}
|
||||
next.forEach {
|
||||
assertTrue { locker.readSemaphoreOrNull(it) ?.freePermits == null }
|
||||
val jobs = List(5) {
|
||||
launch {
|
||||
locker.acquireRead(key)
|
||||
delay(50.milliseconds)
|
||||
results.add(true)
|
||||
locker.releaseRead(key)
|
||||
}
|
||||
}
|
||||
|
||||
for (i in testKeys.indices) {
|
||||
val it = testKeys[i]
|
||||
assertFails {
|
||||
realWithTimeout(13.milliseconds) { locker.lockWrite() }
|
||||
jobs.joinAll()
|
||||
locker.releaseRead(key)
|
||||
|
||||
assertEquals(5, results.size)
|
||||
}
|
||||
|
||||
@Test
|
||||
fun testKeyReadAllowsReadsForDifferentKeys() = runTest {
|
||||
val results = mutableMapOf<String, Boolean>()
|
||||
|
||||
locker.acquireRead("key1")
|
||||
|
||||
val jobs = listOf("key2", "key3", "key4").map { key ->
|
||||
launch {
|
||||
locker.acquireRead(key)
|
||||
delay(50.milliseconds)
|
||||
results[key] = true
|
||||
locker.releaseRead(key)
|
||||
}
|
||||
val readPermitsBeforeLock = locker.readSemaphore().freePermits
|
||||
realWithTimeout(1.seconds) { locker.acquireRead() }
|
||||
}
|
||||
|
||||
jobs.joinAll()
|
||||
locker.releaseRead("key1")
|
||||
|
||||
assertEquals(3, results.size)
|
||||
}
|
||||
|
||||
@Test
|
||||
fun testKeyReadBlocksWriteForSameKey() = runTest {
|
||||
val key = "testKey"
|
||||
locker.acquireRead(key)
|
||||
|
||||
var writeAcquired = false
|
||||
val job = launch {
|
||||
locker.lockWrite(key)
|
||||
writeAcquired = true
|
||||
locker.unlockWrite(key)
|
||||
}
|
||||
|
||||
delay(200.milliseconds)
|
||||
assertFalse(writeAcquired, "Write for same key should be blocked")
|
||||
|
||||
locker.releaseRead(key)
|
||||
job.join()
|
||||
|
||||
assertTrue(writeAcquired)
|
||||
}
|
||||
|
||||
@Test
|
||||
fun testKeyReadBlocksGlobalWrite() = runTest {
|
||||
locker.acquireRead("key1")
|
||||
|
||||
var globalWriteAcquired = false
|
||||
val job = launch {
|
||||
locker.lockWrite()
|
||||
globalWriteAcquired = true
|
||||
locker.unlockWrite()
|
||||
}
|
||||
|
||||
delay(200.milliseconds)
|
||||
assertFalse(globalWriteAcquired, "Global write should be blocked by key read")
|
||||
|
||||
locker.releaseRead("key1")
|
||||
job.join()
|
||||
|
||||
assertTrue(globalWriteAcquired)
|
||||
}
|
||||
|
||||
@Test
|
||||
fun testKeyReadAllowsWriteForDifferentKey() = runTest {
|
||||
locker.acquireRead("key1")
|
||||
|
||||
var writeAcquired = false
|
||||
val job = launch {
|
||||
locker.lockWrite("key2")
|
||||
writeAcquired = true
|
||||
locker.unlockWrite("key2")
|
||||
}
|
||||
|
||||
job.join()
|
||||
assertTrue(writeAcquired, "Write for different key should succeed")
|
||||
|
||||
locker.releaseRead("key1")
|
||||
}
|
||||
|
||||
// ==================== Key Write Tests ====================
|
||||
|
||||
@Test
|
||||
fun testKeyWriteBlocksReadForSameKey() = runTest {
|
||||
val key = "testKey"
|
||||
locker.lockWrite(key)
|
||||
|
||||
var readAcquired = false
|
||||
val job = launch {
|
||||
locker.acquireRead(key)
|
||||
readAcquired = true
|
||||
locker.releaseRead(key)
|
||||
}
|
||||
|
||||
delay(200.milliseconds)
|
||||
assertFalse(readAcquired, "Read for same key should be blocked")
|
||||
|
||||
locker.unlockWrite(key)
|
||||
job.join()
|
||||
|
||||
assertTrue(readAcquired)
|
||||
}
|
||||
|
||||
@Test
|
||||
fun testKeyWriteBlocksGlobalRead() = runTest {
|
||||
locker.lockWrite("key1")
|
||||
|
||||
var globalReadAcquired = false
|
||||
val job = launch {
|
||||
locker.acquireRead()
|
||||
globalReadAcquired = true
|
||||
locker.releaseRead()
|
||||
assertEquals(readPermitsBeforeLock, locker.readSemaphore().freePermits)
|
||||
|
||||
locker.releaseRead(it)
|
||||
}
|
||||
|
||||
assertTrue { locker.readSemaphore().freePermits == Int.MAX_VALUE }
|
||||
realWithTimeout(1.seconds) { locker.lockWrite() }
|
||||
assertFails {
|
||||
realWithTimeout(13.milliseconds) { locker.acquireRead() }
|
||||
}
|
||||
assertTrue { locker.unlockWrite() }
|
||||
assertTrue { locker.readSemaphore().freePermits == Int.MAX_VALUE }
|
||||
delay(200.milliseconds)
|
||||
assertFalse(globalReadAcquired, "Global read should be blocked by key write")
|
||||
|
||||
locker.unlockWrite("key1")
|
||||
job.join()
|
||||
|
||||
assertTrue(globalReadAcquired)
|
||||
}
|
||||
|
||||
@Test
|
||||
fun writesBlockingGlobalWrite() = runTest {
|
||||
val locker = SmartKeyRWLocker<String>()
|
||||
fun testKeyWriteIsExclusiveForSameKey() = runTest {
|
||||
val key = "testKey"
|
||||
locker.lockWrite(key)
|
||||
|
||||
val testKeys = (0 until 100).map { "test$it" }
|
||||
var secondWriteAcquired = false
|
||||
val job = launch {
|
||||
locker.lockWrite(key)
|
||||
secondWriteAcquired = true
|
||||
locker.unlockWrite(key)
|
||||
}
|
||||
|
||||
for (i in testKeys.indices) {
|
||||
val it = testKeys[i]
|
||||
locker.lockWrite(it)
|
||||
val previous = testKeys.take(i)
|
||||
val next = testKeys.drop(i + 1)
|
||||
delay(200.milliseconds)
|
||||
assertFalse(secondWriteAcquired, "Second write for same key should be blocked")
|
||||
|
||||
previous.forEach {
|
||||
assertTrue { locker.writeMutexOrNull(it) ?.isLocked == true }
|
||||
locker.unlockWrite(key)
|
||||
job.join()
|
||||
|
||||
assertTrue(secondWriteAcquired)
|
||||
}
|
||||
|
||||
@Test
|
||||
fun testKeyWriteAllowsOperationsOnDifferentKeys() = runTest {
|
||||
locker.lockWrite("key1")
|
||||
|
||||
val results = mutableMapOf<String, Boolean>()
|
||||
|
||||
val jobs = listOf(
|
||||
launch {
|
||||
locker.acquireRead("key2")
|
||||
results["read-key2"] = true
|
||||
locker.releaseRead("key2")
|
||||
},
|
||||
launch {
|
||||
locker.lockWrite("key3")
|
||||
results["write-key3"] = true
|
||||
locker.unlockWrite("key3")
|
||||
}
|
||||
next.forEach {
|
||||
assertTrue { locker.writeMutexOrNull(it) ?.isLocked != true }
|
||||
)
|
||||
|
||||
jobs.joinAll()
|
||||
assertEquals(2, results.size, "Operations on different keys should succeed")
|
||||
|
||||
locker.unlockWrite("key1")
|
||||
}
|
||||
|
||||
// ==================== Complex Scenarios ====================
|
||||
|
||||
@Test
|
||||
fun testMultipleReadersThenWriter() = runTest {
|
||||
val key = "testKey"
|
||||
val readCount = 5
|
||||
val readers = mutableListOf<Job>()
|
||||
|
||||
repeat(readCount) {
|
||||
readers.add(launch {
|
||||
locker.acquireRead(key)
|
||||
delay(100.milliseconds)
|
||||
locker.releaseRead(key)
|
||||
})
|
||||
}
|
||||
|
||||
delay(50.milliseconds) // Let readers acquire
|
||||
|
||||
var writerExecuted = false
|
||||
val writer = launch {
|
||||
locker.lockWrite(key)
|
||||
writerExecuted = true
|
||||
locker.unlockWrite(key)
|
||||
}
|
||||
|
||||
delay(50.milliseconds)
|
||||
assertFalse(writerExecuted, "Writer should wait for all readers")
|
||||
|
||||
readers.joinAll()
|
||||
writer.join()
|
||||
|
||||
assertTrue(writerExecuted, "Writer should execute after all readers done")
|
||||
}
|
||||
|
||||
@Test
|
||||
fun testWriterThenMultipleReaders() = runTest {
|
||||
val key = "testKey"
|
||||
|
||||
locker.lockWrite(key)
|
||||
|
||||
val readerFlags = mutableListOf<Boolean>()
|
||||
val readers = List(5) {
|
||||
launch {
|
||||
locker.acquireRead(key)
|
||||
readerFlags.add(true)
|
||||
locker.releaseRead(key)
|
||||
}
|
||||
}
|
||||
|
||||
for (i in testKeys.indices) {
|
||||
val it = testKeys[i]
|
||||
assertFails { realWithTimeout(13.milliseconds) { locker.lockWrite() } }
|
||||
delay(200.milliseconds)
|
||||
assertTrue(readerFlags.isEmpty(), "Readers should be blocked by writer")
|
||||
|
||||
val readPermitsBeforeLock = locker.readSemaphore().freePermits
|
||||
assertFails { realWithTimeout(13.milliseconds) { locker.acquireRead() } }
|
||||
assertEquals(readPermitsBeforeLock, locker.readSemaphore().freePermits)
|
||||
locker.unlockWrite(key)
|
||||
readers.joinAll()
|
||||
|
||||
locker.unlockWrite(it)
|
||||
assertEquals(5, readerFlags.size, "All readers should succeed after writer")
|
||||
}
|
||||
|
||||
@Test
|
||||
fun testCascadingLocksWithDifferentKeys() = runTest {
|
||||
val executed = mutableMapOf<String, Boolean>()
|
||||
|
||||
launch {
|
||||
locker.lockWrite("key1")
|
||||
executed["write-key1-start"] = true
|
||||
delay(100.milliseconds)
|
||||
locker.unlockWrite("key1")
|
||||
executed["write-key1-end"] = true
|
||||
}
|
||||
|
||||
assertTrue { locker.readSemaphore().freePermits == Int.MAX_VALUE }
|
||||
realWithTimeout(1.seconds) { locker.lockWrite() }
|
||||
assertFails {
|
||||
realWithTimeout(13.milliseconds) { locker.acquireRead() }
|
||||
delay(50.milliseconds)
|
||||
|
||||
launch {
|
||||
locker.acquireRead("key2")
|
||||
executed["read-key2"] = true
|
||||
delay(100.milliseconds)
|
||||
locker.releaseRead("key2")
|
||||
}
|
||||
assertTrue { locker.unlockWrite() }
|
||||
assertTrue { locker.readSemaphore().freePermits == Int.MAX_VALUE }
|
||||
|
||||
delay(200.milliseconds)
|
||||
|
||||
assertTrue(executed["write-key1-start"] == true)
|
||||
assertTrue(executed["read-key2"] == true)
|
||||
assertTrue(executed["write-key1-end"] == true)
|
||||
}
|
||||
|
||||
@Test
|
||||
fun testReleaseWithoutAcquireReturnsFalse() = runTest {
|
||||
assertFalse(locker.releaseRead(), "Release without acquire should return false")
|
||||
assertFalse(locker.releaseRead("key1"), "Release without acquire should return false")
|
||||
}
|
||||
|
||||
@Test
|
||||
fun testUnlockWithoutLockReturnsFalse() = runTest {
|
||||
assertFalse(locker.unlockWrite(), "Unlock without lock should return false")
|
||||
assertFalse(locker.unlockWrite("key1"), "Unlock without lock should return false")
|
||||
}
|
||||
|
||||
@Test
|
||||
fun testProperReleaseReturnsTrue() = runTest {
|
||||
locker.acquireRead()
|
||||
assertTrue(locker.releaseRead(), "Release after acquire should return true")
|
||||
|
||||
locker.acquireRead("key1")
|
||||
assertTrue(locker.releaseRead("key1"), "Release after acquire should return true")
|
||||
}
|
||||
|
||||
@Test
|
||||
fun testProperUnlockReturnsTrue() = runTest {
|
||||
locker.lockWrite()
|
||||
assertTrue(locker.unlockWrite(), "Unlock after lock should return true")
|
||||
|
||||
locker.lockWrite("key1")
|
||||
assertTrue(locker.unlockWrite("key1"), "Unlock after lock should return true")
|
||||
}
|
||||
|
||||
// ==================== Stress Tests ====================
|
||||
|
||||
@Test
|
||||
fun stressTestWithMixedOperations() = runTest(timeout = 10.seconds) {
|
||||
val operations = 100
|
||||
val keys = listOf("key1", "key2", "key3", "key4", "key5")
|
||||
val jobs = mutableListOf<Job>()
|
||||
|
||||
repeat(operations) { i ->
|
||||
val key = keys[i % keys.size]
|
||||
|
||||
when (i % 4) {
|
||||
0 -> jobs.add(launch {
|
||||
locker.acquireRead(key)
|
||||
delay(10.milliseconds)
|
||||
locker.releaseRead(key)
|
||||
})
|
||||
1 -> jobs.add(launch {
|
||||
locker.lockWrite(key)
|
||||
delay(10.milliseconds)
|
||||
locker.unlockWrite(key)
|
||||
})
|
||||
2 -> jobs.add(launch {
|
||||
locker.acquireRead()
|
||||
delay(10.milliseconds)
|
||||
locker.releaseRead()
|
||||
})
|
||||
3 -> jobs.add(launch {
|
||||
locker.lockWrite()
|
||||
delay(10.milliseconds)
|
||||
locker.unlockWrite()
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
jobs.joinAll()
|
||||
// If we reach here without deadlock or exceptions, test passes
|
||||
}
|
||||
|
||||
@Test
|
||||
fun testFairnessReadersDontStarveWriters() = runTest(timeout = 5.seconds) {
|
||||
val key = "testKey"
|
||||
var writerExecuted = false
|
||||
|
||||
// Start continuous readers
|
||||
val readers = List(10) {
|
||||
launch {
|
||||
repeat(5) {
|
||||
locker.acquireRead(key)
|
||||
delay(50.milliseconds)
|
||||
locker.releaseRead(key)
|
||||
delay(10.milliseconds)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
delay(100.milliseconds)
|
||||
|
||||
// Try to acquire write lock
|
||||
val writer = launch {
|
||||
locker.lockWrite(key)
|
||||
writerExecuted = true
|
||||
locker.unlockWrite(key)
|
||||
}
|
||||
|
||||
readers.joinAll()
|
||||
writer.join()
|
||||
|
||||
assertTrue(writerExecuted, "Writer should eventually execute")
|
||||
}
|
||||
}
|
||||
|
||||
73
coroutines/src/commonTest/kotlin/SmartMutexTests.kt
Normal file
73
coroutines/src/commonTest/kotlin/SmartMutexTests.kt
Normal file
@@ -0,0 +1,73 @@
|
||||
import dev.inmo.micro_utils.coroutines.SmartMutex
|
||||
import dev.inmo.micro_utils.coroutines.withLock
|
||||
import kotlinx.coroutines.Dispatchers
|
||||
import kotlinx.coroutines.awaitCancellation
|
||||
import kotlinx.coroutines.cancel
|
||||
import kotlinx.coroutines.cancelAndJoin
|
||||
import kotlinx.coroutines.currentCoroutineContext
|
||||
import kotlinx.coroutines.flow.first
|
||||
import kotlinx.coroutines.launch
|
||||
import kotlinx.coroutines.test.runTest
|
||||
import kotlin.test.Test
|
||||
import kotlin.test.assertFalse
|
||||
import kotlin.test.assertTrue
|
||||
import kotlin.time.Duration.Companion.seconds
|
||||
|
||||
class SmartMutexTests {
|
||||
@Test
|
||||
fun cancelledUnlockCompletesUnderContention() = runTest(timeout = 5.seconds) {
|
||||
val mutex = SmartMutex.Mutable()
|
||||
|
||||
// Delegate this acquisition's release to another coroutine. The
|
||||
// unconfined collector runs while lock() still holds its internal mutex.
|
||||
val releaser = launch(Dispatchers.Unconfined) {
|
||||
mutex.lockStateFlow.first { it }
|
||||
currentCoroutineContext().cancel()
|
||||
mutex.unlock()
|
||||
}
|
||||
|
||||
// Keep acquisition on the normal test dispatcher so the collector
|
||||
// attempts cancelled cleanup before the internal mutex is released.
|
||||
mutex.lock()
|
||||
releaser.join()
|
||||
|
||||
assertTrue(releaser.isCancelled)
|
||||
assertFalse(mutex.isLocked, "Cancellation must not prevent the delegated unlock")
|
||||
assertTrue(mutex.tryLock())
|
||||
assertTrue(mutex.unlock())
|
||||
}
|
||||
|
||||
@Test
|
||||
fun cancellingWithLockBodyReleasesMutex() = runTest(timeout = 5.seconds) {
|
||||
val mutex = SmartMutex.Mutable()
|
||||
val holder = launch(Dispatchers.Unconfined) {
|
||||
mutex.withLock {
|
||||
awaitCancellation()
|
||||
}
|
||||
}
|
||||
assertTrue(mutex.isLocked)
|
||||
|
||||
holder.cancelAndJoin()
|
||||
|
||||
assertFalse(mutex.isLocked)
|
||||
}
|
||||
|
||||
@Test
|
||||
fun cancelledWaiterDoesNotEnterOrReleaseHeldMutex() = runTest(timeout = 5.seconds) {
|
||||
val mutex = SmartMutex.Mutable()
|
||||
var entered = false
|
||||
mutex.withLock {
|
||||
val waiter = launch(Dispatchers.Unconfined) {
|
||||
mutex.withLock {
|
||||
entered = true
|
||||
}
|
||||
}
|
||||
|
||||
waiter.cancelAndJoin()
|
||||
|
||||
assertFalse(entered)
|
||||
assertTrue(mutex.isLocked)
|
||||
}
|
||||
assertFalse(mutex.isLocked)
|
||||
}
|
||||
}
|
||||
@@ -9,6 +9,7 @@ import kotlin.test.assertEquals
|
||||
import kotlin.test.assertFails
|
||||
import kotlin.test.assertFalse
|
||||
import kotlin.test.assertTrue
|
||||
import kotlin.time.Duration.Companion.days
|
||||
import kotlin.time.Duration.Companion.seconds
|
||||
|
||||
class SmartRWLockerTests {
|
||||
@@ -109,6 +110,59 @@ class SmartRWLockerTests {
|
||||
}
|
||||
}
|
||||
|
||||
@Test
|
||||
fun failureOnReadFreeingRead() = runTest {
|
||||
val locker = SmartRWLocker()
|
||||
val job = launch {
|
||||
locker.withReadAcquire {
|
||||
while (isActive) {
|
||||
delay(1.days)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
locker.readSemaphore.permitsStateFlow.first {
|
||||
it == locker.readSemaphore.maxPermits - 1
|
||||
}
|
||||
job.cancelAndJoin()
|
||||
locker.readSemaphore.permitsStateFlow.first {
|
||||
it == locker.readSemaphore.maxPermits
|
||||
}
|
||||
}
|
||||
|
||||
@Test
|
||||
fun cancelledReaderReleasesPermitUnderContention() = runTest(timeout = 5.seconds) {
|
||||
val locker = SmartRWLocker(readPermits = 2)
|
||||
val reader = launch(Dispatchers.Unconfined) {
|
||||
locker.withReadAcquire {
|
||||
awaitCancellation()
|
||||
}
|
||||
}
|
||||
assertEquals(1, locker.readSemaphore.freePermits)
|
||||
|
||||
// Observe the second acquisition synchronously while it still holds the
|
||||
// semaphore's internal mutex. Cancelling the unconfined reader makes its
|
||||
// cleanup contend for that mutex before the acquisition can release it.
|
||||
val cancellation = launch(Dispatchers.Unconfined) {
|
||||
locker.readSemaphore.permitsStateFlow.first { it == 0 }
|
||||
reader.cancel()
|
||||
}
|
||||
|
||||
// Keep this acquisition on the normal test dispatcher: making it
|
||||
// unconfined would change the ordering that forces cleanup contention.
|
||||
locker.withReadAcquire {
|
||||
cancellation.join()
|
||||
reader.join()
|
||||
assertTrue(reader.isCancelled)
|
||||
assertEquals(
|
||||
1,
|
||||
locker.readSemaphore.freePermits,
|
||||
"The cancelled reader must release its permit while the other reader still holds one"
|
||||
)
|
||||
}
|
||||
assertEquals(2, locker.readSemaphore.freePermits)
|
||||
}
|
||||
|
||||
@Test
|
||||
fun simpleWithReadAcquireTest() {
|
||||
val locker = SmartRWLocker()
|
||||
|
||||
104
coroutines/src/commonTest/kotlin/SmartSemaphoreTests.kt
Normal file
104
coroutines/src/commonTest/kotlin/SmartSemaphoreTests.kt
Normal file
@@ -0,0 +1,104 @@
|
||||
import dev.inmo.micro_utils.coroutines.SmartSemaphore
|
||||
import dev.inmo.micro_utils.coroutines.withAcquire
|
||||
import kotlinx.coroutines.Dispatchers
|
||||
import kotlinx.coroutines.awaitCancellation
|
||||
import kotlinx.coroutines.cancelAndJoin
|
||||
import kotlinx.coroutines.flow.first
|
||||
import kotlinx.coroutines.launch
|
||||
import kotlinx.coroutines.test.runTest
|
||||
import kotlin.test.Test
|
||||
import kotlin.test.assertEquals
|
||||
import kotlin.test.assertFalse
|
||||
import kotlin.test.assertTrue
|
||||
import kotlin.time.Duration.Companion.seconds
|
||||
|
||||
class SmartSemaphoreTests {
|
||||
@Test
|
||||
fun cancelledHolderReleasesPermitUnderContention() = runTest(timeout = 5.seconds) {
|
||||
val semaphore = SmartSemaphore.Mutable(permits = 2)
|
||||
val holder = launch(Dispatchers.Unconfined) {
|
||||
semaphore.withAcquire {
|
||||
awaitCancellation()
|
||||
}
|
||||
}
|
||||
assertEquals(1, semaphore.freePermits)
|
||||
|
||||
// The synchronous observer cancels the holder while the second
|
||||
// acquisition still owns the semaphore's internal changes mutex.
|
||||
val cancellation = launch(Dispatchers.Unconfined) {
|
||||
semaphore.permitsStateFlow.first { it == 0 }
|
||||
holder.cancel()
|
||||
}
|
||||
semaphore.withAcquire {
|
||||
cancellation.join()
|
||||
holder.join()
|
||||
assertTrue(holder.isCancelled)
|
||||
assertEquals(1, semaphore.freePermits, "The cancelled holder must return its permit")
|
||||
}
|
||||
assertEquals(2, semaphore.freePermits)
|
||||
}
|
||||
|
||||
@Test
|
||||
fun cancelledAcquireReturnsPartialPermitsUnderContention() = runTest(timeout = 5.seconds) {
|
||||
// One permit belongs to another holder; the waiter can acquire two
|
||||
// permits immediately, but must wait for the third.
|
||||
val semaphore = SmartSemaphore.Mutable(permits = 3, acquiredPermits = 1)
|
||||
lateinit var waiter: kotlinx.coroutines.Job
|
||||
val cancellation = launch(Dispatchers.Unconfined) {
|
||||
semaphore.permitsStateFlow.first { it == 1 }
|
||||
waiter.cancel()
|
||||
}
|
||||
waiter = launch(Dispatchers.Unconfined) {
|
||||
semaphore.acquire(3)
|
||||
}
|
||||
assertEquals(0, semaphore.freePermits)
|
||||
assertFalse(waiter.isCompleted)
|
||||
|
||||
// Publishing this release resumes the observer while the internal
|
||||
// mutex is held. The cancelled acquire must wait to roll back safely.
|
||||
semaphore.release()
|
||||
cancellation.join()
|
||||
waiter.join()
|
||||
assertTrue(waiter.isCancelled)
|
||||
assertEquals(3, semaphore.freePermits, "Cancellation must return both partially acquired permits")
|
||||
semaphore.withAcquire(3) {
|
||||
assertEquals(0, semaphore.freePermits)
|
||||
}
|
||||
assertEquals(3, semaphore.freePermits)
|
||||
}
|
||||
|
||||
@Test
|
||||
fun cancelledAcquireWithoutPermitsDoesNotReleaseAnotherHoldersPermit() = runTest(timeout = 5.seconds) {
|
||||
val semaphore = SmartSemaphore.Mutable(permits = 1, acquiredPermits = 1)
|
||||
val waiter = launch(Dispatchers.Unconfined) {
|
||||
semaphore.acquire()
|
||||
}
|
||||
assertFalse(waiter.isCompleted)
|
||||
|
||||
waiter.cancelAndJoin()
|
||||
assertEquals(0, semaphore.freePermits, "A cancelled waiter that acquired nothing must release nothing")
|
||||
assertTrue(semaphore.release())
|
||||
assertEquals(1, semaphore.freePermits)
|
||||
}
|
||||
|
||||
@Test
|
||||
fun tryAcquireUsesAvailablePermits() = runTest {
|
||||
val semaphore = SmartSemaphore.Mutable(permits = 3)
|
||||
assertTrue(semaphore.tryAcquire(2))
|
||||
assertEquals(1, semaphore.freePermits)
|
||||
assertTrue(semaphore.tryAcquire())
|
||||
assertEquals(0, semaphore.freePermits)
|
||||
assertTrue(semaphore.release(3))
|
||||
assertEquals(3, semaphore.freePermits)
|
||||
}
|
||||
|
||||
@Test
|
||||
fun tryAcquireWithInsufficientPermitsLeavesStateUnchanged() = runTest {
|
||||
val semaphore = SmartSemaphore.Mutable(permits = 3, acquiredPermits = 2)
|
||||
assertFalse(semaphore.tryAcquire(2))
|
||||
assertEquals(1, semaphore.freePermits)
|
||||
semaphore.acquire()
|
||||
assertFalse(semaphore.tryAcquire())
|
||||
assertEquals(0, semaphore.freePermits)
|
||||
}
|
||||
}
|
||||
@@ -1,4 +1,4 @@
|
||||
import dev.inmo.micro_utils.coroutines.SpecialMutableStateFlow
|
||||
import dev.inmo.micro_utils.coroutines.MutableRedeliverStateFlow
|
||||
import dev.inmo.micro_utils.coroutines.asDeferred
|
||||
import dev.inmo.micro_utils.coroutines.subscribe
|
||||
import kotlinx.coroutines.Job
|
||||
@@ -8,17 +8,17 @@ import kotlin.test.Test
|
||||
import kotlin.test.assertEquals
|
||||
import kotlin.test.assertTrue
|
||||
|
||||
class SpecialMutableStateFlowTests {
|
||||
class MutableRedeliverStateFlowTests {
|
||||
@Test
|
||||
fun simpleTest() = runTest {
|
||||
val specialMutableStateFlow = SpecialMutableStateFlow(0)
|
||||
val specialMutableStateFlow = MutableRedeliverStateFlow(0)
|
||||
specialMutableStateFlow.value = 1
|
||||
specialMutableStateFlow.first { it == 1 }
|
||||
assertEquals(1, specialMutableStateFlow.value)
|
||||
}
|
||||
@Test
|
||||
fun specialTest() = runTest {
|
||||
val specialMutableStateFlow = SpecialMutableStateFlow(0)
|
||||
val specialMutableStateFlow = MutableRedeliverStateFlow(0)
|
||||
lateinit var subscriberJob: Job
|
||||
subscriberJob = specialMutableStateFlow.subscribe(this) {
|
||||
when (it) {
|
||||
|
||||
@@ -15,5 +15,5 @@ crypto_js_version=4.1.1
|
||||
# Project data
|
||||
|
||||
group=dev.inmo
|
||||
version=0.25.8
|
||||
version=0.25.8.3
|
||||
android_code_version=298
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
package dev.inmo.micro_utils.pagination.compose
|
||||
|
||||
import androidx.compose.runtime.*
|
||||
import dev.inmo.micro_utils.coroutines.SpecialMutableStateFlow
|
||||
import dev.inmo.micro_utils.coroutines.MutableRedeliverStateFlow
|
||||
import dev.inmo.micro_utils.coroutines.launchLoggingDropExceptions
|
||||
import dev.inmo.micro_utils.coroutines.runCatchingLogging
|
||||
import dev.inmo.micro_utils.pagination.*
|
||||
@@ -27,8 +27,8 @@ class InfinityPagedComponentContext<T> internal constructor(
|
||||
private val loader: suspend InfinityPagedComponentContext<T>.(Pagination) -> PaginationResult<T>
|
||||
) {
|
||||
internal val startPage = SimplePagination(page, size)
|
||||
internal val latestLoadedPage = SpecialMutableStateFlow<PaginationResult<T>?>(null)
|
||||
internal val dataState = SpecialMutableStateFlow<List<T>?>(null)
|
||||
internal val latestLoadedPage = MutableRedeliverStateFlow<PaginationResult<T>?>(null)
|
||||
internal val dataState = MutableRedeliverStateFlow<List<T>?>(null)
|
||||
internal var loadingJob: Job? = null
|
||||
internal val loadingMutex = Mutex()
|
||||
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
package dev.inmo.micro_utils.pagination.compose
|
||||
|
||||
import androidx.compose.runtime.*
|
||||
import dev.inmo.micro_utils.coroutines.SpecialMutableStateFlow
|
||||
import dev.inmo.micro_utils.coroutines.MutableRedeliverStateFlow
|
||||
import dev.inmo.micro_utils.coroutines.launchLoggingDropExceptions
|
||||
import dev.inmo.micro_utils.pagination.*
|
||||
import kotlinx.coroutines.CoroutineScope
|
||||
@@ -28,8 +28,8 @@ class PagedComponentContext<T> internal constructor(
|
||||
private val loader: suspend PagedComponentContext<T>.(Pagination) -> PaginationResult<T>
|
||||
) {
|
||||
internal val startPage = SimplePagination(initialPage, size)
|
||||
internal val latestLoadedPage = SpecialMutableStateFlow<PaginationResult<T>?>(null)
|
||||
internal val dataState = SpecialMutableStateFlow<PaginationResult<T>?>(null)
|
||||
internal val latestLoadedPage = MutableRedeliverStateFlow<PaginationResult<T>?>(null)
|
||||
internal val dataState = MutableRedeliverStateFlow<PaginationResult<T>?>(null)
|
||||
internal var loadingJob: Job? = null
|
||||
internal val loadingMutex = Mutex()
|
||||
|
||||
|
||||
Reference in New Issue
Block a user