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
|
// 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_URL_LOADER_INTERCEPTOR_H_
#define CONTENT_BROWSER_PRELOADING_PREFETCH_PREFETCH_URL_LOADER_INTERCEPTOR_H_
#include <memory>
#include <optional>
#include "base/memory/weak_ptr.h"
#include "base/sequence_checker.h"
#include "content/browser/loader/navigation_loader_interceptor.h"
#include "content/browser/preloading/prefetch/prefetch_container.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 "services/network/public/cpp/resource_request.h"
namespace content {
class BrowserContext;
class PrefetchContainer;
class ServiceWorkerMainResourceHandle;
using PrefetchCompleteCallbackForTesting =
base::RepeatingCallback<void(PrefetchContainer*)>;
// Intercepts navigations that can use prefetched resources.
class CONTENT_EXPORT PrefetchURLLoaderInterceptor final
: public NavigationLoaderInterceptor {
public:
PrefetchURLLoaderInterceptor(
PrefetchServiceWorkerState expected_service_worker_state,
base::WeakPtr<ServiceWorkerMainResourceHandle>
service_worker_handle_for_navigation,
FrameTreeNodeId frame_tree_node_id,
std::optional<blink::DocumentToken> initiator_document_token,
base::WeakPtr<PrefetchServingPageMetricsContainer>
serving_page_metrics_container);
~PrefetchURLLoaderInterceptor() override;
PrefetchURLLoaderInterceptor(const PrefetchURLLoaderInterceptor&) = delete;
PrefetchURLLoaderInterceptor& operator=(const PrefetchURLLoaderInterceptor&) =
delete;
// NavigationLoaderInterceptor
void MaybeCreateLoader(
const network::ResourceRequest& tentative_resource_request,
BrowserContext* browser_context,
NavigationLoaderInterceptor::LoaderCallback callback,
NavigationLoaderInterceptor::FallbackCallback fallback_callback) override;
// Sets a callback to be called on |OnGetPrefetchComplete| to inform whether
// the prefetch is served, used only for test purpose.
static void SetPrefetchCompleteCallbackForTesting(
PrefetchCompleteCallbackForTesting callback);
protected:
FrameTreeNodeId GetFrameTreeNodeId() const { return frame_tree_node_id_; }
private:
// Gets the `PrefetchContainer` (if any) to be used for
// `tentative_resource_request`. The `PrefetchContainer` is first obtained
// from `PrefetchService` and then goes through other checks in
// `PrefetchUrlLoaderHelper`.
// The |get_prefetch_callback| is called with this associated prefetch.
void GetPrefetch(const network::ResourceRequest& tentative_resource_request,
base::OnceCallback<void(PrefetchContainer::Reader)>
get_prefetch_callback) const;
void OnGetPrefetchComplete(
const network::ResourceRequest& tentative_resource_request,
PrefetchContainer::Reader reader);
// Matches prefetches only if its final PrefetchServiceWorkerState is
// `expected_service_worker_state_`, either `kControlled` or `kDisallowed`.
const PrefetchServiceWorkerState expected_service_worker_state_;
// `ServiceWorkerMainResourceHandle` used for the navigation to be intercepted
// (i.e. NOT the handle used for prefetch). This is used only for the
// `kControlled` case and can be null for `kDisallowed` case.
const base::WeakPtr<ServiceWorkerMainResourceHandle>
service_worker_handle_for_navigation_;
// The frame tree node |this| is associated with, used to retrieve
// |PrefetchService|.
const FrameTreeNodeId frame_tree_node_id_;
// Corresponds to the ID of "navigable's active document" used for "finding a
// matching prefetch record" in the spec. This is used as a part of
// `PrefetchContainer::Key` to make prefetches per-Document.
// https://wicg.github.io/nav-speculation/prefetch.html
const std::optional<blink::DocumentToken> initiator_document_token_;
// The `PrefetchServingPageMetricsContainer` associated with the current
// navigation and to be set to the selected `PrefetchContainer` if any.
base::WeakPtr<PrefetchServingPageMetricsContainer>
serving_page_metrics_container_;
// Called once |this| has decided whether to intercept or not intercept the
// navigation.
NavigationLoaderInterceptor::LoaderCallback loader_callback_;
// The prefetch container that has already been used to serve a redirect. If
// another request can be intercepted, this will be checked first to see if
// its next redirect hop matches the request URL.
PrefetchContainer::Reader redirect_reader_;
SEQUENCE_CHECKER(sequence_checker_);
base::WeakPtrFactory<PrefetchURLLoaderInterceptor> weak_factory_{this};
};
} // namespace content
#endif // CONTENT_BROWSER_PRELOADING_PREFETCH_PREFETCH_URL_LOADER_INTERCEPTOR_H_
|
