使用Turbine测试含shareIn的Kotlin Flow时超时失败问题的解决方法

我来帮你分析这个问题，我之前也遇到过类似的情况😉

问题根源 #

你的fails()测试超时，核心原因出在shareIn的启动策略和协程调度的不同步上：

1. WhileSubscribed的异步启动逻辑：这个启动策略会在第一个订阅者出现时，异步启动上游流的收集工作。当你调用sharedFlow.test { ... }订阅流后立刻emit事件，此时共享流的上游还没来得及完成初始化，这个事件直接被丢弃了，导致Turbine一直等待item超时。
2. 调度器上下文不一致：你定义的scope基于Dispatchers.Default，而测试用runBlocking运行在当前线程上下文，两个调度器的协程执行时机不同步，进一步放大了事件丢失的问题。

正确的测试方案 #

我们可以通过测试调度器同步协程执行来解决这个问题，这是Kotlin协程测试的标准做法：

步骤1：引入测试协程依赖 #

确保你的项目中添加了与kotlinx-coroutines-core版本匹配的测试库：

// build.gradle.kts
testImplementation("org.jetbrains.kotlinx:kotlinx-coroutines-test:1.7.3")

步骤2：修改测试代码使用测试调度器 #

用TestScope和runTest替代原来的CoroutineScope和runBlocking，并在emit前等待共享流完成启动：

import kotlinx.coroutines.test.TestScope
import kotlinx.coroutines.test.runTest
import app.cash.turbine.test

class MyTest {
    private val testScope = TestScope()
    private val mutableSharedFlow = MutableSharedFlow<Int>()

    @Test
    fun succeeds() = testScope.runTest {
        val sharedFlow = mutableSharedFlow
        sharedFlow.test {
            expectNoEvents()
            mutableSharedFlow.emit(3)
            expect(expectItem()).toBe(3)
        }
    }

    @Test
    fun nowWorks() = testScope.runTest {
        val sharedFlow = mutableSharedFlow
            .shareIn(testScope, started = SharingStarted.WhileSubscribed())
        sharedFlow.test {
            // 等待共享流完成上游的启动和订阅，确保后续emit的事件能被捕获
            advanceUntilIdle()
            expectNoEvents()
            mutableSharedFlow.emit(3)
            expect(expectItem()).toBe(3)
        }
    }
}

关键说明 #

• TestScope和runTest提供了可控的测试调度器，所有协程都在这个调度器上运行，确保执行顺序可预测。
• advanceUntilIdle()会等待所有挂起的协程任务完成，包括共享流启动上游收集的异步任务，这样后续emit的事件就不会被丢弃了。

其他可选方案 #

如果你因为某些原因无法使用测试调度器，也可以尝试临时方案（不推荐作为长期测试策略）：

• 改用SharingStarted.Eagerly启动策略（但这可能不符合你的实际业务逻辑）
• 在emit前添加短暂延迟（比如delay(100)），但这种方式依赖系统调度，可靠性低

内容的提问来源于stack exchange，提问作者nhaarman