Skip to content

Fix a race in the frontend server client fake - #2762

Merged
natebosch merged 5 commits into
masterfrom
fix-flaky-test-compiler-fake
Sep 21, 2026
Merged

natebosch merged 5 commits into
masterfrom
fix-flaky-test-compiler-fake

Conversation

@natebosch

@natebosch natebosch commented Sep 19, 2026 •

Copy link
Copy Markdown
Member

The TestCompiler implementation includes some file IO before it calls
FrontendServerClient.compile. This was accounted for in the tests only
with await pumpEventQueue(); which isn't guaranteed to complete after
the OS operations. Make the ordering explicit by adding a stream of
calls to the compiler and making that the only mechanism to communicate
the result.

Remove the unused compileCallCount and isCompileCalled fields. Make
the test body responsible for completing with errors for the test where
it's closed before the compile is finished.

`FakeFrontendServerClient.compile` allocates a fresh completer whenever
the previous one has already been completed. If `completeCompile` runs
before the compiler gets around to calling `compile`, it completes a
completer that `compile` then throws away, and the returned future never
completes. The test then fails with a 30 second timeout.

The tests tried to avoid this by pumping the event queue before
providing a result, but that only makes the ordering likely, not
guaranteed. `can compile successfully with fake` failed on roughly a
third of local runs.

Hold pending compile calls and early results in queues instead, so a
result provided before the matching call is handed to that call rather
than being dropped. Add `compileCalled`, which waits for the compiler to
actually call `compile`, and use it in place of `pumpEventQueue`.
@natebosch
natebosch requested a review from a team as a code owner September 19, 2026 02:11
@natebosch
natebosch marked this pull request as draft September 19, 2026 02:12
@github-actions

github-actions Bot commented Sep 19, 2026 •

Copy link
Copy Markdown

PR Health

`Engine._addLoadSuite` awaits `LoadSuite.suite`, whose completer is only
ever completed from inside the load test's body: either when the body
finishes loading the suite, or by the `onComplete` handler the body
registers. If the load test is closed before its body runs at all,
neither happens and nothing ever completes the suite.

That stalls the task `Engine.run` added for the suite, so it never
releases its resource from `_runPool`, so `_runPool.close()` never
completes, so `Engine.close()` and in turn `Runner.close()` hang
forever.

Today this is masked in the runner: the signal handler cancels its
signal subscription immediately, so the VM exits once nothing else
holds the event loop even though `close()` never completed. Anything
that keeps the isolate alive past that point turns it into a real hang.

Hold onto the completer in `LoadSuite` and add `completeWithoutSuite`,
which completes it with a null suite if nothing else has. Call it once
the load test has finished running, from both `Engine._addLoadSuite`
and `LoadSuite.getSuite`. It is a no-op in every normal path, since the
body holds an outstanding callback until it completes the completer.

Skip running the load test when the engine is already closed. Nothing
needs to be loaded for a closed engine, and `completeWithoutSuite` still
unblocks anything waiting on the suite.
Pass the completer for the compile through the method waiting for the
call to compile.

FakeClient is now just the plumbing, with the behavior more controlled
by the caller.
@natebosch
natebosch marked this pull request as ready for review September 21, 2026 18:08
@natebosch
natebosch merged commit 9946c95 into master Sep 21, 2026
71 checks passed
@natebosch
natebosch deleted the fix-flaky-test-compiler-fake branch September 21, 2026 19:31
copybara-service Bot pushed a commit to dart-lang/sdk that referenced this pull request Sep 22, 2026
Revisions updated by `dart tools/rev_sdk_deps.dart`.

dartdoc (https://github.com/dart-lang/dartdoc/compare/df2f2cd..c68debc):
  c68debcb  Mon Sep 21 11:07:33 2026 +0200  Sarah Zakarias  Adapt the {@example} code fence to the example content (dart-lang/dartdoc#4285)

ecosystem (https://github.com/dart-lang/ecosystem/compare/1bdafd8..16dca7a):
  16dca7a  Mon Sep 21 08:04:10 2026 -0700  Kevin Moore  fix(firehose): keep dart_apitool crash details in logs and sanitize breaking table row (dart-lang/ecosystem#461)

http (https://github.com/dart-lang/http/compare/35769ba..d8e8e9c):
  d8e8e9c  Mon Sep 21 18:26:27 2026 +0900  DubaiChewyCookie  fix(http2): bound peer-controlled streams and headers (dart-lang/http#1958)
  286037b  Thu Sep 17 17:12:02 2026 -0700  Brian Quinlan  chore(http2): prepare to release 3.1.0 (dart-lang/http#1987)
  a067c94  Wed Sep 16 15:57:52 2026 -0700  Brian Quinlan  fix(cupertino_http): possible URLRequest memory leaks (dart-lang/http#1989)
  0d15438  Thu Sep 17 00:43:43 2026 +0300  Ellet  chore(ok_http): Built-in Kotlin and resolve AGP 9 warnings (dart-lang/http#1973)

native (https://github.com/dart-lang/native/compare/a88aaaf..f628b26):
  f628b26f0  Mon Sep 21 23:21:05 2026 +0200  Daco Harkes  [hooks] Add unit tests for `ProtocolExtension` defaults and `build`/`link` error paths (dart-lang/native#3668)
  474a93f39  Mon Sep 21 08:01:13 2026 +0500  Muhammad Anas Naveed  [jni][jnigen] Update Groovy Gradle property assignments (dart-lang/native#3678)
  4434b7f3c  Mon Sep 21 10:31:09 2026 +1000  Liam Appelbe  [jni] Ignore coverage of generated files (dart-lang/native#3665)
  b66dfdeae  Mon Sep 21 10:27:27 2026 +1000  Liam Appelbe  [objective_c] Use `objc_retainAutoreleasedReturnValue` (dart-lang/native#3664)
  541121b4b  Fri Sep 18 17:30:03 2026 +0200  Daco Harkes  [record_use] Add status and coverage badges to `README.md` (dart-lang/native#3675)
  b97663824  Fri Sep 18 17:25:10 2026 +0200  Daco Harkes  [hooks] Prepare `prebuilt_assets_example` v0.1.2 for release (dart-lang/native#3672)
  876145f0c  Fri Sep 18 15:23:34 2026 +0200  Daco Harkes  [hooks] Use `prebuilt/` instead of `assets/` in `prebuilt_assets_example` (dart-lang/native#3671)
  73bd0b7b3  Fri Sep 18 12:58:36 2026 +0200  Daco Harkes  [hooks] Prepare `prebuilt_assets_example` v0.1.1 for release (dart-lang/native#3669)
  4e0f1983f  Fri Sep 18 11:40:30 2026 +0200  Daco Harkes  [hooks] Add example for bundling prebuilt assets in `pub publish` (dart-lang/native#3637)
  22d7cf8da  Fri Sep 18 09:28:25 2026 +0200  Daco Harkes  [native_test_helpers] Add unit tests for `yamlToJson` and `findPackageRoot` (dart-lang/native#3662)
  74e631a8b  Fri Sep 18 09:28:25 2026 +0200  Daco Harkes  [hooks] Add unit tests for `link` API and `MetadataAsset` (dart-lang/native#3661)
  3428cb968  Fri Sep 18 09:28:24 2026 +0200  Daco Harkes  [data_assets] Add unit tests for `LinkOutput` data asset extensions (dart-lang/native#3660)
  0e4eea612  Fri Sep 18 09:28:24 2026 +0200  Daco Harkes  [code_assets] Add unit tests for `testCodeBuildHook` and `CCompilerConfig` (dart-lang/native#3659)
  dc44c5383  Fri Sep 18 09:28:24 2026 +0200  Daco Harkes  [ffi] Add unit tests for `Arena` error handling and `malloc.free` (dart-lang/native#3658)
  1e1e2fb8a  Fri Sep 18 09:28:23 2026 +0200  Daco Harkes  [native_toolchain_c] Default `linkerOptions` in `CLinker.run` and add `CLibrary` tests (dart-lang/native#3657)
  f3c066006  Fri Sep 18 09:28:23 2026 +0200  Daco Harkes  [data_assets] [hooks] [hooks_runner] [record_use] Add coverage ignore comments for debug methods (dart-lang/native#3656)
  59cd44422  Fri Sep 18 09:28:22 2026 +0200  Daco Harkes  [infra] Clean coverage directory and enable `--check-ignore` in `tool/ci.dart` (dart-lang/native#3655)
  b859d5fa8  Fri Sep 18 09:35:46 2026 +0500  Muhammad Anas Naveed  [ffigen] Default compiler options for C++ (dart-lang/native#3645)
  eb6ea1e56  Thu Sep 17 09:28:38 2026 +1000  Liam Appelbe  [ffigen][jnigen] More docs (dart-lang/native#3649)
  da786131c  Thu Sep 17 09:06:20 2026 +1000  Liam Appelbe  [ffigen][jnigen] YAML migration skills (dart-lang/native#3648)
  fc0491997  Wed Sep 16 15:37:19 2026 -0700  Brian Quinlan  [objective_c] don't use autorelease for `toNSDate` (dart-lang/native#3650)
  f7f9a4556  Wed Sep 16 17:32:47 2026 +0200  Daco Harkes  [code_assets] [hooks_runner] [native_toolchain_c] Prepare for release (dart-lang/native#3642)
  1c60c437c  Wed Sep 16 13:40:31 2026 +0200  Daco Harkes  [hooks_runner] Restore non-breaking `KernelAssetPath.toJson` and add `toJsonForTarget` (dart-lang/native#3643)
  7667162b3  Wed Sep 16 11:46:18 2026 +0200  Daco Harkes  [infra] Use `dependency_validator` in `tool/ci.dart` (dart-lang/native#3646)
  f6d153d01  Tue Sep 15 19:32:08 2026 -0700  Brian Quinlan  [objective_c] Fix potential leaks in converts (dart-lang/native#3647)
  cb2c62331  Wed Sep 16 11:32:42 2026 +1000  Liam Appelbe  [ffigen] Remove YAML from readmes (dart-lang/native#3633)
  22e835728  Wed Sep 16 09:49:02 2026 +1000  Liam Appelbe  [jnigen] Remove yaml from readme (dart-lang/native#3634)
  eb444eee2  Wed Sep 16 09:48:04 2026 +1000  Liam Appelbe  [infra] Add and fix `unawaited_futures` and `discarded_futures` lints (dart-lang/native#3639)
  0f419f0d2  Wed Sep 16 09:47:44 2026 +1000  Liam Appelbe  [infra] Switch from coveralls to codecov (dart-lang/native#3626)

shelf (https://github.com/dart-lang/shelf/compare/f36dd68..e5c8dc6):
  e5c8dc6  Tue Sep 15 18:15:41 2026 -0700  Kevin Moore  fix(shelf_static): ignore suffix ranges selecting zero bytes (dart-lang/shelf#541)

test (https://github.com/dart-lang/test/compare/c80d53d..9946c95):
  9946c955  Mon Sep 21 12:31:54 2026 -0700  Nate Bosch  Fix a race in the frontend server client fake (dart-lang/test#2762)
  48c3fdf6  Fri Sep 18 18:52:52 2026 -0700  Nate Bosch  Fix race conditions during test load (dart-lang/test#2761)
  5d74864b  Fri Sep 18 16:25:57 2026 -0700  Nate Bosch  Remove mentions of Travis (dart-lang/test#2760)
  5c4d9b25  Fri Sep 18 12:49:00 2026 -0700  Nate Bosch  Use consistent *Checks naming for prints (dart-lang/test#2759)
  f927df26  Fri Sep 18 12:15:49 2026 -0700  Kevin Moore  feat(checks): add prints expectations (`#2742`) (dart-lang/test#2743)
  347a5af2  Fri Sep 18 12:09:15 2026 -0700  Nate Bosch  Add an example for every matcher (dart-lang/test#2757)
  6358dbb3  Thu Sep 17 15:10:08 2026 -0700  Nate Bosch  Add an example for every checks expectation, and fix the bugs they exposed (dart-lang/test#2756)
  88202adc  Thu Sep 17 14:13:30 2026 +0200  Sigurd Meldgaard  New flag --shard-by-suite

tools (https://github.com/dart-lang/tools/compare/1b0c3bb..3614ce0):
  3614ce06  Fri Sep 18 10:07:20 2026 -0700  Kevin Moore  chore(unified_analytics): remove dart:mirrors usage in test/event_test.dart (dart-lang/tools#2602)
  7550ce13  Fri Sep 18 07:56:44 2026 -0700  Kevin Moore  chore(markdown): remove dart:mirrors usage in tool/stats_lib.dart (dart-lang/tools#2600)

[email protected]

Change-Id: Ide262779269adab780d314d80c9f82b97a79391f
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/552741
Commit-Queue: Nate Bosch <[email protected]>
Reviewed-by: Brian Quinlan <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants