blob: 91e82b075f324e15e1aa3b3f320b43fe18bad406 [file] [log] [blame]
// Copyright 2017 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 <memory>
#include "base/bind.h"
#include "base/message_loop/message_loop.h"
#include "base/run_loop.h"
#include "base/test/metrics/histogram_tester.h"
#include "base/test/scoped_feature_list.h"
#include "cc/base/switches.h"
#include "content/browser/renderer_host/input/synthetic_gesture.h"
#include "content/browser/renderer_host/input/synthetic_gesture_controller.h"
#include "content/browser/renderer_host/input/synthetic_gesture_target.h"
#include "content/browser/renderer_host/input/synthetic_smooth_scroll_gesture.h"
#include "content/browser/renderer_host/render_widget_host_impl.h"
#include "content/browser/web_contents/web_contents_impl.h"
#include "content/common/input/synthetic_gesture_params.h"
#include "content/common/input/synthetic_smooth_scroll_gesture_params.h"
#include "content/public/browser/render_view_host.h"
#include "content/public/browser/render_widget_host_view.h"
#include "content/public/common/content_switches.h"
#include "content/public/test/browser_test_utils.h"
#include "content/public/test/content_browser_test.h"
#include "content/public/test/content_browser_test_utils.h"
#include "content/public/test/hit_test_region_observer.h"
#include "content/shell/browser/shell.h"
#include "ui/base/ui_base_features.h"
namespace {
const char kDataURL[] =
"data:text/html;charset=utf-8,"
"<!DOCTYPE html>"
"<html>"
"<head>"
"<title>Scroll latency histograms browsertests.</title>"
"<style>"
"body {"
" height:3000px;"
"}"
"</style>"
"</head>"
"<body>"
"<div id='spinner'>Spinning</div>"
"</body>"
"<script>"
"var degree = 0;"
"function spin() {"
"degree = degree + 3;"
"if (degree >= 360)"
"degree -= 360;"
"document.getElementById('spinner').style['transform'] = "
"'rotate(' + degree + 'deg)';"
"requestAnimationFrame(spin);"
"}"
"spin();"
"</script>"
"</html>";
} // namespace
namespace content {
class ScrollLatencyBrowserTest : public ContentBrowserTest {
public:
ScrollLatencyBrowserTest() {}
~ScrollLatencyBrowserTest() override {}
RenderWidgetHostImpl* GetWidgetHost() {
return RenderWidgetHostImpl::From(
shell()->web_contents()->GetRenderViewHost()->GetWidget());
}
// TODO(tdresser): Find a way to avoid sleeping like this. See
// crbug.com/405282 for details.
void GiveItSomeTime() {
base::RunLoop run_loop;
base::ThreadTaskRunnerHandle::Get()->PostDelayedTask(
FROM_HERE, run_loop.QuitClosure(),
base::TimeDelta::FromMillisecondsD(10));
run_loop.Run();
}
void OnSyntheticGestureCompleted(SyntheticGesture::Result result) {
EXPECT_EQ(SyntheticGesture::GESTURE_FINISHED, result);
run_loop_->Quit();
}
protected:
void SetUpCommandLine(base::CommandLine* command_line) override {
ContentBrowserTest::SetUpCommandLine(command_line);
if (disable_threaded_scrolling_) {
command_line->AppendSwitch(::switches::kDisableThreadedScrolling);
}
// Set the scroll animation duration to a large number so that
// we ensure secondary GestureScrollUpdates update the animation
// instead of starting a new one.
command_line->AppendSwitchASCII(
cc::switches::kCCScrollAnimationDurationForTesting, "10000000");
}
void LoadURL() {
const GURL data_url(kDataURL);
NavigateToURL(shell(), data_url);
RenderWidgetHostImpl* host = GetWidgetHost();
host->GetView()->SetSize(gfx::Size(400, 400));
HitTestRegionObserver observer(host->GetFrameSinkId());
// Wait for the hit test data to be ready
observer.WaitForHitTestData();
}
// Generate the gestures associated with kNumWheelScrolls ticks,
// scrolling by |distance|. This will perform a smooth scroll on platforms
// which support it.
void DoSmoothWheelScroll(const gfx::Vector2d& distance) {
blink::WebGestureEvent event =
SyntheticWebGestureEventBuilder::BuildScrollBegin(
distance.x(), -distance.y(), blink::WebGestureDevice::kTouchpad, 1);
event.data.scroll_begin.delta_hint_units =
blink::WebScrollGranularity::kScrollByPixel;
GetWidgetHost()->ForwardGestureEvent(event);
const uint32_t kNumWheelScrolls = 2;
for (uint32_t i = 0; i < kNumWheelScrolls; i++) {
// Install a VisualStateCallback and wait for the callback in response
// to each GestureScrollUpdate before sending the next GSU. This will
// ensure the events are not coalesced (resulting in fewer end-to-end
// latency histograms being logged).
// We must install a callback for each gesture since they are one-shot
// callbacks.
shell()->web_contents()->GetMainFrame()->InsertVisualStateCallback(
base::BindOnce(&ScrollLatencyBrowserTest::InvokeVisualStateCallback,
base::Unretained(this)));
blink::WebGestureEvent event2 =
SyntheticWebGestureEventBuilder::BuildScrollUpdate(
distance.x(), -distance.y(), 0,
blink::WebGestureDevice::kTouchpad);
event2.data.scroll_update.delta_units =
blink::WebScrollGranularity::kScrollByPixel;
GetWidgetHost()->ForwardGestureEvent(event2);
while (visual_state_callback_count_ <= i) {
// TODO: There's currently no way to block until a GPU swap
// completes. Until then we need to spin and wait. See
// crbug.com/897520 for more details.
GiveItSomeTime();
}
}
}
void InvokeVisualStateCallback(bool result) {
EXPECT_TRUE(result);
visual_state_callback_count_++;
}
void RunMultipleWheelScroll() {
DoSmoothWheelScroll(gfx::Vector2d(0, 100));
// We expect to see one ScrollBegin and two ScrollUpdate swap values.
while (!VerifyRecordedSamplesForHistogram(
1, "Event.Latency.ScrollBegin.Wheel.TimeToScrollUpdateSwapBegin4")) {
GiveItSomeTime();
FetchHistogramsFromChildProcesses();
}
while (!VerifyRecordedSamplesForHistogram(
1, "Event.Latency.ScrollUpdate.Wheel.TimeToScrollUpdateSwapBegin4")) {
GiveItSomeTime();
FetchHistogramsFromChildProcesses();
}
}
void RunScrollbarButtonLatencyTest() {
// Click on the forward scrollbar button to induce a compositor thread
// scrollbar scroll.
blink::WebFloatPoint scrollbar_forward_button(795, 595);
blink::WebMouseEvent mouse_event = SyntheticWebMouseEventBuilder::Build(
blink::WebInputEvent::kMouseDown, scrollbar_forward_button.x,
scrollbar_forward_button.y, 0);
mouse_event.button = blink::WebMouseEvent::Button::kLeft;
mouse_event.SetTimeStamp(base::TimeTicks::Now());
GetWidgetHost()->ForwardMouseEvent(mouse_event);
mouse_event.SetType(blink::WebInputEvent::kMouseUp);
GetWidgetHost()->ForwardMouseEvent(mouse_event);
RunUntilInputProcessed(GetWidgetHost());
FetchHistogramsFromChildProcesses();
VerifyRecordedSamplesForHistogram(
1, "Event.Latency.ScrollBegin.Scrollbar.TimeToScrollUpdateSwapBegin4");
VerifyRecordedSamplesForHistogram(
1,
"Event.Latency.ScrollBegin.Scrollbar.RendererSwapToBrowserNotified2");
VerifyRecordedSamplesForHistogram(
1,
"Event.Latency.ScrollBegin.Scrollbar.BrowserNotifiedToBeforeGpuSwap2");
VerifyRecordedSamplesForHistogram(
1, "Event.Latency.ScrollBegin.Scrollbar.GpuSwap2");
VerifyRecordedSamplesForHistogram(
1, "Event.Latency.ScrollBegin.Scrollbar.TimeToScrollUpdateSwapBegin4");
std::string thread_name =
DoesScrollbarScrollOnMainThread() ? "Main" : "Impl";
VerifyRecordedSamplesForHistogram(
1, "Event.Latency.ScrollBegin.Scrollbar.TimeToHandled_" + thread_name);
VerifyRecordedSamplesForHistogram(
1, "Event.Latency.ScrollBegin.Scrollbar.HandledToRendererSwap2_" +
thread_name);
}
void RunScrollbarThumbDragLatencyTest() {
// Click on the scrollbar thumb and drag it twice to induce a compositor
// thread scrollbar ScrollBegin and ScrollUpdate.
blink::WebFloatPoint scrollbar_thumb(795, 30);
blink::WebMouseEvent mouse_down = SyntheticWebMouseEventBuilder::Build(
blink::WebInputEvent::kMouseDown, scrollbar_thumb.x, scrollbar_thumb.y,
0);
mouse_down.button = blink::WebMouseEvent::Button::kLeft;
mouse_down.SetTimeStamp(base::TimeTicks::Now());
GetWidgetHost()->ForwardMouseEvent(mouse_down);
blink::WebMouseEvent mouse_move = SyntheticWebMouseEventBuilder::Build(
blink::WebInputEvent::kMouseMove, scrollbar_thumb.x,
scrollbar_thumb.y + 10, 0);
mouse_move.button = blink::WebMouseEvent::Button::kLeft;
mouse_move.SetTimeStamp(base::TimeTicks::Now());
GetWidgetHost()->ForwardMouseEvent(mouse_move);
mouse_move.SetPositionInWidget(scrollbar_thumb.x, scrollbar_thumb.y + 20);
mouse_move.SetPositionInScreen(scrollbar_thumb.x, scrollbar_thumb.y + 20);
GetWidgetHost()->ForwardMouseEvent(mouse_move);
blink::WebMouseEvent mouse_up = SyntheticWebMouseEventBuilder::Build(
blink::WebInputEvent::kMouseUp, scrollbar_thumb.x,
scrollbar_thumb.y + 20, 0);
mouse_up.button = blink::WebMouseEvent::Button::kLeft;
mouse_up.SetTimeStamp(base::TimeTicks::Now());
GetWidgetHost()->ForwardMouseEvent(mouse_up);
RunUntilInputProcessed(GetWidgetHost());
FetchHistogramsFromChildProcesses();
const std::string scroll_types[] = {"ScrollBegin", "ScrollUpdate"};
for (const std::string& scroll_type : scroll_types) {
VerifyRecordedSamplesForHistogram(
1, "Event.Latency." + scroll_type +
".Scrollbar.TimeToScrollUpdateSwapBegin4");
VerifyRecordedSamplesForHistogram(
1, "Event.Latency." + scroll_type +
".Scrollbar.RendererSwapToBrowserNotified2");
VerifyRecordedSamplesForHistogram(
1, "Event.Latency." + scroll_type +
".Scrollbar.BrowserNotifiedToBeforeGpuSwap2");
VerifyRecordedSamplesForHistogram(
1, "Event.Latency." + scroll_type + ".Scrollbar.GpuSwap2");
VerifyRecordedSamplesForHistogram(
1, "Event.Latency." + scroll_type +
".Scrollbar.TimeToScrollUpdateSwapBegin4");
std::string thread_name =
DoesScrollbarScrollOnMainThread() ? "Main" : "Impl";
VerifyRecordedSamplesForHistogram(1, "Event.Latency." + scroll_type +
".Scrollbar.TimeToHandled_" +
thread_name);
VerifyRecordedSamplesForHistogram(
1, "Event.Latency." + scroll_type +
".Scrollbar.HandledToRendererSwap2_" + thread_name);
}
}
// Returns true if the given histogram has recorded the expected number of
// samples.
bool VerifyRecordedSamplesForHistogram(
const size_t num_samples,
const std::string& histogram_name) const {
return num_samples ==
histogram_tester_.GetAllSamples(histogram_name).size();
}
virtual bool DoesScrollbarScrollOnMainThread() const { return true; }
std::unique_ptr<base::RunLoop> run_loop_;
bool disable_threaded_scrolling_ = false;
private:
base::HistogramTester histogram_tester_;
uint32_t visual_state_callback_count_ = 0;
DISALLOW_COPY_AND_ASSIGN(ScrollLatencyBrowserTest);
};
// Perform a smooth wheel scroll, and verify that our end-to-end wheel latency
// metrics are recorded. See crbug.com/599910 for details.
IN_PROC_BROWSER_TEST_F(ScrollLatencyBrowserTest, MultipleWheelScroll) {
LoadURL();
RunMultipleWheelScroll();
}
IN_PROC_BROWSER_TEST_F(ScrollLatencyBrowserTest, MultipleWheelScrollOnMain) {
disable_threaded_scrolling_ = true;
LoadURL();
RunMultipleWheelScroll();
}
// Do an upward wheel scroll, and verify that no scroll metrics is recorded when
// the scroll event is ignored.
IN_PROC_BROWSER_TEST_F(ScrollLatencyBrowserTest,
ScrollLatencyNotRecordedIfGSUIgnored) {
LoadURL();
auto scroll_update_watcher = std::make_unique<InputMsgWatcher>(
GetWidgetHost(), blink::WebInputEvent::kGestureScrollUpdate);
// Try to scroll upward, the GSU(s) will get ignored since the scroller is at
// its extent.
SyntheticSmoothScrollGestureParams params;
params.gesture_source_type = SyntheticGestureParams::TOUCH_INPUT;
params.anchor = gfx::PointF(10, 10);
params.distances.push_back(gfx::Vector2d(0, 60));
run_loop_ = std::make_unique<base::RunLoop>();
std::unique_ptr<SyntheticSmoothScrollGesture> gesture(
new SyntheticSmoothScrollGesture(params));
GetWidgetHost()->QueueSyntheticGesture(
std::move(gesture),
base::BindOnce(&ScrollLatencyBrowserTest::OnSyntheticGestureCompleted,
base::Unretained(this)));
// Runs until we get the OnSyntheticGestureCompleted callback and verify that
// the first GSU event is ignored.
run_loop_->Run();
EXPECT_EQ(INPUT_EVENT_ACK_STATE_NO_CONSUMER_EXISTS,
scroll_update_watcher->GetAckStateWaitIfNecessary());
// Wait for one frame and then verify that the scroll metrics are not
// recorded.
std::unique_ptr<RenderFrameSubmissionObserver> frame_observer =
std::make_unique<RenderFrameSubmissionObserver>(
GetWidgetHost()->render_frame_metadata_provider());
frame_observer->WaitForAnyFrameSubmission();
FetchHistogramsFromChildProcesses();
EXPECT_TRUE(VerifyRecordedSamplesForHistogram(
0, "Event.Latency.ScrollBegin.Touch.BrowserNotifiedToBeforeGpuSwap2"));
EXPECT_TRUE(VerifyRecordedSamplesForHistogram(
0, "Event.Latency.ScrollBegin.Touch.GpuSwap2"));
EXPECT_TRUE(VerifyRecordedSamplesForHistogram(
0, "Event.Latency.ScrollBegin.Touch.HandledToRendererSwap2_Impl"));
EXPECT_TRUE(VerifyRecordedSamplesForHistogram(
0, "Event.Latency.ScrollBegin.Touch.RendererSwapToBrowserNotified2"));
EXPECT_TRUE(VerifyRecordedSamplesForHistogram(
0, "Event.Latency.ScrollBegin.Touch.TimeToHandled2_Impl"));
EXPECT_TRUE(VerifyRecordedSamplesForHistogram(
0, "Event.Latency.ScrollBegin.Touch.TimeToScrollUpdateSwapBegin4"));
}
class ScrollLatencyCompositedScrollbarBrowserTest
: public ScrollLatencyBrowserTest {
public:
ScrollLatencyCompositedScrollbarBrowserTest() {
scoped_feature_list_.InitAndEnableFeature(
features::kCompositorThreadedScrollbarScrolling);
}
~ScrollLatencyCompositedScrollbarBrowserTest() override {}
protected:
bool DoesScrollbarScrollOnMainThread() const override { return false; }
base::test::ScopedFeatureList scoped_feature_list_;
};
IN_PROC_BROWSER_TEST_F(ScrollLatencyCompositedScrollbarBrowserTest,
ScrollbarButtonLatency) {
LoadURL();
RunScrollbarButtonLatencyTest();
}
IN_PROC_BROWSER_TEST_F(ScrollLatencyCompositedScrollbarBrowserTest,
ScrollbarThumbDragLatency) {
LoadURL();
RunScrollbarThumbDragLatencyTest();
}
} // namespace content