Upgrade webdriverio to 6.1.20 #631

alexandramedway · 2020-06-23T16:40:42Z

What is this

WebdriverIO 5 was released in 2018:
https://webdriver.io/blog/2018/12/19/webdriverio-v5-released.html

WebdriverIO 6 was released in March 2020:
https://webdriver.io/blog/2020/03/26/webdriverio-v6-released.html

They have a lot of nice new features / better API, and it would be really nice if spectron supported this version! A few other things we would like to do with webdriverIO:

Video reporting support: https://webdriver.io/docs/wdio-video-reporter.html
Simplify API for reading elements from page / interacting with them
...and more! Please see the link above for more details on the changes

In this PR, we update webdriverio to be 6.1.20 and then fixed every issue that came up as a result of that!

Details

Breaking changes from webdriverIO 4 --> 5:
https://github.com/webdriverio/webdriverio/blob/v5/CHANGELOG.md

Breaking changes from webdriverIO 5 --> 6
https://github.com/webdriverio/webdriverio/blob/master/CHANGELOG.md

Test

Tested with the unit tests that are already in spectron
tslint & tsc
travis

christian-bromann · 2020-06-23T16:50:46Z

So good to see Spectron updating WebdriverIO, thanks @alexandramedway. As an FYI: upgrading to v6 should not require much changes as we just dropped the Node v8 support as well as changed some command interfaces. If I can help with anything please let me know 😉

alexandramedway · 2020-06-23T17:07:38Z

@christian-bromann Thank you so much for your help! I initially tried to update to v6 and ran into a few issues, so started with v5 - would love to get in touch so that I can continue on with v6 :) What is the best way to reach you?

christian-bromann · 2020-06-23T17:12:57Z

What is the best way to reach you?

I do WebdriverIO office hours every Wednesday if you want to jump on call directly. Otherwise just email me via christian[at]saucelabs.com

alexandramedway · 2020-06-23T17:20:54Z

Just signed up - really appreciate you taking the time!

codebytere · 2020-06-23T17:33:25Z

@alexandramedway hey thanks for this! I'll try to get it reviewed as soon as i can 🙇🏻‍♀️

alexandramedway · 2020-06-23T17:41:45Z

@codebytere thank you very much! I am struggling with a couple tests on CI that are not failing locally - would appreciate any advice into how to debug these!

edit: These are resolved now!

alexandramedway · 2020-06-24T19:53:12Z

Big thanks to @christian-bromann for your help getting from v5 to v6!!

christian-bromann

I think there is a lot of opportunity in the code to optimise especially replacing all the .then calls with async/await. But that should be done in other PRs.

Without knowing the internals of the Spectron that much this looks good to me. I added some suggestions.

lib/api.js

christian-bromann · 2020-06-24T21:37:23Z

lib/application.js

+  return self
+    .exists()
+    .then(function () {
+      return self.startChromeDriver()
+    })
+    .then(function () {
+      return self.createClient()
+    })
+    .then(function () {
+      return self.api.initialize()
+    })
+    .then(function () {
+      return self.client.setTimeouts(
+        self.waitTimeout,
+        self.waitTimeout,
+        self.waitTimeout
+      )
+    })
+    .then(function () {
+      self.running = true
+    })
+    .then(function () {
+      return self
+    })


instead of using self we could just use short functions:

Suggested change

return self

.exists()

.then(function () {

return self.startChromeDriver()

})

.then(function () {

return self.createClient()

})

.then(function () {

return self.api.initialize()

})

.then(function () {

return self.client.setTimeouts(

self.waitTimeout,

self.waitTimeout,

self.waitTimeout

)

})

.then(function () {

self.running = true

})

.then(function () {

return self

})

return this

.exists()

.then(() => this.startChromeDriver())

.then(() => this.createClient())

.then(() => this.api.initialize())

.then(() => this.client.setTimeouts(this.waitTimeout, this.waitTimeout, this.waitTimeout))

.then(() => {

this.running = true

})

.then(() => this)

package.json

christian-bromann · 2020-06-24T21:44:56Z

Again, thank you @alexandramedway for pushing this forward 👏 !

jkleinsc

First of all, thanks @alexandramedway for submitting this PR! Also thanks @christian-bromann for pitching in! Overall this looks good to me, I just have some nits that I commented on. In reviewing this PR, I realize that we should have js linting and prettier setup on this project and most of my nits would be resolved by that. I'm not asking that you add that to this PR, just a comment. Once we get this merged in, I'll followup with a PR to add linting and prettier.

lib/application.js

jkleinsc · 2020-06-25T13:46:24Z

test/accessibility-test.js

+    it('resolves to an audit object with the results', async function () {
+      await app.client.waitUntilWindowLoaded()
+      await app.client.windowByIndex(0)
+      var audit = await app.client.auditAccessibility()


Use const instead of var here

Suggested change

var audit = await app.client.auditAccessibility()

const audit = await app.client.auditAccessibility()

We actually need const as we reassign it below!

jkleinsc · 2020-06-25T13:46:52Z

test/accessibility-test.js

-          expect(audit.results).to.have.length(1)
+    it('ignores warnings when ignoreWarnings is specified', async function () {
+      await app.client.waitUntilWindowLoaded()
+      var audit = await app.client.auditAccessibility({ ignoreWarnings: true })


Use const instead of var here

Suggested change

var audit = await app.client.auditAccessibility({ ignoreWarnings: true })

const audit = await app.client.auditAccessibility({ ignoreWarnings: true })

jkleinsc · 2020-06-25T13:47:12Z

test/accessibility-test.js

+
+    it('ignores rules when ignoreRules is specified', async function () {
+      await app.client.waitUntilWindowLoaded()
+      var audit = await app.client.auditAccessibility({


Use const instead of var here

Suggested change

var audit = await app.client.auditAccessibility({

const audit = await app.client.auditAccessibility({

test/example-test.js

jkleinsc · 2020-06-25T13:52:43Z

test/no-node-integration-test.js

+    var elem = await app.client.$('body')
+    var text = await elem.getText()


Suggested change

var elem = await app.client.$('body')

var text = await elem.getText()

const elem = await app.client.$('body')

const text = await elem.getText()

jkleinsc · 2020-06-25T13:52:57Z

test/require-name-test.js

+    app.webContents.getTitle().should.eventually.equal('require name')
+    const emptyArgs = await app.electron.remote.process.execArgv()
+    const elem = await app.client.$('body')
+    var text = await elem.getText()


Suggested change

var text = await elem.getText()

const text = await elem.getText()

jkleinsc · 2020-06-25T13:53:06Z

test/slow-page-test.js

@@ -1,5 +1,6 @@
 var helpers = require('./global-setup')
 var path = require('path')
+var expect = require('chai').expect


Suggested change

var expect = require('chai').expect

const expect = require('chai').expect

test/web-view-test.js

alexandramedway · 2020-06-25T14:45:22Z

In reviewing this PR, I realize that we should have js linting and prettier setup on this project

I totally agree! My editor is actually set up to auto format which is why some changes slipped in which didn't actually update the code, only the formatting (tried to revert most of those though).

Would be awesome to go through this project, convert all var to const or let, etc (but like you mentioned, not in the scope of this PR as that would be huge and hard to review all the changes at once).

Looking forward to that update - will make future changes much easier!

codebytere

thanks for this! others already made most of my review points & this looks good now 🚀

alexandramedway · 2020-06-26T14:31:01Z

Thank you for approving @codebytere - looks like I need 'write access' in order to merge this, would you be able to give it to me so that I can get these changes in? 😄 Or feel free to merge yourself!

segersb · 2020-07-07T18:35:39Z

This is just what I needed! @codebytere do you know when master can be released?

jkleinsc · 2020-07-07T19:34:00Z

@segersb I just released v11.1.0 which has this update.

vladimiry · 2020-07-08T21:48:53Z

I just released v11.1.0 which has this update.

I wish that would be v12 / major release as in many cases the update will break things unless you updated the tests following the webdriver's breaking changes guide.

jkleinsc · 2020-07-08T23:35:45Z

@vladimiry I agree but Spectron has this weird version mapping to Electron: https://github.com/electron-userland/spectron#version-map. I guess we could have waited until Electron 10 to release this but I thought maybe folks would want to use this before then.

vladimiry · 2020-07-09T03:58:58Z

I thought maybe folks would want to use this before then.

Don't know about folks, but I do 👍 Big thanks to @alexandramedway.

Summary: allow-large-files Bumps [spectron](https://github.com/electron/spectron) from 11.0.0 to 14.0.0. <details> <summary>Release notes</summary> <p><em>Sourced from <a href="https://github.com/electron/spectron/releases">spectron's releases</a>.</em></p> <blockquote> <h2>v13.0.0</h2> <p>No release notes provided.</p> <h2>v12.0.0</h2> <p>No release notes provided.</p> <h2>v11.1.0</h2> <p>Upgraded webdriverio to 6.1.20 <a href="https://github.com/electron/spectron/issues/631">https://github.com/facebook/flipper/issues/631</a></p> </blockquote> </details> <details> <summary>Commits</summary> <ul> <li>See full diff in <a href="https://github.com/electron/spectron/commits">compare view</a></li> </ul> </details> <br /> [![Dependabot compatibility score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=spectron&package-manager=npm_and_yarn&previous-version=11.0.0&new-version=14.0.0)](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores) Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `dependabot rebase`. [//]: # (dependabot-automerge-start) [//]: # (dependabot-automerge-end) --- <details> <summary>Dependabot commands and options</summary> <br /> You can trigger Dependabot actions by commenting on this PR: - `dependabot rebase` will rebase this PR - `dependabot recreate` will recreate this PR, overwriting any edits that have been made to it - `dependabot merge` will merge this PR after your CI passes on it - `dependabot squash and merge` will squash and merge this PR after your CI passes on it - `dependabot cancel merge` will cancel a previously requested merge and block automerging - `dependabot reopen` will reopen this PR if it is closed - `dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually - `dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself) - `dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself) - `dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself) </details> Pull Request resolved: #2071 Test Plan: Imported from GitHub, without a `Test Plan:` line. yarn test-e2e Test Suite Succeded after running yarn test-e2e Reviewed By: passy Differential Revision: D27230110 Pulled By: priteshrnandgaonkar fbshipit-source-id: d6d2d6c1482fa563b9dde9472467f918496e2cea

Upgrade webdriverio to 5.23.0

db53142

alexandramedway mentioned this pull request Jun 23, 2020

WebdriverIO v5 #349

Open

travis

ef22f85

final fixes

9d9f9d0

fighting with travis

46b5a39

codebytere self-requested a review June 23, 2020 17:33

alexandramedway added 6 commits June 23, 2020 13:53

travis again

d6bc2d1

restart test runner

82d84a7

typo

986277a

fix test

c74f024

Update to v6

2647078

v6.1.20

f488a48

alexandramedway changed the title ~~Upgrade webdriverio to 5.23.0~~ Upgrade webdriverio to 6.1.20 Jun 24, 2020

alexandramedway added 2 commits June 24, 2020 15:59

tweak

78d3288

revert last change

4dda27c

christian-bromann reviewed Jun 24, 2020

View reviewed changes

jkleinsc reviewed Jun 25, 2020

View reviewed changes

alexandramedway added 4 commits June 25, 2020 11:22

var --> const/let

e32f295

formatting

2169b4e

yarn standard --fix

df76d93

revert paste changes`

379faf3

alexandramedway added 2 commits June 25, 2020 14:14

revert some more changes, tests failing

896c75e

standard --fix

6ee1108

codebytere approved these changes Jun 25, 2020

View reviewed changes

codebytere merged commit 9fdb353 into electron-userland:master Jun 29, 2020

mtgto mentioned this pull request Jul 4, 2020

feat: Use ES6 syntax (class, const/let, arrow functions) #551

Closed

jameskerr mentioned this pull request Jul 27, 2020

Update Electron to Version 9 brimdata/zui#952

Closed

philrz mentioned this pull request Sep 11, 2020

Electron upgrade brimdata/zui#1044

Closed

chinenual mentioned this pull request Mar 5, 2021

Spectron 13: waitUntilWindowLoaded is not a function #887

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Upgrade webdriverio to 6.1.20 #631

Upgrade webdriverio to 6.1.20 #631

alexandramedway commented Jun 23, 2020 •

edited

Loading

christian-bromann commented Jun 23, 2020

alexandramedway commented Jun 23, 2020

christian-bromann commented Jun 23, 2020

alexandramedway commented Jun 23, 2020

codebytere commented Jun 23, 2020

alexandramedway commented Jun 23, 2020 •

edited

Loading

alexandramedway commented Jun 24, 2020

christian-bromann left a comment

christian-bromann Jun 24, 2020

christian-bromann commented Jun 24, 2020

jkleinsc left a comment

jkleinsc Jun 25, 2020

alexandramedway Jun 25, 2020

jkleinsc Jun 25, 2020

jkleinsc Jun 25, 2020

jkleinsc Jun 25, 2020

jkleinsc Jun 25, 2020

jkleinsc Jun 25, 2020

alexandramedway commented Jun 25, 2020

codebytere left a comment

alexandramedway commented Jun 26, 2020 •

edited

Loading

segersb commented Jul 7, 2020

jkleinsc commented Jul 7, 2020

vladimiry commented Jul 8, 2020

jkleinsc commented Jul 8, 2020

vladimiry commented Jul 9, 2020

	var audit = await app.client.auditAccessibility()
	const audit = await app.client.auditAccessibility()

		var elem = await app.client.$('body')
		var text = await elem.getText()

	var text = await elem.getText()
	const text = await elem.getText()

	var expect = require('chai').expect
	const expect = require('chai').expect

Upgrade webdriverio to 6.1.20 #631

Upgrade webdriverio to 6.1.20 #631

Conversation

alexandramedway commented Jun 23, 2020 • edited Loading

What is this

Details

Test

christian-bromann commented Jun 23, 2020

alexandramedway commented Jun 23, 2020

christian-bromann commented Jun 23, 2020

alexandramedway commented Jun 23, 2020

codebytere commented Jun 23, 2020

alexandramedway commented Jun 23, 2020 • edited Loading

alexandramedway commented Jun 24, 2020

christian-bromann left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

christian-bromann commented Jun 24, 2020

jkleinsc left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

alexandramedway commented Jun 25, 2020

codebytere left a comment

Choose a reason for hiding this comment

alexandramedway commented Jun 26, 2020 • edited Loading

segersb commented Jul 7, 2020

jkleinsc commented Jul 7, 2020

vladimiry commented Jul 8, 2020

jkleinsc commented Jul 8, 2020

vladimiry commented Jul 9, 2020

alexandramedway commented Jun 23, 2020 •

edited

Loading

alexandramedway commented Jun 23, 2020 •

edited

Loading

alexandramedway commented Jun 26, 2020 •

edited

Loading