Page MenuHomePhabricator
Create Task
Maniphest T256509

Remove BaseTemplateToolbox hook
Closed, ResolvedPublic2 Estimated Story Points
Actions

Description

This hook was hard deprecated in 1.35 and we should look to remove it in 1.37
https://codesearch.wmflabs.org/search/?q=BaseTemplateToolbox&i=nope&files=&repos=

Also impacted:

Details

SubjectRepoBranchLines +/-
Remove BaseTemplateToolbox hookmediawiki/coremaster+3 -47
Remove usage of deprecated hook BaseTemplateToolboxmediawiki/extensions/BlueSpiceUEModuleHTMLmaster+0 -38
Remove usage of deprecated hook BaseTemplateToolboxmediawiki/extensions/BlueSpiceUEModuleHTMLREL1_35+0 -38
Switch BaseTemplateToolbox to SidebarBeforeOutput hook for MW 1.35+mediawiki/extensions/Mpdfmaster+40 -1
Customize query in gerrit

Related Objects
Search...

Event Timeline

Jdlrobson created this task.Jun 26 2020, 9:50 PM
Restricted Application added a project: Performance-Team. · View Herald TranscriptJun 26 2020, 9:50 PM
Jdlrobson added a project: MediaWiki-Core-Skin-Architecture.Jun 26 2020, 9:50 PM
Jdlrobson moved this task from Backlog to Milestone: More flexibility in article heading area (subpages, descriptions) on the MediaWiki-Core-Skin-Architecture board.Jun 26 2020, 9:56 PM
Jdlrobson mentioned this in T253809: [EPIC] Deprecate the BaseTemplate hooks.
Yaron_Koren subscribed.Jun 26 2020, 10:12 PM

Could someone update this page?

https://www.mediawiki.org/wiki/Manual:Hooks/BaseTemplateToolbox

It would be especially good to know what is meant to be used instead of this hook.

DannyS712 moved this task from Blocker to To deprecate or remove on the MW-1.36-release board.Jun 26 2020, 10:50 PM
Krinkle subscribed.Jun 27 2020, 2:03 AM

See also the doxygen pages in the new hook system, which does not yet have a migration note (doc.wm.o link). This would normally be provided a line of text via the @deprecated annotation.

• Gilles removed projects: MediaWiki-extensions-PerformanceInspector, Performance-Team.Jun 29 2020, 8:05 PM
gerritbot added a comment.Jun 29 2020, 8:48 PM

Change 608245 had a related patch set uploaded (by Yaron Koren; owner: Yaron Koren):
[mediawiki/extensions/Mpdf@master] Switch BaseTemplateToolbox to SidebarBeforeOutput hook for MW 1.35+

https://gerrit.wikimedia.org/r/c/mediawiki/extensions/Mpdf/ /608245

gerritbot added a project: Patch-For-Review.Jun 29 2020, 8:48 PM
Jdlrobson moved this task from Milestone: More flexibility in article heading area (subpages, descriptions) to Phase 2 - Deprecate and remove Skin methods for readability on the MediaWiki-Core-Skin-Architecture board.Jun 29 2020, 11:22 PM
gerritbot added a comment.Jun 30 2020, 6:53 PM

Change 608245 merged by jenkins-bot:
[mediawiki/extensions/Mpdf@master] Switch BaseTemplateToolbox to SidebarBeforeOutput hook for MW 1.35+

https://gerrit.wikimedia.org/r/c/mediawiki/extensions/Mpdf/ /608245

Yaron_Koren mentioned this in rEMPD5e49ebadd8ea: Switch BaseTemplateToolbox to SidebarBeforeOutput hook for MW 1.35+.Jun 30 2020, 8:08 PM
Yaron_Koren added a comment.Jun 30 2020, 8:28 PM

@Jdlrobson - thanks for updating the wiki page.

I believe this is now fixed for the Cargo and Mpdf extensions. They both still use the BaseTemplateToolbox hook, but only for versions of MediaWiki below 1.35.

Jdlrobson removed projects: Patch-For-Review, MediaWiki-extensions-Cargo.Jun 30 2020, 8:42 PM

Thanks @Yaron_Koren ! LGTM and thank you for migrating!

Jdlrobson updated the task description. (Show Details)Jun 30 2020, 8:43 PM
Jdlrobson triaged this task as Medium priority.Sep 4 2020, 9:28 PM
Jdlrobson added a project: MediaWiki-extensions-PerformanceInspector.Oct 29 2020, 5:06 PM
Jdlrobson updated the task description. (Show Details)Oct 29 2020, 5:09 PM
Jdlrobson moved this task from Phase 2 - Deprecate and remove Skin methods for readability to It's complicated on the MediaWiki-Core-Skin-Architecture board.
gerritbot added a comment.Nov 4 2020, 5:05 PM

Change 639208 had a related patch set uploaded (by Pwirth; owner: Pwirth):
[mediawiki/extensions/BlueSpiceUEModuleHTML@REL1_35] Replace usage of deprecated hook BaseTemplateToolbox

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

gerritbot added a project: Patch-For-Review.Nov 4 2020, 5:05 PM
gerritbot added a comment.Nov 27 2020, 7:11 AM

Change 639208 merged by jenkins-bot:
[mediawiki/extensions/BlueSpiceUEModuleHTML@REL1_35] Remove usage of deprecated hook BaseTemplateToolbox

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

gerritbot added a comment.Nov 27 2020, 7:13 AM

Change 643817 had a related patch set uploaded (by Robert Vogel; owner: Pwirth):
[mediawiki/extensions/BlueSpiceUEModuleHTML@master] Remove usage of deprecated hook BaseTemplateToolbox

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

gerritbot added a comment.Nov 27 2020, 7:18 AM

Change 643817 merged by jenkins-bot:
[mediawiki/extensions/BlueSpiceUEModuleHTML@master] Remove usage of deprecated hook BaseTemplateToolbox

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

Maintenance_bot removed a project: Patch-For-Review.Nov 27 2020, 8:10 AM
Osnard mentioned this in rECRC3916cc5cee56: Remove usage of deprecated hook BaseTemplateToolbox.Nov 27 2020, 8:31 AM
Jdlrobson removed projects: MediaWiki-extensions-MassEditRegex, BlueSpice.Dec 2 2020, 5:55 PM
Jdlrobson updated the task description. (Show Details)

4 known usages remain.

Jdlrobson added a subscriber: Kizule.Feb 3 2021, 8:38 PM

@Kizule I recommend using https://www.mediawiki.org/wiki/Manual:Hooks/SidebarBeforeOutput for VirtualKeyboard.

Kizule added a comment.Feb 3 2021, 8:40 PM
In T256509#6801833, @Jdlrobson wrote:

@Kizule I recommend using https://www.mediawiki.org/wiki/Manual:Hooks/SidebarBeforeOutput for VirtualKeyboard.

VirtualKeyboard will be archived, see T273801.

Jdlrobson added a comment.Feb 3 2021, 9:00 PM

Thanks for the update!

Kizule added projects: BlueSpice, MediaWiki-extensions-MassEditRegex.Feb 3 2021, 9:05 PM
Jdlrobson edited projects, added MW-1.37-release; removed MediaWiki-extensions-MassEditRegex, MW-1.36-release.Mar 16 2021, 8:20 PM
Jdlrobson updated the task description. (Show Details)
Jdlrobson moved this task from It's complicated to Milestone: Code removed for 1.37 on the MediaWiki-Core-Skin-Architecture board.Apr 20 2021, 12:25 AM
Mainframe98 updated the task description. (Show Details)Jun 16 2021, 10:02 AM
DannyS712 moved this task from Blocker to To deprecate or remove on the MW-1.37-release board.Jul 7 2021, 10:21 PM
Jdlrobson added a comment.Jul 13 2021, 11:25 PM

Note this will be removed within the next 2 weeks.

Jdlrobson added a project: Web-Team-Backlog.Jul 13 2021, 11:25 PM
Jdlrobson moved this task from Incoming to unsed on the Web-Team-Backlog board.
Jdlrobson moved this task from unsed to Kanbanana-FY-2020-21 on the Web-Team-Backlog board.Jul 14 2021, 3:36 PM
Jdlrobson edited projects, added Web-Team-Backlog (Kanbanana-FY-2020-21); removed Web-Team-Backlog.
Jdlrobson moved this task from Needs Analysis to Upcoming on the Web-Team-Backlog (Kanbanana-FY-2020-21) board.
LGoto set the point value for this task to 2.Jul 20 2021, 5:09 PM
LGoto moved this task from Upcoming to Ready for Development on the Web-Team-Backlog (Kanbanana-FY-2020-21) board.
Jdlrobson added a parent task: T282045: [GOAL] Deprecate and remove skin code in preparation for 1.37.Jul 27 2021, 3:29 PM
cjming claimed this task.Jul 27 2021, 5:02 PM
cjming moved this task from Ready for Development to Doing on the Web-Team-Backlog (Kanbanana-FY-2020-21) board.
gerritbot added a comment.Jul 28 2021, 9:12 PM

Change 708593 had a related patch set uploaded (by Clare Ming; author: Clare Ming):

[mediawiki/core@master] Remove BaseTemplateToolbox hook

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

gerritbot added a project: Patch-For-Review.Jul 28 2021, 9:12 PM
cjming removed cjming as the assignee of this task.Jul 28 2021, 9:14 PM
cjming moved this task from Doing to Code Review on the Web-Team-Backlog (Kanbanana-FY-2020-21) board.
cjming subscribed.
Jdlrobson moved this task from Code Review to Needs More Work on the Web-Team-Backlog (Kanbanana-FY-2020-21) board.Jul 28 2021, 9:35 PM
cjming moved this task from Needs More Work to Code Review on the Web-Team-Backlog (Kanbanana-FY-2020-21) board.Jul 28 2021, 9:43 PM
Jdlrobson mentioned this in T287643: Update third-party extensions to not use BaseTemplateToolbox hook.Jul 28 2021, 9:58 PM
Jdlrobson removed projects: BlueSpice, MediaWiki-extensions-PerformanceInspector, ArticleRatings, MediaWiki-extensions-ParserMigration.

Created T287643 to capture the problem for extensions.

gerritbot added a comment.Jul 28 2021, 10:27 PM

Change 708593 merged by jenkins-bot:

[mediawiki/core@master] Remove BaseTemplateToolbox hook

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

Jdlrobson moved this task from Code Review to Ready for Signoff on the Web-Team-Backlog (Kanbanana-FY-2020-21) board.Jul 28 2021, 10:51 PM
ReleaseTaggerBot added a project: MW-1.37-notes (1.37.0-wmf.17; 2021-08-02).Jul 28 2021, 11:00 PM
Maintenance_bot removed a project: Patch-For-Review.Jul 28 2021, 11:10 PM
LGoto assigned this task to • nray.Jul 29 2021, 5:07 PM
• nray closed this task as Resolved.Jul 29 2021, 10:11 PM
• nray reassigned this task from • nray to cjming.
• nray subscribed.
alex-mashin subscribed.Aug 15 2021, 7:51 AM

It seems that this hook is already gone from MediaWiki 1.35, in spite of being documented as deprecated. The extension PerformanceInspector does not work under PHP 1.35.3 because PerformanceInspectorHooks::onBaseTemplateToolbox is never called, despite having "BaseTemplateToolbox": [ "PerformanceInspectorHooks::onBaseTemplateToolbox" ], in extension.json.

Jdlrobson added a comment.Aug 15 2021, 5:42 PM
In T256509#7283446, @alex-mashin wrote:

It seems that this hook is already gone from MediaWiki 1.35, in spite of being documented as deprecated. The extension PerformanceInspector does not work under PHP 1.35.3 because PerformanceInspectorHooks::onBaseTemplateToolbox is never called, despite having "BaseTemplateToolbox": [ "PerformanceInspectorHooks::onBaseTemplateToolbox" ], in extension.json.

The hook was always skin specific. It's called in 1.35 but only in skins using BaseTemplate which was why it was deprecated. I suspect it works fine in Monobook skin in 1.35 for example?

See https://phabricator.wikimedia.org/T253686 for performance inspector which is not going to be fixed apparently.

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