github-repos/mirai
1
0
Fork 0
mirror of https://github.com/mamoe/mirai.git synced 2025-02-03 14:12:25 +08:00
Code Issues Packages Projects Releases Wiki Activity

Handle exceptions in heartbeat jobs properly, #1893

Browse Source
This commit is contained in:
Him188 2022-04-24 12:14:20 +01:00
parent f5f7b3736c
commit 88e1146edc
1 changed files with 33 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
mirai-core/src/commonMain/kotlin/network/components/HeartbeatScheduler.kt
View File

@ -1,10 +1,10 @@
/*
* Copyright 2019-2021 Mamoe Technologies and contributors.
* Copyright 2019-2022 Mamoe Technologies and contributors.
*
* 此源代码的使用受 GNU AFFERO GENERAL PUBLIC LICENSE version 3 许可证的约束, 可以在以下链接找到该许可证.
* Use of this source code is governed by the GNU AGPLv3 license that can be found through the following link.
* 此源代码的使用受 GNU AFFERO GENERAL PUBLIC LICENSE version 3 许可证的约束, 可以在以下链接找到该许可证.
* Use of this source code is governed by the GNU AGPLv3 license that can be found through the following link.
*
* https://github.com/mamoe/mirai/blob/master/LICENSE
* https://github.com/mamoe/mirai/blob/dev/LICENSE
*/
package net.mamoe.mirai.internal.network.components
@ -84,6 +84,9 @@ internal class TimeBasedHeartbeatSchedulerImpl(
return list
}
/**
* If any of the functions throw an exception, HB will fail unexpectedly can [onHeartFailure] will be called.
*/
private fun launchHeartbeatJobAsync(
scope: CoroutineScope,
name: String,
@ -92,20 +95,42 @@ internal class TimeBasedHeartbeatSchedulerImpl(
action: suspend () -> Unit,
onHeartFailure: HeartbeatFailureHandler,
): Deferred<Unit> {
return scope.async(CoroutineName("$name Scheduler")) {
val coroutineName = "$name Scheduler"
return scope.async(CoroutineName(coroutineName)) {
while (isActive) {
try {
delay(delay())
} catch (e: CancellationException) {
return@async // considered normally cancel
} catch (e: Throwable) {
onHeartFailure(
name,
IllegalStateException(
"$coroutineName: Internal error: exception in heartbeat delay function",
e
) // throwing a ISE will stop the handler.
)
return@async
}
try {
withTimeout(timeout()) {
action()
val result = withTimeoutOrNull(timeout()) { action() }
if (result == null) {
onHeartFailure(
name,
PacketTimeoutException(
"$coroutineName: Timeout receiving action response",
CancellationException("Dummy exception for stacktrace")
) // This is a NetworkException that is recoverable
)
return@async
}
} catch (e: Throwable) {
onHeartFailure(name, PacketTimeoutException("Timeout receiving Heartbeat response", e))
onHeartFailure(
name,
IllegalStateException("$coroutineName: Internal error: caught unexpected exception", e)
) // Terminal ISE
return@async
}
}
}.apply {