forked from cypress-io/cypress
/
aliases.js
144 lines (106 loc) · 3.09 KB
/
aliases.js
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
const _ = require('lodash')
const $errUtils = require('../cypress/error_utils')
const aliasRe = /^@.+/
const aliasDisplayRe = /^([@]+)/
const requestXhrRe = /\.request$/
const reserved = ['test', 'runnable', 'timeout', 'slow', 'skip', 'inspect']
const aliasDisplayName = (name) => {
return name.replace(aliasDisplayRe, '')
}
const getXhrTypeByAlias = (alias) => {
if (requestXhrRe.test(alias)) {
return 'request'
}
return 'response'
}
const validateAlias = (alias) => {
if (!_.isString(alias)) {
$errUtils.throwErrByPath('as.invalid_type')
}
if (aliasDisplayRe.test(alias)) {
$errUtils.throwErrByPath('as.invalid_first_token', {
args: {
alias,
suggestedName: alias.replace(aliasDisplayRe, ''),
},
})
}
if (_.isBlank(alias)) {
$errUtils.throwErrByPath('as.empty_string')
}
if (reserved.includes(alias)) {
return $errUtils.throwErrByPath('as.reserved_word', { args: { alias } })
}
}
const create = (cy) => {
const addAlias = (ctx, aliasObj) => {
const { alias, subject } = aliasObj
const aliases = cy.state('aliases') || {}
aliases[alias] = aliasObj
cy.state('aliases', aliases)
const remoteSubject = cy.getRemotejQueryInstance(subject)
ctx[alias] = remoteSubject ?? subject
}
const getNextAlias = () => {
const next = cy.state('current').get('next')
if (next && (next.get('name') === 'as')) {
return next.get('args')[0]
}
}
const getAlias = (name, cmd, log) => {
const aliases = cy.state('aliases') || {}
// bail if the name doesnt reference an alias
if (!aliasRe.test(name)) {
return
}
const alias = aliases[name.slice(1)]
// slice off the '@'
if (!alias) {
aliasNotFoundFor(name, cmd, log)
}
return alias
}
const getAvailableAliases = () => {
const aliases = cy.state('aliases')
if (!aliases) {
return []
}
return _.keys(aliases)
}
const aliasNotFoundFor = (name, cmd, log) => {
let displayName
const availableAliases = getAvailableAliases()
// throw a very specific error if our alias isnt in the right
// format, but its word is found in the availableAliases
if (!aliasRe.test(name) && availableAliases.includes(name)) {
displayName = aliasDisplayName(name)
$errUtils.throwErrByPath('alias.invalid', {
onFail: log,
args: { name, displayName },
})
}
cmd = cmd ?? ((log && log.get('name')) || cy.state('current').get('name'))
displayName = aliasDisplayName(name)
const errPath = availableAliases.length
? 'alias.not_registered_with_available'
: 'alias.not_registered_without_available'
return $errUtils.throwErrByPath(errPath, {
onFail: log,
args: { cmd, displayName, availableAliases: availableAliases.join(', ') },
})
}
return {
getAlias,
addAlias,
// these are public because its expected other commands
// know about them and are expected to call them
getNextAlias,
validateAlias,
aliasNotFoundFor,
getXhrTypeByAlias,
getAvailableAliases,
}
}
module.exports = {
create,
}