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
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
content / browser / do_not_track_browsertest.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 "base/barrier_closure.h"
#include "base/containers/contains.h"
#include "base/functional/bind.h"
#include "base/memory/raw_ptr.h"
#include "base/strings/utf_string_conversions.h"
#include "build/build_config.h"
#include "content/public/browser/content_browser_client.h"
#include "content/public/browser/web_contents.h"
#include "content/public/common/content_client.h"
#include "content/public/test/browser_test.h"
#include "content/public/test/browser_test_utils.h"
#include "content/public/test/content_browser_test.h"
#include "content/public/test/content_browser_test_content_browser_client.h"
#include "content/public/test/content_browser_test_utils.h"
#include "content/shell/browser/shell.h"
#include "net/test/embedded_test_server/embedded_test_server.h"
#include "net/test/embedded_test_server/http_request.h"
#include "net/test/embedded_test_server/http_response.h"
#include "third_party/blink/public/common/renderer_preferences/renderer_preferences.h"
#if BUILDFLAG(IS_ANDROID)
#include "base/system/sys_info.h"
#endif
namespace content {
namespace {
class MockContentBrowserClient final
: public ContentBrowserTestContentBrowserClient {
public:
void UpdateRendererPreferencesForWorker(
BrowserContext*,
blink::RendererPreferences* prefs) override {
if (do_not_track_enabled_) {
prefs->enable_do_not_track = true;
prefs->enable_referrers = true;
}
}
void EnableDoNotTrack() { do_not_track_enabled_ = true; }
private:
bool do_not_track_enabled_ = false;
};
class DoNotTrackTest : public ContentBrowserTest {
protected:
void SetUpOnMainThread() override {
#if BUILDFLAG(IS_ANDROID)
// TODO(crbug.com/40585282): It seems that we call unsupported Android APIs
// on KitKat when we set a ContentBrowserClient. Don't call such APIs and
// make this test available on KitKat.
int32_t major_version = 0, minor_version = 0, bugfix_version = 0;
base::SysInfo::OperatingSystemVersionNumbers(&major_version, &minor_version,
&bugfix_version);
if (major_version < 5)
return;
#endif
client_ = std::make_unique<MockContentBrowserClient>();
}
void TearDownOnMainThread() override { client_.reset(); }
// Returns false if we cannot enable do not track. It happens only when
// Android Kitkat or older systems.
bool EnableDoNotTrack() {
client_->EnableDoNotTrack();
blink::RendererPreferences* prefs =
shell()->web_contents()->GetMutableRendererPrefs();
EXPECT_FALSE(prefs->enable_do_not_track);
prefs->enable_do_not_track = true;
return true;
}
void ExpectPageTextEq(const std::string& expected_content) {
EXPECT_EQ(expected_content, EvalJs(shell(), "document.body.innerText;"));
}
std::string GetDOMDoNotTrackProperty() {
return EvalJs(shell(),
"navigator.doNotTrack === null ? '' : navigator.doNotTrack")
.ExtractString();
}
GURL GetURL(std::string relative_url) {
return embedded_test_server()->GetURL(relative_url);
}
private:
std::unique_ptr<MockContentBrowserClient> client_;
};
std::unique_ptr<net::test_server::HttpResponse>
CaptureHeaderHandlerAndReturnScript(
const std::string& path,
net::test_server::HttpRequest::HeaderMap* header_map,
const std::string& script,
base::OnceClosure done_callback,
const net::test_server::HttpRequest& request) {
GURL request_url = request.GetURL();
if (request_url.path() != path)
return nullptr;
*header_map = request.headers;
std::move(done_callback).Run();
auto response = std::make_unique<net::test_server::BasicHttpResponse>();
response->set_content_type("text/javascript");
response->set_content(script);
return response;
}
// Checks that the DNT header is not sent by default.
IN_PROC_BROWSER_TEST_F(DoNotTrackTest, NotEnabled) {
ASSERT_TRUE(embedded_test_server()->Start());
EXPECT_TRUE(NavigateToURL(shell(), GetURL("/echoheader?DNT")));
ExpectPageTextEq("None");
// And the DOM property is not set.
EXPECT_EQ("", GetDOMDoNotTrackProperty());
}
// Checks that the DNT header is sent when the corresponding preference is set.
IN_PROC_BROWSER_TEST_F(DoNotTrackTest, Simple) {
ASSERT_TRUE(embedded_test_server()->Start());
if (!EnableDoNotTrack())
return;
EXPECT_TRUE(NavigateToURL(shell(), GetURL("/echoheader?DNT")));
ExpectPageTextEq("1");
}
// Checks that the DNT header is preserved during redirects.
IN_PROC_BROWSER_TEST_F(DoNotTrackTest, Redirect) {
ASSERT_TRUE(embedded_test_server()->Start());
GURL final_url = GetURL("/echoheader?DNT");
GURL url = GetURL("/server-redirect?" + final_url.spec());
if (!EnableDoNotTrack())
return;
// We don't check the result NavigateToURL as it returns true only if the
// final URL is equal to the passed URL.
EXPECT_TRUE(NavigateToURL(shell(), url, final_url /* expected_commit_url */));
ExpectPageTextEq("1");
}
// Checks that the DOM property is set when the corresponding preference is set.
IN_PROC_BROWSER_TEST_F(DoNotTrackTest, DOMProperty) {
ASSERT_TRUE(embedded_test_server()->Start());
if (!EnableDoNotTrack())
return;
EXPECT_TRUE(NavigateToURL(shell(), GetURL("/echo")));
EXPECT_EQ("1", GetDOMDoNotTrackProperty());
}
// Checks that the DNT header is sent in a request for a dedicated worker
// script.
IN_PROC_BROWSER_TEST_F(DoNotTrackTest, Worker) {
const std::string kWorkerScript = R"(postMessage('DONE');)";
net::test_server::HttpRequest::HeaderMap header_map;
base::RunLoop loop;
embedded_test_server()->RegisterRequestHandler(
base::BindRepeating(&CaptureHeaderHandlerAndReturnScript, "/capture",
&header_map, kWorkerScript, loop.QuitClosure()));
ASSERT_TRUE(embedded_test_server()->Start());
if (!EnableDoNotTrack())
return;
EXPECT_TRUE(NavigateToURL(
shell(), GetURL("/workers/create_worker.html?worker_url=/capture")));
loop.Run();
EXPECT_TRUE(base::Contains(header_map, "DNT"));
EXPECT_EQ("1", header_map["DNT"]);
// Wait until the worker script is loaded to stop the test from crashing
// during destruction.
EXPECT_EQ("DONE", EvalJs(shell(), "waitForMessage();"));
}
// Checks that the DNT header is sent in a request for shared worker script.
// Disabled on Android since a shared worker is not available on Android:
// crbug.com/869745.
#if BUILDFLAG(IS_ANDROID)
#define MAYBE_SharedWorker DISABLED_SharedWorker
#else
#define MAYBE_SharedWorker SharedWorker
#endif
IN_PROC_BROWSER_TEST_F(DoNotTrackTest, MAYBE_SharedWorker) {
const std::string kWorkerScript =
R"(self.onconnect = e => { e.ports[0].postMessage('DONE'); };)";
net::test_server::HttpRequest::HeaderMap header_map;
base::RunLoop loop;
embedded_test_server()->RegisterRequestHandler(
base::BindRepeating(&CaptureHeaderHandlerAndReturnScript, "/capture",
&header_map, kWorkerScript, loop.QuitClosure()));
ASSERT_TRUE(embedded_test_server()->Start());
if (!EnableDoNotTrack())
return;
EXPECT_TRUE(NavigateToURL(
shell(),
GetURL("/workers/create_shared_worker.html?worker_url=/capture")));
loop.Run();
EXPECT_TRUE(base::Contains(header_map, "DNT"));
EXPECT_EQ("1", header_map["DNT"]);
// Wait until the worker script is loaded to stop the test from crashing
// during destruction.
EXPECT_EQ("DONE", EvalJs(shell(), "waitForMessage();"));
}
// Checks that the DNT header is sent in a request for a service worker
// script.
IN_PROC_BROWSER_TEST_F(DoNotTrackTest, ServiceWorker_Register) {
const std::string kWorkerScript = "// empty";
net::test_server::HttpRequest::HeaderMap header_map;
base::RunLoop loop;
embedded_test_server()->RegisterRequestHandler(
base::BindRepeating(&CaptureHeaderHandlerAndReturnScript, "/capture",
&header_map, kWorkerScript, loop.QuitClosure()));
ASSERT_TRUE(embedded_test_server()->Start());
if (!EnableDoNotTrack())
return;
EXPECT_TRUE(NavigateToURL(
shell(), GetURL("/service_worker/create_service_worker.html")));
EXPECT_EQ("DONE", EvalJs(shell(), "register('/capture');"));
loop.Run();
EXPECT_TRUE(base::Contains(header_map, "DNT"));
EXPECT_EQ("1", header_map["DNT"]);
// Service worker doesn't have to wait for onmessage event because
// navigator.serviceWorker.ready can ensure that the script load has
// been completed.
}
// Checks that the DNT header is sent in a request for a module service worker
// script.
IN_PROC_BROWSER_TEST_F(DoNotTrackTest, ModuleServiceWorker_Register) {
if (!EnableDoNotTrack())
return;
const std::string kWorkerScript = "// empty";
net::test_server::HttpRequest::HeaderMap header_map;
base::RunLoop loop;
embedded_test_server()->RegisterRequestHandler(
base::BindRepeating(&CaptureHeaderHandlerAndReturnScript, "/capture",
&header_map, kWorkerScript, loop.QuitClosure()));
ASSERT_TRUE(embedded_test_server()->Start());
EXPECT_TRUE(NavigateToURL(
shell(), GetURL("/service_worker/create_service_worker.html")));
EXPECT_EQ("DONE", EvalJs(shell(), "register('/capture', '', 'module');"));
loop.Run();
EXPECT_TRUE(base::Contains(header_map, "DNT"));
EXPECT_EQ("1", header_map["DNT"]);
// Module Service worker doesn't have to wait for onmessage event because
// navigator.serviceWorker.ready can ensure that the script load has
// been completed.
}
// Checks that the DNT header is sent in a request for a module service worker
// script with a static import.
IN_PROC_BROWSER_TEST_F(DoNotTrackTest,
StaticImportModuleServiceWorker_Register) {
if (!EnableDoNotTrack())
return;
const std::string kModuleScript = "// empty";
const std::string kWorkerScript = "import './captureModule';";
net::test_server::HttpRequest::HeaderMap header_map;
base::RunLoop loop;
embedded_test_server()->RegisterRequestHandler(base::BindRepeating(
&CaptureHeaderHandlerAndReturnScript, "/captureModule", &header_map,
kModuleScript, loop.QuitClosure()));
embedded_test_server()->RegisterRequestHandler(base::BindRepeating(
&CaptureHeaderHandlerAndReturnScript, "/captureWorker", &header_map,
kWorkerScript, loop.QuitClosure()));
ASSERT_TRUE(embedded_test_server()->Start());
EXPECT_TRUE(NavigateToURL(
shell(), GetURL("/service_worker/create_service_worker.html")));
EXPECT_EQ("DONE",
EvalJs(shell(), "register('/captureWorker','', 'module');"));
loop.Run();
EXPECT_TRUE(base::Contains(header_map, "DNT"));
EXPECT_EQ("1", header_map["DNT"]);
// Module Service worker doesn't have to wait for onmessage event because
// navigator.serviceWorker.ready can ensure that the script load has
// been completed.
}
// Checks that the DNT header is sent in a request for a service worker
// script during update checking.
IN_PROC_BROWSER_TEST_F(DoNotTrackTest, ServiceWorker_Update) {
const std::string kWorkerScript = "// empty";
net::test_server::HttpRequest::HeaderMap header_map;
base::RunLoop loop;
// Wait for two requests to capture the request header for updating.
embedded_test_server()->RegisterRequestHandler(base::BindRepeating(
&CaptureHeaderHandlerAndReturnScript, "/capture", &header_map,
kWorkerScript, base::BarrierClosure(2, loop.QuitClosure())));
ASSERT_TRUE(embedded_test_server()->Start());
if (!EnableDoNotTrack())
return;
// Register a service worker, trigger update, then wait until the handler sees
// the second request.
EXPECT_TRUE(NavigateToURL(
shell(), GetURL("/service_worker/create_service_worker.html")));
EXPECT_EQ("DONE", EvalJs(shell(), "register('/capture');"));
EXPECT_EQ("DONE", EvalJs(shell(), "update();"));
loop.Run();
EXPECT_TRUE(base::Contains(header_map, "DNT"));
EXPECT_EQ("1", header_map["DNT"]);
// Service worker doesn't have to wait for onmessage event because
// waiting for a promise by registration.update() can ensure that the script
// load has been completed.
}
// Checks that the DNT header is sent in a request for a module service worker
// script during update checking.
IN_PROC_BROWSER_TEST_F(DoNotTrackTest, ModuleServiceWorker_Update) {
if (!EnableDoNotTrack())
return;
const std::string kWorkerScript = "// empty";
net::test_server::HttpRequest::HeaderMap header_map;
base::RunLoop loop;
// Wait for two requests to capture the request header for updating.
embedded_test_server()->RegisterRequestHandler(base::BindRepeating(
&CaptureHeaderHandlerAndReturnScript, "/capture", &header_map,
kWorkerScript, base::BarrierClosure(2, loop.QuitClosure())));
ASSERT_TRUE(embedded_test_server()->Start());
// Register a module service worker, trigger update, then wait until the
// handler sees the second request.
EXPECT_TRUE(NavigateToURL(
shell(), GetURL("/service_worker/create_service_worker.html")));
EXPECT_EQ("DONE", EvalJs(shell(), "register('/capture','','module');"));
EXPECT_EQ("DONE", EvalJs(shell(), "update();"));
loop.Run();
EXPECT_TRUE(base::Contains(header_map, "DNT"));
EXPECT_EQ("1", header_map["DNT"]);
// Module service worker doesn't have to wait for onmessage event because
// waiting for a promise by registration.update() can ensure that the script
// load has been completed.
}
// Checks that the DNT header is sent in a request for a module service worker
// with static import script during update checking.
IN_PROC_BROWSER_TEST_F(DoNotTrackTest, StaticImportModuleServiceWorker_Update) {
if (!EnableDoNotTrack())
return;
const std::string kModuleScript = "// empty";
const std::string kWorkerScript = "import '/captureModule';";
net::test_server::HttpRequest::HeaderMap header_map;
base::RunLoop loop;
embedded_test_server()->RegisterRequestHandler(base::BindRepeating(
&CaptureHeaderHandlerAndReturnScript, "/captureModule", &header_map,
kModuleScript, loop.QuitClosure()));
embedded_test_server()->RegisterRequestHandler(base::BindRepeating(
&CaptureHeaderHandlerAndReturnScript, "/captureWorker", &header_map,
kWorkerScript, loop.QuitClosure()));
ASSERT_TRUE(embedded_test_server()->Start());
// Register a module service worker, trigger update, then wait until the
// handler sees the second request.
EXPECT_TRUE(NavigateToURL(
shell(), GetURL("/service_worker/create_service_worker.html")));
EXPECT_EQ("DONE", EvalJs(shell(), "register('/captureWorker','','module');"));
EXPECT_EQ("DONE", EvalJs(shell(), "update();"));
loop.Run();
EXPECT_TRUE(base::Contains(header_map, "DNT"));
EXPECT_EQ("1", header_map["DNT"]);
// Module service worker doesn't have to wait for onmessage event because
// waiting for a promise by registration.update() can ensure that the script
// load has been completed.
}
// Checks that the DNT header is preserved when fetching from a dedicated
// worker.
IN_PROC_BROWSER_TEST_F(DoNotTrackTest, FetchFromWorker) {
ASSERT_TRUE(embedded_test_server()->Start());
if (!EnableDoNotTrack())
return;
EXPECT_TRUE(
NavigateToURL(shell(), GetURL("/workers/fetch_from_worker.html")));
EXPECT_EQ("1", EvalJs(shell(), "fetch_from_worker('/echoheader?DNT');"));
}
// Checks that the DNT header is preserved when fetching from a shared worker.
//
// Disabled on Android since a shared worker is not available on Android:
// crbug.com/869745.
#if BUILDFLAG(IS_ANDROID)
#define MAYBE_FetchFromSharedWorker DISABLED_FetchFromSharedWorker
#else
#define MAYBE_FetchFromSharedWorker FetchFromSharedWorker
#endif
IN_PROC_BROWSER_TEST_F(DoNotTrackTest, MAYBE_FetchFromSharedWorker) {
ASSERT_TRUE(embedded_test_server()->Start());
if (!EnableDoNotTrack())
return;
EXPECT_TRUE(
NavigateToURL(shell(), GetURL("/workers/fetch_from_shared_worker.html")));
EXPECT_EQ("1",
EvalJs(shell(), "fetch_from_shared_worker('/echoheader?DNT');"));
}
// Checks that the DNT header is preserved when fetching from a service worker.
IN_PROC_BROWSER_TEST_F(DoNotTrackTest, FetchFromServiceWorker) {
ASSERT_TRUE(embedded_test_server()->Start());
if (!EnableDoNotTrack())
return;
EXPECT_TRUE(NavigateToURL(
shell(), GetURL("/service_worker/fetch_from_service_worker.html")));
EXPECT_EQ("ready", EvalJs(shell(), "setup();"));
EXPECT_EQ("1",
EvalJs(shell(), "fetch_from_service_worker('/echoheader?DNT');"));
}
// Checks that the DNT header is preserved when fetching from a page controlled
// by a service worker which doesn't have a fetch handler and falls back to the
// network.
IN_PROC_BROWSER_TEST_F(DoNotTrackTest,
FetchFromServiceWorkerControlledPage_NoFetchHandler) {
ASSERT_TRUE(embedded_test_server()->Start());
if (!EnableDoNotTrack())
return;
// Register a service worker which controls /service_worker.
EXPECT_TRUE(NavigateToURL(
shell(), GetURL("/service_worker/create_service_worker.html")));
EXPECT_EQ("DONE", EvalJs(shell(), "register('empty.js');"));
// Issue a request from a controlled page.
EXPECT_TRUE(
NavigateToURL(shell(), GetURL("/service_worker/fetch_from_page.html")));
EXPECT_EQ("1", EvalJs(shell(), "fetch_from_page('/echoheader?DNT');"));
}
// Checks that the DNT header is preserved when fetching from a page controlled
// by a service worker which has a fetch handler but falls back to the network.
IN_PROC_BROWSER_TEST_F(DoNotTrackTest,
FetchFromServiceWorkerControlledPage_PassThrough) {
ASSERT_TRUE(embedded_test_server()->Start());
if (!EnableDoNotTrack())
return;
// Register a service worker which controls /service_worker.
EXPECT_TRUE(NavigateToURL(
shell(), GetURL("/service_worker/create_service_worker.html")));
EXPECT_EQ("DONE",
EvalJs(shell(), "register('fetch_event_pass_through.js');"));
// Issue a request from a controlled page.
EXPECT_TRUE(
NavigateToURL(shell(), GetURL("/service_worker/fetch_from_page.html")));
EXPECT_EQ("1", EvalJs(shell(), "fetch_from_page('/echoheader?DNT');"));
}
// Checks that the DNT header is preserved when fetching from a page controlled
// by a service worker which has a fetch handler and responds with fetch().
IN_PROC_BROWSER_TEST_F(DoNotTrackTest,
FetchFromServiceWorkerControlledPage_RespondWithFetch) {
ASSERT_TRUE(embedded_test_server()->Start());
if (!EnableDoNotTrack())
return;
// Register a service worker which controls /service_worker.
EXPECT_TRUE(NavigateToURL(
shell(), GetURL("/service_worker/create_service_worker.html")));
EXPECT_EQ("DONE",
EvalJs(shell(), "register('fetch_event_respond_with_fetch.js');"));
// Issue a request from a controlled page.
EXPECT_TRUE(
NavigateToURL(shell(), GetURL("/service_worker/fetch_from_page.html")));
EXPECT_EQ("1", EvalJs(shell(), "fetch_from_page('/echoheader?DNT');"));
}
} // namespace
} // namespace content