Page MenuHomePhabricator
Create Task
Maniphest T375902

JavaScript building message boxes should now use mw.util.messageBox
Closed, ResolvedPublic
Actions

Description

Background

The new mw.util.messageBox method provides a stable API for building message boxes instead of resorting to string stitching. Using this API means you do not need to change markup whenever Codex changes its markup. I've identified codebases impacted by this issue.
https://codesearch.wmcloud.org/deployed/?q=mw-message-box%7Ccdx-message&files=.*%5C.js%24&excludeFiles=%28tests%2F.*%7Cmodules%2Fflow%7Cmodules%2Fgraph.sandbox.js%29&repos=

User story

As a developer I don't want to update code markup every time Codex HTML changes.

Requirements

  • Replace code in the form $( '<div>' ).addClass( 'cdx-message cdx-message--block cdx-message--warning' ) with a call to mw.util.messageBox (example)
  • Make sure you are loading the associated Codex styles, with the CdxMessage component

Details

SubjectRepoBranchLines +/-
Use newer messageBox functionmediawiki/extensions/ParserMigrationmaster+9 -9
Use mw.util.messageBoxmediawiki/extensions/CentralNoticemaster+28 -20
Simplify MassMessage warningmediawiki/extensions/MassMessagemaster+8 -10
refactor(SpecialManageMentors): avoid using Codex classesmediawiki/extensions/GrowthExperimentsmaster+6 -16
refactor(ConfirmEmail): avoid using Codex classesmediawiki/extensions/GrowthExperimentsmaster+6 -4
refactor(ConfirmEmail): use mw.util.messageBoxmediawiki/extensions/GrowthExperimentsmaster+3 -9
mediawiki.util: Use appropriate Codex classes and attributes for Messagesmediawiki/coremaster+5 -1
Use Codex markup for warning messagemediawiki/extensions/TwoColConflictmaster+9 -4
Customize query in gerrit

Related Objects
Search...

Event Timeline

Jdlrobson created this task.Sep 27 2024, 4:41 PM
Restricted Application added a project: Growth-Team. · View Herald TranscriptSep 27 2024, 4:41 PM
Restricted Application added a subscriber: Aklapper. · View Herald Transcript
gerritbot added a comment.Sep 27 2024, 4:55 PM

Change #1071968 had a related patch set uploaded (by Jdlrobson; author: Jdlrobson):

[mediawiki/extensions/TwoColConflict@master] Use Codex markup for warning message

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

gerritbot added a project: Patch-For-Review.Sep 27 2024, 4:55 PM
gerritbot added a comment.Sep 27 2024, 4:58 PM

Change #1076233 had a related patch set uploaded (by Jdlrobson; author: Jdlrobson):

[mediawiki/core@master] Messages: Add support for inline messages and default to polite

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

Jdlrobson added a project: Technical-Debt.Sep 27 2024, 5:08 PM
Jdlrobson updated the task description. (Show Details)
gerritbot added a comment.Sep 27 2024, 5:59 PM

Change #1076233 merged by jenkins-bot:

[mediawiki/core@master] mediawiki.util: Use appropriate Codex classes and attributes for Messages

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

ReleaseTaggerBot added a project: MW-1.43-notes (1.43.0-wmf.25; 2024-10-01).Sep 27 2024, 6:00 PM
gerritbot added a comment.Sep 27 2024, 9:14 PM

Change #1071968 merged by jenkins-bot:

[mediawiki/extensions/TwoColConflict@master] Use Codex markup for warning message

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

• Konfused-Kitten mentioned this in rESCC0c87a1ecdb5c: Use Codex markup for warning message.Sep 27 2024, 9:14 PM
Maintenance_bot removed a project: Patch-For-Review.Sep 27 2024, 9:30 PM
Tacsipacsi awarded a token.Sep 28 2024, 6:01 PM
Tacsipacsi subscribed.

Thanks for finally creating this function! I wish it happened during the messagebox→mw-message-box migration, but it’s better late than never.

Tacsipacsi updated the task description. (Show Details)Sep 28 2024, 6:03 PM
Sgs subscribed.Sep 30 2024, 3:57 PM

Some code relies on finding message boxes by class name, eg: ConfirmEmail.js. Is there a non-Codex class that we could use for this? And if not, can we add one?

Sgs moved this task from Inbox to Triaged on the Growth-Team board.Sep 30 2024, 4:11 PM
gerritbot added a comment.Sep 30 2024, 4:14 PM

Change #1076791 had a related patch set uploaded (by Sergio Gimeno; author: Sergio Gimeno):

[mediawiki/extensions/GrowthExperiments@master] refactor(ConfirmEmail): use mw.util.messageBox

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

gerritbot added a project: Patch-For-Review.Sep 30 2024, 4:14 PM
gerritbot added a comment.Oct 4 2024, 9:40 AM

Change #1076791 merged by jenkins-bot:

[mediawiki/extensions/GrowthExperiments@master] refactor(ConfirmEmail): use mw.util.messageBox

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

ReleaseTaggerBot edited projects, added MW-1.43-notes (1.43.0-wmf.26; 2024-10-08); removed MW-1.43-notes (1.43.0-wmf.25; 2024-10-01).Oct 4 2024, 10:00 AM
Maintenance_bot removed a project: Patch-For-Review.Oct 4 2024, 10:30 AM
Jdlrobson removed projects: Growth-Team, GrowthExperiments.Oct 4 2024, 7:31 PM
Jdlrobson added a comment.Oct 4 2024, 7:34 PM
In T375902#10188282, @Sgs wrote:

Some code relies on finding message boxes by class name, eg: ConfirmEmail.js. Is there a non-Codex class that we could use for this? And if not, can we add one?

@Sgs the Html::messageBox class does support the addition of a custom className - so you'd need to add it there (this would be a non-Codex class). For JS you can add a class by doing the following:

const warning = mw.util.messageBox('my warning', 'warning' );
warning.classList.add( 'mywarningclass' );
gerritbot added a comment.Oct 7 2024, 9:39 AM

Change #1078359 had a related patch set uploaded (by Sergio Gimeno; author: Sergio Gimeno):

[mediawiki/extensions/GrowthExperiments@master] refactor(ConfirmEmail): avoid using Codex classes

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

gerritbot added a project: Patch-For-Review.Oct 7 2024, 9:39 AM
gerritbot added a comment.Oct 7 2024, 9:57 AM

Change #1078364 had a related patch set uploaded (by Sergio Gimeno; author: Sergio Gimeno):

[mediawiki/extensions/GrowthExperiments@master] refactor(SpecialManageMentors): avoid using Codex classes

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

gerritbot added a comment.Oct 8 2024, 6:30 PM

Change #1078359 merged by jenkins-bot:

[mediawiki/extensions/GrowthExperiments@master] refactor(ConfirmEmail): avoid using Codex classes

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

gerritbot added a comment.Oct 8 2024, 6:33 PM

Change #1078364 merged by jenkins-bot:

[mediawiki/extensions/GrowthExperiments@master] refactor(SpecialManageMentors): avoid using Codex classes

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

ReleaseTaggerBot edited projects, added MW-1.43-notes (1.43.0-wmf.27; 2024-10-15); removed MW-1.43-notes (1.43.0-wmf.26; 2024-10-08).Oct 8 2024, 7:00 PM
Maintenance_bot removed a project: Patch-For-Review.Oct 8 2024, 7:30 PM
Sgs added a comment.Oct 9 2024, 9:48 AM
In T375902#10203651, @Jdlrobson wrote:
In T375902#10188282, @Sgs wrote:

Some code relies on finding message boxes by class name, eg: ConfirmEmail.js. Is there a non-Codex class that we could use for this? And if not, can we add one?

@Sgs the Html::messageBox class does support the addition of a custom className - so you'd need to add it there (this would be a non-Codex class). For JS you can add a class by doing the following:

const warning = mw.util.messageBox('my warning', 'warning' );
warning.classList.add( 'mywarningclass' );

Thank you, GrowthExperiments is free of cdx-message classes now.

Jdlrobson added projects: Fundraising-Backlog, Content-Transform-Team, Language-Team.Oct 9 2024, 3:42 PM

Thanks! I've untagged GrowthExperiments so feel free to unsubscribe!

gerritbot added a comment.Oct 9 2024, 3:53 PM

Change #1078974 had a related patch set uploaded (by Jdlrobson; author: Jdlrobson):

[mediawiki/extensions/MassMessage@master] Simplify MassMessage warning

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

gerritbot added a project: Patch-For-Review.Oct 9 2024, 3:53 PM
gerritbot added a comment.Oct 9 2024, 10:25 PM

Change #1078974 merged by jenkins-bot:

[mediawiki/extensions/MassMessage@master] Simplify MassMessage warning

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

Maintenance_bot removed a project: Patch-For-Review.Oct 9 2024, 10:30 PM
gerritbot added a comment.Oct 9 2024, 11:07 PM

Change #1079031 had a related patch set uploaded (by Jdlrobson; author: Jdlrobson):

[mediawiki/extensions/ParserMigration@master] Use newer messageBox function

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

gerritbot added a project: Patch-For-Review.Oct 9 2024, 11:07 PM
Jdlrobson removed projects: Patch-For-Review, MassMessage.Oct 9 2024, 11:07 PM

Screenshot of MassMessage after above merged change:

Screenshot 2024-10-09 at 8.52.37 AM.png (464×1 px, 81 KB)

This leaves 3 extensions.

cscott edited projects, added Content-Transform-Team-WIP; removed Content-Transform-Team.Oct 10 2024, 2:13 PM
Tacsipacsi added a comment.Oct 11 2024, 8:34 AM
In T375902#10215929, @Jdlrobson wrote:

Screenshot of MassMessage after above merged change:

I don’t see the screenshot, please attach it to the task.

AKanji-WMF triaged this task as Medium priority.Oct 15 2024, 8:03 PM
AKanji-WMF moved this task from Triage to DRI Backlog on the Fundraising-Backlog board.
AKanji-WMF added a project: Fundraising Tech - Chaos Crew.
Nikerabbit edited projects, added Language and Product Localization; removed Language-Team.Oct 16 2024, 7:45 AM
gerritbot added a comment.Oct 16 2024, 2:03 PM

Change #1080720 had a related patch set uploaded (by Ejegg; author: Ejegg):

[mediawiki/extensions/CentralNotice@master] Use mw.util.messageBox

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

gerritbot added a project: Patch-For-Review.Oct 16 2024, 2:03 PM
Ejegg moved this task from Backlog to Ready for Review on the Fundraising Tech - Chaos Crew board.Oct 16 2024, 6:25 PM
Pginer-WMF removed a project: Language and Product Localization.Oct 17 2024, 8:31 AM
Nikerabbit removed a project: MediaWiki-extensions-Translate.Oct 17 2024, 8:41 AM
Nikerabbit subscribed.

FYI: I've spun off Translate into a sub task.

Sgs unsubscribed.Oct 17 2024, 9:15 AM
jgleeson moved this task from Ready for Review to Being Reviewed on the Fundraising Tech - Chaos Crew board.Oct 17 2024, 1:42 PM
gerritbot added a comment.Oct 17 2024, 1:52 PM

Change #1080720 merged by jenkins-bot:

[mediawiki/extensions/CentralNotice@master] Use mw.util.messageBox

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

ReleaseTaggerBot edited projects, added MW-1.43-notes (1.43.0-wmf.28; 2024-10-22); removed MW-1.43-notes (1.43.0-wmf.27; 2024-10-15).Oct 17 2024, 2:00 PM
gerritbot added a comment.Oct 18 2024, 11:17 PM

Change #1079031 merged by jenkins-bot:

[mediawiki/extensions/ParserMigration@master] Use newer messageBox function

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

Maintenance_bot removed a project: Patch-For-Review.Oct 18 2024, 11:30 PM
Jdlrobson closed this task as Resolved.Oct 19 2024, 12:15 AM
Jdlrobson claimed this task.

Thanks all!

Tacsipacsi added a comment.Oct 19 2024, 5:56 PM

I still see rEMFR src/mobile.startup/MessageBox.js and rECNO resources/infrastructure/campaignManager.js:559 (at b0a196822c54b931f08b6a8ff403345ad418badb) in the search results, shouldn’t they also be updated before we can call this done? (The other three extensions are probably fine: CommunityConfiguration only references the class in tests, Translate has its own subtask, and Flow is about to be undeployed.)

Jdlrobson added a comment.Oct 21 2024, 5:00 PM
  • CentralNotice was fixed in https://gerrit.wikimedia.org/r/c/mediawiki/extensions/CentralNotice/+/1080720 - they have a release process so it's not yet reflected in master.
  • MobileFrontend's uses templates for managing all Codex design components, so it makes sense to manage this without mw.util.messageBox consistently with other components e.g. Button. As a maintainer preserving that and updating it as needed is fine.
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