Page MenuHomePhabricator
Create Task
Maniphest T322051

[L] [Page Tools] Set default for pinnable state
Closed, ResolvedPublic1 Estimated Story Points
Actions

Assigned To
ovasileva
Authored By
ovasileva
Oct 31 2022, 5:31 PM
Tags
Referenced Files
F35874748: Screenshot 2022-12-18 at 1.51.49 PM.png
Dec 18 2022, 9:52 PM
F35874746: Screen Recording 2022-12-18 at 1.49.44 PM.mov.gif
Dec 18 2022, 9:52 PM
F35874736: Screenshot 2022-12-18 at 1.47.07 PM.png
Dec 18 2022, 9:48 PM
F35874734: Screen Recording 2022-12-18 at 1.45.10 PM.mov.gif
Dec 18 2022, 9:48 PM
F35874732: Screen Recording 2022-12-18 at 1.44.37 PM.mov.gif
Dec 18 2022, 9:48 PM
F35874728: Screen Recording 2022-12-18 at 1.42.39 PM.mov.gif
Dec 18 2022, 9:48 PM
F35874730: Screen Recording 2022-12-18 at 1.41.27 PM.mov.gif
Dec 18 2022, 9:48 PM
F35874726: Screenshot 2022-12-18 at 1.40.47 PM.png
Dec 18 2022, 9:48 PM
Subscribers
Aklapper
• alexhollender_WMF
AntiCompositeNumber
bwang
Edtadros
Jdlrobson
MusikAnimal
View All 10 Subscribers

Description

Background

We would like to set different defaults for the page tools menu

Acceptance criteria

  • Logged out users will not have the ability to pin the page tools open (Pinnable header should be hidden)
  • Logged out users will see the page tools menu as default dropdown
  • Logged-in users will see the page tools menu as default pinned
  • Make pinning/unpinning behavior persistent for logged-in users
  • Cumulative layout shift and last visual change metrics should not be affected by this change (e.g. we should not rely on JS to render the page tools into the correct position on page load)

QA

Pinned/Unpinned state persists while logged-in

  1. Login and visit https://en.wikipedia.beta.wmflabs.org/wiki/Dog?vectorpagetools=1
  2. Verify that page tools is visible in the right sidebar
  3. Click the "hide" button in page tools
  4. Verify that the page tools moves to the page toolbar
  5. Refresh the page
  6. Verify that the page tools remains in the page toolbar
  7. Toggle the page tools to make the menu visible and click the "move to sidebar" button
  8. Verify that the page tools moves to the right sidebar
  9. Refresh the page
  10. Verify that page tools remains in the right sidebar

Page tools is in the page toolbar when anonymous and is not pinnable

  1. Logout and visit https://en.wikipedia.beta.wmflabs.org/wiki/Dog?vectorpagetools=1
  2. Verify that page tools is visible in the page toolbar
  3. Toggle the page tools to make the menu visible and verify that the "move to sidebar" button is not visible

QA Results - Beta

ACStatusDetails
1✅T322051#8476711
2✅T322051#8476711
3✅T322051#8476711
4✅T322051#8476711
5✅T322051#8476711
6✅T322051#8476711
7✅T322051#8476711

QA Results - Prod

ACStatusDetails
1✅T322051#8476713
2✅T322051#8476713
3✅T322051#8476713
4✅T322051#8476713
5✅T322051#8476713
6✅T322051#8476713
7✅T322051#8476713

Details

SubjectRepoBranchLines +/-
Set default pinnable state for page toolsmediawiki/skins/Vectormaster+237 -27
Move limitedWidthToggle.js and features.js to skins.vector.es6 modulemediawiki/skins/Vectormaster+17 -17
Convert LimitedWidthRequirement to UserPreferenceRequirementmediawiki/skins/Vectormaster+111 -21
Customize query in gerrit

Related Objects
Search...

Event Timeline

ovasileva created this task.Oct 31 2022, 5:31 PM
Restricted Application removed a project: Patch-For-Review. · View Herald TranscriptOct 31 2022, 5:31 PM
ovasileva triaged this task as High priority.Oct 31 2022, 5:32 PM
ovasileva moved this task from Needs Analysis to Upcoming on the Web-Team-Backlog (Kanbanana-2022-23-Q2) board.
ovasileva moved this task from Upcoming to Needs Analysis on the Web-Team-Backlog (Kanbanana-2022-23-Q2) board.Oct 31 2022, 5:40 PM
Jdlrobson set the point value for this task to 1.Oct 31 2022, 5:40 PM
LGoto assigned this task to • nray.Oct 31 2022, 5:40 PM
LGoto removed the point value for this task.
Jdlrobson set the point value for this task to 1.Oct 31 2022, 5:41 PM
• nray updated the task description. (Show Details)Oct 31 2022, 7:14 PM
Quiddity unsubscribed.Oct 31 2022, 8:22 PM
• nray updated the task description. (Show Details)Oct 31 2022, 9:47 PM
Nux unsubscribed.Nov 2 2022, 6:02 PM
gerritbot added a comment.Nov 15 2022, 2:26 AM

Change 856718 had a related patch set uploaded (by Nray; author: Nray):

[mediawiki/skins/Vector@master] POC: Set default pinnable state for page tools

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

gerritbot added a project: Patch-For-Review.Nov 15 2022, 2:26 AM
gerritbot added a comment.Nov 15 2022, 2:33 AM

Change 856718 abandoned by Nray:

[mediawiki/skins/Vector@master] POC: Set default pinnable state for page tools

Reason:

POC only

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

• nray removed • nray as the assignee of this task.Nov 15 2022, 2:33 AM
• nray moved this task from Needs Analysis to Upcoming on the Web-Team-Backlog (Kanbanana-2022-23-Q2) board.
gerritbot added a comment.Nov 15 2022, 5:47 PM

Change 856718 restored by Nray:

[mediawiki/skins/Vector@master] POC: Set default pinnable state for page tools

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

gerritbot added a comment.Nov 15 2022, 5:47 PM

Change 856718 abandoned by Nray:

[mediawiki/skins/Vector@master] POC: Set default pinnable state for page tools

Reason:

POC Only

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

ovasileva updated the task description. (Show Details)Nov 15 2022, 6:18 PM
LGoto renamed this task from [Page Tools] Set default for pinnable state to [L] [Page Tools] Set default for pinnable state.Nov 15 2022, 6:20 PM
LGoto updated the task description. (Show Details)
LGoto moved this task from Upcoming to Ready for Development on the Web-Team-Backlog (Kanbanana-2022-23-Q2) board.
• nray moved this task from Ready for Development to Doing on the Web-Team-Backlog (Kanbanana-2022-23-Q2) board.Nov 15 2022, 6:46 PM
• nray claimed this task.Nov 15 2022, 6:54 PM
• nray updated the task description. (Show Details)
• nray updated the task description. (Show Details)Nov 15 2022, 7:22 PM
gerritbot added a comment.Nov 18 2022, 5:11 PM

Change 856718 restored by Nray:

[mediawiki/skins/Vector@master] POC: Set default pinnable state for page tools

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

• nray added a comment.Nov 19 2022, 12:46 AM

I wanted to provide an update on this as I am OOO all of next week (starting Nov 21):

I have a work in progress patch that leverages our feature manager to handle the persistent pinning behavior of the page tools. It needs cleanup and tests, but is working. When I return, I plan to split it up into smaller patches and clean it up!

LGoto moved this task from Doing to Blocked on Others on the Web-Team-Backlog (Kanbanana-2022-23-Q2) board.Nov 21 2022, 6:40 PM
Jdlrobson moved this task from Blocked on Others to Doing on the Web-Team-Backlog (Kanbanana-2022-23-Q2) board.Nov 28 2022, 5:15 PM
• nray moved this task from Doing to Code Review on the Web-Team-Backlog (Kanbanana-2022-23-Q2) board.Nov 29 2022, 5:55 PM
• nray added a comment.Nov 29 2022, 5:57 PM

I've moved this to code review to get some early feedback on the approach (please see comments on the patch) before I spend time splitting up the patch and adding tests.

• nray removed • nray as the assignee of this task.Nov 29 2022, 5:57 PM
Jdlrobson claimed this task.Nov 29 2022, 6:35 PM
Jdlrobson reassigned this task from Jdlrobson to • nray.Nov 29 2022, 9:55 PM
Jdlrobson moved this task from Code Review to Doing on the Web-Team-Backlog (Kanbanana-2022-23-Q2) board.
• nray added a comment.Nov 29 2022, 10:56 PM

thank you @Jdlrobson !

gerritbot added a comment.Dec 1 2022, 8:51 PM

Change 863029 had a related patch set uploaded (by Nray; author: Nray):

[mediawiki/skins/Vector@master] Convert LimitedWidthRequirement to UserPreferenceRequirement

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

Jdlrobson mentioned this in T321745: [Unplanned] Vector 2022 sidebar is automatically collapsed on exactly 1000px breakpoint.Dec 1 2022, 9:20 PM
gerritbot added a comment.Dec 1 2022, 11:50 PM

Change 863029 merged by jenkins-bot:

[mediawiki/skins/Vector@master] Convert LimitedWidthRequirement to UserPreferenceRequirement

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

ReleaseTaggerBot added a project: MW-1.40-notes (1.40.0-wmf.13; 2022-12-05).Dec 2 2022, 12:01 AM
• nray removed • nray as the assignee of this task.Dec 6 2022, 4:01 PM
• nray moved this task from Doing to Code Review on the Web-Team-Backlog (Kanbanana-2022-23-Q2) board.
• nray added a comment.Dec 6 2022, 8:11 PM

Patch is at https://gerrit.wikimedia.org/r/c/mediawiki/skins/Vector/+/856718

• nray claimed this task.Dec 7 2022, 5:41 PM
• nray moved this task from Code Review to Doing on the Web-Team-Backlog (Kanbanana-2022-23-Q2) board.
gerritbot added a comment.Dec 7 2022, 10:29 PM

Change 865786 had a related patch set uploaded (by Nray; author: Nray):

[mediawiki/skins/Vector@master] Move limitedWidthToggle.js and features.js to skins.vector.es6 module

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

• nray moved this task from Doing to Code Review on the Web-Team-Backlog (Kanbanana-2022-23-Q2) board.EditedDec 7 2022, 10:30 PM

Moving this to code review for review of:

• nray removed • nray as the assignee of this task.Dec 7 2022, 11:57 PM
gerritbot added a comment.Dec 8 2022, 12:12 AM

Change 865786 merged by jenkins-bot:

[mediawiki/skins/Vector@master] Move limitedWidthToggle.js and features.js to skins.vector.es6 module

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

ReleaseTaggerBot edited projects, added MW-1.40-notes (1.40.0-wmf.14; 2022-12-12); removed MW-1.40-notes (1.40.0-wmf.13; 2022-12-05).Dec 8 2022, 1:01 AM
• nray claimed this task.Dec 8 2022, 6:09 PM
• nray moved this task from Code Review to Doing on the Web-Team-Backlog (Kanbanana-2022-23-Q2) board.
• nray removed • nray as the assignee of this task.Dec 8 2022, 9:36 PM
• nray moved this task from Doing to Code Review on the Web-Team-Backlog (Kanbanana-2022-23-Q2) board.
gerritbot added a comment.Dec 9 2022, 1:53 AM

Change 856718 merged by jenkins-bot:

[mediawiki/skins/Vector@master] Set default pinnable state for page tools

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

• nray assigned this task to Edtadros.Dec 9 2022, 5:06 PM
• nray moved this task from Code Review to QA on the Web-Team-Backlog (Kanbanana-2022-23-Q2) board.
• nray updated the task description. (Show Details)Dec 9 2022, 5:22 PM
• nray updated the task description. (Show Details)
• nray updated the task description. (Show Details)
Jdlrobson added a subtask: T324874: [subtask] Drop table of contents A/B test code.Dec 9 2022, 11:00 PM
Jdlrobson mentioned this in T324877: Style the page tools and main menu dropdown feature.Dec 10 2022, 12:01 AM
• nray added a comment.Dec 10 2022, 12:55 AM

@ovasileva One question that came out of code review is whether we are planning to also add pinning persistence for the table of contents? Now that we have the infrastructure in place it could be relatively simple to do this. Do we have a ticket for this or are there plans to make one in the future?

ovasileva added a comment.Dec 12 2022, 8:30 PM
In T322051#8458012, @nray wrote:

@ovasileva One question that came out of code review is whether we are planning to also add pinning persistence for the table of contents? Now that we have the infrastructure in place it could be relatively simple to do this. Do we have a ticket for this or are there plans to make one in the future?

No current plans, but I agree that it would make sense as a clear next step. @alexhollender_WMF - would you have any concerns with persistence for the ToC?

• nray mentioned this in T325032: Make TOC pinned body class use `vector-feature-toc-pinned-enabled`/`vector-feature-toc-pinned-disabled` convention.Dec 13 2022, 12:36 AM
• alexhollender_WMF added a comment.Dec 13 2022, 5:34 PM
In T322051#8461755, @ovasileva wrote:
In T322051#8458012, @nray wrote:

@ovasileva One question that came out of code review is whether we are planning to also add pinning persistence for the table of contents? Now that we have the infrastructure in place it could be relatively simple to do this. Do we have a ticket for this or are there plans to make one in the future?

No current plans, but I agree that it would make sense as a clear next step. @alexhollender_WMF - would you have any concerns with persistence for the ToC?

are you referring to this T316060: [anon prefs] TOC pinned / unpinned status should persist across page views for anonymous users? If so, yes we should offer this feature.

• nray added a comment.Dec 13 2022, 5:45 PM

@alexhollender_WMF Yes, that ticket captures the issue. The solution used for this ticket could also work for table of contents if all we want is logged-in persistence (which was the case for this ticket). The anon scenario requires more thought and work because it would probably rely on local storage + moving elements around in the DOM before they render.

Edtadros moved this task from QA to QA in Prod on the Web-Team-Backlog (Kanbanana-2022-23-Q2) board.Dec 15 2022, 5:59 PM
Edtadros added a comment.Dec 18 2022, 9:48 PM

Test Result - Beta

Status: ✅ PASS
Environment: beta
OS: macOS Ventura
Browser: Chrome
Device: MBP
Emulated Device:NA

Test Artifact(s):

QA Steps

Pinned/Unpinned state persists while logged-in

  1. Login and visit https://en.wikipedia.beta.wmflabs.org/wiki/Dog?vectorpagetools=1
  2. ✅ AC1: Verify that page tools is visible in the right sidebar

Screenshot 2022-12-18 at 1.40.47 PM.png (1×1 px, 590 KB)

  1. Click the "hide" button in page tools
  2. ✅ AC2: Verify that the page tools moves to the page toolbar

Screen Recording 2022-12-18 at 1.41.27 PM.mov.gif (758×1 px, 737 KB)

  1. Refresh the page
  2. ✅ AC3: Verify that the page tools remains in the page toolbar

Screen Recording 2022-12-18 at 1.42.39 PM.mov.gif (834×1 px, 1 MB)

  1. Toggle the page tools to make the menu visible and click the "move to sidebar" button
  2. ✅ AC4: Verify that the page tools moves to the right sidebar

Screen Recording 2022-12-18 at 1.44.37 PM.mov.gif (834×1 px, 604 KB)

  1. Refresh the page
  2. ✅ AC5: Verify that page tools remains in the right sidebar

Screen Recording 2022-12-18 at 1.45.10 PM.mov.gif (834×1 px, 853 KB)

Page tools is in the page toolbar when anonymous and is not pinnable

  1. Logout and visit https://en.wikipedia.beta.wmflabs.org/wiki/Dog?vectorpagetools=1
  2. ✅ AC6: Verify that page tools is visible in the page toolbar

Screenshot 2022-12-18 at 1.47.07 PM.png (783×1 px, 339 KB)

  1. ✅ AC7: Toggle the page tools to make the menu visible and verify that the "move to sidebar" button is not visible

See AC6 above

Edtadros reassigned this task from Edtadros to ovasileva.Dec 18 2022, 9:52 PM
Edtadros moved this task from QA in Prod to Ready for Signoff on the Web-Team-Backlog (Kanbanana-2022-23-Q2) board.
Edtadros subscribed.

Test Result - Prod

Status: ✅ PASS
Environment: enwiki
OS: macOS Ventura
Browser: Chrome
Device: MBP
Emulated Device:NA

Test Artifact(s):

QA Steps

Pinned/Unpinned state persists while logged-in

  1. Login and visit https://en.wikipedia.beta.wmflabs.org/wiki/Dog?vectorpagetools=1
  2. ✅ AC1: Verify that page tools is visible in the right sidebar
  3. Click the "hide" button in page tools
  4. ✅ AC2: Verify that the page tools moves to the page toolbar
  5. Refresh the page
  6. ✅ AC3: Verify that the page tools remains in the page toolbar
  7. Toggle the page tools to make the menu visible and click the "move to sidebar" button
  8. ✅ AC4: Verify that the page tools moves to the right sidebar
  9. Refresh the page
  10. ✅ AC5: Verify that page tools remains in the right sidebar

Screen Recording 2022-12-18 at 1.49.44 PM.mov.gif (696×1 px, 737 KB)

Page tools is in the page toolbar when anonymous and is not pinnable

  1. Logout and visit https://en.wikipedia.beta.wmflabs.org/wiki/Dog?vectorpagetools=1
  2. ✅ AC6: Verify that page tools is visible in the page toolbar

Screenshot 2022-12-18 at 1.51.49 PM.png (589×1 px, 264 KB)

  1. ✅ AC7: Toggle the page tools to make the menu visible and verify that the "move to sidebar" button is not visible

See AC6 above

Edtadros updated the task description. (Show Details)Dec 18 2022, 9:56 PM
ovasileva closed this task as Resolved.Dec 19 2022, 5:36 PM

Looks good! Resolving

Jdlrobson closed subtask T324874: [subtask] Drop table of contents A/B test code as Resolved.Jan 10 2023, 5:34 PM
Content licensed under Creative Commons Attribution-ShareAlike (CC BY-SA) 4.0 unless otherwise noted; code licensed under GNU General Public License (GPL) 2.0 or later and other open source licenses. By using this site, you agree to the Terms of Use, Privacy Policy, and Code of Conduct. · Wikimedia Foundation · Privacy Policy · Code of Conduct · Terms of Use · Disclaimer · CC-BY-SA · GPL