cc: Dedup IPCs to return resources to client

content/browser/renderer_host/render_widget_host_view_aura_unittest.cc

 // Copyright (c) 2012 The Chromium 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 "content/browser/renderer_host/render_widget_host_view_aura.h"
 
 #include <stddef.h>
 #include <stdint.h>
 
 #include <tuple>
@@ skipping 211 matching lines @@
  private:
   // Window that we're observing, or NULL if it's been destroyed.
   aura::Window* window_;
 
   // Was |window_| destroyed?
   bool destroyed_;
 
   DISALLOW_COPY_AND_ASSIGN(TestWindowObserver);
 };
 
+class FakeSurfaceDamageObserver : public cc::SurfaceDamageObserver {
+ public:
+  void OnSurfaceDamaged(const cc::SurfaceId& id, bool* changed) override {
+    *changed = true;
+  }
+};
+
 class FakeFrameSubscriber : public RenderWidgetHostViewFrameSubscriber {
  public:
   FakeFrameSubscriber(gfx::Size size, base::Callback<void(bool)> callback)
       : size_(size), callback_(callback), should_capture_(true) {}
 
   bool ShouldCaptureFrame(const gfx::Rect& damage_rect,
                           base::TimeTicks present_time,
                           scoped_refptr<media::VideoFrame>* storage,
                           DeliverFrameCallback* callback) override {
     if (!should_capture_)
@@ skipping 99 matching lines @@
   }
 
   bool HasFrameData() const {
     return !surface_id().is_null();
   }
 
   bool released_front_lock_active() const {
     return GetDelegatedFrameHost()->ReleasedFrontLockActiveForTesting();
   }
 
+  void ReturnResources(const cc::ReturnedResourceArray& resources) {
+    GetDelegatedFrameHost()->ReturnResources(resources);
+  }
+
+  void ResetCompositor() { GetDelegatedFrameHost()->ResetCompositor(); }
+
   // A lock that doesn't actually do anything to the compositor, and does not
   // time out.
   class FakeResizeLock : public ResizeLock {
    public:
     FakeResizeLock(const gfx::Size new_size, bool defer_compositor_lock)
         : ResizeLock(new_size, defer_compositor_lock) {}
   };
 
   const ui::MotionEventAura& pointer_state_for_test() {
     return pointer_state();
@@ skipping 1231 matching lines @@
                                        gfx::Size size,
                                        gfx::Rect damage) {
   cc::CompositorFrame frame;
   frame.metadata.device_scale_factor = scale_factor;
   frame.delegated_frame_data.reset(new cc::DelegatedFrameData);
 
   std::unique_ptr<cc::RenderPass> pass = cc::RenderPass::Create();
   pass->SetNew(
       cc::RenderPassId(1, 1), gfx::Rect(size), damage, gfx::Transform());
   frame.delegated_frame_data->render_pass_list.push_back(std::move(pass));
+  cc::TransferableResource resource;
+  resource.id = 1;
+  frame.delegated_frame_data->resource_list.push_back(std::move(resource));
   return frame;
 }
 
+// If the ui::Compositor has been reset then resources are returned back to the
+// client in response to the swap. This test verifies that the returned
+// resources are indeed reported as being in response to a swap.
+TEST_F(RenderWidgetHostViewAuraTest, ResettingCompositorReturnsResources) {
+  FakeSurfaceDamageObserver damage_observer;
+  ImageTransportFactory* factory = ImageTransportFactory::GetInstance();
+  cc::SurfaceManager* manager = factory->GetSurfaceManager();
+  manager->AddObserver(&damage_observer);
+
+  gfx::Size view_size(100, 100);
+  gfx::Rect view_rect(view_size);
+
+  view_->InitAsChild(NULL);

[danakj, 2016/07/14 19:55:44]

nullptr

[Fady Samuel, 2016/07/14 23:17:04]

Done. I just did a s/NULL/nullptr

+  aura::client::ParentWindowWithContext(
+      view_->GetNativeView(), parent_view_->GetNativeView()->GetRootWindow(),
+      gfx::Rect());
+  view_->SetSize(view_size);
+  view_->Show();
+  sink_->ClearMessages();
+
+  view_->ResetCompositor();
+
+  // Swappinga  frame should trigger a swap ACK IPC because we have reset the

[danakj, 2016/07/14 19:55:44]

Swapping a frame

[Fady Samuel, 2016/07/14 23:17:04]

Done.

+  // compositor.
+  view_->OnSwapCompositorFrame(0,
+                               MakeDelegatedFrame(1.f, view_size, view_rect));
+  EXPECT_EQ(1u, sink_->message_count());
+  {
+    const IPC::Message* msg = sink_->GetMessageAt(0);
+    EXPECT_EQ(ViewMsg_ReclaimCompositorResources::ID, msg->type());
+    ViewMsg_ReclaimCompositorResources::Param params;
+    ViewMsg_ReclaimCompositorResources::Read(msg, &params);
+    EXPECT_EQ(0u, std::get<0>(params));    // output_surface_id
+    EXPECT_EQ(true, std::get<1>(params));  // is_swap_ack

[danakj, 2016/07/14 19:55:44]

EXPECT_TRUE (i've seen EQ(true/false) fail to compile on some platforms?

[Fady Samuel, 2016/07/14 23:17:04]

Done.

+  }
+  manager->RemoveObserver(&damage_observer);
+}
+
+// This test verifies that returned resources do not require a pending ack.
+TEST_F(RenderWidgetHostViewAuraTest, ReturnedResources) {
+  gfx::Size view_size(100, 100);
+  gfx::Rect view_rect(view_size);
+
+  view_->InitAsChild(NULL);
+  aura::client::ParentWindowWithContext(
+      view_->GetNativeView(), parent_view_->GetNativeView()->GetRootWindow(),
+      gfx::Rect());
+  view_->SetSize(view_size);
+  view_->Show();
+  sink_->ClearMessages();
+
+  // Accumulate some returned resources. This should not trigger an IPC.
+  cc::ReturnedResourceArray resources;
+  cc::ReturnedResource resource;
+  resource.id = 1;
+  resources.push_back(resource);
+  view_->ReturnResources(resources);
+  EXPECT_EQ(1u, sink_->message_count());
+  {
+    const IPC::Message* msg = sink_->GetMessageAt(0);
+    EXPECT_EQ(ViewMsg_ReclaimCompositorResources::ID, msg->type());
+    ViewMsg_ReclaimCompositorResources::Param params;
+    ViewMsg_ReclaimCompositorResources::Read(msg, &params);
+    EXPECT_EQ(0u, std::get<0>(params));     // output_surface_id
+    EXPECT_EQ(false, std::get<1>(params));  // is_swap_ack

[danakj, 2016/07/14 19:55:44]

EXPECT_FALSE

[Fady Samuel, 2016/07/14 23:17:04]

Done.

+  }
+}
+
+// This test verifies that when the output_surface_id changes, then
+// DelegateFrameHost

[danakj, 2016/07/14 19:55:44]

weird line wrapping

[Fady Samuel, 2016/07/14 23:17:04]

Done.

+// returns compositor resources without a swap ack.
+TEST_F(RenderWidgetHostViewAuraTest, TwoOutputSurfaces) {
+  FakeSurfaceDamageObserver damage_observer;
+  ImageTransportFactory* factory = ImageTransportFactory::GetInstance();
+  cc::SurfaceManager* manager = factory->GetSurfaceManager();
+  manager->AddObserver(&damage_observer);
+
+  gfx::Size view_size(100, 100);
+  gfx::Rect view_rect(view_size);
+
+  view_->InitAsChild(NULL);
+  aura::client::ParentWindowWithContext(
+      view_->GetNativeView(), parent_view_->GetNativeView()->GetRootWindow(),
+      gfx::Rect());
+  view_->SetSize(view_size);
+  view_->Show();
+  sink_->ClearMessages();
+
+  view_->OnSwapCompositorFrame(0,
+                               MakeDelegatedFrame(1.f, view_size, view_rect));
+
+  // Accumulate some returned resources. This should not trigger an IPC.
+  cc::ReturnedResourceArray resources;
+  cc::ReturnedResource resource;
+  resource.id = 1;
+  resources.push_back(resource);
+  view_->ReturnResources(resources);
+  EXPECT_EQ(0u, sink_->message_count());
+
+  // Swap another CompositorFrame but this time from another output_surface_id.
+  // This should trigger a non-ACK ReclaimCompositorResources IPC.
+  view_->OnSwapCompositorFrame(1,
+                               MakeDelegatedFrame(1.f, view_size, view_rect));
+  EXPECT_EQ(1u, sink_->message_count());
+  {
+    const IPC::Message* msg = sink_->GetMessageAt(0);
+    EXPECT_EQ(ViewMsg_ReclaimCompositorResources::ID, msg->type());
+    ViewMsg_ReclaimCompositorResources::Param params;
+    ViewMsg_ReclaimCompositorResources::Read(msg, &params);
+    EXPECT_EQ(0u, std::get<0>(params));     // output_surface_id
+    EXPECT_EQ(false, std::get<1>(params));  // is_swap_ack
+  }
+  sink_->ClearMessages();
+
+  // Report that the surface is drawn to trigger an ACK.
+  cc::Surface* surface = manager->GetSurfaceForId(view_->surface_id());
+  EXPECT_TRUE(surface);
+  surface->RunDrawCallbacks(cc::SurfaceDrawStatus::DRAWN);
+  EXPECT_EQ(1u, sink_->message_count());
+  {
+    const IPC::Message* msg = sink_->GetMessageAt(0);
+    EXPECT_EQ(ViewMsg_ReclaimCompositorResources::ID, msg->type());
+    ViewMsg_ReclaimCompositorResources::Param params;
+    ViewMsg_ReclaimCompositorResources::Read(msg, &params);
+    EXPECT_EQ(1u, std::get<0>(params));    // output_surface_id
+    EXPECT_EQ(true, std::get<1>(params));  // is_swap_ack
+  }
+
+  manager->RemoveObserver(&damage_observer);
+}
+
 // Resizing in fullscreen mode should send the up-to-date screen info.
 // http://crbug.com/324350
 TEST_F(RenderWidgetHostViewAuraTest, DISABLED_FullscreenResize) {
   aura::Window* root_window = aura_test_helper_->root_window();
   root_window->SetLayoutManager(new FullscreenLayoutManager(root_window));
   view_->InitAsFullscreen(parent_view_);
   view_->Show();
   widget_host_->ResetSizeAndRepaintPendingFlags();
   sink_->ClearMessages();
 
@@ skipping 200 matching lines @@
   view_->SetSize(size3);
   EXPECT_EQ(size2.ToString(), view_->GetRequestedRendererSize().ToString());
   EXPECT_EQ(0u, sink_->message_count());
 
   // Receive a frame of the new size, should be skipped and not produce a Resize
   // message.
   view_->OnSwapCompositorFrame(
       0, MakeDelegatedFrame(1.f, size3, gfx::Rect(size3)));
   // Expect the frame ack;
   EXPECT_EQ(1u, sink_->message_count());
-  EXPECT_EQ(ViewMsg_SwapCompositorFrameAck::ID, sink_->GetMessageAt(0)->type());
+  EXPECT_EQ(ViewMsg_ReclaimCompositorResources::ID,
+            sink_->GetMessageAt(0)->type());
   sink_->ClearMessages();
   EXPECT_EQ(size2.ToString(), view_->GetRequestedRendererSize().ToString());
 
   // Receive a frame of the correct size, should not be skipped and, and should
   // produce a Resize message after the commit.
   view_->OnSwapCompositorFrame(
       0, MakeDelegatedFrame(1.f, size2, gfx::Rect(size2)));
   cc::SurfaceId surface_id = view_->surface_id();
   if (surface_id.is_null()) {
     // No frame ack yet.
@@ skipping 18 matching lines @@
         // call
         // ui::WindowEventDispatcher::SynthesizeMouseMoveAfterChangeToWindow,
         // which the above WaitForCommit may cause to be picked up. Be robust
         // to this extra IPC coming in.
         InputMsg_HandleInputEvent::Param params;
         InputMsg_HandleInputEvent::Read(msg, &params);
         const blink::WebInputEvent* event = std::get<0>(params);
         EXPECT_EQ(blink::WebInputEvent::MouseMove, event->type);
         break;
       }
-      case ViewMsg_SwapCompositorFrameAck::ID:
+      case ViewMsg_ReclaimCompositorResources::ID:
         break;
       case ViewMsg_Resize::ID: {
         EXPECT_FALSE(has_resize);
         ViewMsg_Resize::Param params;
         ViewMsg_Resize::Read(msg, &params);
         EXPECT_EQ(size3.ToString(), std::get<0>(params).new_size.ToString());
         has_resize = true;
         break;
       }
       default:
@@ skipping 2441 matching lines @@
     // No bounds at index 1.
     EXPECT_FALSE(text_input_client()->GetCompositionCharacterBounds(1, &bound));
 
     // Valid bound at index 0.
     EXPECT_TRUE(text_input_client()->GetCompositionCharacterBounds(0, &bound));
     EXPECT_EQ(4 + (int)index, bound.height());
   }
 }
 
 }  // namespace content