1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
|
// Copyright 2020 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include <memory>
#include <tuple>
#include "base/functional/bind.h"
#include "base/run_loop.h"
#include "build/build_config.h"
#include "cc/base/switches.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.h"
#include "content/common/input/synthetic_gesture_controller.h"
#include "content/common/input/synthetic_gesture_params.h"
#include "content/common/input/synthetic_gesture_target.h"
#include "content/common/input/synthetic_smooth_scroll_gesture.h"
#include "content/common/input/synthetic_smooth_scroll_gesture_params.h"
#include "content/public/browser/render_view_host.h"
#include "content/public/common/content_switches.h"
#include "content/public/test/browser_test.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 "third_party/blink/public/common/features.h"
#include "third_party/blink/public/common/switches.h"
namespace {
constexpr int kIntermediateScrollOffset = 25;
const std::string kOverflowScrollDataURL = R"HTML(
data:text/html;charset=utf-8,
<!DOCTYPE html>
<meta name='viewport' content='width=device-width, minimum-scale=1'>
<style>
%23container {
width: 200px;
height: 200px;
overflow: scroll;
}
%23content {
width: 7500px;
height: 7500px;
background-color: blue;
}
</style>
<div id="container">
<div id="content"></div>
</div>
<script>
var element = document.getElementById('container');
window.onload = function() {
document.title='ready';
}
</script>
)HTML";
const std::string kMainFrameScrollDataURL = R"HTML(
data:text/html;charset=utf-8,
<!DOCTYPE html>
<meta name='viewport' content='width=device-width, minimum-scale=1'>
<style>
%23scrollableDiv {
width: 500px;
height: 10000px;
background-color: blue;
}
</style>
<div id='scrollableDiv'></div>
<script>
window.onload = function() {
document.title='ready';
}
</script>
)HTML";
const std::string kSubframeScrollDataURL = R"HTML(
data:text/html;charset=utf-8,
<!DOCTYPE html>
<meta name='viewport' content='width=device-width, minimum-scale=1'>
<style>
%23subframe {
width: 200px;
height: 200px;
}
</style>
<body onload="document.title='ready'">
<iframe id='subframe' srcdoc="
<style>
%23content {
width: 7500px;
height: 7500px;
background-color: blue;
}
</style>
<div id='content'></div>">
</iframe>
</body>
<script>
var subframe = document.getElementById('subframe');
</script>
)HTML";
const std::string kMirroredScrollersDataURL = R"HTML(
data:text/html;charset=utf-8,<!DOCTYPE html>
<meta name=viewport content="width=device-width, minimum-scale=1">
<style>
body, p { margin: 0 }
.s { overflow: scroll; border: 1px solid black;
width: 400px; height: 300px }
.sp { height: 1200px; width: 900px }
</style>
<div id=s1 class=s><p class=sp>SCROLLER</p></div>
<div id=s2 class=s><p class=sp>MIRROR</p></div>
<script>
s1.onscroll = () => { s2.scrollTo(0, s1.scrollTop) }
onload = () => { document.title = "ready" }
</script>
)HTML";
} // namespace
namespace content {
// This test is to verify that in-progress smooth scrolls stops when
// interrupted by an instant scroll, another smooth scroll, a touch scroll, or
// a mouse wheel scroll on an overflow:scroll element, main frame and subframe.
class ScrollBehaviorBrowserTest : public ContentBrowserTest {
public:
ScrollBehaviorBrowserTest() = default;
ScrollBehaviorBrowserTest(const ScrollBehaviorBrowserTest&) = delete;
ScrollBehaviorBrowserTest& operator=(const ScrollBehaviorBrowserTest&) =
delete;
~ScrollBehaviorBrowserTest() override = default;
RenderWidgetHostImpl* GetWidgetHost() {
return RenderWidgetHostImpl::From(shell()
->web_contents()
->GetPrimaryMainFrame()
->GetRenderViewHost()
->GetWidget());
}
void OnSyntheticGestureCompleted(SyntheticGesture::Result result) {
EXPECT_EQ(SyntheticGesture::GESTURE_FINISHED, result);
run_loop_->Quit();
}
protected:
void SetUpCommandLine(base::CommandLine* command_line) override {
// Set the scroll animation duration to 1 second (artificially slow) to make
// it likely that the second scroll interrupts the first scroll's animation.
//
// NOTE: It is likely but NOT guaranteed that interruption will occur. If
// interruption occurs, tests should verify that the behavior is correct.
// But if interruption does not occur, tests should be written to pass.
//
// We also do not want the animation to be TOO slow - both to be kind to the
// bots and to avoid false positives from the "value holds" checks.
//
command_line->AppendSwitchASCII(
switches::kCCScrollAnimationDurationForTesting, "1");
}
void LoadURL(const std::string page_url) {
const GURL data_url(page_url);
EXPECT_TRUE(NavigateToURL(shell(), data_url));
RenderWidgetHostImpl* host = GetWidgetHost();
host->GetView()->SetSize(gfx::Size(400, 400));
std::u16string ready_title(u"ready");
TitleWatcher watcher(shell()->web_contents(), ready_title);
std::ignore = watcher.WaitAndGetTitle();
HitTestRegionObserver observer(host->GetFrameSinkId());
// Wait for the hit test data to be ready
observer.WaitForHitTestData();
}
WebContentsImpl* web_contents() const {
return static_cast<WebContentsImpl*>(shell()->web_contents());
}
// The scroll delta values are in the viewport direction. Positive
// scroll_delta_y means scroll down, positive scroll_delta_x means scroll
// right.
void SimulateScroll(content::mojom::GestureSourceType gesture_source_type,
int scroll_delta_x,
int scroll_delta_y,
bool blocking = true) {
auto scroll_update_watcher = std::make_unique<InputMsgWatcher>(
GetWidgetHost(), blink::WebInputEvent::Type::kGestureScrollEnd);
// This speed affects only the rate at which the requested scroll delta is
// sent from the synthetic gesture controller, and doesn't affect the speed
// of the animation in the renderer.
constexpr int kSpeedInstant = 400000;
SyntheticSmoothScrollGestureParams params;
params.gesture_source_type = gesture_source_type;
params.anchor = gfx::PointF(50, 50);
params.speed_in_pixels_s = kSpeedInstant;
params.distances.push_back(gfx::Vector2d(-scroll_delta_x, -scroll_delta_y));
params.granularity = ui::ScrollGranularity::kScrollByPixel;
run_loop_ = std::make_unique<base::RunLoop>();
auto gesture = std::make_unique<SyntheticSmoothScrollGesture>(params);
GetWidgetHost()->QueueSyntheticGesture(
std::move(gesture),
base::BindOnce(&ScrollBehaviorBrowserTest::OnSyntheticGestureCompleted,
base::Unretained(this)));
if (blocking)
run_loop_->Run();
}
void WaitForScrollToStart(const std::string& script) {
// When the first smooth scroll starts and scroll to 5 pixels, we will
// send the second scroll to interrupt the current smooth scroll.
constexpr int kExpectedScrollTop = 5;
MainThreadFrameObserver frame_observer(GetWidgetHost());
while (EvalJs(shell(), script).ExtractDouble() < kExpectedScrollTop) {
frame_observer.Wait();
}
}
void WaitUntilLessThan(const std::string& script,
double starting_scroll_top) {
// For the scroll interruption, we want to make sure that the first smooth
// scroll animation stops right away, and the second scroll starts.
MainThreadFrameObserver frame_observer(GetWidgetHost());
double current = EvalJs(shell(), script).ExtractDouble();
// If the animation doesn't reverse within this number of pixels we fail the
// test.
constexpr int kThreshold = 20;
while (current >= starting_scroll_top) {
ASSERT_LT(current, starting_scroll_top + kThreshold);
frame_observer.Wait();
current = EvalJs(shell(), script).ExtractDouble();
}
}
void ValueHoldsAt(const std::string& scroll_top_script,
double scroll_top,
double tolerance = 0) {
// This function checks that the scroll top value holds at the given value
// for 10 frames.
MainThreadFrameObserver frame_observer(GetWidgetHost());
int frame_count = 10;
while (frame_count > 0) {
// EXPECT_NEAR is equivalent to EXPECT_EQ if tolerance is zero.
EXPECT_NEAR(EvalJs(shell(), scroll_top_script).ExtractDouble(),
scroll_top, tolerance);
frame_observer.Wait();
frame_count--;
}
}
double AssertScrollEndedAtPosition(const std::string& script,
double target_position,
double tolerance) {
MainThreadFrameObserver frame_observer(GetWidgetHost());
double scroll_top = EvalJs(shell(), script).ExtractDouble();
while (std::abs(target_position - scroll_top) > tolerance) {
scroll_top = EvalJs(shell(), script).ExtractDouble();
frame_observer.Wait();
}
// Assert that we have not scrolled past the target position.
ValueHoldsAt(script, target_position, 1);
return scroll_top;
}
std::unique_ptr<base::RunLoop> run_loop_;
};
// This tests that a in-progress smooth scroll on an overflow:scroll element
// stops when interrupted by an instant scroll.
//
// TODO(crbug.com/40722572): the last animation is committed after we set the
// scrollTop even when we cancel the animation, so the final scrollTop value
// is not 0, we need to fix it.
IN_PROC_BROWSER_TEST_F(ScrollBehaviorBrowserTest,
DISABLED_InstantScriptScrollAbortsSmoothScriptScroll) {
LoadURL(kOverflowScrollDataURL);
EXPECT_TRUE(ExecJs(shell()->web_contents(),
"element.scrollTo({top: 100, behavior: 'smooth'});"));
std::string scroll_top_script = "element.scrollTop";
WaitForScrollToStart(scroll_top_script);
double scroll_top = EvalJs(shell(), scroll_top_script).ExtractDouble();
ASSERT_GT(scroll_top, 0);
// When interrupted by an instant scroll, the in-progress smooth scrolls stop.
EXPECT_TRUE(ExecJs(shell()->web_contents(), "element.scrollTop = 0;"));
// Instant scroll does not cause animation, it scroll to 0 right away.
ValueHoldsAt(scroll_top_script, 0);
}
// This tests that a in-progress smooth wheel scroll on a scrollable element is
// adjusted (without cancellation) when interrupted by an instant script scroll.
IN_PROC_BROWSER_TEST_F(ScrollBehaviorBrowserTest,
InstantScriptScrollAdjustsSmoothWheelScroll) {
LoadURL(kOverflowScrollDataURL);
SimulateScroll(content::mojom::GestureSourceType::kMouseInput, 0, 100,
/* blocking */ false);
WaitForScrollToStart("element.scrollTop");
EXPECT_TRUE(ExecJs(shell()->web_contents(), "element.scrollBy(0, -5);"));
AssertScrollEndedAtPosition("element.scrollTop", 95, 1);
}
// This tests that a smooth wheel scroll is not interrupted when script syncs
// a separate scroller in the onscroll handler. (This was the root cause of
// crbug.com/1248388 affecting CodeMirror as described in crbug.com/1264266.)
IN_PROC_BROWSER_TEST_F(ScrollBehaviorBrowserTest,
SmoothWheelScrollCompletesWithScriptedMirror) {
LoadURL(kMirroredScrollersDataURL);
SimulateScroll(content::mojom::GestureSourceType::kMouseInput, 0, 200,
/* blocking */ false);
WaitForScrollToStart("s1.scrollTop");
AssertScrollEndedAtPosition("s1.scrollTop", 200, 1);
AssertScrollEndedAtPosition("s2.scrollTop", 200, 1);
}
// This tests that a in-progress smooth scroll on an overflow:scroll element
// stops when interrupted by another smooth scroll.
IN_PROC_BROWSER_TEST_F(ScrollBehaviorBrowserTest,
OneSmoothScriptScrollAbortsAnother_Element) {
LoadURL(kOverflowScrollDataURL);
EXPECT_TRUE(ExecJs(shell()->web_contents(),
"element.scrollTo({top: 100, behavior: 'smooth'});"));
std::string scroll_top_script = "element.scrollTop";
WaitForScrollToStart(scroll_top_script);
double scroll_top = EvalJs(shell(), scroll_top_script).ExtractDouble();
ASSERT_GT(scroll_top, 0);
// When interrupted by a smooth scroll, the in-progress smooth scrolls stop.
EXPECT_TRUE(ExecJs(shell()->web_contents(),
"element.scrollTo({top: 0, behavior: 'smooth'});"));
WaitUntilLessThan(scroll_top_script, scroll_top);
double new_scroll_top = EvalJs(shell(), scroll_top_script).ExtractDouble();
EXPECT_LT(new_scroll_top, scroll_top);
}
// This tests that a in-progress smooth scroll on an overflow:scroll element
// stops when interrupted by a touch scroll.
//
// TODO(crbug.com/40712058): compositing scroll should be able to cancel a
// running programmatic scroll.
IN_PROC_BROWSER_TEST_F(ScrollBehaviorBrowserTest,
DISABLED_TouchScrollAbortsSmoothScriptScroll) {
LoadURL(kOverflowScrollDataURL);
EXPECT_TRUE(ExecJs(shell()->web_contents(),
"element.scrollTo({top: 100, behavior: 'smooth'});"));
std::string scroll_top_script = "element.scrollTop";
WaitForScrollToStart(scroll_top_script);
double scroll_top = EvalJs(shell(), scroll_top_script).ExtractDouble();
ASSERT_GT(scroll_top, 0);
ASSERT_LT(scroll_top, kIntermediateScrollOffset);
// When interrupted by a touch scroll, the in-progress smooth scrolls stop.
SimulateScroll(content::mojom::GestureSourceType::kTouchInput, 0, -100);
// The touch scroll should cause scroll to 0 and cancel the animation, so
// make sure the value stays at 0.
ValueHoldsAt(scroll_top_script, 0);
}
// This tests that a in-progress smooth scroll on an overflow:scroll element
// stops when interrupted by a mouse wheel scroll.
//
// TODO(crbug.com/40712058): compositing scroll should be able to cancel a
// running programmatic scroll.
IN_PROC_BROWSER_TEST_F(ScrollBehaviorBrowserTest,
DISABLED_WheelScrollAbortsSmoothScriptScroll) {
LoadURL(kOverflowScrollDataURL);
EXPECT_TRUE(ExecJs(shell()->web_contents(),
"element.scrollTo({top: 100, behavior: 'smooth'});"));
std::string scroll_top_script = "element.scrollTop";
WaitForScrollToStart(scroll_top_script);
double scroll_top = EvalJs(shell(), scroll_top_script).ExtractDouble();
ASSERT_GT(scroll_top, 0);
ASSERT_LT(scroll_top, kIntermediateScrollOffset);
// When interrupted by a wheel scroll, the in-progress smooth scrolls stop.
SimulateScroll(content::mojom::GestureSourceType::kMouseInput, 0, -30);
// Smooth scrolling is disabled for wheel scroll on Mac.
// https://crbug.com/574283.
#if BUILDFLAG(IS_MAC) || BUILDFLAG(IS_ANDROID)
ValueHoldsAt(scroll_top_script, 0);
#else
WaitUntilLessThan(scroll_top_script, scroll_top);
double new_scroll_top = EvalJs(shell(), scroll_top_script).ExtractDouble();
EXPECT_LT(new_scroll_top, scroll_top);
EXPECT_GT(new_scroll_top, 0);
#endif
}
// This tests that a in-progress smooth scroll on the main frame stops when
// interrupted by another smooth scroll.
// Flaky on multiple platforms: crbug.com/1306980
IN_PROC_BROWSER_TEST_F(ScrollBehaviorBrowserTest,
DISABLED_OneSmoothScriptScrollAbortsAnother_Document) {
LoadURL(kMainFrameScrollDataURL);
EXPECT_TRUE(ExecJs(shell()->web_contents(),
"window.scrollTo({top: 100, behavior: 'smooth'});"));
std::string scroll_top_script = "document.scrollingElement.scrollTop";
WaitForScrollToStart(scroll_top_script);
double scroll_top = EvalJs(shell(), scroll_top_script).ExtractDouble();
ASSERT_GT(scroll_top, 0);
// When interrupted by a smooth scroll, the in-progress smooth scrolls stop.
EXPECT_TRUE(ExecJs(shell()->web_contents(),
"window.scrollTo({top: 0, behavior: 'smooth'});"));
WaitUntilLessThan(scroll_top_script, scroll_top);
double new_scroll_top = EvalJs(shell(), scroll_top_script).ExtractDouble();
EXPECT_LT(new_scroll_top, scroll_top);
}
// This tests that a in-progress smooth scroll on a subframe stops when
// interrupted by another smooth scroll.
// Flaky on multiple platforms: crbug.com/1306980
IN_PROC_BROWSER_TEST_F(ScrollBehaviorBrowserTest,
DISABLED_OneSmoothScriptScrollAbortsAnother_Subframe) {
LoadURL(kSubframeScrollDataURL);
EXPECT_TRUE(ExecJs(
shell()->web_contents(),
"subframe.contentWindow.scrollTo({top: 100, behavior: 'smooth'});"));
std::string scroll_top_script =
"subframe.contentDocument.scrollingElement.scrollTop";
WaitForScrollToStart(scroll_top_script);
double scroll_top = EvalJs(shell(), scroll_top_script).ExtractDouble();
ASSERT_GT(scroll_top, 0);
// When interrupted by a smooth scroll, the in-progress smooth scrolls stop.
EXPECT_TRUE(
ExecJs(shell()->web_contents(),
"subframe.contentWindow.scrollTo({top: 0, behavior: 'smooth'});"));
WaitUntilLessThan(scroll_top_script, scroll_top);
double new_scroll_top = EvalJs(shell(), scroll_top_script).ExtractDouble();
EXPECT_LT(new_scroll_top, scroll_top);
}
} // namespace content
|
