Add bySemanticsIdentifier finder for finding by identifier
#155571
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
a: tests
admosity
force-pushed
the
feat/finders-by-semantics-identifier
branch
2 times, most recently
from
a5e90a6 to
bf2573e
Compare
admosity
force-pushed
the
feat/finders-by-semantics-identifier
branch
from
840c18f to
eaf1b53
Compare
admosity
force-pushed
the
feat/finders-by-semantics-identifier
branch
from
ba618eb to
4ecb985
Compare
Contributor
nate-thegrate
left a comment
nate-thegrate
left a comment
There was a problem hiding this comment.
Thanks for adding this, looks fantastic overall!
Just have a bunch of whitespace suggestions :)
admosity
force-pushed
the
feat/finders-by-semantics-identifier
branch
from
f7b0b6e to
cfb1cc4
Compare
nate-thegrate
approved these changes
Sep 24, 2024
Contributor
nate-thegrate
left a comment
nate-thegrate
left a comment
There was a problem hiding this comment.
LGTM, thanks for making this addition!
chunhtai
reviewed
Sep 30, 2024
| /// If the `skipOffstage` argument is true (the default), then this skips | ||
| /// nodes that are [Offstage] or that are from inactive [Route]s. | ||
| Finder bySemanticsIdentifier(Pattern identifier, {bool skipOffstage = true}) { | ||
| if (!SemanticsBinding.instance.semanticsEnabled) { |
Contributor
There was a problem hiding this comment.
Can you refactor some code with the bySemanticsLabel, a big portion is duplicated
admosity
force-pushed
the
feat/finders-by-semantics-identifier
branch
2 times, most recently
from
85bf918 to
6761175
Compare
admosity
force-pushed
the
feat/finders-by-semantics-identifier
branch
from
d39640b to
aaf6632
Compare
…ics widgets
- Introduce `CommonFinders.bySemanticsIdentifier` to enable finding Semantics widgets by their `identifier`.
- Update `semantics.dart` documentation to include usage of the new finder.
- Add comprehensive tests in `finders_test.dart` to verify functionality with both exact strings and regular expressions.
Sample usage:
```dart
expect(find.bySemanticsIdentifier('Back'), findsOneWidget);
expect(find.bySemanticsIdentifier(RegExp(r'^item-')), findsNWidgets(2));
```
Co-authored-by: Nate Wilson <[email protected]>
- Refactored `bySemanticsLabel` and `bySemanticsIdentifier` methods to use a common private method `_bySemanticsProperty`. - Improved code readability and reduced duplication by extracting common logic for semantics property retrieval. - Updated parameter names for consistency and clarity.
Renamed the parameter `pattern` to `label` in the `bySemanticsLabel` method and `pattern` to `identifier` in the `bySemanticsIdentifier` method.
admosity
force-pushed
the
feat/finders-by-semantics-identifier
branch
from
aaf6632 to
f72f56e
Compare
Contributor
|
We good here @chunhtai ? |
chunhtai
added
the
autosubmit
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/packages
that referenced
this pull request
Oct 8, 2024
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/packages
that referenced
this pull request
Oct 8, 2024
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/packages
that referenced
this pull request
Oct 9, 2024
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/packages
that referenced
this pull request
Oct 9, 2024
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/packages
that referenced
this pull request
Oct 9, 2024
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/packages
that referenced
this pull request
Oct 9, 2024
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/packages
that referenced
this pull request
Oct 9, 2024
auto-submit bot
pushed a commit
to flutter/packages
that referenced
this pull request
Oct 9, 2024
Roll Flutter from 0917e9d to 2d45fb3 (50 revisions) flutter/flutter@0917e9d...2d45fb3 2024-10-09 [email protected] Roll Flutter Engine from 4a97943e0556 to fb0b59d9438b (3 revisions) (flutter/flutter#156487) 2024-10-09 [email protected] Roll Flutter Engine from db0c0b7ca428 to 4a97943e0556 (9 revisions) (flutter/flutter#156478) 2024-10-09 [email protected] Roll Packages from 8fbf4cd to 9d00fb1 (9 revisions) (flutter/flutter#156477) 2024-10-09 [email protected] Started handling duplicate validation layer messages (flutter/flutter#156375) 2024-10-09 [email protected] Roll Flutter Engine from 0e7344ae240d to db0c0b7ca428 (4 revisions) (flutter/flutter#156443) 2024-10-09 98614782+auto-submit[bot]@users.noreply.github.com Reverts "Roll pub packages (#156440)" (flutter/flutter#156473) 2024-10-08 [email protected] Roll Flutter Engine from ea4a00f1c123 to 0e7344ae240d (4 revisions) (flutter/flutter#156435) 2024-10-08 [email protected] Roll pub packages (flutter/flutter#156440) 2024-10-08 [email protected] Roll pub packages (flutter/flutter#156284) 2024-10-08 [email protected] [tool] Update description of where to install platforms in XCode (flutter/flutter#156432) 2024-10-08 [email protected] Roll Flutter Engine from 167a42e50fa2 to ea4a00f1c123 (1 revision) (flutter/flutter#156433) 2024-10-08 [email protected] Normalize `ThemeData.tabBarTheme` (flutter/flutter#156253) 2024-10-08 [email protected] Roll Flutter Engine from 82c1dfcf588c to 167a42e50fa2 (3 revisions) (flutter/flutter#156428) 2024-10-08 [email protected] Update MenuAnchor API examples (flutter/flutter#156404) 2024-10-08 [email protected] Roll Dartdoc to 8.2.0 (flutter/flutter#156426) 2024-10-08 [email protected] Add `bySemanticsIdentifier` finder for finding by identifier (flutter/flutter#155571) 2024-10-08 [email protected] Update `DropdownMenu` tests to remove some dependence on platforms (flutter/flutter#156131) 2024-10-08 [email protected] Roll Packages from bb00d34 to 8fbf4cd (10 revisions) (flutter/flutter#156407) 2024-10-08 [email protected] Roll Flutter Engine from bf21ee76f585 to 82c1dfcf588c (1 revision) (flutter/flutter#156406) 2024-10-08 [email protected] NavigatorPopHandler.onPopWithResult (flutter/flutter#155618) 2024-10-08 [email protected] Roll Flutter Engine from 8ec95fe63f2d to bf21ee76f585 (1 revision) (flutter/flutter#156402) 2024-10-08 [email protected] Roll Flutter Engine from 9306456e2532 to 8ec95fe63f2d (1 revision) (flutter/flutter#156401) 2024-10-08 [email protected] Roll Flutter Engine from 7e8011f3cc8e to 9306456e2532 (1 revision) (flutter/flutter#156398) 2024-10-08 [email protected] Migrator for android 35/16kb page size cmake flags for plugin_ffi (flutter/flutter#156221) 2024-10-08 [email protected] Roll Flutter Engine from 33c1a6a16e81 to 7e8011f3cc8e (5 revisions) (flutter/flutter#156392) 2024-10-08 [email protected] Update `flexible_space_bar_test.dart` tests for Material 3 (flutter/flutter#156226) 2024-10-08 [email protected] Roll Flutter Engine from 012029ee19f3 to 33c1a6a16e81 (1 revision) (flutter/flutter#156390) 2024-10-08 [email protected] Roll Flutter Engine from 5923a8b3e632 to 012029ee19f3 (1 revision) (flutter/flutter#156388) 2024-10-08 [email protected] Roll Flutter Engine from fd1ccdb95e03 to 5923a8b3e632 (1 revision) (flutter/flutter#156386) 2024-10-08 [email protected] Roll Flutter Engine from 07c702f2d79b to fd1ccdb95e03 (1 revision) (flutter/flutter#156384) 2024-10-08 [email protected] Roll Flutter Engine from e096ddb3091e to 07c702f2d79b (2 revisions) (flutter/flutter#156379) 2024-10-08 [email protected] [tool] Emit a deprecation warning for some values of --web-renderer. (flutter/flutter#156376) 2024-10-08 [email protected] Roll Flutter Engine from 427302eafdda to e096ddb3091e (2 revisions) (flutter/flutter#156372) 2024-10-07 [email protected] Roll Flutter Engine from e84e30357ccc to 427302eafdda (3 revisions) (flutter/flutter#156364) 2024-10-07 49699333+dependabot[bot]@users.noreply.github.com Bump actions/checkout from 4.2.0 to 4.2.1 (flutter/flutter#156366) 2024-10-07 [email protected] Clarify when `override: no versioning needed` label should be applied (flutter/flutter#156342) 2024-10-07 [email protected] Roll Flutter Engine from 0c9d3f11f098 to e84e30357ccc (3 revisions) (flutter/flutter#156356) 2024-10-07 [email protected] Fixes an issue where onTapOutside was incorrectly triggered across routes in TapRegion (flutter/flutter#155297) 2024-10-07 [email protected] Update 'dump-info' usage for dart2js builds (flutter/flutter#156187) 2024-10-07 [email protected] Roll Flutter Engine from ffacad996f1f to 0c9d3f11f098 (2 revisions) (flutter/flutter#156347) 2024-10-07 [email protected] handle any `RPCError` due to vm service disconnection in `flutter run` (flutter/flutter#156346) 2024-10-07 [email protected] Roll Flutter Engine from 683a14c1f1be to ffacad996f1f (1 revision) (flutter/flutter#156339) 2024-10-07 [email protected] Roll Flutter Engine from 8e46a7670b94 to 683a14c1f1be (1 revision) (flutter/flutter#156323) 2024-10-07 [email protected] Roll Packages from 05bf1d4 to bb00d34 (8 revisions) (flutter/flutter#156322) 2024-10-07 [email protected] Fix `DropdownMenu` with `expandedInsets` always aligned on top (flutter/flutter#156214) 2024-10-07 [email protected] Roll Flutter Engine from a190ab54ce07 to 8e46a7670b94 (2 revisions) (flutter/flutter#156311) ...
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/packages
that referenced
this pull request
Dec 11, 2024
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/packages
that referenced
this pull request
Dec 12, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add
bySemanticsIdentifierfinder for finding by identifierDescription
This pull request introduces a new finder,
CommonFinders.bySemanticsIdentifier, to the Flutter testing framework. This finder allows developers to locateSemanticswidgets based on theiridentifierproperty, enhancing the precision and flexibility of widget tests.Motivation
Establish a consistent and reliable method for locating elements in integration and end-to-end (e2e) tests. Unlike
labelorkey, which may carry functional significance within the application, theidentifieris purely declarative and does not impact functionality. Utilizing theidentifierfor finding semantics widgets ensures that tests can target specific elements without interfering with the app's behavior, thereby enhancing test reliability, maintainability, and reusability across testing frameworks.Changes
semantics.dart
identifiercan be matched usingCommonFinders.bySemanticsIdentifier.finders.dart
bySemanticsIdentifiermethod toCommonFinders.finders_test.dart
bySemanticsIdentifiercorrectly finds widgets by exact identifier and regex patterns.Usage
Developers can use the new finder in their tests as follows: