Page MenuHomePhabricator
Create Task
Maniphest T326839

Pinning behaviour disappears after the TOC reloaded from an edit made with VisualEditor
Closed, ResolvedPublic
Actions

Assigned To
ovasileva
Authored By
bwang
Jan 12 2023, 6:14 PM
Tags
Referenced Files
F36511148: Screen Recording 2023-01-25 at 7.18.51 PM.mov.gif
Jan 26 2023, 3:32 AM
F36511143: Screen Recording 2023-01-25 at 7.12.47 PM.mov.gif
Jan 26 2023, 3:32 AM
F36487142: Screen Recording 2023-01-24 at 3.48.02 PM.mov.gif
Jan 24 2023, 11:49 PM
F36487140: Screen Recording 2023-01-24 at 3.46.37 PM.mov.gif
Jan 24 2023, 11:49 PM
Subscribers
Aklapper
bwang
Edtadros
Jdlrobson
• Mabualruz

Description

Background

https://jumpshare.com/v/Y6t22wHnVhcrjfEkHH7b
Discovered during work on T326682

Developer notes

Currently we reload the entire TOC (#vector-toc) when the 'wikipage.tableOfContents' hook is fired by VisualEditor. This means we need to provide the data and templates for the PinnableHeader, which is unnessary and more error prone. Instead we should only rerender the TOC contents

Acceptance Criteria

QA

Expected behaviour

Unpinned scenario:

  • Edit an article.
  • Change the headers. That makes sure to reload TOC
  • Save the Edits
  • Pinning actions showing and working

Pinned scenario

  • Edit an article.
  • Change the headers. That makes sure to reload TOC
  • Save the Edits
  • Open TOC menu
  • Pinning actions showing and working
Unexpected behaviour

Unpinned scenario:

  • Pinning actions disappear.

Pinned scenario

  • Menu opens but show empty area

QA Results - Beta

ACStatusDetails
1✅T326839#8555538
2✅T326839#8555538

QA Results - Prod

ACStatusDetails
1✅T326839#8559666
2✅T326839#8559666

Details

SubjectRepoBranchLines +/-
Update tableOfContents.js to rerender only the TOC contents rather than the entire pinnable elementmediawiki/skins/Vectormaster+127 -81
Table of contents Pinning behaviormediawiki/skins/Vectormaster+45 -6
Customize query in gerrit

Related Objects

Event Timeline

bwang created this task.Jan 12 2023, 6:14 PM
Restricted Application added a subscriber: Aklapper. · View Herald TranscriptJan 12 2023, 6:14 PM
gerritbot added a comment.Jan 12 2023, 6:14 PM

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

[mediawiki/skins/Vector@master] Update tableOfContents.js to rerender only the TOC contents rather than the entire pinnable element

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

gerritbot added a project: Patch-For-Review.Jan 12 2023, 6:14 PM
bwang added a project: Web-Team-Backlog.Jan 12 2023, 6:14 PM
• nray updated the task description. (Show Details)Jan 12 2023, 9:21 PM
gerritbot added a comment.Jan 12 2023, 11:35 PM

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

[mediawiki/skins/Vector@master] Table of contents Pinning behavior

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

Jdlrobson added a project: Web-Team FY2022-23 Q3 Sprint 1.Jan 12 2023, 11:46 PM
• Mabualruz closed this task as Resolved.Jan 13 2023, 4:24 PM
• Mabualruz reopened this task as Open.
• Mabualruz claimed this task.
• Mabualruz removed • Mabualruz as the assignee of this task.
• Mabualruz moved this task from Incoming to Doing on the Web-Team FY2022-23 Q3 Sprint 1 board.
• Mabualruz moved this task from Doing to Code Review on the Web-Team FY2022-23 Q3 Sprint 1 board.
• Mabualruz subscribed.
ovasileva triaged this task as Medium priority.Jan 13 2023, 11:46 PM
gerritbot added a comment.Jan 16 2023, 10:56 AM

Change 879667 abandoned by Mabualruz:

[mediawiki/skins/Vector@master] Table of contents Pinning behavior

Reason:

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

• Mabualruz claimed this task.Jan 16 2023, 11:56 AM
• Mabualruz moved this task from Code Review to QA on the Web-Team FY2022-23 Q3 Sprint 1 board.Jan 16 2023, 12:04 PM

Opened a bug for another issue with table of contents https://phabricator.wikimedia.org/T327064 Table of contents Collapse/Expand not working

• Mabualruz removed • Mabualruz as the assignee of this task.Jan 16 2023, 12:12 PM
gerritbot added a comment.Jan 16 2023, 12:18 PM

Change 879117 merged by jenkins-bot:

[mediawiki/skins/Vector@master] Update tableOfContents.js to rerender only the TOC contents rather than the entire pinnable element

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

ReleaseTaggerBot added a project: MW-1.40-notes (1.40.0-wmf.19; 2023-01-16).Jan 16 2023, 1:00 PM
• Mabualruz renamed this task from Pinning behavior disappears after the TOC reloaded from an edit made with VisualEditor to Pinning behaviour disappears after the TOC reloaded from an edit made with VisualEditor.Jan 17 2023, 4:57 PM
Jdlrobson moved this task from Incoming to Table of Contents on the Desktop Improvements (Vector 2022) board.Jan 18 2023, 3:47 PM
Jdlrobson moved this task from Incoming to Sprint 1 (non-milestone) on the Web-Team-Backlog board.Jan 18 2023, 9:23 PM
Jdlrobson assigned this task to Edtadros.Jan 18 2023, 10:37 PM
Edtadros reassigned this task from Edtadros to Jdlrobson.Jan 23 2023, 2:39 AM
Edtadros subscribed.

Please provide some steps/guidance on how I can verify this.

Maintenance_bot removed a project: Patch-For-Review.Jan 23 2023, 3:30 AM
Jdlrobson reassigned this task from Jdlrobson to • Mabualruz.Jan 23 2023, 6:06 PM
Jdlrobson subscribed.

Can you please add some QA steps to the description of this ticket? Thanks in advance!

• Mabualruz reassigned this task from • Mabualruz to Edtadros.Jan 24 2023, 9:57 AM
• Mabualruz updated the task description. (Show Details)
• Mabualruz added a comment.Jan 24 2023, 10:00 AM

@Jdlrobson I did not author this one, I did the review and some final touches, anyway I did add QA steps

Edtadros moved this task from QA to QA in Production on the Web-Team FY2022-23 Q3 Sprint 1 board.Jan 24 2023, 11:49 PM

Test Result - Beta

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

Test Artifact(s):

QA Steps

✅ AC1: Unpinned scenario:

Edit an article.
Change the headers. That makes sure to reload TOC
Save the Edits
Pinning actions showing and working

Screen Recording 2023-01-24 at 3.46.37 PM.mov.gif (1×1 px, 656 KB)

✅ AC2: Pinned scenario

Edit an article.
Change the headers. That makes sure to reload TOC
Save the Edits
Open TOC menu
Pinning actions showing and working

Screen Recording 2023-01-24 at 3.48.02 PM.mov.gif (1×1 px, 501 KB)

Edtadros reassigned this task from Edtadros to ovasileva.Jan 26 2023, 3:32 AM
Edtadros moved this task from QA in Production to Ready for Signoff on the Web-Team FY2022-23 Q3 Sprint 1 board.

Test Result - Prod

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

Test Artifact(s):

QA Steps

✅ AC1: Unpinned scenario:

Edit an article.
Change the headers. That makes sure to reload TOC
Save the Edits
Pinning actions showing and working

Screen Recording 2023-01-25 at 7.12.47 PM.mov.gif (896×782 px, 2 MB)

✅ AC2: Pinned scenario

Edit an article.
Change the headers. That makes sure to reload TOC
Save the Edits
Open TOC menu
Pinning actions showing and working

Screen Recording 2023-01-25 at 7.18.51 PM.mov.gif (996×792 px, 2 MB)

Edtadros updated the task description. (Show Details)Jan 26 2023, 3:34 AM
ovasileva closed this task as Resolved.Jan 30 2023, 4:24 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 · Credits