Page MenuHomePhabricator

Move ReferencePreviews related config flags to Cite's codebase
Closed, ResolvedPublic

Description

The Page-Previews extension currently manages a JS global wgPopupsFlags [1] that mainly holds data about settings related to the Reference Previews feature. The code now moved to the Cite extension and so most of these settings should be set there.

Implementation plan:

  • Add gadget detection [2] for ReferenceTooltips and NavigationPopups to Cite's codebase and disable the preview in these cases. ( Use the existing wgPopupsConflictingRefTooltipsGadgetName and wgPopupsConflictingNavPopupsGadgetName settings )
  • Move the code for detecting the user setting wgPopupsReferencePreviews to the Cite codebase. [3]
  • Create Cite specific copies for the relevant gadget and feature switch setting globals
  • Cleanup the settings and flag code in the Popups extension. Note, that the detection for NavigationPopups is still relevant for popups
  • Rename the wgPopupsConflictingRefTooltipsGadgetName config setting and move it to Cite [4]. It's only relevant for Reference Previews .
  • Remove irrelevant global config copies when changes are deployed on production.

Optional:

  • Migrate the popups-reference-previews user preference to cite-reference-previews, including renaming actual saved preferences.
  • Migrate the mwe-popups-referencePreviews-enabled anonymous preference in localStorage to mwe-cite-referencePreviews-enabled

Note:

  • We can use the onMakeGlobalVariablesScript hook to set JS vars where we need the user object like done in the Popups extension.

[1] https://gerrit.wikimedia.org/g/mediawiki/extensions/Popups/+/03449d1af07d25561d2abfeeff5763d5d3fad55e/includes/PopupsHooks.php#246
[2] https://gerrit.wikimedia.org/g/mediawiki/extensions/Popups/+/03449d1af07d25561d2abfeeff5763d5d3fad55e/includes/PopupsGadgetsIntegration.php
[3] https://gerrit.wikimedia.org/g/mediawiki/extensions/Popups/+/03449d1af07d25561d2abfeeff5763d5d3fad55e/includes/PopupsContext.php#152
[4] https://gerrit.wikimedia.org/g/mediawiki/extensions/Popups/+/03449d1af07d25561d2abfeeff5763d5d3fad55e/extension.json#74

Event Timeline

WMDE-Fisch renamed this task from Move ReferenceTooltips detection to Cite's ReferencePreviews to Move ReferencePreviews related config flags to Cite's codebase.Apr 18 2024, 10:39 AM
WMDE-Fisch updated the task description. (Show Details)

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

[mediawiki/extensions/Cite@master] Add ReferencePreviews config checks to Cite extension

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

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

[integration/config@master] Add Gadgets to Cite phan config

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

Change #1023117 merged by jenkins-bot:

[integration/config@master] Zuul: [mediawiki/extensions/Cite] Add Gadgets phan dependency

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

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

[integration/config@master] Zuul: [mediawiki/extensions/Cite] Add Gadgets as general dependency

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

Change #1023448 merged by jenkins-bot:

[integration/config@master] Zuul: [mediawiki/extensions/Cite] Add Gadgets as general dependency

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

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

[operations/mediawiki-config@master] Set conflicting gadget settings for the Cite extension

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

Change #1024345 merged by jenkins-bot:

[operations/mediawiki-config@master] Set conflicting gadget settings for the Cite extension

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

Mentioned in SAL (#wikimedia-operations) [2024-04-25T13:22:59Z] <cgoubert@deploy1002> Started scap: Backport for [[gerrit:1024345|Set conflicting gadget settings for the Cite extension (T362771)]]

Mentioned in SAL (#wikimedia-operations) [2024-04-25T13:26:17Z] <cgoubert@deploy1002> cgoubert and wmde-fisch: Backport for [[gerrit:1024345|Set conflicting gadget settings for the Cite extension (T362771)]] synced to the testservers (https://wikitech.wikimedia.org/wiki/Mwdebug)

Mentioned in SAL (#wikimedia-operations) [2024-04-25T13:44:33Z] <cgoubert@deploy1002> Finished scap: Backport for [[gerrit:1024345|Set conflicting gadget settings for the Cite extension (T362771)]] (duration: 21m 33s)

Change #1023115 merged by jenkins-bot:

[mediawiki/extensions/Cite@master] Add ReferencePreviews config checks to Cite extension

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

WMDE-Fisch changed the task status from Open to Stalled.Apr 26 2024, 10:49 AM

Waiting for 1.43.0-wmf.3 deployment for the next steps.

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

[mediawiki/extensions/Cite@master] Separate names for server-side vs. client-side feature flags

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

Change #1025702 merged by jenkins-bot:

[mediawiki/extensions/Cite@master] Separate names for server-side vs. client-side feature flags

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

WMDE-Fisch changed the task status from Stalled to Open.Jul 10 2024, 7:01 PM
WMDE-Fisch removed WMDE-Fisch as the assignee of this task.
awight updated the task description. (Show Details)
awight moved this task from Doing to Sprint Backlog on the WMDE-TechWish-Sprint-2024-07-10 board.
awight subscribed.

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

[mediawiki/extensions/Popups@master] Remove obsolete ReferenceTooltips gadget checks

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

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

[operations/mediawiki-config@master] [config] Rename moved gadget name setting

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

Change #1078461 merged by jenkins-bot:

[mediawiki/extensions/Popups@master] Remove obsolete ReferenceTooltips gadget checks

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

Change #1078463 merged by jenkins-bot:

[operations/mediawiki-config@master] [config] Rename moved gadget name setting

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

Mentioned in SAL (#wikimedia-operations) [2024-10-10T07:18:46Z] <awight@deploy2002> Started scap sync-world: Backport for [[gerrit:1078463|[config] Rename moved gadget name setting (T362771)]]

Mentioned in SAL (#wikimedia-operations) [2024-10-10T07:21:07Z] <awight@deploy2002> awight, wmde-fisch: Backport for [[gerrit:1078463|[config] Rename moved gadget name setting (T362771)]] synced to the testservers (https://wikitech.wikimedia.org/wiki/Mwdebug)

Mentioned in SAL (#wikimedia-operations) [2024-10-10T07:28:08Z] <awight@deploy2002> Finished scap sync-world: Backport for [[gerrit:1078463|[config] Rename moved gadget name setting (T362771)]] (duration: 09m 22s)

Rename the popups-reference-previews user preference to cite-reference-previews, including renaming actual saved preferences.

Not sure if we really bother doing that 🤔

Rename the popups-reference-previews user preference to cite-reference-previews, including renaming actual saved preferences.

Not sure if we really bother doing that 🤔

I'm not feeling the urge either, we got burned so many times trying to jiggle prefs in the past, and the framework has changed enough that many of our lessons learned are already irrelevant.

Change #1170736 had a related patch set uploaded (by Reedy; author: Reedy):

[operations/mediawiki-config@master] InitialiseSettings: Update comment about wgPopupsConflictingRefTooltipsGadgetName

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

Change #1170736 merged by jenkins-bot:

[operations/mediawiki-config@master] InitialiseSettings: Update comment about wgPopupsConflictingRefTooltipsGadgetName

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

Mentioned in SAL (#wikimedia-operations) [2025-11-11T21:00:57Z] <reedy@deploy2002> Started scap sync-world: Backport for [[gerrit:1129230|CommonSettings.php: Remove old $wgCentralDBname (T389348)]], [[gerrit:1170736|InitialiseSettings: Update comment about wgPopupsConflictingRefTooltipsGadgetName (T362771)]]

Mentioned in SAL (#wikimedia-operations) [2025-11-11T21:03:18Z] <reedy@deploy2002> reedy: Backport for [[gerrit:1129230|CommonSettings.php: Remove old $wgCentralDBname (T389348)]], [[gerrit:1170736|InitialiseSettings: Update comment about wgPopupsConflictingRefTooltipsGadgetName (T362771)]] synced to the testservers (see https://wikitech.wikimedia.org/wiki/Mwdebug). Changes can now be verified there.

Mentioned in SAL (#wikimedia-operations) [2025-11-11T21:07:57Z] <reedy@deploy2002> Finished scap sync-world: Backport for [[gerrit:1129230|CommonSettings.php: Remove old $wgCentralDBname (T389348)]], [[gerrit:1170736|InitialiseSettings: Update comment about wgPopupsConflictingRefTooltipsGadgetName (T362771)]] (duration: 07m 00s)