Him188/revise on demand scope

[Him188]

挪到 mirai-core-utils, 重新审查状态设计 (降低复杂度), 增加文档 (注释), 增加测试

close #2633

[Him188]

java.lang.VerifyError: Bad type on operand stack |  
-- | --
  | Exception Details: |  
  | Location: |  
  | net/mamoe/mirai/utils/channels/CoroutineOnDemandReceiveChannel.receiveOrNull(Lkotlin/coroutines/Continuation;)Ljava/lang/Object; @103: getfield |  
  | Reason: |  
  | Type 'java/lang/Object' (current frame, stack[0]) is not assignable to 'net/mamoe/mirai/utils/channels/CoroutineOnDemandReceiveChannel' |  
  | Current Frame: |  
  | bci: @103 |  
  | flags: { } |  
  | locals: { 'net/mamoe/mirai/utils/channels/CoroutineOnDemandReceiveChannel', 'kotlin/coroutines/Continuation', 'java/lang/Object', integer, top, top, top, top, top, top, top, 'java/lang/Object', 'net/mamoe/mirai/utils/channels/CoroutineOnDemandReceiveChannel$receiveOrNull$1', 'java/lang/Object' } |  
  | stack: { 'java/lang/Object' } |  
  | Bytecode:

https://scans.gradle.com/s/esafjm3w3klog/tests/:mirai-core:jvmTest/net.mamoe.mirai.internal.network.component.BotAuthControlTest/auth%20test()?top-execution=1

interesting

[Him188]

基本好了

• 删除了 CreatingProducer 状态, 与 ProducerReady 合并, 因此修复了 producer 有可能会启动多次问题 (有可能不是, 具体忘了) (2.15.0-M1 受影响)
• 修复了 producer 出异常会导致内存泄露问题 (2.15.0-M1 受影响)
• 修复 expectMore 在 Producing state 不会抛异常的问题
• 调整了异常的 mesage 以及 cause
• 调整了 close (以前叫 finish) 的行为, 现在它与 Job.cancel 行为相似, 重复 close 不会抛出异常

producer 抛异常不会立即 close channel, 在下一次 receiveOrNull 时才会 close.
假如 producer 抛异常时碰巧有人调用 close, 异常会被忽略.
如果 producer 抛了异常, 而 receiver 没有 receiveOrNull 而 close, 异常也会被忽略.
异常会被包装成 ProducerFailureException, 像这样:

net.mamoe.mirai.utils.channels.ProducerFailureException: Producer failed to produce a value, see cause
	at net.mamoe.mirai.utils.channels.CoroutineOnDemandReceiveChannel.receiveOrNull(OnDemandChannelImpl.kt:164)
	at net.mamoe.mirai.utils.channels.CoroutineOnDemandReceiveChannel$receiveOrNull$1.invokeSuspend(OnDemandChannelImpl.kt)
	at kotlin.coroutines.jvm.internal.BaseContinuationImpl.resumeWith(ContinuationImpl.kt:33)
	at kotlinx.coroutines.test.TestBuildersKt.runTest$default(Unknown Source)
	at net.mamoe.mirai.utils.channels.OnDemandChannelTest.producer exception(OnDemandChannelTest.kt:273)
	at worker.org.gradle.process.internal.worker.GradleWorkerMain.main(GradleWorkerMain.java:74)
Caused by: java.util.NoSuchElementException: Oops
	at net.mamoe.mirai.utils.channels.OnDemandChannelTest$producer exception$1$channel$1.invokeSuspend(OnDemandChannelTest.kt:275)
	at net.mamoe.mirai.utils.channels.OnDemandChannelTest$producer exception$1$channel$1.invoke(OnDemandChannelTest.kt)
	at net.mamoe.mirai.utils.channels.OnDemandChannelTest$producer exception$1$channel$1.invoke(OnDemandChannelTest.kt)
	at net.mamoe.mirai.utils.channels.CoroutineOnDemandReceiveChannel$Producer$1.invokeSuspend(OnDemandChannelImpl.kt:46)
	(Coroutine boundary)
	at net.mamoe.mirai.utils.channels.CoroutineOnDemandReceiveChannel.receiveOrNull(OnDemandChannelImpl.kt:162)
	at net.mamoe.mirai.utils.channels.OnDemandChannelTest$producer exception$1.invokeSuspend(OnDemandChannelTest.kt:280)
	at kotlinx.coroutines.test.TestBuildersKt__TestBuildersKt$runTestCoroutine$2.invokeSuspend(TestBuilders.kt:212)
Caused by: java.util.NoSuchElementException: Oops
  ...

在 BotAuth 时会最终以 BotAuthorizationException 之类的在 Bot.login 抛出

TODO:

• [ ] 测试 cancellation
• [ ] �stress test

UPDATE: 留到第二个 PR 再做

[Him188]

@Karlatemp 你想 review 吗

[Karlatemp]

没看具体实现, 看了一遍 test 感觉没啥问题, 实际登录测试过?

[Him188]

e: file:///Users/runner/work/mirai/mirai/mirai-core-
utils/src/commonMain/kotlin/UtilsLogger.kt:69:42 This can only be used in tests.

e: file:///Users/runner/work/mirai/mirai/mirai-core-utils/src/commonMain/kotlin/UtilsLogger.kt:69:42 This can only be used in tests