[Dev] Adopt template partials in Vector and revise sidebar component
Closed, ResolvedPublic3 Estimated Story Points
Actions

Assigned To

Authored By

	Jdlrobson
	Feb 17 2020, 7:56 PM

Description

NOTE: I believe this task will help implement T243281 more effortlessly.

From what I can see with the new version of Vector the easiest path to maintenance would be to maintain 2 master templates or to maintain a single template with conditionals related to version number.

In both scenarios we would benefit from the use of template partials to make index.mustache more readable and easier to rearrange.

Acceptance criteria

There is a single call to processTemplate inside VectorTemplate.
Any new components are documented in storybook and have a template associated.
Any revised components are updated in storybook
Consider updating VectorTemplateTest or adding tests elsewhere

Developer notes

Associated patches show an incremental way to do this.

For context on how this helps T243281 read T243281#5871879 and then consult POC Vector patch

Details

	Subject	Repo	Branch	Lines +/-
	Use template partials rather than HTML strings	mediawiki/skins/Vector	master	+415 -287
	POC: Embrace the Power of the "children" Prop	mediawiki/skins/Vector	master	+87 -71

Customize query in gerrit

Related Objects
Search...

Status	Subtype	Assigned	Task
Resolved	Goal	ovasileva	T242131 [GOAL] Deploy new header to at least one test wiki
Resolved		Jdlrobson	T240856 [EPIC] New header for desktop improvements project
Resolved		ovasileva	T236176 [EPIC] Build opt-in/opt-out mechanism for desktop improvements project
Resolved		ovasileva	T243281 Build opt-out link for logged-in users with new vector on
Resolved		Jdlrobson	T245456 [Dev] Adopt template partials in Vector and revise sidebar component
Resolved		phuedx	T113095 A cached server-side HTML template should update when you change a partial template which it includes

Event Timeline

Jdlrobson created this task.Feb 17 2020, 7:56 PM

Restricted Application added a subscriber: Aklapper. · View Herald TranscriptFeb 17 2020, 7:56 PM

Change 572738 had a related patch set uploaded (by Jdlrobson; owner: Jdlrobson):
[mediawiki/skins/Vector@master] POC: Template partials

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

gerritbot added a project: Patch-For-Review.Feb 17 2020, 7:56 PM

Jdlrobson triaged this task as High priority.Feb 17 2020, 7:57 PM

Jdlrobson updated the task description. (Show Details)

Jdlrobson moved this task from Needs Analysis to Upcoming on the Web-Team-Backlog (Kanbanana-2019-20-Q3) board.

Jdlrobson renamed this task from [Dev] Adopt template partials in Vector to [Dev] Adopt template partials in Vector and revise sidebar component.Feb 17 2020, 8:04 PM

Jdlrobson updated the task description. (Show Details)

ovasileva moved this task from Upcoming to Needs Analysis on the Web-Team-Backlog (Kanbanana-2019-20-Q3) board.Feb 18 2020, 5:35 PM

I've been looking at @Jdlrobson's POC patches related to template partials in trying to determine how to do T243281 (Note the note at the top of the task!). So far they look good to me, but I'm trying to work out if the following AC is the right approach:

There is a single call to processTemplate inside VectorTemplate.

Namely, I'm wondering if we could achieve more/better composition if we made VectorTemplate's execute method be entirely responsible for the the composition of components (and thus have multiple ->processTemplate() calls each rendering a different component with the data it needs) vs. having the execute method be responsible for the composition of data/props AND having mustache match that composition structure through partials composed of partials (which is what I think this AC would require).

If my description sounds entirely vague or nonsensical to you, it's probably because it is! I'm having trouble articulating the approach I'm proposing, but I'm spending some time today to work out a POC patch that will hopefully explain it much better!

• nray mentioned this in T243281: Build opt-out link for logged-in users with new vector on.Feb 20 2020, 7:29 PM

Change 574019 had a related patch set uploaded (by Nray; owner: Nray):
[mediawiki/skins/Vector@master] POC: Embrace the Power of the "children" Prop

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

If my description sounds entirely vague or nonsensical to you, it's probably because it is! I'm having trouble articulating the approach I'm proposing, but I'm spending some time today to work out a POC patch that will hopefully explain it much better!

POC Patch at https://gerrit.wikimedia.org/r/574019 that builds on Jon's work. Not sure if that approach is worth it or not, but I hope that clears up what I was aiming for (namely having more reusable components)

Change 572738 abandoned by Jdlrobson:
POC: Template partials

Reason:
abandoning for now

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