From 94b76782165e2ff7f15518848a4285d066cd69fc Mon Sep 17 00:00:00 2001 From: Paul Adenot Date: Thu, 7 Oct 2021 15:44:53 +0000 Subject: [PATCH] Bug 1678373 - Rename chrome-only telemetry counter attributes to distinguish audio and video. r=alwu,webidl,emilio Differential Revision: https://phabricator.services.mozilla.com/D125083 --- dom/html/HTMLMediaElement.cpp | 4 +-- dom/html/HTMLMediaElement.h | 2 +- dom/media/MediaDecoder.cpp | 2 +- dom/media/MediaDecoder.h | 4 +-- .../chrome/test_accumulated_play_time.html | 30 +++++++++---------- dom/webidl/HTMLMediaElement.webidl | 2 +- 6 files changed, 22 insertions(+), 22 deletions(-) diff --git a/dom/html/HTMLMediaElement.cpp b/dom/html/HTMLMediaElement.cpp index 5d9f9933a996..462cf5343f15 100644 --- a/dom/html/HTMLMediaElement.cpp +++ b/dom/html/HTMLMediaElement.cpp @@ -2081,8 +2081,8 @@ bool HTMLMediaElement::IsVideoDecodingSuspended() const { return mDecoder && mDecoder->IsVideoDecodingSuspended(); } -double HTMLMediaElement::TotalPlayTime() const { - return mDecoder ? mDecoder->GetTotalPlayTimeInSeconds() : -1.0; +double HTMLMediaElement::TotalVideoPlayTime() const { + return mDecoder ? mDecoder->GetTotalVideoPlayTimeInSeconds() : -1.0; } double HTMLMediaElement::VisiblePlayTime() const { diff --git a/dom/html/HTMLMediaElement.h b/dom/html/HTMLMediaElement.h index fd80f4e202d4..14778933bd0b 100644 --- a/dom/html/HTMLMediaElement.h +++ b/dom/html/HTMLMediaElement.h @@ -655,7 +655,7 @@ class HTMLMediaElement : public nsGenericHTMLElement, // These functions return accumulated time, which are used for the telemetry // usage. Return -1 for error. - double TotalPlayTime() const; + double TotalVideoPlayTime() const; double VisiblePlayTime() const; double InvisiblePlayTime() const; double VideoDecodeSuspendedTime() const; diff --git a/dom/media/MediaDecoder.cpp b/dom/media/MediaDecoder.cpp index 5fe5b37bc6ac..18fd41522ac3 100644 --- a/dom/media/MediaDecoder.cpp +++ b/dom/media/MediaDecoder.cpp @@ -1411,7 +1411,7 @@ void MediaDecoder::NotifyAudibleStateChanged() { : TelemetryProbesReporter::AudibleState::eNotAudible); } -double MediaDecoder::GetTotalPlayTimeInSeconds() const { +double MediaDecoder::GetTotalVideoPlayTimeInSeconds() const { return mTelemetryProbesReporter->GetTotalVideoPlayTimeInSeconds(); } diff --git a/dom/media/MediaDecoder.h b/dom/media/MediaDecoder.h index ae6d7c6a7d0f..fb06cba546a8 100644 --- a/dom/media/MediaDecoder.h +++ b/dom/media/MediaDecoder.h @@ -718,8 +718,8 @@ class MediaDecoder : public DecoderDoctorLifeLogger { TelemetryProbesReporter::Visibility OwnerVisibility() const; - // They are used for reporting telemetry related results. - double GetTotalPlayTimeInSeconds() const; + // Those methods exist to report telemetry related metrics. + double GetTotalVideoPlayTimeInSeconds() const; double GetVisibleVideoPlayTimeInSeconds() const; double GetInvisibleVideoPlayTimeInSeconds() const; double GetVideoDecodeSuspendedTimeInSeconds() const; diff --git a/dom/media/test/chrome/test_accumulated_play_time.html b/dom/media/test/chrome/test_accumulated_play_time.html index 890d9b95b849..cbf885d8d2c5 100644 --- a/dom/media/test/chrome/test_accumulated_play_time.html +++ b/dom/media/test/chrome/test_accumulated_play_time.html @@ -35,7 +35,7 @@ add_task(async function testTotalPlayTime() { info(`all accumulated time should be zero`); const videoChrome = SpecialPowers.wrap(video); await new Promise(r => video.onloadeddata = r); - assertValueEqualTo(videoChrome, "totalPlayTime", 0); + assertValueEqualTo(videoChrome, "totalVideoPlayTime", 0); assertValueEqualTo(videoChrome, "invisiblePlayTime", 0); info(`start accumulating play time after media starts`); @@ -44,15 +44,15 @@ add_task(async function testTotalPlayTime() { once(video, "playing"), once(video, "moztotalplaytimestarted"), ]); - await assertValueConstantlyIncreases(videoChrome, "totalPlayTime"); + await assertValueConstantlyIncreases(videoChrome, "totalVideoPlayTime"); assertValueKeptUnchanged(videoChrome, "invisiblePlayTime"); assertValueKeptUnchanged(videoChrome, "videoDecodeSuspendedTime"); info(`should not accumulate time for paused video`); video.pause(); await once(video, "moztotalplaytimepaused"); - assertValueKeptUnchanged(videoChrome, "totalPlayTime"); - assertValueEqualTo(videoChrome, "totalPlayTime", 0); + assertValueKeptUnchanged(videoChrome, "totalVideoPlayTime"); + assertValueEqualTo(videoChrome, "totalVideoPlayTime", 0); info(`should start accumulating time again`); let rv = await Promise.all([ @@ -60,7 +60,7 @@ add_task(async function testTotalPlayTime() { video.play().then(_ => true, _ => false), ]); ok(returnTrueWhenAllValuesAreTrue(rv), "video started again"); - await assertValueConstantlyIncreases(videoChrome, "totalPlayTime"); + await assertValueConstantlyIncreases(videoChrome, "totalVideoPlayTime"); await cleanUpMediaAndCheckTelemetry(video); }); @@ -72,7 +72,7 @@ add_task(async function testVisiblePlayTime() { info(`all accumulated time should be zero`); const videoChrome = SpecialPowers.wrap(video); await new Promise(r => video.onloadeddata = r); - assertValueEqualTo(videoChrome, "totalPlayTime", 0); + assertValueEqualTo(videoChrome, "totalVideoPlayTime", 0); assertValueEqualTo(videoChrome, "visiblePlayTime", 0); assertValueEqualTo(videoChrome, "invisiblePlayTime", 0); @@ -82,14 +82,14 @@ add_task(async function testVisiblePlayTime() { once(video, "playing"), once(video, "moztotalplaytimestarted"), ]); - await assertValueConstantlyIncreases(videoChrome, "totalPlayTime"); + await assertValueConstantlyIncreases(videoChrome, "totalVideoPlayTime"); await assertValueConstantlyIncreases(videoChrome, "visiblePlayTime"); assertValueKeptUnchanged(videoChrome, "invisiblePlayTime"); info(`make video invisible`); video.style.display = "none"; await once(video, "mozinvisibleplaytimestarted"); - await assertValueConstantlyIncreases(videoChrome, "totalPlayTime"); + await assertValueConstantlyIncreases(videoChrome, "totalVideoPlayTime"); await assertValueConstantlyIncreases(videoChrome, "invisiblePlayTime"); assertValueKeptUnchanged(videoChrome, "visiblePlayTime"); await cleanUpMediaAndCheckTelemetry(video); @@ -171,14 +171,14 @@ add_task(async function testDecodeSuspendedTime() { video.play().then(_ => true, _ => false), ]); ok(returnTrueWhenAllValuesAreTrue(rv), "video started playing"); - await assertValueConstantlyIncreases(videoChrome, "totalPlayTime"); + await assertValueConstantlyIncreases(videoChrome, "totalVideoPlayTime"); assertValueKeptUnchanged(videoChrome, "invisiblePlayTime"); assertValueKeptUnchanged(videoChrome, "videoDecodeSuspendedTime"); info(`make it invisible and force to suspend decoding`); video.setVisible(false); await once(video, "mozvideodecodesuspendedstarted"); - await assertValueConstantlyIncreases(videoChrome, "totalPlayTime"); + await assertValueConstantlyIncreases(videoChrome, "totalVideoPlayTime"); await assertValueConstantlyIncreases(videoChrome, "invisiblePlayTime"); await assertValueConstantlyIncreases(videoChrome, "videoDecodeSuspendedTime"); @@ -188,7 +188,7 @@ add_task(async function testDecodeSuspendedTime() { once(video, "mozinvisibleplaytimepaused"), once(video, "mozvideodecodesuspendedpaused"), ]); - await assertValueConstantlyIncreases(videoChrome, "totalPlayTime"); + await assertValueConstantlyIncreases(videoChrome, "totalVideoPlayTime"); assertValueKeptUnchanged(videoChrome, "invisiblePlayTime"); assertValueKeptUnchanged(videoChrome, "videoDecodeSuspendedTime"); await cleanUpMediaAndCheckTelemetry(video); @@ -206,7 +206,7 @@ add_task(async function reuseSameElementForPlayback() { video.play().then(_ => true, _ => false), ]); ok(returnTrueWhenAllValuesAreTrue(rv), "video started again"); - await assertValueConstantlyIncreases(videoChrome, "totalPlayTime"); + await assertValueConstantlyIncreases(videoChrome, "totalVideoPlayTime"); info(`reset its src and all accumulated value should be reset after then`); // After setting its src to nothing, that would trigger a failed load and set @@ -218,7 +218,7 @@ add_task(async function reuseSameElementForPlayback() { cleanUpMediaAndCheckTelemetry(video), ]); // video doesn't have a decoder, so the return value would be -1 (error). - assertValueEqualTo(videoChrome, "totalPlayTime", -1); + assertValueEqualTo(videoChrome, "totalVideoPlayTime", -1); assertValueEqualTo(videoChrome, "invisiblePlayTime", -1); info(`resue same element, make it visible and start playback again`); @@ -228,7 +228,7 @@ add_task(async function reuseSameElementForPlayback() { video.play().then(_ => true, _ => false), ]); ok(returnTrueWhenAllValuesAreTrue(rv), "video started"); - await assertValueConstantlyIncreases(videoChrome, "totalPlayTime"); + await assertValueConstantlyIncreases(videoChrome, "totalVideoPlayTime"); await cleanUpMediaAndCheckTelemetry(video); }); @@ -395,7 +395,7 @@ function assertValueKeptUnchanged(mediaChrome, checkType) { function assertAllProbeRelatedAttributesKeptUnchanged(video) { const videoChrome = SpecialPowers.wrap(video); - assertValueKeptUnchanged(videoChrome, "totalPlayTime"); + assertValueKeptUnchanged(videoChrome, "totalVideoPlayTime"); assertValueKeptUnchanged(videoChrome, "invisiblePlayTime"); assertValueKeptUnchanged(videoChrome, "videoDecodeSuspendedTime"); } diff --git a/dom/webidl/HTMLMediaElement.webidl b/dom/webidl/HTMLMediaElement.webidl index 4c9f4f138fc9..1eb6265fdd9c 100644 --- a/dom/webidl/HTMLMediaElement.webidl +++ b/dom/webidl/HTMLMediaElement.webidl @@ -229,7 +229,7 @@ partial interface HTMLMediaElement { readonly attribute boolean isVideoDecodingSuspended; [ChromeOnly] - readonly attribute double totalPlayTime; + readonly attribute double totalVideoPlayTime; [ChromeOnly] readonly attribute double visiblePlayTime;