使用Paging3测试ViewModel时出现未完成协程错误求助

问题详情 #

在对基于Paging3的ViewModel进行单元测试时，触发如下错误：

等待5秒后，测试协程仍未完成，存在活跃的子任务：[ScopeCoroutine{Active}@244440ed]
kotlinx.coroutines.test.UncompletedCoroutinesError: 等待5秒后，测试协程仍未完成，存在活跃的子任务

经排查，问题源于Paging3测试框架中的asSnapshot()方法——该方法用于将分页数据流转换为列表，但内部协程作用域未被正确清理，导致测试无法正常结束。

已查阅Google官方文档了解asSnapshot()的基础用法，但文档未覆盖此类问题细节；同时参考了多个相关技术问题，均未找到有效解决办法。测试目标为SearchTodoViewModel，核心测试逻辑是通过asSnapshot()转换分页数据流后进行断言验证。

解决方案 #

1. 手动清理asSnapshot()关联的协程 #

asSnapshot()会启动协程监听分页数据流，测试结束前需主动取消该流，避免协程残留：

@Test
fun testSearchTodo() = runTest {
    val snapshotFlow = viewModel.pagingData.asSnapshot()
    // 执行测试断言逻辑
    snapshotFlow.cancel() // 测试收尾时取消快照流
}

2. 调整测试协程超时与调度器 #

若因数据流发射延迟导致超时，可延长runTest的超时时间，或使用UnconfinedTestDispatcher让协程立即执行：

// 延长超时时间
@Test
fun testSearchTodo() = runTest(timeout = 10_000) {
    // 测试逻辑
}

// 全局设置测试调度器
@OptIn(ExperimentalCoroutinesApi::class)
class SearchTodoViewModelTest {
    private val testDispatcher = UnconfinedTestDispatcher()
    
    @Before
    fun setup() {
        Dispatchers.setMain(testDispatcher)
    }
    
    @After
    fun tearDown() {
        Dispatchers.resetMain()
    }
}

3. 排查PagingSource实现是否存在挂起阻塞 #

若自定义PagingSource的load方法存在无限挂起（比如未正确处理数据源返回），会导致asSnapshot()的协程无法结束。需确保load方法能正常返回LoadResult，无阻塞逻辑。

4. 改用Paging3测试扩展替代asSnapshot() #

使用Paging3提供的test()扩展方法更安全地测试分页数据，自动管理协程生命周期：

@Test
fun testSearchTodo() = runTest {
    viewModel.pagingData.test {
        val pagingData = awaitItem()
        // 执行断言逻辑
        cancelAndIgnoreRemainingEvents()
    }
}

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