Page MenuHomePhabricator
Create Task
Maniphest T220620

Switch Hogan for Mustache
Closed, ResolvedPublic5 Estimated Story Points
Actions

Assigned To
ovasileva
Authored By
Jdlrobson
Apr 10 2019, 3:38 PM
Tags
Referenced Files
F28972946: Screen Shot 2019-05-08 at 4.09.14 PM.png
May 8 2019, 11:11 PM
F28972947: Screen Shot 2019-05-08 at 4.10.17 PM.png
May 8 2019, 11:11 PM
F28972897: Screen Shot 2019-05-08 at 4.00.14 PM.png
May 8 2019, 11:11 PM
F28965692: Screen Shot 2019-05-08 at 2.14.26 AM.png
May 8 2019, 9:36 AM
F28965757: Screen Shot 2019-05-08 at 2.29.11 AM.png
May 8 2019, 9:36 AM
F28965701: Screen Shot 2019-05-08 at 2.25.23 AM.png
May 8 2019, 9:36 AM
F28965682: Screen Shot 2019-05-08 at 2.13.02 AM.png
May 8 2019, 9:36 AM
F28965756: Screen Shot 2019-05-08 at 2.33.07 AM.png
May 8 2019, 9:36 AM
Subscribers
Aklapper
• alexhollender_WMF
• charlotteportero
debt
Edtadros
gerritbot
Jdlrobson
View All 15 Subscribers

Description

We will remove Hogan from MobileFrontend and make sure of Mustache in core. Mustache is smaller, uses the same syntax and available in MediaWiki. This will make it easier for template users working across mobile and desktop environments.

Acceptance criteria

  • A dependency is added to mediawiki.template.hogan to mediawiki.template.mustache
  • For compatibility with Minerva which cannot use inline templates (right now) , to avoid loading both Mustache and Hogan and to avoid this being a breaking change the Hogan compiler should remain but look like this:
// register hogan compiler with core
mw.template.registerCompiler( 'hogan', mw.template.getCompiler('mustache') );
  • Any webpack dependencies relating to Hogan are removed.
  • A deprecated flag is added to mediawiki.template.hogan to ensure existing users move to mediawiki.template.mustache

QA steps

Switching Hogan to Mustache will have implications on Minerva, which will still be using templates for rendering page issues, main menu, notifications and the back to top feature

  • In beta ensure the back to top feature is still rendering and matches production when opted into BETA (Android only)
  • Make sure the main menu rendering matches production
  • Make sure the page issues overlay rendering matches production. Use https://en.m.wikipedia.beta.wmflabs.org/wiki/Pharmacovigilance for testing this.
  • Make sure the notification badge (top right corner in LTR mode) is still rendering and matches production.

A general QA of the entire site (either by developer and/or test engineer) will also be needed to check different flows are rendering easily. (This would be much more straightforward if we had a Storybook)

Sign off steps

  • Record this on release timeline
  • Open a task to update Minerva to use mediawiki.template.mustache (already done)
  • Open a task to remove the mediawiki.template.hogan module completely (patch merged 3 weeks after, no task necessary)

QA Results

ACStatusDetails
1✅T220620#5169064
2✅T220620#5166474
3✅T220620#5169064
4✅T220620#5166474

Details

SubjectRepoBranchLines +/-
Swap Hogan for Mustachemediawiki/extensions/MobileFrontendmaster+39 -42
Minerva is Hogan freemediawiki/skins/MinervaNeuemaster+11 -11
Customize query in gerrit

Related Objects
Search...

Event Timeline

Jdlrobson triaged this task as High priority.Apr 10 2019, 3:38 PM
Jdlrobson created this task.
Jdlrobson updated the task description. (Show Details)
Jdlrobson updated the task description. (Show Details)Apr 10 2019, 3:42 PM
Jdlrobson moved this task from Incoming to Upcoming on the Web-Team-Backlog board.
Jdlrobson updated the task description. (Show Details)Apr 10 2019, 4:24 PM
ovasileva set the point value for this task to 5.Apr 10 2019, 4:29 PM
ovasileva edited projects, added Web-Team-Backlog (Readers-Web-Kanbanana-Board-2018-19-Q4); removed Web-Team-Backlog.
Krinkle unsubscribed.Apr 17 2019, 6:26 PM
Jdlrobson claimed this task.Apr 25 2019, 1:44 AM
Jdlrobson moved this task from To Do to Doing on the Web-Team-Backlog (Readers-Web-Kanbanana-Board-2018-19-Q4) board.
gerritbot added a comment.Apr 25 2019, 2:13 AM

Change 506337 had a related patch set uploaded (by Jdlrobson; owner: Jdlrobson):
[mediawiki/extensions/MobileFrontend@master] Swap Hogan for Mustache

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

gerritbot added a project: Patch-For-Review.Apr 25 2019, 2:13 AM
gerritbot added a comment.Apr 25 2019, 2:34 AM

Change 506338 had a related patch set uploaded (by Jdlrobson; owner: Jdlrobson):
[mediawiki/skins/MinervaNeue@master] Minerva is Hogan free

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

Jdlrobson moved this task from Doing to Needs Code Review on the Web-Team-Backlog (Readers-Web-Kanbanana-Board-2018-19-Q4) board.Apr 25 2019, 4:24 AM
• Niedzielski edited projects, added MobileFrontend (MobileFrontend and MinervaNeue architecture); removed MobileFrontend.May 1 2019, 1:34 PM
pmiazga subscribed.May 1 2019, 5:40 PM

We should also fix https://gerrit.wikimedia.org/g/mediawiki/extensions/RelatedArticles/+/a7e6c196f747d90a08c5d649279d8d898632f575/includes/ResourceLoaderMuHoganModule.php

pmiazga added a comment.May 1 2019, 5:44 PM

I downloaded both patches, on pretty clean MediaWiki instance I immediately get warning Use of "compile" is deprecated. Hogan compiler renders templates as Mustache. Use the mustache compiler directly and confirm your template is compatible.

Jdlrobson added a comment.May 1 2019, 7:09 PM
In T220620#5150609, @pmiazga wrote:

I downloaded both patches, on pretty clean MediaWiki instance I immediately get warning Use of "compile" is deprecated. Hogan compiler renders templates as Mustache. Use the mustache compiler directly and confirm your template is compatible.

Fixed in https://gerrit.wikimedia.org/r/#/c/mediawiki/extensions/MobileFrontend/+/506337/5..6/src/mediawiki.template.hogan/mediawiki.template.hogan.js,unified

In T220620#5150601, @pmiazga wrote:

We should also fix https://gerrit.wikimedia.org/g/mediawiki/extensions/RelatedArticles/+/a7e6c196f747d90a08c5d649279d8d898632f575/includes/ResourceLoaderMuHoganModule.php

As discussed this is dead code (and removed in https://gerrit.wikimedia.org/r/507621). Not blocking this change.

gerritbot added a comment.May 1 2019, 7:41 PM

Change 506337 merged by jenkins-bot:
[mediawiki/extensions/MobileFrontend@master] Swap Hogan for Mustache

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

gerritbot added a comment.May 1 2019, 7:41 PM

Change 506338 merged by jenkins-bot:
[mediawiki/skins/MinervaNeue@master] Minerva is Hogan free

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

ReleaseTaggerBot added a project: MW-1.34-notes (1.34.0-wmf.4; 2019-05-07).May 1 2019, 8:01 PM
Jdlrobson reassigned this task from Jdlrobson to Edtadros.May 1 2019, 9:51 PM
Jdlrobson moved this task from Needs Code Review to Needs QA on the Web-Team-Backlog (Readers-Web-Kanbanana-Board-2018-19-Q4) board.
Jdlrobson added a subscriber: • alexhollender_WMF.

Please test on https://en.m.wikipedia.beta.wmflabs.org - specifically we're looking for any UI regressions compared with production (cc @alexhollender )

• alexhollender_WMF added a comment.May 1 2019, 11:59 PM

@Jdlrobson I think we've discussed potential issues with such broad QA asks like this in the past. Is there any way to provide some clues as to what might be off as a result of this change?

Jdlrobson added a comment.May 2 2019, 12:24 AM
In T220620#5151605, @alexhollender wrote:

@Jdlrobson I think we've discussed potential issues with such broad QA asks like this in the past. Is there any way to provide some clues as to what might be off as a result of this change?

I think the risk of any issue is low and if there is an issue it should be obvious and visual (A made-up example might be "when I clicking search and search, the search results are not displaying!"). Templates are used in all our JavaScript based experiences, so we should test all workflows such as editing, viewing languages, talk, searching and checking they still work (which I've done myself). That should be sufficient. The browser tests have also already given us a strong indication that things are working.

Jdlrobson merged a task: T219845: Swap Hogan for Mustache.May 2 2019, 9:07 PM
Jdlrobson added subscribers: • charlotteportero, debt, Reedy and 2 others.
• alexhollender_WMF added a comment.May 6 2019, 7:01 PM

Apologies for the delay here, not sure if this is still needed but everything looks good on both iOS and Android.

In beta ensure the back to top feature is still rendering and matches production✅
Make sure the main menu rendering matches production✅
Make sure the page issues overlay rendering matches production✅
Make sure the notification badge (top right corner in LTR mode) is still rendering and matches production.✅
• alexhollender_WMF updated the task description. (Show Details)May 6 2019, 7:01 PM
Edtadros reassigned this task from Edtadros to • alexhollender_WMF.EditedMay 8 2019, 9:36 AM
Edtadros moved this task from Needs QA to Needs More Work on the Web-Team-Backlog (Readers-Web-Kanbanana-Board-2018-19-Q4) board.
Edtadros subscribed.

Test Result

Status: Not Complete
OS: macOS Mojave
Browser: Chrome
Device: BrowserStack - Galaxy S5

Test Artifact(s):

❓ AC1: In beta ensure the back to top feature is still rendering and matches production (Android only)
@alexhollender I was able to get the back to top overlay in beta but not in production.

Screen Shot 2019-05-08 at 2.13.02 AM.png (1×610 px, 556 KB)

✅ AC2: Make sure the main menu rendering matches production

Screen Shot 2019-05-08 at 2.14.26 AM.png (1×624 px, 457 KB)

Screen Shot 2019-05-08 at 2.25.23 AM.png (1×638 px, 526 KB)

❓ AC3: Make sure the page issues overlay rendering matches production
@alexhollender how do I get the page issues overlay to render?

✅ AC4: Make sure the notification badge (top right corner in LTR mode) is still rendering and matches production.

Screen Shot 2019-05-08 at 2.29.11 AM.png (1×633 px, 594 KB)

Screen Shot 2019-05-08 at 2.33.07 AM.png (1×620 px, 594 KB)

Jdlrobson reassigned this task from • alexhollender_WMF to Edtadros.May 8 2019, 6:47 PM
Jdlrobson updated the task description. (Show Details)
Jdlrobson moved this task from Needs More Work to Needs QA on the Web-Team-Backlog (Readers-Web-Kanbanana-Board-2018-19-Q4) board.

I think the edits to the description in https://phabricator.wikimedia.org/transactions/detail/PHID-XACT-TASK-ccksmfyydwihpcu/ should help with the remaining 2. IM me if not!

Edtadros reassigned this task from Edtadros to ovasileva.EditedMay 8 2019, 11:11 PM
Edtadros moved this task from Needs QA to Ready for Signoff on the Web-Team-Backlog (Readers-Web-Kanbanana-Board-2018-19-Q4) board.

@Jdlrobson, that helped. And neat phab link!

Test Result

Status: ✅ PASS
OS: macOS Mojave
Browser: Chrome
Device: BrowserStack - Galaxy S5

Test Artifact(s):

✅ AC1: In beta ensure the back to top feature is still rendering and matches production (Android only)

Screen Shot 2019-05-08 at 2.13.02 AM.png (1×610 px, 556 KB)

Screen Shot 2019-05-08 at 4.00.14 PM.png (1×655 px, 682 KB)

✅ AC3: Make sure the page issues overlay rendering matches production

Screen Shot 2019-05-08 at 4.10.17 PM.png (1×666 px, 567 KB)

Screen Shot 2019-05-08 at 4.09.14 PM.png (1×645 px, 556 KB)

Krinkle unsubscribed.May 8 2019, 11:13 PM
Edtadros updated the task description. (Show Details)May 8 2019, 11:14 PM
Jdlrobson closed this task as Resolved.May 14 2019, 12:55 PM

Hogan is no more 🦑🦑🦑🐳🎉🎉🎉

xSavitar subscribed.May 14 2019, 1:49 PM
Jdlrobson updated the task description. (Show Details)May 14 2019, 2:14 PM
• nray mentioned this in T223927: [Bug] [object Object] appears in TalkOverlay.May 20 2019, 6:22 PM
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