Merge pull request #215 from simple-robot/dev/main

Release: v1.8.1

Author: ForteScarlet

buildSrc/src/main/kotlin/P.kt

@@ -37,8 +37,8 @@ object P {
         override val description: String get() = DESCRIPTION
         override val homepage: String get() = HOMEPAGE
 
-        const val VERSION = "1.8.0"
-        const val NEXT_VERSION = "1.8.1"
+        const val VERSION = "1.8.1"
+        const val NEXT_VERSION = "1.8.2"
 
         override val snapshotVersion = "$NEXT_VERSION-SNAPSHOT"
         override val version = if (isSnapshot()) snapshotVersion else VERSION

settings.gradle.kts

@@ -23,7 +23,7 @@ pluginManagement {
 }
 
 plugins {
-    id("org.gradle.toolchains.foojay-resolver-convention") version "0.10.0"
+    id("org.gradle.toolchains.foojay-resolver-convention") version "1.0.0"
 }
 
 rootProject.name = "simbot-component-onebot"

simbot-component-onebot-v11/simbot-component-onebot-v11-core/src/commonMain/kotlin/love/forte/simbot/component/onebot/v11/core/bot/OneBotBot.kt

@@ -72,15 +72,85 @@ public interface OneBotBot : Bot, OneBotApiExecutable {
     override val coroutineContext: CoroutineContext
 
     /**
-     * [OneBotBot] 会使用的 [Json]
+     * [OneBotBot] 会使用的 [Json]。
+     * 需要在
      */
     public val decoderJson: Json
 
     /**
      * 当前Bot的配置类。
+     *
+     * 配置信息在 [initConfiguration] 或 [start] 调用后的修改无效。
      */
     public val configuration: OneBotBotConfiguration
 
+    /**
+     * 根据 [configuration] 初始化部分配置信息。
+     *
+     * 在一些特殊情况下(例如测试或仅需要一些序列器等)，
+     * 如果希望在不 [启动][start] bot 就初始化配置信息则使用此函数。
+     *
+     * 初始化配置只能执行一次。如果 [isConfigurationInitialized] 为 `true` 则会返回 `false`。
+     * 同一时间只会有一个 [initConfiguration] 被执行。如果出现竞争则会挂起，
+     * 直到其他竞争者完成初始化或出现异常。
+     * 如果其他竞争者完成初始化，则会直接返回 `false`，不会重复初始化。
+     *
+     * [start] 中也会使用此函数。
+     *
+     * NOTE: 未来标准库 [Bot] 中添加了 `init` 相关函数和属性后会被废弃。
+     * 参考 [#1071](https://github.com/simple-robot/simpler-robot/issues/1071)
+     *
+     * ### status
+     *
+     * 初始化状态有三个阶段：未初始化、正在初始化和完成初始化。
+     * 根据三个状态的不同，会影响 [isConfigurationInitialized]
+     * 和 [isConfigurationInitializing] 的值。
+     *
+     * | status | [isConfigurationInitializing] | [isConfigurationInitialized] |
+     * | --- | --- | --- |
+     * | 未初始化 | `false` | `false` |
+     * | 初始化中 | `true` | `false` |
+     * | 已初始化 | `false` | `true` |
+     *
+     * @throws RuntimeException 初始化过程中出现的任何非预期异常。
+     * @return 如果已经初始化过了，则不会重复初始化，直接返回 `false`。
+     * 否则在成功初始化后返回 `true`。
+     *
+     * @since 1.8.1
+     */
+    @ExperimentalOneBotAPI
+    public suspend fun initConfiguration(): Boolean
+
+    /**
+     * 获取是否已经执行过 [initConfiguration]。
+     * 如果 [initConfiguration] 尚在执行，会返回 `false`,
+     * 如果 [initConfiguration] 已经成功，会得到 `true`。
+     *
+     * NOTE: 未来标准库 [Bot] 中添加了 `init` 相关函数和属性后会被废弃。
+     * 参考 [#1071](https://github.com/simple-robot/simpler-robot/issues/1071)
+     *
+     * @see initConfiguration
+     *
+     * @since 1.8.1
+     */
+    @ExperimentalOneBotAPI
+    public val isConfigurationInitialized: Boolean
+
+    /**
+     * 获取 [initConfiguration] 是否正在处于初始化过程中。
+     * 如果 [initConfiguration] 已经成功或尚未开始，会得到 `false`，
+     * 如果 [initConfiguration] 尚在执行，会返回 `true`。
+     *
+     * NOTE: 未来标准库 [Bot] 中添加了 `init` 相关函数和属性后会被废弃。
+     * 参考 [#1071](https://github.com/simple-robot/simpler-robot/issues/1071)
+     *
+     * @see initConfiguration
+     *
+     * @since 1.8.1
+     */
+    @ExperimentalOneBotAPI
+    public val isConfigurationInitializing: Boolean
+
     /**
      * 由 [OneBotBot] 衍生出的 actor 使用的 [CoroutineContext]。
      * 源自 [coroutineContext], 但是不包含 [Job][kotlinx.coroutines.Job]。

simbot-component-onebot-v11/simbot-component-onebot-v11-core/src/commonMain/kotlin/love/forte/simbot/component/onebot/v11/core/bot/internal/OneBotBotImpl.kt

@@ -36,6 +36,7 @@ import kotlinx.serialization.json.long
 import kotlinx.serialization.modules.overwriteWith
 import love.forte.simbot.annotations.FragileSimbotAPI
 import love.forte.simbot.bot.JobBasedBot
+import love.forte.simbot.common.atomic.atomic
 import love.forte.simbot.common.collectable.Collectable
 import love.forte.simbot.common.collectable.flowCollectable
 import love.forte.simbot.common.coroutines.IOOrDefault
@@ -86,6 +87,8 @@ import love.forte.simbot.logger.isDebugEnabled
 import kotlin.concurrent.Volatile
 import kotlin.coroutines.CoroutineContext
 import kotlin.math.max
+import kotlin.properties.Delegates
+import kotlin.time.Duration
 import kotlin.time.Duration.Companion.milliseconds
 import kotlin.time.Duration.Companion.seconds
 import love.forte.simbot.component.onebot.v11.event.RawEvent as OBRawEvent
@@ -102,46 +105,107 @@ internal class OneBotBotImpl(
     override val configuration: OneBotBotConfiguration,
     override val component: OneBot11Component,
     private val eventProcessor: EventProcessor,
-    baseDecoderJson: Json,
+    private val baseDecoderJson: Json,
 ) : OneBotBot, JobBasedBot() {
     companion object {
         private const val BASE_LOGGER_NAME =
             "love.forte.simbot.component.onebot.v11.core.bot.OneBotBot"
     }
 
     override val subContext = coroutineContext.minusKey(Job)
-    override val decoderJson: Json = Json(baseDecoderJson) {
-        configuration.serializersModule?.also { confMd ->
-            serializersModule = serializersModule overwriteWith confMd
-        }
-    }
 
     internal val logger = LoggerFactory.getLogger("$BASE_LOGGER_NAME.$uniqueId")
 
-    private val eventServerHost = configuration.eventServerHost
-    private val connectMaxRetryTimes = configuration.wsConnectMaxRetryTimes
-    private val connectRetryDelay = max(configuration.wsConnectRetryDelayMillis, 0L).milliseconds
+    override lateinit var decoderJson: Json
+        private set
+
+    private var eventServerHost: Url? = null
+    private var connectMaxRetryTimes by Delegates.notNull<Int>()
+    private var connectRetryDelay by Delegates.notNull<Duration>()
+
+    override lateinit var apiHost: Url
+    override var apiAccessToken: String? = null
+    override var eventAccessToken: String? = null
 
-    override val apiClient: HttpClient
-    private val wsClient: HttpClient?
+
+    override lateinit var apiClient: HttpClient
+        private set
+
+    private var wsClient: HttpClient? = null
 
     @ExperimentalCustomEventResolverApi
-    internal val customEventResolvers = configuration.customEventResolvers.toList()
+    internal lateinit var customEventResolvers: List<CustomEventResolver>
 
-    init {
-        apiClient = resolveHttpClient()
-        wsClient = if (eventServerHost != null) {
+    private val initLock = Mutex()
+    private val initialized = atomic(false)
+
+    override suspend fun initConfiguration(): Boolean {
+        if (initialized.value) {
+            return false
+        }
+
+        initLock.withLock {
+            if (initialized.value) {
+                return false
+            }
+
+            initDecoderJson()
+            initHostAndConnectAndToken()
+            initClients()
+            initJobCompletion()
+            initCustomEventResolvers()
+
+            initialized.value = true
+        }
+
+        return true
+    }
+
+    override val isConfigurationInitialized: Boolean
+        get() = initialized.value
+
+    override val isConfigurationInitializing: Boolean
+        get() = !isConfigurationInitialized && initLock.isLocked
+
+    private fun initDecoderJson() {
+        decoderJson = Json(baseDecoderJson) {
+            configuration.serializersModule?.also { confMd ->
+                serializersModule = serializersModule overwriteWith confMd
+            }
+        }
+    }
+
+    private fun initHostAndConnectAndToken() {
+        this.eventServerHost = configuration.eventServerHost
+        this.connectMaxRetryTimes = configuration.wsConnectMaxRetryTimes
+        this.connectRetryDelay = max(configuration.wsConnectRetryDelayMillis, 0L).milliseconds
+        this.apiHost = configuration.apiServerHost
+        this.apiAccessToken = configuration.apiAccessToken
+        this.eventAccessToken = configuration.eventAccessToken
+
+    }
+
+    private fun initClients() {
+        this.apiClient = resolveHttpClient()
+        this.wsClient = if (eventServerHost != null) {
             resolveWsClient()
         } else {
             null
         }
+    }
 
+    private fun initJobCompletion() {
         job.invokeOnCompletion {
             apiClient.close()
             wsClient?.close()
         }
     }
 
+    @OptIn(ExperimentalCustomEventResolverApi::class)
+    private fun initCustomEventResolvers() {
+        this.customEventResolvers = configuration.customEventResolvers.toList()
+    }
+
     private val wsEnabled: Boolean
         get() = wsClient != null
 
@@ -214,10 +278,6 @@ internal class OneBotBotImpl(
         }
     }
 
-    override val apiHost: Url = configuration.apiServerHost
-
-    override val apiAccessToken: String? = configuration.apiAccessToken
-    override val eventAccessToken: String? = configuration.eventAccessToken
 
     override val id: ID = uniqueId.ID
 
@@ -260,6 +320,7 @@ internal class OneBotBotImpl(
 
     override suspend fun start(): Unit = startLock.withLock {
         job.ensureActive()
+        initConfiguration()
 
         // 更新个人信息
         val info = queryLoginInfo()
@@ -580,7 +641,7 @@ internal class OneBotBotImpl(
         override suspend fun member(groupId: ID, memberId: ID): OneBotMember {
             // TODO 如何检测不存在？
             return this@OneBotBotImpl.executeData(
-                GetGroupMemberInfoApi.create(groupId, userId)
+                GetGroupMemberInfoApi.create(groupId, memberId)
             ).toMember(this@OneBotBotImpl)
         }
     }

simbot-component-onebot-v11/simbot-component-onebot-v11-core/src/commonTest/kotlin/love/forte/simbot/component/onebot/v11/core/bot/BotDecoderFromCustomComponentTests.kt

@@ -60,7 +60,7 @@ class BotDecoderFromCustomComponentTests {
         assertEquals("test", testSeg.data!!.jsonPrimitive.content)
     }
 
-    private fun doTest(app: Application): OneBotMessageSegment {
+    private suspend fun doTest(app: Application): OneBotMessageSegment {
         app.oneBot11Bots {
             val bot = register(
                 OneBotBotConfiguration().apply {
@@ -73,6 +73,7 @@ class BotDecoderFromCustomComponentTests {
                     }
                 }
             )
+            bot.initConfiguration()
 
             val segments = doSerial(bot)
             assertEquals(3, segments.size)

simbot-component-onebot-v11/simbot-component-onebot-v11-core/src/commonTest/kotlin/love/forte/simbot/component/onebot/v11/core/bot/BotInitializationTests.kt

@@ -0,0 +1,70 @@
+package love.forte.simbot.component.onebot.v11.core.bot
+
+import kotlinx.coroutines.SupervisorJob
+import kotlinx.coroutines.flow.Flow
+import kotlinx.coroutines.test.runTest
+import love.forte.simbot.component.onebot.v11.core.OneBot11
+import love.forte.simbot.component.onebot.v11.core.bot.internal.OneBotBotImpl
+import love.forte.simbot.component.onebot.v11.core.component.OneBot11Component
+import love.forte.simbot.event.Event
+import love.forte.simbot.event.EventProcessor
+import love.forte.simbot.event.EventResult
+import kotlin.coroutines.EmptyCoroutineContext
+import kotlin.test.Test
+import kotlin.test.assertFalse
+import kotlin.test.assertTrue
+
+/**
+ *
+ * @author ForteScarlet
+ */
+class BotInitializationTests {
+    private fun bot() = OneBotBotImpl(
+        uniqueId = "UNIQUE_ID",
+        coroutineContext = EmptyCoroutineContext,
+        job = SupervisorJob(),
+        configuration = OneBotBotConfiguration(),
+        component = OneBot11Component(),
+        eventProcessor = object : EventProcessor {
+            override fun push(event: Event): Flow<EventResult> {
+                TODO("Not yet implemented")
+            }
+        },
+        baseDecoderJson = OneBot11.DefaultJson
+    )
+
+    @Test
+    fun testBotInit() = runTest {
+        val bot = bot()
+
+        assertFalse(bot.isConfigurationInitialized)
+        assertFalse(bot.isConfigurationInitializing)
+
+        assertTrue(bot.initConfiguration())
+        assertTrue(bot.isConfigurationInitialized)
+        assertFalse(bot.initConfiguration())
+
+        assertTrue(bot.isConfigurationInitialized)
+        bot.cancel()
+    }
+
+    @Test
+    fun testBotStartInit() = runTest {
+        val bot = bot()
+
+        assertFalse(bot.isConfigurationInitialized)
+        assertFalse(bot.isConfigurationInitializing)
+
+        runCatching { bot.start() }
+
+        assertTrue(bot.isConfigurationInitialized)
+        assertFalse(bot.initConfiguration())
+
+        assertTrue(bot.isConfigurationInitialized)
+
+        bot.cancel()
+    }
+
+
+
+}

simbot-component-onebot-v11/simbot-component-onebot-v11-core/src/commonTest/kotlin/love/forte/simbot/component/onebot/v11/core/event/CustomEventResolverTests.kt

@@ -73,6 +73,8 @@ class CustomEventResolverTests {
             return register {
                 botUniqueId = UUID.random().toString()
                 config()
+            }.also {
+                it.initConfiguration()
             }
         }
     }