Skip to content

Commit 9c9f5b6

Browse files
DavertMikDavertMikclaude
authored
feat: strict mode for all helpers + improved MultipleElementsFound error (#5491)
* feat: improve MultipleElementsFound error and add strict mode to all helpers Add strict mode support to Puppeteer and WebDriver helpers (previously only Playwright). When `strict: true`, single-element operations (click, fillField, etc.) throw MultipleElementsFound if more than one element matches. Refactor MultipleElementsFound to use WebElement[] with async fetchDetails() that shows absolute XPath and minified outerHTML for each matched element. Add toAbsoluteXPath() and toOuterHTML() to WebElement class. Auto-call fetchDetails() in CLI error display. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * refactor: extract simplifyHtmlElement to lib/html.js and add toSimplifiedHTML to WebElement Move HTML simplification logic (removeNonInteractiveElements + unwrap + truncate) into a reusable simplifyHtmlElement() function in lib/html.js. Add toSimplifiedHTML() method to WebElement that combines toOuterHTML() with simplifyHtmlElement(). MultipleElementsFound.fetchDetails() now uses webEl.toSimplifiedHTML() directly. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * fix: WebDriver strict mode - use Array.from for element collections and fix HTML unwrap regex WebdriverIO $$ returns a special collection, not a plain array. Using Array.from() before .map() ensures WebElement[] is a real array with .length. Also fix simplifyHtmlElement regex to handle cases where <head> tag is absent in the parse5 output. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> --------- Co-authored-by: DavertMik <davert@testomat.io> Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent b6fe984 commit 9c9f5b6

8 files changed

Lines changed: 208 additions & 124 deletions

File tree

‎lib/element/WebElement.js‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
import assert from 'assert'
2+
import { simplifyHtmlElement } from '../html.js'
23

34
/**
45
* Unified WebElement class that wraps native element instances from different helpers
@@ -306,6 +307,57 @@ class WebElement {
306307
* @returns {string} Normalized CSS selector
307308
* @private
308309
*/
310+
async toAbsoluteXPath() {
311+
const xpathFn = (el) => {
312+
const parts = []
313+
let current = el
314+
while (current && current.nodeType === Node.ELEMENT_NODE) {
315+
let index = 0
316+
let sibling = current.previousSibling
317+
while (sibling) {
318+
if (sibling.nodeType === Node.ELEMENT_NODE && sibling.tagName === current.tagName) {
319+
index++
320+
}
321+
sibling = sibling.previousSibling
322+
}
323+
const tagName = current.tagName.toLowerCase()
324+
const pathIndex = index > 0 ? `[${index + 1}]` : ''
325+
parts.unshift(`${tagName}${pathIndex}`)
326+
current = current.parentElement
327+
}
328+
return '/' + parts.join('/')
329+
}
330+
331+
switch (this.helperType) {
332+
case 'playwright':
333+
return this.element.evaluate(xpathFn)
334+
case 'puppeteer':
335+
return this.element.evaluate(xpathFn)
336+
case 'webdriver':
337+
return this.helper.browser.execute(xpathFn, this.element)
338+
default:
339+
throw new Error(`Unsupported helper type: ${this.helperType}`)
340+
}
341+
}
342+
343+
async toOuterHTML() {
344+
switch (this.helperType) {
345+
case 'playwright':
346+
return this.element.evaluate(el => el.outerHTML)
347+
case 'puppeteer':
348+
return this.element.evaluate(el => el.outerHTML)
349+
case 'webdriver':
350+
return this.helper.browser.execute(el => el.outerHTML, this.element)
351+
default:
352+
throw new Error(`Unsupported helper type: ${this.helperType}`)
353+
}
354+
}
355+
356+
async toSimplifiedHTML(maxLength = 300) {
357+
const outerHTML = await this.toOuterHTML()
358+
return simplifyHtmlElement(outerHTML, maxLength)
359+
}
360+
309361
_normalizeLocator(locator) {
310362
if (typeof locator === 'string') {
311363
return locator

‎lib/helper/Playwright.js‎

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1764,7 +1764,7 @@ class Playwright extends Helper {
17641764
if (elements.length === 0) {
17651765
throw new ElementNotFound(locator, 'Element', 'was not found')
17661766
}
1767-
if (this.options.strict) assertOnlyOneElement(elements, locator)
1767+
if (this.options.strict) assertOnlyOneElement(elements, locator, this)
17681768
return elements[0]
17691769
}
17701770

@@ -1780,7 +1780,7 @@ class Playwright extends Helper {
17801780
const context = providedContext || (await this._getContext())
17811781
const els = await findCheckable.call(this, locator, context)
17821782
assertElementExists(els[0], locator, 'Checkbox or radio')
1783-
if (this.options.strict) assertOnlyOneElement(els, locator)
1783+
if (this.options.strict) assertOnlyOneElement(els, locator, this)
17841784
return els[0]
17851785
}
17861786

@@ -2267,7 +2267,7 @@ class Playwright extends Helper {
22672267
async fillField(field, value, context = null) {
22682268
const els = await findFields.call(this, field, context)
22692269
assertElementExists(els, field, 'Field')
2270-
if (this.options.strict) assertOnlyOneElement(els, field)
2270+
if (this.options.strict) assertOnlyOneElement(els, field, this)
22712271
const el = els[0]
22722272

22732273
await el.clear()
@@ -2286,7 +2286,7 @@ class Playwright extends Helper {
22862286
async clearField(locator, context = null) {
22872287
const els = await findFields.call(this, locator, context)
22882288
assertElementExists(els, locator, 'Field to clear')
2289-
if (this.options.strict) assertOnlyOneElement(els, locator)
2289+
if (this.options.strict) assertOnlyOneElement(els, locator, this)
22902290

22912291
const el = els[0]
22922292

@@ -2303,7 +2303,7 @@ class Playwright extends Helper {
23032303
async appendField(field, value, context = null) {
23042304
const els = await findFields.call(this, field, context)
23052305
assertElementExists(els, field, 'Field')
2306-
if (this.options.strict) assertOnlyOneElement(els, field)
2306+
if (this.options.strict) assertOnlyOneElement(els, field, this)
23072307
await highlightActiveElement.call(this, els[0])
23082308
await els[0].press('End')
23092309
await els[0].type(value.toString(), { delay: this.options.pressKeyDelay })
@@ -4293,7 +4293,7 @@ async function findClickable(matcher, locator) {
42934293

42944294
if (!matchedLocator.isFuzzy()) {
42954295
const els = await findElements.call(this, matcher, matchedLocator)
4296-
if (this.options.strict) assertOnlyOneElement(els, locator)
4296+
if (this.options.strict) assertOnlyOneElement(els, locator, this)
42974297
return els
42984298
}
42994299

@@ -4303,7 +4303,7 @@ async function findClickable(matcher, locator) {
43034303
try {
43044304
els = await matcher.getByRole('button', { name: matchedLocator.value }).all()
43054305
if (els.length) {
4306-
if (this.options.strict) assertOnlyOneElement(els, locator)
4306+
if (this.options.strict) assertOnlyOneElement(els, locator, this)
43074307
return els
43084308
}
43094309
} catch (err) {
@@ -4313,7 +4313,7 @@ async function findClickable(matcher, locator) {
43134313
try {
43144314
els = await matcher.getByRole('link', { name: matchedLocator.value }).all()
43154315
if (els.length) {
4316-
if (this.options.strict) assertOnlyOneElement(els, locator)
4316+
if (this.options.strict) assertOnlyOneElement(els, locator, this)
43174317
return els
43184318
}
43194319
} catch (err) {
@@ -4322,20 +4322,20 @@ async function findClickable(matcher, locator) {
43224322

43234323
els = await findElements.call(this, matcher, Locator.clickable.narrow(literal))
43244324
if (els.length) {
4325-
if (this.options.strict) assertOnlyOneElement(els, locator)
4325+
if (this.options.strict) assertOnlyOneElement(els, locator, this)
43264326
return els
43274327
}
43284328

43294329
els = await findElements.call(this, matcher, Locator.clickable.wide(literal))
43304330
if (els.length) {
4331-
if (this.options.strict) assertOnlyOneElement(els, locator)
4331+
if (this.options.strict) assertOnlyOneElement(els, locator, this)
43324332
return els
43334333
}
43344334

43354335
try {
43364336
els = await findElements.call(this, matcher, Locator.clickable.self(literal))
43374337
if (els.length) {
4338-
if (this.options.strict) assertOnlyOneElement(els, locator)
4338+
if (this.options.strict) assertOnlyOneElement(els, locator, this)
43394339
return els
43404340
}
43414341
} catch (err) {
@@ -4612,9 +4612,10 @@ function assertElementExists(res, locator, prefix, suffix) {
46124612
}
46134613
}
46144614

4615-
function assertOnlyOneElement(elements, locator) {
4615+
function assertOnlyOneElement(elements, locator, helper) {
46164616
if (elements.length > 1) {
4617-
throw new MultipleElementsFound(locator, elements)
4617+
const webElements = elements.map(el => new WebElement(el, helper))
4618+
throw new MultipleElementsFound(locator, webElements)
46184619
}
46194620
}
46204621

‎lib/helper/Puppeteer.js‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ import {
3333
} from '../utils.js'
3434
import { isColorProperty, convertColorToRGBA } from '../colorUtils.js'
3535
import ElementNotFound from './errors/ElementNotFound.js'
36+
import MultipleElementsFound from './errors/MultipleElementsFound.js'
3637
import RemoteBrowserConnectionRefused from './errors/RemoteBrowserConnectionRefused.js'
3738
import Popup from './extras/Popup.js'
3839
import Console from './extras/Console.js'
@@ -271,6 +272,7 @@ class Puppeteer extends Helper {
271272
show: false,
272273
defaultPopupAction: 'accept',
273274
highlightElement: false,
275+
strict: false,
274276
}
275277

276278
return Object.assign(defaults, config)
@@ -989,6 +991,14 @@ class Puppeteer extends Helper {
989991
*/
990992
async _locateElement(locator) {
991993
const context = await this.context
994+
if (this.options.strict) {
995+
const elements = await findElements.call(this, context, locator)
996+
if (elements.length === 0) {
997+
throw new ElementNotFound(locator, 'Element', 'was not found')
998+
}
999+
assertOnlyOneElement(elements, locator, this)
1000+
return elements[0]
1001+
}
9921002
return findElement.call(this, context, locator)
9931003
}
9941004

@@ -1006,6 +1016,7 @@ class Puppeteer extends Helper {
10061016
if (!els || els.length === 0) {
10071017
throw new ElementNotFound(locator, 'Checkbox or radio')
10081018
}
1019+
if (this.options.strict) assertOnlyOneElement(els, locator, this)
10091020
return els[0]
10101021
}
10111022

@@ -1565,6 +1576,7 @@ class Puppeteer extends Helper {
15651576
async fillField(field, value, context = null) {
15661577
const els = await findVisibleFields.call(this, field, context)
15671578
assertElementExists(els, field, 'Field')
1579+
if (this.options.strict) assertOnlyOneElement(els, field, this)
15681580
const el = els[0]
15691581
const tag = await el.getProperty('tagName').then(el => el.jsonValue())
15701582
const editable = await el.getProperty('contenteditable').then(el => el.jsonValue())
@@ -1595,6 +1607,7 @@ class Puppeteer extends Helper {
15951607
async appendField(field, value, context = null) {
15961608
const els = await findVisibleFields.call(this, field, context)
15971609
assertElementExists(els, field, 'Field')
1610+
if (this.options.strict) assertOnlyOneElement(els, field, this)
15981611
highlightActiveElement.call(this, els[0], await this._getContext())
15991612
await els[0].press('End')
16001613
await els[0].type(value.toString(), { delay: this.options.pressKeyDelay })
@@ -3091,6 +3104,7 @@ async function proceedClick(locator, context = null, options = {}) {
30913104
} else {
30923105
assertElementExists(els, locator, 'Clickable element')
30933106
}
3107+
if (this.options.strict) assertOnlyOneElement(els, locator, this)
30943108

30953109
highlightActiveElement.call(this, els[0], await this._getContext())
30963110

@@ -3418,6 +3432,13 @@ function assertElementExists(res, locator, prefix, suffix) {
34183432
}
34193433
}
34203434

3435+
function assertOnlyOneElement(elements, locator, helper) {
3436+
if (elements.length > 1) {
3437+
const webElements = elements.map(el => new WebElement(el, helper))
3438+
throw new MultipleElementsFound(locator, webElements)
3439+
}
3440+
}
3441+
34213442
function $XPath(element, selector) {
34223443
const found = document.evaluate(selector, element || document.body, null, 5, null)
34233444
const res = []

‎lib/helper/WebDriver.js‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ import {
3030
} from '../utils.js'
3131
import { isColorProperty, convertColorToRGBA } from '../colorUtils.js'
3232
import ElementNotFound from './errors/ElementNotFound.js'
33+
import MultipleElementsFound from './errors/MultipleElementsFound.js'
3334
import ConnectionRefused from './errors/ConnectionRefused.js'
3435
import Locator from '../locator.js'
3536
import { highlightElement } from './scripts/highlightElement.js'
@@ -504,6 +505,7 @@ class WebDriver extends Helper {
504505
keepBrowserState: false,
505506
deprecationWarnings: false,
506507
highlightElement: false,
508+
strict: false,
507509
}
508510

509511
// override defaults with config
@@ -1091,6 +1093,7 @@ class WebDriver extends Helper {
10911093
} else {
10921094
assertElementExists(res, locator, 'Clickable element')
10931095
}
1096+
if (this.options.strict) assertOnlyOneElement(res, locator, this)
10941097
const elem = usingFirstElement(res)
10951098
highlightActiveElement.call(this, elem)
10961099
return this.browser[clickMethod](getElementId(elem))
@@ -1110,6 +1113,7 @@ class WebDriver extends Helper {
11101113
} else {
11111114
assertElementExists(res, locator, 'Clickable element')
11121115
}
1116+
if (this.options.strict) assertOnlyOneElement(res, locator, this)
11131117
const elem = usingFirstElement(res)
11141118
highlightActiveElement.call(this, elem)
11151119

@@ -1137,6 +1141,7 @@ class WebDriver extends Helper {
11371141
} else {
11381142
assertElementExists(res, locator, 'Clickable element')
11391143
}
1144+
if (this.options.strict) assertOnlyOneElement(res, locator, this)
11401145

11411146
const elem = usingFirstElement(res)
11421147
highlightActiveElement.call(this, elem)
@@ -1157,6 +1162,7 @@ class WebDriver extends Helper {
11571162
} else {
11581163
assertElementExists(res, locator, 'Clickable element')
11591164
}
1165+
if (this.options.strict) assertOnlyOneElement(res, locator, this)
11601166

11611167
const el = usingFirstElement(res)
11621168

@@ -1273,6 +1279,7 @@ class WebDriver extends Helper {
12731279
async fillField(field, value, context = null) {
12741280
const res = await findFields.call(this, field, context)
12751281
assertElementExists(res, field, 'Field')
1282+
if (this.options.strict) assertOnlyOneElement(res, field, this)
12761283
const elem = usingFirstElement(res)
12771284
highlightActiveElement.call(this, elem)
12781285
try {
@@ -1296,6 +1303,7 @@ class WebDriver extends Helper {
12961303
async appendField(field, value, context = null) {
12971304
const res = await findFields.call(this, field, context)
12981305
assertElementExists(res, field, 'Field')
1306+
if (this.options.strict) assertOnlyOneElement(res, field, this)
12991307
const elem = usingFirstElement(res)
13001308
highlightActiveElement.call(this, elem)
13011309
return elem.addValue(value.toString())
@@ -1308,6 +1316,7 @@ class WebDriver extends Helper {
13081316
async clearField(field, context = null) {
13091317
const res = await findFields.call(this, field, context)
13101318
assertElementExists(res, field, 'Field')
1319+
if (this.options.strict) assertOnlyOneElement(res, field, this)
13111320
const elem = usingFirstElement(res)
13121321
highlightActiveElement.call(this, elem)
13131322
return elem.clearValue(getElementId(elem))
@@ -3282,6 +3291,13 @@ function usingFirstElement(els) {
32823291
return els[0]
32833292
}
32843293

3294+
function assertOnlyOneElement(elements, locator, helper) {
3295+
if (elements.length > 1) {
3296+
const webElements = Array.from(elements).map(el => new WebElement(el, helper))
3297+
throw new MultipleElementsFound(locator, webElements)
3298+
}
3299+
}
3300+
32853301
function getElementId(el) {
32863302
// W3C WebDriver web element identifier
32873303
// https://w3c.github.io/webdriver/#dfn-web-element-identifier

0 commit comments

Comments
 (0)