build(action): 移除 gradle/actions/wrapper-validation 并将 gradle/actions/setup-gradle 升级至 v4 版本.

为 BotExtensionFactory 的 createExtensionInstance 方法添加 BotExtensionCreateOptions 参数,
通过 BotExtensionCreateOptions 为扩展包 Factory 提供更多信息, 以避免扩展重复声明配置文件.

Issue #4

.github/workflows/binary-compatibility-verification.yml

@@ -25,12 +25,9 @@ jobs:
         with:
           java-version: '11'
           distribution: 'adopt-hotspot'
-          cache: 'gradle'
-      - uses: gradle/wrapper-validation-action@v1
+      - name: Set up Gradle
+        uses: gradle/actions/setup-gradle@v4
       - name: Grant execute permission for gradlew
         run: chmod +x gradlew
       - name: Build and run binary compatibility verification
-        uses: gradle/gradle-build-action@v2.11.0
-        with:
-          gradle-version: 'wrapper'
-          arguments: apiCheck
+        run: ./gradlew apiCheck

.github/workflows/build-and-test.yml

@@ -24,12 +24,9 @@ jobs:
         with:
           java-version: '11'
           distribution: 'adopt-hotspot'
-          cache: 'gradle'
-      - uses: gradle/wrapper-validation-action@v1
+      - name: Set up Gradle
+        uses: gradle/actions/setup-gradle@v4
       - name: Grant execute permission for gradlew
         run: chmod +x gradlew
       - name: Build and test
-        uses: gradle/gradle-build-action@v2.11.0
-        with:
-          gradle-version: 'wrapper'
-          arguments: test
+        run: ./gradlew clean test

.github/workflows/create-release.yml

@@ -44,22 +44,20 @@ jobs:
         with:
           java-version: '11'
           distribution: 'adopt-hotspot'
-          cache: 'gradle'
-      - uses: gradle/wrapper-validation-action@v1
+      - name: Set up Gradle
+        uses: gradle/actions/setup-gradle@v4
       - name: Grant execute permission for gradlew
         run: chmod +x gradlew
       - name: Build and test
-        uses: gradle/gradle-build-action@v2.11.0
-        with:
-          gradle-version: 'wrapper'
-          arguments: clean test assembleDist
+        uses: gradle/gradle-build-action@v3.1.0
+        run: ./gradlew clean test assembleDist
 
       # 创建新的发行版本
       - name: Create Release
-        uses: softprops/action-gh-release@v1
+        uses: softprops/action-gh-release@v2
         with:
           draft: true
           body_path: ${{ github.workspace }}/CURRENT_CHANGELOG.md
           files: |
             */build/distributions/*
-            */build/libs/*
+            */build/libs/*

.github/workflows/publish-artifacts.yml

@@ -20,15 +20,12 @@ jobs:
         with:
           java-version: '11'
           distribution: 'adopt-hotspot'
-          cache: 'gradle'
-      - uses: gradle/wrapper-validation-action@v1
+      - name: Set up Gradle
+        uses: gradle/actions/setup-gradle@v4
       - name: Grant execute permission for gradlew
         run: chmod +x gradlew
       - name: Build and test
-        uses: gradle/gradle-build-action@v2.11.0
-        with:
-          gradle-version: 'wrapper'
-          arguments: clean test installDist
+        run: ./gradlew clean test installDist
       - name: Set up QEMU
         uses: docker/setup-qemu-action@v3
       - name: Set up Docker BuildX
@@ -46,4 +43,4 @@ jobs:
           tags: ${{ env.IMAGE_NAME }}:latest, ${{ env.IMAGE_NAME }}:${{ github.ref_name }}
           platforms: linux/amd64,linux/arm64
           cache-from: type=gha
-          cache-to: type=gha,mode=max
+          cache-to: type=gha,mode=max

.github/workflows/release-dev-container-image.yml

@@ -20,15 +20,12 @@ jobs:
         with:
           java-version: '11'
           distribution: 'adopt-hotspot'
-          cache: 'gradle'
-      - uses: gradle/wrapper-validation-action@v1
+      - name: Set up Gradle
+        uses: gradle/actions/setup-gradle@v4
       - name: Grant execute permission for gradlew
         run: chmod +x gradlew
       - name: Build project and install Distribution package
-        uses: gradle/gradle-build-action@v2.11.0
-        with:
-          gradle-version: 'wrapper'
-          arguments: installDist
+        run: ./gradlew clean test installDist
       - name: Set up QEMU
         uses: docker/setup-qemu-action@v3
       - name: Set up Docker BuildX
@@ -46,4 +43,4 @@ jobs:
           tags: lamgc/scalabot:dev
           platforms: linux/amd64,linux/arm64
           cache-from: type=gha
-          cache-to: type=gha,mode=max
+          cache-to: type=gha,mode=max

Dockerfile

@@ -1,4 +1,4 @@
-FROM openjdk:18
+FROM eclipse-temurin:21-jdk-alpine
 
 ENV BOT_DATA_PATH /scalabot/data/
 WORKDIR /scalabot/run/

build.gradle.kts

@@ -1,7 +1,7 @@
 plugins {
-    kotlin("jvm") version "1.9.10" apply false
-    id("org.jetbrains.kotlinx.kover") version "0.7.4" apply false
-    id("org.jetbrains.kotlinx.binary-compatibility-validator") version "0.13.2" apply false
+    kotlin("jvm") version "1.9.23" apply false
+    id("org.jetbrains.kotlinx.kover") version "0.7.5" apply false
+    id("org.jetbrains.kotlinx.binary-compatibility-validator") version "0.14.0" apply false
 }
 
 allprojects {
@@ -13,5 +13,5 @@ allprojects {
 
     }
     group = "net.lamgc"
-    version = "0.6.1"
-}
+    version = "0.7.0"
+}

scalabot-app/build.gradle.kts

@@ -10,9 +10,9 @@ dependencies {
     implementation(project(":scalabot-meta"))
     implementation(project(":scalabot-extension"))
 
-    implementation("org.slf4j:slf4j-api:2.0.9")
+    implementation("org.slf4j:slf4j-api:2.0.11")
     implementation("io.github.microutils:kotlin-logging:3.0.5")
-    implementation("ch.qos.logback:logback-classic:1.4.11")
+    implementation("ch.qos.logback:logback-classic:1.4.14")
 
     val aetherVersion = "1.1.0"
     implementation("org.eclipse.aether:aether-api:$aetherVersion")
@@ -24,19 +24,19 @@ dependencies {
     implementation("org.apache.maven:maven-aether-provider:3.3.9")
 
     implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core:1.7.3")
-    implementation("org.jetbrains.kotlin:kotlin-reflect:1.9.21")
+    implementation("org.jetbrains.kotlin:kotlin-reflect:1.9.23")
     implementation("com.google.code.gson:gson:2.10.1")
 
     implementation("org.jdom:jdom2:2.0.6.1")
 
-    implementation("org.telegram:telegrambots-abilities:6.8.0")
-    implementation("org.telegram:telegrambots:6.8.0")
+    implementation("org.telegram:telegrambots-abilities:6.9.7.1")
+    implementation("org.telegram:telegrambots:6.9.7.1")
 
     implementation("io.prometheus:simpleclient:0.16.0")
     implementation("io.prometheus:simpleclient_httpserver:0.16.0")
 
     testImplementation(kotlin("test"))
-    testImplementation("io.mockk:mockk:1.13.8")
+    testImplementation("io.mockk:mockk:1.13.9")
     testImplementation("com.github.stefanbirkner:system-lambda:1.2.1")
 }
 

scalabot-app/src/main/kotlin/AppMain.kt

@@ -9,6 +9,8 @@ import net.lamgc.scalabot.util.registerShutdownHook
 import org.eclipse.aether.repository.LocalRepository
 import org.telegram.telegrambots.bots.DefaultBotOptions
 import org.telegram.telegrambots.meta.TelegramBotsApi
+import org.telegram.telegrambots.meta.api.methods.GetMe
+import org.telegram.telegrambots.meta.exceptions.TelegramApiRequestException
 import org.telegram.telegrambots.meta.generics.BotSession
 import org.telegram.telegrambots.updatesreceivers.DefaultBotSession
 import java.io.File
@@ -135,7 +137,11 @@ internal class Launcher(
                 launchBot(botConfig)
                 launchedCounts++
             } catch (e: Exception) {
-                log.error(e) { "机器人 `${botConfig.account.name}` 启动时发生错误." }
+                if (e is TelegramApiRequestException && e.errorCode == 401) {
+                    log.error { "机器人 `${botConfig.account.name}` 的 Bot Token 无效, 请检查配置: [${e.errorCode}] ${e.apiResponse}" }
+                } else {
+                    log.error(e) { "机器人 `${botConfig.account.name}` 启动时发生错误." }
+                }
             }
         }
         return if (launchedCounts != 0) {
@@ -201,6 +207,10 @@ internal class Launcher(
             extensionPackageFinders,
             botConfig
         )
+
+        val botUser = bot.execute(GetMe())
+        log.debug { "已验证 Bot Token 有效性, Bot Username: ${botUser.userName}" }
+
         botSessionMap[bot] = botApi.registerBot(bot)
         log.info { "机器人 `${bot.botUsername}` 已启动." }
 

scalabot-app/src/main/kotlin/ExtensionComponents.kt

@@ -1,6 +1,7 @@
 package net.lamgc.scalabot
 
 import mu.KotlinLogging
+import net.lamgc.scalabot.extension.BotExtensionCreateOptions
 import net.lamgc.scalabot.extension.BotExtensionFactory
 import net.lamgc.scalabot.util.getPriority
 import org.eclipse.aether.artifact.Artifact
@@ -122,7 +123,12 @@ internal class ExtensionLoader(
         for (factory in extClassLoader.serviceLoader) {
             try {
                 val extension =
-                    factory.createExtensionInstance(bot, getExtensionDataFolder(extensionArtifact))
+                    factory.createExtensionInstance(
+                        bot, getExtensionDataFolder(extensionArtifact),
+                        BotExtensionCreateOptions(
+                            bot.botConfig.proxy.copy()
+                        )
+                    )
                 if (extension == null) {
                     log.debug { "Factory ${factory::class.java} 创建插件时返回了 null, 已跳过. (BotName: ${bot.botUsername})" }
                     continue

scalabot-app/src/main/kotlin/ScalaBot.kt

@@ -29,7 +29,7 @@ internal class ScalaBot(
     db: DBContext,
     options: DefaultBotOptions,
     extensionFinders: Set<ExtensionPackageFinder>,
-    botConfig: BotConfig,
+    val botConfig: BotConfig,
     private val creatorId: Long = botConfig.account.creatorId,
     val accountId: Long = botConfig.account.id,
     val extensions: Set<Artifact> = botConfig.extensions

scalabot-ext-example/build.gradle.kts

@@ -5,7 +5,7 @@ plugins {
 dependencies {
     compileOnly(project(":scalabot-extension"))
 
-    testImplementation("org.junit.jupiter:junit-jupiter-api:5.10.0")
+    testImplementation("org.junit.jupiter:junit-jupiter-api:5.10.1")
     testRuntimeOnly("org.junit.jupiter:junit-jupiter-engine")
 }
 

scalabot-ext-example/src/main/java/net/lamgc/scalabot/simple/SimpleExtensionFactory.java

@@ -1,5 +1,6 @@
 package net.lamgc.scalabot.simple;
 
+import net.lamgc.scalabot.extension.BotExtensionCreateOptions;
 import net.lamgc.scalabot.extension.BotExtensionFactory;
 import org.telegram.abilitybots.api.bot.BaseAbilityBot;
 import org.telegram.abilitybots.api.util.AbilityExtension;
@@ -9,7 +10,7 @@ import java.io.File;
 public class SimpleExtensionFactory implements BotExtensionFactory {
 
     @Override
-    public AbilityExtension createExtensionInstance(BaseAbilityBot bot, File shareDataFolder) {
+    public AbilityExtension createExtensionInstance(BaseAbilityBot bot, File shareDataFolder, BotExtensionCreateOptions options) {
         return new SayHelloExtension(bot);
     }
 

scalabot-extension/build.gradle.kts

@@ -7,11 +7,12 @@ plugins {
 }
 
 dependencies {
-    implementation("commons-codec:commons-codec:1.16.0")
-    api("org.telegram:telegrambots-abilities:6.8.0")
+    implementation("commons-codec:commons-codec:1.16.1")
+    api("org.telegram:telegrambots-abilities:6.9.7.1")
+    api(project(":scalabot-meta"))
 
-    testImplementation("org.junit.jupiter:junit-jupiter-api:5.10.0")
-    testImplementation("org.mockito:mockito-core:5.8.0")
+    testImplementation("org.junit.jupiter:junit-jupiter-api:5.10.1")
+    testImplementation("org.mockito:mockito-core:5.11.0")
     testRuntimeOnly("org.junit.jupiter:junit-jupiter-engine")
 }
 

scalabot-extension/src/main/java/net/lamgc/scalabot/extension/BotExtensionCreateOptions.java

@@ -0,0 +1,22 @@
+package net.lamgc.scalabot.extension;
+
+import net.lamgc.scalabot.config.ProxyConfig;
+
+/**
+ * BotExtension 创建参数.
+ * <p>
+ * 通过该类可向 {@link BotExtensionFactory} 提供更多创建 BotExtension 时可用的参数.
+ */
+@SuppressWarnings("unused")
+public class BotExtensionCreateOptions {
+
+    private final ProxyConfig proxy;
+
+    public BotExtensionCreateOptions(ProxyConfig proxy) {
+        this.proxy = proxy;
+    }
+
+    public ProxyConfig getProxy() {
+        return proxy;
+    }
+}

scalabot-extension/src/main/java/net/lamgc/scalabot/extension/BotExtensionFactory.java

@@ -31,7 +31,34 @@ public interface BotExtensionFactory {
      *                        <b>同一个扩展包的 Factory</b> 接收到的共享数据目录<b>都是一样的</b>,
      *                        建议将数据存储在数据目录中, 便于数据的存储管理.
      * @return 返回为该 Bot 对象创建的扩展对象, 如果不希望为该机器人提供扩展, 可返回 {@code null}.
+     * @deprecated 请使用 {@link #createExtensionInstance(BaseAbilityBot, File, BotExtensionCreateOptions)},
+     *             该方法最迟在 1.0.0 正式版中移除.
+     * @since 0.0.1
      */
-    AbilityExtension createExtensionInstance(BaseAbilityBot bot, File shareDataFolder);
+    @Deprecated(since = "0.7.0", forRemoval = true)
+    default AbilityExtension createExtensionInstance(BaseAbilityBot bot, File shareDataFolder) {
+        throw new UnsupportedOperationException("The method has not been implemented.");
+    }
+
+    /**
+     * 为给定的 {@link BaseAbilityBot} 对象创建扩展.
+     *
+     * <p> 如扩展无使用 {@link org.telegram.abilitybots.api.db.DBContext} 的话,
+     * 也可以返回扩展单例, 因为 AbilityBot 本身并不禁止多个机器人共用一个扩展对象
+     * (AbilityBot 只是调用了扩展中的方法来创建 Ability 对象).
+     *
+     * @param bot             机器人对象.
+     * @param shareDataFolder ScalaBot App 为扩展提供的共享数据目录.
+     *                        <p>路径格式为:
+     *                        <pre> $DATA_ROOT/data/extensions/{GroupId}/{ArtifactId}</pre>
+     *                        <b>同一个扩展包的 Factory</b> 接收到的共享数据目录<b>都是一样的</b>,
+     *                        建议将数据存储在数据目录中, 便于数据的存储管理.
+     * @param options         创建扩展时可用的参数.
+     * @return 返回为该 Bot 对象创建的扩展对象, 如果不希望为该机器人提供扩展, 可返回 {@code null}.
+     * @since 0.7.0
+     */
+    default AbilityExtension createExtensionInstance(BaseAbilityBot bot, File shareDataFolder, BotExtensionCreateOptions options) {
+        return createExtensionInstance(bot, shareDataFolder);
+    }
 
 }

scalabot-meta/build.gradle.kts

@@ -12,13 +12,13 @@ dependencies {
     api("org.eclipse.aether:aether-api:$aetherVersion")
     implementation("org.eclipse.aether:aether-util:$aetherVersion")
 
-    implementation("org.telegram:telegrambots-meta:6.8.0")
+    implementation("org.telegram:telegrambots-meta:6.9.7.1")
 
     api("com.google.code.gson:gson:2.10.1")
 
     testImplementation(kotlin("test"))
-    testImplementation("io.mockk:mockk:1.13.8")
-    testImplementation("org.junit.jupiter:junit-jupiter-api:5.10.0")
+    testImplementation("io.mockk:mockk:1.13.9")
+    testImplementation("org.junit.jupiter:junit-jupiter-api:5.10.1")
     testRuntimeOnly("org.junit.jupiter:junit-jupiter-engine:5.10.1")
 
     dokkaHtmlPlugin("org.jetbrains.dokka:javadoc-plugin:1.9.10")