Make updating window metrics multi-view

lib/ui/window/platform_configuration.cc

@@ -308,6 +308,15 @@ void PlatformConfiguration::ReportTimings(std::vector<int64_t> timings) {
                                                }));
 }
 
+Window* PlatformConfiguration::get_window(int window_id) {
+  auto found = windows_.find(window_id);
+  if (found != windows_.end()) {
+    return found->second.get();
+  } else {
+    return nullptr;
+  }
+}
+
 void PlatformConfiguration::CompletePlatformMessageEmptyResponse(
     int response_id) {
   if (!response_id) {

lib/ui/window/platform_configuration.h

@@ -413,9 +413,10 @@ class PlatformConfiguration final {
   ///
   /// @param[in] window_id The id of the window to find and return.
   ///
-  /// @return     a pointer to the Window.
+  /// @return     a pointer to the Window. Returns nullptr if the ID is not
+  ///             found.
   ///
-  Window* get_window(int window_id) { return windows_[window_id].get(); }
+  Window* get_window(int window_id);
 
   //----------------------------------------------------------------------------
   /// @brief      Responds to a previous platform message to the engine from the

lib/ui/window/platform_configuration_unittests.cc

@@ -19,7 +19,9 @@
 namespace flutter {
 namespace testing {
 
-TEST_F(ShellTest, PlatformConfigurationInitialization) {
+class PlatformConfigurationTest : public ShellTest {};
+
+TEST_F(PlatformConfigurationTest, Initialization) {
   auto message_latch = std::make_shared<fml::AutoResetWaitableEvent>();
 
   auto nativeValidateConfiguration = [message_latch](
@@ -63,7 +65,7 @@ TEST_F(ShellTest, PlatformConfigurationInitialization) {
   DestroyShell(std::move(shell), task_runners);
 }
 
-TEST_F(ShellTest, PlatformConfigurationWindowMetricsUpdate) {
+TEST_F(PlatformConfigurationTest, WindowMetricsUpdate) {
   auto message_latch = std::make_shared<fml::AutoResetWaitableEvent>();
 
   auto nativeValidateConfiguration = [message_latch](
@@ -113,7 +115,46 @@ TEST_F(ShellTest, PlatformConfigurationWindowMetricsUpdate) {
   DestroyShell(std::move(shell), task_runners);
 }
 
-TEST_F(ShellTest, PlatformConfigurationOnErrorHandlesError) {
+TEST_F(PlatformConfigurationTest, GetWindowReturnsNullForNonexistentId) {
+  auto message_latch = std::make_shared<fml::AutoResetWaitableEvent>();
+
+  auto nativeValidateConfiguration =
+      [message_latch](Dart_NativeArguments args) {
+        PlatformConfiguration* configuration =
+            UIDartState::Current()->platform_configuration();
+
+        ASSERT_EQ(configuration->get_window(1), nullptr);
+        ASSERT_EQ(configuration->get_window(2), nullptr);
+
+        message_latch->Signal();
+      };
+
+  Settings settings = CreateSettingsForFixture();
+  TaskRunners task_runners("test",                  // label
+                           GetCurrentTaskRunner(),  // platform
+                           CreateNewThread(),       // raster
+                           CreateNewThread(),       // ui
+                           CreateNewThread()        // io
+  );
+
+  AddNativeCallback("ValidateConfiguration",
+                    CREATE_NATIVE_ENTRY(nativeValidateConfiguration));
+
+  std::unique_ptr<Shell> shell = CreateShell(settings, task_runners);
+
+  ASSERT_TRUE(shell->IsSetup());
+  auto run_configuration = RunConfiguration::InferFromSettings(settings);
+  run_configuration.SetEntrypoint("validateConfiguration");
+
+  shell->RunEngine(std::move(run_configuration), [&](auto result) {
+    ASSERT_EQ(result, Engine::RunStatus::Success);
+  });
+
+  message_latch->Wait();
+  DestroyShell(std::move(shell), task_runners);
+}
+
+TEST_F(PlatformConfigurationTest, OnErrorHandlesError) {
   auto message_latch = std::make_shared<fml::AutoResetWaitableEvent>();
   bool did_throw = false;
 
@@ -159,7 +200,7 @@ TEST_F(ShellTest, PlatformConfigurationOnErrorHandlesError) {
   DestroyShell(std::move(shell), task_runners);
 }
 
-TEST_F(ShellTest, PlatformConfigurationOnErrorDoesNotHandleError) {
+TEST_F(PlatformConfigurationTest, OnErrorDoesNotHandleError) {
   auto message_latch = std::make_shared<fml::AutoResetWaitableEvent>();
   std::string ex;
   std::string st;
@@ -211,7 +252,7 @@ TEST_F(ShellTest, PlatformConfigurationOnErrorDoesNotHandleError) {
   DestroyShell(std::move(shell), task_runners);
 }
 
-TEST_F(ShellTest, PlatformConfigurationOnErrorThrows) {
+TEST_F(PlatformConfigurationTest, OnErrorThrows) {
   auto message_latch = std::make_shared<fml::AutoResetWaitableEvent>();
   std::vector<std::string> errors;
   size_t throw_count = 0;
@@ -266,7 +307,7 @@ TEST_F(ShellTest, PlatformConfigurationOnErrorThrows) {
   DestroyShell(std::move(shell), task_runners);
 }
 
-TEST_F(ShellTest, PlatformConfigurationSetDartPerformanceMode) {
+TEST_F(PlatformConfigurationTest, SetDartPerformanceMode) {
   auto message_latch = std::make_shared<fml::AutoResetWaitableEvent>();
   auto finish = [message_latch](Dart_NativeArguments args) {
     // call needs to happen on the UI thread.

runtime/runtime_controller.cc

@@ -20,7 +20,7 @@
 
 namespace flutter {
 
-const uint64_t kFlutterImplicitViewId = 0llu;
+constexpr uint64_t kFlutterImplicitViewId = 0ll;
 
 RuntimeController::RuntimeController(RuntimeDelegate& p_client,
                                      const TaskRunners& task_runners)
@@ -115,7 +115,10 @@ std::unique_ptr<RuntimeController> RuntimeController::Clone() const {
 }
 
 bool RuntimeController::FlushRuntimeStateToIsolate() {
-  return SetViewportMetrics(platform_data_.viewport_metrics) &&
+  // TODO(dkwingsmt): Needs a view ID here (or platform_data should probably
+  // have multiple view metrics).
+  return SetViewportMetrics(kFlutterImplicitViewId,
+                            platform_data_.viewport_metrics) &&
          SetLocales(platform_data_.locale_data) &&
          SetSemanticsEnabled(platform_data_.semantics_enabled) &&
          SetAccessibilityFeatures(
@@ -125,13 +128,19 @@ bool RuntimeController::FlushRuntimeStateToIsolate() {
          SetDisplays(platform_data_.displays);
 }
 
-bool RuntimeController::SetViewportMetrics(const ViewportMetrics& metrics) {
+bool RuntimeController::SetViewportMetrics(int64_t view_id,
+                                           const ViewportMetrics& metrics) {
   TRACE_EVENT0("flutter", "SetViewportMetrics");
   platform_data_.viewport_metrics = metrics;
 
   if (auto* platform_configuration = GetPlatformConfigurationIfAvailable()) {
-    platform_configuration->get_window(0)->UpdateWindowMetrics(metrics);
-    return true;
+    Window* window = platform_configuration->get_window(view_id);
+    if (window) {
+      window->UpdateWindowMetrics(metrics);
+      return true;
+    } else {
+      FML_LOG(WARNING) << "View ID " << view_id << " does not exist.";
+    }
   }
 
   return false;

runtime/runtime_controller.h

@@ -168,11 +168,12 @@ class RuntimeController : public PlatformConfigurationClient {
   ///             If the isolate is not running, these metrics will be saved and
   ///             flushed to the isolate when it starts.
   ///
+  /// @param[in]  view_id  The ID for the view that `metrics` describes.
   /// @param[in]  metrics  The window's viewport metrics.
   ///
   /// @return     If the window metrics were forwarded to the running isolate.
   ///
-  bool SetViewportMetrics(const ViewportMetrics& metrics);
+  bool SetViewportMetrics(int64_t view_id, const ViewportMetrics& metrics);
 
   //----------------------------------------------------------------------------
   /// @brief      Forward the specified display metrics to the running isolate.

shell/common/engine.cc

@@ -292,8 +292,9 @@ tonic::DartErrorHandleType Engine::GetUIIsolateLastError() {
   return runtime_controller_->GetLastError();
 }
 
-void Engine::SetViewportMetrics(const ViewportMetrics& metrics) {
-  runtime_controller_->SetViewportMetrics(metrics);
+void Engine::SetViewportMetrics(int64_t view_id,
+                                const ViewportMetrics& metrics) {
+  runtime_controller_->SetViewportMetrics(view_id, metrics);
   ScheduleFrame();
 }
 

shell/common/engine.h

@@ -677,16 +677,16 @@ class Engine final : public RuntimeDelegate, PointerDataDispatcher::Delegate {
   std::optional<uint32_t> GetUIIsolateReturnCode();
 
   //----------------------------------------------------------------------------
-  /// @brief      Updates the viewport metrics for the currently running Flutter
-  ///             application. The viewport metrics detail the size of the
-  ///             rendering viewport in texels as well as edge insets if
-  ///             present.
+  /// @brief      Updates the viewport metrics for a view. The viewport metrics
+  ///             detail the size of the rendering viewport in texels as well as
+  ///             edge insets if present.
   ///
   /// @see        `ViewportMetrics`
   ///
-  /// @param[in]  metrics  The metrics
+  /// @param[in]  view_id  The ID for the view that `metrics` describes.
+  /// @param[in]  metrics  The metrics.
   ///
-  void SetViewportMetrics(const ViewportMetrics& metrics);
+  void SetViewportMetrics(int64_t view_id, const ViewportMetrics& metrics);
 
   //----------------------------------------------------------------------------
   /// @brief      Updates the display metrics for the currently running Flutter

shell/common/engine_unittests.cc

@@ -21,6 +21,8 @@
 namespace flutter {
 
 namespace {
+constexpr int64_t kImplicitViewId = 0ll;
+
 class MockDelegate : public Engine::Delegate {
  public:
   MOCK_METHOD2(OnEngineUpdateSemantics,
@@ -330,7 +332,8 @@ TEST_F(EngineTest, SpawnResetsViewportMetrics) {
     const double kViewHeight = 1024;
     old_viewport_metrics.physical_width = kViewWidth;
     old_viewport_metrics.physical_height = kViewHeight;
-    mock_runtime_controller->SetViewportMetrics(old_viewport_metrics);
+    mock_runtime_controller->SetViewportMetrics(kImplicitViewId,
+                                                old_viewport_metrics);
     auto engine = std::make_unique<Engine>(
         /*delegate=*/delegate_,
         /*dispatcher_maker=*/dispatcher_maker_,

shell/common/platform_view.cc

@@ -51,8 +51,9 @@ void PlatformView::SetAccessibilityFeatures(int32_t flags) {
   delegate_.OnPlatformViewSetAccessibilityFeatures(flags);
 }
 
-void PlatformView::SetViewportMetrics(const ViewportMetrics& metrics) {
-  delegate_.OnPlatformViewSetViewportMetrics(metrics);
+void PlatformView::SetViewportMetrics(int64_t view_id,
+                                      const ViewportMetrics& metrics) {
+  delegate_.OnPlatformViewSetViewportMetrics(view_id, metrics);
 }
 
 void PlatformView::NotifyCreated() {

shell/common/platform_view.h

@@ -104,14 +104,15 @@ class PlatformView {
         const fml::closure& closure) = 0;
 
     //--------------------------------------------------------------------------
-    /// @brief      Notifies the delegate the viewport metrics of the platform
-    ///             view have been updated. The rasterizer will need to be
-    ///             reconfigured to render the frame in the updated viewport
-    ///             metrics.
+    /// @brief      Notifies the delegate the viewport metrics of a view have
+    ///             been updated. The rasterizer will need to be reconfigured to
+    ///             render the frame in the updated viewport metrics.
     ///
+    /// @param[in]  view_id  The ID for the view that `metrics` describes.
     /// @param[in]  metrics  The updated viewport metrics.
     ///
     virtual void OnPlatformViewSetViewportMetrics(
+        int64_t view_id,
         const ViewportMetrics& metrics) = 0;
 
     //--------------------------------------------------------------------------
@@ -465,16 +466,17 @@ class PlatformView {
                                CustomAccessibilityActionUpdates actions);
 
   //----------------------------------------------------------------------------
-  /// @brief      Used by embedders to specify the updated viewport metrics. In
-  ///             response to this call, on the raster thread, the rasterizer
-  ///             may need to be reconfigured to the updated viewport
+  /// @brief      Used by embedders to specify the updated viewport metrics for
+  ///             a view. In response to this call, on the raster thread, the
+  ///             rasterizer may need to be reconfigured to the updated viewport
   ///             dimensions. On the UI thread, the framework may need to start
   ///             generating a new frame for the updated viewport metrics as
   ///             well.
   ///
+  /// @param[in]  view_id  The ID for the view that `metrics` describes.
   /// @param[in]  metrics  The updated viewport metrics.
   ///
-  void SetViewportMetrics(const ViewportMetrics& metrics);
+  void SetViewportMetrics(int64_t view_id, const ViewportMetrics& metrics);
 
   //----------------------------------------------------------------------------
   /// @brief      Used by embedders to notify the shell that a platform view

shell/common/shell.cc

@@ -954,7 +954,8 @@ void Shell::OnPlatformViewScheduleFrame() {
 }
 
 // |PlatformView::Delegate|
-void Shell::OnPlatformViewSetViewportMetrics(const ViewportMetrics& metrics) {
+void Shell::OnPlatformViewSetViewportMetrics(int64_t view_id,
+                                             const ViewportMetrics& metrics) {
   FML_DCHECK(is_setup_);
   FML_DCHECK(task_runners_.GetPlatformTaskRunner()->RunsTasksOnCurrentThread());
 
@@ -978,9 +979,9 @@ void Shell::OnPlatformViewSetViewportMetrics(const ViewportMetrics& metrics) {
       });
 
   task_runners_.GetUITaskRunner()->PostTask(
-      [engine = engine_->GetWeakPtr(), metrics]() {
+      [engine = engine_->GetWeakPtr(), view_id, metrics]() {
         if (engine) {
-          engine->SetViewportMetrics(metrics);
+          engine->SetViewportMetrics(view_id, metrics);
         }
       });
 

shell/common/shell.h

@@ -544,6 +544,7 @@ class Shell final : public PlatformView::Delegate,
 
   // |PlatformView::Delegate|
   void OnPlatformViewSetViewportMetrics(
+      int64_t view_id,
       const ViewportMetrics& metrics) override;
 
   // |PlatformView::Delegate|

shell/common/shell_test.cc

@@ -20,6 +20,8 @@
 namespace flutter {
 namespace testing {
 
+constexpr int64_t kImplicitViewId = 0;
+
 ShellTest::ShellTest()
     : thread_host_("io.flutter.test." + GetCurrentTestName() + ".",
                    ThreadHost::Type::Platform | ThreadHost::Type::IO |
@@ -144,7 +146,7 @@ void ShellTest::SetViewportMetrics(Shell* shell, double width, double height) {
   shell->GetTaskRunners().GetUITaskRunner()->PostTask(
       [&latch, engine = shell->weak_engine_, viewport_metrics]() {
         if (engine) {
-          engine->SetViewportMetrics(viewport_metrics);
+          engine->SetViewportMetrics(kImplicitViewId, viewport_metrics);
           const auto frame_begin_time = fml::TimePoint::Now();
           const auto frame_end_time =
               frame_begin_time + fml::TimeDelta::FromSecondsF(1.0 / 60.0);
@@ -186,7 +188,7 @@ void ShellTest::PumpOneFrame(Shell* shell,
   fml::AutoResetWaitableEvent latch;
   shell->GetTaskRunners().GetUITaskRunner()->PostTask(
       [&latch, engine = shell->weak_engine_, viewport_metrics]() {
-        engine->SetViewportMetrics(viewport_metrics);
+        engine->SetViewportMetrics(kImplicitViewId, viewport_metrics);
         const auto frame_begin_time = fml::TimePoint::Now();
         const auto frame_end_time =
             frame_begin_time + fml::TimeDelta::FromSecondsF(1.0 / 60.0);