fake_cloud_firestore测试Firestore流：转换器致多元素断言测试挂起

问题场景 #

• 使用fake_cloud_firestore测试返回Firestore流的Dart函数
• 直接测试DocumentSnapshot流时，用例可正常通过
• 用map()或withConverter将快照转为业务对象（如User）后，使用emitsInOrder验证多元素时测试无限挂起，尝试emitLater、stream.take(3)、手动关闭流均无效

原因分析 #

1. 转换函数未处理快照的异常状态（如快照不存在），导致流因异常中断，后续事件无法发射
2. fake_cloud_firestore旧版本存在流转换相关的实现bug，无法正确传递原始流的更新通知
3. 测试框架的emitsInOrder对转换后的流事件监听逻辑存在延迟，未正确等待后续事件

解决方案 #

1. 修复转换函数，处理所有快照状态 #

转换DocumentSnapshot到业务对象时，必须覆盖快照不存在的场景，避免流因异常中断：

User _userFromSnapshot(DocumentSnapshot snapshot) {
  if (!snapshot.exists) {
    return User.empty(); // 或返回null，根据业务逻辑定义
  }
  return User.fromJson(snapshot.data() as Map<String, dynamic>);
}

使用withConverter时，确保fromFirestore方法兼容所有快照情况：

final userRef = fakeFirestore.collection('users').doc('123').withConverter<User>(
  fromFirestore: (snapshot, _) => snapshot.exists 
      ? User.fromJson(snapshot.data()!) 
      : User.empty(),
  toFirestore: (user, _) => user.toJson(),
);

2. 显式控制流的生命周期 #

避免依赖stream.take(n)，手动管理订阅并在测试完成后取消，确保流被正确关闭：

test('测试转换后的User流', () async {
  final fakeFirestore = FakeFirebaseFirestore();
  final userDoc = fakeFirestore.collection('users').doc('123');
  
  // 写入初始数据
  await userDoc.set({'name': 'Alice', 'age': 30});
  
  final userStream = userDoc.snapshots().map(_userFromSnapshot);
  late StreamSubscription subscription;

  // 预期事件序列
  expectLater(userStream, emitsInOrder([
    User(name: 'Alice', age: 30),
    User(name: 'Bob', age: 25),
  ]));

  // 等待第一个事件发射后更新数据
  await Future.delayed(Duration.zero);
  await userDoc.set({'name': 'Bob', 'age': 25});

  // 测试结束后取消订阅，释放资源
  subscription = userStream.listen((_) {});
  await Future.delayed(Duration.zero);
  await subscription.cancel();
});

3. 升级fake_cloud_firestore到最新版本 #

旧版本的fake_cloud_firestore存在流转换相关的bug，升级到^2.4.0及以上的稳定版，多数流同步问题已被修复。

4. 改用StreamQueue手动验证事件 #

如果emitsInOrder仍存在挂起问题，可使用StreamQueue手动监听并验证流事件：

test('用StreamQueue验证User流', () async {
  final fakeFirestore = FakeFirebaseFirestore();
  final userDoc = fakeFirestore.collection('users').doc('123');
  await userDoc.set({'name': 'Alice', 'age': 30});
  
  final userStream = userDoc.snapshots().map(_userFromSnapshot);
  final queue = StreamQueue(userStream);
  
  // 验证第一个元素
  expect(await queue.next(), User(name: 'Alice', age: 30));
  
  // 更新数据并验证第二个元素
  await userDoc.set({'name': 'Bob', 'age': 25});
  expect(await queue.next(), User(name: 'Bob', age: 25));
  
  await queue.cancel();
});

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