cc: Make BackToBackBeginFrameSource a SyntheticBeginFrameSource.

cc/scheduler/begin_frame_source_unittest.cc

 // Copyright 2011 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 "cc/scheduler/begin_frame_source.h"
 
 #include <stdint.h>
 
 #include "base/memory/ptr_util.h"
 #include "base/test/test_simple_task_runner.h"
@@ skipping 155 matching lines @@
 
   EXPECT_BEGIN_FRAME_SOURCE_PAUSED(obs2, false);
   source.SetBeginFrameSourcePaused(false);
 
   EXPECT_BEGIN_FRAME_USED(obs2, 300, 400, 100);
   SEND_BEGIN_FRAME_USED(source, 300, 400, 100);
 
   source.RemoveObserver(&obs2);
 }
 
-// BackToBackBeginFrameSource testing -----------------------------------------
-class TestBackToBackBeginFrameSource : public BackToBackBeginFrameSource {
- public:
-  TestBackToBackBeginFrameSource(base::SimpleTestTickClock* now_src,
-                                 base::SingleThreadTaskRunner* task_runner)
-      : BackToBackBeginFrameSource(task_runner), now_src_(now_src) {}
-
+class BackToBackBeginFrameSourceTest : public ::testing::Test {
  protected:
-  base::TimeTicks Now() override { return now_src_->NowTicks(); }
-
-  // Not owned.
-  base::SimpleTestTickClock* now_src_;
-};
-
-class BackToBackBeginFrameSourceTest : public ::testing::Test {
- public:
   static const int64_t kDeadline;
   static const int64_t kInterval;
 
-  std::unique_ptr<base::SimpleTestTickClock> now_src_;
-  scoped_refptr<OrderedSimpleTaskRunner> task_runner_;
-  std::unique_ptr<TestBackToBackBeginFrameSource> source_;
-  std::unique_ptr<MockBeginFrameObserver> obs_;
-
   void SetUp() override {
     now_src_.reset(new base::SimpleTestTickClock());
     now_src_->Advance(base::TimeDelta::FromMicroseconds(1000));
     task_runner_ =
         make_scoped_refptr(new OrderedSimpleTaskRunner(now_src_.get(), false));
-    source_.reset(
-        new TestBackToBackBeginFrameSource(now_src_.get(), task_runner_.get()));
-    obs_ =
-        base::WrapUnique(new ::testing::StrictMock<MockBeginFrameObserver>());
+    std::unique_ptr<TestDelayBasedTimeSource> time_source(
+        new TestDelayBasedTimeSource(now_src_.get(), task_runner_.get()));
+    source_.reset(new SyntheticBeginFrameSource(std::move(time_source)));
+    source_->SetUnthrottled(true);
+    obs_ = base::WrapUnique(new ::testing::StrictMock<MockBeginFrameObserver>);
   }
 
   void TearDown() override { obs_.reset(); }
+
+  std::unique_ptr<base::SimpleTestTickClock> now_src_;
+  scoped_refptr<OrderedSimpleTaskRunner> task_runner_;
+  std::unique_ptr<SyntheticBeginFrameSource> source_;
+  std::unique_ptr<MockBeginFrameObserver> obs_;
 };
 
 const int64_t BackToBackBeginFrameSourceTest::kDeadline =
     BeginFrameArgs::DefaultInterval().ToInternalValue();
 
 const int64_t BackToBackBeginFrameSourceTest::kInterval =
     BeginFrameArgs::DefaultInterval().ToInternalValue();
 
 TEST_F(BackToBackBeginFrameSourceTest, AddObserverSendsBeginFrame) {
   EXPECT_BEGIN_FRAME_SOURCE_PAUSED(*obs_, false);
@@ skipping 11 matching lines @@
 TEST_F(BackToBackBeginFrameSourceTest,
        DidFinishFrameThenRemoveObserverProducesNoFrame) {
   EXPECT_BEGIN_FRAME_SOURCE_PAUSED(*obs_, false);
   source_->AddObserver(obs_.get());
   EXPECT_BEGIN_FRAME_USED(*obs_, 1000, 1000 + kDeadline, kInterval);
   task_runner_->RunPendingTasks();
 
   source_->RemoveObserver(obs_.get());
   source_->DidFinishFrame(obs_.get(), 0);
 
+  // Verify no BeginFrame is sent to |obs_|. There is a pending task in the
+  // task_runner_ as a BeginFrame was posted, but it gets aborted since |obs_|
+  // is removed.
+  task_runner_->RunPendingTasks();
   EXPECT_FALSE(task_runner_->HasPendingTasks());
 }
 
 TEST_F(BackToBackBeginFrameSourceTest,
        RemoveObserverThenDidFinishFrameProducesNoFrame) {
   EXPECT_BEGIN_FRAME_SOURCE_PAUSED(*obs_, false);
   source_->AddObserver(obs_.get());
   EXPECT_BEGIN_FRAME_USED(*obs_, 1000, 1000 + kDeadline, kInterval);
   task_runner_->RunPendingTasks();
 
@@ skipping 16 matching lines @@
   source_->RemoveObserver(obs_.get());
 
   now_src_->Advance(base::TimeDelta::FromMicroseconds(10));
   EXPECT_BEGIN_FRAME_SOURCE_PAUSED(*obs_, false);
   source_->AddObserver(obs_.get());
 
   now_src_->Advance(base::TimeDelta::FromMicroseconds(10));
   source_->DidFinishFrame(obs_.get(), 0);
 
   now_src_->Advance(base::TimeDelta::FromMicroseconds(10));
-  EXPECT_BEGIN_FRAME_USED(*obs_, 1130, 1130 + kDeadline, kInterval);
+  // The begin frame is posted at the time when the observer was added,
+  // so it ignores changes to "now" afterward.
+  EXPECT_BEGIN_FRAME_USED(*obs_, 1110, 1110 + kDeadline, kInterval);
   EXPECT_TRUE(task_runner_->HasPendingTasks());
   task_runner_->RunPendingTasks();
 }
 
 TEST_F(BackToBackBeginFrameSourceTest,
        DidFinishFrameThenTogglingObserverProducesCorrectFrame) {
   EXPECT_BEGIN_FRAME_SOURCE_PAUSED(*obs_, false);
   source_->AddObserver(obs_.get());
   EXPECT_BEGIN_FRAME_USED(*obs_, 1000, 1000 + kDeadline, kInterval);
   task_runner_->RunPendingTasks();
 
   now_src_->Advance(base::TimeDelta::FromMicroseconds(100));
   source_->DidFinishFrame(obs_.get(), 0);
 
   now_src_->Advance(base::TimeDelta::FromMicroseconds(10));
   source_->RemoveObserver(obs_.get());
 
   now_src_->Advance(base::TimeDelta::FromMicroseconds(10));
   EXPECT_BEGIN_FRAME_SOURCE_PAUSED(*obs_, false);
   source_->AddObserver(obs_.get());
 
   now_src_->Advance(base::TimeDelta::FromMicroseconds(10));
-  EXPECT_BEGIN_FRAME_USED(*obs_, 1130, 1130 + kDeadline, kInterval);
+  // Ticks at the time at which the observer was added, ignoring the
+  // last change to "now".
+  EXPECT_BEGIN_FRAME_USED(*obs_, 1120, 1120 + kDeadline, kInterval);
   EXPECT_TRUE(task_runner_->HasPendingTasks());
   task_runner_->RunPendingTasks();
 }
 
 TEST_F(BackToBackBeginFrameSourceTest, DidFinishFrameNoObserver) {
   EXPECT_BEGIN_FRAME_SOURCE_PAUSED(*obs_, false);
   source_->AddObserver(obs_.get());
   source_->RemoveObserver(obs_.get());
   source_->DidFinishFrame(obs_.get(), 0);
   EXPECT_FALSE(task_runner_->RunPendingTasks());
 }
 
 TEST_F(BackToBackBeginFrameSourceTest, DidFinishFrameRemainingFrames) {
   EXPECT_BEGIN_FRAME_SOURCE_PAUSED(*obs_, false);
   source_->AddObserver(obs_.get());
   EXPECT_BEGIN_FRAME_USED(*obs_, 1000, 1000 + kDeadline, kInterval);
+  // Runs the pending begin frame.
   task_runner_->RunPendingTasks();
+  // While running the begin frame, the next frame was cancelled, this
+  // runs the next frame, sees it was cancelled, and goes to sleep.
+  task_runner_->RunPendingTasks();
+  EXPECT_FALSE(task_runner_->HasPendingTasks());
 
   now_src_->Advance(base::TimeDelta::FromMicroseconds(100));
 
   source_->DidFinishFrame(obs_.get(), 3);
   EXPECT_FALSE(task_runner_->HasPendingTasks());
   source_->DidFinishFrame(obs_.get(), 2);
   EXPECT_FALSE(task_runner_->HasPendingTasks());
   source_->DidFinishFrame(obs_.get(), 1);
   EXPECT_FALSE(task_runner_->HasPendingTasks());
 
@@ skipping 26 matching lines @@
 
 TEST_F(BackToBackBeginFrameSourceTest, DelayInPostedTaskProducesCorrectFrame) {
   EXPECT_BEGIN_FRAME_SOURCE_PAUSED(*obs_, false);
   source_->AddObserver(obs_.get());
   EXPECT_BEGIN_FRAME_USED(*obs_, 1000, 1000 + kDeadline, kInterval);
   task_runner_->RunPendingTasks();
 
   now_src_->Advance(base::TimeDelta::FromMicroseconds(100));
   source_->DidFinishFrame(obs_.get(), 0);
   now_src_->Advance(base::TimeDelta::FromMicroseconds(50));
-  EXPECT_BEGIN_FRAME_USED(*obs_, 1150, 1150 + kDeadline, kInterval);
+  // Ticks at the time the last frame finished, so ignores the last change to
+  // "now".
+  EXPECT_BEGIN_FRAME_USED(*obs_, 1100, 1100 + kDeadline, kInterval);
 
   EXPECT_TRUE(task_runner_->HasPendingTasks());
   task_runner_->RunPendingTasks();
 }
 
 TEST_F(BackToBackBeginFrameSourceTest, MultipleObserversSynchronized) {
   StrictMock<MockBeginFrameObserver> obs1, obs2;
 
   EXPECT_BEGIN_FRAME_SOURCE_PAUSED(obs1, false);
   source_->AddObserver(&obs1);
@@ skipping 34 matching lines @@
   EXPECT_BEGIN_FRAME_USED(obs2, 1100, 1100 + kDeadline, kInterval);
   task_runner_->RunPendingTasks();
 
   now_src_->Advance(base::TimeDelta::FromMicroseconds(100));
   source_->DidFinishFrame(&obs1, 0);
   EXPECT_BEGIN_FRAME_USED(obs1, 1200, 1200 + kDeadline, kInterval);
   task_runner_->RunPendingTasks();
 
   source_->DidFinishFrame(&obs1, 0);
   source_->RemoveObserver(&obs1);
+  // Finishing the frame for |obs1| posts a begin frame task, which will be
+  // aborted since |obs1| is removed. Clear that from the task runner.
+  task_runner_->RunPendingTasks();
 
   now_src_->Advance(base::TimeDelta::FromMicroseconds(100));
   source_->DidFinishFrame(&obs2, 0);
   EXPECT_BEGIN_FRAME_USED(obs2, 1300, 1300 + kDeadline, kInterval);
   task_runner_->RunPendingTasks();
 
   source_->DidFinishFrame(&obs2, 0);
   source_->RemoveObserver(&obs2);
 }
 
+TEST_F(BackToBackBeginFrameSourceTest, MultipleObserversAtOnce) {
+  StrictMock<MockBeginFrameObserver> obs1, obs2;
+
+  EXPECT_BEGIN_FRAME_SOURCE_PAUSED(obs1, false);
+  EXPECT_BEGIN_FRAME_SOURCE_PAUSED(obs2, false);
+  source_->AddObserver(&obs1);
+  source_->AddObserver(&obs2);
+  EXPECT_BEGIN_FRAME_USED(obs1, 1000, 1000 + kDeadline, kInterval);
+  EXPECT_BEGIN_FRAME_USED(obs2, 1000, 1000 + kDeadline, kInterval);
+  task_runner_->RunPendingTasks();
+
+  // |obs1| finishes first.
+  now_src_->Advance(base::TimeDelta::FromMicroseconds(100));
+  source_->DidFinishFrame(&obs1, 0);
+
+  // |obs2| finishes also, before getting to the newly posted begin frame.
+  now_src_->Advance(base::TimeDelta::FromMicroseconds(100));
+  source_->DidFinishFrame(&obs2, 0);
+
+  // Because the begin frame source already ticked when |obs1| finished,
+  // we see it as the frame time for both observers.
+  EXPECT_BEGIN_FRAME_USED(obs1, 1100, 1100 + kDeadline, kInterval);
+  EXPECT_BEGIN_FRAME_USED(obs2, 1100, 1100 + kDeadline, kInterval);
+  task_runner_->RunPendingTasks();
+
+  source_->DidFinishFrame(&obs1, 0);
+  source_->RemoveObserver(&obs1);
+  source_->DidFinishFrame(&obs2, 0);
+  source_->RemoveObserver(&obs2);
+}
+
 // SyntheticBeginFrameSource testing ------------------------------------------
 class SyntheticBeginFrameSourceTest : public ::testing::Test {
  public:
   std::unique_ptr<base::SimpleTestTickClock> now_src_;
   scoped_refptr<OrderedSimpleTaskRunner> task_runner_;
-  std::unique_ptr<TestSyntheticBeginFrameSource> source_;
+  std::unique_ptr<SyntheticBeginFrameSource> source_;
   std::unique_ptr<MockBeginFrameObserver> obs_;
 
   void SetUp() override {
     now_src_.reset(new base::SimpleTestTickClock());
     now_src_->Advance(base::TimeDelta::FromMicroseconds(1000));
     task_runner_ =
         make_scoped_refptr(new OrderedSimpleTaskRunner(now_src_.get(), false));
-    source_.reset(new TestSyntheticBeginFrameSource(
-        now_src_.get(), task_runner_.get(),
-        base::TimeDelta::FromMicroseconds(10000)));
-    obs_ = base::WrapUnique(new MockBeginFrameObserver());
+    std::unique_ptr<DelayBasedTimeSource> time_source(
+        new TestDelayBasedTimeSource(now_src_.get(), task_runner_.get()));
+    time_source->SetTimebaseAndInterval(
+        base::TimeTicks(), base::TimeDelta::FromMicroseconds(10000));
+    source_.reset(new SyntheticBeginFrameSource(std::move(time_source)));
+    obs_.reset(new MockBeginFrameObserver);
   }
 
   void TearDown() override { obs_.reset(); }
 };
 
 TEST_F(SyntheticBeginFrameSourceTest,
        AddObserverCallsOnBeginFrameWithMissedTick) {
   now_src_->Advance(base::TimeDelta::FromMicroseconds(9010));
   EXPECT_BEGIN_FRAME_SOURCE_PAUSED(*obs_, false);
   EXPECT_BEGIN_FRAME_USED_MISSED(*obs_, 10000, 20000, 10000);
@@ skipping 152 matching lines @@
                                    base::TimeDelta::FromInternalValue(10000));
   now_src_->Advance(base::TimeDelta::FromInternalValue(5000));
   EXPECT_BEGIN_FRAME_SOURCE_PAUSED(obs, false);
   EXPECT_BEGIN_FRAME_USED_MISSED(obs, 10000, 20000, 10000);
   source_->AddObserver(&obs);
   source_->RemoveObserver(&obs);
 }
 
 }  // namespace
 }  // namespace cc