Make WebdriverIO to support native app testing on Windows with WinAppDriver #4369

licanhua · 2019-08-15T19:20:57Z

Proposed changes

WinAppDriver is a service to support Selenium-like UI Test Automation on Windows Applications.
For some message like click, the return message is {"sessionId":"19C1CE26-1887-4DA1-AD04-521307B5445C","status":0} which doesn't include value. then WebDriverIO consider it as failed message and will retry.
This pullrequest try to consider value is optional when status=0 to workaround WinAppDriver problem.

Types of changes

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)

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 necessary documentation (if appropriate)

Further comments

Reviewers: @webdriverio/technical-committee

A workaround for WinAppDriver. For some messages, WinAppDriver doesn't return value when status is 0.

jsf-clabot · 2019-08-15T19:20:58Z

All committers have signed the CLA.

codecov · 2019-08-15T20:09:58Z

Codecov Report

Merging #4369 into master will increase coverage by <.01%.
The diff coverage is 100%.

@@            Coverage Diff             @@
##           master    #4369      +/-   ##
==========================================
+ Coverage   99.32%   99.32%   +<.01%     
==========================================
  Files         180      180              
  Lines        4414     4415       +1     
  Branches      950      951       +1     
==========================================
+ Hits         4384     4385       +1     
  Misses         27       27              
  Partials        3        3

Impacted Files	Coverage Δ
packages/webdriver/src/utils.js	`100% <100%> (ø)`	⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update ccb4fb5...c5ac4c8. Read the comment docs.

mgrybyk

Got some thoughts on it.
Can it break somehow something else? When status is 0 for other drivers except of WinApp?

mgrybyk · 2019-08-15T20:36:39Z

packages/webdriver/src/utils.js

@@ -22,8 +22,14 @@ export function isSuccessfulResponse (statusCode, body) {
     * response contains a body
     */
    if (!body || typeof body.value === 'undefined') {


I think overall condition can be improved to avoid nested conditions

I thought about that, and my first local copy is in one line.
splitting it to nested condition would make easy to read. Otherwise I have to write test case on it to provide more context.

licanhua · 2019-08-15T23:42:39Z

Got some thoughts on it.
Can it break somehow something else? When status is 0 for other drivers except of WinApp?

I have no knowledge about other drivers.

christian-bromann

We already had similar attempts to hotpatch WinAppDrivers incompatibility with the W3C protocol:

#3809
#4105

Also this time I will disagree with such a patch given that the fix should be applied there.

christian-bromann · 2019-08-15T23:58:05Z

packages/webdriver/src/utils.js

@@ -22,8 +22,14 @@ export function isSuccessfulResponse (statusCode, body) {
     * response contains a body
     */
    if (!body || typeof body.value === 'undefined') {
-        log.debug('request failed due to missing body')
-        return false
+        if (body && body.status === 0) {


if (body

This will be always be true given that the parent if clause starts with

if (!body

christian-bromann · 2019-08-16T00:01:28Z

packages/webdriver/src/utils.js

-        return false
+        if (body && body.status === 0) {
+            /**
+            * A workaround for WinAppDriver. For some messages, WinAppDriver doesn't return value when status is 0.


This should be fixed in WinAppDriver then. WebdriverIO follows the W3C standard and so should the driver.

christian-bromann · 2019-08-30T10:08:13Z

Will close this as the issue should rather be fixed in WinAppDriver to follow the protocol rather than here.

licanhua · 2019-08-30T15:20:57Z

For people who have the same problem, you can workaround the problem by customized webdriver.
I already create pull request to WinAppDriver, but we don't have ETA for the final release date. Please check if WinAppDriver there is a new release, this problem may be fixed.

    "webdriverio": "^5.10.1",
    "webdriver": "git+https://github.com/react-native-windows/webdriver.git",

christian-bromann · 2023-02-14T17:52:26Z

For people who have the same problem, you can workaround the problem by customized webdriver.

I do not recommend using this custom webdriver build as it us more than 3 years old and not compatible with any recent WebdriverIO setup.

licanhua and others added 2 commits August 15, 2019 11:56

Support native app testing on windows

2b40f4a

A workaround for WinAppDriver. For some messages, WinAppDriver doesn't return value when status is 0.

Fix the wrong check

290082f

fix eslint error

c5ac4c8

mgrybyk requested changes Aug 15, 2019

View reviewed changes

christian-bromann requested changes Aug 16, 2019

View reviewed changes

This was referenced Aug 22, 2019

Support e2e test - webdriverio microsoft/react-native-windows#2975

Merged

Use forked WebDriverIO or newer version of WinAppDriver for E2E testing microsoft/react-native-windows#3019

Closed

christian-bromann closed this Aug 30, 2019

hassanuz mentioned this pull request Aug 30, 2019

WebDriver IO Compatibility Fix microsoft/WinAppDriver#840

Open

licanhua mentioned this pull request Dec 2, 2019

WinAppDriver W3C Compliant microsoft/WinAppDriver#988

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Make WebdriverIO to support native app testing on Windows with WinAppDriver #4369

Make WebdriverIO to support native app testing on Windows with WinAppDriver #4369

licanhua commented Aug 15, 2019

jsf-clabot commented Aug 15, 2019 •

edited

Loading

codecov bot commented Aug 15, 2019 •

edited

Loading

mgrybyk left a comment

mgrybyk Aug 15, 2019

licanhua Aug 15, 2019

licanhua commented Aug 15, 2019

christian-bromann left a comment

christian-bromann Aug 15, 2019

christian-bromann Aug 16, 2019

christian-bromann commented Aug 30, 2019

licanhua commented Aug 30, 2019 •

edited

Loading

christian-bromann commented Feb 14, 2023

Make WebdriverIO to support native app testing on Windows with WinAppDriver #4369

Make WebdriverIO to support native app testing on Windows with WinAppDriver #4369

Conversation

licanhua commented Aug 15, 2019

Proposed changes

Types of changes

Checklist

Further comments

Reviewers: @webdriverio/technical-committee

jsf-clabot commented Aug 15, 2019 • edited Loading

codecov bot commented Aug 15, 2019 • edited Loading

Codecov Report

mgrybyk left a comment

Choose a reason for hiding this comment

mgrybyk Aug 15, 2019

Choose a reason for hiding this comment

licanhua Aug 15, 2019

Choose a reason for hiding this comment

licanhua commented Aug 15, 2019

christian-bromann left a comment

Choose a reason for hiding this comment

christian-bromann Aug 15, 2019

Choose a reason for hiding this comment

christian-bromann Aug 16, 2019

Choose a reason for hiding this comment

christian-bromann commented Aug 30, 2019

licanhua commented Aug 30, 2019 • edited Loading

christian-bromann commented Feb 14, 2023

jsf-clabot commented Aug 15, 2019 •

edited

Loading

codecov bot commented Aug 15, 2019 •

edited

Loading

licanhua commented Aug 30, 2019 •

edited

Loading