blob: eea8102dfbe214e0c773e9515aa6a16d26765ad2 [file] [log] [blame]
// Copyright 2016 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "content/browser/media/audible_metrics.h"
#include "base/metrics/histogram_samples.h"
#include "base/test/metrics/histogram_tester.h"
#include "base/test/metrics/user_action_tester.h"
#include "base/test/simple_test_tick_clock.h"
#include "content/browser/media/media_web_contents_observer.h"
#include "content/public/test/test_renderer_host.h"
#include "content/test/test_web_contents.h"
#include "testing/gtest/include/gtest/gtest.h"
namespace content {
namespace {
static const WebContents* WEB_CONTENTS_0 = reinterpret_cast<WebContents*>(0x00);
static const WebContents* WEB_CONTENTS_1 = reinterpret_cast<WebContents*>(0x01);
static const WebContents* WEB_CONTENTS_2 = reinterpret_cast<WebContents*>(0x10);
static const WebContents* WEB_CONTENTS_3 = reinterpret_cast<WebContents*>(0x11);
static const char* CONCURRENT_TAB_WHEN_STARTING_HISTOGRAM =
"Media.Audible.ConcurrentTabsWhenStarting";
static const char* MAX_CONCURRENT_TAB_IN_SESSION_HISTOGRAM =
"Media.Audible.MaxConcurrentTabsInSession";
static const char* CONCURRENT_TABS_TIME_HISTOGRAM =
"Media.Audible.ConcurrentTabsTime";
static const char* CLOSE_NEWEST_TAB_HISTOGRAM =
"Media.Audible.CloseNewestToExitConcurrentPlayback";
class AudibleMetricsTest : public RenderViewHostTestHarness {
public:
AudibleMetricsTest() = default;
void SetUp() override {
RenderViewHostTestHarness::SetUp();
audible_metrics_ = std::make_unique<AudibleMetrics>();
// Set the clock to a value different than 0 so the time it gives is
// recognized as initialized.
clock_.Advance(base::TimeDelta::FromMilliseconds(1));
audible_metrics_->SetClockForTest(&clock_);
}
void TearDown() override {
audible_metrics_.reset();
RenderViewHostTestHarness::TearDown();
}
base::SimpleTestTickClock* clock() { return &clock_; }
AudibleMetrics* audible_metrics() { return audible_metrics_.get(); };
const base::UserActionTester& user_action_tester() const {
return user_action_tester_;
}
std::unique_ptr<base::HistogramSamples> GetHistogramSamplesSinceTestStart(
const std::string& name) {
return histogram_tester_.GetHistogramSamplesSinceCreation(name);
}
TestWebContents* test_web_contents() {
return static_cast<TestWebContents*>(web_contents());
}
private:
std::unique_ptr<AudibleMetrics> audible_metrics_;
base::SimpleTestTickClock clock_;
base::HistogramTester histogram_tester_;
base::UserActionTester user_action_tester_;
DISALLOW_COPY_AND_ASSIGN(AudibleMetricsTest);
};
} // anonymous namespace
TEST_F(AudibleMetricsTest, CreateAndKillDoesNothing) {
{ std::unique_ptr<AudibleMetrics> audible_metrics(new AudibleMetrics()); }
{
std::unique_ptr<base::HistogramSamples> samples(
GetHistogramSamplesSinceTestStart(
CONCURRENT_TAB_WHEN_STARTING_HISTOGRAM));
EXPECT_EQ(0, samples->TotalCount());
}
{
std::unique_ptr<base::HistogramSamples> samples(
GetHistogramSamplesSinceTestStart(
MAX_CONCURRENT_TAB_IN_SESSION_HISTOGRAM));
EXPECT_EQ(0, samples->TotalCount());
}
{
std::unique_ptr<base::HistogramSamples> samples(
GetHistogramSamplesSinceTestStart(CONCURRENT_TABS_TIME_HISTOGRAM));
EXPECT_EQ(0, samples->TotalCount());
}
}
TEST_F(AudibleMetricsTest, AudibleStart) {
audible_metrics()->UpdateAudibleWebContentsState(WEB_CONTENTS_0, true);
{
std::unique_ptr<base::HistogramSamples> samples(
GetHistogramSamplesSinceTestStart(
CONCURRENT_TAB_WHEN_STARTING_HISTOGRAM));
EXPECT_EQ(1, samples->TotalCount());
EXPECT_EQ(1, samples->GetCount(0));
}
{
std::unique_ptr<base::HistogramSamples> samples(
GetHistogramSamplesSinceTestStart(
MAX_CONCURRENT_TAB_IN_SESSION_HISTOGRAM));
EXPECT_EQ(1, samples->TotalCount());
EXPECT_EQ(1, samples->GetCount(1));
}
{
std::unique_ptr<base::HistogramSamples> samples(
GetHistogramSamplesSinceTestStart(CONCURRENT_TABS_TIME_HISTOGRAM));
EXPECT_EQ(0, samples->TotalCount());
}
}
TEST_F(AudibleMetricsTest, AudibleStartAndStop) {
audible_metrics()->UpdateAudibleWebContentsState(WEB_CONTENTS_0, true);
audible_metrics()->UpdateAudibleWebContentsState(WEB_CONTENTS_0, false);
{
std::unique_ptr<base::HistogramSamples> samples(
GetHistogramSamplesSinceTestStart(
CONCURRENT_TAB_WHEN_STARTING_HISTOGRAM));
EXPECT_EQ(1, samples->TotalCount());
EXPECT_EQ(1, samples->GetCount(0));
}
{
std::unique_ptr<base::HistogramSamples> samples(
GetHistogramSamplesSinceTestStart(
MAX_CONCURRENT_TAB_IN_SESSION_HISTOGRAM));
EXPECT_EQ(1, samples->TotalCount());
EXPECT_EQ(1, samples->GetCount(1));
}
{
std::unique_ptr<base::HistogramSamples> samples(
GetHistogramSamplesSinceTestStart(CONCURRENT_TABS_TIME_HISTOGRAM));
EXPECT_EQ(0, samples->TotalCount());
}
}
TEST_F(AudibleMetricsTest, AddSameTabIsNoOp) {
audible_metrics()->UpdateAudibleWebContentsState(WEB_CONTENTS_0, true);
audible_metrics()->UpdateAudibleWebContentsState(WEB_CONTENTS_0, true);
audible_metrics()->UpdateAudibleWebContentsState(WEB_CONTENTS_0, true);
audible_metrics()->UpdateAudibleWebContentsState(WEB_CONTENTS_0, true);
audible_metrics()->UpdateAudibleWebContentsState(WEB_CONTENTS_0, true);
{
std::unique_ptr<base::HistogramSamples> samples(
GetHistogramSamplesSinceTestStart(
CONCURRENT_TAB_WHEN_STARTING_HISTOGRAM));
EXPECT_EQ(1, samples->TotalCount());
EXPECT_EQ(1, samples->GetCount(0));
}
{
std::unique_ptr<base::HistogramSamples> samples(
GetHistogramSamplesSinceTestStart(
MAX_CONCURRENT_TAB_IN_SESSION_HISTOGRAM));
EXPECT_EQ(1, samples->TotalCount());
EXPECT_EQ(1, samples->GetCount(1));
}
{
std::unique_ptr<base::HistogramSamples> samples(
GetHistogramSamplesSinceTestStart(CONCURRENT_TABS_TIME_HISTOGRAM));
EXPECT_EQ(0, samples->TotalCount());
}
}
TEST_F(AudibleMetricsTest, RemoveUnknownTabIsNoOp) {
audible_metrics()->UpdateAudibleWebContentsState(WEB_CONTENTS_0, false);
audible_metrics()->UpdateAudibleWebContentsState(WEB_CONTENTS_0, false);
EXPECT_EQ(0, GetHistogramSamplesSinceTestStart(
CONCURRENT_TAB_WHEN_STARTING_HISTOGRAM)->TotalCount());
EXPECT_EQ(0, GetHistogramSamplesSinceTestStart(
MAX_CONCURRENT_TAB_IN_SESSION_HISTOGRAM)->TotalCount());
EXPECT_EQ(0, GetHistogramSamplesSinceTestStart(
CONCURRENT_TABS_TIME_HISTOGRAM)->TotalCount());
}
TEST_F(AudibleMetricsTest, ConcurrentTabsInSessionIsIncremental) {
audible_metrics()->UpdateAudibleWebContentsState(WEB_CONTENTS_0, true);
audible_metrics()->UpdateAudibleWebContentsState(WEB_CONTENTS_1, true);
audible_metrics()->UpdateAudibleWebContentsState(WEB_CONTENTS_2, true);
audible_metrics()->UpdateAudibleWebContentsState(WEB_CONTENTS_3, true);
std::unique_ptr<base::HistogramSamples> samples(
GetHistogramSamplesSinceTestStart(
MAX_CONCURRENT_TAB_IN_SESSION_HISTOGRAM));
EXPECT_EQ(4, samples->TotalCount());
EXPECT_EQ(1, samples->GetCount(1));
EXPECT_EQ(1, samples->GetCount(2));
EXPECT_EQ(1, samples->GetCount(3));
EXPECT_EQ(1, samples->GetCount(4));
}
TEST_F(AudibleMetricsTest, ConcurrentTabsInSessionKeepTrackOfRemovedTabs) {
audible_metrics()->UpdateAudibleWebContentsState(WEB_CONTENTS_0, true);
audible_metrics()->UpdateAudibleWebContentsState(WEB_CONTENTS_0, false);
audible_metrics()->UpdateAudibleWebContentsState(WEB_CONTENTS_1, true);
audible_metrics()->UpdateAudibleWebContentsState(WEB_CONTENTS_2, true);
audible_metrics()->UpdateAudibleWebContentsState(WEB_CONTENTS_1, false);
audible_metrics()->UpdateAudibleWebContentsState(WEB_CONTENTS_2, false);
audible_metrics()->UpdateAudibleWebContentsState(WEB_CONTENTS_3, true);
std::unique_ptr<base::HistogramSamples> samples(
GetHistogramSamplesSinceTestStart(
MAX_CONCURRENT_TAB_IN_SESSION_HISTOGRAM));
EXPECT_EQ(2, samples->TotalCount());
EXPECT_EQ(1, samples->GetCount(1));
EXPECT_EQ(1, samples->GetCount(2));
}
TEST_F(AudibleMetricsTest, ConcurrentTabsInSessionIsNotCountedTwice) {
audible_metrics()->UpdateAudibleWebContentsState(WEB_CONTENTS_0, true);
audible_metrics()->UpdateAudibleWebContentsState(WEB_CONTENTS_1, true);
audible_metrics()->UpdateAudibleWebContentsState(WEB_CONTENTS_2, true);
audible_metrics()->UpdateAudibleWebContentsState(WEB_CONTENTS_3, true);
audible_metrics()->UpdateAudibleWebContentsState(WEB_CONTENTS_0, false);
audible_metrics()->UpdateAudibleWebContentsState(WEB_CONTENTS_1, false);
audible_metrics()->UpdateAudibleWebContentsState(WEB_CONTENTS_2, false);
audible_metrics()->UpdateAudibleWebContentsState(WEB_CONTENTS_3, false);
audible_metrics()->UpdateAudibleWebContentsState(WEB_CONTENTS_0, true);
audible_metrics()->UpdateAudibleWebContentsState(WEB_CONTENTS_1, true);
audible_metrics()->UpdateAudibleWebContentsState(WEB_CONTENTS_2, true);
audible_metrics()->UpdateAudibleWebContentsState(WEB_CONTENTS_3, true);
std::unique_ptr<base::HistogramSamples> samples(
GetHistogramSamplesSinceTestStart(
MAX_CONCURRENT_TAB_IN_SESSION_HISTOGRAM));
EXPECT_EQ(4, samples->TotalCount());
EXPECT_EQ(1, samples->GetCount(1));
EXPECT_EQ(1, samples->GetCount(2));
EXPECT_EQ(1, samples->GetCount(3));
EXPECT_EQ(1, samples->GetCount(4));
}
TEST_F(AudibleMetricsTest, ConcurrentTabsWhenStartingAddedPerTab) {
audible_metrics()->UpdateAudibleWebContentsState(WEB_CONTENTS_0, true);
audible_metrics()->UpdateAudibleWebContentsState(WEB_CONTENTS_1, true);
{
std::unique_ptr<base::HistogramSamples> samples(
GetHistogramSamplesSinceTestStart(
CONCURRENT_TAB_WHEN_STARTING_HISTOGRAM));
EXPECT_EQ(2, samples->TotalCount());
EXPECT_EQ(1, samples->GetCount(0));
EXPECT_EQ(1, samples->GetCount(1));
}
// Added again: ignored.
audible_metrics()->UpdateAudibleWebContentsState(WEB_CONTENTS_0, true);
audible_metrics()->UpdateAudibleWebContentsState(WEB_CONTENTS_1, true);
{
std::unique_ptr<base::HistogramSamples> samples(
GetHistogramSamplesSinceTestStart(
CONCURRENT_TAB_WHEN_STARTING_HISTOGRAM));
EXPECT_EQ(2, samples->TotalCount());
EXPECT_EQ(1, samples->GetCount(0));
EXPECT_EQ(1, samples->GetCount(1));
}
// Removing both.
audible_metrics()->UpdateAudibleWebContentsState(WEB_CONTENTS_0, false);
audible_metrics()->UpdateAudibleWebContentsState(WEB_CONTENTS_1, false);
{
std::unique_ptr<base::HistogramSamples> samples(
GetHistogramSamplesSinceTestStart(
CONCURRENT_TAB_WHEN_STARTING_HISTOGRAM));
EXPECT_EQ(2, samples->TotalCount());
EXPECT_EQ(1, samples->GetCount(0));
EXPECT_EQ(1, samples->GetCount(1));
}
// Adding them after removed, it is counted.
audible_metrics()->UpdateAudibleWebContentsState(WEB_CONTENTS_0, true);
audible_metrics()->UpdateAudibleWebContentsState(WEB_CONTENTS_1, true);
{
std::unique_ptr<base::HistogramSamples> samples(
GetHistogramSamplesSinceTestStart(
CONCURRENT_TAB_WHEN_STARTING_HISTOGRAM));
EXPECT_EQ(4, samples->TotalCount());
EXPECT_EQ(2, samples->GetCount(0));
EXPECT_EQ(2, samples->GetCount(1));
}
}
TEST_F(AudibleMetricsTest, ConcurrentTabsTimeRequiresTwoAudibleTabs) {
audible_metrics()->UpdateAudibleWebContentsState(WEB_CONTENTS_0, true);
audible_metrics()->UpdateAudibleWebContentsState(WEB_CONTENTS_1, true);
clock()->Advance(base::TimeDelta::FromMilliseconds(1000));
// No record because concurrent audible tabs still running.
EXPECT_EQ(0, GetHistogramSamplesSinceTestStart(
CONCURRENT_TABS_TIME_HISTOGRAM)->TotalCount());
// No longer concurrent.
audible_metrics()->UpdateAudibleWebContentsState(WEB_CONTENTS_0, false);
{
std::unique_ptr<base::HistogramSamples> samples(
GetHistogramSamplesSinceTestStart(CONCURRENT_TABS_TIME_HISTOGRAM));
EXPECT_EQ(1, samples->TotalCount());
EXPECT_EQ(1, samples->GetCount(1000));
}
// Stopping the second tab is a no-op.
audible_metrics()->UpdateAudibleWebContentsState(WEB_CONTENTS_1, false);
{
std::unique_ptr<base::HistogramSamples> samples(
GetHistogramSamplesSinceTestStart(CONCURRENT_TABS_TIME_HISTOGRAM));
EXPECT_EQ(1, samples->TotalCount());
EXPECT_EQ(1, samples->GetCount(1000));
}
}
TEST_F(AudibleMetricsTest, ConcurrentTabsTimeRunsAsLongAsTwoAudibleTabs) {
audible_metrics()->UpdateAudibleWebContentsState(WEB_CONTENTS_0, true);
audible_metrics()->UpdateAudibleWebContentsState(WEB_CONTENTS_1, true);
clock()->Advance(base::TimeDelta::FromMilliseconds(1000));
audible_metrics()->UpdateAudibleWebContentsState(WEB_CONTENTS_2, true);
clock()->Advance(base::TimeDelta::FromMilliseconds(500));
// Mutes one of the three audible tabs.
audible_metrics()->UpdateAudibleWebContentsState(WEB_CONTENTS_1, false);
// No record because concurrent audible tabs still running.
EXPECT_EQ(0, GetHistogramSamplesSinceTestStart(
CONCURRENT_TABS_TIME_HISTOGRAM)->TotalCount());
// Mutes the first audible tab.
audible_metrics()->UpdateAudibleWebContentsState(WEB_CONTENTS_0, false);
{
std::unique_ptr<base::HistogramSamples> samples(
GetHistogramSamplesSinceTestStart(CONCURRENT_TABS_TIME_HISTOGRAM));
EXPECT_EQ(1, samples->TotalCount());
EXPECT_EQ(1, samples->GetCount(1500));
}
}
TEST_F(AudibleMetricsTest, MediaWebContentsObserver_Audible_Muted) {
MediaWebContentsObserver media_observer(test_web_contents());
media_observer.SetAudibleMetricsForTest(audible_metrics());
test_web_contents()->SetAudioMuted(true);
test_web_contents()
->audio_stream_monitor()
->set_is_currently_audible_for_testing(true);
EXPECT_TRUE(
test_web_contents()->audio_stream_monitor()->IsCurrentlyAudible());
EXPECT_TRUE(test_web_contents()->IsAudioMuted());
EXPECT_EQ(0, audible_metrics()->GetAudibleWebContentsSizeForTest());
media_observer.MaybeUpdateAudibleState();
EXPECT_EQ(0, audible_metrics()->GetAudibleWebContentsSizeForTest());
}
TEST_F(AudibleMetricsTest, MediaWebContentsObserver_Audible_NotMuted) {
MediaWebContentsObserver media_observer(test_web_contents());
media_observer.SetAudibleMetricsForTest(audible_metrics());
test_web_contents()
->audio_stream_monitor()
->set_is_currently_audible_for_testing(true);
EXPECT_TRUE(
test_web_contents()->audio_stream_monitor()->IsCurrentlyAudible());
EXPECT_FALSE(test_web_contents()->IsAudioMuted());
EXPECT_EQ(0, audible_metrics()->GetAudibleWebContentsSizeForTest());
media_observer.MaybeUpdateAudibleState();
EXPECT_EQ(1, audible_metrics()->GetAudibleWebContentsSizeForTest());
}
TEST_F(AudibleMetricsTest, MediaWebContentsObserver_NotAudible_Muted) {
MediaWebContentsObserver media_observer(test_web_contents());
media_observer.SetAudibleMetricsForTest(audible_metrics());
test_web_contents()->SetAudioMuted(true);
EXPECT_FALSE(
test_web_contents()->audio_stream_monitor()->IsCurrentlyAudible());
EXPECT_TRUE(test_web_contents()->IsAudioMuted());
EXPECT_EQ(0, audible_metrics()->GetAudibleWebContentsSizeForTest());
media_observer.MaybeUpdateAudibleState();
EXPECT_EQ(0, audible_metrics()->GetAudibleWebContentsSizeForTest());
}
TEST_F(AudibleMetricsTest, MediaWebContentsObserver_NotAudible_NotMuted) {
MediaWebContentsObserver media_observer(test_web_contents());
media_observer.SetAudibleMetricsForTest(audible_metrics());
EXPECT_FALSE(
test_web_contents()->audio_stream_monitor()->IsCurrentlyAudible());
EXPECT_FALSE(test_web_contents()->IsAudioMuted());
EXPECT_EQ(0, audible_metrics()->GetAudibleWebContentsSizeForTest());
media_observer.MaybeUpdateAudibleState();
EXPECT_EQ(0, audible_metrics()->GetAudibleWebContentsSizeForTest());
}
TEST_F(AudibleMetricsTest, CloseNewestAudibleTabHistogram_IgnoreNotAudible) {
audible_metrics()->UpdateAudibleWebContentsState(WEB_CONTENTS_0, true);
audible_metrics()->UpdateAudibleWebContentsState(WEB_CONTENTS_0, false);
audible_metrics()->WebContentsDestroyed(WEB_CONTENTS_0);
{
std::unique_ptr<base::HistogramSamples> samples(
GetHistogramSamplesSinceTestStart(CLOSE_NEWEST_TAB_HISTOGRAM));
EXPECT_EQ(0, samples->TotalCount());
}
}
TEST_F(AudibleMetricsTest, CloseNewestAudibleTabHistogram_Newest) {
audible_metrics()->UpdateAudibleWebContentsState(WEB_CONTENTS_0, true);
audible_metrics()->UpdateAudibleWebContentsState(WEB_CONTENTS_1, true);
audible_metrics()->UpdateAudibleWebContentsState(WEB_CONTENTS_2, true);
audible_metrics()->WebContentsDestroyed(WEB_CONTENTS_2);
{
std::unique_ptr<base::HistogramSamples> samples(
GetHistogramSamplesSinceTestStart(CLOSE_NEWEST_TAB_HISTOGRAM));
EXPECT_EQ(0, samples->TotalCount());
EXPECT_EQ(
0, samples->GetCount(static_cast<int>(
AudibleMetrics::ExitConcurrentPlaybackContents::kMostRecent)));
}
audible_metrics()->WebContentsDestroyed(WEB_CONTENTS_1);
{
std::unique_ptr<base::HistogramSamples> samples(
GetHistogramSamplesSinceTestStart(CLOSE_NEWEST_TAB_HISTOGRAM));
EXPECT_EQ(1, samples->TotalCount());
EXPECT_EQ(
1, samples->GetCount(static_cast<int>(
AudibleMetrics::ExitConcurrentPlaybackContents::kMostRecent)));
}
audible_metrics()->WebContentsDestroyed(WEB_CONTENTS_0);
{
std::unique_ptr<base::HistogramSamples> samples(
GetHistogramSamplesSinceTestStart(CLOSE_NEWEST_TAB_HISTOGRAM));
EXPECT_EQ(1, samples->TotalCount());
EXPECT_EQ(
1, samples->GetCount(static_cast<int>(
AudibleMetrics::ExitConcurrentPlaybackContents::kMostRecent)));
}
}
TEST_F(AudibleMetricsTest, CloseNewestAudibleTabHistogram_Old) {
audible_metrics()->UpdateAudibleWebContentsState(WEB_CONTENTS_0, true);
audible_metrics()->UpdateAudibleWebContentsState(WEB_CONTENTS_1, true);
audible_metrics()->UpdateAudibleWebContentsState(WEB_CONTENTS_2, true);
audible_metrics()->WebContentsDestroyed(WEB_CONTENTS_1);
{
std::unique_ptr<base::HistogramSamples> samples(
GetHistogramSamplesSinceTestStart(CLOSE_NEWEST_TAB_HISTOGRAM));
EXPECT_EQ(0, samples->TotalCount());
EXPECT_EQ(0, samples->GetCount(0));
EXPECT_EQ(0, samples->GetCount(static_cast<int>(
AudibleMetrics::ExitConcurrentPlaybackContents::kOlder)));
}
audible_metrics()->WebContentsDestroyed(WEB_CONTENTS_0);
{
std::unique_ptr<base::HistogramSamples> samples(
GetHistogramSamplesSinceTestStart(CLOSE_NEWEST_TAB_HISTOGRAM));
EXPECT_EQ(1, samples->TotalCount());
EXPECT_EQ(1, samples->GetCount(static_cast<int>(
AudibleMetrics::ExitConcurrentPlaybackContents::kOlder)));
}
audible_metrics()->WebContentsDestroyed(WEB_CONTENTS_2);
{
std::unique_ptr<base::HistogramSamples> samples(
GetHistogramSamplesSinceTestStart(CLOSE_NEWEST_TAB_HISTOGRAM));
EXPECT_EQ(1, samples->TotalCount());
EXPECT_EQ(1, samples->GetCount(static_cast<int>(
AudibleMetrics::ExitConcurrentPlaybackContents::kOlder)));
}
}
} // namespace content