[Embedder API] Introduce new update semantics callback #39807

loic-sharma · 2023-02-23T00:52:01Z

This introduces a new update semantics embedder API that is identical to the previous update semantics embedder API, except that its ABI is stable as:

The callback uses array of pointers to structs instead of array of structs. This ensures that array indexing does not break if new members are added to the structs.
The types FlutterSemanticsNode and FlutterSemanticsCustomAction were duplicated as FlutterSemanticsNode2 and FlutterSemanticsCustomAction2. This is necessary as FlutterSemanticsUpdate has an array of FlutterSemanticsNode and an array of FlutterSemanticsCustomAction. Adding new members to these structs would break the ABI compatibility of array indexing.

This change does not migrate embedders to this new embedder API, this will be done in subsequent changes: flutter/flutter#121176.

Part of: flutter/flutter#121176
See go/flutter-semantics-abi.

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 Hixie said 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.

shell/platform/embedder/tests/embedder_a11y_unittests.cc

shell/platform/embedder/embedder.h

yaakovschectman

Makes sense

cbracken

Overall looks good - mostly nitpicks.

shell/platform/common/accessibility_bridge.h

shell/platform/embedder/embedder.h

chunhtai

LGTM

shell/platform/common/accessibility_bridge.cc

loic-sharma · 2023-03-13T23:51:59Z

@cbracken and @chinmaygarde This is ready for review. Please take your time as I'd like to make sure there aren't any further embedder API mistakes :)

cbracken

lgtm with a teensy nit.

shell/platform/embedder/embedder.cc

This introduces a new update semantics embedder API that is identical to the previous update semantics embedder API, except that its ABI is stable as: 1. The callback uses array of pointers to structs instead of array of structs. This ensures that array indexing does not break if new members are added to the structs. 2. The types `FlutterSemanticsNode` and `FlutterSemanticsCustomAction` were duplicated as `FlutterSemanticsNode2` and `FlutterSemanticsCustomAction2`. This is necessary as `FlutterSemanticsUpdate` has an array of `FlutterSemanticsNode` and an array of `FlutterSemanticsCustomAction`. Adding new members to these structs would break the ABI compatibility of array indexing. This change does not migrate embedders to this new embedder API, this will be done in subsequent changes: flutter/flutter#121176. Part of: flutter/flutter#121176

…tter/engine#39807)

This moves the Windows embedder to the new update semantics embedder API introduced by flutter#39807. This does not affect functionality hence why existing accessibility integration tests are unaffected. Part of: flutter/flutter#121176

The old "update semantics" embedder API was deprecated as it could not guarantee ABI stability (see flutter/flutter#121176). It was replaced by a new embedder API (flutter#39807) and all affected embedders were migrated to this new embedder API (flutter#40072, flutter#40584). This change: 1. Removes plumbing that was used for the old "update semantics" embedder API 2. Moves all remaining tests to the types used by the new "update semantics" embedder API Completes: flutter/flutter#121176

flutter-dashboard bot added the embedder Related to the embedder API label Feb 23, 2023

loic-sharma commented Feb 23, 2023

View reviewed changes

shell/platform/embedder/tests/embedder_a11y_unittests.cc Outdated Show resolved Hide resolved

loic-sharma changed the title ~~[Embedder API] Introduce new update semantics callback~~ [WIP][Embedder API] Introduce new update semantics callback Feb 23, 2023

loic-sharma added the Work in progress (WIP) Not ready (yet) for review! label Feb 23, 2023

loic-sharma mentioned this pull request Feb 23, 2023

[Embedder API] Fix ABI stability of the update semantics API flutter/flutter#121176

Closed

8 tasks

loic-sharma force-pushed the update_semantics_2 branch 3 times, most recently from 7a23da1 to a11389e Compare March 3, 2023 01:01

loic-sharma force-pushed the update_semantics_2 branch from 63a6402 to 24f4a04 Compare March 3, 2023 22:09

loic-sharma changed the title ~~[WIP][Embedder API] Introduce new update semantics callback~~ [Embedder API] Introduce new update semantics callback Mar 3, 2023

loic-sharma removed the Work in progress (WIP) Not ready (yet) for review! label Mar 3, 2023

loic-sharma marked this pull request as ready for review March 3, 2023 22:59

loic-sharma requested a review from chinmaygarde as a code owner March 3, 2023 22:59

loic-sharma requested review from yaakovschectman, chunhtai and cbracken March 3, 2023 22:59

loic-sharma force-pushed the update_semantics_2 branch 2 times, most recently from f9359c8 to 4d30835 Compare March 4, 2023 01:02

loic-sharma mentioned this pull request Mar 4, 2023

[Windows] Use the new update semantics embedder API #40072

Merged

8 tasks

yaakovschectman reviewed Mar 6, 2023

View reviewed changes

shell/platform/embedder/embedder.h Show resolved Hide resolved

yaakovschectman approved these changes Mar 6, 2023

View reviewed changes

cbracken reviewed Mar 7, 2023

View reviewed changes

loic-sharma force-pushed the update_semantics_2 branch 3 times, most recently from ebe42f0 to 2b36fe3 Compare March 10, 2023 19:27

chunhtai approved these changes Mar 10, 2023

View reviewed changes

shell/platform/common/accessibility_bridge.cc Show resolved Hide resolved

loic-sharma force-pushed the update_semantics_2 branch from 2b36fe3 to 68a0c95 Compare March 13, 2023 17:18

cbracken approved these changes Mar 20, 2023

View reviewed changes

shell/platform/embedder/embedder.cc Show resolved Hide resolved

shell/platform/embedder/embedder.cc Outdated Show resolved Hide resolved

loic-sharma force-pushed the update_semantics_2 branch from 68a0c95 to 32ea99e Compare March 20, 2023 18:33

loic-sharma force-pushed the update_semantics_2 branch from 2fb35e6 to c3fd36f Compare March 20, 2023 19:58

loic-sharma force-pushed the update_semantics_2 branch from c3fd36f to 347850f Compare March 21, 2023 18:58

Use software rendering

936c2ea

loic-sharma added the autosubmit Merge PR when tree becomes green via auto submit App label Mar 22, 2023

auto-submit bot merged commit 6597218 into flutter:main Mar 22, 2023

engine-flutter-autoroll mentioned this pull request Mar 22, 2023

Roll Flutter Engine from 619d721c3686 to 659721823be3 (9 revisions) flutter/flutter#123177

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Mar 22, 2023

659721823 [Embedder API] Introduce new update semantics callback (flu…

f6bab60

…tter/engine#39807)

engine-flutter-autoroll mentioned this pull request Mar 22, 2023

Roll Flutter Engine from 619d721c3686 to 62f284479485 (10 revisions) flutter/flutter#123178

Merged

engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Mar 22, 2023

659721823 [Embedder API] Introduce new update semantics callback (flu…

3e7df52

…tter/engine#39807)

loic-sharma mentioned this pull request Mar 23, 2023

[macOS] Use the new update semantics embedder API #40584

Merged

8 tasks

HansMuller mentioned this pull request Mar 24, 2023

Flutter Framework Team: Notable Commits flutter/flutter#121415

Closed

loic-sharma mentioned this pull request Mar 30, 2023

Complete the update semantics embedder API migration #40773

Merged

8 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[Embedder API] Introduce new update semantics callback #39807

[Embedder API] Introduce new update semantics callback #39807

Uh oh!

loic-sharma commented Feb 23, 2023 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

yaakovschectman left a comment

Uh oh!

cbracken left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

chunhtai left a comment

Uh oh!

Uh oh!

loic-sharma commented Mar 13, 2023

Uh oh!

cbracken left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

[Embedder API] Introduce new update semantics callback #39807

[Embedder API] Introduce new update semantics callback #39807

Uh oh!

Conversation

loic-sharma commented Feb 23, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pre-launch Checklist

Uh oh!

Uh oh!

Uh oh!

yaakovschectman left a comment

Choose a reason for hiding this comment

Uh oh!

cbracken left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

chunhtai left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

loic-sharma commented Mar 13, 2023

Uh oh!

cbracken left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

loic-sharma commented Feb 23, 2023 •

edited

Loading