Skip to content

feat: enrich Appium context methods#14060

Merged
christian-bromann merged 20 commits intomainfrom
ws/enhance-mobile-context-methods
Jan 24, 2025
Merged

feat: enrich Appium context methods#14060
christian-bromann merged 20 commits intomainfrom
ws/enhance-mobile-context-methods

Conversation

@wswebcreation
Copy link
Member

@wswebcreation wswebcreation commented Jan 11, 2025 •
edited
Loading

Thsi PR will enrich the context methods for Appium so it will be easier to switch to a webview, without knowing all the logic.

It contains:

  • renaming Appium protocol commands
  • add initial setup for enriched commands and make sure the original Appium commands are backwards compatible, meaning nothing would break
  • fix isClickable and fix test
  • fix isNativeContext flag
  • enhance the documentation for the new commands but also for the Mobile API page by explaining more about
    • Why enhance certain mobile commands
    • Hybrid apps

Proposed changes

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

@wswebcreation
feat: enrich Appium context methods
5ef62a5 
- rename appium protocol commands
- add initial setup for enriched commands
- fix isClickable and fix test
@pkg-pr-new
Copy link

pkg-pr-new bot commented Jan 11, 2025 •
edited
Loading

Open in Stackblitz

eslint-plugin-wdio

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

@wdio/allure-reporter

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

@wdio/browser-runner

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

@wdio/browserstack-service

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

@wdio/cli

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

@wdio/appium-service

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

@wdio/concise-reporter

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

@wdio/config

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

@wdio/cucumber-framework

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

@wdio/dot-reporter

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

@wdio/firefox-profile-service

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

@wdio/globals

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

@wdio/jasmine-framework

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

@wdio/json-reporter

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

@wdio/junit-reporter

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

@wdio/lighthouse-service

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

@wdio/local-runner

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

@wdio/logger

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

@wdio/mocha-framework

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

@wdio/protocols

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

@wdio/repl

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

@wdio/reporter

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

@wdio/runner

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

@wdio/sauce-service

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

@wdio/shared-store-service

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

@wdio/smoke-test-cjs-service

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

@wdio/smoke-test-reporter

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

@wdio/smoke-test-service

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

@wdio/spec-reporter

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

@wdio/static-server-service

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

@wdio/sumologic-reporter

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

@wdio/testingbot-service

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

@wdio/types

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

@wdio/utils

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

@wdio/webdriver-mock-service

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

webdriver

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

webdriverio

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

commit: e98aae2

christian-bromann
christian-bromann reviewed Jan 12, 2025
View reviewed changes
Copy link
Member

@christian-bromann christian-bromann left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great stuff! Some comments

@wswebcreation @christian-bromann
Update getContexts.ts
6363091 
Co-authored-by: Christian Bromann <git@bromann.dev>
@wswebcreation
Copy link
Member Author

wswebcreation commented Jan 12, 2025

Great stuff! Some comments

Tnx! And what do you think about the docs for the getContexts? Is it clear/too much/do I miss something?

@wswebcreation
chore: fix UT
36f1214
@wswebcreation
test: increase test coverage for getContexts
4ccad37
@wswebcreation
feat: add info message for using detailed contexts
9e7ab96 
- include UT
@wswebcreation
feat: add more details to the switchContext
889a251 
- fix types
@wswebcreation
chore: update docs for switchContext
26ca973 
- fix small bg
@wswebcreation
test: add switchContext tests
eb896fb 
- update docs
- optimise logging
- fix types
@wswebcreation
feat: enhance the context method
a08b1a2 
- update types
@wswebcreation
chore: update docs
3a87536
@wswebcreation
test: add UT's for getContext
1bb875b
@wswebcreation
Merge branch 'main' into ws/enhance-mobile-context-methods
e1d3a20
@wswebcreation
Merge remote-tracking branch 'origin/main' into ws/enhance-mobile-con…
cd7b92d 
…text-methods
@wswebcreation
fix: fix isNativeContext
9344ce7 
due to refactor the logic broke. It has now also been updated with the renamed appium commands
@wswebcreation
chore: enhance documentation
e98aae2
@wswebcreation wswebcreation marked this pull request as ready for review January 24, 2025 14:29
@christian-bromann christian-bromann added the PR: Polish 💅 PRs that contain improvements on existing features label Jan 24, 2025
christian-bromann
christian-bromann approved these changes Jan 24, 2025
View reviewed changes
Copy link
Member

@christian-bromann christian-bromann left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just amazing 🚀

@christian-bromann christian-bromann merged commit 1fc4684 into main Jan 24, 2025
49 of 50 checks passed
@christian-bromann christian-bromann deleted the ws/enhance-mobile-context-methods branch January 24, 2025 18:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@christian-bromann christian-bromann christian-bromann approved these changes

Assignees

No one assigned

Labels

PR: Polish 💅 PRs that contain improvements on existing features

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@wswebcreation @christian-bromann