Skip to content

GitLab

T
tangled
Commit 6f83c851 authored by Robert Kaplow's avatar Robert Kaplow Committed by Commit Bot
Browse files
Options

Strict UKM entry whitelisting. 

Currently if there is no whitelist, we record everything. We shouldn't do this since if a user has no field trial params (first run, etc.), they will record everything, avoiding the whitelist.

Also changed a bitwise and to && while I was making a change. No-op but seems bad style (and apparently can be different as & doesn't shortcut).

Bug: 820632
Change-Id: I3fd3b1ca6669294e61467bb0f4d0ad87fb2ff576
Reviewed-on: https://chromium-review.googlesource.com/957384
Commit-Queue: Robert Kaplow <rkaplow@chromium.org>
Reviewed-by: default avatarSteven Holte <holte@chromium.org>
Cr-Commit-Position: refs/heads/master@{#544034}
parent 866affd2
Show whitespace changes
Inline Side-by-side
Showing with 63 additions and 26 deletions
components/metrics_services_manager/metrics_services_manager.cc
View file @ 6f83c851
......@@ -143,7 +143,7 @@ void MetricsServicesManager::UpdateUkmService() {
metrics_service_client_->IsHistorySyncEnabledOnAllProfiles();
bool is_incognito = client_->IsIncognitoSessionActive();
if (consent_given_ && sync_enabled & !is_incognito) {
if (consent_given_ && sync_enabled && !is_incognito) {
ukm->EnableRecording(
metrics_service_client_->IsExtensionSyncEnabledOnAllProfiles());
if (may_upload_)
......
components/ukm/test_ukm_recorder.cc
View file @ 6f83c851
......@@ -67,7 +67,13 @@ TestUkmRecorder::~TestUkmRecorder() {
};
bool TestUkmRecorder::ShouldRestrictToWhitelistedSourceIds() const {
// In tests, we want to record all source ids (not just hose that are
// In tests, we want to record all source ids (not just those that are
// whitelisted).
return false;
}
bool TestUkmRecorder::ShouldRestrictToWhitelistedEntries() const {
// In tests, we want to record all entries (not just those that are
// whitelisted).
return false;
}
......
components/ukm/test_ukm_recorder.h
View file @ 6f83c851
......@@ -29,6 +29,7 @@ class TestUkmRecorder : public UkmRecorderImpl {
~TestUkmRecorder() override;
bool ShouldRestrictToWhitelistedSourceIds() const override;
bool ShouldRestrictToWhitelistedEntries() const override;
size_t sources_count() const { return sources().size(); }
......
components/ukm/ukm_recorder_impl.cc
View file @ 6f83c851
......@@ -306,6 +306,10 @@ bool UkmRecorderImpl::ShouldRestrictToWhitelistedSourceIds() const {
kUkmFeature, "RestrictToWhitelistedSourceIds", false);
}
bool UkmRecorderImpl::ShouldRestrictToWhitelistedEntries() const {
return true;
}
UkmRecorderImpl::EventAggregate::EventAggregate() = default;
UkmRecorderImpl::EventAggregate::~EventAggregate() = default;
......@@ -371,7 +375,7 @@ void UkmRecorderImpl::AddEntry(mojom::UkmEntryPtr entry) {
return;
}
if (!whitelisted_entry_hashes_.empty() &&
if (ShouldRestrictToWhitelistedEntries() &&
!base::ContainsKey(whitelisted_entry_hashes_, entry->event_hash)) {
RecordDroppedEntry(DroppedDataReason::NOT_WHITELISTED);
return;
......
components/ukm/ukm_recorder_impl.h
View file @ 6f83c851
......@@ -69,6 +69,8 @@ class UkmRecorderImpl : public UkmRecorder {
virtual bool ShouldRestrictToWhitelistedSourceIds() const;
virtual bool ShouldRestrictToWhitelistedEntries() const;
private:
friend ::metrics::UkmBrowserTest;
friend ::metrics::UkmEGTestHelper;
......
components/ukm/ukm_service_unittest.cc
View file @ 6f83c851
......@@ -184,6 +184,10 @@ TEST_F(UkmServiceTest, EnableDisableSchedule) {
}
TEST_F(UkmServiceTest, PersistAndPurge) {
base::FieldTrialList field_trial_list(nullptr /* entropy_provider */);
ScopedUkmFeatureParams params(base::FeatureList::OVERRIDE_ENABLE_FEATURE,
{{"WhitelistEntries", "PageLoad"}});
UkmService service(&prefs_, &client_);
TestRecordingHelper recorder(&service);
EXPECT_EQ(GetPersistedLogCount(), 0);
......@@ -237,6 +241,10 @@ TEST_F(UkmServiceTest, SourceSerialization) {
}
TEST_F(UkmServiceTest, EntryBuilderAndSerialization) {
base::FieldTrialList field_trial_list(nullptr /* entropy_provider */);
ScopedUkmFeatureParams params(base::FeatureList::OVERRIDE_ENABLE_FEATURE,
{{"WhitelistEntries", "foo,bar"}});
UkmService service(&prefs_, &client_);
TestRecordingHelper recorder(&service);
EXPECT_EQ(0, GetPersistedLogCount());
......@@ -264,12 +272,12 @@ TEST_F(UkmServiceTest, EntryBuilderAndSerialization) {
Report proto_report = GetPersistedReport();
EXPECT_EQ(1, proto_report.sources_size());
ASSERT_EQ(1, proto_report.sources_size());
const Source& proto_source = proto_report.sources(0);
EXPECT_EQ(GURL("https://google.com/foobar").spec(), proto_source.url());
EXPECT_EQ(id, proto_source.id());
EXPECT_EQ(2, proto_report.entries_size());
ASSERT_EQ(2, proto_report.entries_size());
// Bar entry is the 0th entry here because bar_builder is destructed before
// foo_builder: the reverse order as they are constructed. To have the same
......@@ -278,7 +286,7 @@ TEST_F(UkmServiceTest, EntryBuilderAndSerialization) {
const Entry& proto_entry_bar = proto_report.entries(0);
EXPECT_EQ(id, proto_entry_bar.source_id());
EXPECT_EQ(base::HashMetricName("bar"), proto_entry_bar.event_hash());
EXPECT_EQ(2, proto_entry_bar.metrics_size());
ASSERT_EQ(2, proto_entry_bar.metrics_size());
const Entry::Metric proto_entry_bar_start = proto_entry_bar.metrics(0);
EXPECT_EQ(base::HashMetricName("bar_start"),
proto_entry_bar_start.metric_hash());
......@@ -290,7 +298,7 @@ TEST_F(UkmServiceTest, EntryBuilderAndSerialization) {
const Entry& proto_entry_foo = proto_report.entries(1);
EXPECT_EQ(id, proto_entry_foo.source_id());
EXPECT_EQ(base::HashMetricName("foo"), proto_entry_foo.event_hash());
EXPECT_EQ(2, proto_entry_foo.metrics_size());
ASSERT_EQ(2, proto_entry_foo.metrics_size());
const Entry::Metric proto_entry_foo_start = proto_entry_foo.metrics(0);
EXPECT_EQ(base::HashMetricName("foo_start"),
proto_entry_foo_start.metric_hash());
......@@ -301,9 +309,13 @@ TEST_F(UkmServiceTest, EntryBuilderAndSerialization) {
}
TEST_F(UkmServiceTest, AddEntryWithEmptyMetrics) {
base::FieldTrialList field_trial_list(nullptr /* entropy_provider */);
ScopedUkmFeatureParams params(base::FeatureList::OVERRIDE_ENABLE_FEATURE,
{{"WhitelistEntries", "PageLoad"}});
UkmService service(&prefs_, &client_);
TestRecordingHelper recorder(&service);
EXPECT_EQ(0, GetPersistedLogCount());
ASSERT_EQ(0, GetPersistedLogCount());
service.Initialize();
task_runner_->RunUntilIdle();
service.EnableRecording(/*extensions=*/false);
......@@ -314,12 +326,16 @@ TEST_F(UkmServiceTest, AddEntryWithEmptyMetrics) {
{ ::ukm::builders::PageLoad(id).Record(&service); }
service.Flush();
EXPECT_EQ(1, GetPersistedLogCount());
ASSERT_EQ(1, GetPersistedLogCount());
Report proto_report = GetPersistedReport();
EXPECT_EQ(1, proto_report.entries_size());
}
TEST_F(UkmServiceTest, MetricsProviderTest) {
base::FieldTrialList field_trial_list(nullptr /* entropy_provider */);
ScopedUkmFeatureParams params(base::FeatureList::OVERRIDE_ENABLE_FEATURE,
{{"WhitelistEntries", "PageLoad"}});
UkmService service(&prefs_, &client_);
TestRecordingHelper recorder(&service);
......@@ -395,6 +411,11 @@ TEST_F(UkmServiceTest, LogsRotation) {
}
TEST_F(UkmServiceTest, LogsUploadedOnlyWhenHavingSourcesOrEntries) {
base::FieldTrialList field_trial_list(nullptr /* entropy_provider */);
// Testing two whitelisted Entries.
ScopedUkmFeatureParams params(base::FeatureList::OVERRIDE_ENABLE_FEATURE,
{{"WhitelistEntries", "PageLoad"}});
UkmService service(&prefs_, &client_);
TestRecordingHelper recorder(&service);
EXPECT_EQ(GetPersistedLogCount(), 0);
......@@ -493,7 +514,8 @@ TEST_F(UkmServiceTest, RestrictToWhitelistedSourceIds) {
ScopedUkmFeatureParams params(
base::FeatureList::OVERRIDE_ENABLE_FEATURE,
{{"RestrictToWhitelistedSourceIds",
restrict_to_whitelisted_source_ids ? "true" : "false"}});
restrict_to_whitelisted_source_ids ? "true" : "false"},
{"WhitelistEntries", "FakeEntry"}});
ClearPrefs();
UkmService service(&prefs_, &client_);
......@@ -514,9 +536,9 @@ TEST_F(UkmServiceTest, RestrictToWhitelistedSourceIds) {
recorder.GetEntryBuilder(id2, "FakeEntry");
service.Flush();
EXPECT_EQ(GetPersistedLogCount(), 1);
ASSERT_EQ(GetPersistedLogCount(), 1);
Report proto_report = GetPersistedReport();
EXPECT_GE(proto_report.sources_size(), 1);
ASSERT_GE(proto_report.sources_size(), 1);
// The whitelisted source should always be recorded.
const Source& proto_source1 = proto_report.sources(0);
......@@ -526,9 +548,9 @@ TEST_F(UkmServiceTest, RestrictToWhitelistedSourceIds) {
// The non-whitelisted source should only be recorded if we aren't
// restricted to whitelisted source ids.
if (restrict_to_whitelisted_source_ids) {
EXPECT_EQ(1, proto_report.sources_size());
ASSERT_EQ(1, proto_report.sources_size());
} else {
EXPECT_EQ(2, proto_report.sources_size());
ASSERT_EQ(2, proto_report.sources_size());
const Source& proto_source2 = proto_report.sources(1);
EXPECT_EQ(id2, proto_source2.id());
EXPECT_EQ(kURL.spec(), proto_source2.url());
......@@ -811,14 +833,15 @@ TEST_F(UkmServiceTest, NonWhitelistedUrls) {
};
base::FieldTrialList field_trial_list(nullptr /* entropy_provider */);
ScopedUkmFeatureParams params(base::FeatureList::OVERRIDE_ENABLE_FEATURE, {});
ScopedUkmFeatureParams params(base::FeatureList::OVERRIDE_ENABLE_FEATURE,
{{"WhitelistEntries", "FakeEntry"}});
for (const auto& test : test_cases) {
ClearPrefs();
UkmService service(&prefs_, &client_);
TestRecordingHelper recorder(&service);
EXPECT_EQ(GetPersistedLogCount(), 0);
ASSERT_EQ(GetPersistedLogCount(), 0);
service.Initialize();
task_runner_->RunUntilIdle();
service.EnableRecording(/*extensions=*/false);
......@@ -834,21 +857,21 @@ TEST_F(UkmServiceTest, NonWhitelistedUrls) {
recorder.GetEntryBuilder(nonwhitelist_id, "FakeEntry");
service.Flush();
EXPECT_EQ(1, GetPersistedLogCount());
ASSERT_EQ(1, GetPersistedLogCount());
auto proto_report = GetPersistedReport();
EXPECT_EQ(2, proto_report.source_counts().observed());
EXPECT_EQ(1, proto_report.source_counts().navigation_sources());
if (test.expected_kept) {
EXPECT_EQ(0, proto_report.source_counts().unmatched_sources());
EXPECT_EQ(2, proto_report.sources_size());
ASSERT_EQ(2, proto_report.sources_size());
EXPECT_EQ(whitelist_id, proto_report.sources(0).id());
EXPECT_EQ(kURL, proto_report.sources(0).url());
EXPECT_EQ(nonwhitelist_id, proto_report.sources(1).id());
EXPECT_EQ(test.url, proto_report.sources(1).url());
} else {
EXPECT_EQ(1, proto_report.source_counts().unmatched_sources());
EXPECT_EQ(1, proto_report.sources_size());
ASSERT_EQ(1, proto_report.sources_size());
EXPECT_EQ(whitelist_id, proto_report.sources(0).id());
EXPECT_EQ(kURL, proto_report.sources(0).url());
}
......@@ -895,7 +918,8 @@ TEST_F(UkmServiceTest, NonWhitelistedCarryoverUrls) {
};
base::FieldTrialList field_trial_list(nullptr /* entropy_provider */);
ScopedUkmFeatureParams params(base::FeatureList::OVERRIDE_ENABLE_FEATURE, {});
ScopedUkmFeatureParams params(base::FeatureList::OVERRIDE_ENABLE_FEATURE,
{{"WhitelistEntries", "FakeEntry"}});
for (const auto& test : test_cases) {
ClearPrefs();
......@@ -917,7 +941,7 @@ TEST_F(UkmServiceTest, NonWhitelistedCarryoverUrls) {
recorder.UpdateSourceURL(nonwhitelist_id1, test.source1_url);
service.Flush();
EXPECT_EQ(1, GetPersistedLogCount());
ASSERT_EQ(1, GetPersistedLogCount());
auto proto_report = GetPersistedReport();
EXPECT_EQ(2, proto_report.source_counts().observed());
......@@ -930,7 +954,7 @@ TEST_F(UkmServiceTest, NonWhitelistedCarryoverUrls) {
EXPECT_EQ(1, proto_report.source_counts().unmatched_sources());
EXPECT_EQ(0, proto_report.source_counts().deferred_sources());
}
EXPECT_EQ(1, proto_report.sources_size());
ASSERT_EQ(1, proto_report.sources_size());
EXPECT_EQ(whitelist_id, proto_report.sources(0).id());
EXPECT_EQ(kURL, proto_report.sources(0).url());
......@@ -941,7 +965,7 @@ TEST_F(UkmServiceTest, NonWhitelistedCarryoverUrls) {
recorder.GetEntryBuilder(nonwhitelist_id2, "FakeEntry");
service.Flush();
EXPECT_EQ(2, GetPersistedLogCount());
ASSERT_EQ(2, GetPersistedLogCount());
proto_report = GetPersistedReport();
EXPECT_EQ(1, proto_report.source_counts().observed());
......@@ -951,17 +975,17 @@ TEST_F(UkmServiceTest, NonWhitelistedCarryoverUrls) {
EXPECT_FALSE(test.expect_source2);
EXPECT_EQ(1, proto_report.source_counts().unmatched_sources());
EXPECT_EQ(0, proto_report.source_counts().carryover_sources());
EXPECT_EQ(0, proto_report.sources_size());
ASSERT_EQ(0, proto_report.sources_size());
} else if (!test.expect_source2) {
EXPECT_EQ(1, proto_report.source_counts().unmatched_sources());
EXPECT_EQ(1, proto_report.source_counts().carryover_sources());
EXPECT_EQ(1, proto_report.sources_size());
ASSERT_EQ(1, proto_report.sources_size());
EXPECT_EQ(nonwhitelist_id1, proto_report.sources(0).id());
EXPECT_EQ(test.source1_url, proto_report.sources(0).url());
} else {
EXPECT_EQ(0, proto_report.source_counts().unmatched_sources());
EXPECT_EQ(1, proto_report.source_counts().carryover_sources());
EXPECT_EQ(2, proto_report.sources_size());
ASSERT_EQ(2, proto_report.sources_size());
EXPECT_EQ(nonwhitelist_id1, proto_report.sources(0).id());
EXPECT_EQ(test.source1_url, proto_report.sources(0).url());
EXPECT_EQ(nonwhitelist_id2, proto_report.sources(1).id());
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment