Add the focus state related methods to the platform dispatcher #49841

tugorez · 2024-01-17T20:22:27Z

This change augments the platform dispatcher to allow the engine <===> framework to communicate flutter and platform focus changes.

Relevant Issues are:

Design doc link: https://github.com/flutter/website/actions/runs/7560898849/job/20588395967
Design doc: Focus management flutter#141711
Focus in web multiview: [web:multi-view] Make keyboard and focus multi-view aware flutter#137443

Pre-launch Checklist

I read the Contributor Guide and followed the process outlined there for submitting PRs.
I read the Tree Hygiene wiki page, which explains my responsibilities.
I read and followed the Flutter Style Guide and the C++, Objective-C, Java style guides.
I listed at least one issue that this PR fixes in the description above.
I added new tests to check the change I am making or feature I am adding, or the PR is test-exempt. See testing the engine for instructions on writing and running engine tests.
I updated/added relevant documentation (doc comments with ///).
I signed the CLA.
All existing and new tests are passing.

If you need help, consider asking for advice on the #hackers-new channel on Discord.

flutter-dashboard · 2024-01-18T22:29:01Z

It looks like this pull request may not have tests. Please make sure to add tests before merging. If you need an exemption to this rule, contact "@test-exemption-reviewer" in the #hackers channel in Chat (don't just cc them here, they won't see it! Use Discord!).

If you are not sure if you need tests, consider this rule of thumb: the purpose of a test is to make sure someone doesn't accidentally revert the fix. Ask yourself, is there anything in your PR that you feel it is important we not accidentally revert back to how it was before your fix?

Reviewers: Read the Tree Hygiene page and make sure this patch meets those guidelines before LGTMing.

lib/ui/platform_dispatcher.dart

goderbauer

I like the structure of this API now. I mostly have suggestions for improving the docs.

@gspencergoog Should also take a look at this in case he ends up implementing the framework side that will consume this API.

lib/ui/platform_dispatcher.dart

lib/web_ui/lib/src/engine/platform_dispatcher.dart

goderbauer

API LGTM

lib/ui/platform_dispatcher.dart

lib/web_ui/test/engine/platform_dispatcher/platform_dispatcher_test.dart

lib/ui/platform_dispatcher.dart

+
+/// Represents the focus state of a given [FlutterView].
+///
+/// This enum will be associated with a [FlutterView] by instantiating a [ViewFocusEvent].


…her (flutter/engine#49841)

zanderso · 2024-02-02T02:56:58Z

This PR is causing analysis to fail in snippet code on rolling to the framework: https://ci.chromium.org/ui/p/flutter/builders/try/Linux%20analyze/73029/overview. I added the revert tag.

zanderso · 2024-02-02T02:57:25Z

RUNNING: cd .; bin/cache/dart-sdk/bin/dart --enable-asserts /b/s/w/ir/x/w/flutter/dev/bots/analyze_snippet_code.dart --verbose
workingDirectory: /b/s/w/ir/x/w/flutter, executable: /b/s/w/ir/x/w/flutter/bin/cache/dart-sdk/bin/dart, arguments: [--enable-asserts, /b/s/w/ir/x/w/flutter/dev/bots/analyze_snippet_code.dart, --verbose]
bin/cache/pkg/sky_engine/lib/ui/platform_dispatcher.dart:320:7: The function 'ViewFocusEvent' isn't defined (expression) (undefined_function)
bin/cache/pkg/sky_engine/lib/ui/platform_dispatcher.dart:322:16: Undefined name 'ViewFocusState' (expression) (undefined_identifier)
bin/cache/pkg/sky_engine/lib/ui/platform_dispatcher.dart:323:20: Undefined name 'ViewFocusDirection' (expression) (undefined_identifier)
bin/cache/pkg/sky_engine/lib/ui/platform_dispatcher.dart:338:7: The function 'ViewFocusEvent' isn't defined (expression) (undefined_function)
bin/cache/pkg/sky_engine/lib/ui/platform_dispatcher.dart:340:16: Undefined name 'ViewFocusState' (expression) (undefined_identifier)
bin/cache/pkg/sky_engine/lib/ui/platform_dispatcher.dart:341:20: Undefined name 'ViewFocusDirection' (expression) (undefined_identifier)
bin/cache/pkg/sky_engine/lib/ui/platform_dispatcher.dart:376:16: Undefined name 'ViewFocusSate' (statement) (undefined_identifier)
bin/cache/pkg/sky_engine/lib/ui/platform_dispatcher.dart:377:20: Undefined name 'ViewFocusDirection' (statement) (undefined_identifier)
Found 8 snippet code errors.
See the documentation at the top of dev/bots/analyze_snippet_code.dart for details.

#49841)" This reverts commit 1312954.

…er" (#50268) Reverts #49841 Initiated by: zanderso This change reverts the following previous change: Original Description: This change augments the platform dispatcher to allow the engine <===> framework to communicate flutter and platform focus changes. Relevant Issues are: * Design doc link: https://github.com/flutter/website/actions/runs/7560898849/job/20588395967 * Design doc: flutter/flutter#141711 * Focus in web multiview: flutter/flutter#137443 [C++, Objective-C, Java style guides]: https://github.com/flutter/engine/blob/main/CONTRIBUTING.md#style

…her (flutter/engine#49841)

tugorez · 2024-02-02T03:58:54Z

This PR is causing analysis to fail in snippet code on rolling to the framework: https://ci.chromium.org/ui/p/flutter/builders/try/Linux%20analyze/73029/overview. I added the revert tag.

Oops, thanks for catching this. @zanderso is there any reason we don't have those linter checks enabled as part of the engine commit process?

…142783) flutter/engine@dd4c79a...b35153d 2024-02-02 skia-flutter-autoroll@skia.org Manual roll Dart SDK from 82936dcdaf4f to 5a5d4c262200 (2 revisions) (flutter/engine#50264) 2024-02-01 dkwingsmt@users.noreply.github.com Remove number of arguments from defining Dart FFI (flutter/engine#50153) 2024-02-01 32242716+ricardoamador@users.noreply.github.com Refactor the linux_android targets to make use of recent changes to android virtual device params (flutter/engine#50099) 2024-02-01 goderbauer@google.com Re-add tests deleted on accident (flutter/engine#50223) 2024-02-01 30870216+gaaclarke@users.noreply.github.com [Impeller] updated todos from opengles golden work (flutter/engine#50218) 2024-02-01 flar@google.com Get bounds from RTree in DLBuilder::Build() (flutter/engine#50253) 2024-02-01 chinmaygarde@google.com [Impeller] Remove unused define. (flutter/engine#50250) 2024-02-01 tugorez@users.noreply.github.com Add the focus state related methods to the platform dispatcher (flutter/engine#49841) 2024-02-01 jason-simmons@users.noreply.github.com Fix the output paths of the Web esbuild GN template (flutter/engine#50188) 2024-02-01 chinmaygarde@google.com [Impeller] Delete unnecessary special casing for Vulkan in framebuffer fetch. (flutter/engine#50251) If this roll has caused a breakage, revert this CL and stop the roller using the controls here: https://autoroll.skia.org/r/flutter-engine-flutter-autoroll Please CC matanl@google.com,rmistry@google.com,zra@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

tugorez · 2024-02-02T05:08:29Z

This PR is causing analysis to fail in snippet code on rolling to the framework: https://ci.chromium.org/ui/p/flutter/builders/try/Linux%20analyze/73029/overview. I added the revert tag.

Oops, thanks for catching this. @zanderso is there any reason we don't have those linter checks enabled as part of the engine commit process?

Also is there an easy way to verify these things locally?

zanderso · 2024-02-02T15:38:55Z

I'm not familiar with how the snippet analysis is implemented. I vaguely recall that @gspencergoog might know more about this.

These changes were originally landed on #49841 but reverted in 0eb7b10. I fixed the offending dart snippets and (think) they now will work without issues (I think I was able to verify them locally by manually patching my bin/cache/... copy of these files with these changes). Relevant Issues are: * Design doc link: https://github.com/flutter/website/actions/runs/7560898849/job/20588395967 * Design doc: flutter/flutter#141711 * Focus in web multiview: flutter/flutter#137443 ## Pre-launch Checklist - [x] I read the [Contributor Guide] and followed the process outlined there for submitting PRs. - [x] I read the [Tree Hygiene] wiki page, which explains my responsibilities. - [x] I read and followed the [Flutter Style Guide] and the [C++, Objective-C, Java style guides]. - [x] I listed at least one issue that this PR fixes in the description above. - [x] I added new tests to check the change I am making or feature I am adding, or the PR is [test-exempt]. See [testing the engine] for instructions on writing and running engine tests. - [x] I updated/added relevant documentation (doc comments with `///`). - [x] I signed the [CLA]. - [x] All existing and new tests are passing. If you need help, consider asking for advice on the #hackers-new channel on [Discord].  [Contributor Guide]: https://github.com/flutter/flutter/wiki/Tree-hygiene#overview [Tree Hygiene]: https://github.com/flutter/flutter/wiki/Tree-hygiene [test-exempt]: https://github.com/flutter/flutter/wiki/Tree-hygiene#tests [Flutter Style Guide]: https://github.com/flutter/flutter/wiki/Style-guide-for-Flutter-repo [C++, Objective-C, Java style guides]: https://github.com/flutter/engine/blob/main/CONTRIBUTING.md#style [testing the engine]: https://github.com/flutter/flutter/wiki/Testing-the-engine [CLA]: https://cla.developers.google.com/ [flutter/tests]: https://github.com/flutter/tests [breaking change policy]: https://github.com/flutter/flutter/wiki/Tree-hygiene#handling-breaking-changes [Discord]: https://github.com/flutter/flutter/wiki/Chat

gspencergoog · 2024-02-05T19:20:36Z

Snippet analysis happens in dev/bots/analyze_snippet_code.dart in the flutter repo. You can run it locally, but you'd have to (manually?) put the engine artifacts into the cache directory of your local flutter repo for it to catch these.

Perhaps that script should be added as part of the presumbits that the engine runs on the Flutter repo?

…0177) Make the flutter web engine publish view focus events. Relevant Issues are: * Design doc link: https://github.com/flutter/website/actions/runs/7560898849/job/20588395967 * Design doc: flutter/flutter#141711 * Focus in web multiview: flutter/flutter#137443 * Platform dispatcher changes: #49841 [C++, Objective-C, Java style guides]: https://github.com/flutter/engine/blob/main/CONTRIBUTING.md#style

#50533) Rename [ViewFocusDirection.backwards] to [ViewFocusDirection.backward] Relevant Issues are: Design doc link: https://github.com/flutter/website/actions/runs/7560898849/job/20588395967 Design doc: flutter/flutter#141711 Focus in web multiview: flutter/flutter#137443 Platform dispatcher changes: #49841 [C++, Objective-C, Java style guides]: https://github.com/flutter/engine/blob/main/CONTRIBUTING.md#style

Move the accesibility placeholder to the platform dispatcher. This change makes the platform dispatcher append a single accesibility placeholder, per app, to the `<body />`. Previous behavior was to insert a placeholder inside each `<flutter-view />` Relevant Issues are: * Design doc: https://flutter.dev/go/focus-management * Focus in web multiview: flutter/flutter#137443 * Platform dispatcher changes: #49841 [C++, Objective-C, Java style guides]: https://github.com/flutter/engine/blob/main/CONTRIBUTING.md#style

…#50610) Make the view focus binding report focus transitions across elements. Previously the web engine reported all the focusin/focusout events as if the elements were first blurred before moving the focus. Relevant Issues are: * Design doc: https://flutter.dev/go/focus-management * Focus in web multiview: flutter/flutter#137443 * Platform dispatcher changes: #49841 [C++, Objective-C, Java style guides]: https://github.com/flutter/engine/blob/main/CONTRIBUTING.md#style

Add view focus direction detection to flutter web. Relevant Issues are: * Design doc: https://flutter.dev/go/focus-management * Focus in web multiview: flutter/flutter#137443 * Platform dispatcher changes: #49841 [C++, Objective-C, Java style guides]: https://github.com/flutter/engine/blob/main/CONTRIBUTING.md#style

Prepends the accesibility placeholder. Previously it was being appended (last child) to the body. Relevant Issues are: * Design doc: https://flutter.dev/go/focus-management * Focus in web multiview: flutter/flutter#137443 * Platform dispatcher changes: #49841 [C++, Objective-C, Java style guides]: https://github.com/flutter/engine/blob/main/CONTRIBUTING.md#style

) Mark the Flutter View as focusable by setting a tabindex value. * When a given flutter view is focused its tabindex will be `-1` * When a given flutter view is not focused its tabindex will be `0` * When semantics are enabled no tabindex will be set. Relevant Issues are: * Design doc: https://flutter.dev/go/focus-management * Focus in web multiview: flutter/flutter#137443 * Platform dispatcher changes: #49841 [C++, Objective-C, Java style guides]: https://github.com/flutter/engine/blob/main/CONTRIBUTING.md#style

Implement PlatformDispatcher.requestViewFocusChange on web. Relevant Issues are: * Design doc: https://flutter.dev/go/focus-management * Focus in web multiview: flutter/flutter#137443 * Platform dispatcher changes: #49841 [C++, Objective-C, Java style guides]: https://github.com/flutter/engine/blob/main/CONTRIBUTING.md#style

tugorez marked this pull request as ready for review January 18, 2024 21:56

tugorez changed the title ~~Add the focus view change and focus state change classes~~ Add the focus state related methods to the platform dispatcher Jan 18, 2024

yjbanov reviewed Jan 18, 2024

View reviewed changes

yjbanov reviewed Jan 22, 2024

View reviewed changes

lib/ui/platform_dispatcher.dart Outdated Show resolved Hide resolved

goderbauer reviewed Jan 23, 2024

View reviewed changes

lib/ui/platform_dispatcher.dart Outdated Show resolved Hide resolved

lib/ui/platform_dispatcher.dart Outdated Show resolved Hide resolved

goderbauer reviewed Jan 25, 2024

View reviewed changes

goderbauer requested a review from gspencergoog January 25, 2024 18:36

github-actions bot added the platform-web Code specifically for the web engine label Jan 29, 2024

tugorez mentioned this pull request Jan 30, 2024

Make the web engine publish view forward focus and unfocus events #50177

Merged

8 tasks

gspencergoog reviewed Jan 31, 2024

View reviewed changes

goderbauer reviewed Jan 31, 2024

View reviewed changes

lib/ui/platform_dispatcher.dart Outdated Show resolved Hide resolved

lib/ui/platform_dispatcher.dart Outdated Show resolved Hide resolved

lib/ui/platform_dispatcher.dart Outdated Show resolved Hide resolved

lib/ui/platform_dispatcher.dart Outdated Show resolved Hide resolved

yjbanov reviewed Jan 31, 2024

View reviewed changes

yjbanov approved these changes Feb 1, 2024

View reviewed changes

Add the focus management API to the platform dispatcher

9402b43

tugorez merged commit 1312954 into flutter:main Feb 1, 2024
26 checks passed

tugorez deleted the focus-management branch February 1, 2024 21:20

engine-flutter-autoroll mentioned this pull request Feb 1, 2024

Roll Flutter Engine from dd4c79a6c864 to 63bcc15738cb (7 revisions) flutter/flutter#142761

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Feb 1, 2024

1312954e5 Add the focus state related methods to the platform dispatc…

8ebbb90

…her (flutter/engine#49841)

engine-flutter-autoroll mentioned this pull request Feb 2, 2024

Roll Flutter Engine from dd4c79a6c864 to d0db4c496c7e (8 revisions) flutter/flutter#142773

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Feb 2, 2024

1312954e5 Add the focus state related methods to the platform dispatc…

d41a53a

…her (flutter/engine#49841)

engine-flutter-autoroll mentioned this pull request Feb 2, 2024

Roll Flutter Engine from dd4c79a6c864 to e61d08a7fe82 (9 revisions) flutter/flutter#142778

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Feb 2, 2024

1312954e5 Add the focus state related methods to the platform dispatc…

d385df2

…her (flutter/engine#49841)

zanderso added the revert Label used to revert changes in a closed and merged pull request. label Feb 2, 2024

auto-submit bot pushed a commit that referenced this pull request Feb 2, 2024

Revert "Add the focus state related methods to the platform dispatcher (

e63519f

#49841)" This reverts commit 1312954.

auto-submit bot mentioned this pull request Feb 2, 2024

Reverts "Add the focus state related methods to the platform dispatcher" #50268

Merged

8 tasks

auto-submit bot removed the revert Label used to revert changes in a closed and merged pull request. label Feb 2, 2024

engine-flutter-autoroll mentioned this pull request Feb 2, 2024

Roll Flutter Engine from dd4c79a6c864 to b35153d00b2e (10 revisions) flutter/flutter#142783

Merged

engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Feb 2, 2024

1312954e5 Add the focus state related methods to the platform dispatc…

d4cba19

…her (flutter/engine#49841)

tugorez mentioned this pull request Feb 2, 2024

Add the focus state related methods to the platform dispatcher #50273

Merged

8 tasks

tugorez mentioned this pull request Feb 2, 2024

Copy the analyze_snippet_code.dart script in the engine repo and make it a PR blocker. flutter/flutter#142834

Open

tugorez mentioned this pull request Feb 10, 2024

Rename [ViewFocusDirection.backwards] to [ViewFocusDirection.backward] #50533

Merged

8 tasks

This was referenced Feb 13, 2024

Move the accesibility placeholder to the platform dispatcher. #50608

Merged

Make the view focus binding report focus transitions across elements. #50610

Merged

Implement PlatformDispatcher.requestViewFocusChange on web. #50535

Merged

tugorez mentioned this pull request Feb 21, 2024

Add view focus direction detection to flutter web. #50843

Merged

8 tasks

This was referenced Feb 23, 2024

Mark the Flutter Views as focusable by setting a tabindex value. #50876

Merged

Prepend the accessibility placeholder #51050

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add the focus state related methods to the platform dispatcher #49841

Add the focus state related methods to the platform dispatcher #49841

tugorez commented Jan 17, 2024

flutter-dashboard bot commented Jan 18, 2024

goderbauer left a comment

goderbauer left a comment

This comment was marked as resolved.

zanderso commented Feb 2, 2024

zanderso commented Feb 2, 2024

tugorez commented Feb 2, 2024

tugorez commented Feb 2, 2024

zanderso commented Feb 2, 2024

gspencergoog commented Feb 5, 2024

Add the focus state related methods to the platform dispatcher #49841

Add the focus state related methods to the platform dispatcher #49841

Conversation

tugorez commented Jan 17, 2024

Pre-launch Checklist

flutter-dashboard bot commented Jan 18, 2024

goderbauer left a comment

Choose a reason for hiding this comment

goderbauer left a comment

Choose a reason for hiding this comment

This comment was marked as resolved.

zanderso commented Feb 2, 2024

zanderso commented Feb 2, 2024

tugorez commented Feb 2, 2024

tugorez commented Feb 2, 2024

zanderso commented Feb 2, 2024

gspencergoog commented Feb 5, 2024