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
|
// Copyright 2019 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "chrome/browser/notifications/scheduler/internal/display_decider.h"
#include <algorithm>
#include "base/memory/raw_ptr.h"
#include "base/time/clock.h"
#include "chrome/browser/notifications/scheduler/internal/impression_types.h"
#include "chrome/browser/notifications/scheduler/internal/notification_entry.h"
#include "chrome/browser/notifications/scheduler/internal/scheduler_config.h"
#include "chrome/browser/notifications/scheduler/internal/scheduler_utils.h"
using Notifications = notifications::DisplayDecider::Notifications;
using Results = notifications::DisplayDecider::Results;
using ClientStates = notifications::DisplayDecider::ClientStates;
namespace notifications {
namespace {
// Helper class contains the actual logic to decide which notifications to show.
// This is an one-shot class, callers should create a new object each time.
class DecisionHelper {
public:
DecisionHelper(const SchedulerConfig* config,
const std::vector<SchedulerClientType>& clients,
base::Clock* clock,
Notifications notifications,
ClientStates client_states)
: notifications_(std::move(notifications)),
client_states_(std::move(client_states)),
config_(config),
clients_(clients),
clock_(clock),
last_shown_type_(SchedulerClientType::kUnknown),
shown_(0) {}
DecisionHelper(const DecisionHelper&) = delete;
DecisionHelper& operator=(const DecisionHelper&) = delete;
~DecisionHelper() = default;
// Figures out a list of notifications to show.
void DecideNotificationToShow(Results* results) {
NotificationsShownToday(client_states_, &shown_per_type_, &shown_,
&last_shown_type_, clock_);
FilterNotifications();
PickNotificationToShow(results);
}
private:
// Filter notifications based on scheduling parameters.
void FilterNotifications() {
Notifications filtered_notifications;
for (const auto& pair : notifications_) {
// Client under suppression will not have notification to show.
auto it = client_states_.find(pair.first);
if (it != client_states_.end() &&
it->second->suppression_info.has_value()) {
continue;
}
for (const notifications::NotificationEntry* notification : pair.second) {
DCHECK(notification);
DCHECK_NE(notification->schedule_params.priority,
ScheduleParams::Priority::kNoThrottle);
if (!ShouldFilterOut(notification))
filtered_notifications[notification->type].emplace_back(notification);
}
}
notifications_.swap(filtered_notifications);
}
bool ShouldFilterOut(const NotificationEntry* entry) {
base::Time now = clock_->Now();
// Filter with time window. Must have |deliver_time_start|.
if (!entry->schedule_params.deliver_time_start.has_value())
return true;
bool meet_deliver_time_start =
now >= entry->schedule_params.deliver_time_start.value();
DCHECK(entry->schedule_params.deliver_time_end.has_value());
bool meet_deliver_time_end =
entry->schedule_params.deliver_time_end.has_value()
? now <= entry->schedule_params.deliver_time_end.value()
: false;
if (meet_deliver_time_start && meet_deliver_time_end) {
return false;
}
return true;
}
// Picks a list of notifications to show.
void PickNotificationToShow(Results* to_show) {
DCHECK(to_show);
if (shown_ > config_->max_daily_shown_all_type || clients_.empty())
return;
// No previous shown notification, move the iterator to last element.
// We will iterate through all client types later.
auto it = std::ranges::find(clients_, last_shown_type_);
if (it == clients_.end()) {
DCHECK_EQ(last_shown_type_, SchedulerClientType::kUnknown);
last_shown_type_ = clients_.back();
it = clients_.end() - 1;
}
DCHECK_NE(last_shown_type_, SchedulerClientType::kUnknown);
size_t steps = 0u;
// Circling around all clients to find new notification to show.
do {
// Move the iterator to next client type.
CHECK(it != clients_.end());
if (++it == clients_.end())
it = clients_.begin();
++steps;
SchedulerClientType type = *it;
// Check quota for all types and current background task type.
if (ReachDailyQuota())
break;
// Check quota for this type, and continue to iterate other types.
if (NoMoreNotificationToShow(type))
continue;
// Show the last notification in the vector. Notice the order depends on
// how the vector is sorted.
to_show->emplace(notifications_[type].back()->guid);
notifications_[type].pop_back();
shown_per_type_[type]++;
shown_++;
steps = 0u;
// Stop if we didn't find anything new to show, and have looped around
// all clients.
} while (steps <= clients_.size());
}
bool NoMoreNotificationToShow(SchedulerClientType type) {
auto it = client_states_.find(type);
int max_daily_show =
it == client_states_.end() ? 0 : it->second->current_max_daily_show;
return notifications_[type].empty() ||
shown_per_type_[type] >= config_->max_daily_shown_per_type ||
shown_per_type_[type] >= max_daily_show;
}
bool ReachDailyQuota() const {
return shown_ >= config_->max_daily_shown_all_type;
}
// Scheduled notifications as candidates to display to the user.
Notifications notifications_;
const ClientStates client_states_;
raw_ptr<const SchedulerConfig, DanglingUntriaged> config_;
const std::vector<SchedulerClientType> clients_;
raw_ptr<base::Clock> clock_;
SchedulerClientType last_shown_type_;
std::map<SchedulerClientType, int> shown_per_type_;
int shown_;
};
class DisplayDeciderImpl : public DisplayDecider {
public:
DisplayDeciderImpl(const SchedulerConfig* config,
std::vector<SchedulerClientType> clients,
base::Clock* clock)
: config_(config), clients_(std::move(clients)), clock_(clock) {}
DisplayDeciderImpl(const DisplayDeciderImpl&) = delete;
DisplayDeciderImpl& operator=(const DisplayDeciderImpl&) = delete;
~DisplayDeciderImpl() override = default;
private:
// DisplayDecider implementation.
void FindNotificationsToShow(Notifications notifications,
ClientStates client_states,
Results* results) override {
Notifications throttled_notifications;
for (const auto& pair : notifications) {
auto type = pair.first;
for (const notifications::NotificationEntry* notification : pair.second) {
// Move unthrottled notifications to results directly.
if (notification->schedule_params.priority ==
ScheduleParams::Priority::kNoThrottle) {
results->emplace(notification->guid);
} else {
throttled_notifications[type].emplace_back(notification);
}
}
}
// Handle throttled notifications.
auto helper = std::make_unique<DecisionHelper>(
config_, clients_, clock_, std::move(throttled_notifications),
std::move(client_states));
helper->DecideNotificationToShow(results);
}
raw_ptr<const SchedulerConfig, DanglingUntriaged> config_;
const std::vector<SchedulerClientType> clients_;
raw_ptr<base::Clock> clock_;
};
} // namespace
// static
std::unique_ptr<DisplayDecider> DisplayDecider::Create(
const SchedulerConfig* config,
std::vector<SchedulerClientType> clients,
base::Clock* clock) {
return std::make_unique<DisplayDeciderImpl>(config, std::move(clients),
clock);
}
} // namespace notifications
|