-
-
Notifications
You must be signed in to change notification settings - Fork 752
Expand file tree
/
Copy pathWebElement.js
More file actions
379 lines (348 loc) · 10.6 KB
/
WebElement.js
File metadata and controls
379 lines (348 loc) · 10.6 KB
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
import assert from 'assert'
import { simplifyHtmlElement } from '../html.js'
/**
* Unified WebElement class that wraps native element instances from different helpers
* and provides a consistent API across all supported helpers (Playwright, WebDriver, Puppeteer).
*/
class WebElement {
constructor(element, helper) {
this.element = element
this.helper = helper
this.helperType = this._detectHelperType(helper)
}
_detectHelperType(helper) {
if (!helper) return 'unknown'
const className = helper.constructor.name
if (className === 'Playwright') return 'playwright'
if (className === 'WebDriver') return 'webdriver'
if (className === 'Puppeteer') return 'puppeteer'
return 'unknown'
}
/**
* Get the native element instance
* @returns {ElementHandle|WebElement|ElementHandle} Native element
*/
getNativeElement() {
return this.element
}
/**
* Get the helper instance
* @returns {Helper} Helper instance
*/
getHelper() {
return this.helper
}
/**
* Get text content of the element
* @returns {Promise<string>} Element text content
*/
async getText() {
switch (this.helperType) {
case 'playwright':
return this.element.textContent()
case 'webdriver':
return this.element.getText()
case 'puppeteer':
return this.element.evaluate(el => el.textContent)
default:
throw new Error(`Unsupported helper type: ${this.helperType}`)
}
}
/**
* Get attribute value of the element
* @param {string} name Attribute name
* @returns {Promise<string|null>} Attribute value
*/
async getAttribute(name) {
switch (this.helperType) {
case 'playwright':
return this.element.getAttribute(name)
case 'webdriver':
return this.element.getAttribute(name)
case 'puppeteer':
return this.element.evaluate((el, attrName) => el.getAttribute(attrName), name)
default:
throw new Error(`Unsupported helper type: ${this.helperType}`)
}
}
/**
* Get property value of the element
* @param {string} name Property name
* @returns {Promise<any>} Property value
*/
async getProperty(name) {
switch (this.helperType) {
case 'playwright':
return this.element.evaluate((el, propName) => el[propName], name)
case 'webdriver':
return this.element.getProperty(name)
case 'puppeteer':
return this.element.evaluate((el, propName) => el[propName], name)
default:
throw new Error(`Unsupported helper type: ${this.helperType}`)
}
}
/**
* Get innerHTML of the element
* @returns {Promise<string>} Element innerHTML
*/
async getInnerHTML() {
switch (this.helperType) {
case 'playwright':
return this.element.innerHTML()
case 'webdriver':
return this.element.getProperty('innerHTML')
case 'puppeteer':
return this.element.evaluate(el => el.innerHTML)
default:
throw new Error(`Unsupported helper type: ${this.helperType}`)
}
}
/**
* Get value of the element (for input elements)
* @returns {Promise<string>} Element value
*/
async getValue() {
switch (this.helperType) {
case 'playwright':
return this.element.inputValue()
case 'webdriver':
return this.element.getValue()
case 'puppeteer':
return this.element.evaluate(el => el.value)
default:
throw new Error(`Unsupported helper type: ${this.helperType}`)
}
}
/**
* Check if element is visible
* @returns {Promise<boolean>} True if element is visible
*/
async isVisible() {
switch (this.helperType) {
case 'playwright':
return this.element.isVisible()
case 'webdriver':
return this.element.isDisplayed()
case 'puppeteer':
return this.element.evaluate(el => {
const style = window.getComputedStyle(el)
return style.display !== 'none' && style.visibility !== 'hidden' && style.opacity !== '0'
})
default:
throw new Error(`Unsupported helper type: ${this.helperType}`)
}
}
/**
* Check if element is enabled
* @returns {Promise<boolean>} True if element is enabled
*/
async isEnabled() {
switch (this.helperType) {
case 'playwright':
return this.element.isEnabled()
case 'webdriver':
return this.element.isEnabled()
case 'puppeteer':
return this.element.evaluate(el => !el.disabled)
default:
throw new Error(`Unsupported helper type: ${this.helperType}`)
}
}
/**
* Check if element exists in DOM
* @returns {Promise<boolean>} True if element exists
*/
async exists() {
try {
switch (this.helperType) {
case 'playwright':
// For Playwright, if we have the element, it exists
return await this.element.evaluate(el => !!el)
case 'webdriver':
// For WebDriver, if we have the element, it exists
return true
case 'puppeteer':
// For Puppeteer, if we have the element, it exists
return await this.element.evaluate(el => !!el)
default:
throw new Error(`Unsupported helper type: ${this.helperType}`)
}
} catch (e) {
return false
}
}
/**
* Get bounding box of the element
* @returns {Promise<Object>} Bounding box with x, y, width, height properties
*/
async getBoundingBox() {
switch (this.helperType) {
case 'playwright':
return this.element.boundingBox()
case 'webdriver':
const rect = await this.element.getRect()
return {
x: rect.x,
y: rect.y,
width: rect.width,
height: rect.height,
}
case 'puppeteer':
return this.element.boundingBox()
default:
throw new Error(`Unsupported helper type: ${this.helperType}`)
}
}
/**
* Click the element
* @param {Object} options Click options
* @returns {Promise<void>}
*/
async click(options = {}) {
switch (this.helperType) {
case 'playwright':
return this.element.click(options)
case 'webdriver':
return this.element.click()
case 'puppeteer':
return this.element.click(options)
default:
throw new Error(`Unsupported helper type: ${this.helperType}`)
}
}
/**
* Type text into the element
* @param {string} text Text to type
* @param {Object} options Type options
* @returns {Promise<void>}
*/
async type(text, options = {}) {
switch (this.helperType) {
case 'playwright':
return this.element.type(text, options)
case 'webdriver':
return this.element.setValue(text)
case 'puppeteer':
return this.element.type(text, options)
default:
throw new Error(`Unsupported helper type: ${this.helperType}`)
}
}
/**
* Find first child element matching the locator
* @param {string|Object} locator Element locator
* @returns {Promise<WebElement|null>} WebElement instance or null if not found
*/
async $(locator) {
let childElement
switch (this.helperType) {
case 'playwright':
childElement = await this.element.$(this._normalizeLocator(locator))
break
case 'webdriver':
try {
childElement = await this.element.$(this._normalizeLocator(locator))
} catch (e) {
return null
}
break
case 'puppeteer':
childElement = await this.element.$(this._normalizeLocator(locator))
break
default:
throw new Error(`Unsupported helper type: ${this.helperType}`)
}
return childElement ? new WebElement(childElement, this.helper) : null
}
/**
* Find all child elements matching the locator
* @param {string|Object} locator Element locator
* @returns {Promise<WebElement[]>} Array of WebElement instances
*/
async $$(locator) {
let childElements
switch (this.helperType) {
case 'playwright':
childElements = await this.element.$$(this._normalizeLocator(locator))
break
case 'webdriver':
childElements = await this.element.$$(this._normalizeLocator(locator))
break
case 'puppeteer':
childElements = await this.element.$$(this._normalizeLocator(locator))
break
default:
throw new Error(`Unsupported helper type: ${this.helperType}`)
}
return childElements.map(el => new WebElement(el, this.helper))
}
/**
* Normalize locator for element search
* @param {string|Object} locator Locator to normalize
* @returns {string} Normalized CSS selector
* @private
*/
async toAbsoluteXPath() {
const xpathFn = (el) => {
const parts = []
let current = el
while (current && current.nodeType === Node.ELEMENT_NODE) {
let index = 0
let sibling = current.previousSibling
while (sibling) {
if (sibling.nodeType === Node.ELEMENT_NODE && sibling.tagName === current.tagName) {
index++
}
sibling = sibling.previousSibling
}
const tagName = current.tagName.toLowerCase()
const pathIndex = index > 0 ? `[${index + 1}]` : ''
parts.unshift(`${tagName}${pathIndex}`)
current = current.parentElement
}
return '/' + parts.join('/')
}
switch (this.helperType) {
case 'playwright':
return this.element.evaluate(xpathFn)
case 'puppeteer':
return this.element.evaluate(xpathFn)
case 'webdriver':
return this.helper.browser.execute(xpathFn, this.element)
default:
throw new Error(`Unsupported helper type: ${this.helperType}`)
}
}
async toOuterHTML() {
switch (this.helperType) {
case 'playwright':
return this.element.evaluate(el => el.outerHTML)
case 'puppeteer':
return this.element.evaluate(el => el.outerHTML)
case 'webdriver':
return this.helper.browser.execute(el => el.outerHTML, this.element)
default:
throw new Error(`Unsupported helper type: ${this.helperType}`)
}
}
async toSimplifiedHTML(maxLength = 300) {
const outerHTML = await this.toOuterHTML()
return simplifyHtmlElement(outerHTML, maxLength)
}
_normalizeLocator(locator) {
if (typeof locator === 'string') {
return locator
}
if (typeof locator === 'object') {
// Handle CodeceptJS locator objects
if (locator.css) return locator.css
if (locator.xpath) return locator.xpath
if (locator.id) return `#${locator.id}`
if (locator.name) return `[name="${locator.name}"]`
if (locator.className) return `.${locator.className}`
}
return locator.toString()
}
}
export default WebElement