Skip to content

Commit 7690086

Browse files
committed
Migrate the shell unit tests from legacy Dart native functions to FFI
This adds a CREATE_FFI_LAMBDA macro that can be used to register a lambda as a Dart FFI function (similar to how CREATE_NATIVE_ENTRY works for the old native function API). The native functions also had to be ported from the Dart_NativeArguments API to FFI-style function signatures. See flutter#190154
1 parent 88b4103 commit 7690086

8 files changed

Lines changed: 326 additions & 364 deletions

File tree

‎engine/src/flutter/shell/common/animator_unittests.cc‎

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -57,14 +57,12 @@ TEST_F(ShellTest, VSyncTargetTime) {
5757
int64_t target_time;
5858
fml::AutoResetWaitableEvent on_target_time_latch;
5959
auto nativeOnBeginFrame = [&on_target_time_latch,
60-
&target_time](Dart_NativeArguments args) {
61-
Dart_Handle exception = nullptr;
62-
target_time =
63-
tonic::DartConverter<int64_t>::FromArguments(args, 0, exception);
60+
&target_time](int64_t microseconds) {
61+
target_time = microseconds;
6462
on_target_time_latch.Signal();
6563
};
66-
AddNativeCallback("NativeOnBeginFrame",
67-
CREATE_NATIVE_ENTRY(nativeOnBeginFrame));
64+
AddFfiNativeCallback("NativeOnBeginFrame",
65+
CREATE_FFI_LAMBDA(nativeOnBeginFrame));
6866

6967
// Create all te prerequisites for a shell.
7068
ASSERT_FALSE(DartVMRef::IsInstanceRunning());

‎engine/src/flutter/shell/common/dart_native_benchmarks.cc‎

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -35,10 +35,8 @@ BENCHMARK_F(DartNativeBenchmarks, TimeToFirstNativeMessageFromIsolateInNewVM)
3535
fml::AutoResetWaitableEvent latch;
3636
st.PauseTiming();
3737
ASSERT_FALSE(DartVMRef::IsInstanceRunning());
38-
AddNativeCallback("NotifyNative",
39-
CREATE_NATIVE_ENTRY(([&latch](Dart_NativeArguments args) {
40-
latch.Signal();
41-
})));
38+
AddFfiNativeCallback("NotifyNative",
39+
CREATE_FFI_LAMBDA(([&latch]() { latch.Signal(); })));
4240

4341
const auto settings = CreateSettingsForFixture();
4442
DartVMRef vm_ref = DartVMRef::Create(settings);
@@ -72,10 +70,8 @@ BENCHMARK_F(DartNativeBenchmarks, MultipleDartToNativeMessages)
7270
fml::CountDownLatch latch(1000);
7371
st.PauseTiming();
7472
ASSERT_FALSE(DartVMRef::IsInstanceRunning());
75-
AddNativeCallback("NotifyNative",
76-
CREATE_NATIVE_ENTRY(([&latch](Dart_NativeArguments args) {
77-
latch.CountDown();
78-
})));
73+
AddFfiNativeCallback(
74+
"NotifyNative", CREATE_FFI_LAMBDA(([&latch]() { latch.CountDown(); })));
7975

8076
const auto settings = CreateSettingsForFixture();
8177
DartVMRef vm_ref = DartVMRef::Create(settings);

‎engine/src/flutter/shell/common/engine_animator_unittests.cc‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -303,7 +303,8 @@ TEST_F(EngineAnimatorTest, AnimatorAcceptsMultipleRenders) {
303303
});
304304

305305
native_latch.Reset();
306-
AddNativeCallback("NotifyNative", [](auto args) { native_latch.Signal(); });
306+
AddFfiNativeCallback("NotifyNative",
307+
CREATE_FFI_LAMBDA([]() { native_latch.Signal(); }));
307308

308309
std::unique_ptr<Animator> animator;
309310
PostSync(task_runners_.GetUITaskRunner(),
@@ -395,8 +396,7 @@ TEST_F(EngineAnimatorTest, IgnoresDuplicateRenders) {
395396
std::unique_ptr<EngineContext> engine_context;
396397

397398
std::vector<std::shared_ptr<Layer>> benchmark_layers;
398-
auto capture_root_layer = [&benchmark_layers](Dart_NativeArguments args) {
399-
auto handle = Dart_GetNativeArgument(args, 0);
399+
auto capture_root_layer = [&benchmark_layers](Dart_Handle handle) {
400400
intptr_t peer = 0;
401401
Dart_Handle result = Dart_GetNativeInstanceField(
402402
handle, tonic::DartWrappable::kPeerIndex, &peer);
@@ -438,8 +438,8 @@ TEST_F(EngineAnimatorTest, IgnoresDuplicateRenders) {
438438
});
439439
});
440440

441-
AddNativeCallback("CaptureRootLayer",
442-
CREATE_NATIVE_ENTRY(capture_root_layer));
441+
AddFfiNativeCallback("CaptureRootLayer",
442+
CREATE_FFI_LAMBDA(capture_root_layer));
443443

444444
std::unique_ptr<Animator> animator;
445445
PostSync(task_runners_.GetUITaskRunner(),
@@ -506,11 +506,11 @@ TEST_F(EngineAnimatorTest, AnimatorSubmitsImplicitViewBeforeDrawFrameEnds) {
506506

507507
native_latch.Reset();
508508
// The native_latch is signaled at the end of handleDrawFrame.
509-
AddNativeCallback("NotifyNative",
510-
CREATE_NATIVE_ENTRY([&rasterization_started](auto args) {
511-
EXPECT_EQ(rasterization_started, true);
512-
native_latch.Signal();
513-
}));
509+
AddFfiNativeCallback("NotifyNative",
510+
CREATE_FFI_LAMBDA([&rasterization_started]() {
511+
EXPECT_EQ(rasterization_started, true);
512+
native_latch.Signal();
513+
}));
514514

515515
engine_context = EngineContext::Create(delegate_, settings_, task_runners_,
516516
std::move(animator));

‎engine/src/flutter/shell/common/fixtures/shell_test.dart‎

Lines changed: 23 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66

77
import 'dart:async';
88
import 'dart:convert' show json, utf8;
9+
import 'dart:ffi';
910
import 'dart:isolate';
1011
import 'dart:typed_data';
1112
import 'dart:ui';
@@ -23,11 +24,11 @@ void mainNotifyNative() {
2324
notifyNative();
2425
}
2526

26-
@pragma('vm:external-name', 'NativeReportTimingsCallback')
27+
@Native<Void Function(Handle)>(symbol: 'NativeReportTimingsCallback')
2728
external void nativeReportTimingsCallback(List<int> timings);
28-
@pragma('vm:external-name', 'NativeOnBeginFrame')
29+
@Native<Void Function(Int64)>(symbol: 'NativeOnBeginFrame')
2930
external void nativeOnBeginFrame(int microseconds);
30-
@pragma('vm:external-name', 'NativeOnPointerDataPacket')
31+
@Native<Void Function(Handle)>(symbol: 'NativeOnPointerDataPacket')
3132
external void nativeOnPointerDataPacket(List<int> sequences);
3233

3334
@pragma('vm:entry-point')
@@ -50,9 +51,9 @@ void onErrorB() {
5051
throw Exception('I should be coming from B');
5152
}
5253

53-
@pragma('vm:external-name', 'NotifyErrorA')
54+
@Native<Void Function(Handle)>(symbol: 'NotifyErrorA')
5455
external void notifyErrorA(String message);
55-
@pragma('vm:external-name', 'NotifyErrorB')
56+
@Native<Void Function(Handle)>(symbol: 'NotifyErrorB')
5657
external void notifyErrorB(String message);
5758

5859
@pragma('vm:entry-point')
@@ -120,7 +121,7 @@ void reportMetrics() {
120121
};
121122
}
122123

123-
@pragma('vm:external-name', 'ReportMetrics')
124+
@Native<Void Function(Double, Double, Double)>(symbol: 'ReportMetrics')
124125
external void _reportMetrics(double devicePixelRatio, double width, double height);
125126

126127
@pragma('vm:entry-point')
@@ -133,11 +134,11 @@ void fixturesAreFunctionalMain() {
133134
sayHiFromFixturesAreFunctionalMain();
134135
}
135136

136-
@pragma('vm:external-name', 'SayHiFromFixturesAreFunctionalMain')
137+
@Native<Void Function()>(symbol: 'SayHiFromFixturesAreFunctionalMain')
137138
external void sayHiFromFixturesAreFunctionalMain();
138139

139140
@pragma('vm:entry-point')
140-
@pragma('vm:external-name', 'NotifyNative')
141+
@Native<Void Function()>(symbol: 'NotifyNative')
141142
external void notifyNative();
142143

143144
@pragma('vm:entry-point')
@@ -184,7 +185,7 @@ void testSkiaResourceCacheSendsResponse() {
184185
);
185186
}
186187

187-
@pragma('vm:external-name', 'NotifyWidthHeight')
188+
@Native<Void Function(Int, Int)>(symbol: 'NotifyWidthHeight')
188189
external void notifyWidthHeight(int width, int height);
189190

190191
@pragma('vm:entry-point')
@@ -215,7 +216,7 @@ void performanceModeImpactsNotifyIdle() {
215216
PlatformDispatcher.instance.requestDartPerformanceMode(DartPerformanceMode.balanced);
216217
}
217218

218-
@pragma('vm:external-name', 'NotifyMessage')
219+
@Native<Void Function(Handle)>(symbol: 'NotifyMessage')
219220
external void notifyMessage(String string);
220221

221222
@pragma('vm:entry-point')
@@ -229,10 +230,10 @@ void canRegisterImageDecoders() {
229230
);
230231
}
231232

232-
@pragma('vm:external-name', 'NotifyLocalTime')
233+
@Native<Void Function(Handle)>(symbol: 'NotifyLocalTime')
233234
external void notifyLocalTime(String string);
234235

235-
@pragma('vm:external-name', 'WaitFixture')
236+
@Native<Bool Function()>(symbol: 'WaitFixture')
236237
external bool waitFixture();
237238

238239
// Return local date-time as a string, to an hour resolution. So, "2020-07-23
@@ -258,10 +259,10 @@ void timezonesChange() {
258259
} while (waitFixture());
259260
}
260261

261-
@pragma('vm:external-name', 'NotifyCanAccessResource')
262+
@Native<Void Function(Bool)>(symbol: 'NotifyCanAccessResource')
262263
external void notifyCanAccessResource(bool success);
263264

264-
@pragma('vm:external-name', 'NotifySetAssetBundlePath')
265+
@Native<Void Function()>(symbol: 'NotifySetAssetBundlePath')
265266
external void notifySetAssetBundlePath();
266267

267268
@pragma('vm:entry-point')
@@ -276,10 +277,10 @@ Future<void> canAccessResourceFromAssetDir() async {
276277
);
277278
}
278279

279-
@pragma('vm:external-name', 'NotifyNativeWhenEngineRun')
280+
@Native<Void Function(Bool)>(symbol: 'NotifyNativeWhenEngineRun')
280281
external void notifyNativeWhenEngineRun(bool success);
281282

282-
@pragma('vm:external-name', 'NotifyNativeWhenEngineSpawn')
283+
@Native<Void Function(Bool)>(symbol: 'NotifyNativeWhenEngineSpawn')
283284
external void notifyNativeWhenEngineSpawn(bool success);
284285

285286
@pragma('vm:entry-point')
@@ -307,7 +308,7 @@ void frameCallback(Object? image, int durationMilliseconds, String decodeError)
307308
}
308309
}
309310

310-
@pragma('vm:external-name', 'NativeOnBeforeToImageSync')
311+
@Native<Void Function()>(symbol: 'NativeOnBeforeToImageSync')
311312
external void onBeforeToImageSync();
312313

313314
@pragma('vm:entry-point')
@@ -373,7 +374,7 @@ Future<void> runCallback(IsolateParam param) async {
373374
}
374375

375376
@pragma('vm:entry-point')
376-
@pragma('vm:external-name', 'NotifyNativeBool')
377+
@Native<Void Function(Bool)>(symbol: 'NotifyNativeBool')
377378
external void notifyNativeBool(bool value);
378379

379380
@pragma('vm:entry-point')
@@ -419,7 +420,7 @@ Future<void> testThatAssetLoadingHappensOnWorkerThread() async {
419420
notifyNative();
420421
}
421422

422-
@pragma('vm:external-name', 'NativeReportViewIdsCallback')
423+
@Native<Void Function(Bool, Handle)>(symbol: 'NativeReportViewIdsCallback')
423424
external void nativeReportViewIdsCallback(bool hasImplicitView, List<int> viewIds);
424425

425426
List<int> getCurrentViewIds() {
@@ -468,7 +469,7 @@ List<int> getCurrentViewWidths() {
468469
return result;
469470
}
470471

471-
@pragma('vm:external-name', 'NativeReportViewWidthsCallback')
472+
@Native<Void Function(Handle)>(symbol: 'NativeReportViewWidthsCallback')
472473
external void nativeReportViewWidthsCallback(List<int> viewWidthPacket);
473474

474475
// This entrypoint reports the list of views and their widths using
@@ -513,7 +514,7 @@ void renderViewsInFrameAndOutOfFrame() {
513514
PlatformDispatcher.instance.scheduleFrame();
514515
}
515516

516-
@pragma('vm:external-name', 'CaptureRootLayer')
517+
@Native<Void Function(Handle)>(symbol: 'CaptureRootLayer')
517518
external void _captureRootLayer(SceneBuilder sceneBuilder);
518519

519520
@pragma('vm:entry-point')
@@ -634,7 +635,7 @@ void testSendViewFocusEvent() {
634635
notifyNative();
635636
}
636637

637-
@pragma('vm:external-name', 'ReportEngineId')
638+
@Native<Void Function(Handle)>(symbol: 'ReportEngineId')
638639
external void _reportEngineId(int? identifier);
639640

640641
@pragma('vm:entry-point')

‎engine/src/flutter/shell/common/input_events_unittests.cc‎

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ static void TestSimulatedInputEvents(
7979
int frame_drawn = 0;
8080
auto nativeOnPointerDataPacket = [&events_consumed_at_frame,
8181
&will_draw_new_frame, &events_consumed,
82-
&frame_drawn](Dart_NativeArguments args) {
82+
&frame_drawn](Dart_Handle sequences) {
8383
events_consumed += 1;
8484
if (will_draw_new_frame) {
8585
frame_drawn += 1;
@@ -89,8 +89,8 @@ static void TestSimulatedInputEvents(
8989
events_consumed_at_frame.back() = events_consumed;
9090
}
9191
};
92-
fixture->AddNativeCallback("NativeOnPointerDataPacket",
93-
CREATE_NATIVE_ENTRY(nativeOnPointerDataPacket));
92+
fixture->AddFfiNativeCallback("NativeOnPointerDataPacket",
93+
CREATE_FFI_LAMBDA(nativeOnPointerDataPacket));
9494

9595
ASSERT_TRUE(configuration.IsValid());
9696
fixture->RunEngine(shell.get(), std::move(configuration));
@@ -327,16 +327,16 @@ TEST_F(ShellTest, CanCorrectlyPipePointerPacket) {
327327
// Sets up native handler.
328328
fml::AutoResetWaitableEvent reportLatch;
329329
std::vector<int64_t> result_sequence;
330-
auto nativeOnPointerDataPacket = [&reportLatch, &result_sequence](
331-
Dart_NativeArguments args) {
330+
auto nativeOnPointerDataPacket = [&reportLatch,
331+
&result_sequence](Dart_Handle sequences) {
332332
Dart_Handle exception = nullptr;
333-
result_sequence = tonic::DartConverter<std::vector<int64_t>>::FromArguments(
334-
args, 0, exception);
333+
result_sequence =
334+
tonic::DartConverter<std::vector<int64_t>>::FromDart(sequences);
335335
reportLatch.Signal();
336336
};
337337
// Starts engine.
338-
AddNativeCallback("NativeOnPointerDataPacket",
339-
CREATE_NATIVE_ENTRY(nativeOnPointerDataPacket));
338+
AddFfiNativeCallback("NativeOnPointerDataPacket",
339+
CREATE_FFI_LAMBDA(nativeOnPointerDataPacket));
340340
ASSERT_TRUE(configuration.IsValid());
341341
RunEngine(shell.get(), std::move(configuration));
342342
// Starts test.
@@ -392,16 +392,16 @@ TEST_F(ShellTest, CanCorrectlySynthesizePointerPacket) {
392392
// Sets up native handler.
393393
fml::AutoResetWaitableEvent reportLatch;
394394
std::vector<int64_t> result_sequence;
395-
auto nativeOnPointerDataPacket = [&reportLatch, &result_sequence](
396-
Dart_NativeArguments args) {
395+
auto nativeOnPointerDataPacket = [&reportLatch,
396+
&result_sequence](Dart_Handle sequences) {
397397
Dart_Handle exception = nullptr;
398-
result_sequence = tonic::DartConverter<std::vector<int64_t>>::FromArguments(
399-
args, 0, exception);
398+
result_sequence =
399+
tonic::DartConverter<std::vector<int64_t>>::FromDart(sequences);
400400
reportLatch.Signal();
401401
};
402402
// Starts engine.
403-
AddNativeCallback("NativeOnPointerDataPacket",
404-
CREATE_NATIVE_ENTRY(nativeOnPointerDataPacket));
403+
AddFfiNativeCallback("NativeOnPointerDataPacket",
404+
CREATE_FFI_LAMBDA(nativeOnPointerDataPacket));
405405
ASSERT_TRUE(configuration.IsValid());
406406
RunEngine(shell.get(), std::move(configuration));
407407
// Starts test.

‎engine/src/flutter/shell/common/shell_fuchsia_unittests.cc‎

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -173,22 +173,21 @@ TEST_F(FuchsiaShellTest, LocaltimesVaryOnTimezoneChanges) {
173173
// there.
174174
fml::AutoResetWaitableEvent latch;
175175
std::string dart_isolate_time_str;
176-
AddNativeCallback("NotifyLocalTime", CREATE_NATIVE_ENTRY([&](auto args) {
177-
dart_isolate_time_str =
178-
tonic::DartConverter<std::string>::FromDart(
179-
Dart_GetNativeArgument(args, 0));
180-
latch.Signal();
181-
}));
176+
AddFfiNativeCallback(
177+
"NotifyLocalTime", CREATE_FFI_LAMBDA([&](Dart_Handle string_handle) {
178+
dart_isolate_time_str =
179+
tonic::DartConverter<std::string>::FromDart(string_handle);
180+
latch.Signal();
181+
}));
182182

183183
// As long as this is set, the isolate will keep rerunning its only task.
184184
bool continue_fixture = true;
185185
fml::AutoResetWaitableEvent fixture_latch;
186-
AddNativeCallback("WaitFixture", CREATE_NATIVE_ENTRY([&](auto args) {
187-
// Wait for the test fixture to advance.
188-
fixture_latch.Wait();
189-
tonic::DartConverter<bool>::SetReturnValue(
190-
args, continue_fixture);
191-
}));
186+
AddFfiNativeCallback("WaitFixture", CREATE_FFI_LAMBDA([&]() {
187+
// Wait for the test fixture to advance.
188+
fixture_latch.Wait();
189+
return continue_fixture;
190+
}));
192191

193192
auto settings = CreateSettingsForFixture();
194193
auto configuration = RunConfiguration::InferFromSettings(settings);

0 commit comments

Comments
 (0)