Page MenuHomePhabricator

Update is_pinned condition to disgard TOC state
Closed, ResolvedPublic2 Estimated Story Points

Assigned To
Authored By
KSarabia-WMF
Oct 27 2023, 4:32 PM
Referenced Files
F41520710: screenshot 258.png
Nov 19 2023, 8:46 PM
F41520709: screenshot 261.png
Nov 19 2023, 8:46 PM
F41520708: screenshot 259.png
Nov 19 2023, 8:46 PM
F41520707: screenshot 260.png
Nov 19 2023, 8:46 PM
F41484935: screenshot 200.png
Nov 10 2023, 10:26 PM
F41484934: screenshot 199.png
Nov 10 2023, 10:26 PM
F41484933: screenshot 198.png
Nov 10 2023, 10:26 PM
F41484932: screenshot 201.png
Nov 10 2023, 10:26 PM

Description

The TOC pinned state being default distracts the baseline data collection process because we have to track the pinned component adaptation of users. Currently, the condition will return true if one of three pinnable components (TOC, main menu, and page tools) is pinned, but we should update it so it will only return true if either main menu and page tools is pinned, disregarding the pinned/unpinned state of TOC.

QA Results - Beta

ACStatusDetails
1T349924#9324258

QA Results - Prod

ACStatusDetails
1T349924#9343335

Event Timeline

Discussed in grooming and we're not quite ready to estimate. @KSarabia-WMF and @Jdrewniak to discuss further. Let's try to estimate again Mon, Nov 6

After talking with @KSarabia-WMF , we decided to rename the PinnableElement.hasPinnedElement() function to reflect the fact that it is specifically used for Event logging. With that change, we can add conditional logic inside that function. to track certain elements and disregard others, without affecting the PinnableElement.isPinned() function, which is more broadly used.

Jdlrobson set the point value for this task to 2.Nov 6 2023, 6:24 PM

Change 972421 had a related patch set uploaded (by Kimberly Sarabia; author: Kimberly Sarabia):

[mediawiki/skins/Vector@master] Remove TOC state from logic

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

Change 972888 had a related patch set uploaded (by Kimberly Sarabia; author: Kimberly Sarabia):

[mediawiki/extensions/WikimediaEvents@master] Update function name

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

Change 972421 merged by jenkins-bot:

[mediawiki/skins/Vector@master] Remove TOC state from logic

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

Change 972888 merged by jenkins-bot:

[mediawiki/extensions/WikimediaEvents@master] Update function name

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

QA Steps

  • Go to Network Tab
  • Previously, is_pinned: will return true if one of three pinnable components (TOC, main menu, and page tools) is pinned.
  • Now, it should only return true if either main menu and page tools is pinned, disregarding the pinned/unpinned state of TOC.
Edtadros removed Edtadros as the assignee of this task.EditedNov 10 2023, 10:26 PM
Edtadros subscribed.

Test Result - Beta

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

Test Artifact(s):

QA Steps

Go to Network Tab
Previously, is_pinned: will return true if one of three pinnable components (TOC, main menu, and page tools) is pinned.
✅ AC1: Now, it should only return true if either main menu and page tools is pinned, disregarding the pinned/unpinned state of TOC.
@KSarabia-WMF can you please confirm if this should also work for anon users? I'm passing this since it works for logged in users.

screenshot 201.png (1×1 px, 277 KB)

screenshot 198.png (1×1 px, 247 KB)

screenshot 199.png (1×1 px, 245 KB)

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

Jdlrobson claimed this task.
Jdlrobson subscribed.

Per @KSarabia-WMF we do not need to do any further verification here.

Test Result - Prod

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

Test Artifact(s):

QA Steps

Go to Network Tab
Previously, is_pinned: will return true if one of three pinnable components (TOC, main menu, and page tools) is pinned.
✅ AC1: Now, it should only return true if either main menu and page tools is pinned, disregarding the pinned/unpinned state of TOC.

screenshot 260.png (1×1 px, 334 KB)

screenshot 259.png (1×1 px, 361 KB)

screenshot 261.png (1×1 px, 361 KB)

screenshot 258.png (1×1 px, 363 KB)