Add a proc table version of embedder API #21813

stuartmorgan · 2020-10-13T17:17:50Z

Description

Adds the ability to use the embedder API via a proc table rather than declared functions. This allows embeddings/embedders who choose to use that version to easily do unit testing with mock and/or fake engine implementations.

Also adds a supporting macro to facilitate writing mock replacements in unit tests.

Related Issues

flutter/flutter#66935

Tests

I added the following tests: None

Checklist

Before you create this PR confirm that it meets all requirements listed below by checking the relevant checkboxes ([x]). This will ensure a smooth and quick review process.

I read the contributor guide and followed the process outlined there for submitting PRs.
I signed the CLA.
I read and followed the C++, Objective-C, Java style guides for the engine.
I read the tree hygiene wiki page, which explains my responsibilities.
I updated/added relevant documentation.
All existing and new tests are passing.
I am willing to follow-up on review comments in a timely manner.

Reviewer Checklist

I have submitted any presubmit flakes in this PR using the engine presubmit flakes form before re-triggering the failure.

Breaking Change

Did any tests fail when you ran them? Please read handling breaking changes.

No, no existing tests failed, so this is not a breaking change.
Yes, this is a breaking change.

flutter-dashboard · 2020-10-13T17:17:53Z

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 Hixie on the #hackers channel in Chat.

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

stuartmorgan · 2020-10-13T17:20:51Z

I realized when splitting it out that I wasn't explicitly testing the new surface, just implicitly via the macOS embedding. I'll add a new test target.

stuartmorgan · 2020-10-13T18:19:52Z

New test binary added; ready for full review.

chinmaygarde · 2020-10-16T17:20:36Z

shell/platform/embedder/embedder.cc

+  SET_PROC(post_callback_on_all_native_threads,
+           FlutterEnginePostCallbackOnAllNativeThreads);
+  SET_PROC(notify_display_update, FlutterEngineNotifyDisplayUpdate);
+#undef HAS_PROC


This undefs an unset macro. I think you meant SET_PROC.

🤦
Shame that's not a warning.

chinmaygarde · 2020-10-16T17:22:05Z

shell/platform/embedder/embedder_safe_access.h

@@ -7,21 +7,25 @@

 #include <type_traits>


This file should probably be called embedder_macros.h or something now. It has more than just the SAFE_ACCESS macro. We can do this in a separate patch.

Easily done in this patch.

shell/platform/embedder/embedder.h

shell/platform/embedder/embedder.cc

shell/platform/embedder/tests/embedder_unittests_proctable.cc

* 53d5d68 Add dart-lang/sdk's new package:clock dependency (flutter/engine#22142) * c32e3d8 Roll Skia from 7737a5bd2510 to 5567a6091ceb (8 revisions) (flutter/engine#22146) * 376045c Roll Fuchsia Linux SDK from XYN02FThN... to UKgKCjxSA... (flutter/engine#22147) * 03395de Roll Fuchsia Mac SDK from GKPwGj1Ux... to xHjtLQPQ5... (flutter/engine#22151) * 0c7e952 Manual Dart SDK roll 6e015bd9cddb to 9c6e76468ca4 (6 revisions (flutter/engine#22153) * e5f168a Update constraint to latest integration test (flutter/engine#22169) * e61e8c2 Smooth window resizing on macOS (flutter/engine#21525) * acece00 Allow parse_and_send to use access tokens (flutter/engine#22019) * 0270632 Includes roles for links, checkboxes, and radio buttons in semantics (flutter/engine#22061) * 632354d Roll Fuchsia Linux SDK from UKgKCjxSA... to PY5hNI-wY... (flutter/engine#22175) * 62d50af Add plumbing for command line arguments on Windows (flutter/engine#22094) * 06b0910 Fix possible use of std::moved value in Rasterizer (flutter/engine#22125) * 005dec4 [web] Clean up unused previousStyle logic (flutter/engine#22150) * ca05bdc Roll Skia from 5567a6091ceb to f548a028ce70 (7 revisions) (flutter/engine#22155) * 5b07ac4 Roll Fuchsia Mac SDK from xHjtLQPQ5... to ICK_JlnKJ... (flutter/engine#22188) * d615a97 Roll Fuchsia Linux SDK from PY5hNI-wY... to Usec4YBzR... (flutter/engine#22197) * 11ed711 Invalidate the cached SkParagraph font collection when a new font manager is installed (flutter/engine#22157) * 07c780b [web] Assign default natural width/height for svgs that report 0,0 on firefox and ie11 (flutter/engine#22184) * b54bb88 Migrate runZoned to runZonedGuarded (flutter/engine#22198) * 247139a [web] Fix transform not invalidating path bounds causing debugValidate failure (flutter/engine#22172) * e4dffc1 [web] Fix scroll wheel line delta on Firefox. (flutter/engine#21928) * d6627c6 Reland [ios] Refactor IOSSurface factory and unify surface creation (flutter/engine#22016) * ce1dd11 Standardize macro names for dartdoc macros (flutter/engine#22180) * f81bc37 [profiling] Handle thread_info to account for killed threads (flutter/engine#22170) * fd94c86 Fix for firefox custom clipping (flutter/engine#22182) * 9ccf9f1 bring back build_test to ensure we validate licenses (flutter/engine#22201) * 38f6665 Set strut font to Roboto if the given font hasn't been registered (flutter/engine#22129) * caf32d5 Add a proc table version of embedder API (flutter/engine#21813) * ed0f477 Use preTranslate when applying offset to matrix (flutter/engine#21648) * b457e2d Refactor make_mock_engine into fl_test (flutter/engine#21585) * 28497c8 Fix typos in FlValue docs (flutter/engine#21875) * bb32446 Fix FlTextInputPlugin tear down (flutter/engine#22007) * 7a7804b Add "input shield" to capture pointer input for reinjection (flutter/engine#22067) * fe85f94 Update painting.dart (flutter/engine#22195) * 99cc50d [ios] Surface factory holds the canonical reference to the external view embedder (flutter/engine#22206)

stuartmorgan added 2 commits October 13, 2020 10:12

Add a proc table version of embedder API

19d4a26

Add supporting macro for writing tests

0528b66

stuartmorgan requested a review from chinmaygarde October 13, 2020 17:17

googlebot added the cla: yes label Oct 13, 2020

stuartmorgan mentioned this pull request Oct 13, 2020

Switch macOS embedding to proc table embedder API #21811

Merged

10 tasks

Add a new test binary

7271a9c

stuartmorgan added 2 commits October 13, 2020 11:57

GN format

1a4b326

de-lint

fed4f5f

chinmaygarde reviewed Oct 16, 2020

View reviewed changes

stuartmorgan added 2 commits October 20, 2020 10:04

Improve copy/paste test

0302f33

Address review comments

c5a8407

chinmaygarde approved these changes Oct 26, 2020

View reviewed changes

stuartmorgan added 2 commits October 29, 2020 11:51

Merge branch 'master' into embedder-jump-table

43327ad

Work around Windows macro collision

bcbfdc0

stuartmorgan added the waiting for tree to go green This PR is approved and tested, but waiting for the tree to be green to land. label Oct 29, 2020

fluttergithubbot merged commit caf32d5 into flutter:master Oct 29, 2020

engine-flutter-autoroll mentioned this pull request Oct 29, 2020

Roll Engine from 073263e39d1d to fe85f946db04 (34 revisions) flutter/flutter#69343

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Oct 29, 2020

caf32d5 Add a proc table version of embedder API (flutter/engine#21813)

4bb5d0b

GaryQian mentioned this pull request Oct 29, 2020

Roll engine from 073263e39d1d to fe85f946db04 (34 revisions) manual flutter/flutter#69347

Closed

engine-flutter-autoroll mentioned this pull request Oct 29, 2020

Roll Engine from 073263e39d1d to fe85f946db04 (34 revisions) flutter/flutter#69349

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Oct 29, 2020

caf32d5 Add a proc table version of embedder API (flutter/engine#21813)

bad400a

engine-flutter-autoroll mentioned this pull request Oct 30, 2020

Roll Engine from 073263e39d1d to 99cc50dfffab (35 revisions) flutter/flutter#69353

Merged

engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Oct 30, 2020

caf32d5 Add a proc table version of embedder API (flutter/engine#21813)

4ef7fce

engine-flutter-autoroll mentioned this pull request Oct 30, 2020

Roll Engine from 073263e39d1d to 7d6180c3014a (37 revisions) flutter/flutter#69357

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Oct 30, 2020

caf32d5 Add a proc table version of embedder API (flutter/engine#21813)

08c6ac2

engine-flutter-autoroll mentioned this pull request Oct 30, 2020

Roll Engine from 99cc50dfffab1 to 7d6180c3014a (2 revisions) flutter/flutter#69365

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Oct 30, 2020

caf32d5 Add a proc table version of embedder API (flutter/engine#21813)

c153206

chaselatta pushed a commit to chaselatta/engine that referenced this pull request Nov 30, 2020

Add a proc table version of embedder API (flutter#21813)

3fec149

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add a proc table version of embedder API #21813

Add a proc table version of embedder API #21813

stuartmorgan commented Oct 13, 2020

flutter-dashboard bot commented Oct 13, 2020

stuartmorgan commented Oct 13, 2020

stuartmorgan commented Oct 13, 2020

chinmaygarde Oct 16, 2020

stuartmorgan Oct 20, 2020

chinmaygarde Oct 16, 2020

stuartmorgan Oct 20, 2020

Add a proc table version of embedder API #21813

Add a proc table version of embedder API #21813

Conversation

stuartmorgan commented Oct 13, 2020

Description

Related Issues

Tests

Checklist

Reviewer Checklist

Breaking Change

flutter-dashboard bot commented Oct 13, 2020

stuartmorgan commented Oct 13, 2020

stuartmorgan commented Oct 13, 2020

chinmaygarde Oct 16, 2020

Choose a reason for hiding this comment

stuartmorgan Oct 20, 2020

Choose a reason for hiding this comment

chinmaygarde Oct 16, 2020

Choose a reason for hiding this comment

stuartmorgan Oct 20, 2020

Choose a reason for hiding this comment