1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254
|
// Copyright 2022 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "components/permissions/notifications_engagement_service.h"
#include "base/metrics/histogram.h"
#include "base/numerics/safe_conversions.h"
#include "base/strings/string_number_conversions.h"
#include "base/values.h"
#include "components/permissions/permissions_client.h"
#include "url/gurl.h"
namespace permissions {
namespace {
// For each origin that has the |ContentSettingsType::NOTIFICATIONS|
// permission, we record the number of notifications that were displayed
// and interacted with. The data is stored in the website setting
// |NOTIFICATION_INTERACTIONS| keyed to the same origin. The internal
// structure of this metadata is a dictionary:
//
// {"1644163200": {"display_count": 3}, # Implied click_count = 0.
// "1644768000": {"display_count": 6, "click_count": 1}}
//
// Currently, entries will be recorded daily.
constexpr char kEngagementKey[] = "click_count";
constexpr char kDisplayedKey[] = "display_count";
// Entries in notifications engagement expire after they become this old.
constexpr base::TimeDelta kMaxAge = base::Days(30);
// Discards notification interactions stored in `engagement` for time
// periods older than |kMaxAge|.
void EraseStaleEntries(base::Value::Dict& engagement) {
const base::Time cutoff = base::Time::Now() - kMaxAge;
for (auto it = engagement.begin(); it != engagement.end();) {
const auto& [key, value] = *it;
std::optional<base::Time> last_time =
NotificationsEngagementService::ParsePeriodBeginFromBucketLabel(key);
if (!last_time.has_value() || last_time.value() < cutoff) {
it = engagement.erase(it);
continue;
}
++it;
}
}
int ExtractNotificationCount(const base::Value::Dict& engagement,
std::string date) {
const base::Value::Dict* bucket = engagement.FindDict(date);
if (!bucket) {
return 0;
}
return bucket->FindInt(kDisplayedKey).value_or(0);
}
void ReportNotificationEngagement(std::string_view type,
int daily_notification_count,
double site_engagement_score,
int count) {
if (count <= 0) {
return;
}
std::string_view volume;
if (daily_notification_count < 0) {
return;
} else if (daily_notification_count == 0) {
volume = "Volume0";
} else if (daily_notification_count == 1) {
volume = "Volume1";
} else if (daily_notification_count <= 5) {
volume = "Volume5";
} else if (daily_notification_count <= 10) {
volume = "Volume10";
} else if (daily_notification_count <= 20) {
volume = "Volume20";
} else {
volume = "VolumeAbove20";
}
// `site_engagement_score` is a double between 0 and 100, and starts being
// interested when greater than 0.5. We record `site_engagement_score * 2` in
// order to be able to distinguish positive values from zero.
int site_engagement_score_to_report =
base::saturated_cast<int>(site_engagement_score * 2);
base::HistogramBase* histogram = base::Histogram::FactoryGet(
base::StrCat({"Notifications.Engagement.", type, ".", volume}), 1, 201,
50, base::HistogramBase::kUmaTargetedHistogramFlag);
histogram->AddCount(site_engagement_score_to_report, count);
}
} // namespace
NotificationsEngagementService::NotificationsEngagementService(
content::BrowserContext* context,
PrefService* pref_service)
: pref_service_(pref_service),
browser_context_(context),
settings_map_(PermissionsClient::Get()->GetSettingsMap(context)) {}
void NotificationsEngagementService::Shutdown() {
settings_map_ = nullptr;
browser_context_ = nullptr;
}
void NotificationsEngagementService::RecordNotificationDisplayed(
const GURL& url) {
IncrementCounts(url, 1 /*display_count_delta*/, 0 /*click_count_delta*/);
}
void NotificationsEngagementService::RecordNotificationDisplayed(
const GURL& url,
int display_count) {
IncrementCounts(url, display_count, 0 /*click_count_delta*/);
}
void NotificationsEngagementService::RecordNotificationInteraction(
const GURL& url) {
IncrementCounts(url, 0 /*display_count_delta*/, 1 /*click_count_delta*/);
}
// static
int NotificationsEngagementService::GetDailyAverageNotificationCount(
const base::Value::Dict& engagement) {
// Calculate daily average count for the past week.
base::Time date = base::Time::Now();
int notification_count_total = 0;
static constexpr int kDays = 7;
for (int day = 0; day < kDays; ++day) {
notification_count_total += ExtractNotificationCount(
engagement, GetBucketLabel(date - base::Days(day)));
}
return std::ceil(notification_count_total / kDays);
}
// static
int NotificationsEngagementService::GetDailyAverageNotificationCount(
const ContentSettingPatternSource& setting) {
if (!setting.setting_value.is_dict()) {
return 0;
}
return GetDailyAverageNotificationCount(setting.setting_value.GetDict());
}
// static
std::map<std::pair<ContentSettingsPattern, ContentSettingsPattern>, int>
NotificationsEngagementService::GetNotificationCountMapPerPatternPair(
const HostContentSettingsMap* hcsm) {
std::map<std::pair<ContentSettingsPattern, ContentSettingsPattern>, int>
result;
for (auto& item : hcsm->GetSettingsForOneType(
ContentSettingsType::NOTIFICATION_INTERACTIONS)) {
result[std::pair{item.primary_pattern, item.secondary_pattern}] =
GetDailyAverageNotificationCount(item);
}
return result;
}
void NotificationsEngagementService::IncrementCounts(const GURL& url,
int display_count_delta,
int click_count_delta) {
base::Value engagement_as_value = settings_map_->GetWebsiteSetting(
url, GURL(), ContentSettingsType::NOTIFICATION_INTERACTIONS);
base::Value::Dict engagement;
if (engagement_as_value.is_dict()) {
engagement = std::move(engagement_as_value).TakeDict();
}
std::string date = GetBucketLabel(base::Time::Now());
if (date == std::string()) {
return;
}
EraseStaleEntries(engagement);
base::Value::Dict* bucket = engagement.FindDict(date);
if (!bucket) {
bucket = &engagement.Set(date, base::Value::Dict())->GetDict();
}
if (display_count_delta) {
bucket->Set(kDisplayedKey, display_count_delta +
bucket->FindInt(kDisplayedKey).value_or(0));
}
if (click_count_delta) {
bucket->Set(
kEngagementKey,
click_count_delta + bucket->FindInt(kEngagementKey).value_or(0));
}
int daily_notification_count = GetDailyAverageNotificationCount(engagement);
double site_engagement_score =
PermissionsClient::Get()->GetSiteEngagementScore(browser_context_, url);
ReportNotificationEngagement("Displayed", daily_notification_count,
site_engagement_score, display_count_delta);
ReportNotificationEngagement("Clicked", daily_notification_count,
site_engagement_score, click_count_delta);
// Set the website setting of this origin with the updated |engagement|.
settings_map_->SetWebsiteSettingDefaultScope(
url, GURL(), ContentSettingsType::NOTIFICATION_INTERACTIONS,
base::Value(std::move(engagement)));
}
// static
std::string NotificationsEngagementService::GetBucketLabel(base::Time date) {
// For human-readability, return the UTC midnight on the same date as
// local midnight.
base::Time local_date = date.LocalMidnight();
base::Time::Exploded local_date_exploded;
local_date.LocalExplode(&local_date_exploded);
// Intentionally converting a locally exploded time, to an UTC time, so that
// the Midnight in UTC is on the same date the date on local time.
base::Time last_date;
bool converted = base::Time::FromUTCExploded(local_date_exploded, &last_date);
if (converted) {
return base::NumberToString(last_date.base::Time::ToTimeT());
}
return std::string();
}
// static
std::optional<base::Time>
NotificationsEngagementService::ParsePeriodBeginFromBucketLabel(
const std::string& label) {
int maybe_engagement_time;
base::Time local_period_begin;
// Store the time as local time.
if (base::StringToInt(label.c_str(), &maybe_engagement_time)) {
base::Time::Exploded date_exploded;
base::Time::FromTimeT(maybe_engagement_time).UTCExplode(&date_exploded);
if (base::Time::FromLocalExploded(date_exploded, &local_period_begin)) {
return local_period_begin;
}
}
return std::nullopt;
}
} // namespace permissions
|