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
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
content / browser / renderer_host / navigation_throttle_runner_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/renderer_host/navigation_throttle_runner.h"
#include <optional>
#include "base/functional/bind.h"
#include "base/metrics/metrics_hashes.h"
#include "components/ukm/test_ukm_recorder.h"
#include "content/public/browser/navigation_throttle.h"
#include "content/public/common/url_constants.h"
#include "content/public/test/mock_navigation_handle.h"
#include "content/public/test/test_navigation_throttle.h"
#include "content/public/test/test_renderer_host.h"
#include "services/metrics/public/cpp/ukm_builders.h"
namespace content {
// Test version of a NavigationThrottle that will execute a callback when
// called.
class DeletingNavigationThrottle : public NavigationThrottle {
public:
DeletingNavigationThrottle(NavigationHandle* handle,
const base::RepeatingClosure& deletion_callback)
: NavigationThrottle(handle), deletion_callback_(deletion_callback) {}
~DeletingNavigationThrottle() override {}
NavigationThrottle::ThrottleCheckResult WillStartRequest() override {
deletion_callback_.Run();
return NavigationThrottle::PROCEED;
}
NavigationThrottle::ThrottleCheckResult WillRedirectRequest() override {
deletion_callback_.Run();
return NavigationThrottle::PROCEED;
}
NavigationThrottle::ThrottleCheckResult WillFailRequest() override {
deletion_callback_.Run();
return NavigationThrottle::PROCEED;
}
NavigationThrottle::ThrottleCheckResult WillProcessResponse() override {
deletion_callback_.Run();
return NavigationThrottle::PROCEED;
}
NavigationThrottle::ThrottleCheckResult WillCommitWithoutUrlLoader()
override {
deletion_callback_.Run();
return NavigationThrottle::PROCEED;
}
const char* GetNameForLogging() override {
return "DeletingNavigationThrottle";
}
private:
base::RepeatingClosure deletion_callback_;
};
class NavigationThrottleRunnerTest : public RenderViewHostTestHarness,
public NavigationThrottleRunner::Delegate {
public:
NavigationThrottleRunnerTest()
: delegate_result_(NavigationThrottle::DEFER) {}
void SetUp() override {
RenderViewHostTestHarness::SetUp();
runner_ = std::make_unique<NavigationThrottleRunner>(this, 1, true);
}
void Resume() { runner_->CallResumeForTesting(); }
void SimulateEvent(NavigationThrottleRunner::Event event) {
was_delegate_notified_ = false;
delegate_result_ = NavigationThrottle::DEFER;
observer_last_event_ = NavigationThrottleRunner::Event::kNoEvent;
runner_->ProcessNavigationEvent(event);
}
// Whether the callback was called.
bool was_delegate_notified() const { return was_delegate_notified_; }
// Returns the delegate_result.
NavigationThrottle::ThrottleCheckResult delegate_result() const {
return delegate_result_;
}
NavigationThrottleRunner::Event observer_last_event() const {
return observer_last_event_;
}
bool is_deferring() { return runner_->GetDeferringThrottle() != nullptr; }
NavigationThrottleRunner* runner() { return runner_.get(); }
void CheckNotNotified(TestNavigationThrottle* throttle) {
CHECK_EQ(
0, throttle->GetCallCount(TestNavigationThrottle::WILL_START_REQUEST));
CHECK_EQ(0, throttle->GetCallCount(
TestNavigationThrottle::WILL_REDIRECT_REQUEST));
CHECK_EQ(0,
throttle->GetCallCount(TestNavigationThrottle::WILL_FAIL_REQUEST));
CHECK_EQ(0, throttle->GetCallCount(
TestNavigationThrottle::WILL_PROCESS_RESPONSE));
}
void CheckNotifiedOfEvent(TestNavigationThrottle* throttle,
NavigationThrottleRunner::Event event) {
if (event == NavigationThrottleRunner::Event::kWillStartRequest) {
CHECK_EQ(1, throttle->GetCallCount(
TestNavigationThrottle::WILL_START_REQUEST));
} else {
CHECK_EQ(0, throttle->GetCallCount(
TestNavigationThrottle::WILL_START_REQUEST));
}
if (event == NavigationThrottleRunner::Event::kWillRedirectRequest) {
CHECK_EQ(1, throttle->GetCallCount(
TestNavigationThrottle::WILL_REDIRECT_REQUEST));
} else {
CHECK_EQ(0, throttle->GetCallCount(
TestNavigationThrottle::WILL_REDIRECT_REQUEST));
}
if (event == NavigationThrottleRunner::Event::kWillFailRequest) {
CHECK_EQ(
1, throttle->GetCallCount(TestNavigationThrottle::WILL_FAIL_REQUEST));
} else {
CHECK_EQ(
0, throttle->GetCallCount(TestNavigationThrottle::WILL_FAIL_REQUEST));
}
if (event == NavigationThrottleRunner::Event::kWillProcessResponse) {
CHECK_EQ(1, throttle->GetCallCount(
TestNavigationThrottle::WILL_PROCESS_RESPONSE));
} else {
CHECK_EQ(0, throttle->GetCallCount(
TestNavigationThrottle::WILL_PROCESS_RESPONSE));
}
if (event == NavigationThrottleRunner::Event::kWillCommitWithoutUrlLoader) {
CHECK_EQ(1, throttle->GetCallCount(
TestNavigationThrottle::WILL_COMMIT_WITHOUT_URL_LOADER));
} else {
CHECK_EQ(0, throttle->GetCallCount(
TestNavigationThrottle::WILL_COMMIT_WITHOUT_URL_LOADER));
}
}
// Creates, register and returns a TestNavigationThrottle that will
// synchronously return |result| on checks by default.
TestNavigationThrottle* CreateTestNavigationThrottle(
NavigationThrottle::ThrottleCheckResult result) {
TestNavigationThrottle* test_throttle =
new TestNavigationThrottle(&handle_);
test_throttle->SetResponseForAllMethods(TestNavigationThrottle::SYNCHRONOUS,
result);
runner_->AddThrottle(
std::unique_ptr<TestNavigationThrottle>(test_throttle));
return test_throttle;
}
// Creates, register and returns a TestNavigationThrottle that will
// synchronously return |result| on check for the given |method|, and
// NavigationThrottle::PROCEED otherwise.
TestNavigationThrottle* CreateTestNavigationThrottle(
TestNavigationThrottle::ThrottleMethod method,
NavigationThrottle::ThrottleCheckResult result) {
TestNavigationThrottle* test_throttle =
CreateTestNavigationThrottle(NavigationThrottle::PROCEED);
test_throttle->SetResponse(method, TestNavigationThrottle::SYNCHRONOUS,
result);
return test_throttle;
}
// Creates and register a NavigationThrottle that will delete the
// NavigationHandle in checks.
void AddDeletingNavigationThrottle() {
runner_->AddThrottle(std::make_unique<DeletingNavigationThrottle>(
&handle_,
base::BindRepeating(
&NavigationThrottleRunnerTest::ResetNavigationThrottleRunner,
base::Unretained(this))));
}
ukm::TestUkmRecorder& test_ukm_recorder() { return test_ukm_recorder_; }
private:
// NavigationThrottleRunner::Delegate:
void OnNavigationEventProcessed(
NavigationThrottleRunner::Event event,
NavigationThrottle::ThrottleCheckResult result) override {
DCHECK(!was_delegate_notified_);
delegate_result_ = result;
was_delegate_notified_ = true;
observer_last_event_ = event;
}
void ResetNavigationThrottleRunner() { runner_.reset(); }
std::unique_ptr<NavigationThrottleRunner> runner_;
MockNavigationHandle handle_;
NavigationThrottleRunner::Event observer_last_event_ =
NavigationThrottleRunner::Event::kNoEvent;
bool was_delegate_notified_ = false;
NavigationThrottle::ThrottleCheckResult delegate_result_;
ukm::TestAutoSetUkmRecorder test_ukm_recorder_;
};
class NavigationThrottleRunnerTestWithEvent
: public NavigationThrottleRunnerTest,
public testing::WithParamInterface<NavigationThrottleRunner::Event> {
public:
NavigationThrottleRunnerTestWithEvent() : NavigationThrottleRunnerTest() {}
~NavigationThrottleRunnerTestWithEvent() override {}
void SetUp() override {
NavigationThrottleRunnerTest::SetUp();
event_ = GetParam();
}
NavigationThrottleRunner::Event event() const { return event_; }
void CheckNotified(TestNavigationThrottle* throttle) {
CheckNotifiedOfEvent(throttle, event());
}
private:
NavigationThrottleRunner::Event event_;
};
// Checks that a navigation deferred by a NavigationThrottle can be properly
// resumed.
TEST_P(NavigationThrottleRunnerTestWithEvent, ResumeDeferred) {
TestNavigationThrottle* test_throttle =
CreateTestNavigationThrottle(NavigationThrottle::DEFER);
CheckNotNotified(test_throttle);
// Simulate the event. The request should be deferred. The observer
// should not have been notified.
SimulateEvent(event());
CheckNotified(test_throttle);
EXPECT_TRUE(is_deferring());
EXPECT_FALSE(was_delegate_notified());
// Resume the request. It should no longer be deferred and the observer
// should have been notified.
Resume();
CheckNotified(test_throttle);
EXPECT_FALSE(is_deferring());
EXPECT_TRUE(was_delegate_notified());
EXPECT_EQ(NavigationThrottle::PROCEED, delegate_result());
EXPECT_EQ(event(), observer_last_event());
}
// Checks that a NavigationThrottleRunner can be safely deleted by the execution
// of one of its NavigationThrottle.
TEST_P(NavigationThrottleRunnerTestWithEvent, DeletionByNavigationThrottle) {
AddDeletingNavigationThrottle();
SimulateEvent(event());
EXPECT_EQ(nullptr, runner());
EXPECT_FALSE(was_delegate_notified());
}
// Checks that a NavigationThrottleRunner can be safely deleted by the execution
// of one of its NavigationThrottle following a call to
// ResumeProcessingNavigationEvent.
TEST_P(NavigationThrottleRunnerTestWithEvent,
DeletionByNavigationThrottleAfterResume) {
CreateTestNavigationThrottle(NavigationThrottle::DEFER);
AddDeletingNavigationThrottle();
SimulateEvent(event());
EXPECT_NE(nullptr, runner());
Resume();
EXPECT_EQ(nullptr, runner());
EXPECT_FALSE(was_delegate_notified());
}
INSTANTIATE_TEST_SUITE_P(
AllEvents,
NavigationThrottleRunnerTestWithEvent,
::testing::Values(
NavigationThrottleRunner::Event::kWillStartRequest,
NavigationThrottleRunner::Event::kWillRedirectRequest,
NavigationThrottleRunner::Event::kWillFailRequest,
NavigationThrottleRunner::Event::kWillProcessResponse,
NavigationThrottleRunner::Event::kWillCommitWithoutUrlLoader));
class NavigationThrottleRunnerTestWithEventAndAction
: public NavigationThrottleRunnerTest,
public testing::WithParamInterface<
std::tuple<NavigationThrottleRunner::Event,
NavigationThrottle::ThrottleAction>> {
public:
NavigationThrottleRunnerTestWithEventAndAction()
: NavigationThrottleRunnerTest() {}
~NavigationThrottleRunnerTestWithEventAndAction() override {}
void SetUp() override {
NavigationThrottleRunnerTest::SetUp();
std::tie(event_, action_) = GetParam();
}
NavigationThrottleRunner::Event event() const { return event_; }
NavigationThrottle::ThrottleAction action() const { return action_; }
void CheckNotified(TestNavigationThrottle* throttle) {
CheckNotifiedOfEvent(throttle, event());
}
private:
NavigationThrottleRunner::Event event_;
NavigationThrottle::ThrottleAction action_;
};
// Checks that a NavigationThrottle asking during to defer
// followed by another NavigationThrottle behave correctly.
TEST_P(NavigationThrottleRunnerTestWithEventAndAction, DeferThenAction) {
TestNavigationThrottle* defer_throttle =
CreateTestNavigationThrottle(NavigationThrottle::DEFER);
TestNavigationThrottle* test_throttle =
CreateTestNavigationThrottle(action());
CheckNotNotified(defer_throttle);
CheckNotNotified(test_throttle);
// Simulate the event. The request should be deferred. The observer
// should not have been notified. The second throttle should not have been
// notified.
SimulateEvent(event());
CheckNotified(defer_throttle);
CheckNotNotified(test_throttle);
EXPECT_TRUE(is_deferring());
EXPECT_FALSE(was_delegate_notified());
// Resume the request. It should no longer be deferred and the observer
// should have been notified. The second throttle should have been notified.
Resume();
CheckNotified(defer_throttle);
CheckNotified(test_throttle);
EXPECT_FALSE(is_deferring());
EXPECT_TRUE(was_delegate_notified());
EXPECT_EQ(action(), delegate_result().action());
EXPECT_EQ(event(), observer_last_event());
}
// Checks that a NavigationThrottle asking to cancel followed by a
// NavigationThrottle asking to proceed behave correctly. The navigation will
// be stopped directly, and the second throttle will not be called.
TEST_P(NavigationThrottleRunnerTestWithEventAndAction, CancelThenProceed) {
if (action() == NavigationThrottle::PROCEED)
return;
TestNavigationThrottle* test_throttle =
CreateTestNavigationThrottle(action());
TestNavigationThrottle* proceed_throttle =
CreateTestNavigationThrottle(NavigationThrottle::PROCEED);
CheckNotNotified(test_throttle);
CheckNotNotified(proceed_throttle);
// Simulate the event. The request should be not be deferred. The observer
// should have been notified. The second throttle should not have been
// notified.
SimulateEvent(event());
CheckNotified(test_throttle);
CheckNotNotified(proceed_throttle);
EXPECT_FALSE(is_deferring());
EXPECT_TRUE(was_delegate_notified());
EXPECT_EQ(action(), delegate_result().action());
EXPECT_EQ(event(), observer_last_event());
}
// Checks that a NavigationThrottle asking to proceed followed by a
// NavigationThrottle asking to cancel behave correctly.
// Both throttles will be called, and the request will be cancelled.
TEST_P(NavigationThrottleRunnerTestWithEventAndAction, ProceedThenCancel) {
if (action() == NavigationThrottle::PROCEED)
return;
TestNavigationThrottle* proceed_throttle =
CreateTestNavigationThrottle(NavigationThrottle::PROCEED);
TestNavigationThrottle* test_throttle =
CreateTestNavigationThrottle(action());
CheckNotNotified(test_throttle);
CheckNotNotified(proceed_throttle);
// Simulate the event. The request should be not be deferred. The observer
// should have been notified.
SimulateEvent(event());
CheckNotified(proceed_throttle);
CheckNotified(test_throttle);
EXPECT_FALSE(is_deferring());
EXPECT_TRUE(was_delegate_notified());
EXPECT_EQ(action(), delegate_result().action());
EXPECT_EQ(event(), observer_last_event());
}
// Checks that a NavigationThrottle being deferred and resumed records UKM about
// the deferral.
TEST_P(NavigationThrottleRunnerTestWithEventAndAction, DeferRecordsUKM) {
TestNavigationThrottle* defer_throttle =
CreateTestNavigationThrottle(NavigationThrottle::DEFER);
CheckNotNotified(defer_throttle);
// Simulate the event. The request should be deferred.
SimulateEvent(event());
CheckNotified(defer_throttle);
EXPECT_TRUE(is_deferring());
// Resume the request. This should record UKM.
Resume();
// There should be one entry with name hash matching the logging name and
// event that is being run. Ignore the time for testing as it is variable, and
// even possibly 0.
const auto& entries = test_ukm_recorder().GetEntriesByName(
ukm::builders::NavigationThrottleDeferredTime::kEntryName);
EXPECT_EQ(1u, entries.size());
for (const ukm::mojom::UkmEntry* entry : entries) {
EXPECT_EQ(*ukm::TestUkmRecorder::GetEntryMetric(
entry, ukm::builders::NavigationThrottleDeferredTime::
kNavigationThrottleEventTypeName),
static_cast<int64_t>(event()));
EXPECT_EQ(*ukm::TestUkmRecorder::GetEntryMetric(
entry, ukm::builders::NavigationThrottleDeferredTime::
kNavigationThrottleNameHashName),
static_cast<int64_t>(
base::HashMetricName(defer_throttle->GetNameForLogging())));
}
}
INSTANTIATE_TEST_SUITE_P(
AllEvents,
NavigationThrottleRunnerTestWithEventAndAction,
::testing::Combine(
::testing::Values(
NavigationThrottleRunner::Event::kWillStartRequest,
NavigationThrottleRunner::Event::kWillRedirectRequest,
NavigationThrottleRunner::Event::kWillFailRequest,
NavigationThrottleRunner::Event::kWillProcessResponse,
NavigationThrottleRunner::Event::kWillCommitWithoutUrlLoader),
::testing::Values(NavigationThrottle::PROCEED,
NavigationThrottle::CANCEL,
NavigationThrottle::CANCEL_AND_IGNORE,
NavigationThrottle::BLOCK_REQUEST,
NavigationThrottle::BLOCK_REQUEST_AND_COLLAPSE,
NavigationThrottle::BLOCK_RESPONSE)));
class NavigationThrottleRunnerTestWithEventAndError
: public NavigationThrottleRunnerTest,
public testing::WithParamInterface<
std::tuple<NavigationThrottleRunner::Event,
net::Error,
std::optional<std::string>>> {
public:
NavigationThrottleRunnerTestWithEventAndError()
: NavigationThrottleRunnerTest() {}
~NavigationThrottleRunnerTestWithEventAndError() override {}
void SetUp() override {
NavigationThrottleRunnerTest::SetUp();
std::tie(event_, error_, custom_error_page_) = GetParam();
}
NavigationThrottleRunner::Event event() const { return event_; }
net::Error error() const { return error_; }
const std::optional<std::string>& custom_error_page() const {
return custom_error_page_;
}
void CheckNotified(TestNavigationThrottle* throttle) {
CheckNotifiedOfEvent(throttle, event());
}
private:
NavigationThrottleRunner::Event event_;
net::Error error_;
std::optional<std::string> custom_error_page_ = std::nullopt;
};
// Checks that the NavigationThrottleRunner correctly propagates a
// ThrottleCheckResult with a custom error page and/or error code to its
// delegate.
TEST_P(NavigationThrottleRunnerTestWithEventAndError, CustomNetError) {
SCOPED_TRACE(::testing::Message()
<< "Event: " << static_cast<int>(event())
<< " Error: " << error() << " Custom error page: "
<< (custom_error_page().has_value() ? custom_error_page().value()
: ""));
NavigationThrottle::ThrottleCheckResult result(NavigationThrottle::CANCEL,
error());
if (custom_error_page().has_value()) {
result = NavigationThrottle::ThrottleCheckResult(
NavigationThrottle::CANCEL, error(), custom_error_page().value());
}
TestNavigationThrottle* test_throttle = CreateTestNavigationThrottle(result);
CheckNotNotified(test_throttle);
// Simulate the event. The request should not be deferred. The
// callback should have been called.
SimulateEvent(event());
EXPECT_FALSE(is_deferring());
EXPECT_TRUE(was_delegate_notified());
EXPECT_EQ(NavigationThrottle::CANCEL, delegate_result().action());
EXPECT_EQ(error(), delegate_result().net_error_code());
EXPECT_EQ(custom_error_page().has_value(),
delegate_result().error_page_content().has_value());
if (custom_error_page().has_value()) {
EXPECT_EQ(custom_error_page().value(),
delegate_result().error_page_content().value());
}
CheckNotified(test_throttle);
}
INSTANTIATE_TEST_SUITE_P(
AllEvents,
NavigationThrottleRunnerTestWithEventAndError,
::testing::Combine(
::testing::Values(
NavigationThrottleRunner::Event::kWillStartRequest,
NavigationThrottleRunner::Event::kWillRedirectRequest,
NavigationThrottleRunner::Event::kWillFailRequest,
NavigationThrottleRunner::Event::kWillProcessResponse,
NavigationThrottleRunner::Event::kWillCommitWithoutUrlLoader),
::testing::Values(net::ERR_BLOCKED_BY_ADMINISTRATOR, net::ERR_ABORTED),
::testing::Values(std::nullopt, "<html><body>test</body></html>")));
} // namespace content