[material_ui] Migrate off of flutter_test's find.byTooltip and on to the local findByTooltip by justinmc · Pull Request #12492 · flutter/packages

justinmc · 2026-08-17T23:11:32Z

The find.byTooltip finder in flutter/flutter's flutter_test package is unreliable for material_ui due to using flutter/flutter's Tooltip class. This PR migrates all usages to the existing findByTooltip in material_ui, which does not have this problem.

See flutter/flutter#191063 (comment)

Fixes flutter/flutter#191063

gemini-code-assist

Code Review

This pull request replaces usages of find.byTooltip with a custom findByTooltip helper function across multiple test files in packages/material_ui. Feedback on the changes suggests addressing the duplication of the findByTooltip helper function in the example test files by extracting it into a shared location. Additionally, the feedback recommends replacing unsafe null assertions (!) on widget.richMessage with optional chaining (?.) and a fallback value to prevent potential runtime exceptions.

gemini-code-assist · 2026-08-18T16:44:29Z

+/// Finds [RawTooltip] or [Tooltip] widgets with the given `message`.
+///
+/// ## Sample code
+///
+/// ```dart
+/// expect(findByTooltip('Back'), findsOneWidget);
+/// expect(findByTooltip(RegExp('Back.*')), findsNWidgets(2));
+/// ```
+///
+/// If the `skipOffstage` argument is true (the default), then this skips
+/// nodes that are [Offstage] or that are from inactive [Route]s.
+///
+/// This was copied from flutter_test, which uses flutter/material.dart.
+///
+// TODO(justinmc): Port flutter_test to material_ui, then delete this method and
+// use that one. See https://github.com/flutter/flutter/issues/186966
+Finder findByTooltip(Pattern message, {bool skipOffstage = true}) {
+  return find.byWidgetPredicate((Widget widget) {
+    // Compare RawTooltip's semantics tooltip with the given message.
+    // However, Tooltip's message needs to be checked directly if:
+    // 1. Tooltip.excludeFromSemantics is true, since in this case Tooltip
+    //    provides no semantics tooltip to the underlying RawTooltip.
+    // 2. Tooltip.message and Tooltip.richMessage are empty, since in this
+    //    case no RawTooltip is created.
+    if (widget is Tooltip) {
+      final String tooltipMessage =
+          widget.message ?? widget.richMessage!.toPlainText();
+      if ((widget.excludeFromSemantics ?? false) || tooltipMessage.isEmpty) {
+        return message is RegExp
+            ? message.hasMatch(tooltipMessage)
+            : tooltipMessage == message;
+      }
+    }
+    return widget is RawTooltip &&
+        (message is RegExp
+            ? message.hasMatch(widget.semanticsTooltip ?? '')
+            : widget.semanticsTooltip == message);
+  }, skipOffstage: skipOffstage);
+}


The findByTooltip helper function is duplicated across multiple example test files (e.g., bottom_app_bar.2_test.dart and tooltip.3_test.dart). To improve maintainability and adhere to DRY (Don't Repeat Yourself) principles, consider extracting this helper into a shared finders.dart file under packages/material_ui/example/test/ and importing it in the respective test files.

I'm ok either way here. I could make a utils file in examples/test, though it would be the first one. This is already going to be duplicated with material_ui/test/finders.dart, and we will clean them up after flutter_test migrates to material_ui.

gemini-code-assist · 2026-08-18T16:44:29Z

+      final String tooltipMessage =
+          widget.message ?? widget.richMessage!.toPlainText();


Using the null assertion operator ! on widget.richMessage can lead to a runtime exception if both widget.message and widget.richMessage are null. Use optional chaining ?. and a fallback empty string ?? '' to ensure defensive programming and null safety.

Suggested change

final String tooltipMessage =

widget.message ?? widget.richMessage!.toPlainText();

final String tooltipMessage =

widget.message ?? widget.richMessage?.toPlainText() ?? '';

There's an assertion that enforces at least one of these is set.

gemini-code-assist · 2026-08-18T16:44:29Z

+    // 2. Tooltip.message and Tooltip.richMessage are empty, since in this
+    //    case no RawTooltip is created.
+    if (widget is Tooltip) {
+      final String tooltipMessage = widget.message ?? widget.richMessage!.toPlainText();


Using the null assertion operator ! on widget.richMessage can lead to a runtime exception if both widget.message and widget.richMessage are null. Use optional chaining ?. and a fallback empty string ?? '' to ensure defensive programming and null safety.

Suggested change

final String tooltipMessage = widget.message ?? widget.richMessage!.toPlainText();

final String tooltipMessage = widget.message ?? widget.richMessage?.toPlainText() ?? '';

Piinks · 2026-08-19T15:28:46Z

+///
+/// This was copied from flutter_test, which uses flutter/material.dart.
+///
+// TODO(justinmc): Port flutter_test to material_ui, then delete this method and


I don't think we want flutter_test to depend on material_ui, I thought we were going to remove any material/cupertino references from flutter_test?

Yeah, I thought we had already done this.. See https://github.com/flutter/packages/blob/main/packages/material_ui/test/finders.dart

I don't think flutter_test can depend on material_ui. We'd end up in another circular circus.

You are right, I'll remove these TODOs. The linked issue explains the situation correctlly.

Piinks

LGTM

Piinks

~~This will need a pending changelog. :)~~

Piinks · 2026-09-02T21:24:16Z

This will need a pending changelog. :)

Oh wait! It won't!
This just changes test files.

auto-submit · 2026-09-02T22:32:02Z

autosubmit label was removed for flutter/packages/12492, because - The status or check suite Dashboard Checks has failed. Please fix the issues identified (or deflake) before re-applying this label.

flutter/packages@18fe786...f9b3954 2026-09-03 ashutoshagarwal2014@gmail.com [image_picker] Fix android-16 not picking up file (flutter/packages#11320) 2026-09-02 jmccandless@google.com [material_ui] Migrate off of flutter_test's find.byTooltip and on to the local findByTooltip (flutter/packages#12492) 2026-09-02 32538273+ValentinVignal@users.noreply.github.com [material_ui] Remove no shuffle from text field tests (flutter/packages#12547) 2026-09-02 21270878+elliette@users.noreply.github.com Add Material style variant enum (#12221) (flutter/packages#12717) 2026-09-02 brian.egan@verygood.ventures [go_router_builder] Report duplicate route paths at build time (flutter/packages#12399) 2026-09-02 victor.orozco@cloudsufi.com [google_sign_in] PR 1/4 google_sign_in_ios SPM packaging (flutter/packages#12654) 2026-09-02 55357489+voledyaev@users.noreply.github.com [video_player_android] Report display size for anamorphic video (flutter/packages#12360) If this roll has caused a breakage, revert this CL and stop the roller using the controls here: https://autoroll.skia.org/r/flutter-packages-flutter-autoroll Please CC flutter-ecosystem@google.com on the revert to ensure that a human is aware of the problem. To file a bug in Flutter: https://github.com/flutter/flutter/issues/new/choose To report a problem with the AutoRoller itself, please file a bug: https://issues.skia.org/issues/new?component=1389291&template=1850622 Documentation for the AutoRoller is here: https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md

justinmc mentioned this pull request Aug 17, 2026

flutter_test finders still references flutter/material Tooltip widget flutter/flutter#191063

Closed

github-actions Bot added triage-framework Should be looked at in framework triage p: material_ui labels Aug 17, 2026

justinmc added the CICD Run CI/CD label Aug 18, 2026

justinmc requested a review from Piinks August 18, 2026 16:43

justinmc marked this pull request as ready for review August 18, 2026 16:43

gemini-code-assist Bot reviewed Aug 18, 2026

View reviewed changes

Piinks reviewed Aug 19, 2026

View reviewed changes

github-actions Bot added triage-design Should be looked at in design triage and removed triage-framework Should be looked at in framework triage labels Aug 20, 2026

justinmc requested a review from Piinks August 20, 2026 22:16

Piinks approved these changes Sep 2, 2026

View reviewed changes

Piinks reviewed Sep 2, 2026

View reviewed changes

justinmc added 4 commits September 2, 2026 16:23

Migrate from find.byTooltip to findByTooltip

ef82a1a

No cross package import.

b030c50

Formatting

f0e277a

Remove inaccurate TODOs.

530e5bc

Piinks force-pushed the material-find-by-tooltip branch from 116dcb6 to 530e5bc Compare September 2, 2026 21:23

Piinks added the autosubmit Merge PR when tree becomes green via auto submit App label Sep 2, 2026

auto-submit Bot removed the autosubmit Merge PR when tree becomes green via auto submit App label Sep 2, 2026

justinmc added the autosubmit Merge PR when tree becomes green via auto submit App label Sep 2, 2026

auto-submit Bot merged commit 1efac12 into flutter:main Sep 2, 2026
11 of 13 checks passed

engine-flutter-autoroll mentioned this pull request Sep 3, 2026

Roll Packages from 18fe786e24b3 to f9b3954a113d (7 revisions) flutter/flutter#192235

Merged

		final String tooltipMessage =
		widget.message ?? widget.richMessage!.toPlainText();

	final String tooltipMessage = widget.message ?? widget.richMessage!.toPlainText();
	final String tooltipMessage = widget.message ?? widget.richMessage?.toPlainText() ?? '';

Uh oh!

Conversation

justinmc commented Aug 17, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

gemini-code-assist Bot Aug 18, 2026

Choose a reason for hiding this comment

Uh oh!

justinmc Aug 18, 2026

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist Bot Aug 18, 2026

Choose a reason for hiding this comment

Uh oh!

justinmc Aug 18, 2026

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist Bot Aug 18, 2026

Choose a reason for hiding this comment

Uh oh!

Piinks Aug 19, 2026

Choose a reason for hiding this comment

Uh oh!

Piinks Aug 19, 2026

Choose a reason for hiding this comment

Uh oh!

justinmc Aug 20, 2026

Choose a reason for hiding this comment

Uh oh!

Piinks left a comment

Choose a reason for hiding this comment

Uh oh!

Piinks left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Piinks commented Sep 2, 2026

Uh oh!

auto-submit Bot commented Sep 2, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

justinmc commented Aug 17, 2026 •

edited

Loading

Piinks left a comment •

edited

Loading