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
|
// Copyright 2014 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "ui/android/overscroll_refresh.h"
#include "base/android/scoped_java_ref.h"
#include "cc/input/overscroll_behavior.h"
#include "testing/gtest/include/gtest/gtest.h"
#include "ui/android/overscroll_refresh_handler.h"
#include "ui/gfx/geometry/point_f.h"
namespace ui {
const float kDipScale = 1.f;
const gfx::PointF kStartPos(2.f, 2.f);
const float kDefaultEdgeWidth =
OverscrollRefresh::kDefaultNavigationEdgeWidth * kDipScale;
class OverscrollRefreshTest : public OverscrollRefreshHandler,
public testing::Test {
public:
OverscrollRefreshTest() : OverscrollRefreshHandler(nullptr) {}
// OverscrollRefreshHandler implementation.
bool PullStart(
OverscrollAction type,
std::optional<BackGestureEventSwipeEdge> initiating_edge) override {
started_ = true;
return true;
}
void PullUpdate(float x_delta, float y_delta) override { delta_ += y_delta; }
void PullRelease(bool allow_refresh) override {
released_ = true;
refresh_allowed_ = allow_refresh;
}
void PullReset() override { reset_ = true; }
bool GetAndResetPullStarted() {
bool result = started_;
started_ = false;
return result;
}
float GetAndResetPullDelta() {
float result = delta_;
delta_ = 0;
return result;
}
bool GetAndResetPullReleased() {
bool result = released_;
released_ = false;
return result;
}
bool GetAndResetRefreshAllowed() {
bool result = refresh_allowed_;
refresh_allowed_ = false;
return result;
}
bool GetAndResetPullReset() {
bool result = reset_;
reset_ = false;
return result;
}
void TestOverscrollBehavior(const cc::OverscrollBehavior& ob,
const gfx::Vector2dF& scroll_delta,
bool started) {
OverscrollRefresh effect(this, kDefaultEdgeWidth);
effect.OnScrollBegin(kStartPos);
EXPECT_FALSE(effect.WillHandleScrollUpdate(scroll_delta));
EXPECT_FALSE(effect.IsActive());
EXPECT_TRUE(effect.IsAwaitingScrollUpdateAck());
effect.OnOverscrolled(ob, -scroll_delta);
EXPECT_EQ(started, GetAndResetPullStarted());
EXPECT_EQ(!started, GetAndResetPullReset());
}
private:
float delta_ = 0;
bool started_ = false;
bool released_ = false;
bool reset_ = false;
bool refresh_allowed_ = false;
};
TEST_F(OverscrollRefreshTest, TriggerPullToRefresh) {
OverscrollRefresh effect(this, kDefaultEdgeWidth);
EXPECT_FALSE(effect.IsActive());
EXPECT_FALSE(effect.IsAwaitingScrollUpdateAck());
effect.OnScrollBegin(kStartPos);
EXPECT_FALSE(effect.IsActive());
EXPECT_TRUE(effect.IsAwaitingScrollUpdateAck());
// The initial scroll should not be consumed, as it should first be offered
// to content.
gfx::Vector2dF scroll_up(0, 10);
EXPECT_FALSE(effect.WillHandleScrollUpdate(scroll_up));
EXPECT_FALSE(effect.IsActive());
EXPECT_TRUE(effect.IsAwaitingScrollUpdateAck());
// The unconsumed, overscrolling scroll will trigger the effect.
effect.OnOverscrolled(cc::OverscrollBehavior(), -scroll_up);
EXPECT_TRUE(effect.IsActive());
EXPECT_FALSE(effect.IsAwaitingScrollUpdateAck());
EXPECT_TRUE(GetAndResetPullStarted());
// Further scrolls will be consumed.
EXPECT_TRUE(effect.WillHandleScrollUpdate(gfx::Vector2dF(0, 50)));
EXPECT_EQ(50.f, GetAndResetPullDelta());
EXPECT_TRUE(effect.IsActive());
// Even scrolls in the down direction should be consumed.
EXPECT_TRUE(effect.WillHandleScrollUpdate(gfx::Vector2dF(0, -50)));
EXPECT_EQ(-50.f, GetAndResetPullDelta());
EXPECT_TRUE(effect.IsActive());
// Ending the scroll while beyond the threshold should trigger a refresh.
gfx::Vector2dF zero_velocity;
EXPECT_FALSE(GetAndResetPullReleased());
effect.OnScrollEnd(zero_velocity);
EXPECT_FALSE(effect.IsActive());
EXPECT_TRUE(GetAndResetPullReleased());
EXPECT_TRUE(GetAndResetRefreshAllowed());
}
TEST_F(OverscrollRefreshTest, NotTriggeredIfInitialYOffsetIsNotZero) {
OverscrollRefresh effect(this, kDefaultEdgeWidth);
// A positive y scroll offset at the start of scroll will prevent activation,
// even if the subsequent scroll overscrolls upward.
gfx::PointF nonzero_offset(0, 10);
gfx::SizeF viewport(100, 100);
gfx::SizeF content_size(100, 10000);
bool overflow_y_hidden = false;
effect.OnFrameUpdated(viewport, nonzero_offset, content_size,
overflow_y_hidden);
effect.OnScrollBegin(kStartPos);
effect.OnFrameUpdated(viewport, gfx::PointF(), content_size,
overflow_y_hidden);
gfx::Vector2dF scroll_delta = gfx::Vector2dF(0, 10);
ASSERT_FALSE(effect.WillHandleScrollUpdate(scroll_delta));
EXPECT_FALSE(effect.IsActive());
EXPECT_FALSE(effect.IsAwaitingScrollUpdateAck());
effect.OnOverscrolled(cc::OverscrollBehavior(), -scroll_delta);
EXPECT_FALSE(effect.IsActive());
EXPECT_FALSE(effect.IsAwaitingScrollUpdateAck());
EXPECT_FALSE(effect.WillHandleScrollUpdate(gfx::Vector2dF(0, 500)));
effect.OnScrollEnd(gfx::Vector2dF());
EXPECT_FALSE(GetAndResetPullStarted());
EXPECT_FALSE(GetAndResetPullReleased());
}
TEST_F(OverscrollRefreshTest, NotTriggeredIfOverflowYHidden) {
OverscrollRefresh effect(this, kDefaultEdgeWidth);
// overflow-y:hidden at the start of scroll will prevent activation.
gfx::PointF zero_offset;
bool overflow_y_hidden = true;
gfx::SizeF viewport(100, 100);
gfx::SizeF content_size(100, 10000);
effect.OnFrameUpdated(viewport, zero_offset, content_size, overflow_y_hidden);
effect.OnScrollBegin(kStartPos);
gfx::Vector2dF scroll_delta = gfx::Vector2dF(0, 10);
ASSERT_FALSE(effect.WillHandleScrollUpdate(scroll_delta));
EXPECT_FALSE(effect.IsActive());
EXPECT_FALSE(effect.IsAwaitingScrollUpdateAck());
effect.OnOverscrolled(cc::OverscrollBehavior(), -scroll_delta);
EXPECT_FALSE(effect.IsActive());
EXPECT_FALSE(effect.IsAwaitingScrollUpdateAck());
EXPECT_FALSE(effect.WillHandleScrollUpdate(gfx::Vector2dF(0, 500)));
effect.OnScrollEnd(gfx::Vector2dF());
EXPECT_FALSE(GetAndResetPullStarted());
EXPECT_FALSE(GetAndResetPullReleased());
}
TEST_F(OverscrollRefreshTest, NotTriggeredIfInitialScrollDownward) {
OverscrollRefresh effect(this, kDefaultEdgeWidth);
effect.OnScrollBegin(kStartPos);
// A downward initial scroll will prevent activation, even if the subsequent
// scroll overscrolls upward.
gfx::Vector2dF scroll_delta = gfx::Vector2dF(0, -10);
ASSERT_FALSE(effect.WillHandleScrollUpdate(scroll_delta));
EXPECT_FALSE(effect.IsActive());
EXPECT_FALSE(effect.IsAwaitingScrollUpdateAck());
effect.OnOverscrolled(cc::OverscrollBehavior(), -scroll_delta);
EXPECT_FALSE(effect.IsActive());
EXPECT_FALSE(effect.IsAwaitingScrollUpdateAck());
EXPECT_FALSE(effect.WillHandleScrollUpdate(gfx::Vector2dF(0, 500)));
effect.OnScrollEnd(gfx::Vector2dF());
EXPECT_FALSE(GetAndResetPullReleased());
}
TEST_F(OverscrollRefreshTest, NotTriggeredIfInitialScrollOrTouchConsumed) {
OverscrollRefresh effect(this, kDefaultEdgeWidth);
effect.OnScrollBegin(kStartPos);
gfx::Vector2dF scroll_delta = gfx::Vector2dF(0, 10);
ASSERT_FALSE(effect.WillHandleScrollUpdate(scroll_delta));
ASSERT_TRUE(effect.IsAwaitingScrollUpdateAck());
// Consumption of the initial touchmove or scroll should prevent future
// activation.
effect.Reset();
effect.OnOverscrolled(cc::OverscrollBehavior(), -scroll_delta);
EXPECT_FALSE(effect.IsActive());
EXPECT_FALSE(effect.IsAwaitingScrollUpdateAck());
EXPECT_FALSE(effect.WillHandleScrollUpdate(gfx::Vector2dF(0, 500)));
effect.OnOverscrolled(cc::OverscrollBehavior(), -scroll_delta);
EXPECT_FALSE(effect.IsActive());
EXPECT_FALSE(effect.IsAwaitingScrollUpdateAck());
EXPECT_FALSE(effect.WillHandleScrollUpdate(gfx::Vector2dF(0, 500)));
effect.OnScrollEnd(gfx::Vector2dF());
EXPECT_FALSE(GetAndResetPullStarted());
EXPECT_FALSE(GetAndResetPullReleased());
}
TEST_F(OverscrollRefreshTest, NotTriggeredIfFlungDownward) {
OverscrollRefresh effect(this, kDefaultEdgeWidth);
effect.OnScrollBegin(kStartPos);
gfx::Vector2dF scroll_delta = gfx::Vector2dF(0, 10);
ASSERT_FALSE(effect.WillHandleScrollUpdate(scroll_delta));
ASSERT_TRUE(effect.IsAwaitingScrollUpdateAck());
effect.OnOverscrolled(cc::OverscrollBehavior(), -scroll_delta);
ASSERT_TRUE(effect.IsActive());
EXPECT_TRUE(GetAndResetPullStarted());
// Terminating the pull with a down-directed fling should prevent triggering.
effect.OnScrollEnd(gfx::Vector2dF(0, -1000));
EXPECT_TRUE(GetAndResetPullReleased());
EXPECT_FALSE(GetAndResetRefreshAllowed());
}
TEST_F(OverscrollRefreshTest, NotTriggeredIfReleasedWithoutActivation) {
OverscrollRefresh effect(this, kDefaultEdgeWidth);
effect.OnScrollBegin(kStartPos);
gfx::Vector2dF scroll_delta = gfx::Vector2dF(0, 10);
ASSERT_FALSE(effect.WillHandleScrollUpdate(scroll_delta));
ASSERT_TRUE(effect.IsAwaitingScrollUpdateAck());
effect.OnOverscrolled(cc::OverscrollBehavior(), -scroll_delta);
ASSERT_TRUE(effect.IsActive());
EXPECT_TRUE(GetAndResetPullStarted());
// An early release should prevent the refresh action from firing.
effect.ReleaseWithoutActivation();
effect.OnScrollEnd(gfx::Vector2dF());
EXPECT_TRUE(GetAndResetPullReleased());
EXPECT_FALSE(GetAndResetRefreshAllowed());
}
TEST_F(OverscrollRefreshTest, NotTriggeredIfReset) {
OverscrollRefresh effect(this, kDefaultEdgeWidth);
effect.OnScrollBegin(kStartPos);
gfx::Vector2dF scroll_delta = gfx::Vector2dF(0, 10);
ASSERT_FALSE(effect.WillHandleScrollUpdate(scroll_delta));
ASSERT_TRUE(effect.IsAwaitingScrollUpdateAck());
effect.OnOverscrolled(cc::OverscrollBehavior(), -scroll_delta);
ASSERT_TRUE(effect.IsActive());
EXPECT_TRUE(GetAndResetPullStarted());
// An early reset should prevent the refresh action from firing.
effect.Reset();
EXPECT_TRUE(GetAndResetPullReset());
effect.OnScrollEnd(gfx::Vector2dF());
EXPECT_FALSE(GetAndResetPullReleased());
}
TEST_F(OverscrollRefreshTest, TriggerPullFromBottomEdge) {
OverscrollRefresh effect(this, kDefaultEdgeWidth);
// Set yOffset as reaching the bottom of the page.
gfx::PointF nonzero_offset(0, 900);
gfx::SizeF viewport(100, 100);
gfx::SizeF content_size(100, 1000);
bool overflow_y_hidden = false;
effect.OnFrameUpdated(viewport, nonzero_offset, content_size,
overflow_y_hidden);
gfx::PointF start(2.f, 902.f);
effect.OnScrollBegin(start);
EXPECT_FALSE(effect.IsActive());
EXPECT_TRUE(effect.IsAwaitingScrollUpdateAck());
// The initial scroll should not be consumed, as it should first be offered
// to content.
gfx::Vector2dF scroll_down(0, -10);
EXPECT_FALSE(effect.WillHandleScrollUpdate(scroll_down));
EXPECT_FALSE(effect.IsActive());
EXPECT_TRUE(effect.IsAwaitingScrollUpdateAck());
// The unconsumed, overscrolling scroll will trigger the effect.
effect.OnOverscrolled(cc::OverscrollBehavior(), -scroll_down);
EXPECT_TRUE(effect.IsActive());
EXPECT_FALSE(effect.IsAwaitingScrollUpdateAck());
EXPECT_TRUE(GetAndResetPullStarted());
// Further scrolls will be consumed.
EXPECT_TRUE(effect.WillHandleScrollUpdate(gfx::Vector2dF(0, -50)));
EXPECT_EQ(-50.f, GetAndResetPullDelta());
EXPECT_TRUE(effect.IsActive());
// Even scrolls in the different direction should be consumed.
EXPECT_TRUE(effect.WillHandleScrollUpdate(gfx::Vector2dF(0, 50)));
EXPECT_EQ(50.f, GetAndResetPullDelta());
EXPECT_TRUE(effect.IsActive());
// Ending the scroll while beyond the threshold should trigger a refresh.
gfx::Vector2dF zero_velocity;
EXPECT_FALSE(GetAndResetPullReleased());
effect.OnScrollEnd(zero_velocity);
EXPECT_FALSE(effect.IsActive());
EXPECT_TRUE(GetAndResetPullReleased());
EXPECT_TRUE(GetAndResetRefreshAllowed());
}
TEST_F(OverscrollRefreshTest, NotTriggeredIfInitialScrollNotFromBottom) {
OverscrollRefresh effect(this, kDefaultEdgeWidth);
// A negative y scroll offset at the start of scroll will prevent activation,
// since it's not starting from the bottom, even if the subsequent scroll
// overscrolls upward.
gfx::SizeF viewport(100, 100);
gfx::SizeF content_size(100, 110);
bool overflow_y_hidden = false;
effect.OnFrameUpdated(viewport, gfx::PointF(), content_size,
overflow_y_hidden);
effect.OnScrollBegin(kStartPos);
effect.OnFrameUpdated(viewport, gfx::PointF(), content_size,
overflow_y_hidden);
gfx::Vector2dF scroll_delta = gfx::Vector2dF(0, -10);
ASSERT_FALSE(effect.WillHandleScrollUpdate(scroll_delta));
EXPECT_FALSE(effect.IsActive());
EXPECT_FALSE(effect.IsAwaitingScrollUpdateAck());
effect.OnOverscrolled(cc::OverscrollBehavior(), -scroll_delta);
EXPECT_FALSE(effect.IsActive());
EXPECT_FALSE(effect.IsAwaitingScrollUpdateAck());
EXPECT_FALSE(effect.WillHandleScrollUpdate(gfx::Vector2dF(0, -500)));
effect.OnScrollEnd(gfx::Vector2dF());
EXPECT_FALSE(GetAndResetPullStarted());
EXPECT_FALSE(GetAndResetPullReleased());
}
TEST_F(OverscrollRefreshTest, NotTriggeredIfContentSizeEqualsToViewport) {
OverscrollRefresh effect(this, kDefaultEdgeWidth);
// bottom overscroll only triggers when content is scrollable.
gfx::SizeF viewport(100, 100);
gfx::SizeF content_size(100, 100);
bool overflow_y_hidden = false;
effect.OnFrameUpdated(viewport, gfx::PointF(), content_size,
overflow_y_hidden);
effect.OnScrollBegin(kStartPos);
effect.OnFrameUpdated(viewport, gfx::PointF(), content_size,
overflow_y_hidden);
gfx::Vector2dF scroll_delta = gfx::Vector2dF(0, -10);
ASSERT_FALSE(effect.WillHandleScrollUpdate(scroll_delta));
EXPECT_FALSE(effect.IsActive());
EXPECT_FALSE(effect.IsAwaitingScrollUpdateAck());
effect.OnOverscrolled(cc::OverscrollBehavior(), -scroll_delta);
EXPECT_FALSE(effect.IsActive());
EXPECT_FALSE(effect.IsAwaitingScrollUpdateAck());
EXPECT_FALSE(effect.WillHandleScrollUpdate(gfx::Vector2dF(0, -500)));
effect.OnScrollEnd(gfx::Vector2dF());
EXPECT_FALSE(GetAndResetPullStarted());
EXPECT_FALSE(GetAndResetPullReleased());
}
TEST_F(OverscrollRefreshTest, OverscrollBehaviorYAutoTriggersStart) {
TestOverscrollBehavior(cc::OverscrollBehavior(), gfx::Vector2dF(0, 10), true);
}
TEST_F(OverscrollRefreshTest, OverscrollBehaviorYContainPreventsTriggerStart) {
auto ob = cc::OverscrollBehavior();
ob.y = cc::OverscrollBehavior::Type::kContain;
TestOverscrollBehavior(ob, gfx::Vector2dF(0, 10), false);
}
TEST_F(OverscrollRefreshTest, OverscrollBehaviorYNonePreventsTriggerStart) {
auto ob = cc::OverscrollBehavior();
ob.y = cc::OverscrollBehavior::Type::kNone;
TestOverscrollBehavior(ob, gfx::Vector2dF(0, 10), false);
}
TEST_F(OverscrollRefreshTest, OverscrollBehaviorXAutoTriggersStart) {
TestOverscrollBehavior(cc::OverscrollBehavior(), gfx::Vector2dF(10, 0), true);
}
TEST_F(OverscrollRefreshTest, OverscrollBehaviorXContainPreventsTriggerStart) {
auto ob = cc::OverscrollBehavior();
ob.x = cc::OverscrollBehavior::Type::kContain;
TestOverscrollBehavior(ob, gfx::Vector2dF(10, 0), false);
}
TEST_F(OverscrollRefreshTest, OverscrollBehaviorXNonePreventsTriggerStart) {
auto ob = cc::OverscrollBehavior();
ob.x = cc::OverscrollBehavior::Type::kNone;
TestOverscrollBehavior(ob, gfx::Vector2dF(10, 0), false);
}
} // namespace ui
|
