Page MenuHomePhabricator

Merge jquery.cookie and mediawiki.cookie modules
Closed, ResolvedPublic

Description

The jquery.cookie and mediawiki.cookie scripts are both quite small. Both separately and combined, they don't really make sense to me to register as their own top-level bundle. But at least as a first step we can combine the two.

This would also be a good time to acknowledge the fact that we have forked jquery-cookie (ref change 655719), and clean up and simplify the code to align with our current best practices.

jquery.cookie can be an alias for mediawiki.cookie, to be removed once core and bundled/wmf exensions have migrated.

Although we don't yet have a deprecation policy for modules and other frontend code, it seems fair that given its widespread use, we should keep the alias in at least one stable release. We'll also want to notify Tech News and perhaps wait for, or help make happen, a tourbot to fix the majority of simple gadget dependencies and mw.loader calls.

This migration can already start today because mediawiki.cookie naturally depends on (and thus provides) jquery.cookie.

NOTE: We are not deprecating $.cookie. This function will continue to be provided as a low-level interface for direct cookie reads. Use of the higher-level mw.cookie interface is and remains completely optional. This task is about the bundle in which these JavaScript codes are delived from the server to the browser. The module name jquery.cookie will deprecated once its contents have been merged into mediawiki.cookie.

Event Timeline

Change 876272 had a related patch set uploaded (by Legoktm; author: Legoktm):

[mediawiki/core@master] Merge "jquery.cookie" into "mediawiki.cookie"

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

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

[mediawiki/core@master] Make jquery.cookie not depend on jquery

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

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

[mediawiki/core@master] Decouple jquery convenience functions from mediawiki.cookie

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

Change 876272 merged by jenkins-bot:

[mediawiki/core@master] Merge "jquery.cookie" into "mediawiki.cookie"

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

Change 909399 abandoned by Jdlrobson:

[mediawiki/core@master] Decouple jquery convenience functions from mediawiki.cookie

Reason:

merged into https://gerrit.wikimedia.org/r/c/mediawiki/core/+/908933

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

Change 908933 merged by jenkins-bot:

[mediawiki/core@master] mediawiki.cookie: Factor out internal jar interface from $.cookie

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

@Jdlrobson Do you want to do the honours on updating gadget and user script references to load the mediawiki.cookie module instead?

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

[mediawiki/skins/MinervaNeue@master] jquery.cookie is deprecated

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

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

[mediawiki/extensions/WikiEditor@master] jquery.cookie is deprecated

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

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

[mediawiki/extensions/DismissableSiteNotice@master] jquery.cookie is deprecated

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

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

[mediawiki/extensions/CentralNotice@master] jquery.cookie is deprecated

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

Change 919908 merged by jenkins-bot:

[mediawiki/extensions/DismissableSiteNotice@master] jquery.cookie is deprecated

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

Change 919907 merged by jenkins-bot:

[mediawiki/extensions/WikiEditor@master] jquery.cookie is deprecated

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

Change 919909 merged by jenkins-bot:

[mediawiki/extensions/CentralNotice@master] jquery.cookie is deprecated

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

Change 919906 merged by jenkins-bot:

[mediawiki/skins/MinervaNeue@master] jquery.cookie is deprecated

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

All MediaWiki:Gadget-definitions have been updated so we are good to remove this now.

Presumably for third parties we should leave the deprecation for one release. Would it make sense to backport https://gerrit.wikimedia.org/r/909399 to 1.40 so we can remove it now?

Jdlrobson changed the task status from Open to Stalled.Jun 9 2023, 6:15 PM

Blocked until MediaWiki 1.42.0

Actually, let's do this instead: T338637
This bit is done.

Change 995439 had a related patch set uploaded (by Jack Phoenix; author: Jack Phoenix):

[mediawiki/extensions/ArticleFeedbackv5@master] Swap uses of the deprecated RL module (alias) jquery.cookie to mediawiki.cookie

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

Change 995439 merged by jenkins-bot:

[mediawiki/extensions/ArticleFeedbackv5@master] Swap uses of the deprecated RL module (alias) jquery.cookie to mediawiki.cookie

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