Page MenuHomePhabricator
Create Task
Maniphest T210789

Table of contents' hidden state isn't kept after reload
Closed, ResolvedPublic
Actions

Description

There are at least two reports in ruwiki that the table of contents' hidden state isn't kept after page reload (I confirm). This could be connected to T195053. This is not wiki-dependent, not user-dependent, and it doesn't look like it's browser-dependent (in Firefox, the state is kept only when you press "Refresh", and that's probably some browser feature).

Steps to reproduce:

  1. Open any wiki page with more than 3 sections, for example https://en.wikipedia.org/wiki/Phabricator.
  2. Click [hide] in TOC.
  3. Refresh the page (in Firefox, click in the address bar and press "Enter").

Expected result:
TOC is hidden.

Actual result:
TOC is shown.

Affected: MW 1.33 and later (backport bugfix)

Details

ProjectBranchLines +/-Subject
mediawiki/coremaster+67 -103mediawiki.toc: Fix cookie persistence and remove redundant code
mediawiki/coremaster+7 -0ToC: Save and restore the state of the toc toggle in a cookie
Customize query in gerrit

Related Objects

Event Timeline

Jack_who_built_the_house created this task.Nov 29 2018, 9:21 PM
Restricted Application added a subscriber: Aklapper. · View Herald TranscriptNov 29 2018, 9:21 PM
Jack_who_built_the_house updated the task description. (Show Details)Nov 29 2018, 9:23 PM
Jack_who_built_the_house updated the task description. (Show Details)
Jack_who_built_the_house updated the task description. (Show Details)
Jack_who_built_the_house updated the task description. (Show Details)
SerDIDG awarded a token.Nov 29 2018, 9:34 PM
SerDIDG added a subscriber: SerDIDG.
Jack_who_built_the_house updated the task description. (Show Details)Nov 29 2018, 9:38 PM
Jack_who_built_the_house renamed this task from Table of contents' hidden state isn't kept after reload in Chrome to Table of contents' hidden state isn't kept after reload.Nov 29 2018, 11:10 PM
Jack_who_built_the_house updated the task description. (Show Details)
Jack_who_built_the_house updated the task description. (Show Details)
Schnark added a subscriber: Schnark.Nov 30 2018, 9:15 AM

Quote from https://gerrit.wikimedia.org/r/372515: "Changes in the behavior: [...] The state of the button is not saved in a cookie."

MBH added a subscriber: MBH.Nov 30 2018, 10:28 AM
Jack_who_built_the_house added a comment.Nov 30 2018, 11:05 AM

@Schnark So, what is it based on? Technical unfeasibility? Perceived lack of necessity? There are users who are not happy about it. I think, some would say, there is no need in the hiding/showing functionality at all if the state is not saved in a cookie. The only thing it does when used on one page is saves a small amount of space.

Schnark added a subscriber: Fomafix.Dec 1 2018, 8:42 AM

Don't know, let's ask @Fomafix.

Fomafix added a comment.Dec 1 2018, 1:35 PM

It is possible to reimplement the former behavior and store the status in a cookie on a change. Restoring the status from a cookie with JavaScript can only be done after DOM ready and this leads to a flash of the full ToC before it get minimized. A way to avoid this is to hide the ToC already on server-side. With a cookie this would also be possible but cookies are unwanted for such a think. An alternative is to store the status in a user option. Anonymous user have no user options and therefor they can not store the status in the user options. An advantage of storing in user options is that the status is shared for browser the user uses.

Fomafix claimed this task.Feb 14 2019, 9:25 PM
gerritbot added a subscriber: gerritbot.Feb 14 2019, 9:25 PM

Change 490705 had a related patch set uploaded (by Fomafix; owner: Fomafix):
[mediawiki/core@master] ToC: Save and restore the state of the toc toggle in a cookie

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

gerritbot added a project: Patch-For-Review.Feb 14 2019, 9:25 PM
Krinkle added projects: MW-1.33-release, MW-1.34-release, Regression.Sep 8 2019, 3:44 AM
Krinkle removed a project: CSS.
gerritbot added a comment.Nov 6 2019, 12:41 AM

Change 490705 had a related patch set uploaded (by Krinkle; owner: Fomafix):
[mediawiki/core@master] ToC: Save and restore the state of the toc toggle in a cookie

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

Krinkle triaged this task as Medium priority.Nov 6 2019, 12:42 AM
Krinkle removed projects: MW-1.34-release, MW-1.33-release.
Krinkle updated the task description. (Show Details)
Krinkle added a subscriber: Krinkle.

Does not seem severe enough to block 1.34 release, in particular given it has been live without a fix on Wikipedia with it for 10 months, and the area does not have an active steward.

Once fixed, should still be backported to affected release channels (1.33+) that are supported at that time, for release in a minor version.

gerritbot added a comment.Apr 20 2020, 5:17 PM

Change 591109 had a related patch set uploaded (by Krinkle; owner: Krinkle):
[mediawiki/core@master] mediawiki.toc: Fix cookie persistence and remove redundant code

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

Krinkle claimed this task.Apr 20 2020, 5:17 PM
gerritbot added a comment.Apr 20 2020, 5:17 PM

Change 490705 abandoned by Krinkle:
ToC: Save and restore the state of the toc toggle in a cookie

Reason:
Continuing at https://gerrit.wikimedia.org/r/591109

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

Fomafix added a comment.EditedApr 20 2020, 7:59 PM

Is a cookie the right way to store the state? Isn't an user option a better way?

Krinkle added a comment.Apr 22 2020, 2:15 AM

@Fomafix I can see reasons for it (cross-device, last forever) but also against it (anon user support, prefer per-device, performance ajax request, data retention/privacy). That's something to consider in another task I think :)

gerritbot added a comment.May 4 2020, 10:05 PM

Change 591109 merged by jenkins-bot:
[mediawiki/core@master] mediawiki.toc: Fix cookie persistence and remove redundant code

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

Krinkle closed this task as Resolved.May 4 2020, 11:02 PM
Krinkle edited projects, added Performance-Team; removed Patch-For-Review.
ReleaseTaggerBot added a project: MW-1.35-notes (1.35.0-wmf.31; 2020-05-05).May 5 2020, 8:00 AM
BEANS-X2 added a subscriber: BEANS-X2.May 8 2020, 3:09 PM
Content licensed under Creative Commons Attribution-ShareAlike 3.0 (CC-BY-SA) unless otherwise noted; code licensed under GNU General Public License (GPL) or 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