Refactor WebdriverIO tests from sync to async mode
Open, Needs TriagePublic
Actions

Description

Status

22/34 (65%)

✅ - work is complete
⚠ - will revisit
🔨 - in progress
🚫 - abandoned (Entity Schema)

Description

MediaWiki Core, it's extensions and skins use WebdriverIO to drive our Selenium testing framework. All tests are written using WebdriverIO sync mode. The sync mode will be deprecated in Node.js v16. We need to move tests in MediaWiki Core, it's extensions and skins from WebdriverIO sync to async mode.

TODO

Revert 896026.
Update documentation.
There should be no instances of @wdio/sync.

Optional

Should all instances of browser.call() be removed?
Should browser.execute (search) be replaced with browser.executeAsync()?
Should fs.writeFileSync() (search) be replaced with fs.writeFile()?

Repositories

Repository	Suites	Tests	Task	Status
mediawiki/core	5	13	T293071	✅
mediawiki/extensions/AbuseFilter	3	24	T300790	✅
mediawiki/extensions/AdvancedSearch	5	41	T300791	⚠
mediawiki/extensions/CampaignEvents				✅
mediawiki/extensions/CentralNotice	1	1	T300212	✅
mediawiki/extensions/CheckUser	2	2	T321904	✅
mediawiki/extensions/CirrusSearch	1	3	T300793
mediawiki/extensions/Cite	1	6	T300196	✅
mediawiki/extensions/CodeMirror	3	5	T300205
mediawiki/extensions/ContactPage	1	1	T334094	✅
mediawiki/extensions/Echo	2	5	T293073	✅
mediawiki/extensions/ElectronPdfService	1	1	T299684	✅
mediawiki/extensions/EntitySchema	5	17	T300794	🚫
mediawiki/extensions/FileImporter	2	1	T300535
mediawiki/extensions/GlobalWatchlist	1	2	T293074	✅
mediawiki/extensions/GrowthExperiments	2	7	T299102	✅
mediawiki/extensions/Math	1	1	T293076	✅
mediawiki/extensions/Newsletter	1	1	T293078	✅
mediawiki/extensions/PageTriage				✅
mediawiki/extensions/Popups	2	7	T293072
mediawiki/extensions/ProofreadPage	1	1	T293079	⚠
mediawiki/extensions/RelatedArticles	1	0	T300797	✅
mediawiki/extensions/RevisionSlider	8	22	T300798	✅
mediawiki/extensions/TemplateWizard	1	3	T300208	✅
mediawiki/extensions/TwoColConflict	7	46	T300800	⚠
mediawiki/extensions/VisualEditor	1	1	T299756	✅
mediawiki/extensions/Wikibase	16	37	T293080	🔨
mediawiki/extensions/WikibaseLexeme	16	48	T293081	🔨
mediawiki/extensions/WikiLambda	1	2	T293082	✅
mediawiki/extensions/Wikistories				✅
mediawiki/skins/MinervaNeue	10	14	T293084	✅
wikibase/termbox	4	25	T300807
wikidata/query/gui	1	0	T300808
wmde/wdio-wikibase	0	0	T300811

(Number of tests estimated with ack --count --files-with-matches ' it\('. See P17460.)

Notes

Sync vs. Async Mode
WebdriverIO Codemod
Sync API Deprecation
RFC Replacement for Node-Fibers
Repositories with Selenium tests: https://www.mediawiki.org/wiki/Selenium/Reference/Example_Code
Project on Outreachy: https://www.outreachy.org/outreachy-december-2021-internship-round/communities/wikimedia/#refactor-mediawiki-tests-to-use-webdriverio-async
A Beginner’s Guide to JavaScript async/await, with Examples

Details

Project	Branch	Lines +/-	Subject
mediawiki/extensions/VisualEditor	master	+2 K -2 K	selenium: Refactor WebdriverIO tests from sync to async mode
integration/config	master	+1 -0	Add Outreachy round 23 applicant to trusted users
mediawiki/core	master	+20 -13	WIP WDIO(async): Make tests in tests/selenium/specialrecentchanges.js async
mediawiki/core	master	+23 -23	WIP WDIO(async): Make tests in tests/selenium/specialwatchlist.js async
mediawiki/core	master	+151 -114	WIP WDIO(async): Make tests in tests/selenium/page.js async
mediawiki/core	master	+58 -40	WIP WDIO(async): Make tests in tests/selenium/specs/user.js async
mediawiki/core	master	+7 -7	WIP WDIO(async): skipping all test suites
mediawiki/core	master	+0 -26	WIP WDIO(async): remove wdio-sync npm package

Customize query in gerrit

Related Objects
Search...

Status	Subtype	Assigned	Task
Open		None	T210726 Selenium framework cleanup
Open		None	T324685 Upgrade WebdriverIO to v8 in all repositories
Stalled		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
Declined		None	T182412 Investigate if WebdriverIO `sync: false` would be useful to us and document how to use it
Resolved		• zeljkofilipin	T292853 Run Selenium tests targeting MediaWiki Core in MediaWiki-Docker
Resolved		Osamaahmed17	T293071 Refactor MediaWiki Core WebdriverIO tests from sync to async mode
Resolved		None	T297950 npm ERR! enoent Invalid response body while trying to fetch https://registry.npmjs.org/ua-parser-js: ENOENT: no such file or directory
Open		None	T293072 Refactor Popups WebdriverIO tests from sync to async mode
Duplicate	BUG REPORT	• zeljkofilipin	T331063 Popups browser tests failing with `08:25:51 node: ../src/coroutine.cc:134: void* find_thread_id_key(void*): Assertion `thread_id_key != 0x7777' failed.`
Resolved		Osamaahmed17	T293073 Refactor Echo WebdriverIO tests from sync to async mode
Resolved		• zeljkofilipin	T293074 Refactor GlobalWatchlist WebdriverIO tests from sync to async mode
Resolved		None	T293076 Refactor Math WebdriverIO tests from sync to async mode
Resolved		None	T293078 Refactor Newsletter WebdriverIO tests from sync to async mode
Open		vaughnwalters	T293079 Refactor ProofreadPage WebdriverIO tests from sync to async mode
Open		vaughnwalters	T293080 Refactor Wikibase WebdriverIO tests from sync to async mode
Open		None	T293081 Refactor WikibaseLexeme WebdriverIO tests from sync to async mode
Resolved		Osamaahmed17	T293082 Refactor WikiLambda WebdriverIO tests from sync to async mode
Resolved		vaughnwalters	T293084 Refactor MinervaNeue WebdriverIO tests from sync to async mode
Resolved		• zeljkofilipin	T293258 Push a commit to Gerrit
Resolved		• zeljkofilipin	T293374 Amend existing commit in Gerrit
Resolved		• zeljkofilipin	T293381 Create a Wikimedia developer account
Resolved		• zeljkofilipin	T293748 Introduce yourself in WebdriverIO topic in Zulip
Resolved		kostajh	T299102 Refactor GrowthExperiments WebdriverIO tests from sync to async mode
Resolved		Osamaahmed17	T299756 Refactor VisualEditor WebdriverIO tests from sync to async mode
Resolved		Osamaahmed17	T299684 Refactor ElectronPdfService WebdriverIO tests from sync to async mode
Open		None	T300808 Refactor GUI WebdriverIO tests from sync to async mode
Resolved		pwangai	T300790 Refactor AbuseFilter WebdriverIO tests from sync to async mode
Open		None	T300791 Refactor AdvancedSearch WebdriverIO tests from sync to async mode
Resolved		Osamaahmed17	T300212 Refactor CentralNotice WebdriverIO tests from sync to async mode
Open		None	T300793 Refactor CirrusSearch WebdriverIO tests from sync to async mode
Resolved		pwangai	T300196 Refactor Cite WebdriverIO tests from sync to async mode
Open		WMDE-Fisch	T300205 Refactor CodeMirror WebdriverIO tests from sync to async mode
Open		pwangai	T300794 Refactor EntitySchema WebdriverIO tests from sync to async mode
Open		None	T300535 Refactor FileImporter WebdriverIO tests from sync to async mode
Invalid		None	T300796 Refactor MobileFrontend WebdriverIO tests from sync to async mode
Resolved		Osamaahmed17	T300797 Refactor RelatedArticles WebdriverIO tests from sync to async mode
Resolved		vaughnwalters	T300798 Refactor RevisionSlider WebdriverIO tests from sync to async mode
Resolved		pwangai	T300208 Refactor TemplateWizard WebdriverIO tests from sync to async mode
Open		WMDE-Fisch	T300800 Refactor TwoColConflict WebdriverIO tests from sync to async mode
Open		None	T300807 Refactor Termbox WebdriverIO tests from sync to async mode
Invalid		None	T300809 Refactor Deploy WebdriverIO tests from sync to async mode
Open		None	T300811 Refactor Wdio-Wikibase WebdriverIO tests from sync to async mode
Resolved		Dreamy_Jazz	T321904 Refactor CheckUser WebdriverIO tests from sync to async mode
Open		None	T337463 Refactor wdio-mediawiki from sync to async mode

Event Timeline

There are a very large number of changes, so older changes are hidden. Show Older Changes

• zeljkofilipin moved this task from In Progress 🎸 to Next 💉 on the User-zeljkofilipin board.Mar 4 2022, 2:28 PM

• zeljkofilipin removed Osamaahmed17 as the assignee of this task.Mar 21 2022, 4:29 PM

• zeljkofilipin mentioned this in T296426: Onboard/offboard Osama Ahmed Tahir.Mar 22 2022, 2:53 PM

• zeljkofilipin mentioned this in Blog Post: Outreachy, December 2021-March 2022.Mar 29 2022, 1:12 PM

• zeljkofilipin moved this task from Next 💉 to Project ♟ on the User-zeljkofilipin board.Apr 29 2022, 12:24 PM

• zeljkofilipin mentioned this in T280331: Switch to spec reporter.May 27 2022, 3:53 PM

• zeljkofilipin mentioned this in T318448: Write selenium tests for CheckUser.Oct 28 2022, 10:15 AM

• zeljkofilipin updated the task description. (Show Details)

Dreamy_Jazz added a subtask: T321904: Refactor CheckUser WebdriverIO tests from sync to async mode.Oct 28 2022, 1:29 PM

Dreamy_Jazz updated the task description. (Show Details)Oct 28 2022, 1:34 PM

• zeljkofilipin changed the status of subtask T293073: Refactor Echo WebdriverIO tests from sync to async mode from In Progress to Open.Nov 8 2022, 3:05 PM

Dreamy_Jazz closed subtask T321904: Refactor CheckUser WebdriverIO tests from sync to async mode as Resolved.Nov 22 2022, 1:43 PM

Lens0021 removed a subscriber: Lens0021.Nov 22 2022, 1:43 PM

WebdriverIO v8 was released yesterday, which drops support for @wdio/sync; v7 is now in “LTS” until October 2023, at which point it (along with the last version of @wdio/sync) will fall out of support entirely.