feat: add ExitTestEvent to indicate the process has exited (#6)

Author: felangel

lib/src/models/test_event.dart

@@ -36,6 +36,8 @@ abstract class TestEvent {
         return TestDoneEvent.fromJson(json);
       case 'done':
         return DoneTestEvent.fromJson(json);
+      case 'exit':
+        return ExitTestEvent.fromJson(json);
       default:
         throw UnsupportedError('Unsupported type: $type');
     }
@@ -331,6 +333,24 @@ class DoneTestEvent extends TestEvent {
   final bool? success;
 }
 
+/// {@template test_exit_event}
+/// An event emitted when a test completes.
+/// The [exitCode] attribute indicates the result of the test process.
+/// {@endtemplate}
+@JsonSerializable()
+class ExitTestEvent extends TestEvent {
+  /// {@macro test_exit_event}
+  const ExitTestEvent({required int time, required this.exitCode})
+      : super(type: 'exit', time: time);
+
+  /// {@macro test_exit_event}
+  factory ExitTestEvent.fromJson(Map<String, dynamic> json) =>
+      _$ExitTestEventFromJson(json);
+
+  /// The exit code associated with the test process.
+  final int exitCode;
+}
+
 /// {@template test_suite}
 /// A test suite corresponding to a loaded test file.
 /// The suite's ID is unique in the context of this test run.

lib/src/models/test_event.g.dart

@@ -78,6 +78,7 @@ Stream<TestEvent> _runTestProcess(
   late Future<Process> processFuture;
 
   Future<void> _onListen() async {
+    final stopwatch = Stopwatch()..start();
     processFuture = processRunner();
     final process = await processFuture;
     final errors = process.stderr.map((e) => utf8.decode(e).trim());
@@ -86,8 +87,22 @@ Stream<TestEvent> _runTestProcess(
     testEventSubscription = testEvents.listen(
       controller.add,
       onError: controller.addError,
-      onDone: controller.close,
     );
+
+    final exitCode = await process.exitCode;
+    stopwatch.stop();
+    await Future.wait([
+      errorSubscription.cancel(),
+      testEventSubscription.cancel(),
+    ]);
+    if (controller.isClosed) return;
+    controller.add(
+      ExitTestEvent(
+        time: stopwatch.elapsedMilliseconds,
+        exitCode: exitCode,
+      ),
+    );
+    await controller.close();
   }
 
   Future<void> _onCancel() async {

lib/src/very_good_test_runner.dart

@@ -143,6 +143,12 @@ void main() {
 
         expect(TestEvent.fromJson(json), isA<DoneTestEvent>());
       });
+
+      test('returns ExitTestEvent when type is exit', () {
+        final json = {'exitCode': 0, 'type': 'exit', 'time': 4034};
+
+        expect(TestEvent.fromJson(json), isA<ExitTestEvent>());
+      });
     });
   });
 }

test/src/models/test_event_test.dart

@@ -47,6 +47,7 @@ void main() {
       ).thenAnswer((_) async => process);
       when(() => process.stdout).thenAnswer((_) => stdoutController.stream);
       when(() => process.stderr).thenAnswer((_) => stderrController.stream);
+      when(() => process.exitCode).thenAnswer((_) async => 0);
       when(process.kill).thenReturn(true);
     });
 
@@ -158,6 +159,7 @@ void main() {
       ).thenAnswer((_) async => process);
       when(() => process.stdout).thenAnswer((_) => stdoutController.stream);
       when(() => process.stderr).thenAnswer((_) => stderrController.stream);
+      when(() => process.exitCode).thenAnswer((_) async => 0);
       when(process.kill).thenReturn(true);
     });
 
@@ -246,6 +248,8 @@ void main() {
     });
 
     test('emits correct stream of TestEvents', () async {
+      final completer = Completer<int>();
+      when(() => process.exitCode).thenAnswer((_) => completer.future);
       final rawEvents = [
         {
           'protocolVersion': '0.1.1',
@@ -740,7 +744,6 @@ void main() {
         (element) => utf8.encode(json.encode(element)),
       );
       await stdoutController.addStream(Stream.fromIterable(encodedEvents));
-      await stdoutController.close();
       expect(
         events,
         equals([
@@ -788,6 +791,9 @@ void main() {
           isA<DoneTestEvent>(),
         ]),
       );
+      completer.complete(0);
+      await Future<void>.delayed(Duration.zero);
+      expect(events.last, isA<ExitTestEvent>());
       unawaited(subscription.cancel());
     });
   });