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
content / browser / preloading / prerenderer_impl.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.
#ifdef UNSAFE_BUFFERS_BUILD
// TODO(crbug.com/341324165): Fix and remove.
#pragma allow_unsafe_buffers
#endif
#include "content/browser/preloading/prerenderer_impl.h"
#include <vector>
#include "base/feature_list.h"
#include "content/browser/preloading/prefetch/no_vary_search_helper.h"
#include "content/browser/preloading/prefetch/prefetch_document_manager.h"
#include "content/browser/preloading/preloading.h"
#include "content/browser/preloading/preloading_attempt_impl.h"
#include "content/browser/preloading/preloading_data_impl.h"
#include "content/browser/preloading/preloading_trigger_type_impl.h"
#include "content/browser/preloading/prerender/prerender_attributes.h"
#include "content/browser/preloading/prerender/prerender_features.h"
#include "content/browser/preloading/prerender/prerender_final_status.h"
#include "content/browser/preloading/prerender/prerender_host_registry.h"
#include "content/browser/preloading/prerender/prerender_metrics.h"
#include "content/browser/preloading/prerender/prerender_navigation_utils.h"
#include "content/browser/preloading/prerender/prerender_new_tab_handle.h"
#include "content/browser/renderer_host/render_frame_host_delegate.h"
#include "content/public/browser/preloading_trigger_type.h"
#include "content/public/browser/web_contents.h"
#include "third_party/blink/public/common/features.h"
namespace content {
struct PrerendererImpl::PrerenderInfo {
blink::mojom::SpeculationInjectionType injection_type;
blink::mojom::SpeculationEagerness eagerness;
FrameTreeNodeId prerender_host_id;
GURL url;
};
PrerendererImpl::PrerendererImpl(RenderFrameHost& render_frame_host)
: WebContentsObserver(WebContents::FromRenderFrameHost(&render_frame_host)),
render_frame_host_(render_frame_host) {
DCHECK_CURRENTLY_ON(BrowserThread::UI);
auto& rfhi = static_cast<RenderFrameHostImpl&>(render_frame_host);
registry_ = rfhi.delegate()->GetPrerenderHostRegistry()->GetWeakPtr();
if (registry_) {
observation_.Observe(registry_.get());
}
ResetReceivedPrerendersCountForMetrics();
if (base::FeatureList::IsEnabled(
blink::features::kLCPTimingPredictorPrerender2)) {
blocked_ = true;
}
}
PrerendererImpl::~PrerendererImpl() {
DCHECK_CURRENTLY_ON(BrowserThread::UI);
CancelStartedPrerenders();
RecordReceivedPrerendersCountToMetrics();
ResetReceivedPrerendersCountForMetrics();
}
void PrerendererImpl::PrimaryPageChanged(Page& page) {
// Listen to the change of the primary page. Since only the primary page can
// trigger speculationrules, the change of the primary page indicates that the
// trigger associated with this host is destroyed, so the browser should
// cancel the prerenders that are initiated by it.
// We cannot do it in the destructor only, because DocumentService can be
// deleted asynchronously, but we want to make sure to cancel prerendering
// before the next primary page swaps in so that the next page can trigger a
// new prerender without hitting the max number of running prerenders.
DCHECK_CURRENTLY_ON(BrowserThread::UI);
CancelStartedPrerenders();
RecordReceivedPrerendersCountToMetrics();
ResetReceivedPrerendersCountForMetrics();
}
// TODO(isaboori) Part of the logic in |ProcessCandidatesForPrerender| method is
// about making preloading decisions and could be moved to PreloadingDecider
// class.
void PrerendererImpl::ProcessCandidatesForPrerender(
const std::vector<blink::mojom::SpeculationCandidatePtr>& candidates) {
if (!registry_)
return;
// Extract only the candidates which apply to prerender, and sort them by URL
// so we can efficiently compare them to `started_prerenders_`.
std::vector<std::pair<size_t, blink::mojom::SpeculationCandidatePtr>>
prerender_candidates;
for (const auto& candidate : candidates) {
if (candidate->action == blink::mojom::SpeculationAction::kPrerender) {
prerender_candidates.emplace_back(prerender_candidates.size(),
candidate.Clone());
}
}
base::ranges::stable_sort(prerender_candidates, std::less<>(),
[](const auto& p) { return p.second->url; });
std::vector<std::pair<size_t, blink::mojom::SpeculationCandidatePtr>>
candidates_to_start;
// Collects the host ids corresponding to the URLs that are removed from the
// speculation rules. These hosts are cancelled later.
std::vector<FrameTreeNodeId> removed_prerender_rules;
// Compare the sorted candidate and started prerender lists to one another.
// Since they are sorted, we process the lexicographically earlier of the two
// URLs pointed at by the iterators, and compare the range of entries in each
// that match that URL.
//
// URLs which are present in the prerender list but not the candidate list can
// no longer proceed and are cancelled.
//
// URLs which are present in the candidate list but not the prerender list
// could be started and are gathered in `candidates_to_start`.
auto candidate_it = prerender_candidates.begin();
auto started_it = started_prerenders_.begin();
while (candidate_it != prerender_candidates.end() ||
started_it != started_prerenders_.end()) {
// Select the lesser of the two URLs to diff.
GURL url;
if (started_it == started_prerenders_.end())
url = candidate_it->second->url;
else if (candidate_it == prerender_candidates.end())
url = started_it->url;
else
url = std::min(candidate_it->second->url, started_it->url);
// Select the ranges from both that match the URL in question.
auto equal_prerender_end = base::ranges::find_if(
started_it, started_prerenders_.end(),
[&](const auto& started) { return started.url != url; });
base::span<PrerenderInfo> matching_prerenders(started_it,
equal_prerender_end);
auto equal_candidate_end = base::ranges::find_if(
candidate_it, prerender_candidates.end(),
[&](const auto& candidate) { return candidate.second->url != url; });
base::span<std::pair<size_t, blink::mojom::SpeculationCandidatePtr>>
matching_candidates(candidate_it, equal_candidate_end);
// Decide what started prerenders to cancel.
for (PrerenderInfo& prerender : matching_prerenders) {
if (prerender.prerender_host_id.is_null()) {
continue;
}
// TODO(jbroman): This doesn't currently care about other aspects, like
// the referrer. This doesn't presently matter, but in the future we might
// want to cancel if there are candidates which match by URL but none of
// which permit this prerender.
if (matching_candidates.empty()) {
removed_prerender_rules.push_back(prerender.prerender_host_id);
}
}
// Decide what new candidates to start.
// For now, start the first candidate for a URL only if there are no
// matching prerenders. We could be cleverer in the future.
if (matching_prerenders.empty()) {
CHECK_GT(matching_candidates.size(), 0u);
candidates_to_start.push_back(std::move(matching_candidates[0]));
}
// Advance the iterators past all matching entries.
candidate_it = equal_candidate_end;
started_it = equal_prerender_end;
}
std::set<FrameTreeNodeId> canceled_prerender_rules_set =
registry_->CancelHosts(
removed_prerender_rules,
PrerenderCancellationReason(
PrerenderFinalStatus::kSpeculationRuleRemoved));
// Canceled prerenders by kSpeculationRuleRemoved should have already been
// removed from `started_prerenders_` via `OnCancel`.
CHECK(std::find_if(started_prerenders_.begin(), started_prerenders_.end(),
[&](const PrerenderInfo& x) {
return base::Contains(canceled_prerender_rules_set,
x.prerender_host_id);
}) == started_prerenders_.end());
// Actually start the candidates in their original order once the diffing is
// done.
base::ranges::sort(candidates_to_start, std::less<>(),
[](const auto& p) { return p.first; });
for (const auto& [_, candidate] : candidates_to_start) {
PreloadingTriggerType trigger_type =
PreloadingTriggerTypeFromSpeculationInjectionType(
candidate->injection_type);
// Eager candidates are enacted by the same predictor that creates them.
PreloadingPredictor enacting_predictor =
GetPredictorForPreloadingTriggerType(trigger_type);
MaybePrerender(candidate, enacting_predictor, PreloadingConfidence{100});
}
}
void PrerendererImpl::OnLCPPredicted() {
blocked_ = false;
for (auto& [candidate, enacting_predictor, confidence] :
std::move(blocked_candidates_)) {
MaybePrerender(candidate, enacting_predictor, confidence);
}
}
bool PrerendererImpl::MaybePrerender(
const blink::mojom::SpeculationCandidatePtr& candidate,
const PreloadingPredictor& enacting_predictor,
PreloadingConfidence confidence) {
CHECK_EQ(candidate->action, blink::mojom::SpeculationAction::kPrerender);
// Prerendering is not allowed in fenced frames.
if (render_frame_host_->IsNestedWithinFencedFrame()) {
render_frame_host_->AddMessageToConsole(
blink::mojom::ConsoleMessageLevel::kWarning,
"The SpeculationRules API does not support prerendering in fenced "
"frames.");
return false;
}
if (blocked_) {
blocked_candidates_.emplace_back(candidate->Clone(), enacting_predictor,
confidence);
return false;
}
// Prerendering frames should not trigger any prerender request.
CHECK(!render_frame_host_->IsInLifecycleState(
RenderFrameHost::LifecycleState::kPrerendering));
if (!registry_)
return false;
auto& rfhi = static_cast<RenderFrameHostImpl&>(render_frame_host_.get());
WebContents* web_contents =
WebContents::FromRenderFrameHost(&render_frame_host_.get());
auto [begin, end] = base::ranges::equal_range(
started_prerenders_.begin(), started_prerenders_.end(), candidate->url,
std::less<>(), &PrerenderInfo::url);
// cannot currently start a second prerender with the same URL
if (begin != end) {
return false;
}
GetContentClient()->browser()->LogWebFeatureForCurrentPage(
&rfhi, blink::mojom::WebFeature::kSpeculationRulesPrerender);
auto* preloading_data = static_cast<PreloadingDataImpl*>(
PreloadingData::GetOrCreateForWebContents(web_contents));
preloading_data->SetHasSpeculationRulesPrerender();
IncrementReceivedPrerendersCountForMetrics(
PreloadingTriggerTypeFromSpeculationInjectionType(
candidate->injection_type),
candidate->eagerness);
// TODO(crbug.com/40168192): Remove it after supporting cross-site
// prerender.
if (!prerender_navigation_utils::IsSameSite(candidate->url,
rfhi.GetLastCommittedOrigin())) {
rfhi.AddMessageToConsole(
blink::mojom::ConsoleMessageLevel::kWarning,
base::StringPrintf(
"The SpeculationRules API does not support cross-site prerender "
"yet (initiator origin: %s, prerender origin: %s). "
"https://crbug.com/1176054 tracks cross-site support.",
rfhi.GetLastCommittedOrigin().Serialize().c_str(),
url::Origin::Create(candidate->url).Serialize().c_str()));
}
std::optional<net::HttpNoVarySearchData> no_vary_search_expected;
if (base::FeatureList::IsEnabled(blink::features::kPrerender2NoVarySearch) &&
candidate->no_vary_search_hint) {
no_vary_search_expected =
no_vary_search::ParseHttpNoVarySearchDataFromMojom(
candidate->no_vary_search_hint);
}
PrerenderAttributes attributes(
candidate->url,
PreloadingTriggerTypeFromSpeculationInjectionType(
candidate->injection_type),
/*embedder_histogram_suffix=*/"",
candidate->target_browsing_context_name_hint,
Referrer{*candidate->referrer}, candidate->eagerness,
no_vary_search_expected, rfhi.GetLastCommittedOrigin(),
rfhi.GetProcess()->GetID(), web_contents->GetWeakPtr(),
rfhi.GetFrameToken(), rfhi.GetFrameTreeNodeId(),
rfhi.GetPageUkmSourceId(), ui::PAGE_TRANSITION_LINK,
/*should_warm_up_compositor=*/false,
/*url_match_predicate=*/{},
/*prerender_navigation_handle_callback=*/{},
base::MakeRefCounted<PreloadPipelineInfo>(),
rfhi.GetDevToolsNavigationToken());
PreloadingTriggerType trigger_type =
PreloadingTriggerTypeFromSpeculationInjectionType(
candidate->injection_type);
PreloadingPredictor creating_predictor =
GetPredictorForPreloadingTriggerType(trigger_type);
FrameTreeNodeId prerender_host_id = [&] {
// TODO(crbug.com/40235424): Handle the case where multiple speculation
// rules have the same URL but its `target_browsing_context_name_hint` is
// different. In the current implementation, only the first rule is
// triggered.
switch (candidate->target_browsing_context_name_hint) {
case blink::mojom::SpeculationTargetHint::kBlank: {
if (base::FeatureList::IsEnabled(
blink::features::kPrerender2InNewTab)) {
// For the prerender-in-new-tab, PreloadingAttempt will be managed by
// a prerender WebContents to be created later.
return registry_->CreateAndStartHostForNewTab(
attributes, creating_predictor, enacting_predictor, confidence);
}
// Handle the rule as kNoHint if the prerender-in-new-tab is not
// enabled.
[[fallthrough]];
}
case blink::mojom::SpeculationTargetHint::kNoHint:
case blink::mojom::SpeculationTargetHint::kSelf: {
if (base::FeatureList::IsEnabled(
features::kPrerender2FallbackPrefetchSpecRules)) {
auto* prefetch_document_manager =
content::PrefetchDocumentManager::GetOrCreateForCurrentDocument(
web_contents->GetPrimaryMainFrame());
prefetch_document_manager->PrefetchAheadOfPrerender(
attributes.preload_pipeline_info, candidate.Clone(),
enacting_predictor);
}
// Create new PreloadingAttempt and pass all the values corresponding to
// this prerendering attempt.
auto* preloading_data =
PreloadingDataImpl::GetOrCreateForWebContents(web_contents);
PreloadingURLMatchCallback same_url_matcher =
PreloadingData::GetSameURLMatcher(candidate->url);
auto* preloading_attempt = static_cast<PreloadingAttemptImpl*>(
preloading_data->AddPreloadingAttempt(
creating_predictor, enacting_predictor,
PreloadingType::kPrerender, std::move(same_url_matcher),
/*planned_max_preloading_type=*/PreloadingType::kPrerender,
web_contents->GetPrimaryMainFrame()->GetPageUkmSourceId()));
preloading_attempt->SetSpeculationEagerness(candidate->eagerness);
return registry_->CreateAndStartHost(attributes, preloading_attempt);
}
}
}();
// An existing prerender may be canceled to start a new prerender, and
// `started_prerenders_` may be modified through this cancellation. Therefore,
// it is needed to re-calculate the right place here on `started_prerenders_`
// for new candidates.
end = base::ranges::upper_bound(started_prerenders_.begin(),
started_prerenders_.end(), candidate->url,
std::less<>(), &PrerenderInfo::url);
started_prerenders_.insert(end, {.injection_type = candidate->injection_type,
.eagerness = candidate->eagerness,
.prerender_host_id = prerender_host_id,
.url = candidate->url});
return true;
}
bool PrerendererImpl::ShouldWaitForPrerenderResult(const GURL& url) {
auto [begin, end] = base::ranges::equal_range(
started_prerenders_.begin(), started_prerenders_.end(), url,
std::less<>(), &PrerenderInfo::url);
for (auto it = begin; it != end; ++it) {
if (it->prerender_host_id.is_null()) {
return false;
}
}
return begin != end;
}
void PrerendererImpl::OnCancel(FrameTreeNodeId host_frame_tree_node_id,
const PrerenderCancellationReason& reason) {
switch (reason.final_status()) {
// TODO(crbug.com/40275452): Support other final status cases.
case PrerenderFinalStatus::kTimeoutBackgrounded:
case PrerenderFinalStatus::kMaxNumOfRunningNonEagerPrerendersExceeded:
case PrerenderFinalStatus::kSpeculationRuleRemoved: {
auto erasing_prerender_it = std::find_if(
started_prerenders_.begin(), started_prerenders_.end(),
[&](const PrerenderInfo& prerender_info) {
return prerender_info.prerender_host_id == host_frame_tree_node_id;
});
if (erasing_prerender_it != started_prerenders_.end()) {
auto url = erasing_prerender_it->url;
started_prerenders_.erase(erasing_prerender_it);
// Notify PreloadingDecider.
prerender_cancellation_callback_.Run(url);
}
break;
}
default:
break;
}
}
void PrerendererImpl::OnRegistryDestroyed() {
observation_.Reset();
}
void PrerendererImpl::SetPrerenderCancellationCallback(
PrerenderCancellationCallback callback) {
prerender_cancellation_callback_ = std::move(callback);
}
void PrerendererImpl::CancelStartedPrerenders() {
if (registry_) {
std::vector<FrameTreeNodeId> started_prerender_ids;
for (auto& prerender_info : started_prerenders_) {
started_prerender_ids.push_back(prerender_info.prerender_host_id);
}
registry_->CancelHosts(
started_prerender_ids,
PrerenderCancellationReason(PrerenderFinalStatus::kTriggerDestroyed));
}
started_prerenders_.clear();
}
void PrerendererImpl::CancelStartedPrerendersForTesting() {
CancelStartedPrerenders();
}
void PrerendererImpl::ResetReceivedPrerendersCountForMetrics() {
for (auto trigger_type :
{PreloadingTriggerType::kSpeculationRule,
PreloadingTriggerType::kSpeculationRuleFromIsolatedWorld}) {
received_prerenders_by_eagerness_[trigger_type].fill({});
}
}
void PrerendererImpl::IncrementReceivedPrerendersCountForMetrics(
PreloadingTriggerType trigger_type,
blink::mojom::SpeculationEagerness eagerness) {
received_prerenders_by_eagerness_[trigger_type]
[static_cast<size_t>(eagerness)]++;
}
void PrerendererImpl::RecordReceivedPrerendersCountToMetrics() {
for (auto trigger_type :
{PreloadingTriggerType::kSpeculationRule,
PreloadingTriggerType::kSpeculationRuleFromIsolatedWorld}) {
int conservative =
received_prerenders_by_eagerness_[trigger_type][static_cast<size_t>(
blink::mojom::SpeculationEagerness::kConservative)];
int moderate =
received_prerenders_by_eagerness_[trigger_type][static_cast<size_t>(
blink::mojom::SpeculationEagerness::kModerate)];
int eager =
received_prerenders_by_eagerness_[trigger_type][static_cast<size_t>(
blink::mojom::SpeculationEagerness::kEager)];
// This will record zero when
// 1) there are no started prerenders eventually. Also noted that if
// there is no rule set, PreloadingDecider won't be created (which means
// PrerenderImpl also won't be created), so it cannot be reached this
// code path at the first place.
// 2) when the corresponding RFH lives but is inactive (such as the case in
// BFCache) after once PrimaryPageChanged was called and the recorded
// number was reset (As long as PreloadingDecider (which has the same
// lifetime with a document) that owns this (PrerenderImpl) lives, this
// function will be called per PrimaryPageChanged).
//
// Avoids recording these cases uniformly.
if (conservative + moderate + eager == 0) {
continue;
}
// Record per single eagerness.
RecordReceivedPrerendersPerPrimaryPageChangedCount(
conservative, trigger_type, "Conservative");
RecordReceivedPrerendersPerPrimaryPageChangedCount(moderate, trigger_type,
"Moderate");
RecordReceivedPrerendersPerPrimaryPageChangedCount(eager, trigger_type,
"Eager");
// Record per eager or non-eager(eager case has already been recorded
// above).
RecordReceivedPrerendersPerPrimaryPageChangedCount(
conservative + moderate, trigger_type, "NonEager");
// Record the total number of prerenders.
RecordReceivedPrerendersPerPrimaryPageChangedCount(
conservative + moderate + eager, trigger_type, "Total");
}
}
} // namespace content