Vector isnt firing 'scroll-to-toc' and 'scroll-to-top' events correctly
Closed, ResolvedPublic
Actions

Assigned To

Authored By

	bwang
	May 9 2022, 6:43 PM

Description

Background

There are two main issues with our scroll instrumentation

Due to a bug in T303297's implementation, extra scroll-to-toc and scroll-to-top events have been firing since https://gerrit.wikimedia.org/r/c/mediawiki/skins/Vector/+/773632. This is because we are firing both events whenever either the TOC or page heading are detected by the scrollObserver. Instead, the events should only be fired when their respective element is scrolled to, i.e. only the 'scroll-to-toc' event should be fired when the TOC is scrolled to.

scroll-to-toc events have not been firing correctly when the TOC scrolls into / out of the viewport on large screen sizes when the A/B test is enabled since https://gerrit.wikimedia.org/r/c/mediawiki/skins/Vector/+/777889. This is because the instrumentation originally tracked a TOC placeholder when the modern TOC was shown, but during T300975, the placeholder was replaced with a hidden legacy TOC element, which could not be detected by the scrollObserver.

AC

'scroll-to-top' events are only fired when the page header scrolls into or out of the viewport
'scroll-to-toc' events are only fired when the TOC scrolls into or out of the viewport
'scroll-to-toc' events still fire when the A/B is on, regardless of the user's bucket

QA Results - Beta

AC	Status	Details
1	✅	T307952#7948658
2	✅	T307952#7948658
3	✅	T307952#7948658

QA Results - Prod

AC	Status	Details
1	✅	T307952#7981774
2	✅	T307952#7981774
3	✅	T307952#7981774

Details

	Subject	Repo	Branch	Lines +/-
	Factor out a separate scroll observer for the TOC A/B test, which should be fired separately from the page title observer used by the sticky header and TOC	mediawiki/skins/Vector	wmf/1.39.0-wmf.10	+32 -24
	Factor out a separate scroll observer for the TOC A/B test, which should be fired separately from the page title observer used by the sticky header and TOC	mediawiki/skins/Vector	master	+32 -24

Customize query in gerrit

Related Objects

Mentioned In: T307345: Sticky header disappears within lead sections of certain articles when old table of contents scrolls into view
T306557: Schema QA : mediawiki_web_ui_scroll
Mentioned Here: T307345: Sticky header disappears within lead sections of certain articles when old table of contents scrolls into view
T300975: [ToC] short term: show the ToC inline for smaller resolutions for the A/B test
T303297: Prepare mediawiki_web_ui_scroll schema for table of contents AB test

Event Timeline

bwang created this task.May 9 2022, 6:43 PM

Restricted Application added a subscriber: Aklapper. · View Herald TranscriptMay 9 2022, 6:43 PM

bwang renamed this task from 'scroll-to-toc' and 'scroll-to-top' events aren' to Vector isnt firing 'scroll-to-toc' and 'scroll-to-top' events correctly .May 9 2022, 7:58 PM

bwang added projects: Vector (legacy skin), Desktop Improvements (Vector 2022).

bwang updated the task description. (Show Details)

bwang added subscribers: cjming, ovasileva.

bwang added a subscriber: jwang.

bwang updated the task description. (Show Details)May 9 2022, 8:06 PM

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

[mediawiki/skins/Vector@master] Factor out a separate scroll observer for the TOC A/B test, which should be fired separately from the page title observer used by the sticky header and TOC

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

gerritbot added a project: Patch-For-Review.May 9 2022, 8:44 PM

bwang assigned this task to cjming.May 9 2022, 9:34 PM

bwang added a project: Web-Team-Backlog (Kanbanana-FY-2021-22).

bwang moved this task from Needs Analysis to Code Review on the Web-Team-Backlog (Kanbanana-FY-2021-22) board.

jwang mentioned this in T306557: Schema QA : mediawiki_web_ui_scroll.May 9 2022, 10:16 PM

cjming reassigned this task from cjming to Edtadros.May 9 2022, 10:56 PM

cjming moved this task from Code Review to QA on the Web-Team-Backlog (Kanbanana-FY-2021-22) board.

Change 789684 merged by jenkins-bot:

[mediawiki/skins/Vector@master] Factor out a separate scroll observer for the TOC A/B test, which should be fired separately from the page title observer used by the sticky header and TOC

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

Maintenance_bot removed a project: Patch-For-Review.May 9 2022, 11:31 PM

ovasileva triaged this task as High priority.May 10 2022, 8:18 AM

Change 790443 had a related patch set uploaded (by Clare Ming; author: Bernard Wang):

[mediawiki/skins/Vector@wmf/1.39.0-wmf.10] Factor out a separate scroll observer for the TOC A/B test, which should be fired separately from the page title observer used by the sticky header and TOC

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

gerritbot added a project: Patch-For-Review.May 11 2022, 4:56 PM

Change 790443 merged by jenkins-bot:

[mediawiki/skins/Vector@wmf/1.39.0-wmf.10] Factor out a separate scroll observer for the TOC A/B test, which should be fired separately from the page title observer used by the sticky header and TOC

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

Mentioned in SAL (#wikimedia-operations) [2022-05-11T20:25:50Z] <cjming@deploy1002> Synchronized php-1.39.0-wmf.10/skins/Vector/resources: Backport: [[gerrit:790443|Factor out a separate scroll observer for the TOC A/B test, which should be fired separately from the page title observer used by the sticky header and TOC (T307952 T307345)]] (duration: 00m 52s)

Test Result - Beta

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

Test Artifact(s):

QA Steps

✅ AC1: 'scroll-to-top' events are only fired when the page header scrolls into or out of the viewport

Screen Shot 2022-05-22 at 6.08.26 PM.png (279×748 px, 52 KB)

✅ AC2: 'scroll-to-toc' events are only fired when the TOC scrolls into or out of the viewport

Screen Shot 2022-05-22 at 6.08.01 PM.png (259×749 px, 47 KB)

Screen Shot 2022-05-22 at 6.07.40 PM.png (214×668 px, 39 KB)

Screen Shot 2022-05-22 at 6.07.25 PM.png (257×721 px, 48 KB)

✅ AC3: 'scroll-to-toc' events still fire when the A/B is on, regardless of the user's bucket

Screen Shot 2022-05-22 at 6.07.05 PM.png (265×704 px, 47 KB)

Maintenance_bot removed a project: Patch-For-Review.May 23 2022, 1:30 AM

Test Result - Prod

Status: ✅ PASS
Environment: enwiki, euwiki
OS: macOS Monterey
Browser: Chrome
Device: MBP
Emulated Device:NA

Test Artifact(s):

QA Steps

✅ AC1: 'scroll-to-top' events are only fired when the page header scrolls into or out of the viewport
See AC2
✅ AC2: 'scroll-to-toc' events are only fired when the TOC scrolls into or out of the viewport

Screen Recording 2022-06-05 at 6.09.37 PM.mov.gif (1×1 px, 3 MB)

✅ AC3: 'scroll-to-toc' events still fire when the A/B is on, regardless of the user's bucket

Screen Recording 2022-06-05 at 6.15.20 PM.mov.gif (1×1 px, 2 MB)

Edtadros updated the task description. (Show Details)Jun 6 2022, 1:19 AM

ovasileva closed this task as Resolved.Jun 7 2022, 8:31 AM

	F35210258: Screen Recording 2022-06-05 at 6.09.37 PM.mov.gif
	Jun 6 2022, 1:17 AM

	F35210269: Screen Recording 2022-06-05 at 6.15.20 PM.mov.gif
	Jun 6 2022, 1:17 AM

	F35167535: Screen Shot 2022-05-22 at 6.07.25 PM.png
	May 23 2022, 1:17 AM

	F35167530: Screen Shot 2022-05-22 at 6.08.01 PM.png
	May 23 2022, 1:17 AM

	F35167527: Screen Shot 2022-05-22 at 6.08.26 PM.png
	May 23 2022, 1:17 AM

	F35167533: Screen Shot 2022-05-22 at 6.07.40 PM.png
	May 23 2022, 1:17 AM

	F35167538: Screen Shot 2022-05-22 at 6.07.05 PM.png
	May 23 2022, 1:17 AM

Vector isnt firing 'scroll-to-toc' and 'scroll-to-top' events correctly Closed, ResolvedPublicActions

Description

Background

AC

QA Results - Beta

QA Results - Prod

Details

Related Objects

Event Timeline

Test Result - Beta

QA Steps

Test Result - Prod

QA Steps

Vector isnt firing 'scroll-to-toc' and 'scroll-to-top' events correctly
Closed, ResolvedPublic
Actions