Skip to content

feat(webdriverio): use checkVisibility for display checks#14075

Merged
christian-bromann merged 2 commits intomainfrom
cb/isDisplayed-revamp
Jan 17, 2025
Merged

feat(webdriverio): use checkVisibility for display checks#14075
christian-bromann merged 2 commits intomainfrom
cb/isDisplayed-revamp

Conversation

@christian-bromann
Copy link
Member

Proposed changes

The web platform now provides a checkVisibility function to verify if an element is visible or not. It makes sense to rely on that implementation than maintaining one (that we forked from a different project) ourselves.

Furthermore this tweaks the function execution to expose the function name if available to make it easier to understand which WebdriverIO helper functions were called in the logs.

This "should" be a non breaking change but it is hard to say given that it is not much clear how the custom script worked.

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

n/a

Reviewers: @webdriverio/project-committers

@christian-bromann christian-bromann added the PR: New Feature 🚀 PRs that contain new features label Jan 15, 2025
@pkg-pr-new
Copy link

pkg-pr-new bot commented Jan 15, 2025

Open in Stackblitz

eslint-plugin-wdio

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

@wdio/allure-reporter

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

@wdio/browser-runner

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

@wdio/appium-service

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

@wdio/browserstack-service

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

@wdio/cli

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

@wdio/concise-reporter

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

@wdio/config

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

@wdio/cucumber-framework

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

@wdio/dot-reporter

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

@wdio/firefox-profile-service

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

@wdio/globals

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

@wdio/jasmine-framework

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

@wdio/json-reporter

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

@wdio/junit-reporter

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

@wdio/lighthouse-service

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

@wdio/local-runner

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

@wdio/logger

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

@wdio/mocha-framework

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

@wdio/protocols

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

@wdio/repl

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

@wdio/reporter

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

@wdio/runner

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

@wdio/sauce-service

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

@wdio/shared-store-service

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

@wdio/smoke-test-cjs-service

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

@wdio/smoke-test-reporter

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

@wdio/smoke-test-service

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

@wdio/spec-reporter

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

@wdio/static-server-service

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

@wdio/sumologic-reporter

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

@wdio/testingbot-service

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

@wdio/types

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

@wdio/utils

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

@wdio/webdriver-mock-service

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

webdriver

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

webdriverio

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

commit: 6ac6835

@erwinheitzman
Copy link
Member

Oh damn, nice that they standardised this!

I can run some tests with this if we release a "next" version or something like this. What do you think?

@christian-bromann
Copy link
Member Author

I can run some tests with this if we release a "next" version or something like this. What do you think?

@erwinheitzman you can already via:

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

@nextlevelbeard
Copy link
Member

@christian-bromann Great stuff! But I'm concerned about one thing:
I'm seeing that it is always making the check for the command availability every time isDisplayed is called.
It would perhaps be more performative if the check is made once when the session is created / attached / reloaded, and have the commands respect the setting.

@christian-bromann
Copy link
Member Author

I'm seeing that it is always making the check for the command availability every time isDisplayed is called.
It would perhaps be more performative if the check is made once when the session is created / attached / reloaded, and have the commands respect the setting.

@nextlevelbeard can you raise a new issue for this? It seems unrelated to this change given we just change how we find out whether an element is visible.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

PR: New Feature 🚀 PRs that contain new features

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants