Page MenuHomePhabricator
Create Task
Maniphest T300640

Hide unused parameters by default in multi-part transclusions
Closed, ResolvedPublic0 Estimated Story Points
Actions

Description

In T298259: Add button to sidebar to hide/show unused fields we implemented a "hide unused parameters" filter for large lists of template parameters. This is a follow-up to that.

  • Whenever the dialog opens with a single template, unused parameters are shown.
  • When a multi-part transclusion is edited, all unused parameters in all parts are initially hidden.
  • All this must consider that the filter options are hidden for templates with 3 or less parameters. Contrary to what was said above unused parameters are not hidden when a template has 3 or less parameters.
  • When adding more parameters to a template so it includes more than 3, the search and hide unused widgets will show, but unused parameters should (still) not be hidden
  • When adding another part to a multi-part transclusion, the new part should never be collapsed.
  • This allows for more performance improvements. See T300974.

Details

Related Changes in Gerrit:
SubjectRepoBranchLines +/-
Fix hiding unused template parameters sometimes not workingmediawiki/extensions/VisualEditormaster+17 -18
Never collapse newly added templates in transclusion dialogmediawiki/extensions/VisualEditormaster+7 -5
Hide unused paramters by default on multipartmediawiki/extensions/VisualEditormaster+46 -9
Customize query in gerrit

Related Objects
Search...

Event Timeline

thiemowmde created this task.Feb 1 2022, 3:36 PM
Restricted Application added a subscriber: Aklapper. · View Herald TranscriptFeb 1 2022, 3:36 PM
thiemowmde added a subtask: T298259: Add button to sidebar to hide/show unused fields.Feb 1 2022, 3:37 PM
thiemowmde moved this task from Backlog to Ready for pickup on the WMDE-Templates-FocusArea board.
thiemowmde added a project: WMDE-TechWish-Sprint-2022-02-02.Feb 2 2022, 9:19 AM
thiemowmde set the point value for this task to 5.Feb 2 2022, 9:22 AM
WMDE-Fisch claimed this task.Feb 2 2022, 12:08 PM
WMDE-Fisch moved this task from Ready for pickup to In sprint on the WMDE-Templates-FocusArea board.
WMDE-Fisch moved this task from Sprint Backlog to Doing on the WMDE-TechWish-Sprint-2022-02-02 board.
WMDE-Fisch added a comment.Feb 3 2022, 11:28 AM

All this must consider that the filter options are hidden for templates with 3 or less parameters. Contrary to what was said above unused parameters are not hidden when a template has 3 or less parameters.

On question to that:

  • Currently a 3 parameter template added in a multipart transclusion shows these parameters as described and hides the interface to search/filter unused.
  • When I now add a 4th parameter using the Add undocumented parameter UI this changes and the search/filter unused becomes visible.
  • In that step the 3 unused parameters will "suddenly" become hidden due to the new default of hiding unused parameters on multipart.
  • Should that stay like that? ( The button then shows Show all fields as it should and there might be no problem, just wanted to raise awareness for that fact )
thiemowmde added a comment.Feb 3 2022, 12:10 PM

In that step the 3 unused parameters will "suddenly" become hidden […]

Uh, no, that doesn't sound right to me. The behavior should be consistent in so far that:

  1. The initial state this ticket is about is only for when the dialog opens. It should not have an effect later.
  2. I don't think there is another situation where adding a parameter suddenly hides something.
gerritbot added a comment.Feb 3 2022, 12:37 PM

Change 759497 had a related patch set uploaded (by WMDE-Fisch; author: WMDE-Fisch):

[mediawiki/extensions/VisualEditor@master] Hide unused paramters by default on multipart

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

gerritbot added a project: Patch-For-Review.Feb 3 2022, 12:37 PM
WMDE-Fisch updated the task description. (Show Details)Feb 4 2022, 9:26 AM
WMDE-Fisch updated the task description. (Show Details)
WMDE-Fisch moved this task from Doing to Tech Review on the WMDE-TechWish-Sprint-2022-02-02 board.Feb 4 2022, 10:19 AM
thiemowmde mentioned this in T300974: Loading performance: Postpone initial widget creation for unused template parameters.Feb 4 2022, 1:37 PM
thiemowmde added a parent task: T300974: Loading performance: Postpone initial widget creation for unused template parameters.
thiemowmde updated the task description. (Show Details)Feb 4 2022, 1:39 PM
WMDE-Fisch changed the point value for this task from 5 to 3.Feb 4 2022, 1:49 PM
gerritbot added a comment.Feb 8 2022, 3:58 PM

Change 759497 merged by jenkins-bot:

[mediawiki/extensions/VisualEditor@master] Hide unused paramters by default on multipart

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

ReleaseTaggerBot added a project: MW-1.38-notes (1.38.0-wmf.22; 2022-02-14).Feb 8 2022, 4:00 PM
WMDE-Fisch moved this task from Tech Review to Demo on the WMDE-TechWish-Sprint-2022-02-02 board.Feb 8 2022, 4:05 PM
Maintenance_bot removed a project: Patch-For-Review.Feb 8 2022, 4:10 PM
ppelberg moved this task from To Triage to Triaged on the VisualEditor board.Feb 10 2022, 4:44 PM
thiemowmde claimed this task.Feb 22 2022, 9:43 AM
thiemowmde updated the task description. (Show Details)
thiemowmde moved this task from Demo to Doing on the WMDE-TechWish-Sprint-2022-02-02 board.
gerritbot added a comment.Feb 22 2022, 10:38 AM

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

[mediawiki/extensions/VisualEditor@master] Never collapse newly added templates in transclusion dialog

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

gerritbot added a project: Patch-For-Review.Feb 22 2022, 10:38 AM
thiemowmde moved this task from Doing to Tech Review on the WMDE-TechWish-Sprint-2022-02-02 board.Feb 22 2022, 10:38 AM
gerritbot added a comment.Feb 22 2022, 3:03 PM

Change 764742 merged by jenkins-bot:

[mediawiki/extensions/VisualEditor@master] Never collapse newly added templates in transclusion dialog

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

Maintenance_bot removed a project: Patch-For-Review.Feb 22 2022, 3:10 PM
ReleaseTaggerBot edited projects, added MW-1.38-notes (1.38.0-wmf.24; 2022-02-28); removed MW-1.38-notes (1.38.0-wmf.22; 2022-02-14).Feb 22 2022, 4:00 PM
thiemowmde added a project: WMDE-TechWish-Sprint-2022-02-23.Feb 23 2022, 9:13 AM
thiemowmde moved this task from Sprint Backlog to Tech Review on the WMDE-TechWish-Sprint-2022-02-23 board.
thiemowmde changed the point value for this task from 3 to 1.Feb 23 2022, 9:34 AM
thiemowmde changed the point value for this task from 1 to 0.
thiemowmde moved this task from Tech Review to Demo on the WMDE-TechWish-Sprint-2022-02-23 board.
thiemowmde changed the point value for this task from 0 to 3.Feb 23 2022, 9:42 AM
thiemowmde added a project: WMDE-TechWish-Sprint-2022-03-02.Mar 2 2022, 9:22 AM
thiemowmde moved this task from Sprint Backlog to Demo on the WMDE-TechWish-Sprint-2022-03-02 board.Mar 2 2022, 9:23 AM
WMDE-Fisch added a comment.Mar 15 2022, 9:33 AM

We have a regression here probably introduced by T302965: Hiding unused parameters makes the sidebar jump to the wrong header in some cases.

WMDE-Fisch added a comment.Mar 15 2022, 11:47 AM
In T300640#7776939, @WMDE-Fisch wrote:

We have a regression here probably introduced by T302965: Hiding unused parameters makes the sidebar jump to the wrong header in some cases.

There seems to be an edge case, where on templates with template data, that have no parameter added to them, hiding the unused by default does not work. Instead, the button assumes the hidden state while the parameters are all visible.

WMDE-Fisch moved this task from Demo to Doing on the WMDE-TechWish-Sprint-2022-03-02 board.Mar 15 2022, 11:47 AM
WMDE-Fisch claimed this task.Mar 15 2022, 4:58 PM

The regression was introduced with https://gerrit.wikimedia.org/r/c/mediawiki/extensions/VisualEditor/+/761002/ from T300974: Loading performance: Postpone initial widget creation for unused template parameters it seems.

WMDE-Fisch added a project: WMDE-TechWish-Sprint-2022-03-16.Mar 16 2022, 9:33 AM
WMDE-Fisch changed the point value for this task from 3 to 2.
WMDE-Fisch moved this task from Sprint Backlog to Doing on the WMDE-TechWish-Sprint-2022-03-16 board.Mar 16 2022, 9:35 AM
gerritbot added a comment.Mar 16 2022, 12:21 PM

Change 770940 had a related patch set uploaded (by WMDE-Fisch; author: WMDE-Fisch):

[mediawiki/extensions/VisualEditor@master] Revert "Skip initial creation of unused parameter widget"

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

gerritbot added a project: Patch-For-Review.Mar 16 2022, 12:21 PM
WMDE-Fisch added a comment.Mar 16 2022, 12:31 PM

I did not find a good solution to fix the issues that came with the performance patch's changes so I'm tending to revert it. It can always be re-applied when it's fixed and working correctly.

WMDE-Fisch moved this task from Doing to Tech Review on the WMDE-TechWish-Sprint-2022-03-16 board.Mar 16 2022, 12:31 PM
WMDE-Fisch moved this task from Doing to Tech Review on the WMDE-TechWish-Sprint-2022-03-02 board.Mar 16 2022, 12:35 PM
WMDE-Fisch moved this task from Tech Review to Doing on the WMDE-TechWish-Sprint-2022-03-02 board.
WMDE-Fisch mentioned this in T304046: Templates with suggested/required parameters do not hide unused parameters by default on multipart when empty.Mar 17 2022, 7:28 AM
WMDE-Fisch changed the point value for this task from 2 to 0.Mar 17 2022, 7:30 AM

I created a follow up ticket for this bug. Also to document the issue properly.

WMDE-Fisch added a subtask: T304046: Templates with suggested/required parameters do not hide unused parameters by default on multipart when empty.Mar 17 2022, 7:31 AM
WMDE-Fisch removed WMDE-Fisch as the assignee of this task.Mar 17 2022, 7:34 AM
WMDE-Fisch removed a project: Patch-For-Review.
WMDE-Fisch moved this task from Tech Review to Watching / Epic / Stalled on the WMDE-TechWish-Sprint-2022-03-16 board.
gerritbot added a comment.Mar 22 2022, 1:59 PM

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

[mediawiki/extensions/VisualEditor@master] Fix hiding unused template parameters sometimes not working

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

gerritbot added a project: Patch-For-Review.Mar 22 2022, 2:00 PM
gerritbot added a comment.Mar 22 2022, 6:22 PM

Change 772833 merged by jenkins-bot:

[mediawiki/extensions/VisualEditor@master] Fix hiding unused template parameters sometimes not working

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

thiemowmde closed subtask T304046: Templates with suggested/required parameters do not hide unused parameters by default on multipart when empty as Resolved.Mar 29 2022, 8:13 AM
awight moved this task from Watching / Epic / Stalled to Done on the WMDE-TechWish-Sprint-2022-03-16 board.Mar 29 2022, 8:38 AM
thiemowmde closed this task as Resolved.Mar 29 2022, 8:47 AM
thiemowmde claimed this task.
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