feat: enhance scrollIntoView to support native mobile by wswebcreation · Pull Request #13870 · webdriverio/webdriverio

wswebcreation · 2024-11-09T10:46:43Z

Initial setup to support Native apps

Proposed changes

This PR enhances the scrollIntoView to support native mobile apps by using the native mobile:execute methods of the drivers

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

Initial setup to support Native apps

pkg-pr-new · 2024-11-10T08:04:20Z

Open in Stackblitz

eslint-plugin-wdio

pnpm add https://pkg.pr.new/webdriverio/webdriverio/eslint-plugin-wdio@13870

@wdio/allure-reporter

pnpm add https://pkg.pr.new/webdriverio/webdriverio/@wdio/allure-reporter@13870

@wdio/browser-runner

pnpm add https://pkg.pr.new/webdriverio/webdriverio/@wdio/browser-runner@13870

@wdio/appium-service

pnpm add https://pkg.pr.new/webdriverio/webdriverio/@wdio/appium-service@13870

@wdio/browserstack-service

pnpm add https://pkg.pr.new/webdriverio/webdriverio/@wdio/browserstack-service@13870

@wdio/cli

pnpm add https://pkg.pr.new/webdriverio/webdriverio/@wdio/cli@13870

@wdio/concise-reporter

pnpm add https://pkg.pr.new/webdriverio/webdriverio/@wdio/concise-reporter@13870

@wdio/config

pnpm add https://pkg.pr.new/webdriverio/webdriverio/@wdio/config@13870

@wdio/cucumber-framework

pnpm add https://pkg.pr.new/webdriverio/webdriverio/@wdio/cucumber-framework@13870

@wdio/dot-reporter

pnpm add https://pkg.pr.new/webdriverio/webdriverio/@wdio/dot-reporter@13870

@wdio/firefox-profile-service

pnpm add https://pkg.pr.new/webdriverio/webdriverio/@wdio/firefox-profile-service@13870

@wdio/globals

pnpm add https://pkg.pr.new/webdriverio/webdriverio/@wdio/globals@13870

@wdio/jasmine-framework

pnpm add https://pkg.pr.new/webdriverio/webdriverio/@wdio/jasmine-framework@13870

@wdio/json-reporter

pnpm add https://pkg.pr.new/webdriverio/webdriverio/@wdio/json-reporter@13870

@wdio/junit-reporter

pnpm add https://pkg.pr.new/webdriverio/webdriverio/@wdio/junit-reporter@13870

@wdio/lighthouse-service

pnpm add https://pkg.pr.new/webdriverio/webdriverio/@wdio/lighthouse-service@13870

@wdio/local-runner

pnpm add https://pkg.pr.new/webdriverio/webdriverio/@wdio/local-runner@13870

@wdio/logger

pnpm add https://pkg.pr.new/webdriverio/webdriverio/@wdio/logger@13870

@wdio/mocha-framework

pnpm add https://pkg.pr.new/webdriverio/webdriverio/@wdio/mocha-framework@13870

@wdio/protocols

pnpm add https://pkg.pr.new/webdriverio/webdriverio/@wdio/protocols@13870

@wdio/repl

pnpm add https://pkg.pr.new/webdriverio/webdriverio/@wdio/repl@13870

@wdio/reporter

pnpm add https://pkg.pr.new/webdriverio/webdriverio/@wdio/reporter@13870

@wdio/runner

pnpm add https://pkg.pr.new/webdriverio/webdriverio/@wdio/runner@13870

@wdio/sauce-service

pnpm add https://pkg.pr.new/webdriverio/webdriverio/@wdio/sauce-service@13870

@wdio/shared-store-service

pnpm add https://pkg.pr.new/webdriverio/webdriverio/@wdio/shared-store-service@13870

@wdio/smoke-test-cjs-service

pnpm add https://pkg.pr.new/webdriverio/webdriverio/@wdio/smoke-test-cjs-service@13870

@wdio/smoke-test-reporter

pnpm add https://pkg.pr.new/webdriverio/webdriverio/@wdio/smoke-test-reporter@13870

@wdio/smoke-test-service

pnpm add https://pkg.pr.new/webdriverio/webdriverio/@wdio/smoke-test-service@13870

@wdio/spec-reporter

pnpm add https://pkg.pr.new/webdriverio/webdriverio/@wdio/spec-reporter@13870

@wdio/static-server-service

pnpm add https://pkg.pr.new/webdriverio/webdriverio/@wdio/static-server-service@13870

@wdio/sumologic-reporter

pnpm add https://pkg.pr.new/webdriverio/webdriverio/@wdio/sumologic-reporter@13870

@wdio/testingbot-service

pnpm add https://pkg.pr.new/webdriverio/webdriverio/@wdio/testingbot-service@13870

@wdio/types

pnpm add https://pkg.pr.new/webdriverio/webdriverio/@wdio/types@13870

@wdio/utils

pnpm add https://pkg.pr.new/webdriverio/webdriverio/@wdio/utils@13870

@wdio/webdriver-mock-service

pnpm add https://pkg.pr.new/webdriverio/webdriverio/@wdio/webdriver-mock-service@13870

webdriver

pnpm add https://pkg.pr.new/webdriverio/webdriverio/webdriver@13870

webdriverio

pnpm add https://pkg.pr.new/webdriverio/webdriverio@13870

commit: 3cf3653

- fix tests

wswebcreation · 2024-11-10T16:45:15Z

Hmm, getting the following error when I try to test the command

Can't call scrollIntoView on element with selector "//android.widget.TextView[@resource-id="android:id/title" and @text="System"]" because element wasn't found

For native the elements are not always available as with web. I might have found a hack I'm not proud of. The implicitWait excludes checking for the *waitUntil* methods. If I just "hack" the scrollIntoView into it, it works, it will not find the element, it will scroll and check if it exists, if not, it will scroll, and so on.
This is a "hacky" solution, so I would love to get some input/look into a specific direction to make this more stable. I'm open to suggestions 😅

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

christian-bromann · 2024-11-11T16:48:30Z

If I just "hack" the scrollIntoView into it, it works, it will not find the element, it will scroll and check if it exists, if not, it will scroll, and so on.

It seem fine to me if we extend the if statement with scrollIntoView if we are in a mobile and native context, e.g.

const browser = getBrowserObject(currentElement)
const shallSkipForMobileScrollIntoView = browser.isMobile && (await browser.getContext === 'NATIVE')

Co-authored-by: Christian Bromann <git@bromann.dev>

wswebcreation · 2024-11-11T17:02:47Z

If I just "hack" the scrollIntoView into it, it works, it will not find the element, it will scroll and check if it exists, if not, it will scroll, and so on.

It seem fine to me if we extend the if statement with scrollIntoView if we are in a mobile and native context, e.g.
const browser = getBrowserObject(currentElement)
const shallSkipForMobileScrollIntoView = browser.isMobile && (await browser.getContext === 'NATIVE')

Thanks, that's a solution. If we have the isNativeContext we could even determine better. There's only one downside, and that is that will always do an extra webdriver call for mobile, no matter if it's web or native app

- changed code order - updated error messages - fixed UTs

christian-bromann · 2024-11-11T17:18:42Z

There's only one downside, and that is that will always do an extra webdriver call for mobile, no matter if it's web or native app

How about enhancing the context manager the way we discussed so the extra call is obsolete?

wswebcreation · 2024-11-11T17:41:44Z

There's only one downside, and that is that will always do an extra webdriver call for mobile, no matter if it's web or native app

How about enhancing the context manager the way we discussed so the extra call is obsolete?

That's also what I wanted to do, but in a separate PR which would "revert" the extra call. I wanted to create "smaller" PRs because I don't have a lot of time the coming weeks

wswebcreation · 2024-11-11T19:40:19Z

@christian-bromann

~~Not sure why other UTs are failing, I can't see any impact due to my changes (to the fetch Mock). Any ideas?~~

Fixed it

- due to the extra getContext call in mobile mode a lot of UT's failed

christian-bromann

LGTM 👍

* feat: enhance scrollIntoView to support native mobile Initial setup to support Native apps * test: Add unit tests * fix: fix types * chore: add the docs and fix types * fix: make use of $$ from the browser - fix tests * Update packages/webdriverio/src/commands/element/scrollIntoView.ts Co-authored-by: Christian Bromann <git@bromann.dev> * chore: updates after feedback - changed code order - updated error messages - fixed UTs * fix: exclude the scrollIntoView * fix: fix type for scrollIntoView * fix: fix type * fix: type test * test: fix all UTs - due to the extra getContext call in mobile mode a lot of UT's failed --------- Co-authored-by: Christian Bromann <git@bromann.dev>

wswebcreation added 4 commits November 9, 2024 11:44

feat: enhance scrollIntoView to support native mobile

257e237

Initial setup to support Native apps

test: Add unit tests

704726d

Merge branch 'main' into ws/update-scrollintoview-mobile

34b8069

fix: fix types

d63b0c8

chore: add the docs and fix types

d032ec5

wswebcreation requested a review from christian-bromann November 10, 2024 13:23

wswebcreation marked this pull request as ready for review November 10, 2024 13:23

fix: make use of $$ from the browser

f9c0c24

- fix tests

christian-bromann reviewed Nov 11, 2024

View reviewed changes

Update packages/webdriverio/src/commands/element/scrollIntoView.ts

e4976e9

Co-authored-by: Christian Bromann <git@bromann.dev>

wswebcreation added 2 commits November 11, 2024 18:02

Merge branch 'main' into ws/update-scrollintoview-mobile

2e1725c

chore: updates after feedback

6588505

- changed code order - updated error messages - fixed UTs

fix: exclude the scrollIntoView

c8655a0

wswebcreation requested a review from christian-bromann November 11, 2024 19:09

fix: fix type for scrollIntoView

6fa12c3

wswebcreation added 4 commits November 11, 2024 20:44

fix: fix type

e36121d

fix: type test

f07a38a

test: fix all UTs

9e7f5b2

- due to the extra getContext call in mobile mode a lot of UT's failed

Merge branch 'main' into ws/update-scrollintoview-mobile

3cf3653

christian-bromann approved these changes Nov 13, 2024

View reviewed changes

christian-bromann added the PR: New Feature 🚀 PRs that contain new features label Nov 13, 2024

christian-bromann merged commit 21b53fd into main Nov 13, 2024

christian-bromann deleted the ws/update-scrollintoview-mobile branch November 13, 2024 16:17

christian-bromann mentioned this pull request Nov 21, 2024

Make scrollIntoView possible for mobile #6537

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat: enhance scrollIntoView to support native mobile#13870

feat: enhance scrollIntoView to support native mobile#13870
christian-bromann merged 15 commits intomainfrom
ws/update-scrollintoview-mobile

wswebcreation commented Nov 9, 2024 •

edited

Loading

Uh oh!

pkg-pr-new bot commented Nov 10, 2024 •

edited

Loading

Uh oh!

wswebcreation commented Nov 10, 2024

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

christian-bromann commented Nov 11, 2024

Uh oh!

wswebcreation commented Nov 11, 2024

Uh oh!

christian-bromann commented Nov 11, 2024

Uh oh!

wswebcreation commented Nov 11, 2024

Uh oh!

wswebcreation commented Nov 11, 2024 •

edited

Loading

Uh oh!

christian-bromann left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Conversation

wswebcreation commented Nov 9, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Proposed changes

Types of changes

Checklist

Backport Request

Further comments

Reviewers: @webdriverio/project-committers

Uh oh!

pkg-pr-new bot commented Nov 10, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

wswebcreation commented Nov 10, 2024

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

christian-bromann commented Nov 11, 2024

Uh oh!

wswebcreation commented Nov 11, 2024

Uh oh!

christian-bromann commented Nov 11, 2024

Uh oh!

wswebcreation commented Nov 11, 2024

Uh oh!

wswebcreation commented Nov 11, 2024 • 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!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

wswebcreation commented Nov 9, 2024 •

edited

Loading

pkg-pr-new bot commented Nov 10, 2024 •

edited

Loading

wswebcreation commented Nov 11, 2024 •

edited

Loading