improvements and actualization

2025-09-16 13:39:18 +00:00 · 2022-05-14 13:43:28 +06:00
parent 8543917da7
commit 0b79f27b38
12 changed files with 198 additions and 127 deletions
--- a/src/commonMain/kotlin/dev/inmo/saucenaoapi/SauceNaoAPI.kt
+++ b/src/commonMain/kotlin/dev/inmo/saucenaoapi/SauceNaoAPI.kt
@@ -5,18 +5,16 @@ import dev.inmo.saucenaoapi.exceptions.sauceNaoAPIException
 import dev.inmo.saucenaoapi.models.*
 import dev.inmo.saucenaoapi.utils.*
 import io.ktor.client.HttpClient
-import io.ktor.client.features.ClientRequestException
+import io.ktor.client.plugins.ClientRequestException
 import io.ktor.client.request.*
 import io.ktor.client.request.forms.MultiPartFormDataContent
 import io.ktor.client.request.forms.formData
-import io.ktor.client.statement.HttpResponse
-import io.ktor.client.statement.readText
+import io.ktor.client.statement.*
 import io.ktor.http.*
 import io.ktor.utils.io.core.Input
 import kotlinx.coroutines.*
 import kotlinx.coroutines.channels.Channel
 import kotlinx.serialization.json.Json
-import kotlin.coroutines.*

 private const val API_TOKEN_FIELD = "api_key"
 private const val OUTPUT_TYPE_FIELD = "output_type"
@@ -40,26 +38,30 @@ val defaultSauceNaoParser = Json {

 data class SauceNaoAPI(
    private val apiToken: String? = null,
-    private val outputType: dev.inmo.saucenaoapi.OutputType = dev.inmo.saucenaoapi.JsonOutputType,
    private val client: HttpClient = HttpClient(),
    private val searchUrl: String = SEARCH_URL,
    private val scope: CoroutineScope = CoroutineScope(Dispatchers.Default),
    private val parser: Json = defaultSauceNaoParser
 ) : SauceCloseable {
-    private val requestsChannel = Channel<Pair<Continuation<SauceNaoAnswer>, HttpRequestBuilder>>(Channel.UNLIMITED)
-    private val timeManager = TimeManager(scope)
-    private val quotaManager = RequestQuotaManager(scope)
+    private val requestsChannel = Channel<Pair<CompletableDeferred<SauceNaoAnswer>, HttpRequestBuilder>>(Channel.UNLIMITED)
+    private val subscope = CoroutineScope(scope.coroutineContext + SupervisorJob(scope.coroutineContext.job)).also {
+        it.coroutineContext.job.invokeOnCompletion {
+            requestsChannel.close(it)
+        }
+    }
+    private val timeManager = TimeManager(subscope)
+    private val quotaManager = RequestQuotaManager(subscope)

    val limitsState: LimitsState
        get() = quotaManager.limitsState

-    private val requestsJob = scope.launch {
+    private val requestsJob = subscope.launch {
        for ((callback, requestBuilder) in requestsChannel) {
            quotaManager.getQuota()
            launch {
                try {
                    val answer = makeRequest(requestBuilder)
-                    callback.resume(answer)
+                    callback.complete(answer)

                    quotaManager.updateQuota(answer.header, timeManager)
                } catch (e: TooManyRequestsException) {
@@ -67,7 +69,7 @@ data class SauceNaoAPI(
                    requestsChannel.send(callback to requestBuilder)
                } catch (e: Exception) {
                    try {
-                        callback.resumeWithException(e)
+                        callback.completeExceptionally(e)
                    } catch (e: IllegalStateException) { // may happen when already resumed and api was closed
                        // do nothing
                    }
@@ -80,7 +82,7 @@ data class SauceNaoAPI(
        url: String,
        resultsCount: Int? = null,
        minSimilarity: Float? = null
-    ): SauceNaoAnswer? = makeRequest(
+    ): SauceNaoAnswer = makeRequest(
        url.asSauceRequestSubject,
        resultsCount = resultsCount,
        minSimilarity = minSimilarity
@@ -91,18 +93,29 @@ data class SauceNaoAPI(
        mimeType: ContentType,
        resultsCount: Int? = null,
        minSimilarity: Float? = null
-    ): SauceNaoAnswer? = makeRequest(
+    ): SauceNaoAnswer = makeRequest(
        mediaInput.asSauceRequestSubject(mimeType),
        resultsCount = resultsCount,
        minSimilarity = minSimilarity
    )

+    suspend fun request(
+        file: MPPFile,
+        resultsCount: Int? = null,
+        minSimilarity: Float? = null
+    ): SauceNaoAnswer = request(
+        file.input,
+        file.contentType,
+        resultsCount = resultsCount,
+        minSimilarity = minSimilarity
+    )
+
    suspend fun requestByDb(
        url: String,
        db: Int,
        resultsCount: Int? = null,
        minSimilarity: Float? = null
-    ): SauceNaoAnswer? = makeRequest(
+    ): SauceNaoAnswer = makeRequest(
        url.asSauceRequestSubject,
        db = db,
        resultsCount = resultsCount,
@@ -114,7 +127,7 @@ data class SauceNaoAPI(
        dbmask: Int,
        resultsCount: Int? = null,
        minSimilarity: Float? = null
-    ): SauceNaoAnswer? = makeRequest(
+    ): SauceNaoAnswer = makeRequest(
        url.asSauceRequestSubject,
        dbmask = dbmask,
        resultsCount = resultsCount,
@@ -126,7 +139,7 @@ data class SauceNaoAPI(
        dbmaski: Int,
        resultsCount: Int? = null,
        minSimilarity: Float? = null
-    ): SauceNaoAnswer? = makeRequest(
+    ): SauceNaoAnswer = makeRequest(
        url.asSauceRequestSubject,
        dbmaski = dbmaski,
        resultsCount = resultsCount,
@@ -137,8 +150,8 @@ data class SauceNaoAPI(
        builder: HttpRequestBuilder
    ): SauceNaoAnswer {
        return try {
-            val call = client.request<HttpResponse>(builder)
-            val answerText = call.readText()
+            val call = client.request(builder)
+            val answerText = call.bodyAsText()
            timeManager.addTimeAndClear()
            parser.decodeFromString(
                SauceNaoAnswerSerializer,
@@ -156,29 +169,32 @@ data class SauceNaoAPI(
        dbmaski: Int? = null,
        resultsCount: Int? = null,
        minSimilarity: Float? = null
-    ): SauceNaoAnswer? {
-        return suspendCoroutine<SauceNaoAnswer> {
-            requestsChannel.trySend(
-                it to HttpRequestBuilder().apply {
-                    url(searchUrl)
+    ): SauceNaoAnswer {
+        val deferred = CompletableDeferred<SauceNaoAnswer>()

-                    apiToken ?.also { parameter(API_TOKEN_FIELD, it) }
-                    parameter(OUTPUT_TYPE_FIELD, outputType.typeCode)
-                    db ?.also { parameter(DB_FIELD, it) }
-                    dbmask ?.also { parameter(DBMASK_FIELD, it) }
-                    dbmaski ?.also { parameter(DBMASKI_FIELD, it) }
-                    resultsCount ?.also { parameter(RESULTS_COUNT_FIELD, it) }
-                    minSimilarity ?.also { parameter(MINIMAL_SIMILARITY_FIELD, it) }
+        requestsChannel.trySend(
+            deferred to HttpRequestBuilder().apply {
+                url(searchUrl)

-                    when (request) {
-                        is UrlSauceRequestSubject -> {
-                            parameter(URL_FIELD, request.url)
-                        }
-                        is InputRequestSubject -> {
-                            val mimeType = request.mimeType
+                apiToken ?.also { parameter(API_TOKEN_FIELD, it) }
+                parameter(OUTPUT_TYPE_FIELD, JsonOutputType.typeCode)
+                db ?.also { parameter(DB_FIELD, it) }
+                dbmask ?.also { parameter(DBMASK_FIELD, it) }
+                dbmaski ?.also { parameter(DBMASKI_FIELD, it) }
+                resultsCount ?.also { parameter(RESULTS_COUNT_FIELD, it) }
+                minSimilarity ?.also { parameter(MINIMAL_SIMILARITY_FIELD, it) }

-                            method = HttpMethod.Post
-                            body = MultiPartFormDataContent(formData {
+                when (request) {
+                    is UrlSauceRequestSubject -> {
+                        parameter(URL_FIELD, request.url)
+                    }
+                    is InputRequestSubject -> {
+                        val mimeType = request.mimeType
+
+                        method = HttpMethod.Post
+                        setBody(
+                            MultiPartFormDataContent(
+                                formData {
                                    appendInput(
                                        FILE_FIELD,
                                        Headers.build {
@@ -197,19 +213,18 @@ data class SauceNaoAPI(
                                        },
                                        block = request::input
                                    )
-                            })
-                        }
+                                }
+                            )
+                        )
                    }
                }
-            )
-        }
+            }
+        )
+
+        return deferred.await()
    }

    override fun close() {
-        requestsChannel.close()
-        client.close()
-        requestsJob.cancel()
-        timeManager.close()
-        quotaManager.close()
+        subscope.cancel()
    }
 }
--- a/src/commonMain/kotlin/dev/inmo/saucenaoapi/exceptions/TooManyRequestsException.kt
+++ b/src/commonMain/kotlin/dev/inmo/saucenaoapi/exceptions/TooManyRequestsException.kt
@@ -3,15 +3,15 @@ package dev.inmo.saucenaoapi.exceptions
 import dev.inmo.saucenaoapi.additional.LONG_TIME_RECALCULATING_MILLIS
 import dev.inmo.saucenaoapi.additional.SHORT_TIME_RECALCULATING_MILLIS
 import com.soywiz.klock.TimeSpan
-import io.ktor.client.features.ClientRequestException
-import io.ktor.client.statement.readText
+import io.ktor.client.plugins.ClientRequestException
+import io.ktor.client.statement.bodyAsText
 import io.ktor.http.HttpStatusCode.Companion.TooManyRequests
 import io.ktor.utils.io.errors.IOException

 internal suspend fun ClientRequestException.sauceNaoAPIException(): Exception  {
    return when (response.status) {
        TooManyRequests -> {
-            val answerContent = response.readText()
+            val answerContent = response.bodyAsText()
            when {
                answerContent.contains("daily limit") -> TooManyRequestsLongException(answerContent)
                else -> TooManyRequestsShortException(answerContent)
--- a/src/commonMain/kotlin/dev/inmo/saucenaoapi/utils/MPPFile.kt
+++ b/src/commonMain/kotlin/dev/inmo/saucenaoapi/utils/MPPFile.kt
@@ -0,0 +1,9 @@
+package dev.inmo.saucenaoapi.utils
+
+import io.ktor.http.ContentType
+import io.ktor.utils.io.core.Input
+
+expect class MPPFile
+
+expect val MPPFile.input: Input
+expect val MPPFile.contentType: ContentType
--- a/src/commonMain/kotlin/dev/inmo/saucenaoapi/utils/RequestQuotaManager.kt
+++ b/src/commonMain/kotlin/dev/inmo/saucenaoapi/utils/RequestQuotaManager.kt
@@ -9,13 +9,12 @@ import dev.inmo.saucenaoapi.models.LimitsState
 import com.soywiz.klock.DateTime
 import kotlinx.coroutines.*
 import kotlinx.coroutines.channels.Channel
-import kotlin.coroutines.suspendCoroutine
 import kotlin.math.max
 import kotlin.math.min

 internal class RequestQuotaManager (
    scope: CoroutineScope
-) : SauceCloseable {
+) {
    private var longQuota = 1
    private var shortQuota = 1
    private var longMaxQuota = 1
@@ -35,6 +34,10 @@ internal class RequestQuotaManager (
        for (callback in quotaActions) {
            callback()
        }
+    }.also {
+        it.invokeOnCompletion {
+            quotaActions.close(it)
+        }
    }

    private suspend fun updateQuota(
@@ -83,21 +86,16 @@ internal class RequestQuotaManager (
    )

    suspend fun getQuota() {
-        return suspendCoroutine {
-            lateinit var callback: suspend () -> Unit
-            callback = suspend {
-                if (longQuota > 0 && shortQuota > 0) {
-                    it.resumeWith(Result.success(Unit))
-                } else {
-                    quotaActions.send(callback)
-                }
+        val job = Job()
+        lateinit var callback: suspend () -> Unit
+        callback = suspend {
+            if (longQuota > 0 && shortQuota > 0) {
+                job.complete()
+            } else {
+                quotaActions.send(callback)
            }
-            quotaActions.trySend(callback)
        }
-    }
-
-    override fun close() {
-        quotaJob.cancel()
-        quotaActions.close()
+        quotaActions.trySend(callback)
+        return job.join()
    }
 }
--- a/src/commonMain/kotlin/dev/inmo/saucenaoapi/utils/SauceCloseable.kt
+++ b/src/commonMain/kotlin/dev/inmo/saucenaoapi/utils/SauceCloseable.kt
@@ -6,12 +6,13 @@ interface SauceCloseable {
    fun close()
 }

-fun <T> SauceCloseable.use(block: (SauceCloseable) -> T): T = try {
+inline fun <T> SauceCloseable.use(block: (SauceCloseable) -> T): T = try {
    block(this)
 } finally {
    close()
 }

+@Deprecated("Useless")
 suspend fun <T> SauceCloseable.useSafe(block: suspend (SauceCloseable) -> T): T = try {
    supervisorScope {
        block(this@useSafe)
--- a/src/commonMain/kotlin/dev/inmo/saucenaoapi/utils/TimeManager.kt
+++ b/src/commonMain/kotlin/dev/inmo/saucenaoapi/utils/TimeManager.kt
@@ -3,11 +3,8 @@ package dev.inmo.saucenaoapi.utils
 import dev.inmo.saucenaoapi.additional.LONG_TIME_RECALCULATING_MILLIS
 import dev.inmo.saucenaoapi.additional.SHORT_TIME_RECALCULATING_MILLIS
 import com.soywiz.klock.DateTime
-import kotlinx.coroutines.CoroutineScope
+import kotlinx.coroutines.*
 import kotlinx.coroutines.channels.Channel
-import kotlinx.coroutines.launch
-import kotlin.coroutines.Continuation
-import kotlin.coroutines.suspendCoroutine

 private fun MutableList<DateTime>.clearTooOldTimes(relatedTo: DateTime = DateTime.now()) {
    val limitValue = relatedTo - LONG_TIME_RECALCULATING_MILLIS
@@ -38,16 +35,16 @@ private data class TimeManagerTimeAdder(
 }

 private data class TimeManagerMostOldestInLongGetter(
-    private val continuation: Continuation<DateTime?>
+    private val deferred: CompletableDeferred<DateTime?>
 ) : TimeManagerAction {
    override suspend fun makeChangeWith(times: MutableList<DateTime>) {
        times.clearTooOldTimes()
-        continuation.resumeWith(Result.success(times.minOrNull()))
+        deferred.complete(times.minOrNull())
    }
 }

 private data class TimeManagerMostOldestInShortGetter(
-    private val continuation: Continuation<DateTime?>
+    private val deferred: CompletableDeferred<DateTime?>
 ) : TimeManagerAction {
    override suspend fun makeChangeWith(times: MutableList<DateTime>) {
        times.clearTooOldTimes()
@@ -56,19 +53,17 @@ private data class TimeManagerMostOldestInShortGetter(

        val limitTime = now - SHORT_TIME_RECALCULATING_MILLIS

-        continuation.resumeWith(
-            Result.success(
-                times.asSequence().filter {
-                    limitTime < it
-                }.minOrNull()
-            )
+        deferred.complete(
+            times.asSequence().filter {
+                limitTime < it
+            }.minOrNull()
        )
    }
 }

 internal class TimeManager(
    scope: CoroutineScope
-) : SauceCloseable {
+) {
    private val actionsChannel = Channel<TimeManagerAction>(Channel.UNLIMITED)

    private val timeUpdateJob = scope.launch {
@@ -76,6 +71,10 @@ internal class TimeManager(
        for (action in actionsChannel) {
            action(times)
        }
+    }.also {
+        it.invokeOnCompletion {
+            actionsChannel.close(it)
+        }
    }

    suspend fun addTimeAndClear() {
@@ -83,21 +82,20 @@ internal class TimeManager(
    }

    suspend fun getMostOldestInLongPeriod(): DateTime? {
-        return suspendCoroutine {
-            actionsChannel.trySend(
-                TimeManagerMostOldestInLongGetter(it)
-            )
+        val deferred = CompletableDeferred<DateTime?>()
+        return if (actionsChannel.trySend(TimeManagerMostOldestInLongGetter(deferred)).isSuccess) {
+            deferred.await()
+        } else {
+            null
        }
    }

    suspend fun getMostOldestInShortPeriod(): DateTime? {
-        return suspendCoroutine {
-            actionsChannel.trySend(TimeManagerMostOldestInShortGetter(it))
+        val deferred = CompletableDeferred<DateTime?>()
+        return if (actionsChannel.trySend(TimeManagerMostOldestInShortGetter(deferred)).isSuccess) {
+            deferred.await()
+        } else {
+            null
        }
    }
-
-    override fun close() {
-        actionsChannel.close()
-        timeUpdateJob.cancel()
-    }
 }
--- a/src/jsMain/kotlin/dev/inmo/saucenaoapi/utils/ActualMPPFile.kt
+++ b/src/jsMain/kotlin/dev/inmo/saucenaoapi/utils/ActualMPPFile.kt
@@ -0,0 +1,18 @@
+package dev.inmo.saucenaoapi.utils
+
+import io.ktor.http.ContentType
+import io.ktor.utils.io.core.ByteReadPacket
+import io.ktor.utils.io.core.Input
+import org.khronos.webgl.Int8Array
+import org.w3c.files.File
+import org.w3c.files.FileReaderSync
+
+actual typealias MPPFile = File
+
+actual val MPPFile.input: Input
+    get() {
+        val reader = FileReaderSync()
+        return ByteReadPacket(Int8Array(reader.readAsArrayBuffer(this)) as ByteArray)
+    }
+actual val MPPFile.contentType: ContentType
+    get() = ContentType.parse(type)
--- a/src/jvmMain/kotlin/dev/inmo/saucenaoapi/utils/ActualMPPFile.kt
+++ b/src/jvmMain/kotlin/dev/inmo/saucenaoapi/utils/ActualMPPFile.kt
@@ -0,0 +1,14 @@
+package dev.inmo.saucenaoapi.utils
+
+import io.ktor.http.ContentType
+import io.ktor.utils.io.core.Input
+import io.ktor.utils.io.streams.asInput
+import java.io.File
+import java.nio.file.Files
+
+actual typealias MPPFile = File
+
+actual val MPPFile.input: Input
+    get() = inputStream().asInput()
+actual val MPPFile.contentType: ContentType
+    get() = ContentType.parse(Files.probeContentType(toPath()))
--- a/src/jvmTest/kotlin/Launcher.kt
+++ b/src/jvmTest/kotlin/Launcher.kt
@@ -1,30 +1,27 @@
 import dev.inmo.saucenaoapi.SauceNaoAPI
-import dev.inmo.saucenaoapi.utils.useSafe
-import io.ktor.http.ContentType
-import io.ktor.utils.io.streams.asInput
+import io.ktor.client.HttpClient
 import kotlinx.coroutines.*
 import java.io.File
-import java.nio.file.Files

 suspend fun main(vararg args: String) {
    val (key, requestSubject) = args

-    val scope = CoroutineScope(Dispatchers.Default)
-
-    val api = SauceNaoAPI(key, scope = scope)
-    api.useSafe { _ ->
-        println(
-            when {
-                requestSubject.startsWith("/") -> File(requestSubject).let {
-                    api.request(
-                        it.inputStream().asInput(),
-                        ContentType.parse(Files.probeContentType(it.toPath()))
-                    )
-                }
-                else -> api.request(requestSubject)
-            }
-        )
+    val client = HttpClient()
+    val scope = CoroutineScope(Dispatchers.IO).also {
+        it.coroutineContext.job.invokeOnCompletion {
+            client.close()
+        }
    }

+    val api = SauceNaoAPI(key, client,  scope = scope)
+    println(
+        when {
+            requestSubject.startsWith("/") -> File(requestSubject).let {
+                api.request(it)
+            }
+            else -> api.request(requestSubject)
+        }
+    )
+
    scope.cancel()
 }