Page MenuHomePhabricator
Create Task
Maniphest T358652

Investigate unit test coverage of Cite visual editor JS
Closed, ResolvedPublic
Actions

Description

Aim: Make sure that we have a good unit/integration (e.g. QUnit) test coverage of the JS code in the VisualEditor Cite code

Tasks:
In Visual Editor & Cite extensions:

  • Determine what the latest method of JS code coverage is across active MediaWiki extensions. "nyc"?
  • Analyze existing test coverage of the JS code
  • Check if test coverage reports are generated
  • If missing test cases are identified, create subtask for parent ticket for creation of new unit tests

Details

SubjectRepoBranchLines +/-
Add initial QUnit tests relevant for reference re-use in VEmediawiki/extensions/Citemaster+289 -4
Add basic PHPUnit tests for Parsoid implementationmediawiki/extensions/Citemaster+210 -0
Customize query in gerrit

Related Objects
Search...

Event Timeline

MareikeHeuerWMDE created this task.Feb 28 2024, 11:06 AM
WMDE-Fisch edited projects, added WMDE-TechWish-Sprint-2024-02-28; removed WMDE-TechWish-Sprint-2024-02-15.Feb 28 2024, 12:44 PM
awight renamed this task from Investigate test coverage of the JS code in the VisualEditor Cite code to Investigate unit test coverage of Cite visual editor JS.Feb 28 2024, 12:48 PM
awight updated the task description. (Show Details)
thiemowmde claimed this task.Mar 7 2024, 8:51 AM
thiemowmde added a project: Test-Coverage.
thiemowmde moved this task from Sprint Backlog to Doing on the WMDE-TechWish-Sprint-2024-02-28 board.
thiemowmde added subscribers: thiemowmde, awight.
gerritbot added a comment.Mar 11 2024, 12:37 PM

Change 1010183 had a related patch set uploaded (by Thiemo Kreuz (WMDE); author: Thiemo Kreuz (WMDE)):

[mediawiki/extensions/Cite@master] [WIP] Add QUnit tests for all .js classes in ve-cite

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

gerritbot added a project: Patch-For-Review.Mar 11 2024, 12:37 PM
gerritbot added a comment.Mar 12 2024, 9:06 AM

Change 1008454 had a related patch set uploaded (by Thiemo Kreuz (WMDE); author: Thiemo Kreuz (WMDE)):

[mediawiki/extensions/Cite@master] Add basic PHPUnit tests for Parsoid implementation

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

Tobi_WMDE_SW added a project: WMDE-TechWish-Sprint-2024-03-13.Mar 13 2024, 2:04 PM
Tobi_WMDE_SW moved this task from Sprint Backlog to Doing on the WMDE-TechWish-Sprint-2024-03-13 board.
gerritbot added a comment.Mar 13 2024, 2:59 PM

Change 1008454 merged by jenkins-bot:

[mediawiki/extensions/Cite@master] Add basic PHPUnit tests for Parsoid implementation

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

ReleaseTaggerBot added a project: MW-1.42-notes (1.42.0-wmf.23; 2024-03-19).Mar 13 2024, 7:01 PM
thiemowmde moved this task from Incoming to In progress on the WMDE-References-FocusArea board.Mar 15 2024, 10:10 AM
thiemowmde moved this task from Doing to Tech Review on the WMDE-TechWish-Sprint-2024-03-13 board.Mar 15 2024, 1:24 PM
gerritbot added a comment.Mar 22 2024, 10:49 AM

Change #1010183 merged by jenkins-bot:

[mediawiki/extensions/Cite@master] Add initial QUnit tests relevant for reference re-use in VE

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

ReleaseTaggerBot edited projects, added MW-1.42-notes (1.42.0-wmf.24; 2024-03-26); removed MW-1.42-notes (1.42.0-wmf.23; 2024-03-19).Mar 22 2024, 11:00 AM
Maintenance_bot removed a project: Patch-For-Review.Mar 22 2024, 11:30 AM
WMDE-Fisch added a project: WMDE-TechWish-Sprint-2024-03-27.Mar 27 2024, 1:22 PM
WMDE-Fisch moved this task from Sprint Backlog to Tech Review on the WMDE-TechWish-Sprint-2024-03-27 board.
thiemowmde added a comment.Apr 2 2024, 9:25 AM

Overview of my findings:

  • Test coverage for Cite's VisualEditor integration is effectively non-existent, neither via unit nor browser tests.
  • A good amount of code is more wiring/glue than anything. E.g. …Action, …Command, or …ContextItem classes. This it naturally hard to test individually, but that's fine. The files barely contain any code anyway. They are sufficiently covered by browser tests that rely on the features.
  • …Node and …Model classes sound like they are leaf nodes in the general tree of VE data structures, but unfortunately aren't. ve.ce.…Node classes bind against …Model classes. …Model classes bind against the entire Document.
    • The two ve.dm.…Node classes are the best candidates for individual coverage. We already found bugs in them, see T359943.
  • The following features are also worth being covered individually, in my opinion:
    • The re-use dialog builds an internal search index that contains all visible and some invisible information about each ref. Tests should make sure that e.g. the index is updated when references are edited.
    • Reusing an unnamed ref auto-generates a name like :0. We should e.g. test when this happens (immediately, i.e. the :0 becomes visible during the session, or only after save?).
    • There are a few …Widget classes. These are great candidates for unit tests. Naturally widgets should have no coupling whatsoever.
thiemowmde moved this task from Tech Review to Done on the WMDE-TechWish-Sprint-2024-03-27 board.Apr 2 2024, 5:54 PM
WMDE-Fisch closed this task as Resolved.Apr 12 2024, 9:12 AM
Content licensed under Creative Commons Attribution-ShareAlike (CC BY-SA) 4.0 unless otherwise noted; code licensed under GNU General Public License (GPL) 2.0 or later and other open source licenses. By using this site, you agree to the Terms of Use, Privacy Policy, and Code of Conduct. · Wikimedia Foundation · Privacy Policy · Code of Conduct · Terms of Use · Disclaimer · CC-BY-SA · GPL · Credits