Skip to content

Commit 543f7a6

Browse files
committed
Migrate the embedder tests from the legacy Dart native function format to FFI
See flutter#190154
1 parent 4adca2f commit 543f7a6

24 files changed

Lines changed: 630 additions & 817 deletions

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
#include "gmock/gmock.h"
1818
#include "gtest/gtest.h"
1919

20-
// CREATE_NATIVE_ENTRY is leaky by design
20+
// CREATE_FFI_LAMBDA is leaky by design
2121
// NOLINTBEGIN(clang-analyzer-core.StackAddressEscape)
2222

2323
namespace flutter {

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
#include "fml/synchronization/count_down_latch.h"
1313
#include "runtime/dart_vm_lifecycle.h"
1414

15-
// CREATE_NATIVE_ENTRY is leaky by design
15+
// CREATE_FFI_LAMBDA is leaky by design
1616
// NOLINTBEGIN(clang-analyzer-core.StackAddressEscape)
1717

1818
namespace flutter::testing {

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
#include "gmock/gmock.h"
1414
#include "impeller/core/runtime_types.h"
1515

16-
// CREATE_NATIVE_ENTRY is leaky by design
16+
// CREATE_FFI_LAMBDA is leaky by design
1717
// NOLINTBEGIN(clang-analyzer-core.StackAddressEscape)
1818

1919
namespace flutter {

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
#include "flutter/shell/common/shell_test.h"
66
#include "flutter/testing/testing.h"
77

8-
// CREATE_NATIVE_ENTRY is leaky by design
8+
// CREATE_FFI_LAMBDA is leaky by design
99
// NOLINTBEGIN(clang-analyzer-core.StackAddressEscape)
1010

1111
namespace flutter {

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@
5757
#include "flutter/vulkan/vulkan_application.h" // nogncheck
5858
#endif
5959

60-
// CREATE_NATIVE_ENTRY is leaky by design
60+
// CREATE_FFI_LAMBDA is leaky by design
6161
// NOLINTBEGIN(clang-analyzer-core.StackAddressEscape)
6262

6363
namespace flutter {

‎engine/src/flutter/shell/platform/darwin/macos/framework/Source/FlutterEngineTest.mm‎

Lines changed: 36 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@
3333
#include "flutter/testing/test_dart_native_resolver.h"
3434
#include "gtest/gtest.h"
3535

36-
// CREATE_NATIVE_ENTRY and MOCK_ENGINE_PROC are leaky by design
36+
// CREATE_FFI_LAMBDA and MOCK_ENGINE_PROC are leaky by design
3737
// NOLINTBEGIN(clang-analyzer-core.StackAddressEscape)
3838

3939
@interface FlutterEngine (Test)
@@ -153,12 +153,12 @@ @implementation MockableFlutterEngine
153153

154154
// Block until notified by the Dart test of the value of Platform.executable.
155155
BOOL signaled = NO;
156-
AddNativeCallback("NotifyStringValue", CREATE_NATIVE_ENTRY([&](Dart_NativeArguments args) {
157-
const auto dart_string = tonic::DartConverter<std::string>::FromDart(
158-
Dart_GetNativeArgument(args, 0));
159-
EXPECT_EQ(executable_name, dart_string);
160-
signaled = YES;
161-
}));
156+
AddFfiNativeCallback("NotifyStringValue", CREATE_FFI_LAMBDA([&](Dart_Handle value) {
157+
const auto dart_string =
158+
tonic::DartConverter<std::string>::FromDart(value);
159+
EXPECT_EQ(executable_name, dart_string);
160+
signaled = YES;
161+
}));
162162

163163
// Launch the test entrypoint.
164164
EXPECT_TRUE([engine runWithEntrypoint:@"executableNameNotNull"]);
@@ -216,8 +216,7 @@ @implementation MockableFlutterEngine
216216
TEST_F(FlutterEngineTest, CanLogToStdout) {
217217
// Block until completion of print statement.
218218
BOOL signaled = NO;
219-
AddNativeCallback("SignalNativeTest",
220-
CREATE_NATIVE_ENTRY([&](Dart_NativeArguments args) { signaled = YES; }));
219+
AddFfiNativeCallback("SignalNativeTest", CREATE_FFI_LAMBDA([&]() { signaled = YES; }));
221220

222221
// Replace stdout stream buffer with our own.
223222
FlutterStringOutputWriter* writer = [[FlutterStringOutputWriter alloc] init];
@@ -242,16 +241,16 @@ @implementation MockableFlutterEngine
242241

243242
// Latch to ensure the entire layer tree has been generated and presented.
244243
BOOL signaled = NO;
245-
AddNativeCallback("SignalNativeTest", CREATE_NATIVE_ENTRY([&](Dart_NativeArguments args) {
246-
CALayer* rootLayer = engine.viewController.flutterView.layer;
247-
EXPECT_TRUE(rootLayer.backgroundColor != nil);
248-
if (rootLayer.backgroundColor != nil) {
249-
NSColor* actualBackgroundColor =
250-
[NSColor colorWithCGColor:rootLayer.backgroundColor];
251-
EXPECT_EQ(actualBackgroundColor, [NSColor blackColor]);
252-
}
253-
signaled = YES;
254-
}));
244+
AddFfiNativeCallback("SignalNativeTest", CREATE_FFI_LAMBDA([&]() {
245+
CALayer* rootLayer = engine.viewController.flutterView.layer;
246+
EXPECT_TRUE(rootLayer.backgroundColor != nil);
247+
if (rootLayer.backgroundColor != nil) {
248+
NSColor* actualBackgroundColor =
249+
[NSColor colorWithCGColor:rootLayer.backgroundColor];
250+
EXPECT_EQ(actualBackgroundColor, [NSColor blackColor]);
251+
}
252+
signaled = YES;
253+
}));
255254

256255
// Launch the test entrypoint.
257256
EXPECT_TRUE([engine runWithEntrypoint:@"backgroundTest"]);
@@ -273,16 +272,16 @@ @implementation MockableFlutterEngine
273272

274273
// Latch to ensure the entire layer tree has been generated and presented.
275274
BOOL signaled = NO;
276-
AddNativeCallback("SignalNativeTest", CREATE_NATIVE_ENTRY([&](Dart_NativeArguments args) {
277-
CALayer* rootLayer = engine.viewController.flutterView.layer;
278-
EXPECT_TRUE(rootLayer.backgroundColor != nil);
279-
if (rootLayer.backgroundColor != nil) {
280-
NSColor* actualBackgroundColor =
281-
[NSColor colorWithCGColor:rootLayer.backgroundColor];
282-
EXPECT_EQ(actualBackgroundColor, [NSColor whiteColor]);
283-
}
284-
signaled = YES;
285-
}));
275+
AddFfiNativeCallback("SignalNativeTest", CREATE_FFI_LAMBDA([&]() {
276+
CALayer* rootLayer = engine.viewController.flutterView.layer;
277+
EXPECT_TRUE(rootLayer.backgroundColor != nil);
278+
if (rootLayer.backgroundColor != nil) {
279+
NSColor* actualBackgroundColor =
280+
[NSColor colorWithCGColor:rootLayer.backgroundColor];
281+
EXPECT_EQ(actualBackgroundColor, [NSColor whiteColor]);
282+
}
283+
signaled = YES;
284+
}));
286285

287286
// Launch the test entrypoint.
288287
EXPECT_TRUE([engine runWithEntrypoint:@"backgroundTest"]);
@@ -512,8 +511,7 @@ @implementation MockableFlutterEngine
512511

513512
TEST_F(FlutterEngineTest, NativeCallbacks) {
514513
BOOL latch_called = NO;
515-
AddNativeCallback("SignalNativeTest",
516-
CREATE_NATIVE_ENTRY([&](Dart_NativeArguments args) { latch_called = YES; }));
514+
AddFfiNativeCallback("SignalNativeTest", CREATE_FFI_LAMBDA([&]() { latch_called = YES; }));
517515

518516
FlutterEngine* engine = GetFlutterEngine();
519517
EXPECT_TRUE([engine runWithEntrypoint:@"nativeCallback"]);
@@ -937,14 +935,13 @@ @implementation MockableFlutterEngine
937935

938936
BOOL signaled = NO;
939937
std::optional<int64_t> engineId;
940-
AddNativeCallback("NotifyEngineId", CREATE_NATIVE_ENTRY([&](Dart_NativeArguments args) {
941-
const auto argument = Dart_GetNativeArgument(args, 0);
942-
if (!Dart_IsNull(argument)) {
943-
const auto id = tonic::DartConverter<int64_t>::FromDart(argument);
944-
engineId = id;
945-
}
946-
signaled = YES;
947-
}));
938+
AddFfiNativeCallback("NotifyEngineId", CREATE_FFI_LAMBDA([&](Dart_Handle argument) {
939+
if (!Dart_IsNull(argument)) {
940+
const auto id = tonic::DartConverter<int64_t>::FromDart(argument);
941+
engineId = id;
942+
}
943+
signaled = YES;
944+
}));
948945

949946
EXPECT_TRUE([engine runWithEntrypoint:@"testEngineId"]);
950947
while (!signaled) {

‎engine/src/flutter/shell/platform/darwin/macos/framework/Source/FlutterEngineTestUtils.h‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ class FlutterEngineTest : public AutoreleasePoolTest {
2525
void TearDown() override;
2626

2727
void AddNativeCallback(const char* name, Dart_NativeFunction function);
28+
void AddFfiNativeCallback(const char* name, void* function);
2829

2930
static void IsolateCreateCallback(void* user_data);
3031

‎engine/src/flutter/shell/platform/darwin/macos/framework/Source/FlutterEngineTestUtils.mm‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,10 @@ - (BOOL)setString:(NSString*)string forType:(NSPasteboardType)dataType {
7373
native_resolver_->AddNativeCallback({name}, function);
7474
}
7575

76+
void FlutterEngineTest::AddFfiNativeCallback(const char* name, void* function) {
77+
native_resolver_->AddFfiNativeCallback({name}, function);
78+
}
79+
7680
id CreateMockFlutterEngine(NSString* pasteboardString) {
7781
NSString* fixtures = @(testing::GetFixturesPath());
7882
FlutterDartProject* project = [[FlutterDartProject alloc]

‎engine/src/flutter/shell/platform/darwin/macos/framework/Source/FlutterWindowControllerTest.mm‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,10 +26,10 @@ void SetUp() {
2626

2727
signalled_ = false;
2828

29-
AddNativeCallback("SignalNativeTest", CREATE_NATIVE_ENTRY([&](Dart_NativeArguments args) {
30-
isolate_ = Isolate::Current();
31-
signalled_ = true;
32-
}));
29+
AddFfiNativeCallback("SignalNativeTest", CREATE_FFI_LAMBDA([&]() {
30+
isolate_ = Isolate::Current();
31+
signalled_ = true;
32+
}));
3333

3434
while (!signalled_) {
3535
CFRunLoopRunInMode(kCFRunLoopDefaultMode, 0.1, false);

‎engine/src/flutter/shell/platform/darwin/macos/framework/Source/fixtures/flutter_desktop_test.dart‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,12 @@
44

55
// ignore_for_file: avoid_print
66

7+
import 'dart:ffi';
78
import 'dart:io';
89
import 'dart:typed_data';
910
import 'dart:ui';
1011

11-
@pragma('vm:external-name', 'SignalNativeTest')
12+
@Native<Void Function()>(symbol: 'SignalNativeTest')
1213
external void signalNativeTest();
1314

1415
void main() {}
@@ -20,7 +21,7 @@ void empty() {}
2021
///
2122
/// This is used to notify the native side of the test of a string value from
2223
/// the Dart fixture under test.
23-
@pragma('vm:external-name', 'NotifyStringValue')
24+
@Native<Void Function(Handle)>(symbol: 'NotifyStringValue')
2425
external void notifyStringValue(String s);
2526

2627
@pragma('vm:entry-point')
@@ -86,7 +87,7 @@ void sendFooMessage() {
8687
PlatformDispatcher.instance.sendPlatformMessage('foo', null, (ByteData? result) {});
8788
}
8889

89-
@pragma('vm:external-name', 'NotifyEngineId')
90+
@Native<Void Function(Handle)>(symbol: 'NotifyEngineId')
9091
external void notifyEngineId(int? engineId);
9192

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

0 commit comments

Comments
 (0)