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
content / browser / preloading / prefetch / prefetch_service.h [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.
#ifndef CONTENT_BROWSER_PRELOADING_PREFETCH_PREFETCH_SERVICE_H_
#define CONTENT_BROWSER_PRELOADING_PREFETCH_PREFETCH_SERVICE_H_
#include <map>
#include <optional>
#include <string_view>
#include "base/dcheck_is_on.h"
#include "base/functional/callback_forward.h"
#include "base/memory/weak_ptr.h"
#include "content/browser/preloading/prefetch/no_vary_search_helper.h"
#include "content/browser/preloading/prefetch/prefetch_container.h"
#include "content/browser/preloading/prefetch/prefetch_params.h"
#include "content/browser/preloading/prefetch/prefetch_status.h"
#include "content/browser/preloading/prefetch/prefetch_streaming_url_loader_common_types.h"
#include "content/common/content_export.h"
#include "content/public/browser/frame_tree_node_id.h"
#include "content/public/browser/global_routing_id.h"
#include "content/public/browser/service_worker_context.h"
#include "net/cookies/canonical_cookie.h"
#include "net/url_request/redirect_info.h"
#include "services/network/public/mojom/url_response_head.mojom.h"
#include "url/gurl.h"
namespace network::mojom {
class NetworkContext;
class URLLoaderFactory;
} // namespace network::mojom
namespace content {
class BrowserContext;
class PrefetchMatchResolver;
class PrefetchOriginProber;
class PrefetchProxyConfigurator;
class PrefetchServiceDelegate;
class ServiceWorkerContext;
// These values are persisted to logs. Entries should not be renumbered and
// numeric values should never be reused.
enum class PrefetchRedirectResult {
kSuccessRedirectFollowed = 0,
kFailedNullPrefetch = 1,
// OBSOLETE: kFailedRedirectsDisabled = 2,
kFailedInvalidMethod = 3,
kFailedInvalidResponseCode = 4,
kFailedInvalidChangeInNetworkContext = 5,
kFailedIneligible = 6,
kFailedInsufficientReferrerPolicy = 7,
kMaxValue = kFailedInsufficientReferrerPolicy,
};
// These values are persisted to logs. Entries should not be renumbered and
// numeric values should never be reused.
enum class PrefetchRedirectNetworkContextTransition {
kDefaultToDefault = 0,
kDefaultToIsolated = 1,
kIsolatedToDefault = 2,
kIsolatedToIsolated = 3,
kMaxValue = kIsolatedToIsolated,
};
// Manages all prefetches within a single BrowserContext. Responsible for
// checking the eligibility of the prefetch, making the network request for the
// prefetch, and provide prefetched resources to URL loader interceptor when
// needed.
class CONTENT_EXPORT PrefetchService {
public:
static PrefetchService* GetFromFrameTreeNodeId(
FrameTreeNodeId frame_tree_node_id);
static void SetFromFrameTreeNodeIdForTesting(
FrameTreeNodeId frame_tree_node_id,
std::unique_ptr<PrefetchService> prefetch_service);
// |browser_context| must outlive this instance. In general this should always
// be true, since |PrefetchService| will be indirectly owned by
// |BrowserContext|.
explicit PrefetchService(BrowserContext* browser_context);
virtual ~PrefetchService();
PrefetchService(const PrefetchService&) = delete;
const PrefetchService& operator=(const PrefetchService&) = delete;
BrowserContext* GetBrowserContext() const { return browser_context_; }
PrefetchServiceDelegate* GetPrefetchServiceDelegate() const {
return delegate_.get();
}
void SetPrefetchServiceDelegateForTesting(
std::unique_ptr<PrefetchServiceDelegate> delegate);
PrefetchProxyConfigurator* GetPrefetchProxyConfigurator() const {
return prefetch_proxy_configurator_.get();
}
virtual PrefetchOriginProber* GetPrefetchOriginProber() const;
virtual void PrefetchUrl(base::WeakPtr<PrefetchContainer> prefetch_container);
// Finds the prefetch (if any) that can be used to serve a navigation to
// |url|, and then calls |on_prefetch_to_serve_ready| with that prefetch.
using OnPrefetchToServeReady =
base::OnceCallback<void(PrefetchContainer::Reader prefetch_to_serve)>;
void GetPrefetchToServe(const PrefetchContainer::Key& key,
base::WeakPtr<PrefetchServingPageMetricsContainer>
serving_page_metrics_container,
PrefetchMatchResolver& prefetch_match_resolver);
// Copies any cookies in the isolated network context associated with
// |prefetch_container| to the default network context.
virtual void CopyIsolatedCookies(const PrefetchContainer::Reader& reader);
// Add `PrefetchContainer` under control of `PrefetchService`.
//
// `AddPrefetchContainer()` synchronously destruct `prefetch_container` if the
// key conflicted to the one already added with migration of some attributes.
// See also `MigrateNewlyaAdded()`.
void AddPrefetchContainer(
std::unique_ptr<PrefetchContainer> prefetch_container);
void AddPrefetchContainerWithoutStartingPrefetchForTesting(
std::unique_ptr<PrefetchContainer> prefetch_container);
void ResetPrefetch(base::WeakPtr<PrefetchContainer> prefetch_container);
// Called by PrefetchDocumentManager when it finishes processing the latest
// update of speculation candidates.
void OnCandidatesUpdated();
// Helper functions to control the behavior of the eligibility check when
// testing.
static void SetServiceWorkerContextForTesting(ServiceWorkerContext* context);
static void SetHostNonUniqueFilterForTesting(
bool (*filter)(std::string_view));
// Sets the URLLoaderFactory to be used during testing instead of the
// |PrefetchNetworkContext| associated with each |PrefetchContainer|. Note
// that this does not take ownership of |url_loader_factory|, and caller must
// keep ownership over the course of the test.
static void SetURLLoaderFactoryForTesting(
network::mojom::URLLoaderFactory* url_loader_factory);
// Sets the NetworkContext to use just for the proxy lookup. Note that this
// does not take ownership of |network_context|, and the caller must keep
// ownership over the course of the test.
static void SetNetworkContextForProxyLookupForTesting(
network::mojom::NetworkContext* network_context);
// Set a callback for injecting delay for eligibility check in tests.
using DelayEligibilityCheckForTesting =
base::RepeatingCallback<void(base::OnceClosure)>;
static void SetDelayEligibilityCheckForTesting(
DelayEligibilityCheckForTesting callback);
// Set an ineligibility to make eligibility check always fail in tests.
static void SetForceIneligibilityForTesting(PreloadingEligibility);
// Set a callback for waiting for prefetch completion in tests.
using PrefetchResponseCompletedCallbackForTesting =
base::RepeatingCallback<void(base::WeakPtr<PrefetchContainer>)>;
static void SetPrefetchResponseCompletedCallbackForTesting(
PrefetchResponseCompletedCallbackForTesting callback);
base::WeakPtr<PrefetchContainer> MatchUrl(
const PrefetchContainer::Key& key) const;
std::vector<std::pair<GURL, base::WeakPtr<PrefetchContainer>>>
GetAllForUrlWithoutRefAndQueryForTesting(
const PrefetchContainer::Key& key) const;
// Returns candidate `PrefetchContainer`s and servable states for matching
// process. Corresponds to 3.4. of
// https://wicg.github.io/nav-speculation/prefetch.html#wait-for-a-matching-prefetch-record
//
// Note that `PrefetchContainer::GetServableState()` depends on
// `base::TimeTicks::now()` and can expire (can change from `kServable` to
// `kNotServable`) in the minute between two calls. Deciding something with
// multiple `PrefetchContainer::GetServableState()` calls can lead
// inconsistent state. To avoid that, we record `ServableState` in the
// `flat_map` at the beginning of matching process and refer to it.
std::pair<
std::vector<PrefetchContainer*>,
base::flat_map<PrefetchContainer::Key, PrefetchContainer::ServableState>>
CollectMatchCandidates(const PrefetchContainer::Key& key,
bool is_nav_prerender,
base::WeakPtr<PrefetchServingPageMetricsContainer>
serving_page_metrics_container);
base::WeakPtr<PrefetchService> GetWeakPtr();
private:
friend class PrefetchURLLoaderInterceptorTestBase;
// Checks whether the given |prefetch_container| is eligible for prefetch.
// Once the eligibility is determined then |OnGotEligibility()| will be
// called.
void CheckEligibilityOfPrefetch(
base::WeakPtr<PrefetchContainer> prefetch_container,
const GURL& url,
std::optional<
std::pair<net::RedirectInfo, network::mojom::URLResponseHeadPtr>>
redirect_data);
void CheckHasServiceWorker(
base::WeakPtr<PrefetchContainer> prefetch_container,
const GURL& url,
std::optional<
std::pair<net::RedirectInfo, network::mojom::URLResponseHeadPtr>>
redirect_data);
void OnGotServiceWorkerResult(
base::WeakPtr<PrefetchContainer> prefetch_container,
const GURL& url,
std::optional<
std::pair<net::RedirectInfo, network::mojom::URLResponseHeadPtr>>
redirect_data,
base::Time check_has_service_worker_start_time,
ServiceWorkerCapability service_worker_capability);
// Called after getting the existing cookies associated with
// |prefetch_container|. If there are any cookies, then the prefetch is not
// eligible.
void OnGotCookiesForEligibilityCheck(
base::WeakPtr<PrefetchContainer> prefetch_container,
const GURL& url,
std::optional<
std::pair<net::RedirectInfo, network::mojom::URLResponseHeadPtr>>
redirect_data,
const net::CookieAccessResultList& cookie_list,
const net::CookieAccessResultList& excluded_cookies);
// Starts the check for whether or not there is a proxy configured for the URL
// of |prefetch_container|. If there is an existing proxy, then the prefetch
// is not eligible.
void StartProxyLookupCheck(
base::WeakPtr<PrefetchContainer> prefetch_container,
const GURL& url,
std::optional<
std::pair<net::RedirectInfo, network::mojom::URLResponseHeadPtr>>
redirect_data);
// Called after looking up the proxy configuration for the URL of
// |prefetch_container|. If there is an existing proxy, then the prefetch is
// not eligible.
void OnGotProxyLookupResult(
base::WeakPtr<PrefetchContainer> prefetch_container,
std::optional<
std::pair<net::RedirectInfo, network::mojom::URLResponseHeadPtr>>
redirect_data,
bool has_proxy);
// Called when the eligibility is determined for each fetch of prefetch, i.e.
// initial fetch and redirects.
//
// If ineligible, these methods may convert the prefetch into decoy.
//
// If the initial fetch (respectively, the redirect) is eligible or the
// prefetch is decoy, the prefetch is added to `prefetch_queue_`
// (respectively, is retained in the queue) and proceeds to the next fetch.
void OnGotEligibility(
base::WeakPtr<PrefetchContainer> prefetch_container,
std::optional<
std::pair<net::RedirectInfo, network::mojom::URLResponseHeadPtr>>
redirect_data,
PreloadingEligibility eligibility);
void OnGotEligibilityForNonRedirect(
base::WeakPtr<PrefetchContainer> prefetch_container,
PreloadingEligibility eligibility);
void OnGotEligibilityForRedirect(
base::WeakPtr<PrefetchContainer> prefetch_container,
net::RedirectInfo redirect_info,
network::mojom::URLResponseHeadPtr redirect_head,
PreloadingEligibility eligibility);
// Adds `prefetch_container` to the cache but doesn't initiate prefetching.
// Use `AddPrefetchContainer()` for non-test cases.
void AddPrefetchContainerWithoutStartingPrefetch(
std::unique_ptr<PrefetchContainer> prefetch_container);
// Starts the network requests for as many prefetches in |prefetch_queue_| as
// possible.
void Prefetch();
// Pops the first valid prefetch (determined by PrefetchDocumentManager) from
// |prefetch_queue_|. Returns a tuple containing the popped prefetch and
// (optionally) an already completed prefetch that needs to be evicted to make
// space for the new prefetch. If there are no valid prefetches in the queue,
// then (nullptr, nullptr) is returned.
std::tuple<base::WeakPtr<PrefetchContainer>, base::WeakPtr<PrefetchContainer>>
PopNextPrefetchContainer();
// After |PrefetchContainerLifetimeInPrefetchService| amount of time, the
// prefetch is deleted. Note that if
// |PrefetchContainerLifetimeInPrefetchService| is 0 or less, then it is kept
// forever.
void OnPrefetchTimeout(base::WeakPtr<PrefetchContainer> prefetch);
// Starts the given |prefetch_container|. If |prefetch_to_evict| is specified,
// it is evicted immediately before starting |prefetch_container|.
void StartSinglePrefetch(base::WeakPtr<PrefetchContainer> prefetch_container,
base::WeakPtr<PrefetchContainer> prefetch_to_evict);
// Creates a new URL loader and starts a network request for
// |prefetch_container|. |MakePrefetchRequest| must have been previously
// called.
void SendPrefetchRequest(base::WeakPtr<PrefetchContainer> prefetch_container);
// Gets the URL loader for the given |prefetch_container|. If an override was
// set by |SetURLLoaderFactoryForTesting|, then that will be returned instead.
network::mojom::URLLoaderFactory* GetURLLoaderFactoryForCurrentPrefetch(
base::WeakPtr<PrefetchContainer> prefetch_container);
// Called when the request for |prefetch_container| is redirected.
void OnPrefetchRedirect(base::WeakPtr<PrefetchContainer> prefetch_container,
const net::RedirectInfo& redirect_info,
network::mojom::URLResponseHeadPtr redirect_head);
// Called when the response for |prefetch_container| has started. Based on
// |head|, returns a status to inform the |PrefetchStreamingURLLoader| whether
// the prefetch is servable. If servable, then `std::nullopt` will be
// returned, otherwise a failure status is returned.
std::optional<PrefetchErrorOnResponseReceived> OnPrefetchResponseStarted(
base::WeakPtr<PrefetchContainer> prefetch_container,
network::mojom::URLResponseHead* head);
// Called when the response for |prefetch_container| has completed when using
// the streaming URL loader.
void OnPrefetchResponseCompleted(
base::WeakPtr<PrefetchContainer> prefetch_container,
const network::URLLoaderCompletionStatus& completion_status);
// Called when the cookies from |prefetch_conatiner| are read from the
// isolated network context and are ready to be written to the default network
// context.
void OnGotIsolatedCookiesForCopy(
PrefetchContainer::Reader reader,
const net::CookieAccessResultList& cookie_list,
const net::CookieAccessResultList& excluded_cookies);
enum class HandlePrefetchContainerResult {
// No prefetch was available to be used.
kNotAvailable,
// There was a prefetch available but it is not usable.
kNotUsable,
// The prefetch will be served.
kToBeServed,
// The prefetch cannot be served because Cookies have changed.
kNotToBeServedCookiesChanged,
// The prefetch's head has not yet been received.
kWaitForHead
};
using FallbackToRegularNavigationWhenPrefetchNotUsable = base::StrongAlias<
class FallbackToRegularNavigationWhenPrefetchNotUsableTag,
bool>;
// Helper function for |GetPrefetchToServe| to return |prefetch_container| via
// |on_prefetch_to_serve_ready| callback in |prefetch_match_resolver|. Starts
// the cookie copy process for the given prefetch if needed, and updates its
// state.
HandlePrefetchContainerResult ReturnPrefetchToServe(
const PrefetchContainer::Key& key,
const GURL& prefetch_url,
PrefetchContainer::Reader reader,
PrefetchMatchResolver& prefetch_match_resolver,
FallbackToRegularNavigationWhenPrefetchNotUsable
when_prefetch_not_used_fallback_to_regular_navigation =
FallbackToRegularNavigationWhenPrefetchNotUsable(true));
// Callback for non-blocking call `PrefetchContainer::StartBlockUntilHead()`.
// Waits non-redirect response header for No-Vary-Search to determine a
// potentially matching prefetch is a matching prefetch. Corresponds 3.6 in
// https://wicg.github.io/nav-speculation/prefetch.html#wait-for-a-matching-prefetch-record
//
// Once we make the decision to use a prefetch, call |PrepareToServe| and
// |GetPrefetchToServe| again in order to enforce that prefetches that are
// served are served from |prefetches_ready_to_serve_|.
void OnMaybeDeterminedHead(
const PrefetchContainer::Key& key,
base::WeakPtr<PrefetchMatchResolver> prefetch_match_resolver,
PrefetchContainer& prefetch_container);
// Helper function for |GetPrefetchToServe| which handles a
// |prefetch_container| that could potentially be served to the navigation.
HandlePrefetchContainerResult HandlePrefetchContainerToServe(
const PrefetchContainer::Key& key,
PrefetchContainer& prefetch_container,
PrefetchMatchResolver& prefetch_match_resolver);
// Checks if there is a prefetch in |owned_prefetches_| with the same URL as
// |prefetch_container| but from a different referring RenderFrameHost.
// Records the result to a UMA histogram.
void RecordExistingPrefetchWithMatchingURL(
base::WeakPtr<PrefetchContainer> prefetch_container) const;
void DumpPrefetchesForDebug() const;
raw_ptr<BrowserContext> browser_context_;
// Delegate provided by embedder that controls specific behavior of |this|.
// May be nullptr if embedder doesn't provide a delegate.
std::unique_ptr<PrefetchServiceDelegate> delegate_;
// The custom proxy configurator for Prefetch Proxy. Only used on prefetches
// that require the proxy.
std::unique_ptr<PrefetchProxyConfigurator> prefetch_proxy_configurator_;
// The origin prober class which manages all logic for origin probing.
std::unique_ptr<PrefetchOriginProber> origin_prober_;
// A FIFO queue of prefetches that have been confirmed to be eligible but have
// not started yet.
std::vector<base::WeakPtr<PrefetchContainer>> prefetch_queue_;
// Current prefetch with an in-progress request (if any).
std::optional<PrefetchContainer::Key> active_prefetch_;
// Prefetches owned by |this|. Once the network request for a prefetch is
// started, |this| takes ownership of the prefetch so the response can be used
// on future page loads.
std::map<PrefetchContainer::Key, std::unique_ptr<PrefetchContainer>>
owned_prefetches_;
// Protects against Prefetch() being called recursively.
#if DCHECK_IS_ON()
bool prefetch_reentrancy_guard_ = false;
#endif
SEQUENCE_CHECKER(sequence_checker_);
base::WeakPtrFactory<PrefetchService> weak_method_factory_{this};
};
} // namespace content
#endif // CONTENT_BROWSER_PRELOADING_PREFETCH_PREFETCH_SERVICE_H_