-
Notifications
You must be signed in to change notification settings - Fork 3.1k
/
screenshot.ts
585 lines (475 loc) · 15.8 KB
/
screenshot.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
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
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
/* global Cypress, cy */
import _ from 'lodash'
import $ from 'jquery'
import bytes from 'bytes'
import Promise from 'bluebird'
import $Screenshot from '../../cypress/screenshot'
import $dom from '../../dom'
import $errUtils from '../../cypress/error_utils'
import $utils from '../../cypress/utils'
import type { Log } from '../../cypress/log'
const getViewportHeight = (state) => {
// TODO this doesn't seem correct
return Math.min(state('viewportHeight'), window.innerHeight)
}
const getViewportWidth = (state) => {
return Math.min(state('viewportWidth'), window.innerWidth)
}
const automateScreenshot = (state, options: TakeScreenshotOptions = {}) => {
const { runnable, timeout } = options
const titles: string[] = []
// if this a hook then push both the current test title
// and our own hook title
if (runnable.type === 'hook') {
let ct = runnable.ctx.currentTest
if (runnable.ctx && ct) {
titles.push(ct.title, runnable.title)
}
} else {
titles.push(runnable.title)
}
const getParentTitle = (runnable) => {
const p = runnable.parent
if (p) {
const t = p.title
if (t) {
titles.unshift(t)
}
return getParentTitle(p)
}
}
getParentTitle(runnable)
const props = _.extend({
titles,
testId: runnable.id,
takenPaths: state('screenshotPaths'),
testAttemptIndex: $utils.getTestFromRunnable(runnable)._currentRetry,
}, _.omit(options, 'runnable', 'timeout', 'log', 'subject'))
const automate = () => {
return Cypress.automation('take:screenshot', props)
}
if (!timeout) {
return automate()
}
// need to remove the current timeout
// because we're handling timeouts ourselves
cy.clearTimeout('take:screenshot')
return automate()
.timeout(timeout)
.catch((err) => {
return $errUtils.throwErr(err, { onFail: options.log })
})
.catch(Promise.TimeoutError, () => {
return $errUtils.throwErrByPath('screenshot.timed_out', {
onFail: options.log,
args: { timeout },
})
})
}
const scrollOverrides = (win, doc) => {
const originalOverflow = doc.documentElement.style.overflow
const originalBodyOverflowY = doc.body.style.overflowY
const originalX = win.scrollX
const originalY = win.scrollY
// overflow-y: scroll can break `window.scrollTo`
if (doc.body) {
doc.body.style.overflowY = 'visible'
}
// hide scrollbars
doc.documentElement.style.overflow = 'hidden'
// this body class is used to set some other overflow-related CSS
// around the resizable panels in the Runner
document.querySelector('body')?.classList.add('screenshot-scrolling')
// in the case that an element might change size on scroll
// we trigger a scroll event to ensure that all elements are
// at their final size before we calculate the total height
// since we scroll down the page in takeScrollingScreenshots
// and don't want the page size to change once we start
// https://github.com/cypress-io/cypress/issues/6099
win.dispatchEvent(new win.Event('scroll'))
return () => {
doc.documentElement.style.overflow = originalOverflow
if (doc.body) {
doc.body.style.overflowY = originalBodyOverflowY
}
document.querySelector('body')?.classList.remove('screenshot-scrolling')
return win.scrollTo(originalX, originalY)
}
}
const validateNumScreenshots = (numScreenshots, automationOptions) => {
if (numScreenshots < 1) {
$errUtils.throwErrByPath('screenshot.invalid_height', {
log: automationOptions.log,
})
}
}
const takeScrollingScreenshots = (scrolls, win, state, automationOptions) => {
const scrollAndTake = ({ y, clip, afterScroll }, index) => {
win.scrollTo(0, y)
if (afterScroll) {
clip = afterScroll()
}
const options = _.extend({}, automationOptions, {
current: index + 1,
total: scrolls.length,
clip,
})
return automateScreenshot(state, options)
}
return Promise
.mapSeries(scrolls, scrollAndTake)
.then(_.last)
}
const takeFullPageScreenshot = (state, automationOptions) => {
const win = state('window')
const doc = state('document')
const resetScrollOverrides = scrollOverrides(win, doc)
const docHeight = $(doc).height() as number
const viewportHeight = getViewportHeight(state)
const numScreenshots = Math.ceil(docHeight / viewportHeight)
validateNumScreenshots(numScreenshots, automationOptions)
const scrolls = _.map(_.times(numScreenshots), (index) => {
const y = viewportHeight * index
let clip
if ((index + 1) === numScreenshots) {
const heightLeft = docHeight - (viewportHeight * index)
clip = {
x: automationOptions.clip.x,
y: viewportHeight - heightLeft,
width: automationOptions.clip.width,
height: heightLeft,
}
} else {
clip = automationOptions.clip
}
return { y, clip }
})
return takeScrollingScreenshots(scrolls, win, state, automationOptions)
.finally(resetScrollOverrides)
}
const applyPaddingToElementPositioning = (elPosition, automationOptions) => {
if (!automationOptions.padding) {
return elPosition
}
const [paddingTop, paddingRight, paddingBottom, paddingLeft] = automationOptions.padding
return {
width: elPosition.width + paddingLeft + paddingRight,
height: elPosition.height + paddingTop + paddingBottom,
fromElViewport: {
top: elPosition.fromElViewport.top - paddingTop,
left: elPosition.fromElViewport.left - paddingLeft,
bottom: elPosition.fromElViewport.bottom + paddingBottom,
},
fromElWindow: {
top: elPosition.fromElWindow.top - paddingTop,
},
}
}
const takeElementScreenshot = ($el, state, automationOptions) => {
const win = state('window')
const doc = state('document')
const resetScrollOverrides = scrollOverrides(win, doc)
let elPosition = applyPaddingToElementPositioning(
$dom.getElementPositioning($el),
automationOptions,
)
const viewportHeight = getViewportHeight(state)
const viewportWidth = getViewportWidth(state)
const numScreenshots = Math.ceil(elPosition.height / viewportHeight)
validateNumScreenshots(numScreenshots, automationOptions)
const scrolls = _.map(_.times(numScreenshots), (index) => {
const y = elPosition.fromElWindow.top + (viewportHeight * index)
const afterScroll = () => {
elPosition = applyPaddingToElementPositioning(
$dom.getElementPositioning($el),
automationOptions,
)
const x = Math.min(viewportWidth, elPosition.fromElViewport.left)
const width = Math.min(viewportWidth - x, elPosition.width)
if (numScreenshots === 1) {
return {
x,
y: elPosition.fromElViewport.top,
width,
height: elPosition.height,
}
}
if ((index + 1) === numScreenshots) {
const overlap = ((numScreenshots - 1) * viewportHeight) + elPosition.fromElViewport.top
const heightLeft = elPosition.fromElViewport.bottom - overlap
return {
x,
y: overlap,
width,
height: heightLeft,
}
}
return {
x,
y: Math.max(0, elPosition.fromElViewport.top),
width,
// TODO: try simplifying to just 'viewportHeight'
height: Math.min(viewportHeight, elPosition.fromElViewport.top + elPosition.height),
}
}
return { y, afterScroll }
})
return takeScrollingScreenshots(scrolls, win, state, automationOptions)
.finally(resetScrollOverrides)
}
// "app only" means we're hiding the runner UI
const isAppOnly = ({ capture }) => {
return (capture === 'viewport') || (capture === 'fullPage')
}
const getShouldScale = ({ capture, scale }) => {
return isAppOnly({ capture }) ? scale : true
}
const getBlackout = ({ capture, blackout }) => {
return isAppOnly({ capture }) ? blackout : []
}
// TODO: anys should be removed.
type TakeScreenshotOptions = {
name?: string
subject?: any
simple?: boolean
testFailure?: boolean
runnable?: any
log?: any
timeout?: number
}
const takeScreenshot = (Cypress, state, screenshotConfig, options: TakeScreenshotOptions = {}) => {
const {
capture,
padding,
clip,
overwrite,
disableTimersAndAnimations,
onBeforeScreenshot,
onAfterScreenshot,
} = screenshotConfig
const { subject, runnable } = options
const startTime = new Date()
// TODO: is this ok to make `resolve` undefined?
const send = (event, props, resolve?) => {
Cypress.action(`cy:${event}`, props, resolve)
}
const sendAsync = (event, props) => {
return new Promise((resolve) => {
return send(event, props, resolve)
})
}
const getOptions = (isOpen) => {
return {
id: runnable.id,
testAttemptIndex: $utils.getTestFromRunnable(runnable)._currentRetry,
isOpen,
appOnly: isAppOnly(screenshotConfig),
scale: getShouldScale(screenshotConfig),
waitForCommandSynchronization: !isAppOnly(screenshotConfig),
disableTimersAndAnimations,
blackout: getBlackout(screenshotConfig),
overwrite,
}
}
const before = ($body, $container) => {
return Promise.try(() => {
if (disableTimersAndAnimations) {
return cy.pauseTimers(true)
}
return null
})
.then(() => {
// could fail if iframe is cross-origin, so fail gracefully
try {
if (disableTimersAndAnimations) {
$dom.addCssAnimationDisabler($body)
}
_.each(getBlackout(screenshotConfig), (selector) => {
$dom.addBlackouts($body, $container, selector)
})
} catch (err) {
/* eslint-disable no-console */
console.error('Failed to modify app dom:')
console.error(err)
/* eslint-enable no-console */
}
return sendAsync('before:screenshot', getOptions(true))
})
}
const after = ($body) => {
// could fail if iframe is cross-origin, so fail gracefully
try {
if (disableTimersAndAnimations) {
$dom.removeCssAnimationDisabler($body)
}
$dom.removeBlackouts($body)
} catch (err) {
/* eslint-disable no-console */
console.error('Failed to modify app dom:')
console.error(err)
/* eslint-enable no-console */
}
send('after:screenshot', getOptions(false))
return Promise.try(() => {
if (disableTimersAndAnimations) {
return cy.pauseTimers(false)
}
return null
})
}
const automationOptions = _.extend({}, options, {
capture,
clip: {
x: 0,
y: 0,
width: getViewportWidth(state),
height: getViewportHeight(state),
},
padding,
userClip: clip,
viewport: {
width: window.innerWidth,
height: window.innerHeight,
},
scaled: getShouldScale(screenshotConfig),
blackout: getBlackout(screenshotConfig),
overwrite,
startTime: startTime.toISOString(),
})
// use the subject as $el or yield the wrapped documentElement
const $el = $dom.isElement(subject)
? subject
: $dom.wrap(state('document').documentElement)
// get the current body of the AUT to accurately calculate screenshot blackouts
// as well as properly enable/disable CSS animations while screenshotting is happening
const $body = Cypress.$('body')
return before($body, $el)
.then(() => {
if (onBeforeScreenshot) {
onBeforeScreenshot.call(state('ctx'), $el)
}
$Screenshot.onBeforeScreenshot($el)
if ($dom.isElement(subject)) {
return takeElementScreenshot($el, state, automationOptions)
}
if (capture === 'fullPage') {
return takeFullPageScreenshot(state, automationOptions)
}
return automateScreenshot(state, automationOptions)
})
.then((props) => {
if (onAfterScreenshot) {
onAfterScreenshot.call(state('ctx'), $el, props)
}
$Screenshot.onAfterScreenshot($el, props)
return props
})
.finally(() => after($body))
}
interface InternalScreenshotOptions extends Partial<Cypress.Loggable & Cypress.Timeoutable & Cypress.ScreenshotOptions> {
_log?: Log
}
export default function (Commands, Cypress, cy, state, config) {
// failure screenshot when not interactive
Cypress.on('runnable:after:run:async', (test, runnable) => {
const screenshotConfig = $Screenshot.getConfig()
if (
!test.err
|| !screenshotConfig.screenshotOnRunFailure
|| config('isInteractive')
|| test.err.isPending
|| !config('screenshotOnRunFailure')
) {
return
}
// if a screenshot has not been taken (by cy.screenshot()) in the test
// that failed, we can bypass UI-changing and pixel-checking (simple: true)
// otherwise, we need to do all the standard checks
// to make sure the UI is in the right place (simple: false)
screenshotConfig.capture = 'runner'
return takeScreenshot(Cypress, state, screenshotConfig, {
runnable,
simple: !state('screenshotTaken'),
testFailure: true,
timeout: config('responseTimeout'),
})
})
Commands.addAll({ prevSubject: ['optional', 'element', 'window', 'document'] }, {
screenshot (subject, name, userOptions: Partial<Cypress.Loggable & Cypress.Timeoutable & Cypress.ScreenshotOptions> = {}) {
if (_.isObject(name)) {
userOptions = name
name = null
}
// make sure when we capture the entire test runner
// we are not limited to "within" subject
// https://github.com/cypress-io/cypress/issues/14253
if (userOptions.capture !== 'runner') {
const withinSubject = state('withinSubject')
if (withinSubject && $dom.isElement(withinSubject)) {
subject = withinSubject
}
}
// TODO: handle hook titles
const runnable = state('runnable')
const options: InternalScreenshotOptions = _.defaults({}, userOptions, {
log: true,
timeout: config('responseTimeout'),
})
const isWin = $dom.isWindow(subject)
let screenshotConfig: any = _.pick(options, 'capture', 'scale', 'disableTimersAndAnimations', 'overwrite', 'blackout', 'waitForCommandSynchronization', 'padding', 'clip', 'onBeforeScreenshot', 'onAfterScreenshot')
screenshotConfig = $Screenshot.validate(screenshotConfig, 'screenshot', options._log)
screenshotConfig = _.extend($Screenshot.getConfig(), screenshotConfig)
// set this regardless of options.log b/c its used by the
// yielded value below
let consoleProps = _.omit(screenshotConfig, 'scale', 'screenshotOnRunFailure')
consoleProps = _.extend(consoleProps, {
scaled: getShouldScale(screenshotConfig),
blackout: getBlackout(screenshotConfig),
})
if (name) {
consoleProps.name = name
}
if (options.log) {
options._log = Cypress.log({
message: name,
timeout: options.timeout,
consoleProps () {
return consoleProps
},
})
}
if (!isWin && subject && subject.length > 1) {
$errUtils.throwErrByPath('screenshot.multiple_elements', {
log: options._log,
args: { numElements: subject.length },
})
}
if ($dom.isElement(subject)) {
screenshotConfig.capture = 'viewport'
}
state('screenshotTaken', true)
return takeScreenshot(Cypress, state, screenshotConfig, {
name,
subject,
runnable,
log: options._log,
timeout: options.timeout,
})
.then((props) => {
const { duration, path, size } = props
const { width, height } = props.dimensions
const takenPaths = state('screenshotPaths') || []
state('screenshotPaths', takenPaths.concat([path]))
_.extend(consoleProps, props, {
size: bytes(size, { unitSeparator: ' ' }),
duration: `${duration}ms`,
dimensions: `${width}px x ${height}px`,
})
if (subject) {
consoleProps.subject = subject
}
return subject
})
},
})
}