Skip to content

[cupertino_ui] Migrate nav_bar_test.dart to SemanticsHandle#11980

Open
Renzo-Olivares wants to merge 2 commits into
flutter:mainfrom
Renzo-Olivares:cupertino_ui_nav_bar_test_migration
Open

[cupertino_ui] Migrate nav_bar_test.dart to SemanticsHandle#11980
Renzo-Olivares wants to merge 2 commits into
flutter:mainfrom
Renzo-Olivares:cupertino_ui_nav_bar_test_migration

Conversation

@Renzo-Olivares

Copy link
Copy Markdown
Contributor

Part of flutter/flutter#182636 and flutter/flutter#188395

This PR:

  • Removed the cross-import of widgets/semantics_tester.dart. Replaced SemanticsTester with SemanticsHandle.
  • Removed @Skip annotation, all tests in this file has passed. semantics_tester.dart has existed in cupertino_ui, so we can directly import semantics_tester.dart;
  • Moved the file to test/ folder.

Pre-Review Checklist

  • I read the [Contributor Guide] and followed the process outlined there for submitting PRs.
  • I read the [AI contribution guidelines] and understand my responsibilities, or I am not using AI tools.
  • I read the [Tree Hygiene] page, which explains my responsibilities.
  • I read and followed the [relevant style guides] and ran [the auto-formatter].
  • I signed the [CLA].
  • The title of the PR starts with the name of the package surrounded by square brackets, e.g. [shared_preferences]
  • I [linked to at least one issue that this PR fixes] in the description above.
  • I followed [the version and CHANGELOG instructions], using [semantic versioning] and the [repository CHANGELOG style], or I have commented below to indicate which documented exception this PR falls under[^1].
  • I updated/added any relevant documentation (doc comments with ///).
  • I added new tests to check the change I am making, or I have commented below to indicate which [test exemption] this PR falls under[^1].
  • All existing and new tests are passing.

@flutter-dashboard flutter-dashboard Bot added the CICD Run CI/CD label Jun 25, 2026
@github-actions github-actions Bot added the triage-framework Should be looked at in framework triage label Jun 25, 2026

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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();

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

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);

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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();

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

Since handle.dispose() is now registered via addTearDown right after creation, this manual call at the end of the test is redundant and can be removed.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.


testWidgets('CupertinoNavigationBar has semantics', (WidgetTester tester) async {
final semantics = SemanticsTester(tester);
final SemanticsHandle handle = tester.ensureSemantics();

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

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);

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

);

semantics.dispose();
handle.dispose();

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

Since handle.dispose() is now registered via addTearDown right after creation, this manual call at the end of the test is redundant and can be removed.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.


testWidgets('Large CupertinoNavigationBar has semantics', (WidgetTester tester) async {
final semantics = SemanticsTester(tester);
final SemanticsHandle handle = tester.ensureSemantics();

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

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);

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

);

semantics.dispose();
handle.dispose();

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

Since handle.dispose() is now registered via addTearDown right after creation, this manual call at the end of the test is redundant and can be removed.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@github-actions github-actions Bot removed the CICD Run CI/CD label Jun 25, 2026
@Renzo-Olivares Renzo-Olivares added the CICD Run CI/CD label Jun 25, 2026
@Piinks Piinks changed the title [Decoupling] Migrate nav_bar_test.dart to SemanticsHandle [cupertino_ui] Migrate nav_bar_test.dart to SemanticsHandle Jun 25, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CICD Run CI/CD p: cupertino_ui triage-framework Should be looked at in framework triage

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants