1768041 - The subtitles' padding is incorrectly tall on a cbsnews video

Status: VERIFIED FIXED

(Toolkit :: Picture-in-Picture, defect)

Description

[Daniel Bodea [:danibodea]]

Attachment: padding issue on cbs news.png

Note

• When the user loads and plays a cbsnews video and launches the PiP, he will notice that the height of the subs padding is too tall.

Affected versions

• Nightly v102.0a1
• Beta v101.0b2
• Release
• ESR

Affected platforms

• Windows 10
• Window 7
• Mac OS 11
• Ubuntu

Steps to reproduce

1. Launch browser.
2. Load https://www.cbsnews.com/video/music-therapy-helps-addicts-recover-through-song/#x
3. Play the video and activate subtitles.
4. Launch PiP.

Expected result

• Subtitles padding is not too tall.

Actual result

• Subtitle padding is too tall.

Regression range

• Not a browser regression as it reproduces since implementation.

Additional notes

• This issue does not occur in the case of other news webpages with "pure WebVTT subtitles" like CBC NEWS.
• This issue appeared to be somewhat intermittent on a 3rd Windows 10 system and on a second Mac OS 11 it was tested on, so it's probably somewhat intermittent or dependent on some drivers or hardware set-up.

Comment 1

[Molly Howell (she/her) (no longer active)]

Looks like we're getting doubled-up line breaks in there. I feel like we could probably get away with consolidating consecutive line breaks down to one before we display any caption. Katherine, does that sound like it makes sense?

Comment 2

[kpatenio]

Makes sense to me! I can look into it.

Comment 3

[kpatenio]

Attachment: Bug 1768041 - remove extra newlines from PiP WebVTT captions/subtitles. r=#pip-reviewers!

Comment 4

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/94722d9bbc2b
remove extra newlines from PiP WebVTT captions/subtitles. r=mhowell

Comment 5

[Narcis Beleuzu [:NarcisB]]

https://hg.mozilla.org/mozilla-central/rev/94722d9bbc2b

Comment 6

[BugBot [:suhaib / :marco/ :calixte]]

The patch landed in nightly and beta is affected.
:kpatenio, is this bug important enough to require an uplift?
If not please set status_beta to wontfix.

For more information, please visit auto_nag documentation.

Comment 7

[kpatenio]

Comment on attachment 9275325 [details]
Bug 1768041 - remove extra newlines from PiP WebVTT captions/subtitles. r=#pip-reviewers!

Beta/Release Uplift Approval Request

• User impact if declined: If declined, PiP captions will not appear as expected in cases where multiple newline characters are provided in the captions cue text. (See sample video). This might make text harder to read, and the inconsistent spacing will impact the overall quality of PiP as a feature (especially considering that subtitles/captions support is a highlighted new feature in Fx100).
• Is this code covered by automated tests?: Yes
• Has the fix been verified in Nightly?: No
• Needs manual test from QE?: Yes
• If yes, steps to reproduce: 1. Play provided video in ticket

2. Enable captions for video
3. Enable PiP mode via PiP toggle or context menu
4. Captions should appear cleanly in two separate lines, without any extra spaces in between them

• List of other uplifts needed: None
• Risk to taking this patch: Low
• Why is the change risky/not risky? (and alternatives if risky): This change only affects sites that utilize WebVTT for captions/subtitles, thus not impacting major sites like YouTube, Prime Video, and Netflix. This fix is visual - ensuring that only one newline character is rendered whenever multiple newline characters are provided in the cue text. Regarding automated tests: WebVTT captions support is already covered by automated tests. It is just this specific change that does not have tests, since it is hard to replicate a case where multiple newlines are integrated into the cue text (which anyways is not a very common occurrence).
• String changes made/needed: None
• Is Android affected?: No

Comment 8

[Daniel Bodea [:danibodea]]

This fix was verified in Nightly v102.0a1 from 2022-05-10 on Windows 10, Windows 7 and Mac OS 11. Expecting fix to land uplift.
Fix on Ubuntu can't be verified due to a webcompat issue (bug 1767983).

Comment 9

[Ryan VanderMeulen [:RyanVM]]

Comment on attachment 9275325 [details]
Bug 1768041 - remove extra newlines from PiP WebVTT captions/subtitles. r=#pip-reviewers!

Approved for 101.0b5.

Comment 10

[Ryan VanderMeulen [:RyanVM]]

https://hg.mozilla.org/releases/mozilla-beta/rev/ed19fa2f6eda

Comment 11

[Daniel Bodea [:danibodea]]

This fix was verified in Beta v101.0b5 on Windows 10, Mac OS 11/12.

Comment 12

[Dianna Smith [:diannaS]]

Comment on attachment 9275325 [details]
Bug 1768041 - remove extra newlines from PiP WebVTT captions/subtitles. r=#pip-reviewers!

Approved for 100.0.1

Comment 13

[Dianna Smith [:diannaS]]

https://hg.mozilla.org/releases/mozilla-release/rev/acd93c3a675e

Comment 14

[Daniel Bodea [:danibodea]]

This fix has been verified in Release v100.0.1 (build ID: 20220513165813) in Windows 10, Mac OS 11.6.5 and Windows 7.
The padding is displayed correctly on this video.
Linux platform suffers from bug 1767983 so it can't be verified.