Page MenuHomePhabricator
Create Task
Maniphest T274538

Design new VisualEditor template dialog data model and data propagation
Closed, ResolvedPublic8 Estimated Story Points
Actions

Description

We want to start by designing a data model that can be shared between both the sidebar and the content pane.

  • Lists top-level content elements (can be multiple templates as well as wikitext snippets).
  • Lists all known parameters.
  • Each parameter with a bool flag for the checkbox.
  • Unknown parameters can be added any time.
  • Search indexes (many TemplateData fields)
  • Need to consider the event handling model--possibly a merged data structure is not going to be easy.
  • Draw a diagram of the data container(s) and how changes are propagated among components.

We’re worried that the content model is designed to be 1:1 with wikitext, and our model which contains nonexistent parameters will break this assumption.

Updates are currently propagated by add, remove, and replace events. Will we stay in this paradigm? The alternative is to send something like a "change" event, and each pane is responsible for updating itself from the master data store.

Related Objects
Search...

StatusSubtypeAssignedTask
 ResolvedWMDE-FischT306967 Deploy VE template dialog improvements to enwiki
 ResolvedLena_WMDET296759 Deploy VE template dialog improvements to more wikis
 ResolvedLena_WMDET286992 Deploy VE template dialog improvements to small set of wikis
 ResolvedWMDE-FischT272487 New input for undocumented parameters
 ResolvedWMDE-FischT272482 Show/hide advanced toolbar when multi-part content is present
 ResolvedECohen_WMDET272368 Add checkboxes to param list sidebar in VE TemplateDialog
 ResolvedNoneT274548 VisualEditor template "required" parameter handling
 InvalidNoneT274549 Handle "no parameter" templates
 ResolvedthiemowmdeT274551 "deprecated" parameter handling
 ResolvedAndrew-WMDET275761 Remove the trash icons which show next to the parameter name when it's "in focus"
 ResolvedNoneT274547 Handle checkbox clicks in VisualEditor template dialog sidebar
 ResolvedNoneT272481 Add parameter search to sidebar of VE TemplateDialog
 ResolvedthiemowmdeT274544 Support multiple transclusions (i.e. templates) in the new template dialog sidebar
 ResolvedAndrew-WMDET274550 Handle undocumented template parameters
 ResolvedWMDE-FischT274545 Wire template parameters into the checkbox list view
 ResolvedLena_WMDET274538 Design new VisualEditor template dialog data model and data propagation
 ResolvedNoneT276325 Review proof-of-concept VE template dialog sidebar code
 ResolvedECohen_WMDET285869 Add error handling for the undocumented parameter input
 InvalidNoneT291059 [DRAFT] Adjust messages for special alias edge cases

Event Timeline

awight created this task.Feb 11 2021, 2:52 PM
Restricted Application added a subscriber: Aklapper. · View Herald TranscriptFeb 11 2021, 2:52 PM
lilients_WMDE mentioned this in T274540: Implement the new VisualEditor template dialog data model and adjust existing code to it.Feb 11 2021, 2:57 PM
awight added a project: VisualEditor-MediaWiki-Templates.Feb 11 2021, 3:19 PM
Maintenance_bot added a project: VisualEditor.Feb 11 2021, 3:46 PM
matmarex moved this task from To Triage to Triaged on the VisualEditor board.Feb 11 2021, 4:09 PM
gerritbot added a comment.Mar 2 2021, 4:58 PM

Change 667892 had a related patch set uploaded (by Ebernhardson; owner: Ebernhardson):
[wikimedia/discovery/analytics@master] ores_bulk_ingest: Increase drafttopic error_threshold to 1 per 500

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

gerritbot added a project: Patch-For-Review.Mar 2 2021, 4:58 PM
EBernhardson removed a project: Patch-For-Review.Mar 2 2021, 5:33 PM
awight updated the task description. (Show Details)Mar 3 2021, 1:38 PM
awight set the point value for this task to 8.Mar 3 2021, 1:41 PM
Lena_WMDE moved this task from Backlog to In preparation on the WMDE-Templates-FocusArea board.Mar 10 2021, 1:54 PM
awight added a parent task: T274545: Wire template parameters into the checkbox list view.Mar 11 2021, 2:42 PM
awight removed a parent task: T272368: Add checkboxes to param list sidebar in VE TemplateDialog.Mar 11 2021, 2:54 PM
Lena_WMDE moved this task from In preparation to Ready for pickup on the WMDE-Templates-FocusArea board.Apr 14 2021, 8:24 AM
awight renamed this task from Design new VisualEditor template dialog data model to Design new VisualEditor template dialog data model and data propagation.May 14 2021, 7:43 AM
Lena_WMDE edited projects, added WMDE-TechWish-Sprint-2021-05-26; removed WMDE-TechWish.May 26 2021, 8:36 AM
WMDE-Fisch moved this task from Ready for pickup to In sprint on the WMDE-Templates-FocusArea board.May 26 2021, 8:36 AM
awight closed subtask T276325: Review proof-of-concept VE template dialog sidebar code as Resolved.Jun 8 2021, 8:07 AM
thiemowmde added a project: WMDE-TechWish-Sprint-2021-06-09.Jun 9 2021, 11:13 AM
awight moved this task from Sprint Backlog to Review on the WMDE-TechWish-Sprint-2021-05-26 board.Jun 14 2021, 2:01 PM

Today's thoughts:

  • BookletLayout embeds assumptions about data flow and the relationship of its "outline" to the content, which are not compatible with the new design.
    • We need to rewrite the hierarchy from this level down.
    • "TransclusionEditor" will contain a "TransclusionOutline" sidebar, and a "TransclusionContent" main pane.
    • The content pane classes will be mostly unchanged, with one exception: they currently have responsibility for creating their own outline items. This code will become inert in the new hierarchy, and will only be used for legacy BookletLayout invocations in other extensions.
    • The sidebar classes are replaced.
  • We can use the transclusionModel (interface to the wikitext being edited) as our main source of truth. For example: let's take the UI action to delete a parameter. This will call transclusionModel.disconnect, and a replacePart(removed, null) event is emitted.
  • The sidebar and content panes listen to the wikitext, and add or remove UI elements in response to changes. This approach is already a partial precedent in existing code, but I'm recommending that we consolidate to this approach and migrate any data flows going through other objects.
  • Parameter order follows the existing rules. Wikitext order may vary, and is kept stable during normal edits, but dialog order is always canonical. Unknown parameters come last, in the order dded. In other words, nothing changes here.
    • The canonical ordering service can be extracted into a module, which reads from the template spec and from the transclusionModel. It could be implemented by listening to transclusionModel changes.
  • The template spec holds the list of "known" parameters and should be constant during the course of a dialog.

Search indexing is still an open question, I would like to use the same transclusionModel-driven flow, but it looks like we need some awkward routing to split events by which multi-part template they belong to, for both search and the sidebar?

Still need to draw this proposal.

awight added a comment.Jun 15 2021, 12:44 PM

Today's thoughts:

After a quick Dev Talk, this theory seems reasonable enough to move forward with. Please jump in with any last concerns you might have!

awight moved this task from Sprint Backlog to Demo on the WMDE-TechWish-Sprint-2021-06-09 board.Jun 15 2021, 12:44 PM
awight moved this task from Demo to Done on the WMDE-TechWish-Sprint-2021-06-09 board.Jun 22 2021, 7:49 AM
Lena_WMDE closed this task as Resolved.Jun 22 2021, 8:38 AM
Lena_WMDE claimed this task.
Content licensed under Creative Commons Attribution-ShareAlike 4.0 (CC-BY-SA) unless otherwise noted; code licensed under GNU General Public License (GPL) or 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