Page MenuHomePhabricator

Drop support for addPortletLink with #p-namespaces in Vector 2022 skin
Closed, ResolvedPublic1 Estimated Story Points

Description

IN T313409 we added code to support backwards compatibility with gadgets adding portlet links to #p-namespaces and set the intention this would be removed in MediaWiki 1.40. That deadline has long passed and we are now starting to see visual issues with code using the backwards compatibility method.

Per https://www.mediawiki.org/w/index.php?title=Stable_interface_policy/Frontend&safemode=1#How_providers_should_communicate_changes_to_consumers we're now removing that support.

After this change, impacted gadgets and user scripts will stop appending links alongside the talk and article tabs in Vector 2022 and may throw JavaScript errors if the return value of addPortletLink has not been checked. We will patch any issues that arise due to the latter.

Migration notes

Before:

mw.util.addPortletLink('p-namespaces', '#', 'text')

After:

var link = mw.util.addPortletLink('p-namespaces', '#', 'text');
if (!link) {
  mw.util.addPortletLink('p-associated-pages', '#', 'text')
}

Event Timeline

Change 962699 had a related patch set uploaded (by Jdlrobson; author: Jdlrobson):

[mediawiki/skins/Vector@master] Drop p-namespaces backwards compatibility script

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

Re: Tech News - What wording would you suggest as the content, and when will the change go into effect? I'm unsure how to summarize. Thanks!

Editors should be on the lookout for tools that appear beside talk tab missing. In the event these break please direct your technical editors to this phabricator ticket.

I'd like to include the context so that it might act as a memory-aid. Would something like this be accurate?

Code related to addPortletLink and #p-namespaces that was deprecated last year is now being removed. If you notice tools that should appear next to the "Discussion" tab are now missing, please tell the gadget's maintainers to see instructions in the Phabricator task.

And when is the change planned? (So that we can tweak "is now being removed" to either "is being removed [this/next] week" or similar.) Thanks.

I'd like to include the context so that it might act as a memory-aid. Would something like this be accurate?

Code related to addPortletLink and #p-namespaces that was deprecated last year is now being removed. If you notice tools that should appear next to the "Discussion" tab are now missing, please tell the gadget's maintainers to see instructions in the Phabricator task.

And when is the change planned? (So that we can tweak "is now being removed" to either "is being removed [this/next] week" or similar.) Thanks.

Maybe it'd be good to mention that the removal applies only to Vector 2022?

Ok, so a complete draft could be (please improve this if possible, or correct any inaccuracies or missing details ):

Future changes

  • In 2 weeks, in the Vector 2022 skin, code related to addPortletLink and #p-namespaces that was deprecated one year ago will be removed. If you notice tools that should appear next to the "Discussion" tab are then missing, please tell the gadget's maintainers to see instructions in the Phabricator task.
ovasileva set the point value for this task to 1.Oct 12 2023, 5:35 PM

(Forgot that a user notice went out about this - should probably be in sprint 2 but maybe low priority)

@Mabualruz to review , plan to backport this week

Change 962699 merged by jenkins-bot:

[mediawiki/skins/Vector@master] Drop p-namespaces backwards compatibility script

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

Edtadros subscribed.

Need some test steps please.

No QA needed here, as we're intentionally breaking/removing support.