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
|
// Copyright 2024 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/segmentation_platform/embedder/home_modules/tips_manager/tips_manager.h"
#include <vector>
#include "base/check.h"
#include "base/json/values_util.h"
#include "base/values.h"
#include "components/pref_registry/pref_registry_syncable.h"
#include "components/prefs/pref_registry.h"
#include "components/prefs/pref_registry_simple.h"
#include "components/prefs/pref_service.h"
#include "components/prefs/scoped_user_pref_update.h"
#include "components/segmentation_platform/embedder/home_modules/tips_manager/constants.h"
#include "components/segmentation_platform/embedder/home_modules/tips_manager/signal_constants.h"
namespace segmentation_platform {
namespace {
// Removes signal data from `pref_service` that are not defined in
// `signals::kProfileSignalNames` or `signals::kLocalSignalNames`.
// This prevents storing data for unused signals.
void PruneSignalHistory(PrefService* pref_service) {
ScopedDictPrefUpdate update(pref_service, kTipsSignalHistory);
std::vector<std::string> signals_to_remove;
for (auto signal : *update) {
if (!tips_manager::signals::kLocalSignalNames.contains(signal.first) &&
!tips_manager::signals::kProfileSignalNames.contains(signal.first)) {
signals_to_remove.push_back(signal.first);
}
}
for (const std::string& signal_to_remove : signals_to_remove) {
update->Remove(signal_to_remove);
}
}
} // namespace
TipsManager::TipsManager(PrefService* profile_pref_service,
PrefService* local_pref_service)
: profile_pref_service_(profile_pref_service),
local_pref_service_(local_pref_service) {
CHECK(profile_pref_service_);
CHECK(local_pref_service_);
// Remove data for signals that are no longer used by the Tips Manager.
// This ensures the stored signal history remains relevant and doesn't
// contain outdated information.
PruneSignalHistory(profile_pref_service);
PruneSignalHistory(local_pref_service);
}
TipsManager::~TipsManager() = default;
void TipsManager::RegisterProfilePrefs(
user_prefs::PrefRegistrySyncable* registry) {
registry->RegisterDictionaryPref(kTipsSignalHistory,
PrefRegistry::LOSSY_PREF);
}
void TipsManager::RegisterLocalPrefs(PrefRegistrySimple* registry) {
registry->RegisterDictionaryPref(kTipsSignalHistory,
PrefRegistry::LOSSY_PREF);
}
void TipsManager::Shutdown() {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
profile_pref_service_ = nullptr;
local_pref_service_ = nullptr;
}
bool TipsManager::NotifySignal(std::string_view signal) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
// A signal cannot be registered as both a local and profile-based signal.
CHECK(!tips_manager::signals::kLocalSignalNames.contains(signal) ||
!tips_manager::signals::kProfileSignalNames.contains(signal));
if (tips_manager::signals::kLocalSignalNames.contains(signal)) {
RecordSignalToPref(signal, local_pref_service_);
return true;
}
if (tips_manager::signals::kProfileSignalNames.contains(signal)) {
RecordSignalToPref(signal, profile_pref_service_);
return true;
}
return false;
}
bool TipsManager::WasSignalFired(std::string_view signal) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
// Determine the correct pref service to use based on the `signal`.
PrefService* pref_service =
tips_manager::signals::kLocalSignalNames.contains(signal)
? local_pref_service_
: profile_pref_service_;
const base::Value::Dict& signal_history =
pref_service->GetDict(kTipsSignalHistory);
return signal_history.contains(signal);
}
bool TipsManager::WasSignalFiredWithin(std::string_view signal,
base::TimeDelta window) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
// Determine the correct pref service to use based on the `signal`.
PrefService* pref_service =
tips_manager::signals::kLocalSignalNames.contains(signal)
? local_pref_service_
: profile_pref_service_;
const base::Value::Dict& signal_history =
pref_service->GetDict(kTipsSignalHistory);
const base::Value::Dict* signal_data = signal_history.FindDict(signal);
if (!signal_data) {
return false; // Signal not found in history.
}
std::optional<base::Time> last_observed_time =
base::ValueToTime(signal_data->Find(kLastObservedTime));
if (!last_observed_time.has_value()) {
return false; // Invalid or missing timestamp.
}
return (base::Time::Now() - last_observed_time.value()) <= window;
}
bool TipsManager::RecordSignalToPref(std::string_view signal,
PrefService* pref_service) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
CHECK(pref_service);
ScopedDictPrefUpdate update(pref_service, kTipsSignalHistory);
base::Value::Dict* signal_history = update->EnsureDict(signal);
if (signal_history->empty()) {
signal_history->Set(kFirstObservedTime,
base::TimeToValue(base::Time::Now()));
signal_history->Set(kLastObservedTime,
base::TimeToValue(base::Time::Now()));
signal_history->Set(kTotalOccurrences, 1);
return true;
}
std::optional<int> occurrences = signal_history->FindInt(kTotalOccurrences);
if (!occurrences.has_value()) {
// This indicates potential data corruption in the preferences for `signal`.
return false;
}
signal_history->Set(kLastObservedTime, base::TimeToValue(base::Time::Now()));
signal_history->Set(kTotalOccurrences, occurrences.value() + 1);
return true;
}
} // namespace segmentation_platform
|
