Reland Dart plugin registrant (flutter#25496)

BUILD.gn

@@ -103,6 +103,7 @@ group("flutter") {
       "//flutter/flow:flow_unittests",
       "//flutter/fml:fml_unittests",
       "//flutter/lib/ui:ui_unittests",
+      "//flutter/runtime:no_dart_plugin_registrant_unittests",
       "//flutter/runtime:runtime_unittests",
       "//flutter/shell/common:shell_unittests",
       "//flutter/shell/platform/embedder:embedder_proctable_unittests",

ci/licenses_golden/licenses_flutter

@@ -609,10 +609,12 @@ FILE: ../../../flutter/runtime/dart_vm_lifecycle.h
 FILE: ../../../flutter/runtime/dart_vm_unittests.cc
 FILE: ../../../flutter/runtime/embedder_resources.cc
 FILE: ../../../flutter/runtime/embedder_resources.h
+FILE: ../../../flutter/runtime/fixtures/no_dart_plugin_registrant_test.dart
 FILE: ../../../flutter/runtime/fixtures/runtime_test.dart
 FILE: ../../../flutter/runtime/fixtures/split_lib_test.dart
 FILE: ../../../flutter/runtime/isolate_configuration.cc
 FILE: ../../../flutter/runtime/isolate_configuration.h
+FILE: ../../../flutter/runtime/no_dart_plugin_registrant_unittests.cc
 FILE: ../../../flutter/runtime/platform_data.cc
 FILE: ../../../flutter/runtime/platform_data.h
 FILE: ../../../flutter/runtime/ptrace_check.cc

lib/ui/painting/image_decoder_unittests.cc

@@ -637,9 +637,9 @@ TEST_F(ImageDecoderFixtureTest,
   });
   latch.Wait();
 
-  auto isolate =
-      RunDartCodeInIsolate(vm_ref, settings, runners, "main", {},
-                           GetFixturesPath(), io_manager->GetWeakIOManager());
+  auto isolate = RunDartCodeInIsolate(vm_ref, settings, runners, "main", {},
+                                      GetDefaultKernelFilePath(),
+                                      io_manager->GetWeakIOManager());
 
   // Latch the IO task runner.
   runners.GetIOTaskRunner()->PostTask([&]() { io_latch.Wait(); });

lib/ui/ui_benchmarks.cc

@@ -32,7 +32,7 @@ static void BM_PlatformMessageResponseDartComplete(benchmark::State& state) {
   auto vm_ref = DartVMRef::Create(settings);
   auto isolate =
       testing::RunDartCodeInIsolate(vm_ref, settings, task_runners, "main", {},
-                                    testing::GetFixturesPath(), {});
+                                    testing::GetDefaultKernelFilePath(), {});
 
   while (state.KeepRunning()) {
     state.PauseTiming();

runtime/BUILD.gn

@@ -136,4 +136,24 @@ if (enable_unittests) {
       "//third_party/skia",
     ]
   }
+
+  test_fixtures("no_plugin_registrant") {
+    dart_main = "fixtures/no_dart_plugin_registrant_test.dart"
+    use_target_as_artifact_prefix = true
+  }
+
+  executable("no_dart_plugin_registrant_unittests") {
+    testonly = true
+
+    sources = [ "no_dart_plugin_registrant_unittests.cc" ]
+
+    public_configs = [ "//flutter:export_dynamic_symbols" ]
+
+    public_deps = [
+      ":no_plugin_registrant",
+      "//flutter/fml",
+      "//flutter/testing",
+      "//flutter/testing:fixture_test",
+    ]
+  }
 }

runtime/dart_isolate.cc

@@ -725,6 +725,28 @@ bool DartIsolate::MarkIsolateRunnable() {
   return true;
 }
 
+static void InvokeDartPluginRegistrantIfAvailable(Dart_Handle library_handle) {
+  TRACE_EVENT0("flutter", "InvokeDartPluginRegistrantIfAvailable");
+
+  // The Dart plugin registrant is a static method with signature `void
+  // register()` within the class `_PluginRegistrant` generated by the Flutter
+  // tool.
+  //
+  // This method binds a plugin implementation to their platform
+  // interface based on the configuration of the app's pubpec.yaml, and the
+  // plugin's pubspec.yaml.
+  //
+  // Since this method may or may not be defined, check if the class is defined
+  // in the default library before calling the method.
+  Dart_Handle plugin_registrant =
+      ::Dart_GetClass(library_handle, tonic::ToDart("_PluginRegistrant"));
+
+  if (Dart_IsError(plugin_registrant)) {
+    return;
+  }
+  tonic::LogIfError(tonic::DartInvokeField(plugin_registrant, "register", {}));
+}
+
 bool DartIsolate::RunFromLibrary(std::optional<std::string> library_name,
                                  std::optional<std::string> entrypoint,
                                  const std::vector<std::string>& args) {
@@ -742,6 +764,9 @@ bool DartIsolate::RunFromLibrary(std::optional<std::string> library_name,
   auto entrypoint_handle = entrypoint.has_value() && !entrypoint.value().empty()
                                ? tonic::ToDart(entrypoint.value().c_str())
                                : tonic::ToDart("main");
+
+  InvokeDartPluginRegistrantIfAvailable(library_handle);
+
   auto user_entrypoint_function =
       ::Dart_GetField(library_handle, entrypoint_handle);
 

runtime/dart_isolate_unittests.cc

@@ -214,7 +214,7 @@ TEST_F(DartIsolateTest, IsolateCanLoadAndRunDartCode) {
                            GetCurrentTaskRunner()   //
   );
   auto isolate = RunDartCodeInIsolate(vm_ref, settings, task_runners, "main",
-                                      {}, GetFixturesPath());
+                                      {}, GetDefaultKernelFilePath());
   ASSERT_TRUE(isolate);
   ASSERT_EQ(isolate->get()->GetPhase(), DartIsolate::Phase::Running);
 }
@@ -231,7 +231,7 @@ TEST_F(DartIsolateTest, IsolateCannotLoadAndRunUnknownDartEntrypoint) {
   );
   auto isolate =
       RunDartCodeInIsolate(vm_ref, settings, task_runners, "thisShouldNotExist",
-                           {}, GetFixturesPath());
+                           {}, GetDefaultKernelFilePath());
   ASSERT_FALSE(isolate);
 }
 
@@ -246,7 +246,7 @@ TEST_F(DartIsolateTest, CanRunDartCodeCodeSynchronously) {
                            GetCurrentTaskRunner()   //
   );
   auto isolate = RunDartCodeInIsolate(vm_ref, settings, task_runners, "main",
-                                      {}, GetFixturesPath());
+                                      {}, GetDefaultKernelFilePath());
 
   ASSERT_TRUE(isolate);
   ASSERT_EQ(isolate->get()->GetPhase(), DartIsolate::Phase::Running);
@@ -275,9 +275,9 @@ TEST_F(DartIsolateTest, CanRegisterNativeCallback) {
                            thread,                //
                            thread                 //
   );
-  auto isolate =
-      RunDartCodeInIsolate(vm_ref, settings, task_runners,
-                           "canRegisterNativeCallback", {}, GetFixturesPath());
+  auto isolate = RunDartCodeInIsolate(vm_ref, settings, task_runners,
+                                      "canRegisterNativeCallback", {},
+                                      GetDefaultKernelFilePath());
   ASSERT_TRUE(isolate);
   ASSERT_EQ(isolate->get()->GetPhase(), DartIsolate::Phase::Running);
   Wait();
@@ -307,7 +307,7 @@ TEST_F(DartIsolateTest, CanSaveCompilationTrace) {
   );
   auto isolate = RunDartCodeInIsolate(vm_ref, settings, task_runners,
                                       "testCanSaveCompilationTrace", {},
-                                      GetFixturesPath());
+                                      GetDefaultKernelFilePath());
   ASSERT_TRUE(isolate);
   ASSERT_EQ(isolate->get()->GetPhase(), DartIsolate::Phase::Running);
 
@@ -367,7 +367,7 @@ TEST_F(DartSecondaryIsolateTest, CanLaunchSecondaryIsolates) {
   );
   auto isolate = RunDartCodeInIsolate(vm_ref, settings, task_runners,
                                       "testCanLaunchSecondaryIsolate", {},
-                                      GetFixturesPath());
+                                      GetDefaultKernelFilePath());
   ASSERT_TRUE(isolate);
   ASSERT_EQ(isolate->get()->GetPhase(), DartIsolate::Phase::Running);
   ChildShutdownWait();  // wait for child isolate to shutdown first
@@ -395,7 +395,7 @@ TEST_F(DartIsolateTest, CanRecieveArguments) {
   );
   auto isolate = RunDartCodeInIsolate(vm_ref, settings, task_runners,
                                       "testCanRecieveArguments", {"arg1"},
-                                      GetFixturesPath());
+                                      GetDefaultKernelFilePath());
   ASSERT_TRUE(isolate);
   ASSERT_EQ(isolate->get()->GetPhase(), DartIsolate::Phase::Running);
 
@@ -477,7 +477,7 @@ TEST_F(DartIsolateTest,
   );
   {
     auto isolate = RunDartCodeInIsolate(vm_ref, settings, task_runners, "main",
-                                        {}, GetFixturesPath());
+                                        {}, GetDefaultKernelFilePath());
     ASSERT_TRUE(isolate);
     ASSERT_EQ(isolate->get()->GetPhase(), DartIsolate::Phase::Running);
   }
@@ -505,7 +505,7 @@ TEST_F(DartIsolateTest,
   );
   {
     auto isolate = RunDartCodeInIsolate(vm_ref, instance_settings, task_runners,
-                                        "main", {}, GetFixturesPath());
+                                        "main", {}, GetDefaultKernelFilePath());
     ASSERT_TRUE(isolate);
     ASSERT_EQ(isolate->get()->GetPhase(), DartIsolate::Phase::Running);
   }
@@ -596,9 +596,9 @@ TEST_F(DartIsolateTest, DISABLED_ValidLoadingUnitSucceeds) {
                            thread,                //
                            thread                 //
   );
-  auto isolate =
-      RunDartCodeInIsolate(vm_ref, settings, task_runners,
-                           "canCallDeferredLibrary", {}, GetFixturesPath());
+  auto isolate = RunDartCodeInIsolate(vm_ref, settings, task_runners,
+                                      "canCallDeferredLibrary", {},
+                                      GetDefaultKernelFilePath());
   ASSERT_TRUE(isolate);
   ASSERT_EQ(isolate->get()->GetPhase(), DartIsolate::Phase::Running);
   Wait();
@@ -613,5 +613,39 @@ TEST_F(DartIsolateTest, DISABLED_ValidLoadingUnitSucceeds) {
   Wait();
 }
 
+TEST_F(DartIsolateTest, DartPluginRegistrantIsCalled) {
+  ASSERT_FALSE(DartVMRef::IsInstanceRunning());
+
+  std::vector<std::string> messages;
+  fml::AutoResetWaitableEvent latch;
+
+  AddNativeCallback(
+      "PassMessage",
+      CREATE_NATIVE_ENTRY(([&latch, &messages](Dart_NativeArguments args) {
+        auto message = tonic::DartConverter<std::string>::FromDart(
+            Dart_GetNativeArgument(args, 0));
+        messages.push_back(message);
+        latch.Signal();
+      })));
+
+  const auto settings = CreateSettingsForFixture();
+  auto vm_ref = DartVMRef::Create(settings);
+  auto thread = CreateNewThread();
+  TaskRunners task_runners(GetCurrentTestName(),  //
+                           thread,                //
+                           thread,                //
+                           thread,                //
+                           thread                 //
+  );
+  auto isolate = RunDartCodeInIsolate(vm_ref, settings, task_runners,
+                                      "mainForPluginRegistrantTest", {},
+                                      GetDefaultKernelFilePath());
+  ASSERT_TRUE(isolate);
+  ASSERT_EQ(isolate->get()->GetPhase(), DartIsolate::Phase::Running);
+  latch.Wait();
+  ASSERT_EQ(messages.size(), 1u);
+  ASSERT_EQ(messages[0], "_PluginRegistrant.register() was called");
+}
+
 }  // namespace testing
 }  // namespace flutter

runtime/fixtures/no_dart_plugin_registrant_test.dart

@@ -0,0 +1,9 @@
+// Copyright 2013 The Flutter Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+void passMessage(String message) native 'PassMessage';
+
+void main() {
+  passMessage('main() was called');
+}

runtime/fixtures/runtime_test.dart

@@ -10,8 +10,7 @@ import 'dart:ui';
 
 import 'split_lib_test.dart' deferred as splitlib;
 
-void main() {
-}
+void main() {}
 
 @pragma('vm:entry-point')
 void sayHi() {
@@ -115,3 +114,29 @@ void testCanConvertListOfInts(List<int> args){
                 args[2] == 3 &&
                 args[3] == 4);
 }
+
+bool didCallRegistrantBeforeEntrypoint = false;
+
+// Test the Dart plugin registrant.
+@pragma('vm:entry-point')
+class _PluginRegistrant {
+
+  @pragma('vm:entry-point')
+  static void register() {
+    if (didCallRegistrantBeforeEntrypoint) {
+      throw '_registerPlugins is being called twice';
+    }
+    didCallRegistrantBeforeEntrypoint = true;
+  }
+
+}
+
+
+@pragma('vm:entry-point')
+void mainForPluginRegistrantTest() { // ignore: unused_element
+  if (didCallRegistrantBeforeEntrypoint) {
+    passMessage('_PluginRegistrant.register() was called');
+  } else {
+    passMessage('_PluginRegistrant.register() was not called');
+  }
+}

runtime/no_dart_plugin_registrant_unittests.cc

@@ -0,0 +1,73 @@
+// Copyright 2013 The Flutter Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+#include "flutter/runtime/dart_isolate.h"
+
+#include "flutter/fml/paths.h"
+#include "flutter/runtime/dart_vm.h"
+#include "flutter/runtime/dart_vm_lifecycle.h"
+#include "flutter/testing/dart_isolate_runner.h"
+#include "flutter/testing/fixture_test.h"
+#include "flutter/testing/testing.h"
+
+namespace flutter {
+namespace testing {
+
+const std::string kernel_file_name = "no_plugin_registrant_kernel_blob.bin";
+const std::string elf_file_name = "no_plugin_registrant_app_elf_snapshot.so";
+
+class DartIsolateTest : public FixtureTest {
+ public:
+  DartIsolateTest() : FixtureTest(kernel_file_name, elf_file_name, "") {}
+};
+
+TEST_F(DartIsolateTest, DartPluginRegistrantIsNotPresent) {
+  ASSERT_FALSE(DartVMRef::IsInstanceRunning());
+
+  std::vector<std::string> messages;
+  fml::AutoResetWaitableEvent latch;
+
+  AddNativeCallback(
+      "PassMessage",
+      CREATE_NATIVE_ENTRY(([&latch, &messages](Dart_NativeArguments args) {
+        auto message = tonic::DartConverter<std::string>::FromDart(
+            Dart_GetNativeArgument(args, 0));
+        messages.push_back(message);
+        latch.Signal();
+      })));
+
+  auto settings = CreateSettingsForFixture();
+  auto did_throw_exception = false;
+  settings.unhandled_exception_callback = [&](const std::string& error,
+                                              const std::string& stack_trace) {
+    did_throw_exception = true;
+    return true;
+  };
+
+  auto vm_ref = DartVMRef::Create(settings);
+  auto thread = CreateNewThread();
+  TaskRunners task_runners(GetCurrentTestName(),  //
+                           thread,                //
+                           thread,                //
+                           thread,                //
+                           thread                 //
+  );
+
+  auto kernel_path =
+      fml::paths::JoinPaths({GetFixturesPath(), kernel_file_name});
+  auto isolate = RunDartCodeInIsolate(vm_ref, settings, task_runners, "main",
+                                      {}, kernel_path);
+
+  ASSERT_TRUE(isolate);
+  ASSERT_EQ(isolate->get()->GetPhase(), DartIsolate::Phase::Running);
+
+  latch.Wait();
+
+  ASSERT_EQ(messages.size(), 1u);
+  ASSERT_EQ(messages[0], "main() was called");
+  ASSERT_FALSE(did_throw_exception);
+}
+
+}  // namespace testing
+}  // namespace flutter

runtime/type_conversions_unittests.cc

@@ -28,7 +28,7 @@ class TypeConversionsTest : public FixtureTest {
                                             thread, thread, thread);
     auto isolate =
         RunDartCodeInIsolate(vm_, settings_, single_threaded_task_runner,
-                             entrypoint, {}, GetFixturesPath());
+                             entrypoint, {}, GetDefaultKernelFilePath());
     if (!isolate || isolate->get()->GetPhase() != DartIsolate::Phase::Running) {
       return false;
     }

shell/common/shell_benchmarks.cc

@@ -29,7 +29,8 @@ static void StartupAndShutdownShell(benchmark::State& state,
     settings.task_observer_remove = [](intptr_t) {};
 
     if (DartVM::IsRunningPrecompiledCode()) {
-      aot_symbols = testing::LoadELFSymbolFromFixturesIfNeccessary();
+      aot_symbols = testing::LoadELFSymbolFromFixturesIfNeccessary(
+          testing::kDefaultAOTAppELFFileName);
       FML_CHECK(
           testing::PrepareSettingsForAOTWithSymbols(settings, aot_symbols))
           << "Could not set up settings with AOT symbols.";