forked from cypress-io/cypress
/
scroll.ts
416 lines (354 loc) · 11.8 KB
/
scroll.ts
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
import _ from 'lodash'
import $ from 'jquery'
import Promise from 'bluebird'
import $dom from '../../../dom'
import $utils from '../../../cypress/utils'
import $errUtils from '../../../cypress/error_utils'
import type { Log } from '../../../cypress/log'
const findScrollableParent = ($el, win) => {
const $parent = $dom.getParent($el)
// if we're at the body, we just want to pass in
// window into jQuery scrollTo
if ($parent.is('body,html') || $dom.isDocument($parent)) {
return win
}
if ($dom.isScrollable($parent)) {
return $parent
}
return findScrollableParent($parent, win)
}
const isNaNOrInfinity = (item) => {
const num = Number.parseFloat(item)
return _.isNaN(num) || !_.isFinite(num)
}
interface InternalScrollIntoViewOptions extends Partial<Cypress.ScrollToOptions> {
_log?: Log
$el: JQuery
$parent: any
axis: string
offset?: object
}
interface InternalScrollToOptions extends Partial<Cypress.ScrollToOptions> {
_log?: Log
$el: any
x: number
y: number
error?: any
axis: string
}
export default (Commands, Cypress, cy, state) => {
Commands.addAll({ prevSubject: 'element' }, {
scrollIntoView (subject, userOptions: Partial<Cypress.ScrollToOptions> = {}) {
if (!_.isObject(userOptions)) {
$errUtils.throwErrByPath('scrollIntoView.invalid_argument', { args: { arg: userOptions } })
}
// ensure the subject is not window itself
// cause how are you gonna scroll the window into view...
if (subject === state('window')) {
$errUtils.throwErrByPath('scrollIntoView.subject_is_window')
}
// throw if we're trying to scroll to multiple elements
if (subject.length > 1) {
$errUtils.throwErrByPath('scrollIntoView.multiple_elements', { args: { num: subject.length } })
}
const options: InternalScrollIntoViewOptions = _.defaults({}, userOptions, {
$el: subject,
$parent: state('window'),
log: true,
duration: 0,
easing: 'swing',
axis: 'xy',
})
// figure out the options which actually change the behavior of clicks
let deltaOptions = $utils.filterOutOptions(options)
// here we want to figure out what has to actually
// be scrolled to get to this element, cause we need
// to scrollTo passing in that element.
options.$parent = findScrollableParent(options.$el, state('window'))
let parentIsWin = false
if (options.$parent === state('window')) {
parentIsWin = true
// jQuery scrollTo looks for the prop contentWindow
// otherwise it'll use the wrong window to scroll :(
options.$parent.contentWindow = options.$parent
}
// if we cannot parse an integer out of duration
// which could be 500 or "500", then it's NaN...throw
if (isNaNOrInfinity(options.duration)) {
$errUtils.throwErrByPath('scrollIntoView.invalid_duration', { args: { duration: options.duration } })
}
if (!((options.easing === 'swing') || (options.easing === 'linear'))) {
$errUtils.throwErrByPath('scrollIntoView.invalid_easing', { args: { easing: options.easing } })
}
if (options.log) {
deltaOptions = $utils.filterOutOptions(options, { duration: 0, easing: 'swing', offset: { left: 0, top: 0 } })
const log = {
$el: options.$el,
message: deltaOptions,
timeout: options.timeout,
consoleProps () {
const obj = {
// merge into consoleProps without mutating it
'Applied To': $dom.getElements(options.$el),
'Scrolled Element': $dom.getElements(options.$el),
}
return obj
},
}
options._log = Cypress.log(log)
}
if (!parentIsWin) {
// scroll the parent into view first
// before attemp
options.$parent[0].scrollIntoView()
}
const scrollIntoView = () => {
return new Promise((resolve, reject) => {
// scroll our axes
return $(options.$parent).scrollTo(options.$el, {
axis: options.axis,
easing: options.easing,
duration: options.duration,
offset: options.offset,
done () {
return resolve(options.$el)
},
fail () {
// its Promise object is rejected
try {
return $errUtils.throwErrByPath('scrollTo.animation_failed')
} catch (err) {
return reject(err)
}
},
always () {
if (parentIsWin) {
delete options.$parent.contentWindow
}
},
})
})
}
return scrollIntoView()
.then(() => {
const verifyAssertions = () => {
return cy.verifyUpcomingAssertions(options.$el, options, {
onRetry: verifyAssertions,
})
}
return verifyAssertions()
})
},
})
Commands.addAll({ prevSubject: ['optional', 'element', 'window'] }, {
scrollTo (subject, xOrPosition, yOrOptions, userOptions: Partial<Cypress.ScrollToOptions> = {}) {
let x; let y
// check for undefined or null values
if (xOrPosition === undefined || xOrPosition === null) {
$errUtils.throwErrByPath('scrollTo.invalid_target', { args: { x } })
}
if (_.isObject(yOrOptions)) {
userOptions = yOrOptions
} else {
y = yOrOptions
}
let position: string | null = null
// we may be '50%' or 'bottomCenter'
if (_.isString(xOrPosition)) {
// if there's a number in our string, then
// don't check for positions and just set x
// this will check for NaN, etc - we need to explicitly
// include '0%' as a use case
if (Number.parseFloat(xOrPosition) || (Number.parseFloat(xOrPosition) === 0)) {
x = xOrPosition
} else {
position = xOrPosition
// make sure it's one of the valid position strings
cy.ensureValidPosition(position)
}
} else {
x = xOrPosition
}
switch (position) {
case 'topLeft':
x = 0 // y = 0
break
case 'top':
x = '50%' // y = 0
break
case 'topRight':
x = '100%' // y = 0
break
case 'left':
x = 0
y = '50%'
break
case 'center':
x = '50%'
y = '50%'
break
case 'right':
x = '100%'
y = '50%'
break
case 'bottomLeft':
x = 0
y = '100%'
break
case 'bottom':
x = '50%'
y = '100%'
break
case 'bottomRight':
x = '100%'
y = '100%'
break
default:
break
}
if (y == null) {
y = 0
}
if (x == null) {
x = 0
}
let $container
let isWin
// if our subject is window let it fall through
if (subject && !$dom.isWindow(subject)) {
// if they passed something here, its a DOM element
$container = subject
} else {
isWin = true
// if we don't have a subject, then we are a parent command
// assume they want to scroll the entire window.
$container = state('window')
// jQuery scrollTo looks for the prop contentWindow
// otherwise it'll use the wrong window to scroll :(
$container.contentWindow = $container
}
// throw if we're trying to scroll multiple containers
if (!isWin && $container.length > 1) {
$errUtils.throwErrByPath('scrollTo.multiple_containers', { args: { num: $container.length } })
}
const options: InternalScrollToOptions = _.defaults({}, userOptions, {
$el: $container,
log: true,
duration: 0,
easing: 'swing',
axis: 'xy',
ensureScrollable: true,
x,
y,
})
// if we cannot parse an integer out of duration
// which could be 500 or "500", then it's NaN...throw
if (isNaNOrInfinity(options.duration)) {
$errUtils.throwErrByPath('scrollTo.invalid_duration', { args: { duration: options.duration } })
}
if (!((options.easing === 'swing') || (options.easing === 'linear'))) {
$errUtils.throwErrByPath('scrollTo.invalid_easing', { args: { easing: options.easing } })
}
if (!_.isBoolean(options.ensureScrollable)) {
$errUtils.throwErrByPath('scrollTo.invalid_ensureScrollable', { args: { ensureScrollable: options.ensureScrollable } })
}
// if we cannot parse an integer out of y or x
// which could be 50 or "50px" or "50%" then
// it's NaN/Infinity...throw
if (isNaNOrInfinity(options.y) || isNaNOrInfinity(options.x)) {
$errUtils.throwErrByPath('scrollTo.invalid_target', { args: { x, y } })
}
if (options.log) {
const deltaOptions = $utils.stringify(
$utils.filterOutOptions(options, { duration: 0, easing: 'swing' }),
)
const messageArgs: string[] = []
if (position) {
messageArgs.push(position)
} else {
messageArgs.push(x)
messageArgs.push(y)
}
if (deltaOptions) {
messageArgs.push(deltaOptions)
}
const log: Record<string, any> = {
message: messageArgs.join(', '),
timeout: options.timeout,
consoleProps () {
// merge into consoleProps without mutating it
const obj: Record<string, any> = {}
if (position) {
obj.Position = position
} else {
obj.X = x
obj.Y = y
}
if (deltaOptions) {
obj.Options = deltaOptions
}
obj['Scrolled Element'] = $dom.getElements(options.$el)
return obj
},
}
if (!isWin) {
log.$el = options.$el
}
options._log = Cypress.log(log)
}
const ensureScrollability = () => {
// Some elements are not scrollable, user may opt out of error checking
// https://github.com/cypress-io/cypress/issues/1924
if (!options.ensureScrollable) {
return
}
try {
// make sure our container can even be scrolled
return cy.ensureScrollability($container, 'scrollTo')
} catch (err) {
options.error = err
return cy.retry(ensureScrollability, options)
}
}
const scrollTo = () => {
return new Promise((resolve, reject) => {
// scroll our axis
$(options.$el).scrollTo({ left: x, top: y }, {
axis: options.axis,
easing: options.easing,
duration: options.duration,
// TODO: ensureScrollable option does not exist on jQuery or config/jquery.scrollto.ts.
// It can be removed.
// @ts-ignore
ensureScrollable: options.ensureScrollable,
done () {
return resolve(options.$el)
},
fail () {
// its Promise object is rejected
try {
return $errUtils.throwErrByPath('scrollTo.animation_failed')
} catch (err) {
return reject(err)
}
},
})
if (isWin) {
delete options.$el.contentWindow
}
})
}
return Promise
.try(ensureScrollability)
.then(scrollTo)
.then(() => {
const verifyAssertions = () => {
return cy.verifyUpcomingAssertions(options.$el, options, {
onRetry: verifyAssertions,
})
}
return verifyAssertions()
})
},
})
}