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
content / browser / preloading / prefetch / prefetch_streaming_url_loader.cc [blame]
// Copyright 2022 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/preloading/prefetch/prefetch_streaming_url_loader.h"
#include "base/task/sequenced_task_runner.h"
#include "base/task/single_thread_task_runner.h"
#include "content/browser/loader/navigation_url_loader.h"
#include "content/browser/preloading/prefetch/prefetch_response_reader.h"
#include "net/cookies/cookie_util.h"
#include "services/network/public/cpp/resource_request.h"
#include "services/network/public/mojom/early_hints.mojom.h"
#include "services/network/public/mojom/url_response_head.mojom.h"
namespace content {
PrefetchStreamingURLLoader::PrefetchStreamingURLLoader(
OnPrefetchResponseStartedCallback on_prefetch_response_started_callback,
OnPrefetchResponseCompletedCallback on_prefetch_response_completed_callback,
OnPrefetchRedirectCallback on_prefetch_redirect_callback,
base::OnceClosure on_determined_head_callback)
: on_prefetch_response_started_callback_(
std::move(on_prefetch_response_started_callback)),
on_prefetch_response_completed_callback_(
std::move(on_prefetch_response_completed_callback)),
on_prefetch_redirect_callback_(std::move(on_prefetch_redirect_callback)),
on_determined_head_callback_(std::move(on_determined_head_callback)) {}
void PrefetchStreamingURLLoader::Start(
network::mojom::URLLoaderFactory* url_loader_factory,
const network::ResourceRequest& request,
const net::NetworkTrafficAnnotationTag& network_traffic_annotation,
base::TimeDelta timeout_duration) {
// Copying the ResourceRequest is currently necessary because the Mojo traits
// for TrustedParams currently const_cast and then move the underlying
// devtools_observer, rather than cloning it. The copy constructor for
// TrustedParams, on the other hand, clones it correctly.
//
// This is a violation of const correctness which lead to a confusing bug
// here.
network::ResourceRequest new_request(request);
if (!new_request.trusted_params) {
new_request.trusted_params.emplace();
}
// Request cookies will be included with the response.
// They must be removed before forwarding to any untrusted client.
// This happens in `PrefetchResponseReader::HandleRedirect` and
// `PrefetchResponseReader::OnReceiveResponse`.
new_request.trusted_params->include_request_cookies_with_response = true;
// `is_outermost_main_frame` is true here because the prefetched result is
// served only for outermost main frames.
url_loader_factory->CreateLoaderAndStart(
prefetch_url_loader_.BindNewPipeAndPassReceiver(), /*request_id=*/0,
NavigationURLLoader::GetURLLoaderOptions(
/*is_outermost_main_frame=*/true),
new_request,
prefetch_url_loader_client_receiver_.BindNewPipeAndPassRemote(
base::SingleThreadTaskRunner::GetCurrentDefault()),
net::MutableNetworkTrafficAnnotationTag(network_traffic_annotation));
prefetch_url_loader_client_receiver_.set_disconnect_handler(base::BindOnce(
&PrefetchStreamingURLLoader::DisconnectPrefetchURLLoaderMojo,
weak_ptr_factory_.GetWeakPtr()));
if (!timeout_duration.is_zero()) {
timeout_timer_.Start(
FROM_HERE, timeout_duration,
base::BindOnce(&PrefetchStreamingURLLoader::OnComplete,
weak_ptr_factory_.GetWeakPtr(),
network::URLLoaderCompletionStatus(net::ERR_TIMED_OUT)));
}
}
PrefetchStreamingURLLoader::~PrefetchStreamingURLLoader() = default;
// static
base::WeakPtr<PrefetchStreamingURLLoader>
PrefetchStreamingURLLoader::CreateAndStart(
network::mojom::URLLoaderFactory* url_loader_factory,
const network::ResourceRequest& request,
const net::NetworkTrafficAnnotationTag& network_traffic_annotation,
base::TimeDelta timeout_duration,
OnPrefetchResponseStartedCallback on_prefetch_response_started_callback,
OnPrefetchResponseCompletedCallback on_prefetch_response_completed_callback,
OnPrefetchRedirectCallback on_prefetch_redirect_callback,
base::OnceClosure on_determined_head_callback,
base::WeakPtr<PrefetchResponseReader> response_reader) {
std::unique_ptr<PrefetchStreamingURLLoader> streaming_loader =
std::make_unique<PrefetchStreamingURLLoader>(
std::move(on_prefetch_response_started_callback),
std::move(on_prefetch_response_completed_callback),
std::move(on_prefetch_redirect_callback),
std::move(on_determined_head_callback));
streaming_loader->SetResponseReader(std::move(response_reader));
streaming_loader->Start(url_loader_factory, request,
network_traffic_annotation,
std::move(timeout_duration));
base::WeakPtr<PrefetchStreamingURLLoader> weak_streaming_loader =
streaming_loader->GetWeakPtr();
weak_streaming_loader->self_pointer_ = std::move(streaming_loader);
return weak_streaming_loader;
}
void PrefetchStreamingURLLoader::SetResponseReader(
base::WeakPtr<PrefetchResponseReader> response_reader) {
response_reader_ = std::move(response_reader);
if (response_reader_) {
response_reader_->SetStreamingURLLoader(GetWeakPtr());
}
}
void PrefetchStreamingURLLoader::CancelIfNotServing() {
if (used_for_serving_) {
return;
}
DisconnectPrefetchURLLoaderMojo();
}
void PrefetchStreamingURLLoader::DisconnectPrefetchURLLoaderMojo() {
prefetch_url_loader_.reset();
prefetch_url_loader_client_receiver_.reset();
timeout_timer_.Stop();
if (!self_pointer_) {
return;
}
if (on_deletion_scheduled_for_tests_) {
std::move(on_deletion_scheduled_for_tests_).Run();
}
// To avoid UAF bugs, post a separate task to delete this object, because this
// can be called in one of PrefetchStreamingURLLoader callbacks.
base::SequencedTaskRunner::GetCurrentDefault()->DeleteSoon(
FROM_HERE, std::move(self_pointer_));
}
bool PrefetchStreamingURLLoader::IsDeletionScheduledForCHECK() const {
return !self_pointer_;
}
void PrefetchStreamingURLLoader::SetOnDeletionScheduledForTests(
base::OnceClosure on_deletion_scheduled_for_tests) {
on_deletion_scheduled_for_tests_ = std::move(on_deletion_scheduled_for_tests);
}
void PrefetchStreamingURLLoader::OnReceiveEarlyHints(
network::mojom::EarlyHintsPtr early_hints) {
if (response_reader_) {
response_reader_->OnReceiveEarlyHints(std::move(early_hints));
}
}
void PrefetchStreamingURLLoader::OnReceiveResponse(
network::mojom::URLResponseHeadPtr head,
mojo::ScopedDataPipeConsumerHandle body,
std::optional<mojo_base::BigBuffer> cached_metadata) {
// Cached metadata is not supported for prefetch.
cached_metadata.reset();
head->was_in_prefetch_cache = true;
// Checks head to determine if the prefetch can be served.
CHECK(on_prefetch_response_started_callback_);
std::optional<PrefetchErrorOnResponseReceived> error =
std::move(on_prefetch_response_started_callback_).Run(head.get());
// `head` and `body` are discarded if `response_reader_` is `nullptr`, because
// it means the `PrefetchResponseReader` is deleted and thus we no longer
// serve the prefetched result.
if (response_reader_) {
response_reader_->OnReceiveResponse(std::move(error), std::move(head),
std::move(body));
}
if (on_determined_head_callback_) {
std::move(on_determined_head_callback_).Run();
}
}
void PrefetchStreamingURLLoader::OnReceiveRedirect(
const net::RedirectInfo& redirect_info,
network::mojom::URLResponseHeadPtr redirect_head) {
CHECK(on_prefetch_redirect_callback_);
on_prefetch_redirect_callback_.Run(redirect_info, std::move(redirect_head));
}
void PrefetchStreamingURLLoader::HandleRedirect(
PrefetchRedirectStatus redirect_status,
const net::RedirectInfo& redirect_info,
network::mojom::URLResponseHeadPtr redirect_head) {
CHECK(redirect_head);
// If the prefetch_url_loader_ is no longer connected, mark this as failed.
if (!prefetch_url_loader_) {
redirect_status = PrefetchRedirectStatus::kFail;
}
switch (redirect_status) {
case PrefetchRedirectStatus::kFollow:
CHECK(prefetch_url_loader_);
prefetch_url_loader_->FollowRedirect(
/*removed_headers=*/std::vector<std::string>(),
/*modified_headers=*/net::HttpRequestHeaders(),
/*modified_cors_exempt_headers=*/net::HttpRequestHeaders(),
/*new_url=*/std::nullopt);
break;
case PrefetchRedirectStatus::kSwitchNetworkContext:
// The redirect requires a switch in network context, so the redirect will
// be followed using a separate PrefetchStreamingURLLoader, and this url
// loader will stop its request.
DisconnectPrefetchURLLoaderMojo();
break;
case PrefetchRedirectStatus::kFail:
DisconnectPrefetchURLLoaderMojo();
if (on_determined_head_callback_) {
std::move(on_determined_head_callback_).Run();
}
break;
}
if (response_reader_) {
response_reader_->HandleRedirect(redirect_status, redirect_info,
std::move(redirect_head));
}
}
void PrefetchStreamingURLLoader::OnUploadProgress(
int64_t current_position,
int64_t total_size,
OnUploadProgressCallback callback) {
// Only handle GETs.
NOTREACHED_IN_MIGRATION();
}
void PrefetchStreamingURLLoader::OnTransferSizeUpdated(
int32_t transfer_size_diff) {
if (response_reader_) {
response_reader_->OnTransferSizeUpdated(transfer_size_diff);
}
}
void PrefetchStreamingURLLoader::OnComplete(
const network::URLLoaderCompletionStatus& completion_status) {
DisconnectPrefetchURLLoaderMojo();
if (response_reader_) {
response_reader_->OnComplete(completion_status);
}
if (completion_status.error_code != net::OK) {
// Notify a failure if the callback is not consumed yet.
if (on_determined_head_callback_) {
std::move(on_determined_head_callback_).Run();
}
}
std::move(on_prefetch_response_completed_callback_).Run(completion_status);
}
void PrefetchStreamingURLLoader::OnStartServing() {
// Once the prefetch is served, stop the timeout timer.
timeout_timer_.Stop();
used_for_serving_ = true;
}
void PrefetchStreamingURLLoader::SetPriority(net::RequestPriority priority,
int32_t intra_priority_value) {
if (prefetch_url_loader_) {
prefetch_url_loader_->SetPriority(priority, intra_priority_value);
}
}
void PrefetchStreamingURLLoader::PauseReadingBodyFromNet() {
if (prefetch_url_loader_) {
prefetch_url_loader_->PauseReadingBodyFromNet();
}
}
void PrefetchStreamingURLLoader::ResumeReadingBodyFromNet() {
if (prefetch_url_loader_) {
prefetch_url_loader_->ResumeReadingBodyFromNet();
}
}
} // namespace content