PowLimiter and CommonLimiter rewriting (#210)

CHANGELOG.md

@@ -7,6 +7,7 @@
         * `MicroUtils`: `0.4.0` -> `0.4.1`
 * `Core`:
     * `TelegramAPIUrlsKeeper` will fix ending of host url since this version
+    * New mechanisms in`PowLimiter` and `CommonLimiter` has been added
 
 ## 0.30.6
 

tgbotapi.core/src/commonMain/kotlin/dev/inmo/tgbotapi/bot/settings/limiters/CommonLimiter.kt

@@ -1,67 +1,43 @@
 package dev.inmo.tgbotapi.bot.settings.limiters
 
 import com.soywiz.klock.DateTime
+import dev.inmo.micro_utils.coroutines.*
+import dev.inmo.tgbotapi.types.MilliSeconds
 import kotlinx.coroutines.*
 import kotlinx.coroutines.channels.Channel
+import kotlinx.coroutines.flow.filter
+import kotlinx.coroutines.sync.Semaphore
+import kotlinx.serialization.Serializable
+import kotlinx.serialization.Transient
+import kotlin.coroutines.Continuation
+import kotlin.math.roundToLong
 
 private fun now(): Long = DateTime.nowUnixLong()
 
+@Serializable
 class CommonLimiter(
     private val lockCount: Int = 10,
-    private val regenTime: Long = 20 * 1000L // 20 seconds for full regen of opportunity to send message
+    private val regenTime: MilliSeconds = 15 * 1000, // 15 seconds for full regen of opportunity to send message
+    @Transient
+    private val scope: CoroutineScope = CoroutineScope(Dispatchers.Default)
 ) : RequestLimiter {
-    private var doLimit: Boolean = false
+    private val quotaSemaphore = Semaphore(lockCount)
-
+    private val counterRegeneratorJob = scope.launch {
-    private val counterChannel = Channel<Unit>(Channel.UNLIMITED)
+        val regenDelay: MilliSeconds = (regenTime.toDouble() / lockCount).roundToLong()
-    private val scope = CoroutineScope(Dispatchers.Default)
-    private val counterJob = scope.launch {
-        var wasLastSecond = 0
-        var lastCountTime = now()
-        var limitManagementJob: Job? = null
-        var removeLimitTime: Long = lastCountTime
-        for (counter in counterChannel) {
-            val now = now()
-            if (now - lastCountTime > 1000) {
-                lastCountTime = now
-                wasLastSecond = 1
-            } else {
-                wasLastSecond++
-            }
-            if (wasLastSecond >= lockCount) {
-                removeLimitTime = now + regenTime
-                if (limitManagementJob == null) {
-                    limitManagementJob = launch {
-                        doLimit = true
-                        var internalNow = now()
-                        while (internalNow < removeLimitTime) {
-                            delay(removeLimitTime - internalNow)
-                            internalNow = now()
-                        }
-                        doLimit = false
-                    }
-                }
-            }
-            if (now > removeLimitTime) {
-                limitManagementJob = null
-            }
-        }
-    }
-
-    private val quoterChannel = Channel<Unit>(Channel.CONFLATED)
-    private val tickerJob = scope.launch {
         while (isActive) {
-            quoterChannel.send(Unit)
+            delay(regenDelay)
-            delay(1000L)
+            if (quotaSemaphore.availablePermits < lockCount) {
+                try {
+                    quotaSemaphore.release()
+                } catch (_: IllegalStateException) {
+                    // Skip IllegalStateException due to the fact that this exception may happens in release method
+                }
+            }
         }
     }
 
     override suspend fun <T> limit(block: suspend () -> T): T {
-        counterChannel.send(Unit)
+        quotaSemaphore.acquire()
-        return if (!doLimit) {
+        return block()
-            block()
-        } else {
-            quoterChannel.receive()
-            block()
-        }
     }
 }

tgbotapi.core/src/commonMain/kotlin/dev/inmo/tgbotapi/bot/settings/limiters/PowLimiter.kt

@@ -1,5 +1,7 @@
 package dev.inmo.tgbotapi.bot.settings.limiters
 
+import dev.inmo.micro_utils.coroutines.*
+import dev.inmo.tgbotapi.types.MilliSeconds
 import kotlinx.coroutines.*
 import kotlinx.coroutines.channels.Channel
 import kotlinx.serialization.Serializable
@@ -9,42 +11,35 @@ import kotlin.math.pow
 
 private sealed class RequestEvent
 private class AddRequest(
-    val continuation: Continuation<Long>
+    val continuation: Continuation<MilliSeconds>
 ) : RequestEvent()
 private object CompleteRequest : RequestEvent()
 
 @Serializable
 data class PowLimiter(
-    private val minAwaitTime: Long = 0L,
+    private val minAwaitTime: MilliSeconds = 0L,
-    private val maxAwaitTime: Long = 10000L,
+    private val maxAwaitTime: MilliSeconds = 10000L,
     private val powValue: Double = 4.0,
-    private val powK: Double = 0.0016
+    private val powK: Double = 1.6,
+    @Transient
+    private val scope: CoroutineScope = CoroutineScope(Dispatchers.Default)
 ) : RequestLimiter {
-    @Transient
-    private val scope = CoroutineScope(Dispatchers.Default)
-    @Transient
-    private val eventsChannel = Channel<RequestEvent>(Channel.UNLIMITED)
     @Transient
     private val awaitTimeRange = minAwaitTime .. maxAwaitTime
-
+    @Transient
-    init {
+    private val eventsChannel = let {
-        scope.launch {
+        var requestsInWork = 0.0
-            var requestsInWork: Double = 0.0
+        scope.actor<RequestEvent> {
-            for (event in eventsChannel) {
+            when (it) {
-                when (event) {
                 is AddRequest -> {
-                        val awaitTime = (((requestsInWork.pow(powValue) * powK) * 1000L).toLong())
+                    val awaitTime = (requestsInWork.pow(powValue) * powK).toLong()
                     requestsInWork++
 
-                        event.continuation.resume(
+                    it.continuation.resume(
-                            if (awaitTime in awaitTimeRange) {
+                        when {
-                                awaitTime
+                            awaitTime in awaitTimeRange -> awaitTime
-                            } else {
+                            awaitTime < awaitTimeRange.first -> awaitTimeRange.first
-                                if (awaitTime < minAwaitTime) {
+                            else -> awaitTimeRange.last
-                                    minAwaitTime
-                                } else {
-                                    maxAwaitTime
-                                }
                         }
                     )
                 }
@@ -52,19 +47,24 @@ data class PowLimiter(
             }
         }
     }
-    }
 
-    override suspend fun <T> limit(
+    private suspend inline fun <T> withDelay(
-        block: suspend () -> T
+        crossinline block: suspend () -> T
     ): T {
         val delayMillis = suspendCoroutine<Long> {
             scope.launch { eventsChannel.send(AddRequest(it)) }
         }
         delay(delayMillis)
         return try {
-            block()
+            safely { block() }
         } finally {
             eventsChannel.send(CompleteRequest)
         }
     }
+
+    override suspend fun <T> limit(
+        block: suspend () -> T
+    ): T {
+        return withDelay(block)
+    }
 }