Replace [FinderBase] with [Finder] in the documentation of Matchers #168279

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Merged

auto-submit merged 6 commits into flutter:master from ahmedsameha1:fix_#168230

Jul 9, 2025

Contributor

ahmedsameha1 commented May 3, 2025 •

edited by tirth-patel-nc

Loading

Replace [FinderBase] with [Finder] in the doc comments of Matchers.

Closes #168230

github-actions bot added a: tests framework labels

ahmedsameha1 mentioned this pull request

[Finder]/[FinderBase] in the documentation of Matchers #168230

Closed

justinmc reviewed

View reviewed changes

Contributor

justinmc left a comment •

edited

Loading

Isn't it more accurate to say FinderBase instead of Finder? Something like findsNothing could be used with SemanticsFinder, which is a FinderBase and not a Finder.

Edit: In your example in the issue #168230, you compare findsNothing with findsOneWidget, but findsOneWidget should operate only on Finders, so I think that is correct as-is.

Contributor Author

ahmedsameha1 commented May 7, 2025

I cannot understand you. Both FindsNothing and FindsOneWidget are instances of the same class: _FindsCountMatcher, so if something should work with one, it should work with the other, and if something should not work with one, it should not work with the other.
Ok. I could replace [Finder] with [FinderBase]. There is more than one subtype of FinderBase, so I think that you are correct that I should replace [Finder] with [FinderBase]. May I update this pull request according to this?

Contributor

justinmc commented May 13, 2025

Yes please go ahead and update the PR and I will take another look. Thank you!

ahmedsameha1 force-pushed the fix_#168230 branch from 88f407b to 587471c Compare

May 14, 2025 03:11

Contributor Author

ahmedsameha1 commented May 14, 2025

I did replace [Finder] with [FinderBase] in the doc comments of Matchers.

justinmc reviewed

View reviewed changes

Contributor

justinmc left a comment

I think these are all correct as-is, unless I missed one. These all seem to operate on widgets and therefore it's more accurate to say Finder and not FinderBase.

I think we can probably close this PR and close #168230, unless there is a specific mismatch that you see in the use of Finder vs. FinderBase.

packages/flutter_test/lib/src/matchers.dart

    
              const Matcher findsNothing = _FindsCountMatcher(null, 0);

              /// Asserts that the [Finder] locates at least one widget in the widget tree.

              /// Asserts that the [FinderBase] locates at least one widget in the widget tree.

Contributor

justinmc May 29, 2025

I think this was correct as-is. findsWidgets deals with widgets and so does Finder.

Contributor Author

ahmedsameha1 Jun 3, 2025

findsWidgets is an instance of the _FindsCountMatcher class.
This is the signature of the matches() method of _FindsCountMatcher:

bool matches(covariant FinderBase<dynamic> finder, Map<dynamic, dynamic> matchState)

As you can see, it takes a FinderBase, not a Finder, as its first argument. So I think that FinderBase is the correct type that should be used in this doc comment.

Contributor

justinmc Jun 4, 2025

Ah ok you're right, they do all operate on FinderBase even when they have "widgets" in the name. I even see this below for findsOneWidget:

This is equivalent to the preferred [findsOne] method.

Indeed findsOne and findsOneWidget are identical.

justinmc reviewed

View reviewed changes

packages/flutter_test/lib/src/matchers.dart Outdated

    
              Matcher findsAtLeast(int n) => _FindsCountMatcher(n, null);

              /// Asserts that the [Finder] locates a single widget that has at

              /// Asserts that the [FinderBase] locates a single widget that has at

Contributor

justinmc Jun 4, 2025

This one looks like it actually should be Finder right?

flutter/packages/flutter_test/lib/src/matchers.dart

Line 1177 in 1fcd888

bool matches(covariant Finder finder, Map<dynamic, dynamic> matchState) {

Contributor Author

ahmedsameha1 Jun 5, 2025

Ok. This should be Finder.

packages/flutter_test/lib/src/matchers.dart

    
              const Matcher findsNothing = _FindsCountMatcher(null, 0);

              /// Asserts that the [Finder] locates at least one widget in the widget tree.

              /// Asserts that the [FinderBase] locates at least one widget in the widget tree.

Contributor

justinmc Jun 4, 2025

Ah ok you're right, they do all operate on FinderBase even when they have "widgets" in the name. I even see this below for findsOneWidget:

This is equivalent to the preferred [findsOne] method.

Indeed findsOne and findsOneWidget are identical.

packages/flutter_test/lib/src/matchers.dart Outdated

    
              const Matcher isOffstage = _IsOffstage();

              /// Asserts that the [Finder] locates a single widget that has no

              /// Asserts that the [FinderBase] locates a single widget that has no

Contributor

justinmc Jun 4, 2025

Also this one should stay Finder.

Contributor Author

ahmedsameha1 Jun 5, 2025

Ok. This should stay Finder.

packages/flutter_test/lib/src/matchers.dart Outdated

    
              const Matcher isInCard = _IsInCard();

              /// Asserts that the [Finder] locates a single widget that has no

              /// Asserts that the [FinderBase] locates a single widget that has no

Contributor

justinmc Jun 4, 2025

Should stay Finder.

Contributor Author

ahmedsameha1 Jun 5, 2025

Ok. This should stay Finder.

packages/flutter_test/lib/src/matchers.dart Outdated

Comment on lines 469 to 472

    
              /// Asserts that a [Finder], [Future<ui.Image>], or [ui.Image] matches the

              /// Asserts that a [FinderBase], [Future<ui.Image>], or [ui.Image] matches the

              /// golden image file identified by [key], with an optional [version] number.

              ///

              /// For the case of a [Finder], the [Finder] must match exactly one widget and

              /// For the case of a [FinderBase], the [FinderBase] must match exactly one widget and

Contributor

justinmc Jun 4, 2025

Looks like it's a Finder:

flutter/packages/flutter_test/lib/src/_matchers_io.dart

Line 93 in 1fcd888

} else if (item is Finder) {

Contributor Author

ahmedsameha1 Jun 5, 2025

Ok. This should stay Finder.

packages/flutter_test/lib/src/matchers.dart Outdated

    
              const Matcher clipsWithBoundingRect = _ClipsWithBoundingRect();

              /// Asserts that a [Finder] locates a single object whose root RenderObject is

              /// Asserts that a [FinderBase] locates a single object whose root RenderObject is

Contributor

justinmc Jun 4, 2025

Finder:

flutter/packages/flutter_test/lib/src/matchers.dart

Line 1877 in 1fcd888

bool matches(covariant Finder finder, Map<dynamic, dynamic> matchState) {

Contributor Author

ahmedsameha1 Jun 5, 2025

Ok. This should stay Finder.

packages/flutter_test/lib/src/matchers.dart Outdated

    
              const Matcher hasNoImmediateClip = _MatchAnythingExceptClip();

              /// Asserts that a [Finder] locates a single object whose root RenderObject

              /// Asserts that a [FinderBase] locates a single object whose root RenderObject

Contributor

justinmc Jun 4, 2025

Finder:

flutter/packages/flutter_test/lib/src/matchers.dart

Line 1912 in 1fcd888

bool matches(covariant Finder finder, Map<dynamic, dynamic> matchState) {

Contributor Author

ahmedsameha1 Jun 5, 2025

Ok. This should stay Finder.

packages/flutter_test/lib/src/matchers.dart Outdated

    
              }

              /// Asserts that a [Finder] locates a single object whose root RenderObject

              /// Asserts that a [FinderBase] locates a single object whose root RenderObject

Contributor

justinmc Jun 4, 2025

Finder:

flutter/packages/flutter_test/lib/src/matchers.dart

Line 1912 in 1fcd888

bool matches(covariant Finder finder, Map<dynamic, dynamic> matchState) {

Contributor Author

ahmedsameha1 Jun 5, 2025

Ok. This should stay Finder.

packages/flutter_test/lib/src/matchers.dart Outdated

    
              }

              /// Asserts that a [Finder] locates a single object whose root RenderObject

              /// Asserts that a [FinderBase] locates a single object whose root RenderObject

Contributor

justinmc Jun 4, 2025

Finder:

flutter/packages/flutter_test/lib/src/matchers.dart

Line 1912 in 1fcd888

bool matches(covariant Finder finder, Map<dynamic, dynamic> matchState) {

Contributor Author

ahmedsameha1 Jun 5, 2025

Ok, Finder.

packages/flutter_test/lib/src/matchers.dart Outdated

    
              }

              /// Asserts that a [Finder] locates a single object whose root RenderObject

              /// Asserts that a [FinderBase] locates a single object whose root RenderObject

Contributor

justinmc Jun 4, 2025

Finder:

flutter/packages/flutter_test/lib/src/matchers.dart

Line 1912 in 1fcd888

bool matches(covariant Finder finder, Map<dynamic, dynamic> matchState) {

Contributor Author

ahmedsameha1 Jun 5, 2025

Ok, Finder.


          Changes after investigating every single one

10f1d7b

ahmedsameha1 force-pushed the fix_#168230 branch from 587471c to 10f1d7b Compare

June 6, 2025 04:30

Contributor Author

ahmedsameha1 commented Jun 6, 2025

I have updated the pull request based on the last investigation.

ahmedsameha1 added 3 commits

June 16, 2025 10:04


          Merge remote-tracking branch 'upstream/master' into fix_#168230

6ba249d


          Merge branch 'flutter:master' into fix_#168230

a69e27a


          Merge branch 'master' into fix_#168230

889fa7f

Contributor Author

ahmedsameha1 commented Jun 25, 2025

@justinmc Is there any additional needed requirements to merge this PR?

ahmedsameha1 added 2 commits

June 26, 2025 07:38


          Merge branch 'master' into fix_#168230

a4720b5


          Merge branch 'master' into fix_#168230

06726f6

justinmc approved these changes

View reviewed changes

Contributor

justinmc left a comment

LGTM 👍 Thank you for dealing with all of my nitpicks on this PR and following through! I appreciate the effort to improve our docs 🙏 .

Contributor Author

ahmedsameha1 commented Jul 9, 2025

This is my first approved PR in the Flutter repository. I'm happy. Thank you.

bleroux approved these changes

View reviewed changes

Contributor

bleroux left a comment

LGTM!

bleroux added the autosubmit label

auto-submit bot added this pull request to the merge queue

Merged via the queue into flutter:master with commit 55af36a

69 checks passed

flutter-dashboard bot removed the autosubmit label

engine-flutter-autoroll mentioned this pull request

Roll Flutter from adffe244f3f1 to 55af36a3d506 (27 revisions) flutter/packages#9583

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request


          55af36a3d Replace [FinderBase] with [Finder] in the documentation of …

6c3ce7c

…Matchers (flutter/flutter#168279)

engine-flutter-autoroll mentioned this pull request

Roll Flutter from adffe244f3f1 to ac12f66681f1 (28 revisions) flutter/packages#9584

Merged

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request


          55af36a3d Replace [FinderBase] with [Finder] in the documentation of …

b955bfb

…Matchers (flutter/flutter#168279)

auto-submit bot pushed a commit to flutter/packages that referenced this pull request


          Roll Flutter from adffe244f3f1 to ac12f66681f1 (28 revisions) (#9584)

421e77c

flutter/flutter@adffe24...ac12f66

2025-07-09 [email protected] Roll Packages from cba2e90 to 4a231ae (5 revisions) (flutter/flutter#171879)
2025-07-09 [email protected] Replace [FinderBase] with [Finder] in the documentation of Matchers (flutter/flutter#168279)
2025-07-09 [email protected] Revert "Mark web_long_running_tests_2_5 as bringup" (flutter/flutter#171872)
2025-07-09 [email protected] Apply normalization to TimePickerThemeData.inputDecorationTheme (flutter/flutter#171584)
2025-07-09 [email protected] Fix InputDecorationThemeData.activeIndicatorBorder is not applied (flutter/flutter#171764)
2025-07-09 [email protected] Fix multi-view GL rendering not working since software rendering was added (flutter/flutter#171409)
2025-07-09 [email protected] Marks Linux_android_emu android_engine_vulkan_tests to be unflaky (flutter/flutter#171141)
2025-07-08 [email protected] Roll Fuchsia Linux SDK from AinHuT0vgOelA1g7_... to 0-xqmXWc4cXzw3tfe... (flutter/flutter#171823)
2025-07-08 [email protected] Marks Linux_android_emu android_display_cutout to be unflaky (flutter/flutter#171140)
2025-07-08 [email protected] [Documentation] When updating kgp minimum document additional changes that are required (flutter/flutter#171819)
2025-07-08 [email protected] Marks Linux_android_emu android_engine_opengles_tests to be unflaky (flutter/flutter#171142)
2025-07-08 [email protected] Add support for running dart2wasm in dry run mode on js compilations (flutter/flutter#171682)
2025-07-08 [email protected] Remove now duplicate un-forward ports for Android (flutter/flutter#171473)
2025-07-08 [email protected] [skia] Update usage of removed gn flag (flutter/flutter#171800)
2025-07-08 [email protected] [web] Disable auto-formatting for the stack_trace.dart test file (flutter/flutter#171801)
2025-07-08 [email protected] Bump warn and error versions of agp, kotlin and gradle versions in preparation for gradle 9 (flutter/flutter#171776)
2025-07-08 [email protected] Removed string keys (flutter/flutter#171293)
2025-07-08 [email protected] Add `radioSide` to `RadioListTile` (flutter/flutter#171318)
2025-07-08 [email protected] Roll Fuchsia Test Scripts from ZpnML-jis0gVIvtx5... to MnFlN7VWM_7h7EmBV... (flutter/flutter#171787)
2025-07-08 [email protected] Add/use `addMachineOutputFlag`/`outputsMachineFormat` instead of strings (flutter/flutter#171459)
2025-07-08 [email protected] Update translation from console (flutter/flutter#171556)
2025-07-08 [email protected] [ Tool ] Support upgrading to a new Flutter version pointing to the same revision as a previous version (flutter/flutter#171783)
2025-07-08 [email protected] Multi-window support (engine) (flutter/flutter#168728)
2025-07-08 [email protected] Fixes an issue where TapRegion would consume taps regardless of navigation state (flutter/flutter#169067)
2025-07-08 [email protected] SliverSemantics (flutter/flutter#167300)
2025-07-08 [email protected] Roll Skia from e159882c6ce0 to 0fef076beec3 (3 revisions) (flutter/flutter#171779)
2025-07-08 [email protected] Run hot_restart_web_amd_test.dart on Mac/Windows (flutter/flutter#171281)
2025-07-08 [email protected] Roll Packages from 2c52f24 to cba2e90 (2 revisions) (flutter/flutter#171775)

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
Please CC [email protected],[email protected] on the revert to ensure that a human
is aware of the problem.

To file a bug in Packages: 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

mboetger pushed a commit to mboetger/flutter that referenced this pull request


          Replace [FinderBase] with [Finder] in the documentation of Matchers (f…

44c1288

…lutter#168279)

Replace [FinderBase] with [Finder] in the doc comments of Matchers.

Closes flutter#168230

ahmedsameha1 deleted the fix_#168230 branch

July 10, 2025 08:57

azatech pushed a commit to azatech/flutter that referenced this pull request


          Replace [FinderBase] with [Finder] in the documentation of Matchers (f…

bcb9b20

…lutter#168279)

Replace [FinderBase] with [Finder] in the doc comments of Matchers.

Closes flutter#168230

mboetger pushed a commit to mboetger/flutter that referenced this pull request


          Replace [FinderBase] with [Finder] in the documentation of Matchers (f…

686691b

…lutter#168279)

Replace [FinderBase] with [Finder] in the doc comments of Matchers.

Closes flutter#168230

azatech pushed a commit to azatech/flutter that referenced this pull request


          Replace [FinderBase] with [Finder] in the documentation of Matchers (f…

4e2b4e1

…lutter#168279)

Replace [FinderBase] with [Finder] in the doc comments of Matchers.

Closes flutter#168230

vashworth pushed a commit to vashworth/packages that referenced this pull request


          Roll Flutter from adffe244f3f1 to ac12f66681f1 (28 revisions) (flutte…

cf631ee

…r#9584)

flutter/flutter@adffe24...ac12f66

2025-07-09 [email protected] Roll Packages from cba2e90 to 4a231ae (5 revisions) (flutter/flutter#171879)
2025-07-09 [email protected] Replace [FinderBase] with [Finder] in the documentation of Matchers (flutter/flutter#168279)
2025-07-09 [email protected] Revert "Mark web_long_running_tests_2_5 as bringup" (flutter/flutter#171872)
2025-07-09 [email protected] Apply normalization to TimePickerThemeData.inputDecorationTheme (flutter/flutter#171584)
2025-07-09 [email protected] Fix InputDecorationThemeData.activeIndicatorBorder is not applied (flutter/flutter#171764)
2025-07-09 [email protected] Fix multi-view GL rendering not working since software rendering was added (flutter/flutter#171409)
2025-07-09 [email protected] Marks Linux_android_emu android_engine_vulkan_tests to be unflaky (flutter/flutter#171141)
2025-07-08 [email protected] Roll Fuchsia Linux SDK from AinHuT0vgOelA1g7_... to 0-xqmXWc4cXzw3tfe... (flutter/flutter#171823)
2025-07-08 [email protected] Marks Linux_android_emu android_display_cutout to be unflaky (flutter/flutter#171140)
2025-07-08 [email protected] [Documentation] When updating kgp minimum document additional changes that are required (flutter/flutter#171819)
2025-07-08 [email protected] Marks Linux_android_emu android_engine_opengles_tests to be unflaky (flutter/flutter#171142)
2025-07-08 [email protected] Add support for running dart2wasm in dry run mode on js compilations (flutter/flutter#171682)
2025-07-08 [email protected] Remove now duplicate un-forward ports for Android (flutter/flutter#171473)
2025-07-08 [email protected] [skia] Update usage of removed gn flag (flutter/flutter#171800)
2025-07-08 [email protected] [web] Disable auto-formatting for the stack_trace.dart test file (flutter/flutter#171801)
2025-07-08 [email protected] Bump warn and error versions of agp, kotlin and gradle versions in preparation for gradle 9 (flutter/flutter#171776)
2025-07-08 [email protected] Removed string keys (flutter/flutter#171293)
2025-07-08 [email protected] Add `radioSide` to `RadioListTile` (flutter/flutter#171318)
2025-07-08 [email protected] Roll Fuchsia Test Scripts from ZpnML-jis0gVIvtx5... to MnFlN7VWM_7h7EmBV... (flutter/flutter#171787)
2025-07-08 [email protected] Add/use `addMachineOutputFlag`/`outputsMachineFormat` instead of strings (flutter/flutter#171459)
2025-07-08 [email protected] Update translation from console (flutter/flutter#171556)
2025-07-08 [email protected] [ Tool ] Support upgrading to a new Flutter version pointing to the same revision as a previous version (flutter/flutter#171783)
2025-07-08 [email protected] Multi-window support (engine) (flutter/flutter#168728)
2025-07-08 [email protected] Fixes an issue where TapRegion would consume taps regardless of navigation state (flutter/flutter#169067)
2025-07-08 [email protected] SliverSemantics (flutter/flutter#167300)
2025-07-08 [email protected] Roll Skia from e159882c6ce0 to 0fef076beec3 (3 revisions) (flutter/flutter#171779)
2025-07-08 [email protected] Run hot_restart_web_amd_test.dart on Mac/Windows (flutter/flutter#171281)
2025-07-08 [email protected] Roll Packages from 2c52f24 to cba2e90 (2 revisions) (flutter/flutter#171775)

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
Please CC [email protected],[email protected] on the revert to ensure that a human
is aware of the problem.

To file a bug in Packages: 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

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request


          55af36a3d Replace [FinderBase] with [Finder] in the documentation of …

c17503c

…Matchers (flutter/flutter#168279)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request


          55af36a3d Replace [FinderBase] with [Finder] in the documentation of …

1a538ca

…Matchers (flutter/flutter#168279)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request


          55af36a3d Replace [FinderBase] with [Finder] in the documentation of …

8ec5d7f

…Matchers (flutter/flutter#168279)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request


          55af36a3d Replace [FinderBase] with [Finder] in the documentation of …

ba6e19d

…Matchers (flutter/flutter#168279)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request


          55af36a3d Replace [FinderBase] with [Finder] in the documentation of …

f27c92e

…Matchers (flutter/flutter#168279)

ksokolovskyi pushed a commit to ksokolovskyi/flutter that referenced this pull request


          Replace [FinderBase] with [Finder] in the documentation of Matchers (f…

985dea7

…lutter#168279)

Replace [FinderBase] with [Finder] in the doc comments of Matchers.

Closes flutter#168230

lucaantonelli pushed a commit to lucaantonelli/flutter that referenced this pull request


          Replace [FinderBase] with [Finder] in the documentation of Matchers (f…

c47fdae

…lutter#168279)

Replace [FinderBase] with [Finder] in the doc comments of Matchers.

Closes flutter#168230

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

a: tests framework