Reland "Send FrameSwapMessageQueue's messages in QueueMessageSwapPromise" with fixes

content/renderer/gpu/queue_message_swap_promise_unittest.cc

 // Copyright 2014 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/renderer/gpu/queue_message_swap_promise.h"
 
 #include <stddef.h>
 
 #include <memory>
 #include <vector>
 
 #include "base/macros.h"
 #include "base/memory/ptr_util.h"
 #include "base/test/scoped_task_environment.h"
 #include "cc/output/swap_promise.h"
+#include "content/common/view_messages.h"
 #include "content/renderer/gpu/frame_swap_message_queue.h"
 #include "content/renderer/gpu/render_widget_compositor.h"
 #include "content/renderer/render_widget.h"
 #include "content/test/mock_render_process.h"
 #include "ipc/ipc_message.h"
 #include "ipc/ipc_sync_message_filter.h"
 #include "ipc/ipc_test_sink.h"
 #include "testing/gtest/include/gtest/gtest.h"
 
 namespace content {
 
 class TestRenderWidget : public RenderWidget {
  public:
   using RenderWidget::QueueMessageImpl;
 
  private:
   ~TestRenderWidget() override {}
 
   DISALLOW_COPY_AND_ASSIGN(TestRenderWidget);
 };
 
 class TestSyncMessageFilter : public IPC::SyncMessageFilter {
  public:
   TestSyncMessageFilter() : IPC::SyncMessageFilter(nullptr) {}
 
   bool Send(IPC::Message* message) override {
-    messages_.push_back(base::WrapUnique(message));
+    if (message->type() == ViewHostMsg_FrameSwapMessages::ID) {
+      ViewHostMsg_FrameSwapMessages::Param param;
+      ViewHostMsg_FrameSwapMessages::Read(message, &param);
+      std::vector<IPC::Message> messages = std::get<1>(param);
+      last_swap_messages_.clear();
+      for (const IPC::Message& message : messages) {
+        last_swap_messages_.push_back(base::MakeUnique<IPC::Message>(message));
+      }
+      delete message;
+    } else {
+      direct_send_messages_.push_back(base::WrapUnique(message));
+    }
     return true;
   }
 
-  std::vector<std::unique_ptr<IPC::Message>>& messages() { return messages_; }
+  std::vector<std::unique_ptr<IPC::Message>>& last_swap_messages() {
+    return last_swap_messages_;
+  }
+
+  const std::vector<std::unique_ptr<IPC::Message>>& direct_send_messages() {
+    return direct_send_messages_;
+  }
 
  private:
   ~TestSyncMessageFilter() override {}
 
-  std::vector<std::unique_ptr<IPC::Message>> messages_;
+  std::vector<std::unique_ptr<IPC::Message>> direct_send_messages_;
+  std::vector<std::unique_ptr<IPC::Message>> last_swap_messages_;
 
   DISALLOW_COPY_AND_ASSIGN(TestSyncMessageFilter);
 };
 
 struct QueueMessageData {
   MessageDeliveryPolicy policy;
   int source_frame_number;
 };
 
 class QueueMessageSwapPromiseTest : public testing::Test {
  public:
   QueueMessageSwapPromiseTest()
-      : frame_swap_message_queue_(new FrameSwapMessageQueue()),
+      : frame_swap_message_queue_(new FrameSwapMessageQueue(0)),
         sync_message_filter_(new TestSyncMessageFilter()) {}
 
   ~QueueMessageSwapPromiseTest() override {}
 
   std::unique_ptr<cc::SwapPromise> QueueMessageImpl(
       IPC::Message* msg,
       MessageDeliveryPolicy policy,
       int source_frame_number) {
     return TestRenderWidget::QueueMessageImpl(
         msg, policy, frame_swap_message_queue_.get(), sync_message_filter_,
         source_frame_number);
   }
 
   const std::vector<std::unique_ptr<IPC::Message>>& DirectSendMessages() {
-    return sync_message_filter_->messages();
+    return sync_message_filter_->direct_send_messages();
+  }
+
+  std::vector<std::unique_ptr<IPC::Message>>& LastSwapMessages() {
+    return sync_message_filter_->last_swap_messages();
   }
 
   std::vector<std::unique_ptr<IPC::Message>>& NextSwapMessages() {
     next_swap_messages_.clear();
     std::unique_ptr<FrameSwapMessageQueue::SendMessageScope>
         send_message_scope =
             frame_swap_message_queue_->AcquireSendMessageScope();
     frame_swap_message_queue_->DrainMessages(&next_swap_messages_);
     return next_swap_messages_;
   }
 
   bool ContainsMessage(
       const std::vector<std::unique_ptr<IPC::Message>>& messages,
       const IPC::Message& message) {
     if (messages.empty())
       return false;
     for (const auto& msg : messages) {
       if (msg->type() == message.type())
         return true;
     }
     return false;
   }
 
+  bool LastSwapHasMessage(const IPC::Message& message) {
+    return ContainsMessage(LastSwapMessages(), message);
+  }
+
   bool NextSwapHasMessage(const IPC::Message& message) {
     return ContainsMessage(NextSwapMessages(), message);
   }
 
   void QueueMessages(QueueMessageData data[], size_t count) {
     for (size_t i = 0; i < count; ++i) {
       messages_.push_back(
           IPC::Message(0, i + 1, IPC::Message::PRIORITY_NORMAL));
       promises_.push_back(QueueMessageImpl(new IPC::Message(messages_[i]),
                                            data[i].policy,
                                            data[i].source_frame_number));
     }
   }
 
   void CleanupPromises() {
     for (const auto& promise : promises_) {
       if (promise.get()) {
         promise->DidActivate();
-        promise->WillSwap(NULL);
+        promise->WillSwap(&dummy_metadata_);
         promise->DidSwap();
       }
     }
   }
 
  protected:
   void VisualStateSwapPromiseDidNotSwap(
       cc::SwapPromise::DidNotSwapReason reason);
 
   base::test::ScopedTaskEnvironment scoped_task_environment_;
   scoped_refptr<FrameSwapMessageQueue> frame_swap_message_queue_;
   scoped_refptr<TestSyncMessageFilter> sync_message_filter_;
   std::vector<IPC::Message> messages_;
   std::vector<std::unique_ptr<cc::SwapPromise>> promises_;
+  cc::CompositorFrameMetadata dummy_metadata_;
 
  private:
   std::vector<std::unique_ptr<IPC::Message>> next_swap_messages_;
 
   DISALLOW_COPY_AND_ASSIGN(QueueMessageSwapPromiseTest);
 };
 
 TEST_F(QueueMessageSwapPromiseTest, NextSwapPolicySchedulesMessageForNextSwap) {
   QueueMessageData data[] = {
     /* { policy, source_frame_number } */
     {MESSAGE_DELIVERY_POLICY_WITH_NEXT_SWAP, 1},
   };
   QueueMessages(data, arraysize(data));
 
   ASSERT_TRUE(promises_[0].get());
   promises_[0]->DidActivate();
-  promises_[0]->WillSwap(NULL);
+  promises_[0]->WillSwap(&dummy_metadata_);
   promises_[0]->DidSwap();
 
   EXPECT_TRUE(DirectSendMessages().empty());
-  EXPECT_FALSE(frame_swap_message_queue_->Empty());
-  // frame_swap_message_queue_->WillSwap(1);
-  EXPECT_TRUE(NextSwapHasMessage(messages_[0]));
+  EXPECT_TRUE(frame_swap_message_queue_->Empty());
+  EXPECT_TRUE(LastSwapHasMessage(messages_[0]));
 }
 
 TEST_F(QueueMessageSwapPromiseTest, NextSwapPolicyNeedsAtMostOnePromise) {
   QueueMessageData data[] = {
     /* { policy, source_frame_number } */
     {MESSAGE_DELIVERY_POLICY_WITH_NEXT_SWAP, 1},
     {MESSAGE_DELIVERY_POLICY_WITH_NEXT_SWAP, 1},
   };
   QueueMessages(data, arraysize(data));
 
   ASSERT_TRUE(promises_[0].get());
   ASSERT_FALSE(promises_[1].get());
 
   CleanupPromises();
 }
 
 TEST_F(QueueMessageSwapPromiseTest, NextSwapPolicySendsMessageOnNoUpdate) {
   QueueMessageData data[] = {
     /* { policy, source_frame_number } */
     {MESSAGE_DELIVERY_POLICY_WITH_NEXT_SWAP, 1},
   };
   QueueMessages(data, arraysize(data));
 
   promises_[0]->DidNotSwap(cc::SwapPromise::COMMIT_NO_UPDATE);
   EXPECT_TRUE(ContainsMessage(DirectSendMessages(), messages_[0]));
-  EXPECT_TRUE(NextSwapMessages().empty());
+  EXPECT_TRUE(LastSwapMessages().empty());
   EXPECT_TRUE(frame_swap_message_queue_->Empty());
 }
 
 TEST_F(QueueMessageSwapPromiseTest, NextSwapPolicySendsMessageOnSwapFails) {
   QueueMessageData data[] = {
     /* { policy, source_frame_number } */
     {MESSAGE_DELIVERY_POLICY_WITH_NEXT_SWAP, 1},
   };
   QueueMessages(data, arraysize(data));
 
   promises_[0]->DidNotSwap(cc::SwapPromise::SWAP_FAILS);
   EXPECT_TRUE(ContainsMessage(DirectSendMessages(), messages_[0]));
-  EXPECT_TRUE(NextSwapMessages().empty());
+  EXPECT_TRUE(LastSwapMessages().empty());
   EXPECT_TRUE(frame_swap_message_queue_->Empty());
 }
 
 TEST_F(QueueMessageSwapPromiseTest, NextSwapPolicyRetainsMessageOnCommitFails) {
   QueueMessageData data[] = {
     /* { policy, source_frame_number } */
     {MESSAGE_DELIVERY_POLICY_WITH_NEXT_SWAP, 1},
   };
   QueueMessages(data, arraysize(data));
 
   promises_[0]->DidNotSwap(cc::SwapPromise::COMMIT_FAILS);
   EXPECT_TRUE(DirectSendMessages().empty());
+  EXPECT_TRUE(LastSwapMessages().empty());
   EXPECT_FALSE(frame_swap_message_queue_->Empty());
   frame_swap_message_queue_->DidSwap(2);
   EXPECT_TRUE(NextSwapHasMessage(messages_[0]));
 }
 
 TEST_F(QueueMessageSwapPromiseTest,
        VisualStateQueuesMessageWhenCommitRequested) {
   QueueMessageData data[] = {
     /* { policy, source_frame_number } */
     {MESSAGE_DELIVERY_POLICY_WITH_VISUAL_STATE, 1},
@@ skipping 27 matching lines @@
 TEST_F(QueueMessageSwapPromiseTest, VisualStateSwapPromiseDidActivate) {
   QueueMessageData data[] = {
     /* { policy, source_frame_number } */
     {MESSAGE_DELIVERY_POLICY_WITH_VISUAL_STATE, 1},
     {MESSAGE_DELIVERY_POLICY_WITH_VISUAL_STATE, 1},
     {MESSAGE_DELIVERY_POLICY_WITH_VISUAL_STATE, 2},
   };
   QueueMessages(data, arraysize(data));
 
   promises_[0]->DidActivate();
-  promises_[0]->WillSwap(NULL);
+  promises_[0]->WillSwap(&dummy_metadata_);
   promises_[0]->DidSwap();
   ASSERT_FALSE(promises_[1].get());
   std::vector<std::unique_ptr<IPC::Message>> messages;
-  messages.swap(NextSwapMessages());
+  messages.swap(LastSwapMessages());
   EXPECT_EQ(2u, messages.size());
   EXPECT_TRUE(ContainsMessage(messages, messages_[0]));
   EXPECT_TRUE(ContainsMessage(messages, messages_[1]));
   EXPECT_FALSE(ContainsMessage(messages, messages_[2]));
 
   promises_[2]->DidActivate();
   promises_[2]->DidNotSwap(cc::SwapPromise::SWAP_FAILS);
   messages.swap(NextSwapMessages());
   EXPECT_TRUE(messages.empty());
 
@@ skipping 47 matching lines @@
 TEST_F(QueueMessageSwapPromiseTest, VisualStateSwapPromiseDidNotSwapSwapFails) {
   VisualStateSwapPromiseDidNotSwap(cc::SwapPromise::SWAP_FAILS);
 }
 
 TEST_F(QueueMessageSwapPromiseTest,
        VisualStateSwapPromiseDidNotSwapActivationFails) {
   VisualStateSwapPromiseDidNotSwap(cc::SwapPromise::ACTIVATION_FAILS);
 }
 
 }  // namespace content