Move logic of recording main thread scrolling reasons from cc to blink::ScrollManager

third_party/WebKit/Source/core/input/EventHandlerTest.cpp

 // Copyright 2015 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 "core/input/EventHandler.h"
 
 #include <memory>
 #include "core/dom/Document.h"
 #include "core/dom/Range.h"
 #include "core/editing/Editor.h"
 #include "core/editing/FrameSelection.h"
 #include "core/frame/FrameView.h"
 #include "core/frame/LocalFrame.h"
 #include "core/frame/Settings.h"
+#include "core/layout/LayoutBox.h"
 #include "core/loader/EmptyClients.h"
 #include "core/page/AutoscrollController.h"
 #include "core/page/Page.h"
+#include "core/paint/PaintLayerScrollableArea.h"
 #include "core/testing/DummyPageHolder.h"
+#include "platform/scroll/MainThreadScrollingReason.h"
+#include "platform/testing/HistogramTester.h"
 #include "testing/gtest/include/gtest/gtest.h"
 
+#define EXPECT_WHEEL_BUCKET(reason, count)     \
+  histogram_tester.ExpectBucketCount(          \
+      "Renderer4.MainThreadWheelScrollReason", \
+      GetBucketIndex(MainThreadScrollingReason::reason), count);
+
+#define EXPECT_TOUCH_BUCKET(reason, count)       \
+  histogram_tester.ExpectBucketCount(            \
+      "Renderer4.MainThreadGestureScrollReason", \
+      GetBucketIndex(MainThreadScrollingReason::reason), count);
+
+#define EXPECT_WHEEL_TOTAL(count)                                            \
+  histogram_tester.ExpectTotalCount("Renderer4.MainThreadWheelScrollReason", \
+                                    count);
+
+#define EXPECT_TOUCH_TOTAL(count)                                              \
+  histogram_tester.ExpectTotalCount("Renderer4.MainThreadGestureScrollReason", \
+                                    count);
+
 namespace blink {
 
 class EventHandlerTest : public ::testing::Test {
  protected:
   void SetUp() override;
 
   Page& GetPage() const { return dummy_page_holder_->GetPage(); }
   Document& GetDocument() const { return dummy_page_holder_->GetDocument(); }
   FrameSelection& Selection() const {
     return GetDocument().GetFrame()->Selection();
   }
 
   void SetHtmlInnerHTML(const char* html_content);
 
  protected:
   std::unique_ptr<DummyPageHolder> dummy_page_holder_;
 };
 
+class NonCompositedMainThreadScrollingReasonRecordTest
+    : public EventHandlerTest {
+ protected:
+  class ScrollBeginEventBuilder : public WebGestureEvent {
+   public:
+    ScrollBeginEventBuilder(IntPoint position,
+                            FloatPoint delta,
+                            WebGestureDevice device)
+        : WebGestureEvent() {
+      type_ = WebInputEvent::kGestureScrollBegin;
+      x = global_x = position.X();
+      y = global_y = position.Y();
+      data.scroll_begin.delta_y_hint = delta.Y();
+      source_device = device;
+      frame_scale_ = 1;
+    }
+  };
+
+  class ScrollUpdateEventBuilder : public WebGestureEvent {
+   public:
+    ScrollUpdateEventBuilder() : WebGestureEvent() {
+      type_ = WebInputEvent::kGestureScrollUpdate;
+      data.scroll_update.delta_x = 0.0f;
+      data.scroll_update.delta_y = 1.0f;
+      data.scroll_update.velocity_x = 0;
+      data.scroll_update.velocity_y = 1;
+      frame_scale_ = 1;
+    }
+  };
+
+  class ScrollEndEventBuilder : public WebGestureEvent {
+   public:
+    ScrollEndEventBuilder() : WebGestureEvent() {
+      type_ = WebInputEvent::kGestureScrollEnd;
+      frame_scale_ = 1;
+    }
+  };
+
+  int GetBucketIndex(uint32_t reason);
+  void Scroll(const Element*,
+              const WebGestureDevice = kWebGestureDeviceTouchpad);

[bokan, 2017/04/11 17:30:52]

No default param. It should be clear at the call site which device we're
scrolling on.

[yigu, 2017/04/11 21:28:10]

Done.

+};
+
 class TapEventBuilder : public WebGestureEvent {
  public:
   TapEventBuilder(IntPoint position, int tap_count)
       : WebGestureEvent(WebInputEvent::kGestureTap,
                         WebInputEvent::kNoModifiers,
                         TimeTicks::Now().InSeconds()) {
     x = global_x = position.X();
     y = global_y = position.Y();
     source_device = kWebGestureDeviceTouchscreen;
     data.tap.tap_count = tap_count;
@@ skipping 34 matching lines @@
 
 void EventHandlerTest::SetUp() {
   dummy_page_holder_ = DummyPageHolder::Create(IntSize(300, 400));
 }
 
 void EventHandlerTest::SetHtmlInnerHTML(const char* html_content) {
   GetDocument().documentElement()->setInnerHTML(String::FromUTF8(html_content));
   GetDocument().View()->UpdateAllLifecyclePhases();
 }
 
+int NonCompositedMainThreadScrollingReasonRecordTest::GetBucketIndex(
+    uint32_t reason) {
+  int index = 1;
+  while (!(reason & 1)) {
+    reason >>= 1;
+    ++index;
+  }
+  DCHECK_EQ(reason, 1u);
+  return index;
+}
+
+void NonCompositedMainThreadScrollingReasonRecordTest::Scroll(
+    const Element* element,
+    const WebGestureDevice device) {
+  DCHECK(element);
+  DCHECK(element->GetLayoutBox());
+  LayoutBox* box = element->GetLayoutBox();
+  ScrollBeginEventBuilder scroll_begin(
+      IntPoint(box->Location().X().ToInt() + box->size().Width().ToInt() / 2,

[bokan, 2017/04/11 17:30:52]

Location() is relative to its container, which is not what you want. You need
relative to the root frame. In that case, you should use
Element::getBoundingClientRect

[yigu, 2017/04/11 21:28:10]

Done.

+               box->Location().Y().ToInt() + box->size().Height().ToInt() / 2),
+      FloatPoint(0.f, 1.f), device);
+  ScrollUpdateEventBuilder scroll_update;
+  ScrollEndEventBuilder scroll_end;
+  GetDocument().GetFrame()->GetEventHandler().HandleGestureEvent(scroll_begin);
+  GetDocument().GetFrame()->GetEventHandler().HandleGestureEvent(scroll_update);
+  GetDocument().GetFrame()->GetEventHandler().HandleGestureEvent(scroll_end);
+}
+
 TEST_F(EventHandlerTest, dragSelectionAfterScroll) {
   SetHtmlInnerHTML(
       "<style> body { margin: 0px; } .upper { width: 300px; height: 400px; }"
       ".lower { margin: 0px; width: 300px; height: 400px; } .line { display: "
       "block; width: 300px; height: 30px; } </style>"
       "<div class='upper'></div>"
       "<div class='lower'>"
       "<span class='line'>Line 1</span><span class='line'>Line 2</span><span "
       "class='line'>Line 3</span><span class='line'>Line 4</span><span "
       "class='line'>Line 5</span>"
@@ skipping 438 matching lines @@
       WebInputEvent::kMouseLeave, WebFloatPoint(0, 0), WebFloatPoint(0, 0),
       WebPointerProperties::Button::kNoButton, 0, WebInputEvent::kNoModifiers,
       TimeTicks::Now().InSeconds());
   mouse_leave_event.SetFrameScale(1);
   GetDocument().GetFrame()->GetEventHandler().HandleMouseLeaveEvent(
       mouse_leave_event);
 
   EXPECT_EQ(WTF::String(), LastToolTip());
 }
 
+TEST_F(NonCompositedMainThreadScrollingReasonRecordTest,
+       TouchAndWheelGeneralTest) {
+  SetHtmlInnerHTML(
+      "<style>"
+      " .box { overflow:scroll; width: 100px; height: 100px; }"
+      " .translucent { opacity: 0.5; }"
+      " .spacer { height: 1000px; }"
+      "</style>"
+      "<div id='box' class='translucent box'>"
+      " <div class='spacer'></div>"
+      "</div>");
+
+  GetDocument().View()->UpdateAllLifecyclePhases();
+
+  Element* box = GetDocument().getElementById("box");
+  HistogramTester histogram_tester;
+
+  // Test touch scroll.
+  Scroll(box, kWebGestureDeviceTouchscreen);
+  EXPECT_TOUCH_BUCKET(kHasOpacityAndLCDText, 1);
+  EXPECT_TOUCH_BUCKET(kBackgroundNotOpaqueInRectAndLCDText, 1);
+
+  Scroll(box, kWebGestureDeviceTouchscreen);
+  EXPECT_TOUCH_BUCKET(kHasOpacityAndLCDText, 2);
+  EXPECT_TOUCH_BUCKET(kBackgroundNotOpaqueInRectAndLCDText, 2);
+  EXPECT_TOUCH_TOTAL(4);
+
+  // Test wheel scroll.
+  Scroll(box);
+  EXPECT_WHEEL_BUCKET(kHasOpacityAndLCDText, 1);
+  EXPECT_WHEEL_BUCKET(kBackgroundNotOpaqueInRectAndLCDText, 1);
+  EXPECT_WHEEL_TOTAL(2);
+}
+
+TEST_F(NonCompositedMainThreadScrollingReasonRecordTest,
+       CompositedScrollableAreaTest) {
+  SetHtmlInnerHTML(
+      "<style>"
+      " .box { overflow:scroll; width: 100px; height: 100px; }"
+      " .translucent { opacity: 0.5; }"
+      " .composited { will-change: transform; }"
+      " .spacer { height: 1000px; }"
+      "</style>"
+      "<div id='box' class='translucent box'>"
+      " <div class='spacer'></div>"
+      "</div>");
+
+  GetPage().GetSettings().SetAcceleratedCompositingEnabled(true);
+  GetDocument().View()->SetParentVisible(true);
+  GetDocument().View()->SetSelfVisible(true);
+  GetDocument().View()->UpdateAllLifecyclePhases();
+
+  Element* box = GetDocument().getElementById("box");
+  HistogramTester histogram_tester;
+
+  Scroll(box);
+  EXPECT_WHEEL_BUCKET(kHasOpacityAndLCDText, 1);
+  EXPECT_WHEEL_BUCKET(kBackgroundNotOpaqueInRectAndLCDText, 1);
+  EXPECT_WHEEL_TOTAL(2);
+
+  box->setAttribute("class", "composited translucent box");
+  GetDocument().View()->UpdateAllLifecyclePhases();
+  Scroll(box);
+  EXPECT_FALSE(ToLayoutBox(box->GetLayoutObject())
+                   ->GetScrollableArea()
+                   ->GetNonCompositedMainThreadScrollingReasons());
+  EXPECT_WHEEL_BUCKET(kHasOpacityAndLCDText, 1);
+  EXPECT_WHEEL_BUCKET(kBackgroundNotOpaqueInRectAndLCDText, 1);
+  EXPECT_WHEEL_TOTAL(2);
+}
+
+TEST_F(NonCompositedMainThreadScrollingReasonRecordTest,
+       NotScrollableAreaTest) {
+  SetHtmlInnerHTML(
+      "<style>.box { overflow:scroll; width: 100px; height: 100px; }"
+      " .translucent { opacity: 0.5; }"
+      " .hidden { overflow: hidden; }"
+      " .spacer { height: 1000px; }"
+      "</style>"
+      "<div id='box' class='translucent box'>"
+      " <div class='spacer'></div>"
+      "</div>");
+
+  GetDocument().View()->UpdateAllLifecyclePhases();
+
+  Element* box = GetDocument().getElementById("box");
+  HistogramTester histogram_tester;
+
+  Scroll(box);
+  EXPECT_WHEEL_BUCKET(kHasOpacityAndLCDText, 1);
+  EXPECT_WHEEL_BUCKET(kBackgroundNotOpaqueInRectAndLCDText, 1);
+  EXPECT_WHEEL_TOTAL(2);
+
+  box->setAttribute("class", "hidden translucent box");
+  GetDocument().View()->UpdateAllLifecyclePhases();
+  Scroll(box);
+  EXPECT_WHEEL_BUCKET(kHasOpacityAndLCDText, 1);
+  EXPECT_WHEEL_BUCKET(kBackgroundNotOpaqueInRectAndLCDText, 1);
+  EXPECT_WHEEL_TOTAL(2);
+}
+
+TEST_F(NonCompositedMainThreadScrollingReasonRecordTest, NestedScrollersTest) {
+  SetHtmlInnerHTML(
+      "<style>"
+      " .container { overflow:scroll; width: 200px; height: 200px; }"
+      " .box { overflow:scroll; width: 100px; height: 100px; }"
+      " .translucent { opacity: 0.5; }"
+      " .transform { transform: scale(0.8); }"
+      " .with-border-radius { border: 5px solid; border-radius: 5px; }"
+      " .spacer { height: 1000px; }"
+      " .composited { will-change: transform; }"
+      "</style>"
+      "<div id='container' class='container with-border-radius'>"
+      "  <div class='translucent box'>"
+      "    <div id='inner' class='composited transform box'>"
+      "      <div class='spacer'></div>"
+      "    </div>"
+      "  </div>"
+      "  <div class='spacer'></div>"
+      "</div>");
+
+  GetPage().GetSettings().SetAcceleratedCompositingEnabled(true);
+  GetDocument().View()->SetParentVisible(true);
+  GetDocument().View()->SetSelfVisible(true);
+  GetDocument().View()->UpdateAllLifecyclePhases();
+
+  Element* box = GetDocument().getElementById("inner");
+  HistogramTester histogram_tester;
+
+  Scroll(box);
+  // Scrolling the inner box will gather reasons from the scrolling chain. The
+  // inner box itself has no reason because it's composited. Other scrollable
+  // areas from the chain have corresponding reasons.
+  EXPECT_WHEEL_BUCKET(kHasOpacityAndLCDText, 1);
+  EXPECT_WHEEL_BUCKET(kBackgroundNotOpaqueInRectAndLCDText, 1);
+  EXPECT_WHEEL_BUCKET(kHasBorderRadius, 1);
+  EXPECT_WHEEL_BUCKET(kHasTransformAndLCDText, 0);
+  EXPECT_WHEEL_TOTAL(3);
+}
+
 }  // namespace blink