Page MenuHomePhabricator

Rename "client preferences menu" to "appearances menu"
Closed, ResolvedPublic3 Estimated Story Points

Description

Description

Per Slack thread: https://wikimedia.slack.com/archives/G8QAPHCTT/p1712787742192229
The name is confusing when client prefs is the way we are saving preferences (similar to user preferences), and it is something that will be used for many things other than the "appearance" menu that contains theme, width, font size, etc. One example of this confusion is the vector-feature-client-prefs-pinned-clientpref-1 class

We want to change this before the release to anonymous users.

User story

No impact on end user. Improves developer experience and maintainability long term. Also aligns code with product naming convention

AC

  • Rename ClientPreference Feature flags and classes
  • Rename ClientPreferencePinned Feature flags and classes
  • Rename vector-client-prefs-pinned to vector-appearance-pinned

QA steps

On beta cluster (check the environment is ready with a developer before starting)

  • As logged in user, after disabling beta preference for Vector, I should not see the appearance menu in the UI
  • When beta feature is enabled the appearance menu should show.
  • check that you can pin the appearances menu. ON page refresh it should remain in the previous state you left it.
  • Refresh and confirm it is still pinned.
  • As anonymous user (using ?vectorappearance=1), check that you can pin the appearances menu. ON page refresh it should remain in the previous state you left it.
  • Unpin the menu and refresh.

Communication criteria - does this need an announcement or discussion?

no

QA Results - Beta

Event Timeline

@bwang to update task description to use new template

Change #1019142 had a related patch set uploaded (by Bernard Wang; author: Bernard Wang):

[mediawiki/skins/Vector@master] Rename client preference menu to appearance menu

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

bwang updated the task description. (Show Details)

Change #1023928 had a related patch set uploaded (by Bernard Wang; author: Bernard Wang):

[operations/mediawiki-config@master] Update wgVectorClientPrefs to wgVectorAppearance

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

Change #1019142 merged by jenkins-bot:

[mediawiki/skins/Vector@master] Rename client preference menu to appearance menu

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

Change #1025319 had a related patch set uploaded (by Jdlrobson; author: Bernard Wang):

[mediawiki/skins/Vector@wmf/1.42.0-wmf.2] Rename client preference menu to appearance menu

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

Change #1025319 abandoned by Jdlrobson:

[mediawiki/skins/Vector@wmf/1.42.0-wmf.2] Rename client preference menu to appearance menu

Reason:

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

Edtadros subscribed.

@Jdlrobson / @bwang / @KSarabia-WMF This passes.

Test Result - Beta

Status: ✅ PASS
Environment: beta
OS: macOS Sonoma
Browser: Chrome
Device: MBA
Emulated Device:NA

Test Artifact(s):

Test Steps

On beta cluster (check the environment is ready with a developer before starting)

✅ AC1: As logged in user, after disabling beta preference for Vector, I should not see the appearance menu in the UI

screenshot 272.png (1×1 px, 194 KB)

✅ AC2: When beta feature is enabled the appearance menu should show.

screenshot 271.png (1×1 px, 200 KB)

✅ AC3: check that you can pin the appearances menu.

screenshot 48.mov.gif (1×1 px, 730 KB)

✅ AC4: ON page refresh it should remain in the previous state you left it. Refresh and confirm it is still pinned.

screenshot 49.mov.gif (1×1 px, 1 MB)

✅ AC5: As anonymous user (using ?vectorappearance=1), check that you can pin the appearances menu.

screenshot 50.mov.gif (486×1 px, 433 KB)

✅ AC6: ON page refresh it should remain in the previous state you left it.

screenshot 51.mov.gif (486×1 px, 560 KB)

✅ AC7: Unpin the menu and refresh.

screenshot 52.mov.gif (486×1 px, 477 KB)

Edtadros updated the task description. (Show Details)
Jdlrobson updated the task description. (Show Details)