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
content / browser / client_hints / client_hints_unittest.cc [blame]
// Copyright 2018 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/client_hints/client_hints.h"
#include "base/memory/raw_ptr.h"
#include "base/ranges/algorithm.h"
#include "base/strings/strcat.h"
#include "base/strings/string_number_conversions.h"
#include "base/strings/string_util.h"
#include "base/time/time.h"
#include "content/public/test/mock_client_hints_controller_delegate.h"
#include "content/public/test/test_browser_context.h"
#include "content/test/test_render_frame_host.h"
#include "content/test/test_render_view_host.h"
#include "content/test/test_web_contents.h"
#include "net/http/http_response_headers.h"
#include "services/metrics/public/cpp/ukm_source_id.h"
#include "services/network/public/cpp/client_hints.h"
#include "services/network/public/cpp/is_potentially_trustworthy.h"
namespace content {
namespace {
using ClientHintsVector = std::vector<network::mojom::WebClientHintsType>;
using network::mojom::WebClientHintsType;
} // namespace
class ClientHintsTest : public RenderViewHostImplTestHarness {
public:
ClientHintsTest() = default;
ClientHintsTest(const ClientHintsTest&) = delete;
ClientHintsTest& operator=(const ClientHintsTest&) = delete;
~ClientHintsTest() override {
blink::TrialTokenValidator::ResetOriginTrialPolicyGetter();
}
static constexpr char kOriginUrl[] = "https://example.com";
void AddOneChildNode() {
main_test_rfh()->OnCreateChildFrame(
/*new_routing_id=*/14, TestRenderFrameHost::CreateStubFrameRemote(),
TestRenderFrameHost::CreateStubBrowserInterfaceBrokerReceiver(),
TestRenderFrameHost::CreateStubPolicyContainerBindParams(),
TestRenderFrameHost::CreateStubAssociatedInterfaceProviderReceiver(),
/*scope=*/blink::mojom::TreeScopeType::kDocument, /*frame_name=*/"",
/*frame_unique_name=*/"uniqueName0", /*is_created_by_script=*/false,
/*frame_token=*/blink::LocalFrameToken(),
/*devtools_frame_token=*/base::UnguessableToken::Create(),
/*document_token=*/blink::DocumentToken(),
/*frame_policy=*/blink::FramePolicy(),
/*frame_owner_properties=*/blink::mojom::FrameOwnerProperties(),
/*owner_type=*/blink::FrameOwnerElementType::kIframe,
/*document_ukm_source_id=*/ukm::kInvalidSourceId);
}
std::optional<ClientHintsVector> ParseAndPersist(
const GURL& url,
const net::HttpResponseHeaders* response_header,
const std::string& accept_ch_str,
FrameTreeNode* frame_tree_node,
MockClientHintsControllerDelegate* delegate) {
auto parsed_headers = network::mojom::ParsedHeaders::New();
parsed_headers->accept_ch = network::ParseClientHintsHeader(accept_ch_str);
return ParseAndPersistAcceptCHForNavigation(
url::Origin::Create(url), parsed_headers, response_header,
browser_context(), delegate, frame_tree_node);
}
std::string HintsToString(std::optional<ClientHintsVector> hints) {
if (!hints)
return "";
std::vector<std::string> hints_list;
const auto& map = network::GetClientHintToNameMap();
base::ranges::transform(hints.value(), std::back_inserter(hints_list),
[&map](network::mojom::WebClientHintsType hint) {
return map.at(hint);
});
return base::JoinString(hints_list, ",");
}
std::pair<std::string, ClientHintsVector> GetAllClientHints() {
std::vector<std::string> accept_ch_tokens;
ClientHintsVector hints_list;
for (const auto& pair : network::GetClientHintToNameMap()) {
hints_list.push_back(pair.first);
accept_ch_tokens.push_back(pair.second);
}
return {base::JoinString(accept_ch_tokens, ","), hints_list};
}
};
TEST_F(ClientHintsTest, RttRoundedOff) {
EXPECT_EQ(0u, RoundRttForTesting("", base::Milliseconds(1023)) % 50);
EXPECT_EQ(0u, RoundRttForTesting("", base::Milliseconds(6787)) % 50);
EXPECT_EQ(0u, RoundRttForTesting("", base::Milliseconds(12)) % 50);
EXPECT_EQ(0u, RoundRttForTesting("foo.com", base::Milliseconds(1023)) % 50);
EXPECT_EQ(0u, RoundRttForTesting("foo.com", base::Milliseconds(1193)) % 50);
EXPECT_EQ(0u, RoundRttForTesting("foo.com", base::Milliseconds(12)) % 50);
}
TEST_F(ClientHintsTest, DownlinkRoundedOff) {
EXPECT_GE(1,
static_cast<int>(RoundKbpsToMbpsForTesting("", 102) * 1000) % 50);
EXPECT_GE(1, static_cast<int>(RoundKbpsToMbpsForTesting("", 12) * 1000) % 50);
EXPECT_GE(1,
static_cast<int>(RoundKbpsToMbpsForTesting("", 2102) * 1000) % 50);
EXPECT_GE(
1,
static_cast<int>(RoundKbpsToMbpsForTesting("foo.com", 102) * 1000) % 50);
EXPECT_GE(
1,
static_cast<int>(RoundKbpsToMbpsForTesting("foo.com", 12) * 1000) % 50);
EXPECT_GE(
1,
static_cast<int>(RoundKbpsToMbpsForTesting("foo.com", 2102) * 1000) % 50);
EXPECT_GE(
1, static_cast<int>(RoundKbpsToMbpsForTesting("foo.com", 12102) * 1000) %
50);
}
// Verify that the value of RTT after adding noise is within approximately 10%
// of the original value. Note that the difference between the final value of
// RTT and the original value may be slightly more than 10% due to rounding off.
// To handle that, the maximum absolute difference allowed is set to a value
// slightly larger than 10% of the original metric value.
TEST_F(ClientHintsTest, FinalRttWithin10PercentValue) {
EXPECT_NEAR(98, RoundRttForTesting("", base::Milliseconds(98)), 100);
EXPECT_NEAR(1023, RoundRttForTesting("", base::Milliseconds(1023)), 200);
EXPECT_NEAR(1193, RoundRttForTesting("", base::Milliseconds(1193)), 200);
EXPECT_NEAR(2750, RoundRttForTesting("", base::Milliseconds(2750)), 400);
}
// Verify that the value of downlink after adding noise is within approximately
// 10% of the original value. Note that the difference between the final value
// of downlink and the original value may be slightly more than 10% due to
// rounding off. To handle that, the maximum absolute difference allowed is set
// to a value slightly larger than 10% of the original metric value.
TEST_F(ClientHintsTest, FinalDownlinkWithin10PercentValue) {
EXPECT_NEAR(0.098, RoundKbpsToMbpsForTesting("", 98), 0.1);
EXPECT_NEAR(1.023, RoundKbpsToMbpsForTesting("", 1023), 0.2);
EXPECT_NEAR(1.193, RoundKbpsToMbpsForTesting("", 1193), 0.2);
EXPECT_NEAR(7.523, RoundKbpsToMbpsForTesting("", 7523), 0.9);
EXPECT_NEAR(9.999, RoundKbpsToMbpsForTesting("", 9999), 1.2);
}
TEST_F(ClientHintsTest, RttMaxValue) {
EXPECT_GE(3000u, RoundRttForTesting("", base::Milliseconds(1023)));
EXPECT_GE(3000u, RoundRttForTesting("", base::Milliseconds(2789)));
EXPECT_GE(3000u, RoundRttForTesting("", base::Milliseconds(6023)));
EXPECT_EQ(0u, RoundRttForTesting("", base::Milliseconds(1023)) % 50);
EXPECT_EQ(0u, RoundRttForTesting("", base::Milliseconds(2789)) % 50);
EXPECT_EQ(0u, RoundRttForTesting("", base::Milliseconds(6023)) % 50);
}
TEST_F(ClientHintsTest, DownlinkMaxValue) {
EXPECT_GE(10.0, RoundKbpsToMbpsForTesting("", 102));
EXPECT_GE(10.0, RoundKbpsToMbpsForTesting("", 2102));
EXPECT_GE(10.0, RoundKbpsToMbpsForTesting("", 100102));
EXPECT_GE(1,
static_cast<int>(RoundKbpsToMbpsForTesting("", 102) * 1000) % 50);
EXPECT_GE(1,
static_cast<int>(RoundKbpsToMbpsForTesting("", 2102) * 1000) % 50);
EXPECT_GE(
1, static_cast<int>(RoundKbpsToMbpsForTesting("", 100102) * 1000) % 50);
}
TEST_F(ClientHintsTest, RttRandomized) {
const int initial_value =
RoundRttForTesting("example.com", base::Milliseconds(1023));
bool network_quality_randomized_by_host = false;
// There is a 1/20 chance that the same random noise is selected for two
// different hosts. Run this test across 20 hosts to reduce the chances of
// test failing to (1/20)^20.
for (size_t i = 0; i < 20; ++i) {
int value =
RoundRttForTesting(base::NumberToString(i), base::Milliseconds(1023));
// If |value| is different than |initial_value|, it implies that RTT is
// randomized by host. This verifies the behavior, and test can be ended.
if (value != initial_value)
network_quality_randomized_by_host = true;
}
EXPECT_TRUE(network_quality_randomized_by_host);
// Calling RoundRttForTesting for same host should return the same result.
for (size_t i = 0; i < 20; ++i) {
int value = RoundRttForTesting("example.com", base::Milliseconds(1023));
EXPECT_EQ(initial_value, value);
}
}
TEST_F(ClientHintsTest, DownlinkRandomized) {
const int initial_value = RoundKbpsToMbpsForTesting("example.com", 1023);
bool network_quality_randomized_by_host = false;
// There is a 1/20 chance that the same random noise is selected for two
// different hosts. Run this test across 20 hosts to reduce the chances of
// test failing to (1/20)^20.
for (size_t i = 0; i < 20; ++i) {
int value = RoundKbpsToMbpsForTesting(base::NumberToString(i), 1023);
// If |value| is different than |initial_value|, it implies that downlink is
// randomized by host. This verifies the behavior, and test can be ended.
if (value != initial_value)
network_quality_randomized_by_host = true;
}
EXPECT_TRUE(network_quality_randomized_by_host);
// Calling RoundMbps for same host should return the same result.
for (size_t i = 0; i < 20; ++i) {
int value = RoundKbpsToMbpsForTesting("example.com", 1023);
EXPECT_EQ(initial_value, value);
}
}
TEST_F(ClientHintsTest, IntegrationTestsOnParseLookUp) {
GURL url = GURL(ClientHintsTest::kOriginUrl);
contents()->NavigateAndCommit(url);
FrameTree& frame_tree = contents()->GetPrimaryFrameTree();
FrameTreeNode* main_frame_node = frame_tree.root();
AddOneChildNode();
FrameTreeNode* sub_frame_node = main_frame_node->child_at(0);
blink::UserAgentMetadata ua_metadata;
MockClientHintsControllerDelegate delegate(ua_metadata);
const auto& all_non_origin_trial_hints_pair = GetAllClientHints();
const struct {
std::string description;
std::string accept_ch_str;
raw_ptr<FrameTreeNode> frame_tree_node;
std::optional<ClientHintsVector> expect_hints;
ClientHintsVector expect_commit_hints;
} tests[] = {
{"Persist hints for main frame", "sec-ch-ua-platform, sec-ch-ua-bitness",
main_frame_node,
std::make_optional(ClientHintsVector{WebClientHintsType::kUAPlatform,
WebClientHintsType::kUABitness}),
ClientHintsVector{WebClientHintsType::kUAPlatform,
WebClientHintsType::kUABitness}},
{"No persist hints for sub frame",
"sec-ch-ua-platform, sec-ch-ua-bitness", sub_frame_node, std::nullopt,
ClientHintsVector{WebClientHintsType::kUAPlatform,
WebClientHintsType::kUABitness}},
{"All client hints for main frame", all_non_origin_trial_hints_pair.first,
main_frame_node,
std::make_optional(all_non_origin_trial_hints_pair.second),
all_non_origin_trial_hints_pair.second},
{"All client hints for sub frame", all_non_origin_trial_hints_pair.first,
sub_frame_node, std::nullopt, all_non_origin_trial_hints_pair.second},
};
for (const auto& test : tests) {
auto response_headers =
base::MakeRefCounted<net::HttpResponseHeaders>("HTTP/1.1 200 OK\n");
auto actual_hints =
ParseAndPersist(url, response_headers.get(), test.accept_ch_str,
test.frame_tree_node, &delegate);
EXPECT_EQ(test.expect_hints, actual_hints)
<< "Test case [" << test.description << "]: expected hints "
<< HintsToString(test.expect_hints) << " but got "
<< HintsToString(actual_hints) << ".";
// Verify commit hints.
ClientHintsVector actual_commit_hints = LookupAcceptCHForCommit(
url::Origin::Create(url), &delegate, test.frame_tree_node);
EXPECT_EQ(test.expect_commit_hints, actual_commit_hints)
<< "Test case [" << test.description << "]: expected commit hints "
<< HintsToString(test.expect_commit_hints) << " but got "
<< HintsToString(actual_commit_hints) << ".";
}
}
TEST_F(ClientHintsTest, SubFrame) {
GURL url = GURL(ClientHintsTest::kOriginUrl);
contents()->NavigateAndCommit(url);
FrameTree& frame_tree = contents()->GetPrimaryFrameTree();
FrameTreeNode* main_frame_node = frame_tree.root();
AddOneChildNode();
FrameTreeNode* sub_frame_node = main_frame_node->child_at(0);
blink::UserAgentMetadata ua_metadata;
MockClientHintsControllerDelegate delegate(ua_metadata);
// Persist existing hint to accept-ch cache.
ClientHintsVector existing_hints = ClientHintsVector{
WebClientHintsType::kUAPlatform, WebClientHintsType::kUABitness};
delegate.PersistClientHints(url::Origin::Create(url),
main_frame_node->GetParentOrOuterDocument(),
existing_hints);
auto response_headers =
base::MakeRefCounted<net::HttpResponseHeaders>("HTTP/1.1 200 OK\n");
std::string accept_ch_str = "sec-ch-ua-platform-version";
// We shouldn't parse accept-ch in subframe, it should not overwrite existing
// hints.
auto actual_updated_hints = ParseAndPersist(
url, response_headers.get(), accept_ch_str, sub_frame_node, &delegate);
EXPECT_EQ(std::nullopt, actual_updated_hints);
blink::EnabledClientHints current_hints;
delegate.GetAllowedClientHintsFromSource(url::Origin::Create(url),
¤t_hints);
EXPECT_EQ(existing_hints, current_hints.GetEnabledHints());
}
} // namespace content