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
|
// 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.
#ifndef CHROME_BROWSER_NOTIFICATIONS_SCHEDULER_INTERNAL_IMPRESSION_HISTORY_TRACKER_H_
#define CHROME_BROWSER_NOTIFICATIONS_SCHEDULER_INTERNAL_IMPRESSION_HISTORY_TRACKER_H_
#include <map>
#include <memory>
#include <string>
#include <vector>
#include "base/containers/circular_deque.h"
#include "base/functional/callback.h"
#include "base/memory/raw_ptr.h"
#include "base/memory/raw_ref.h"
#include "base/memory/weak_ptr.h"
#include "base/time/clock.h"
#include "base/time/time.h"
#include "chrome/browser/notifications/scheduler/internal/collection_store.h"
#include "chrome/browser/notifications/scheduler/internal/impression_types.h"
#include "chrome/browser/notifications/scheduler/internal/scheduler_config.h"
#include "chrome/browser/notifications/scheduler/public/impression_detail.h"
#include "chrome/browser/notifications/scheduler/public/throttle_config.h"
#include "chrome/browser/notifications/scheduler/public/user_action_handler.h"
namespace notifications {
// Provides functionalities to update notification impression history and adjust
// maximum daily notification shown to the user.
class ImpressionHistoryTracker : public UserActionHandler {
public:
using ClientStates =
std::map<SchedulerClientType, std::unique_ptr<ClientState>>;
using InitCallback = base::OnceCallback<void(bool)>;
class Delegate {
public:
using ThrottleConfigCallback =
base::OnceCallback<void(std::unique_ptr<ThrottleConfig>)>;
Delegate() = default;
Delegate(const Delegate&) = delete;
Delegate& operator=(const Delegate&) = delete;
virtual ~Delegate() = default;
// Get ThrottleConfig.
virtual void GetThrottleConfig(SchedulerClientType type,
ThrottleConfigCallback callback) = 0;
};
ImpressionHistoryTracker(const ImpressionHistoryTracker&) = delete;
ImpressionHistoryTracker& operator=(const ImpressionHistoryTracker&) = delete;
// Initializes the impression tracker.
virtual void Init(Delegate* delegate, InitCallback callback) = 0;
// Add a new impression, called after the notification is shown.
virtual void AddImpression(
SchedulerClientType type,
const std::string& guid,
const Impression::ImpressionResultMap& impression_map,
const Impression::CustomData& custom_data,
std::optional<base::TimeDelta> ignore_timeout_duration) = 0;
// Analyzes the impression history for all notification clients, and adjusts
// the |current_max_daily_show|.
virtual void AnalyzeImpressionHistory() = 0;
// Queries the client states.
virtual void GetClientStates(
std::map<SchedulerClientType, const ClientState*>* client_states)
const = 0;
// Queries impression based on guid, returns nullptr if no impression is
// found.
virtual const Impression* GetImpression(SchedulerClientType type,
const std::string& guid) = 0;
// Queries the impression detail of a given |SchedulerClientType|.
virtual void GetImpressionDetail(
SchedulerClientType type,
ImpressionDetail::ImpressionDetailCallback callback) = 0;
virtual ~ImpressionHistoryTracker() = default;
protected:
ImpressionHistoryTracker() = default;
};
// An implementation of ImpressionHistoryTracker backed by a database.
class ImpressionHistoryTrackerImpl : public ImpressionHistoryTracker {
public:
explicit ImpressionHistoryTrackerImpl(
const SchedulerConfig& config,
std::vector<SchedulerClientType> registered_clients,
std::unique_ptr<CollectionStore<ClientState>> store,
base::Clock* clock);
ImpressionHistoryTrackerImpl(const ImpressionHistoryTrackerImpl&) = delete;
ImpressionHistoryTrackerImpl& operator=(const ImpressionHistoryTrackerImpl&) =
delete;
~ImpressionHistoryTrackerImpl() override;
private:
// ImpressionHistoryTracker implementation.
void Init(Delegate* delegate, InitCallback callback) override;
void AddImpression(
SchedulerClientType type,
const std::string& guid,
const Impression::ImpressionResultMap& impression_mapping,
const Impression::CustomData& custom_data,
std::optional<base::TimeDelta> ignore_timeout_duration) override;
void AnalyzeImpressionHistory() override;
void GetClientStates(std::map<SchedulerClientType, const ClientState*>*
client_states) const override;
const Impression* GetImpression(SchedulerClientType type,
const std::string& guid) override;
void GetImpressionDetail(
SchedulerClientType type,
ImpressionDetail::ImpressionDetailCallback callback) override;
void OnUserAction(const UserActionData& action_data) override;
// Called after |store_| is initialized.
void OnStoreInitialized(InitCallback callback,
bool success,
CollectionStore<ClientState>::Entries entries);
// Sync with registered clients. Adds new data for new client and deletes data
// for deprecated client.
void SyncRegisteredClients();
// Helper method to prune impressions created before |start_time|. Assumes
// |impressions| are sorted by creation time.
static void PruneImpressionByCreateTime(
base::circular_deque<Impression*>* impressions,
const base::Time& start_time);
// Analyzes the impression history for a particular client.
void AnalyzeImpressionHistory(ClientState* client_state);
// Check consecutive user actions, and generate impression result if no less
// than |num_actions| count of user actions.
void CheckConsecutiveDismiss(ClientState* client_state,
base::circular_deque<Impression*>* impressions);
// Generates user impression result.
void GenerateImpressionResult(Impression* impression);
// Updates notification throttling based on the impression result.
void UpdateThrottling(ClientState* client_state, Impression* impression);
// Applies a positive impression result to this notification type.
void ApplyPositiveImpression(ClientState* client_state,
Impression* impression);
// Applies one negative impression.
void ApplyNegativeImpression(ClientState* client_state,
Impression* impression);
// Checks if suppression is expired and recover to a certain daily quota.
void CheckSuppressionExpiration(ClientState* client_state);
// Tries to update the database records for |type|. Returns whether the db is
// actually updated.
bool MaybeUpdateDb(SchedulerClientType type);
bool MaybeUpdateAllDb();
// Sets/Gets the flag if impression data for |type| needs update in the
// database.
void SetNeedsUpdate(SchedulerClientType type, bool needs_update);
bool NeedsUpdate(SchedulerClientType type) const;
// Finds an impression that needs to update based on notification id.
Impression* FindImpressionNeedsUpdate(SchedulerClientType type,
const std::string& notification_guid);
Impression* GetImpressionInternal(SchedulerClientType type,
const std::string& guid);
void OnClickInternal(SchedulerClientType type,
const std::string& notification_guid,
bool update_db);
void OnButtonClickInternal(SchedulerClientType type,
const std::string& notification_guid,
ActionButtonType button_type,
bool update_db);
void OnDismissInternal(SchedulerClientType type,
const std::string& notification_guid,
bool update_db);
void OnCustomNegativeActionCountQueried(
SchedulerClientType type,
base::circular_deque<Impression*>* impressions,
std::unique_ptr<ThrottleConfig> custom_throttle_config);
void OnCustomSuppressionDurationQueried(
SchedulerClientType type,
std::unique_ptr<ThrottleConfig> custom_throttle_config);
void HandleIgnoredImpressions(ClientState* client_state);
// Impression history and global states for all notification scheduler
// clients.
ClientStates client_states_;
// The storage that persists data.
std::unique_ptr<CollectionStore<ClientState>> store_;
// System configuration.
const raw_ref<const SchedulerConfig, DanglingUntriaged> config_;
const std::vector<SchedulerClientType> registered_clients_;
// Whether the impression tracker is successfully initialized.
bool initialized_;
// If the database needs an update when any of the impression data is updated.
std::map<SchedulerClientType, bool> need_update_db_;
// The clock to provide the current timestamp.
raw_ptr<base::Clock> clock_;
// Delegate object.
raw_ptr<Delegate, DanglingUntriaged> delegate_;
base::WeakPtrFactory<ImpressionHistoryTrackerImpl> weak_ptr_factory_{this};
};
} // namespace notifications
#endif // CHROME_BROWSER_NOTIFICATIONS_SCHEDULER_INTERNAL_IMPRESSION_HISTORY_TRACKER_H_
|
