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
331
332
333
334
335
336
337
338
339
340
content / browser / interest_group / header_direct_from_seller_signals.cc [blame]
// 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 "content/browser/interest_group/header_direct_from_seller_signals.h"
#include <functional>
#include <memory>
#include <optional>
#include <set>
#include <string>
#include <utility>
#include <vector>
#include "base/containers/flat_map.h"
#include "base/functional/bind.h"
#include "base/functional/callback.h"
#include "base/json/json_string_value_serializer.h"
#include "base/memory/scoped_refptr.h"
#include "base/metrics/histogram_functions.h"
#include "base/strings/stringprintf.h"
#include "base/time/time.h"
#include "base/values.h"
#include "services/data_decoder/public/cpp/data_decoder.h"
#include "url/gurl.h"
#include "url/origin.h"
#include "url/url_constants.h"
namespace content {
namespace {
size_t GetResultSizeBytes(const HeaderDirectFromSellerSignals::Result& result) {
size_t size = 0u;
if (result.seller_signals()) {
size += result.seller_signals()->size();
}
if (result.auction_signals()) {
size += result.auction_signals()->size();
}
for (const auto& [unused_origin, signals] : result.per_buyer_signals()) {
size += signals.size();
}
return size;
}
} // namespace
HeaderDirectFromSellerSignals::Result::Result() = default;
HeaderDirectFromSellerSignals::Result::Result(
std::optional<std::string> seller_signals,
std::optional<std::string> auction_signals,
base::flat_map<url::Origin, std::string> per_buyer_signals)
: seller_signals_(std::move(seller_signals)),
auction_signals_(std::move(auction_signals)),
per_buyer_signals_(std::move(per_buyer_signals)) {}
HeaderDirectFromSellerSignals::Result::~Result() = default;
HeaderDirectFromSellerSignals::HeaderDirectFromSellerSignals() = default;
HeaderDirectFromSellerSignals::~HeaderDirectFromSellerSignals() {
base::UmaHistogramCounts10000(
"Ads.InterestGroup.NetHeaderResponse.HeaderDirectFromSellerSignals."
"QueueDepthAtDestruction",
unprocessed_header_responses_.size());
base::UmaHistogramCounts10000(
"Ads.InterestGroup.NetHeaderResponse.HeaderDirectFromSellerSignals."
"NumResponsesReceivedPerPage",
num_add_witness_for_origin_calls_);
base::UmaHistogramCounts10000(
"Ads.InterestGroup.NetHeaderResponse.HeaderDirectFromSellerSignals."
"NumParseAndFindCalls",
parse_and_find_calls_);
}
void HeaderDirectFromSellerSignals::ParseAndFind(
const url::Origin& origin,
const std::string& ad_slot,
ParseAndFindCompletedCallback callback) {
parse_and_find_calls_++;
ParseAndFindCompletedInfo completed_info{
/*start_time=*/base::TimeTicks::Now(), /*origin=*/std::move(origin),
/*ad_slot=*/std::move(ad_slot), /*callback=*/std::move(callback)};
if (!add_witness_for_origin_completed_callback_) {
ParseAndFindCompleted(std::move(completed_info));
return;
}
// NOTE: If signals are received faster than the queue can process them, then
// `callback` will never be called. However, this seems unlikely, given that
// there should be only a small number of Ad-Auction-Signals header fetches
// per page. Note that each HeaderDirectFromSellerSignals is per-page.
parse_and_find_completed_infos_.push(std::move(completed_info));
}
void HeaderDirectFromSellerSignals::AddWitnessForOrigin(
data_decoder::DataDecoder& decoder,
const url::Origin& origin,
const std::string& response,
AddWitnessForOriginCompletedCallback callback) {
CHECK(callback);
num_add_witness_for_origin_calls_++;
base::UmaHistogramCounts100000(
"Ads.InterestGroup.NetHeaderResponse.HeaderDirectFromSellerSignals."
"ResponseSizeBytes",
response.size());
unprocessed_header_responses_.emplace(origin, response);
base::UmaHistogramCounts1000(
"Ads.InterestGroup.NetHeaderResponse.HeaderDirectFromSellerSignals."
"QueueDepthAtAdd",
unprocessed_header_responses_.size());
if (!add_witness_for_origin_completed_callback_) {
add_witness_for_origin_completed_callback_ = std::move(callback);
last_round_started_time_ = base::TimeTicks::Now();
DecodeNextResponse(decoder,
/*errors=*/std::vector<std::string>());
}
}
HeaderDirectFromSellerSignals::ParseAndFindCompletedInfo::
ParseAndFindCompletedInfo(base::TimeTicks start_time,
url::Origin origin,
std::string ad_slot,
ParseAndFindCompletedCallback callback)
: start_time(std::move(start_time)),
origin(std::move(origin)),
ad_slot(std::move(ad_slot)),
callback(std::move(callback)) {}
HeaderDirectFromSellerSignals::ParseAndFindCompletedInfo::
~ParseAndFindCompletedInfo() = default;
HeaderDirectFromSellerSignals::ParseAndFindCompletedInfo::
ParseAndFindCompletedInfo(ParseAndFindCompletedInfo&&) = default;
HeaderDirectFromSellerSignals::ParseAndFindCompletedInfo&
HeaderDirectFromSellerSignals::ParseAndFindCompletedInfo::operator=(
HeaderDirectFromSellerSignals::ParseAndFindCompletedInfo&&) = default;
void HeaderDirectFromSellerSignals::ParseAndFindCompleted(
ParseAndFindCompletedInfo info) const {
scoped_refptr<HeaderDirectFromSellerSignals::Result> result;
const auto it = results_.find(std::make_pair(info.origin, info.ad_slot));
if (it != results_.end()) {
result = it->second;
base::UmaHistogramCounts100000(
"Ads.InterestGroup.NetHeaderResponse.HeaderDirectFromSellerSignals."
"SignalsUsedInAuctionBytes",
GetResultSizeBytes(*result));
}
base::UmaHistogramTimes(
"Ads.InterestGroup.NetHeaderResponse.HeaderDirectFromSellerSignals."
"ParseAndFindMatchTime",
base::TimeTicks::Now() - info.start_time);
std::move(info.callback).Run(std::move(result));
}
void HeaderDirectFromSellerSignals::ProcessOneResponse(
const data_decoder::DataDecoder::ValueOrError& result,
const UnprocessedResponse& unprocessed_response,
std::vector<std::string>& errors) {
if (!result.has_value()) {
errors.push_back(base::StringPrintf(
"directFromSellerSignalsHeaderAdSlot: encountered invalid JSON: '%s' "
"for Ad-Auction-Signals=%s",
result.error().c_str(), unprocessed_response.response_json.c_str()));
return;
}
const base::Value::List* maybe_list = result->GetIfList();
if (!maybe_list) {
errors.push_back(base::StringPrintf(
"directFromSellerSignalsHeaderAdSlot: encountered response where "
"top-level JSON value isn't an array: Ad-Auction-Signals=%s",
unprocessed_response.response_json.c_str()));
return;
}
size_t num_ad_slots = 0u;
std::set<std::string> ad_slots_from_response;
for (const base::Value& list_item : *maybe_list) {
const base::Value::Dict* maybe_dict = list_item.GetIfDict();
if (!maybe_dict) {
errors.push_back(
base::StringPrintf("directFromSellerSignalsHeaderAdSlot: encountered "
"non-dict list item: Ad-AuctionSignals=%s",
unprocessed_response.response_json.c_str()));
continue;
}
const std::string* maybe_ad_slot = maybe_dict->FindString("adSlot");
if (!maybe_ad_slot) {
errors.push_back(base::StringPrintf(
"directFromSellerSignalsHeaderAdSlot: encountered dict without "
"\"adSlot\" key: Ad-Auction-Signals=%s",
unprocessed_response.response_json.c_str()));
continue;
}
if (!ad_slots_from_response.insert(*maybe_ad_slot).second) {
errors.push_back(base::StringPrintf(
"directFromSellerSignalsHeaderAdSlot: encountered dict with "
"duplicate adSlot key \"%s\": Ad-Auction-Signals=%s",
maybe_ad_slot->c_str(), unprocessed_response.response_json.c_str()));
continue;
}
const base::Value* maybe_seller_signals = maybe_dict->Find("sellerSignals");
std::optional<std::string> seller_signals;
if (maybe_seller_signals) {
seller_signals.emplace();
JSONStringValueSerializer serializer(&seller_signals.value());
if (!serializer.Serialize(*maybe_seller_signals)) {
errors.push_back(base::StringPrintf(
"directFromSellerSignalsHeaderAdSlot: failed to re-serialize "
"sellerSignals: Ad-Auction-Signals=%s",
unprocessed_response.response_json.c_str()));
seller_signals.reset();
}
}
const base::Value* maybe_auction_signals =
maybe_dict->Find("auctionSignals");
std::optional<std::string> auction_signals;
if (maybe_auction_signals) {
auction_signals.emplace();
JSONStringValueSerializer serializer(&auction_signals.value());
if (!serializer.Serialize(*maybe_auction_signals)) {
errors.push_back(base::StringPrintf(
"directFromSellerSignalsHeaderAdSlot: failed to re-serialize "
"auctionSignals: Ad-Auction-Signals=%s",
unprocessed_response.response_json.c_str()));
auction_signals.reset();
}
}
std::vector<std::pair<url::Origin, std::string>> per_buyer_signals_vec;
const base::Value::Dict* maybe_per_buyer_signals =
maybe_dict->FindDict("perBuyerSignals");
if (maybe_per_buyer_signals) {
for (const std::pair<const std::string&, const base::Value&> item :
*maybe_per_buyer_signals) {
// Checking that the origin isn't opaque, untrustworthy, etc. shouldn't
// be necessary, since such origins aren't allowed for the interest
// group buyers. But, we check for https as a sanity check, which will
// also fail if the origin isn't valid.
url::Origin origin = url::Origin::Create(GURL(item.first));
if (origin.scheme() != url::kHttpsScheme) {
errors.push_back(base::StringPrintf(
"directFromSellerSignalsHeaderAdSlot: encountered non-https "
"perBuyerSignals origin '%s': Ad-Auction-Signals=%s",
item.first.c_str(), unprocessed_response.response_json.c_str()));
continue;
}
std::string origin_signals;
JSONStringValueSerializer serializer(&origin_signals);
if (serializer.Serialize(item.second)) {
per_buyer_signals_vec.emplace_back(std::move(origin),
std::move(origin_signals));
} else {
errors.push_back(base::StringPrintf(
"directFromSellerSignalsHeaderAdSlot: failed to re-serialize "
"perBuyerSignals[%s]: Ad-Auction-Signals=%s",
item.first.c_str(), unprocessed_response.response_json.c_str()));
}
}
}
base::flat_map<url::Origin, std::string> per_buyer_signals(
std::move(per_buyer_signals_vec));
results_[std::make_pair(unprocessed_response.origin, *maybe_ad_slot)] =
base::MakeRefCounted<HeaderDirectFromSellerSignals::Result>(
std::move(seller_signals), std::move(auction_signals),
std::move(per_buyer_signals));
num_ad_slots++;
}
base::UmaHistogramCounts10000(
"Ads.InterestGroup.NetHeaderResponse.HeaderDirectFromSellerSignals."
"NumAdSlotsPerResponse",
num_ad_slots);
}
void HeaderDirectFromSellerSignals::OnJsonDecoded(
data_decoder::DataDecoder& decoder,
UnprocessedResponse current_unprocessed_response,
std::vector<std::string> errors,
base::TimeTicks parse_start_time,
data_decoder::DataDecoder::ValueOrError result) {
ProcessOneResponse(result, current_unprocessed_response, errors);
base::UmaHistogramTimes(
"Ads.InterestGroup.NetHeaderResponse.HeaderDirectFromSellerSignals."
"OneResponseParseTime",
base::TimeTicks::Now() - parse_start_time);
if (unprocessed_header_responses_.empty()) {
base::UmaHistogramCounts10M(
"Ads.InterestGroup.NetHeaderResponse.HeaderDirectFromSellerSignals."
"ProcessedBytesPerRound",
processed_bytes_per_round_);
base::UmaHistogramMediumTimes(
"Ads.InterestGroup.NetHeaderResponse.HeaderDirectFromSellerSignals."
"RoundProcessingTime",
base::TimeTicks::Now() - last_round_started_time_);
processed_bytes_per_round_ = 0u;
std::move(add_witness_for_origin_completed_callback_)
.Run(std::move(errors));
while (!parse_and_find_completed_infos_.empty()) {
ParseAndFindCompleted(std::move(parse_and_find_completed_infos_.front()));
parse_and_find_completed_infos_.pop();
}
return;
}
DecodeNextResponse(decoder, std::move(errors));
}
void HeaderDirectFromSellerSignals::DecodeNextResponse(
data_decoder::DataDecoder& decoder,
std::vector<std::string> errors) {
CHECK(!unprocessed_header_responses_.empty());
UnprocessedResponse next_unprocessed_response =
std::move(unprocessed_header_responses_.front());
unprocessed_header_responses_.pop();
processed_bytes_per_round_ += next_unprocessed_response.response_json.size();
// NOTE: The class comment for HeaderDirectFromSellerSignals requires that the
// DataDecoder instances passed to AddWitnessForOrigin() be destroyed before
// this HeaderDirectFromSellerSignals, so base::Unretained() below is safe.
decoder.ParseJson(
next_unprocessed_response.response_json,
base::BindOnce(&HeaderDirectFromSellerSignals::OnJsonDecoded,
base::Unretained(this), std::ref(decoder),
next_unprocessed_response, std::move(errors),
base::TimeTicks::Now()));
}
} // namespace content