[fuchsia][scenic] Reland Move pointer injector to embedder. (#34692)

This PR moves the pointer injector library from fuchsia views library
present in fuchsia.git to the flutter embedder.

Test: ffx test run "fuchsia-pkg://fuchsia.com/flutter_runner_tests#meta/flutter_runner_tests.cm"

Author: shivesh-ganju

ci/licenses_golden/licenses_flutter

@@ -2076,6 +2076,9 @@ FILE: ../../../flutter/shell/platform/fuchsia/flutter/platform_view_unittest.cc
 FILE: ../../../flutter/shell/platform/fuchsia/flutter/pointer_delegate.cc
 FILE: ../../../flutter/shell/platform/fuchsia/flutter/pointer_delegate.h
 FILE: ../../../flutter/shell/platform/fuchsia/flutter/pointer_delegate_unittests.cc
+FILE: ../../../flutter/shell/platform/fuchsia/flutter/pointer_injector_delegate.cc
+FILE: ../../../flutter/shell/platform/fuchsia/flutter/pointer_injector_delegate.h
+FILE: ../../../flutter/shell/platform/fuchsia/flutter/pointer_injector_delegate_unittest.cc
 FILE: ../../../flutter/shell/platform/fuchsia/flutter/program_metadata.h
 FILE: ../../../flutter/shell/platform/fuchsia/flutter/runner.cc
 FILE: ../../../flutter/shell/platform/fuchsia/flutter/runner.h

shell/platform/fuchsia/flutter/BUILD.gn

@@ -92,6 +92,8 @@ template("runner_sources") {
       "platform_view.h",
       "pointer_delegate.cc",
       "pointer_delegate.h",
+      "pointer_injector_delegate.cc",
+      "pointer_injector_delegate.h",
       "program_metadata.h",
       "runner.cc",
       "runner.h",
@@ -158,6 +160,7 @@ template("runner_sources") {
              "$fuchsia_sdk_root/fidl:fuchsia.ui.pointer",
              "$fuchsia_sdk_root/fidl:fuchsia.ui.views",
              "$fuchsia_sdk_root/fidl:fuchsia.ui.scenic",
+             "$fuchsia_sdk_root/fidl:fuchsia.ui.pointerinjector",
              "$fuchsia_sdk_root/pkg:async-cpp",
              "$fuchsia_sdk_root/pkg:async-default",
              "$fuchsia_sdk_root/pkg:async-loop",
@@ -472,6 +475,7 @@ if (enable_unittests) {
       "keyboard_unittest.cc",
       "platform_view_unittest.cc",
       "pointer_delegate_unittests.cc",
+      "pointer_injector_delegate_unittest.cc",
       "tests/engine_unittests.cc",
       "tests/fake_flatland_unittests.cc",
       "tests/fake_session_unittests.cc",

shell/platform/fuchsia/flutter/engine.cc

@@ -213,6 +213,17 @@ void Engine::Initialize(
       << "fuchsia::ui::input3::Keyboard connection failed: "
       << zx_status_get_string(keyboard_status);
 
+  // Connect to Pointerinjector service.
+  fuchsia::ui::pointerinjector::RegistryHandle pointerinjector_registry;
+  zx_status_t pointerinjector_registry_status =
+      runner_services->Connect<fuchsia::ui::pointerinjector::Registry>(
+          pointerinjector_registry.NewRequest());
+  if (pointerinjector_registry_status != ZX_OK) {
+    FML_LOG(WARNING)
+        << "fuchsia::ui::pointerinjector::Registry connection failed: "
+        << zx_status_get_string(pointerinjector_registry_status);
+  }
+
   // Make clones of the `ViewRef` before sending it to various places.
   fuchsia::ui::views::ViewRef platform_view_ref;
   view_ref_pair.view_ref.Clone(&platform_view_ref);
@@ -401,6 +412,7 @@ void Engine::Initialize(
            view_ref_focused = std::move(view_ref_focused),
            touch_source = std::move(touch_source),
            mouse_source = std::move(mouse_source),
+           pointerinjector_registry = std::move(pointerinjector_registry),
            on_session_listener_error_callback =
                std::move(on_session_listener_error_callback),
            on_enable_wireframe_callback =
@@ -479,6 +491,7 @@ void Engine::Initialize(
                       std::move(mouse_source), std::move(focuser),
                       std::move(view_ref_focused),
                       std::move(parent_viewport_watcher),
+                      std::move(pointerinjector_registry),
                       std::move(on_enable_wireframe_callback),
                       std::move(on_create_flatland_view_callback),
                       std::move(on_update_view_callback),
@@ -496,6 +509,7 @@ void Engine::Initialize(
                   std::move(keyboard), std::move(touch_source),
                   std::move(mouse_source), std::move(focuser),
                   std::move(view_ref_focused),
+                  std::move(pointerinjector_registry),
                   std::move(session_listener_request),
                   std::move(on_session_listener_error_callback),
                   std::move(on_enable_wireframe_callback),

shell/platform/fuchsia/flutter/flatland_external_view_embedder.cc

@@ -358,7 +358,7 @@ void FlatlandExternalViewEmbedder::CreateView(
   FlatlandView new_view = {.transform_id = transform_id,
                            .viewport_id = viewport_id};
   flatland_->flatland()->CreateTransform(new_view.transform_id);
-  fuchsia::ui::composition::ChildViewWatcherPtr child_view_watcher;
+  fuchsia::ui::composition::ChildViewWatcherHandle child_view_watcher;
   new_view.pending_create_viewport_callback =
       [this, transform_id, viewport_id, view_id,
        child_view_watcher_request =

shell/platform/fuchsia/flutter/flatland_external_view_embedder.h

@@ -35,7 +35,7 @@ namespace flutter_runner {
 using ViewCallback = std::function<void()>;
 using FlatlandViewCreatedCallback = std::function<void(
     fuchsia::ui::composition::ContentId,
-    fuchsia::ui::composition::ChildViewWatcherPtr child_view_watcher)>;
+    fuchsia::ui::composition::ChildViewWatcherHandle child_view_watcher)>;
 using FlatlandViewIdCallback =
     std::function<void(fuchsia::ui::composition::ContentId)>;
 

shell/platform/fuchsia/flutter/flatland_platform_view.cc

@@ -21,6 +21,7 @@ FlatlandPlatformView::FlatlandPlatformView(
     fuchsia::ui::views::ViewRefFocusedHandle view_ref_focused,
     fuchsia::ui::composition::ParentViewportWatcherHandle
         parent_viewport_watcher,
+    fuchsia::ui::pointerinjector::RegistryHandle pointerinjector_registry,
     OnEnableWireframe wireframe_enabled_callback,
     OnCreateFlatlandView on_create_view_callback,
     OnUpdateView on_update_view_callback,
@@ -43,6 +44,7 @@ FlatlandPlatformView::FlatlandPlatformView(
                    std::move(mouse_source),
                    std::move(focuser),
                    std::move(view_ref_focused),
+                   std::move(pointerinjector_registry),
                    std::move(wireframe_enabled_callback),
                    std::move(on_update_view_callback),
                    std::move(on_create_surface_callback),
@@ -148,6 +150,10 @@ void FlatlandPlatformView::OnChildViewViewRef(
 
   focus_delegate_->OnChildViewViewRef(view_id, std::move(view_ref));
 
+  fuchsia::ui::views::ViewRef view_ref_clone;
+  fidl::Clone(view_ref, &view_ref_clone);
+  pointer_injector_delegate_->OnCreateView(view_id, std::move(view_ref_clone));
+
   child_view_info_.at(content_id)
       .child_view_watcher->GetViewRef(
           [this, content_id, view_id](fuchsia::ui::views::ViewRef view_ref) {
@@ -164,16 +170,32 @@ void FlatlandPlatformView::OnCreateView(ViewCallback on_view_created,
                             task_runners_.GetPlatformTaskRunner(),
                         view_id = view_id_raw](
                            fuchsia::ui::composition::ContentId content_id,
-                           fuchsia::ui::composition::ChildViewWatcherPtr
-                               child_view_watcher) {
+                           fuchsia::ui::composition::ChildViewWatcherHandle
+                               child_view_watcher_handle) {
     FML_CHECK(weak);
     FML_CHECK(weak->child_view_info_.count(content_id.value) == 0);
+
+    // Bind the child view watcher to the platform thread so that the FIDL calls
+    // are handled on the platform thread.
+    fuchsia::ui::composition::ChildViewWatcherPtr child_view_watcher =
+        child_view_watcher_handle.Bind();
     FML_CHECK(child_view_watcher);
 
-    child_view_watcher.set_error_handler([](zx_status_t status) {
-      FML_LOG(ERROR) << "Interface error on: ChildViewWatcher status: "
-                     << status;
-    });
+    child_view_watcher.set_error_handler(
+        [weak, view_id](zx_status_t status) {
+          FML_LOG(ERROR) << "Interface error on: ChildViewWatcher status: "
+                         << status;
+
+          if (!weak) {
+            FML_LOG(WARNING)
+                << "Flatland View bound to PlatformView after PlatformView was "
+                   "destroyed; ignoring.";
+            return;
+          }
+
+          // Disconnected views cannot listen to pointer events.
+          weak->pointer_injector_delegate_->OnDestroyView(view_id);
+        });
 
     platform_task_runner->PostTask(
         fml::MakeCopyable([weak, view_id, content_id,
@@ -226,6 +248,7 @@ void FlatlandPlatformView::OnDisposeView(int64_t view_id_raw) {
           FML_DCHECK(weak->child_view_info_.count(content_id.value) == 1);
           weak->child_view_info_.erase(content_id.value);
           weak->focus_delegate_->OnDisposeChildView(view_id_raw);
+          weak->pointer_injector_delegate_->OnDestroyView(view_id_raw);
         });
       };
   on_destroy_view_callback_(view_id_raw, std::move(on_view_unbound));

shell/platform/fuchsia/flutter/flatland_platform_view.h

@@ -35,6 +35,7 @@ class FlatlandPlatformView final : public flutter_runner::PlatformView {
       fuchsia::ui::views::ViewRefFocusedHandle view_ref_focused,
       fuchsia::ui::composition::ParentViewportWatcherHandle
           parent_viewport_watcher,
+      fuchsia::ui::pointerinjector::RegistryHandle pointerinjector_registry,
       OnEnableWireframe wireframe_enabled_callback,
       OnCreateFlatlandView on_create_view_callback,
       OnUpdateView on_update_view_callback,

shell/platform/fuchsia/flutter/gfx_platform_view.cc

@@ -19,6 +19,7 @@ GfxPlatformView::GfxPlatformView(
     fuchsia::ui::pointer::MouseSourceHandle mouse_source,
     fuchsia::ui::views::FocuserHandle focuser,
     fuchsia::ui::views::ViewRefFocusedHandle view_ref_focused,
+    fuchsia::ui::pointerinjector::RegistryHandle pointerinjector_registry,
     fidl::InterfaceRequest<fuchsia::ui::scenic::SessionListener>
         session_listener_request,
     fit::closure on_session_listener_error_callback,
@@ -44,6 +45,7 @@ GfxPlatformView::GfxPlatformView(
                    std::move(mouse_source),
                    std::move(focuser),
                    std::move(view_ref_focused),
+                   std::move(pointerinjector_registry),
                    std::move(wireframe_enabled_callback),
                    std::move(on_update_view_callback),
                    std::move(on_create_surface_callback),
@@ -295,6 +297,9 @@ bool GfxPlatformView::OnChildViewDisconnected(
       << "}";
   auto call = out.str();
 
+  // A disconnected view cannot listen to pointer events.
+  pointer_injector_delegate_->OnDestroyView(view_id_mapping->second);
+
   std::unique_ptr<flutter::PlatformMessage> message =
       std::make_unique<flutter::PlatformMessage>(
           "flutter/platform_views",
@@ -350,6 +355,7 @@ void GfxPlatformView::OnCreateView(ViewCallback on_view_created,
 
           FML_DCHECK(weak->child_view_ids_.count(resource_id) == 0);
           weak->child_view_ids_[resource_id] = view_id;
+          weak->pointer_injector_delegate_->OnCreateView(view_id);
         });
       };
   on_create_view_callback_(view_id_raw, std::move(on_view_created),
@@ -358,10 +364,10 @@ void GfxPlatformView::OnCreateView(ViewCallback on_view_created,
 
 void GfxPlatformView::OnDisposeView(int64_t view_id_raw) {
   auto on_view_unbound =
-      [weak = weak_factory_.GetWeakPtr(),
+      [weak = weak_factory_.GetWeakPtr(), view_id = view_id_raw,
        platform_task_runner = task_runners_.GetPlatformTaskRunner()](
           scenic::ResourceId resource_id) {
-        platform_task_runner->PostTask([weak, resource_id]() {
+        platform_task_runner->PostTask([weak, resource_id, view_id]() {
           if (!weak) {
             FML_LOG(WARNING)
                 << "ViewHolder unbound from PlatformView after PlatformView"
@@ -371,6 +377,7 @@ void GfxPlatformView::OnDisposeView(int64_t view_id_raw) {
 
           FML_DCHECK(weak->child_view_ids_.count(resource_id) == 1);
           weak->child_view_ids_.erase(resource_id);
+          weak->pointer_injector_delegate_->OnDestroyView(view_id);
         });
       };
   on_destroy_view_callback_(view_id_raw, std::move(on_view_unbound));

shell/platform/fuchsia/flutter/gfx_platform_view.h

@@ -36,6 +36,7 @@ class GfxPlatformView final : public flutter_runner::PlatformView,
       fuchsia::ui::pointer::MouseSourceHandle mouse_source,
       fuchsia::ui::views::FocuserHandle focuser,
       fuchsia::ui::views::ViewRefFocusedHandle view_ref_focused,
+      fuchsia::ui::pointerinjector::RegistryHandle pointerinjector_registry,
       fidl::InterfaceRequest<fuchsia::ui::scenic::SessionListener>
           session_listener_request,
       fit::closure on_session_listener_error_callback,

shell/platform/fuchsia/flutter/meta/common.shard.cml

@@ -48,6 +48,7 @@
                 "fuchsia.ui.input.ImeService",
                 "fuchsia.ui.input3.Keyboard",
                 "fuchsia.ui.scenic.Scenic",
+                "fuchsia.ui.pointerinjector.Registry",
                 "fuchsia.vulkan.loader.Loader"  // Copied from vulkan/client.shard.cml.
             ]
         }