Refactor wdio-mediawiki from sync to async mode
Open, Needs TriagePublic
Actions

Assigned To

None

Authored By

	WMDE-Fisch
	May 25 2023, 9:30 AM

Description

I came across a major blocker when dealing with upgrading some of the browser tests to async mode. In Two-Column-Edit-Conflict-Merge we're using waitForModuleState from the wdio-mediawiki's Util.js. In the browser tests of the Two-Column-Edit-Conflict-Merge extension we need to make sure that loading of the modules is finished before the test continues.

This did not work with the current way waitForModuleState method is implemented since it seems to be incompatible when using async mode.

As a workaround and proof of concept I added a minor fork of the Util.js to the extensions test suite, where I added async support. At least that fix should go upstream into a new wdio-mediawiki release.

See the patch where I got these insights from: https://gerrit.wikimedia.org/r/c/mediawiki/extensions/TwoColConflict/+/906082

Details

Subject	Repo	Branch	Lines +/-
bridge: selenium: await browser.saveScreenshot	mediawiki/extensions/Wikibase	master	+2 -2
selenium: await browser.saveScreenshot	mediawiki/extensions/CirrusSearch	master	+4 -4
wdio-mediawiki: Release 2.3.0	mediawiki/core	master	+10 -1
wdio-mediawiki: await saveScreenshot	mediawiki/core	REL1_40	+4 -4
wdio-mediawiki: await saveScreenshot	mediawiki/core	REL1_39	+4 -4
wdio-mediawiki: await saveScreenshot	mediawiki/core	master	+4 -4
[wdio-mediawiki] Refactor waitForModuleState to async	mediawiki/core	master	+7 -4

Customize query in gerrit

Related Objects
Search...

Status	Assigned	Task
Open	None	T225730 Reduce runtime of MW shared gate Jenkins jobs to 5 min
Open	None	T226869 Run browser tests in parallel
Open	None	T210726 Selenium framework cleanup
Open	None	T344754 Browser tests video capture is shared between tests
Open	None	T324685 Upgrade WebdriverIO to v8 in all repositories
Resolved	None	T314468 Update vite to Version 3
Open	None	T314470 Upgrade all CI jobs for WMF-deployed projects from Node 14 to Node 16
Open	None	T256626 Refactor WebdriverIO tests from sync to async mode
Open	None	T337463 Refactor wdio-mediawiki from sync to async mode

Event Timeline

WMDE-Fisch created this task.May 25 2023, 9:30 AM

WMDE-Fisch mentioned this in T300800: Refactor TwoColConflict WebdriverIO tests from sync to async mode.

Change 923326 had a related patch set uploaded (by WMDE-Fisch; author: WMDE-Fisch):

[mediawiki/core@master] [wdio-mediawiki] Refactor waitForModuleState to async

https://gerrit.wikimedia.org/r/923326

gerritbot added a project: Patch-For-Review.May 25 2023, 11:54 AM

WMDE-Fisch mentioned this in rESCC1205fb9b79ac: selenium: Refactor WebdriverIO tests from sync to async mode.Jun 6 2023, 9:25 AM

Change 923326 merged by jenkins-bot:

[mediawiki/core@master] [wdio-mediawiki] Refactor waitForModuleState to async

https://gerrit.wikimedia.org/r/923326

Maintenance_bot removed a project: Patch-For-Review.Jun 23 2023, 2:30 PM

ReleaseTaggerBot added a project: MW-1.41-notes (1.41.0-wmf.15; 2023-06-27).Jun 23 2023, 3:00 PM

zeljkofilipin added a project: User-zeljkofilipin.Jul 7 2023, 4:39 PM

zeljkofilipin moved this task from Backlog 🪒 to Q1 👔 on the User-zeljkofilipin board.

@WMDE-Fisch the only related commit is merged. Is there something else to do, or can this task be resolved?

zeljkofilipin moved this task from Q1 👔 to Waiting 🏹 on the User-zeljkofilipin board.Jul 19 2023, 11:19 AM

zeljkofilipin mentioned this in T342222: Release a new version of wdio-mediawiki.Jul 19 2023, 11:21 AM

In T337463#9027311, @zeljkofilipin wrote:

@WMDE-Fisch the only related commit is merged. Is there something else to do, or can this task be resolved?

Thanks for the nudge. There are some other parts in the lib that are not converted to async/await yet. But my use case is covered and I'm not sure about the other files. So we could either narrow this ticket down to the Utils part or we keep it open for tracking.

zeljkofilipin moved this task from Waiting 🏹 to Deep work 🌊 on the User-zeljkofilipin board.Jul 19 2023, 12:04 PM

zeljkofilipin moved this task from Deep work 🌊 to Q1 👔 on the User-zeljkofilipin board.Jul 21 2023, 1:01 PM

zeljkofilipin added a project: MediaWiki-Core-Tests.

zeljkofilipin moved this task from Inbox to Selenium on the MediaWiki-Core-Tests board.

Change 951466 had a related patch set uploaded (by WMDE-Fisch; author: Hashar):

[mediawiki/core@master] wdio-mediawiki: await saveScreenshot

https://gerrit.wikimedia.org/r/951466

gerritbot added a project: Patch-For-Review.Aug 25 2023, 7:45 AM

Change 951466 merged by jenkins-bot:

[mediawiki/core@master] wdio-mediawiki: await saveScreenshot

https://gerrit.wikimedia.org/r/951466

Maintenance_bot removed a project: Patch-For-Review.Aug 25 2023, 8:10 AM

Change 952805 had a related patch set uploaded (by Hashar; author: Hashar):

[mediawiki/core@REL1_40] wdio-mediawiki: await saveScreenshot

https://gerrit.wikimedia.org/r/952805

Change 953206 had a related patch set uploaded (by Hashar; author: Hashar):

[mediawiki/core@REL1_39] wdio-mediawiki: await saveScreenshot

https://gerrit.wikimedia.org/r/953206

ReleaseTaggerBot edited projects, added MW-1.41-notes (1.41.0-wmf.25; 2023-09-05); removed MW-1.41-notes (1.41.0-wmf.15; 2023-06-27).Aug 30 2023, 3:01 AM

Change 953206 merged by jenkins-bot:

[mediawiki/core@REL1_39] wdio-mediawiki: await saveScreenshot

https://gerrit.wikimedia.org/r/953206

Change 952805 merged by jenkins-bot:

[mediawiki/core@REL1_40] wdio-mediawiki: await saveScreenshot

https://gerrit.wikimedia.org/r/952805

Maintenance_bot removed a project: Patch-For-Review.Sep 1 2023, 11:30 PM

ReleaseTaggerBot added projects: MW-1.39-notes, MW-1.40-notes.Sep 2 2023, 1:00 AM

I went to fix the browser.saveScreenshot which was not awaited for ( https://gerrit.wikimedia.org/r/q/message:saveScreenshot ).

And I have send a tiny documentation update Upstream https://github.com/webdriverio/webdriverio/pull/11005/files which got merged 🏆 .

zeljkofilipin awarded a token.Sep 7 2023, 10:57 AM

Change 959812 had a related patch set uploaded (by WMDE-Fisch; author: WMDE-Fisch):

[mediawiki/core@master] wdio-mediawiki: Release 2.3.0

https://gerrit.wikimedia.org/r/959812

gerritbot added a project: Patch-For-Review.Sep 21 2023, 5:09 PM

Change 959812 merged by jenkins-bot:

[mediawiki/core@master] wdio-mediawiki: Release 2.3.0

https://gerrit.wikimedia.org/r/959812

I have fixed wdio-mediawiki to await browser.saveScreenshot but through Code Search https://codesearch.wmcloud.org/search/?q=saveScreenshot&files=&excludeFiles=&repos= I found a couple more in CirrusSearch and Wikibase

Change 960039 had a related patch set uploaded (by Hashar; author: Hashar):

[mediawiki/extensions/CirrusSearch@master] selenium: await browser.saveScreenshot

https://gerrit.wikimedia.org/r/960039

Change 960040 had a related patch set uploaded (by Hashar; author: Hashar):

[mediawiki/extensions/Wikibase@master] bridge: selenium: await browser.saveScreenshot

https://gerrit.wikimedia.org/r/960040

Change 960039 merged by jenkins-bot:

[mediawiki/extensions/CirrusSearch@master] selenium: await browser.saveScreenshot

https://gerrit.wikimedia.org/r/960039

ReleaseTaggerBot edited projects, added MW-1.41-notes (1.41.0-wmf.28; 2023-09-26); removed MW-1.41-notes (1.41.0-wmf.25; 2023-09-05).Sep 22 2023, 2:00 PM

Change 960040 merged by jenkins-bot:

[mediawiki/extensions/Wikibase@master] bridge: selenium: await browser.saveScreenshot

https://gerrit.wikimedia.org/r/960040

Michael mentioned this in T314470: Upgrade all CI jobs for WMF-deployed projects from Node 14 to Node 16.Jan 2 2024, 9:02 AM

zeljkofilipin moved this task from Q1 👔 to Backlog 🪒 on the User-zeljkofilipin board.Jan 19 2024, 1:11 PM

zeljkofilipin mentioned this in T256626: Refactor WebdriverIO tests from sync to async mode.May 5 2024, 7:37 AM