fix: update waitForExist function to maintain elementIds for shadow e… by b-kirby · Pull Request #14836 · webdriverio/webdriverio

b-kirby · 2025-10-31T16:56:40Z

Proposed changes

Adds a small change to the waitForExist function for and edge case that causes the switchFrame function to fail with an undefined elementId when passing in a shadow Element.

The impact of the problem occurs in this part of the switchFrame logic:

webdriverio/packages/webdriverio/src/commands/browser/switchFrame.ts

Line 296 in e86efcc

await element.waitForExist({

if (isPossiblyUnresolvedElement(context)) {
        const element = await context.getElement()
        await element.waitForExist({
            timeoutMsg: `Can't switch to frame with selector ${element.selector} because it doesn't exist`
        })
        return switchToFrameUsingElement(this, element)
    }

The issue is hard to detect as it has no impact in most cases due to the internal logic and the return type.

In this scenario the function correctly returns true but it also resets the global elementId to be undefined due to this line:

webdriverio/packages/webdriverio/src/commands/element/waitForExist.ts

Line 68 in e86efcc

this.elementId = await this.parent.$(this.selector).elementId

Because the element being passed into the function is a shadow element, the parent is unable to find the element based on the provided selector.

Inside the switchFrame function the elementId is now undefined prior to calling

return switchToFrameUsingElement(this, element)

which results in an error similar to the following:

WebDriver Bidi command "script.callFunction" failed with error: invalid argument - Expected "type" to be a string, got [object Undefined] undefined

The fix is intended to be the least invasive approach with minimal impact to the underlying functionality in most cases.

Types of changes

Polish (an improvement for an existing feature)
Bugfix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to not work as expected)
Documentation update (improvements to the project's docs)
Specification changes (updates to WebDriver command specifications)
Internal updates (everything related to internal scripts, governance documentation and CI files)

Checklist

I have read the CONTRIBUTING doc
I have added tests that prove my fix is effective or that my feature works
I have added the necessary documentation (if appropriate)
I have added proper type definitions for new commands (if appropriate)

Backport Request

//: # (The current main branch is the development branch for WebdriverIO v9. If your change should be released to the current major version of WebdriverIO (v8), please raise another PR with the same changes against the v8 branch.)

This change is solely for v9 and doesn't need to be back-ported
Back-ported PR at #XXXXX

Further comments

Reviewers: @webdriverio/project-committers

…lements

linux-foundation-easycla · 2025-10-31T16:56:47Z

The committers listed above are authorized under a signed CLA.

✅ login: b-kirby / name: b-kirby (f427a78)

christian-bromann

LGTM 👍

pkg-pr-new · 2025-11-14T05:27:32Z

Open in StackBlitz

create-wdio

npm i https://pkg.pr.new/webdriverio/webdriverio/create-wdio@14836

eslint-plugin-wdio

npm i https://pkg.pr.new/webdriverio/webdriverio/eslint-plugin-wdio@14836

@wdio/allure-reporter

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/allure-reporter@14836

@wdio/appium-service

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/appium-service@14836

@wdio/browser-runner

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/browser-runner@14836

@wdio/browserstack-service

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/browserstack-service@14836

@wdio/cli

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/cli@14836

@wdio/concise-reporter

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/concise-reporter@14836

@wdio/config

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/config@14836

@wdio/cucumber-framework

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/cucumber-framework@14836

@wdio/dot-reporter

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/dot-reporter@14836

@wdio/firefox-profile-service

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/firefox-profile-service@14836

@wdio/globals

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/globals@14836

@wdio/jasmine-framework

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/jasmine-framework@14836

@wdio/json-reporter

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/json-reporter@14836

@wdio/junit-reporter

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/junit-reporter@14836

@wdio/lighthouse-service

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/lighthouse-service@14836

@wdio/local-runner

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/local-runner@14836

@wdio/logger

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/logger@14836

@wdio/mocha-framework

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/mocha-framework@14836

@wdio/protocols

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/protocols@14836

@wdio/repl

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/repl@14836

@wdio/reporter

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/reporter@14836

@wdio/runner

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/runner@14836

@wdio/sauce-service

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/sauce-service@14836

@wdio/shared-store-service

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/shared-store-service@14836

@wdio/smoke-test-cjs-service

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/smoke-test-cjs-service@14836

@wdio/smoke-test-reporter

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/smoke-test-reporter@14836

@wdio/smoke-test-service

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/smoke-test-service@14836

@wdio/spec-reporter

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/spec-reporter@14836

@wdio/static-server-service

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/static-server-service@14836

@wdio/sumologic-reporter

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/sumologic-reporter@14836

@wdio/testingbot-service

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/testingbot-service@14836

@wdio/types

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/types@14836

@wdio/utils

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/utils@14836

@wdio/webdriver-mock-service

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/webdriver-mock-service@14836

@wdio/xvfb

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/xvfb@14836

webdriver

npm i https://pkg.pr.new/webdriverio/webdriverio/webdriver@14836

webdriverio

npm i https://pkg.pr.new/webdriverio/webdriverio@14836

commit: 810d99c

wdio-bot · 2025-11-22T01:49:07Z

Hey b-kirby 👋

Thank you for your contribution to WebdriverIO! Your pull request has been marked as an "Expensable" contribution.

We've sent you an email with further instructions on how to claim your expenses from our development fund.
Please make sure to check your spam folder as well. If you have any questions, feel free to reach out to us at expense@webdriver.io or in the contributing channel on Discord.

We are looking forward to more contributions from you in the future 🙌

Have a nice day,
The WebdriverIO Team 🤖

fix: update waitForExist function to maintain elementIds for shadow e…

8af44dd

…lements

Merge branch 'main' into main

810d99c

christian-bromann approved these changes Nov 14, 2025

View reviewed changes

Merge branch 'main' into main

f427a78

christian-bromann merged commit 26b463f into webdriverio:main Nov 22, 2025
3 of 6 checks passed

christian-bromann added the PR: Bug Fix 🐛 PRs that contain bug fixes label Nov 22, 2025

wdio-bot added the Expensable $25 💸 label Nov 22, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

fix: update waitForExist function to maintain elementIds for shadow e…#14836

fix: update waitForExist function to maintain elementIds for shadow e…#14836
christian-bromann merged 3 commits intowebdriverio:mainfrom
b-kirby:main

b-kirby commented Oct 31, 2025

Uh oh!

linux-foundation-easycla bot commented Oct 31, 2025 •

edited

Loading

Uh oh!

christian-bromann left a comment

Uh oh!

pkg-pr-new bot commented Nov 14, 2025

Uh oh!

Uh oh!

wdio-bot commented Nov 22, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

Conversation

b-kirby commented Oct 31, 2025

Proposed changes

Types of changes

Checklist

Backport Request

Further comments

Reviewers: @webdriverio/project-committers

Uh oh!

linux-foundation-easycla bot commented Oct 31, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

christian-bromann left a comment

Choose a reason for hiding this comment

Uh oh!

pkg-pr-new bot commented Nov 14, 2025

Uh oh!

Uh oh!

wdio-bot commented Nov 22, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

linux-foundation-easycla bot commented Oct 31, 2025 •

edited

Loading