event-driven test waits, fail-loud on timeout (T-108)

Replaces the fixed Future.delayed sleeps the consultant flagged
with stream-based waits that complete when the awaited event
arrives. Timeout callbacks call fail() with a diagnostic instead
of `onTimeout: () {}` swallowing the signal — a never-producing
pty now reports "pty did not produce X within 5s" instead of an
unhelpful "Actual: ''".

session_test.dart:
  - _readUntil helper subscribes to s.output, completes when a
    marker substring appears (or onDone), fails on timeout.
  - _waitForBuffer polls a buffer the listener is already filling
    after a write; 25ms tick, 5s ceiling, fail-loud on miss.
  - Drops the 500ms settle + 50×100ms polling pattern in the write
    test; uses a "first-byte" completer for prompt-readiness.
  - retry: 2 restored on the four read-dependent forkpty tests
    (the underlying flutter-test-runner pty-output flake hasn't
    fully gone away; recovers cleanly on a fresh spawn).

watcher_test.dart:
  - "emits a created event" awaits stream.firstWhere instead of two
    fixed sleeps.
  - "filters ignored paths" uses pre + post sentinel markers to
    bracket the inotify-delivery window event-driven; the negative
    assertion only runs after the post marker is observed.

event_sink.dart:
  - RecordingEventSink gains a broadcast `stream` for the same
    event-await pattern. PaneRegistry's output test subscribes
    BEFORE spawn so first bytes aren't lost.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This commit is contained in:
2026-05-17 22:05:49 +02:00
co-authored by Claude Opus 4.7
parent 7937da1734
commit b66e8f6cc0
7 changed files with 160 additions and 54 deletions
+72 -32
View File
@@ -24,7 +24,7 @@ void main() {
if (!Platform.isLinux && !Platform.isMacOS) return;
group('NativePty', () {
test('spawns shell -c echo and reads output', tags: ['forkpty'], () async {
test('spawns shell -c echo and reads output', tags: ['forkpty'], retry: 2, () async {
final s = NativePty.start(
executable: '/bin/sh',
arguments: ['-c', 'echo hello-pty'],
@@ -38,20 +38,11 @@ void main() {
);
addTearDown(s.close);
final buf = StringBuffer();
final done = Completer<void>();
s.output.listen(
(bytes) => buf.write(utf8.decode(bytes, allowMalformed: true)),
onDone: () {
if (!done.isCompleted) done.complete();
},
);
await done.future.timeout(const Duration(seconds: 5), onTimeout: () {});
expect(buf.toString(), contains('hello-pty'));
final got = await _readUntil(s, 'hello-pty', const Duration(seconds: 5));
expect(got, contains('hello-pty'));
});
test('write sends keystrokes to child', tags: ['forkpty'], () async {
test('write sends keystrokes to child', tags: ['forkpty'], retry: 2, () async {
final s = NativePty.start(
executable: '/bin/sh',
arguments: [],
@@ -66,19 +57,27 @@ void main() {
addTearDown(s.close);
final buf = StringBuffer();
s.output.listen((bytes) => buf.write(utf8.decode(bytes, allowMalformed: true)));
final firstByte = Completer<void>();
final sub = s.output.listen((bytes) {
buf.write(utf8.decode(bytes, allowMalformed: true));
// First byte from the pty signals the shell is up and the
// reader isolate is delivering — better than a fixed sleep.
if (!firstByte.isCompleted) firstByte.complete();
});
addTearDown(sub.cancel);
await Future<void>.delayed(const Duration(milliseconds: 500));
await firstByte.future.timeout(
const Duration(seconds: 5),
onTimeout: () => fail('shell never produced its first byte within 5s'),
);
s.write(utf8.encode('echo write-test-ok\n'));
for (var i = 0; i < 50 && !buf.toString().contains('write-test-ok'); i++) {
await Future<void>.delayed(const Duration(milliseconds: 100));
}
expect(buf.toString(), contains('write-test-ok'));
final result = await _waitForBuffer(buf, 'write-test-ok', const Duration(seconds: 5));
expect(result, contains('write-test-ok'));
});
test('close kills child and closes output', tags: ['forkpty'], () async {
test('close kills child and closes output', tags: ['forkpty'], retry: 2, () async {
final s = NativePty.start(
executable: '/bin/sh',
arguments: [],
@@ -95,11 +94,14 @@ void main() {
s.output.listen((_) {}, onDone: () => done.complete());
await s.close();
await done.future.timeout(const Duration(seconds: 3));
await done.future.timeout(
const Duration(seconds: 3),
onTimeout: () => fail('output stream did not close within 3s after s.close()'),
);
expect(s.isClosed, isTrue);
});
test('bare command name resolves via the PATH env var', tags: ['forkpty'], () async {
test('bare command name resolves via the PATH env var', tags: ['forkpty'], retry: 2, () async {
// 'sh' is a bare command; without resolution, execve would fail.
final s = NativePty.start(
executable: 'sh',
@@ -113,16 +115,9 @@ void main() {
},
);
addTearDown(s.close);
final buf = StringBuffer();
final done = Completer<void>();
s.output.listen(
(b) => buf.write(utf8.decode(b, allowMalformed: true)),
onDone: () {
if (!done.isCompleted) done.complete();
},
);
await done.future.timeout(const Duration(seconds: 5), onTimeout: () {});
expect(buf.toString(), contains('path-resolution-ok'));
final got = await _readUntil(s, 'path-resolution-ok', const Duration(seconds: 5));
expect(got, contains('path-resolution-ok'));
});
test('non-existent workingDirectory surfaces a PtyException at spawn time', () {
@@ -201,3 +196,48 @@ void main() {
});
});
}
// -- Helpers ----------------------------------------------------------------
/// Read bytes from [s] into a local buffer until [marker] appears or
/// [timeout] elapses. Fails the test on timeout — the previous bare
/// `onTimeout: () {}` pattern hid the real failure mode (reader
/// isolate never delivered) behind a confusing "buffer empty"
/// assertion.
Future<String> _readUntil(NativePty s, String marker, Duration timeout) async {
final buf = StringBuffer();
final done = Completer<String>();
final sub = s.output.listen(
(bytes) {
buf.write(utf8.decode(bytes, allowMalformed: true));
if (buf.toString().contains(marker) && !done.isCompleted) {
done.complete(buf.toString());
}
},
onDone: () {
if (!done.isCompleted) done.complete(buf.toString());
},
);
try {
return await done.future.timeout(
timeout,
onTimeout: () => fail('pty did not produce "$marker" within ${timeout.inSeconds}s (buffer: "${buf.toString().replaceAll('\n', r'\n')}")'),
);
} finally {
await sub.cancel();
}
}
/// Poll [buf] until [marker] appears or [timeout] elapses. Used after
/// a write — the bytes flow back through the same output stream a
/// caller is already listening to, so we just watch the buffer.
Future<String> _waitForBuffer(StringBuffer buf, String marker, Duration timeout) async {
final deadline = DateTime.now().add(timeout);
while (!buf.toString().contains(marker)) {
if (DateTime.now().isAfter(deadline)) {
fail('buffer never contained "$marker" within ${timeout.inSeconds}s (buffer: "${buf.toString().replaceAll('\n', r'\n')}")');
}
await Future<void>.delayed(const Duration(milliseconds: 25));
}
return buf.toString();
}