Page MenuHomePhabricator
Create Task
Maniphest T253416

Deprecate BaseTemplateToolbox hook
Closed, ResolvedPublic
Actions

Description

The BaseTemplateToolbox hook adds logic to the rendering layer.
It's used in a few places:
https://codesearch.wmflabs.org/search/?q=BaseTemplateToolbox&i=nope&files=&repos=

With T252917 and @Ammarpad modification the SidebarBeforeOutput hook will be usable instead.

Let's deprecate the hook and move usages to SidebarBeforeOutput.

Acceptance criteria

  • All extensions in subtasks should use SidebarBeforeOutput (Vector) instead of the BaseTemplateToolbox. This should retain support with Modern, Monobook and Cologne Blue.
  • Vector should not call BaseTemplate::getToolbox
  • Soft deprecate BaseTemplate::getToolbox in core
  • Mark BaseTemplateToolbox hook as deprecated.

Details

ProjectBranchLines +/-Subject
mediawiki/coremaster+10 -6Hard deprecate BaseTemplateToolbox hook
mediawiki/coremaster+7 -0Soft deprecate BaseTemplate::getToolbox()
mediawiki/skins/Vectormaster+3 -5Simplify Vector buildSidebar() method
mediawiki/skins/Vectormaster+4 -9Vector should not call BaseTemplate::getToolbox
mediawiki/extensions/Cargomaster+14 -22Use SidebarBeforeOutput hook to add toolbox item
Customize query in gerrit

Related Objects
Search...

Event Timeline

Jdlrobson created this task.May 22 2020, 8:23 PM
Restricted Application added a subscriber: Aklapper. · View Herald TranscriptMay 22 2020, 8:23 PM
Jdlrobson added a subscriber: xSavitar.May 22 2020, 8:23 PM
Mainframe98 added a subscriber: Mainframe98.May 22 2020, 8:35 PM
Mainframe98 awarded a token.May 22 2020, 8:43 PM
Jdlrobson mentioned this in T253683: UrlShortener should use the SidebarBeforeOutput hook .May 26 2020, 8:22 PM
Jdlrobson mentioned this in T253684: MachineVision should use the SidebarBeforeOutput hook .May 26 2020, 8:24 PM
Jdlrobson mentioned this in T253685: WikibaseRepo should use the SidebarBeforeOutput hook instead of BaseTemplateToolbox.May 26 2020, 8:26 PM
Jdlrobson mentioned this in T253686: PerformanceInspector should use SidebarBeforeOutput hook .
Jdlrobson mentioned this in T253687: CiteThisPage should use the SidebarBeforeOutput hook .
Jdlrobson added a project: MediaWiki-Core-Skin-Architecture.May 27 2020, 6:01 PM
Jdlrobson moved this task from Backlog to Phase 1 - simplify hook contracts on the MediaWiki-Core-Skin-Architecture board.May 27 2020, 6:07 PM
Jdlrobson updated the task description. (Show Details)May 27 2020, 6:21 PM
Restricted Application added a subscriber: Liuxinyu970226. · View Herald TranscriptMay 27 2020, 6:21 PM
Jdlrobson mentioned this in T253783: [EPIC] Deprecate SkinTemplateToolboxEnd hook in favor of SidebarBeforeOutput hook.May 27 2020, 6:22 PM
Jdlrobson closed subtask T253683: UrlShortener should use the SidebarBeforeOutput hook as Resolved.May 27 2020, 8:48 PM
Jdlrobson added a parent task: T253809: [EPIC] Deprecate the BaseTemplate hooks.May 27 2020, 8:53 PM
Jdlrobson moved this task from Backlog to Skinning system on the MediaWiki-Interface board.May 27 2020, 10:33 PM
Ammarpad added a subscriber: Ammarpad.May 28 2020, 5:24 PM
Ammarpad added a comment.May 28 2020, 6:22 PM

Hi @Jdlrobson, there's some problem with the new hook. It seems the TOOLBOX/LANGUAGES magic strings are not really recognized as the items are not added. Using custom heading works, but that's not wanted in most cases.

Jdlrobson added a comment.May 28 2020, 6:25 PM

@Ammarpad can you share the patch you are having issues with that's not working? I'll take a look.

Ammarpad added a comment.EditedMay 28 2020, 8:32 PM

Ok, I see it does not work well in all skins. In r596759 for MediaWiki-extensions-ShortUrl you had to use SkinTemplateToolboxEnd hook ( for 'legacy skins') even though you have also used SidebarBeforeOutput hook. But in T252917, you're also on the way to remove the former.

r596759 for ShortUrl and r598958 for UrlShorterner both do not seem to add the link if you remove SkinTemplateToolboxEnd hook.

So what's the status of SkinTemplateToolboxEnd? and what are the 'legacy skins'?

Jdlrobson added a comment.EditedMay 28 2020, 9:08 PM

Hi @Ammarpad, thanks for flagging. Sounds like we have a chicken egg problem. SkinTemplateToolboxEnd needs to be deprecated. In ShortUrl I added support for SidebarBeforeOutput but kept the SkinTemplateToolboxEnd hook around while we update CologneBlue, Monobook, Timeless and Modern.

So I guess as we do this we need to use both for now, and then once that's done, update CologneBlue, Monobook, Timeless and Modern to stop using SkinTemplateToolboxEnd.

We'll then mark the SkinTemplateToolboxEnd hook as deprecated and remove all the SkinTemplateToolboxEnd hooks via the normal deprecation process to allow other skins to catch up.

Does that make sense?

Ammarpad added a comment.May 28 2020, 9:23 PM

Thanks for the clarification. Yes, that's OK.

Jdlrobson claimed this task.May 28 2020, 9:32 PM
Jdlrobson updated the task description. (Show Details)
Jdlrobson updated the task description. (Show Details)May 29 2020, 10:08 PM
Ammarpad closed subtask T253687: CiteThisPage should use the SidebarBeforeOutput hook as Resolved.May 30 2020, 5:11 AM
Jdlrobson closed subtask T253684: MachineVision should use the SidebarBeforeOutput hook as Resolved.Jun 1 2020, 11:19 PM
Ammarpad added a subtask: T254218: Translate should use the SidebarBeforeOutput hook.Jun 2 2020, 7:03 AM
Jdlrobson added a project: MW-1.35-release.Jun 2 2020, 5:35 PM
Jdlrobson removed a subtask: T253686: PerformanceInspector should use SidebarBeforeOutput hook .
Jdlrobson updated the task description. (Show Details)
Jdlrobson moved this task from Blocker to To deprecate or remove on the MW-1.35-release board.Jun 2 2020, 11:51 PM
Ammarpad mentioned this in T254431: Deprecate SkinTemplateBuildNavUrlsNav_urlsAfterPermalink hook.Jun 4 2020, 7:53 AM
Ammarpad mentioned this in T254485: Regression: Wikidata item missing in Monobook (WikibaseClient should use the SidebarBeforeOutput hook instead of BaseTemplateToolbox).Jun 4 2020, 2:32 PM
gerritbot added a comment.Jun 5 2020, 2:25 AM

Change 602543 had a related patch set uploaded (by Ammarpad; owner: Ammarpad):
[mediawiki/skins/Vector@master] Vector should not call BaseTemplate::getToolbox

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

gerritbot added a project: Patch-For-Review.Jun 5 2020, 2:25 AM
Ammarpad added a subtask: T254548: Regression: Tool "User uploads" in the sidebar missing in skin Monobook.Jun 5 2020, 8:14 AM
Ammarpad added a subtask: T254565: ArticlePlaceholder should use the SidebarBeforeOutput hook.Jun 5 2020, 11:14 AM
Jdlrobson closed subtask T254548: Regression: Tool "User uploads" in the sidebar missing in skin Monobook as Resolved.Jun 5 2020, 4:22 PM
Jdlrobson triaged this task as High priority.Jun 5 2020, 8:49 PM
Jdlrobson mentioned this in T254433: Collection should not use SkinTemplateBuildNavUrlsNav_urlsAfterPermalink hook.Jun 5 2020, 9:54 PM
Ammarpad added a subtask: T254485: Regression: Wikidata item missing in Monobook (WikibaseClient should use the SidebarBeforeOutput hook instead of BaseTemplateToolbox).Jun 6 2020, 4:30 AM
Aklapper added a parent task: T254433: Collection should not use SkinTemplateBuildNavUrlsNav_urlsAfterPermalink hook.Jun 6 2020, 7:48 AM
gerritbot added a comment.Jun 6 2020, 9:30 AM

Change 602796 had a related patch set uploaded (by Ammarpad; owner: Ammarpad):
[mediawiki/extensions/Cargo@master] Use SidebarBeforeOutput hook to add toolbox item

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

Jdlrobson closed subtask T254218: Translate should use the SidebarBeforeOutput hook as Resolved.Jun 9 2020, 2:08 AM
gerritbot added a comment.Jun 10 2020, 4:36 PM

Change 602796 merged by jenkins-bot:
[mediawiki/extensions/Cargo@master] Use SidebarBeforeOutput hook to add toolbox item

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

Jdlrobson changed the task status from Open to Stalled.Jun 10 2020, 11:59 PM
Jdlrobson closed subtask T254565: ArticlePlaceholder should use the SidebarBeforeOutput hook as Resolved.

This is stalled on T253685 now.

Jdlrobson changed the task status from Stalled to Open.Jun 11 2020, 8:19 PM
Jdlrobson closed subtask T253685: WikibaseRepo should use the SidebarBeforeOutput hook instead of BaseTemplateToolbox as Resolved.
Jdlrobson updated the task description. (Show Details)
gerritbot added a comment.Jun 11 2020, 9:27 PM

Change 602543 merged by jenkins-bot:
[mediawiki/skins/Vector@master] Vector should not call BaseTemplate::getToolbox

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

ReleaseTaggerBot added a project: MW-1.35-notes (1.35.0-wmf.37; 2020-06-16).Jun 11 2020, 10:01 PM
Jdlrobson removed a project: Patch-For-Review.Jun 11 2020, 10:05 PM
Jdlrobson updated the task description. (Show Details)
Jdlrobson removed Jdlrobson as the assignee of this task.Jun 11 2020, 10:29 PM
Jdlrobson added a project: patch-welcome.
Ammarpad claimed this task.Jun 12 2020, 2:19 PM
gerritbot added a comment.Jun 12 2020, 6:00 PM

Change 605292 had a related patch set uploaded (by Ammarpad; owner: Ammarpad):
[mediawiki/skins/Vector@master] Simplify Vector buildSidebar() method

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

gerritbot added a project: Patch-For-Review.Jun 12 2020, 6:00 PM
gerritbot added a comment.Jun 12 2020, 7:43 PM

Change 605309 had a related patch set uploaded (by Ammarpad; owner: Ammarpad):
[mediawiki/core@master] Soft deprecate BaseTemplate::getToolbox()

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

gerritbot added a comment.Jun 12 2020, 8:32 PM

Change 605309 merged by jenkins-bot:
[mediawiki/core@master] Soft deprecate BaseTemplate::getToolbox()

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

gerritbot added a comment.Jun 12 2020, 8:32 PM

Change 605292 merged by jenkins-bot:
[mediawiki/skins/Vector@master] Simplify Vector buildSidebar() method

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

Jdlrobson removed a project: Patch-For-Review.Jun 12 2020, 8:47 PM
Jdlrobson updated the task description. (Show Details)
Ammarpad updated the task description. (Show Details)Jun 13 2020, 7:41 AM
Ammarpad updated the task description. (Show Details)Jun 13 2020, 7:49 AM
gerritbot added a comment.Jun 13 2020, 8:05 AM

Change 605351 had a related patch set uploaded (by Ammarpad; owner: Ammarpad):
[mediawiki/core@master] Hard deprecate BaseTemplateToolbox hook

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

gerritbot added a project: Patch-For-Review.Jun 13 2020, 8:05 AM
gerritbot added a comment.Jun 13 2020, 3:48 PM

Change 605351 merged by jenkins-bot:
[mediawiki/core@master] Hard deprecate BaseTemplateToolbox hook

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

Jdlrobson closed this task as Resolved.Jun 13 2020, 3:49 PM
Jdlrobson updated the task description. (Show Details)
Maintenance_bot removed a project: Patch-For-Review.Jun 13 2020, 4:10 PM
Content licensed under Creative Commons Attribution-ShareAlike 3.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