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
content / browser / renderer_host / direct_manipulation_win_browsertest.cc [blame]
// Copyright 2018 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "content/browser/renderer_host/direct_manipulation_helper_win.h"
#include "content/browser/renderer_host/direct_manipulation_test_helper_win.h"
#include "content/browser/renderer_host/legacy_render_widget_host_win.h"
#include "content/browser/renderer_host/render_widget_host_view_aura.h"
#include "content/browser/web_contents/web_contents_impl.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/shell/browser/shell.h"
#include "ui/aura/window.h"
#include "ui/aura/window_tree_host.h"
#include "ui/base/ui_base_features.h"
#include "ui/base/win/window_event_target.h"
#include "ui/compositor/compositor.h"
#include "ui/events/event_rewriter.h"
#include "ui/events/event_source.h"
#include "url/gurl.h"
namespace content {
class DirectManipulationBrowserTestBase : public ContentBrowserTest {
public:
DirectManipulationBrowserTestBase() {}
DirectManipulationBrowserTestBase(const DirectManipulationBrowserTestBase&) =
delete;
DirectManipulationBrowserTestBase& operator=(
const DirectManipulationBrowserTestBase&) = delete;
LegacyRenderWidgetHostHWND* GetLegacyRenderWidgetHostHWND() {
RenderWidgetHostViewAura* rwhva = static_cast<RenderWidgetHostViewAura*>(
shell()->web_contents()->GetRenderWidgetHostView());
return rwhva->legacy_render_widget_host_HWND_;
}
ui::WindowEventTarget* GetWindowEventTarget() {
LegacyRenderWidgetHostHWND* lrwhh = GetLegacyRenderWidgetHostHWND();
return lrwhh->GetWindowEventTarget(lrwhh->GetParent());
}
void SetDirectManipulationInteraction(
DIRECTMANIPULATION_INTERACTION_TYPE type) {
LegacyRenderWidgetHostHWND* lrwhh = GetLegacyRenderWidgetHostHWND();
lrwhh->direct_manipulation_helper_->event_handler_->OnInteraction(nullptr,
type);
}
bool HasAnimationObserver(LegacyRenderWidgetHostHWND* lrwhh) {
return lrwhh->direct_manipulation_helper_->compositor_
->HasAnimationObserver(lrwhh->direct_manipulation_helper_.get());
}
void StartNewSequence() {
LegacyRenderWidgetHostHWND* lrwhh = GetLegacyRenderWidgetHostHWND();
lrwhh->direct_manipulation_helper_->event_handler_->OnViewportStatusChanged(
lrwhh->direct_manipulation_helper_->viewport_.Get(),
DIRECTMANIPULATION_READY, DIRECTMANIPULATION_RUNNING);
}
void UpdateContents(MockDirectManipulationContent* content) {
LegacyRenderWidgetHostHWND* lrwhh = GetLegacyRenderWidgetHostHWND();
lrwhh->direct_manipulation_helper_->event_handler_->OnContentUpdated(
lrwhh->direct_manipulation_helper_->viewport_.Get(), content);
}
};
class DirectManipulationBrowserTest : public DirectManipulationBrowserTestBase {
public:
DirectManipulationBrowserTest() {}
DirectManipulationBrowserTest(const DirectManipulationBrowserTest&) = delete;
DirectManipulationBrowserTest& operator=(
const DirectManipulationBrowserTest&) = delete;
};
// Ensure the AnimationObserver is only created after direct manipulation
// interaction begin and destroyed after direct manipulation interaction end.
IN_PROC_BROWSER_TEST_F(DirectManipulationBrowserTest,
ObserverDuringInteraction) {
EXPECT_TRUE(NavigateToURL(shell(), GURL(url::kAboutBlankURL)));
LegacyRenderWidgetHostHWND* lrwhh = GetLegacyRenderWidgetHostHWND();
ASSERT_TRUE(lrwhh);
// The observer should not be created before it is needed.
EXPECT_FALSE(HasAnimationObserver(lrwhh));
// Begin direct manipulation interaction.
SetDirectManipulationInteraction(DIRECTMANIPULATION_INTERACTION_BEGIN);
// AnimationObserver should be added after direct manipulation interaction
// begin.
EXPECT_TRUE(HasAnimationObserver(lrwhh));
// End direct manipulation interaction.
SetDirectManipulationInteraction(DIRECTMANIPULATION_INTERACTION_END);
// The animation observer should be removed.
EXPECT_FALSE(HasAnimationObserver(lrwhh));
}
// EventLogger is to observe the events sent from WindowEventTarget (the root
// window).
class EventLogger : public ui::EventRewriter {
public:
EventLogger() {}
EventLogger(const EventLogger&) = delete;
EventLogger& operator=(const EventLogger&) = delete;
~EventLogger() override {}
std::unique_ptr<ui::Event> ReleaseLastEvent() {
return std::move(last_event_);
}
private:
// ui::EventRewriter
ui::EventDispatchDetails RewriteEvent(
const ui::Event& event,
const Continuation continuation) override {
DCHECK(!last_event_);
last_event_ = event.Clone();
return SendEvent(continuation, &event);
}
std::unique_ptr<ui::Event> last_event_;
};
// Check DirectManipulation events convert to ui::event correctly.
IN_PROC_BROWSER_TEST_F(DirectManipulationBrowserTest, EventConvert) {
EXPECT_TRUE(NavigateToURL(shell(), GURL(url::kAboutBlankURL)));
LegacyRenderWidgetHostHWND* lrwhh = GetLegacyRenderWidgetHostHWND();
ASSERT_TRUE(lrwhh);
HWND hwnd =
shell()->window()->GetRootWindow()->GetHost()->GetAcceleratedWidget();
ui::EventSource* dwthw = static_cast<ui::EventSource*>(
aura::WindowTreeHost::GetForAcceleratedWidget(hwnd));
EventLogger event_logger;
dwthw->AddEventRewriter(&event_logger);
ui::WindowEventTarget* target = GetWindowEventTarget();
{
target->ApplyPanGestureScroll(1, 2);
std::unique_ptr<ui::Event> event = event_logger.ReleaseLastEvent();
ASSERT_TRUE(event);
EXPECT_EQ(ui::EventType::kScroll, event->type());
ui::ScrollEvent* scroll_event = event->AsScrollEvent();
EXPECT_EQ(1, scroll_event->x_offset());
EXPECT_EQ(2, scroll_event->y_offset());
EXPECT_EQ(ui::EventMomentumPhase::NONE, scroll_event->momentum_phase());
EXPECT_EQ(ui::ScrollEventPhase::kUpdate,
scroll_event->scroll_event_phase());
}
{
target->ApplyPanGestureFling(1, 2);
std::unique_ptr<ui::Event> event = event_logger.ReleaseLastEvent();
ASSERT_TRUE(event);
EXPECT_EQ(ui::EventType::kScroll, event->type());
ui::ScrollEvent* scroll_event = event->AsScrollEvent();
EXPECT_EQ(1, scroll_event->x_offset());
EXPECT_EQ(2, scroll_event->y_offset());
EXPECT_EQ(ui::EventMomentumPhase::INERTIAL_UPDATE,
scroll_event->momentum_phase());
EXPECT_EQ(ui::ScrollEventPhase::kNone, scroll_event->scroll_event_phase());
}
{
target->ApplyPanGestureScrollBegin(1, 2);
std::unique_ptr<ui::Event> event = event_logger.ReleaseLastEvent();
ASSERT_TRUE(event);
EXPECT_EQ(ui::EventType::kScroll, event->type());
ui::ScrollEvent* scroll_event = event->AsScrollEvent();
EXPECT_EQ(1, scroll_event->x_offset());
EXPECT_EQ(2, scroll_event->y_offset());
EXPECT_EQ(ui::EventMomentumPhase::NONE, scroll_event->momentum_phase());
EXPECT_EQ(ui::ScrollEventPhase::kBegan, scroll_event->scroll_event_phase());
}
{
target->ApplyPanGestureScrollEnd(true);
std::unique_ptr<ui::Event> event = event_logger.ReleaseLastEvent();
ASSERT_TRUE(event);
EXPECT_EQ(ui::EventType::kScroll, event->type());
ui::ScrollEvent* scroll_event = event->AsScrollEvent();
EXPECT_EQ(0, scroll_event->x_offset());
EXPECT_EQ(0, scroll_event->y_offset());
EXPECT_EQ(ui::EventMomentumPhase::BLOCKED, scroll_event->momentum_phase());
EXPECT_EQ(ui::ScrollEventPhase::kEnd, scroll_event->scroll_event_phase());
}
{
target->ApplyPanGestureFlingBegin();
std::unique_ptr<ui::Event> event = event_logger.ReleaseLastEvent();
ASSERT_TRUE(event);
EXPECT_EQ(ui::EventType::kScroll, event->type());
ui::ScrollEvent* scroll_event = event->AsScrollEvent();
EXPECT_EQ(0, scroll_event->x_offset());
EXPECT_EQ(0, scroll_event->y_offset());
EXPECT_EQ(ui::EventMomentumPhase::BEGAN, scroll_event->momentum_phase());
EXPECT_EQ(ui::ScrollEventPhase::kNone, scroll_event->scroll_event_phase());
}
{
target->ApplyPanGestureFlingEnd();
std::unique_ptr<ui::Event> event = event_logger.ReleaseLastEvent();
ASSERT_TRUE(event);
EXPECT_EQ(ui::EventType::kScroll, event->type());
ui::ScrollEvent* scroll_event = event->AsScrollEvent();
EXPECT_EQ(0, scroll_event->x_offset());
EXPECT_EQ(0, scroll_event->y_offset());
EXPECT_EQ(ui::EventMomentumPhase::END, scroll_event->momentum_phase());
EXPECT_EQ(ui::ScrollEventPhase::kNone, scroll_event->scroll_event_phase());
}
{
target->ApplyPinchZoomBegin();
std::unique_ptr<ui::Event> event = event_logger.ReleaseLastEvent();
ASSERT_TRUE(event);
EXPECT_EQ(ui::EventType::kGesturePinchBegin, event->type());
ui::GestureEvent* gesture_event = event->AsGestureEvent();
EXPECT_EQ(ui::GestureDeviceType::DEVICE_TOUCHPAD,
gesture_event->details().device_type());
}
{
target->ApplyPinchZoomScale(1.1f);
std::unique_ptr<ui::Event> event = event_logger.ReleaseLastEvent();
ASSERT_TRUE(event);
EXPECT_EQ(ui::EventType::kGesturePinchUpdate, event->type());
ui::GestureEvent* gesture_event = event->AsGestureEvent();
EXPECT_EQ(ui::GestureDeviceType::DEVICE_TOUCHPAD,
gesture_event->details().device_type());
EXPECT_EQ(1.1f, gesture_event->details().scale());
}
{
target->ApplyPinchZoomEnd();
std::unique_ptr<ui::Event> event = event_logger.ReleaseLastEvent();
ASSERT_TRUE(event);
EXPECT_EQ(ui::EventType::kGesturePinchEnd, event->type());
ui::GestureEvent* gesture_event = event->AsGestureEvent();
EXPECT_EQ(ui::GestureDeviceType::DEVICE_TOUCHPAD,
gesture_event->details().device_type());
}
dwthw->RemoveEventRewriter(&event_logger);
}
class PrecisionTouchpadBrowserTest : public DirectManipulationBrowserTestBase {
public:
PrecisionTouchpadBrowserTest() {
content_ = Microsoft::WRL::Make<MockDirectManipulationContent>();
}
PrecisionTouchpadBrowserTest(const PrecisionTouchpadBrowserTest&) = delete;
PrecisionTouchpadBrowserTest& operator=(const PrecisionTouchpadBrowserTest&) =
delete;
void UpdateContents(float scale, float scroll_x, float scroll_y) {
content_->SetContentTransform(scale, scroll_x, scroll_y);
DirectManipulationBrowserTestBase::UpdateContents(content_.Get());
}
void UseCenterPointAsMockCursorPosition(WebContentsImpl* web_contents) {
SetMockCursorPositionForTesting(
web_contents, web_contents->GetContainerBounds().CenterPoint());
}
private:
Microsoft::WRL::ComPtr<MockDirectManipulationContent> content_;
};
// Confirm that preventDefault correctly prevents pinch zoom on precision
// touchpad.
IN_PROC_BROWSER_TEST_F(PrecisionTouchpadBrowserTest, PreventDefaultPinchZoom) {
ASSERT_TRUE(NavigateToURL(shell(), GURL(R"HTML(data:text/html,<!DOCTYPE html>
<html>
Hello, world
</html>)HTML")));
WebContentsImpl* web_contents =
static_cast<WebContentsImpl*>(shell()->web_contents());
RenderWidgetHostImpl* rwhi = web_contents->GetRenderWidgetHostWithPageFocus();
// Wait for a frame to be produced or else the test will sometimes try to
// zoom too early and be unable to, causing flakiness.
MainThreadFrameObserver observer(
web_contents->GetRenderViewHost()->GetWidget());
observer.Wait();
UseCenterPointAsMockCursorPosition(web_contents);
EXPECT_EQ(1, EvalJs(web_contents, "window.visualViewport.scale"));
// Initial amount to try zooming by.
const int kInitialZoom = 2;
// Used to confirm the gesture is ACK'd before checking the zoom state. The
// ACK result itself isn't relevant in this test.
auto input_msg_watcher = std::make_unique<InputMsgWatcher>(
web_contents->GetRenderViewHost()->GetWidget(),
blink::WebInputEvent::Type::kGesturePinchUpdate);
// First, test a standard zoom.
UpdateContents(kInitialZoom, 0, 0);
input_msg_watcher->WaitForAck();
EXPECT_TRUE(input_msg_watcher->HasReceivedAck());
RunUntilInputProcessed(rwhi);
EXPECT_EQ(kInitialZoom, EvalJs(web_contents, "window.visualViewport.scale"));
// In order for the end event to be fired and state reset, a new sequence has
// to be started. This simulates lifting fingers off of the touch pad.
StartNewSequence();
// Now add the preventDefault to confirm zooming does not happen.
EXPECT_TRUE(ExecJs(web_contents,
R"(var handler = function (e) {e.preventDefault(); };
document.addEventListener('wheel', handler, {passive: false}); )"));
RunUntilInputProcessed(rwhi);
// Arbitrary zoom amount chosen here to make the test fail if it does zoom.
UpdateContents(3.5, 0, 0);
input_msg_watcher->WaitForAck();
EXPECT_TRUE(input_msg_watcher->HasReceivedAck());
RunUntilInputProcessed(rwhi);
EXPECT_EQ(kInitialZoom, EvalJs(web_contents, "window.visualViewport.scale"));
// Confirm a zoom back out to 1 works as expected.
StartNewSequence();
RunUntilInputProcessed(rwhi);
EXPECT_TRUE(ExecJs(
web_contents,
R"(document.removeEventListener('wheel', handler, {passive: false}); )"));
const float kEndZoom = 0.5;
UpdateContents(kEndZoom, 0, 0);
input_msg_watcher->WaitForAck();
EXPECT_TRUE(input_msg_watcher->HasReceivedAck());
RunUntilInputProcessed(rwhi);
EXPECT_EQ(static_cast<int>(kInitialZoom * kEndZoom),
EvalJs(web_contents, "window.visualViewport.scale"));
}
// Confirm that preventDefault correctly prevents scrolling on precision
// touchpad.
IN_PROC_BROWSER_TEST_F(PrecisionTouchpadBrowserTest, PreventDefaultScroll) {
ASSERT_TRUE(NavigateToURL(shell(), GURL(R"HTML(data:text/html,<!DOCTYPE html>
<html>
<body style='height:2000px; width:2000px;'>
Hello, world
</body>
</html>)HTML")));
WebContentsImpl* web_contents =
static_cast<WebContentsImpl*>(shell()->web_contents());
RenderWidgetHostImpl* rwhi = web_contents->GetRenderWidgetHostWithPageFocus();
// Wait for a frame to be produced or else the test will sometimes try to
// scroll too early and be unable to, causing flakiness.
MainThreadFrameObserver observer(
web_contents->GetRenderViewHost()->GetWidget());
observer.Wait();
UseCenterPointAsMockCursorPosition(web_contents);
EXPECT_EQ(0, EvalJs(web_contents, "document.documentElement.scrollLeft"));
EXPECT_EQ(0, EvalJs(web_contents, "document.documentElement.scrollTop"));
// The distance to try scrolling. Note that scrolling down or right is
// considered the negative direction, so this value will be negated when
// passed to UpdateContents.
const int kInitialScrollDistance = 200;
// Used to confirm the gesture is ACK'd before checking the scroll state. The
// ACK result itself isn't relevant in this test.
auto input_msg_watcher = std::make_unique<InputMsgWatcher>(
web_contents->GetRenderViewHost()->GetWidget(),
blink::WebInputEvent::Type::kMouseWheel);
// First, test scrolling vertically
UpdateContents(1, 0, -kInitialScrollDistance);
input_msg_watcher->WaitForAck();
EXPECT_TRUE(input_msg_watcher->HasReceivedAck());
RunUntilInputProcessed(rwhi);
EXPECT_EQ(0, EvalJs(web_contents, "document.documentElement.scrollLeft"));
EXPECT_EQ(kInitialScrollDistance,
EvalJs(web_contents, "document.documentElement.scrollTop"));
// Then, horizontally. Note that a new sequence is not starting between these,
// which is why the y value remains the same.
UpdateContents(1, -kInitialScrollDistance, -kInitialScrollDistance);
RunUntilInputProcessed(rwhi);
EXPECT_EQ(kInitialScrollDistance,
EvalJs(web_contents, "document.documentElement.scrollLeft"));
EXPECT_EQ(kInitialScrollDistance,
EvalJs(web_contents, "document.documentElement.scrollTop"));
// In order for the end event to be fired and state reset, a new sequence has
// to be started. This simulates lifting fingers off of the touch pad.
StartNewSequence();
// Now add the preventDefault to confirm scrolling does not happen.
EXPECT_TRUE(ExecJs(web_contents,
R"(var handler = function (e) {e.preventDefault(); };
document.addEventListener('wheel', handler, {passive: false}); )"));
RunUntilInputProcessed(rwhi);
// Updating with arbitrarily chosen numbers that should make it obvious where
// values are coming from when this test fails.
UpdateContents(1, 354, 291);
input_msg_watcher->WaitForAck();
EXPECT_TRUE(input_msg_watcher->HasReceivedAck());
RunUntilInputProcessed(rwhi);
EXPECT_EQ(kInitialScrollDistance,
EvalJs(web_contents, "document.documentElement.scrollLeft"));
EXPECT_EQ(kInitialScrollDistance,
EvalJs(web_contents, "document.documentElement.scrollTop"));
// Confirm a scroll back towards the origin works after removing the event
// listener.
StartNewSequence();
EXPECT_TRUE(ExecJs(
web_contents,
R"(document.removeEventListener('wheel', handler, {passive: false}); )"));
// Values arbitrarily chosen so to confirm that scrolling up and left works
// without going all the way to the origin.
const int kScrollXDistance = 120;
const int kScrollYDistance = 150;
UpdateContents(1, kScrollXDistance, kScrollYDistance);
input_msg_watcher->WaitForAck();
EXPECT_TRUE(input_msg_watcher->HasReceivedAck());
RunUntilInputProcessed(rwhi);
EXPECT_EQ(kInitialScrollDistance - kScrollXDistance,
EvalJs(web_contents, "document.documentElement.scrollLeft"));
EXPECT_EQ(kInitialScrollDistance - kScrollYDistance,
EvalJs(web_contents, "document.documentElement.scrollTop"));
}
} // namespace content