[cupertino_ui] Migrate nav_bar_test.dart to SemanticsHandle#11980
[cupertino_ui] Migrate nav_bar_test.dart to SemanticsHandle#11980Renzo-Olivares wants to merge 2 commits into
nav_bar_test.dart to SemanticsHandle#11980Conversation
There was a problem hiding this comment.
Code Review
This pull request removes the skip annotation and custom SemanticsTester from nav_bar_test.dart, refactoring the semantics tests to use tester.ensureSemantics() and isSemantics. The review feedback suggests registering the disposal of SemanticsHandle using addTearDown immediately after creation to prevent resource leaks if assertions fail, and removing the redundant manual dispose calls.
|
|
||
| testWidgets('CupertinoSliverNavigationBar has semantics', (WidgetTester tester) async { | ||
| final semantics = SemanticsTester(tester); | ||
| final SemanticsHandle handle = tester.ensureSemantics(); |
There was a problem hiding this comment.
If the expect assertion fails, the test execution will halt immediately, and handle.dispose() at the end of the test will not be called. This leaves the global semantics state enabled, which can cause side effects or failures in subsequent tests. Registering the disposal with addTearDown immediately after creation ensures it is always cleaned up properly.
final SemanticsHandle handle = tester.ensureSemantics();
addTearDown(handle.dispose);There was a problem hiding this comment.
This is how the test was previously structured, no addTearDown was previously used. Also explanation from gemini below as to why the test fails if we do use addTearDown(handle.dispose).
From gemini:
Flutter's TestWidgetsFlutterBinding runs its end-of-test leak verifications (specifically _verifySemanticsHandlesWereDisposed) inside the test body execution flow, immediately after your test callback completes, but before returning control to the Dart test runner:
1. [Test Runner] Starts test
2. [Flutter Binding] Runs test body (your async callback)
3. Your test code executes...
4. Your test code completes.
5. [Flutter Binding] Runs _endOfTestVerifications() <-- CRITICAL POINT
6. Checking active SemanticsHandles...
ERROR: "A SemanticsHandle was active at the end of the test."
7. [Test Runner] Runs addTearDown callbacks <-- TOO LATE!
8. handle.dispose() is called here.
Because the verification (Step 5) happens before the test runner runs the teardown callbacks (Step 7), the binding sees that the SemanticsHandle is still active and throws a FlutterError, failing the test.
| ); | ||
|
|
||
| semantics.dispose(); | ||
| handle.dispose(); |
There was a problem hiding this comment.
|
|
||
| testWidgets('CupertinoNavigationBar has semantics', (WidgetTester tester) async { | ||
| final semantics = SemanticsTester(tester); | ||
| final SemanticsHandle handle = tester.ensureSemantics(); |
There was a problem hiding this comment.
If the expect assertion fails, the test execution will halt immediately, and handle.dispose() at the end of the test will not be called. This leaves the global semantics state enabled, which can cause side effects or failures in subsequent tests. Registering the disposal with addTearDown immediately after creation ensures it is always cleaned up properly.
final SemanticsHandle handle = tester.ensureSemantics();
addTearDown(handle.dispose);There was a problem hiding this comment.
| ); | ||
|
|
||
| semantics.dispose(); | ||
| handle.dispose(); |
There was a problem hiding this comment.
|
|
||
| testWidgets('Large CupertinoNavigationBar has semantics', (WidgetTester tester) async { | ||
| final semantics = SemanticsTester(tester); | ||
| final SemanticsHandle handle = tester.ensureSemantics(); |
There was a problem hiding this comment.
If the expect assertion fails, the test execution will halt immediately, and handle.dispose() at the end of the test will not be called. This leaves the global semantics state enabled, which can cause side effects or failures in subsequent tests. Registering the disposal with addTearDown immediately after creation ensures it is always cleaned up properly.
final SemanticsHandle handle = tester.ensureSemantics();
addTearDown(handle.dispose);There was a problem hiding this comment.
| ); | ||
|
|
||
| semantics.dispose(); | ||
| handle.dispose(); |
There was a problem hiding this comment.
nav_bar_test.dart to SemanticsHandlenav_bar_test.dart to SemanticsHandle
Part of flutter/flutter#182636 and flutter/flutter#188395
This PR:
widgets/semantics_tester.dart. ReplacedSemanticsTesterwithSemanticsHandle.@Skipannotation, all tests in this file has passed.semantics_tester.darthas existed incupertino_ui, so we can directly importsemantics_tester.dart;test/folder.Pre-Review Checklist
[shared_preferences]///).