forked from chromium/chromium
-
Notifications
You must be signed in to change notification settings - Fork 0
/
event_report_windows.cc
330 lines (276 loc) · 11.1 KB
/
event_report_windows.cc
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
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
// Copyright 2023 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/attribution_reporting/event_report_windows.h"
#include <stddef.h>
#include <algorithm>
#include <iterator>
#include <utility>
#include <vector>
#include "base/check.h"
#include "base/check_op.h"
#include "base/containers/flat_set.h"
#include "base/functional/not_fn.h"
#include "base/ranges/algorithm.h"
#include "base/time/time.h"
#include "base/types/expected.h"
#include "base/types/expected_macros.h"
#include "base/values.h"
#include "components/attribution_reporting/constants.h"
#include "components/attribution_reporting/parsing_utils.h"
#include "components/attribution_reporting/source_registration_error.mojom-shared.h"
#include "components/attribution_reporting/source_type.mojom-shared.h"
#include "third_party/abseil-cpp/absl/types/optional.h"
namespace attribution_reporting {
namespace {
using ::attribution_reporting::mojom::SourceRegistrationError;
using ::attribution_reporting::mojom::SourceType;
constexpr char kEventReportWindow[] = "event_report_window";
constexpr char kEventReportWindows[] = "event_report_windows";
constexpr char kStartTime[] = "start_time";
constexpr char kEndTimes[] = "end_times";
bool IsValid(base::TimeDelta start_time,
const base::flat_set<base::TimeDelta>& end_times) {
return !start_time.is_negative() && !end_times.empty() &&
end_times.size() <= kMaxEventLevelReportWindows &&
*end_times.begin() > start_time &&
*end_times.begin() >= kMinReportWindow;
}
bool IsReportWindowValid(base::TimeDelta report_window) {
return report_window >= kMinReportWindow && report_window <= kMaxSourceExpiry;
}
bool IsStrictlyIncreasing(const std::vector<base::TimeDelta>& end_times) {
return base::ranges::adjacent_find(end_times, base::not_fn(std::less{})) ==
end_times.end();
}
base::Time ReportTimeFromDeadline(base::Time source_time,
base::TimeDelta deadline) {
// Valid conversion reports should always have a valid reporting deadline.
DCHECK(deadline.is_positive());
return source_time + deadline;
}
} // namespace
// static
absl::optional<EventReportWindows> EventReportWindows::FromDefaults(
base::TimeDelta report_window,
SourceType source_type) {
if (!IsReportWindowValid(report_window)) {
return absl::nullopt;
}
return EventReportWindows(report_window, source_type);
}
// static
absl::optional<EventReportWindows> EventReportWindows::Create(
base::TimeDelta start_time,
std::vector<base::TimeDelta> end_times) {
if (!IsStrictlyIncreasing(end_times)) {
return absl::nullopt;
}
base::flat_set<base::TimeDelta> end_times_set(base::sorted_unique,
std::move(end_times));
if (!IsValid(start_time, end_times_set)) {
return absl::nullopt;
}
return EventReportWindows(start_time, std::move(end_times_set));
}
EventReportWindows::EventReportWindows(
base::TimeDelta start_time,
base::flat_set<base::TimeDelta> end_times)
: start_time_(start_time), end_times_(std::move(end_times)) {
CHECK(IsValid(start_time_, end_times_));
}
EventReportWindows::EventReportWindows(base::TimeDelta report_window,
SourceType source_type) {
CHECK(IsReportWindowValid(report_window));
std::vector<base::TimeDelta> end_times;
switch (source_type) {
case SourceType::kNavigation:
end_times = {base::Days(2), base::Days(7)};
break;
case SourceType::kEvent:
break;
}
while (!end_times.empty() && report_window <= end_times.back()) {
end_times.pop_back();
}
end_times.push_back(report_window);
end_times_.replace(std::move(end_times));
CHECK(IsValid(start_time_, end_times_));
}
EventReportWindows::EventReportWindows()
: EventReportWindows(/*start_time=*/base::TimeDelta(),
/*end_times=*/{kMaxSourceExpiry}) {}
EventReportWindows::~EventReportWindows() = default;
EventReportWindows::EventReportWindows(const EventReportWindows&) = default;
EventReportWindows& EventReportWindows::operator=(const EventReportWindows&) =
default;
EventReportWindows::EventReportWindows(EventReportWindows&&) = default;
EventReportWindows& EventReportWindows::operator=(EventReportWindows&&) =
default;
base::Time EventReportWindows::ComputeReportTime(
base::Time source_time,
base::Time trigger_time) const {
// Follows the steps detailed in
// https://wicg.github.io/attribution-reporting-api/#obtain-an-event-level-report-delivery-time
// Starting from step 2.
DCHECK_LE(source_time, trigger_time);
base::TimeDelta reporting_window_to_use = *end_times_.rbegin();
for (base::TimeDelta reporting_window : end_times_) {
if (source_time + reporting_window <= trigger_time) {
continue;
}
reporting_window_to_use = reporting_window;
break;
}
return ReportTimeFromDeadline(source_time, reporting_window_to_use);
}
base::Time EventReportWindows::ReportTimeAtWindow(base::Time source_time,
int window_index) const {
DCHECK_GE(window_index, 0);
DCHECK_LT(static_cast<size_t>(window_index), end_times_.size());
return ReportTimeFromDeadline(source_time,
*std::next(end_times_.begin(), window_index));
}
EventReportWindows::WindowResult EventReportWindows::FallsWithin(
base::TimeDelta trigger_moment) const {
// It is possible for a source to have an assigned time of T and a trigger
// that is attributed to it to have a time of T-X e.g. due to user-initiated
// clock changes.
//
// TODO(crbug.com/1489333): Assume trigger moment is not negative once
// attribution time resolution is implemented in storage.
base::TimeDelta bounded_trigger_moment =
trigger_moment.is_negative() ? base::Microseconds(0) : trigger_moment;
if (bounded_trigger_moment < start_time_) {
return WindowResult::kNotStarted;
}
if (bounded_trigger_moment >= *end_times_.rbegin()) {
return WindowResult::kPassed;
}
return WindowResult::kFallsWithin;
}
base::expected<EventReportWindows, SourceRegistrationError>
EventReportWindows::FromJSON(const base::Value::Dict& registration,
base::TimeDelta expiry,
SourceType source_type) {
const base::Value* singular_window = registration.Find(kEventReportWindow);
const base::Value* multiple_windows = registration.Find(kEventReportWindows);
if (singular_window && multiple_windows) {
return base::unexpected(
SourceRegistrationError::kBothEventReportWindowFieldsFound);
} else if (singular_window) {
ASSIGN_OR_RETURN(
base::TimeDelta report_window,
ParseLegacyDuration(
*singular_window,
SourceRegistrationError::kEventReportWindowValueInvalid));
report_window = std::clamp(report_window, kMinReportWindow, expiry);
return EventReportWindows(report_window, source_type);
} else if (multiple_windows) {
return ParseWindowsJSON(*multiple_windows, expiry);
} else {
return EventReportWindows(expiry, source_type);
}
}
// static
base::expected<EventReportWindows, SourceRegistrationError>
EventReportWindows::ParseWindows(const base::Value::Dict& dict,
base::TimeDelta expiry,
const EventReportWindows& default_if_absent) {
const base::Value* value = dict.Find(kEventReportWindows);
if (!value) {
return default_if_absent;
}
return ParseWindowsJSON(*value, expiry);
}
// static
base::expected<EventReportWindows, SourceRegistrationError>
EventReportWindows::ParseWindowsJSON(const base::Value& v,
base::TimeDelta expiry) {
const base::Value::Dict* dict = v.GetIfDict();
if (!dict) {
return base::unexpected(
SourceRegistrationError::kEventReportWindowsWrongType);
}
base::TimeDelta start_time = base::Seconds(0);
if (const base::Value* start_time_value = dict->Find(kStartTime)) {
absl::optional<int> int_value = start_time_value->GetIfInt();
if (!int_value.has_value()) {
return base::unexpected(
SourceRegistrationError::kEventReportWindowsStartTimeWrongType);
}
start_time = base::Seconds(*int_value);
if (start_time.is_negative() || start_time > expiry) {
return base::unexpected(
SourceRegistrationError::kEventReportWindowsStartTimeInvalid);
}
}
const base::Value* end_times_value = dict->Find(kEndTimes);
if (!end_times_value) {
return base::unexpected(
SourceRegistrationError::kEventReportWindowsEndTimesMissing);
}
const base::Value::List* end_times_list = end_times_value->GetIfList();
if (!end_times_list) {
return base::unexpected(
SourceRegistrationError::kEventReportWindowsEndTimesWrongType);
}
if (end_times_list->empty()) {
return base::unexpected(
SourceRegistrationError::kEventReportWindowsEndTimesListEmpty);
}
if (end_times_list->size() > kMaxEventLevelReportWindows) {
return base::unexpected(
SourceRegistrationError::kEventReportWindowsEndTimesListTooLong);
}
std::vector<base::TimeDelta> end_times;
end_times.reserve(end_times_list->size());
base::TimeDelta start_duration = start_time;
for (const auto& item : *end_times_list) {
const absl::optional<int> item_int = item.GetIfInt();
if (!item_int.has_value()) {
return base::unexpected(
SourceRegistrationError::kEventReportWindowsEndTimeValueWrongType);
}
if (item_int.value() <= 0) {
return base::unexpected(
SourceRegistrationError::kEventReportWindowsEndTimeValueInvalid);
}
base::TimeDelta end_time = base::Seconds(*item_int);
if (end_time > expiry) {
end_time = expiry;
}
if (end_time < kMinReportWindow) {
end_time = kMinReportWindow;
}
if (end_time <= start_duration) {
return base::unexpected(
SourceRegistrationError::kEventReportWindowsEndTimeDurationLTEStart);
}
end_times.push_back(end_time);
start_duration = end_time;
}
return EventReportWindows(start_time, std::move(end_times));
}
void EventReportWindows::Serialize(base::Value::Dict& dict) const {
base::Value::Dict windows_dict;
windows_dict.Set(kStartTime, static_cast<int>(start_time_.InSeconds()));
base::Value::List list;
for (const auto& end_time : end_times_) {
list.Append(static_cast<int>(end_time.InSeconds()));
}
windows_dict.Set(kEndTimes, std::move(list));
dict.Set(kEventReportWindows, std::move(windows_dict));
}
bool EventReportWindows::IsValidForExpiry(base::TimeDelta expiry) const {
return start_time_ <= expiry && *end_times_.rbegin() <= expiry;
}
base::Time LastTriggerTimeForReportTime(base::Time report_time) {
// TODO(apaseltiner): `base::Time` has microsecond resolution, so we should
// probably use `base::Microseconds(1)` instead.
constexpr base::TimeDelta kWindowTinyOffset = base::Milliseconds(1);
// `kWindowTinyOffset` is needed as the window is not selected right at
// `report_time`.
return report_time - kWindowTinyOffset;
}
} // namespace attribution_reporting