Create API for client side preference manipulation
Closed, ResolvedPublic5 Estimated Story PointsFeature
Actions

Assigned To

Authored By

	Jdlrobson
	Jul 12 2023, 7:33 PM

Description

Feature summary (what you would like to be able to do and where):

In T339268 we propose an inline script to replace the existing system and support multiple client preferences.

This needs to be complemented by a client API inside mediawiki core

todo

The new API should make use of tulle existing mediawiki.user module
The new API should match the proposal in the decision record.
Vector should use the new API

QA Steps

Go to https://en.wikipedia.beta.wmflabs.org/wiki/Spain in an incognito window
Run mw.user.clientPrefs.set('vector-feature-limited-width', '0') in JS console. It should visually resize the article and return true.
Run `mw.user.clientPrefs.set('vector-feature-limited-width', '1') in JS it should restore the article and return true
Run mw.user.clientPrefs.set('vector-feature-darkfoo', '1' ) in JS is should return false.

QA Results - Beta

AC	Status	Details
1	✅	T341720
2	✅	T341720
3	✅	T341720

Details

	Subject	Repo	Branch	Lines +/-
	Add API for client side preferences	mediawiki/core	master	+101 -0
	core - client side preferences inline script	mediawiki/core	master	+248 -10

Customize query in gerrit

Related Objects
Search...

Status	Subtype	Assigned	Task
Open		Jdrewniak	T341631 [EPIC] Q1 Main hypothesis: Typographical and palette customizations
Resolved		ovasileva	T333867 TDMP Proposal: Preference Persistence For Anonymous Users
Resolved		Jdlrobson	T333883 [EPIC] Post-TDMP : Implement Anonymous Preference Persistence API
Resolved	Feature	Jdlrobson	T341720 Create API for client side preference manipulation

Event Timeline

Jdlrobson created this task.Jul 12 2023, 7:33 PM

Restricted Application added a subscriber: Aklapper. · View Herald TranscriptJul 12 2023, 7:33 PM

Jdlrobson triaged this task as Medium priority.Jul 12 2023, 7:34 PM

Jdlrobson added a parent task: T333883: [EPIC] Post-TDMP : Implement Anonymous Preference Persistence API.

Jdlrobson updated the task description. (Show Details)

Jdlrobson moved this task from Incoming to Current Fiscal Year on the Web-Team-Backlog board.

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

[mediawiki/core@master] Add API for client side preferences

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

gerritbot added a project: Patch-For-Review.Jul 20 2023, 12:36 AM

Jdlrobson mentioned this in T336713: Diff-type preference: save diff-type user selection as a preference.Jul 20 2023, 12:40 AM

ovasileva set the point value for this task to 5.Jul 31 2023, 5:35 PM

ovasileva edited projects, added Web-Team-Backlog (Web Team FY2023-24 Q1 Sprint 3); removed Web-Team-Backlog.

ovasileva moved this task from Incoming to Ready for Development on the Web-Team-Backlog (Web Team FY2023-24 Q1 Sprint 3) board.

Jdlrobson moved this task from Ready for Development to Blocked on Others on the Web-Team-Backlog (Web Team FY2023-24 Q1 Sprint 3) board.Jul 31 2023, 5:59 PM

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

[mediawiki/core@master] core - client side preferences inline script

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

Jdlrobson assigned this task to Mabualruz.Aug 2 2023, 6:37 PM

Jdlrobson moved this task from Blocked on Others to Doing on the Web-Team-Backlog (Web Team FY2023-24 Q1 Sprint 3) board.

Mabualruz moved this task from Doing to Code Review on the Web-Team-Backlog (Web Team FY2023-24 Q1 Sprint 3) board.Aug 3 2023, 11:58 AM

Jdlrobson claimed this task.Aug 3 2023, 8:22 PM

Jdlrobson added a subscriber: Mabualruz.

Jdlrobson reassigned this task from Jdlrobson to Catrope.Aug 4 2023, 12:19 AM

Jdlrobson moved this task from Code Review to Blocked on Others on the Web-Team-Backlog (Web Team FY2023-24 Q1 Sprint 3) board.

Change 932819 merged by jenkins-bot:

[mediawiki/core@master] core - client side preferences inline script

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

Jdlrobson moved this task from Blocked on Others to QA on the Web-Team-Backlog (Web Team FY2023-24 Q1 Sprint 3) board.Aug 8 2023, 1:25 AM

ReleaseTaggerBot added a project: MW-1.41-notes (1.41.0-wmf.22; 2023-08-15).Aug 8 2023, 2:00 AM

Hey @Mhurd adding you since @Edtadros is winding down. Feel free to reassign to George if they'll be handling QA.

Jdlrobson updated the task description. (Show Details)Aug 8 2023, 6:25 PM

GMikesell-WMF claimed this task.Aug 10 2023, 4:15 PM

Status: ✅ PASS
Environment: Beta
OS: macOS Ventura, Windows 11
Browser: Chrome 116, FireFox 115, Edge 115, Safari 16.5
Device: MBP
Emulated Device:BrowserStack for Windows 11
Test Links: https://en.wikipedia.beta.wmflabs.org/wiki/Spain

✅AC1: mw.user.clientPrefs.set('vector-feature-limited-width', '0') in JS console. It should visually resize the article and return true.

T341720_CoreSkin_PreferenceManipulation_ApiVector1.png (1×3 px, 431 KB)

✅AC2: mw.user.clientPrefs.set('vector-feature-limited-width', '1') in JS it should restore the article and return true

T341720_CoreSkin_PreferenceManipulation_ApiVector2.png (1×3 px, 414 KB)

✅AC3: mw.user.clientPrefs.set('vector-feature-darkfoo', '1' ) in JS is should return false.

T341720_CoreSkin_PreferenceManipulation_ApiVector3.png (1×3 px, 425 KB)

Same as above with the different browsers.

FireFox	Safari	Edge

GMikesell-WMF removed GMikesell-WMF as the assignee of this task.Aug 10 2023, 6:29 PM

GMikesell-WMF updated the task description. (Show Details)

GMikesell-WMF moved this task from QA to Ready for Signoff on the Web-Team-Backlog (Web Team FY2023-24 Q1 Sprint 3) board.

GMikesell-WMF subscribed.

Jdlrobson claimed this task.Aug 11 2023, 6:52 PM

Thanks all!

Lens0021 awarded a token.Aug 18 2023, 11:27 PM

Change 939782 abandoned by Jdlrobson:

[mediawiki/core@master] Add API for client side preferences

Reason:

Done in a9045f21f7d9