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
content / browser / preloading / speculation_rules / speculation_host_impl_unittest.cc [blame]
// Copyright 2021 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/speculation_rules/speculation_host_impl.h"
#include "base/memory/raw_ptr.h"
#include "base/test/bind.h"
#include "base/test/scoped_feature_list.h"
#include "base/unguessable_token.h"
#include "content/browser/preloading/preloading_decider.h"
#include "content/browser/preloading/prerender/prerender_host_registry.h"
#include "content/public/browser/web_contents_delegate.h"
#include "content/public/common/content_client.h"
#include "content/public/test/prerender_test_util.h"
#include "content/public/test/test_browser_context.h"
#include "content/public/test/test_renderer_host.h"
#include "content/public/test/test_utils.h"
#include "content/test/test_content_browser_client.h"
#include "content/test/test_render_view_host.h"
#include "content/test/test_web_contents.h"
#include "mojo/public/cpp/system/functions.h"
#include "testing/gmock/include/gmock/gmock.h"
#include "third_party/blink/public/common/features.h"
#include "third_party/blink/public/mojom/speculation_rules/speculation_rules.mojom.h"
using testing::_;
using testing::Exactly;
using testing::StrictMock;
namespace content {
namespace {
class SpeculationHostImplTest : public RenderViewHostImplTestHarness {
public:
SpeculationHostImplTest() = default;
void SetUp() override {
RenderViewHostImplTestHarness::SetUp();
browser_context_ = std::make_unique<TestBrowserContext>();
web_contents_ = TestWebContents::Create(
browser_context_.get(),
SiteInstanceImpl::Create(browser_context_.get()));
web_contents_delegate_ =
std::make_unique<test::ScopedPrerenderWebContentsDelegate>(
*web_contents_);
web_contents_->NavigateAndCommit(GURL("https://example.com"));
}
void TearDown() override {
web_contents_.reset();
browser_context_.reset();
mojo::SetDefaultProcessErrorHandler(base::NullCallback());
RenderViewHostImplTestHarness::TearDown();
}
RenderFrameHostImpl* GetRenderFrameHost() {
return web_contents_->GetPrimaryMainFrame();
}
GURL GetSameOriginUrl(const std::string& path) {
return GURL("https://example.com" + path);
}
GURL GetCrossSiteUrl(const std::string& path) {
return GURL("https://example2.com" + path);
}
PrerenderHostRegistry* GetPrerenderHostRegistry() const {
return web_contents_->GetPrerenderHostRegistry();
}
blink::mojom::SpeculationCandidatePtr CreatePrerenderCandidate(
const GURL& url) {
auto candidate = blink::mojom::SpeculationCandidate::New();
candidate->action = blink::mojom::SpeculationAction::kPrerender;
candidate->url = url;
candidate->referrer = blink::mojom::Referrer::New();
return candidate;
}
private:
test::ScopedPrerenderFeatureList prerender_feature_list_;
std::unique_ptr<TestBrowserContext> browser_context_;
std::unique_ptr<TestWebContents> web_contents_;
std::unique_ptr<test::ScopedPrerenderWebContentsDelegate>
web_contents_delegate_;
};
class ScopedPreloadingDeciderObserver
: public PreloadingDeciderObserverForTesting {
public:
explicit ScopedPreloadingDeciderObserver(RenderFrameHostImpl* rfh)
: rfh_(rfh) {
auto* preloading_decider =
PreloadingDecider::GetOrCreateForCurrentDocument(rfh_);
old_observer_ = preloading_decider->SetObserverForTesting(this);
}
~ScopedPreloadingDeciderObserver() override {
auto* preloading_decider =
PreloadingDecider::GetOrCreateForCurrentDocument(rfh_);
EXPECT_EQ(this, preloading_decider->SetObserverForTesting(old_observer_));
}
void UpdateSpeculationCandidates(
const std::vector<blink::mojom::SpeculationCandidatePtr>& candidates)
override {
for (const auto& candidate : candidates) {
candidates_.push_back(candidate.Clone());
}
}
void OnPointerDown(const GURL& url) override {}
void OnPointerHover(const GURL& url) override {}
std::vector<blink::mojom::SpeculationCandidatePtr> candidates_;
private:
raw_ptr<RenderFrameHostImpl> rfh_;
raw_ptr<PreloadingDeciderObserverForTesting> old_observer_;
};
// Tests that SpeculationHostImpl dispatches the candidates to
// PreloadingDecider.
TEST_F(SpeculationHostImplTest, StartPrerender) {
ScopedPreloadingDeciderObserver observer(GetRenderFrameHost());
RenderFrameHostImpl* render_frame_host = GetRenderFrameHost();
mojo::Remote<blink::mojom::SpeculationHost> remote;
SpeculationHostImpl::Bind(render_frame_host,
remote.BindNewPipeAndPassReceiver());
const GURL kPrerenderingUrl = GetSameOriginUrl("/empty.html");
std::vector<blink::mojom::SpeculationCandidatePtr> candidates;
candidates.push_back(CreatePrerenderCandidate(kPrerenderingUrl));
remote->UpdateSpeculationCandidates(std::move(candidates));
remote.FlushForTesting();
EXPECT_EQ(1u, observer.candidates_.size());
EXPECT_EQ(kPrerenderingUrl, observer.candidates_[0]->url);
}
// Tests that SpeculationHostImpl crashes the renderer process if it receives
// non-http prerender candidates.
TEST_F(SpeculationHostImplTest, ReportNonHttpMessage) {
RenderFrameHostImpl* render_frame_host = GetRenderFrameHost();
PrerenderHostRegistry* registry = GetPrerenderHostRegistry();
mojo::Remote<blink::mojom::SpeculationHost> remote;
SpeculationHostImpl::Bind(render_frame_host,
remote.BindNewPipeAndPassReceiver());
// Set up the error handler for bad mojo messages.
std::string bad_message_error;
mojo::SetDefaultProcessErrorHandler(
base::BindLambdaForTesting([&](const std::string& error) {
EXPECT_FALSE(error.empty());
EXPECT_TRUE(bad_message_error.empty());
bad_message_error = error;
}));
std::vector<blink::mojom::SpeculationCandidatePtr> candidates;
const GURL kPrerenderingUrl = GURL("blob:https://bar");
candidates.push_back(CreatePrerenderCandidate(kPrerenderingUrl));
remote->UpdateSpeculationCandidates(std::move(candidates));
remote.FlushForTesting();
EXPECT_EQ(bad_message_error, "SH_NON_HTTP");
EXPECT_FALSE(registry->FindHostByUrlForTesting(kPrerenderingUrl));
}
// Tests that SpeculationHostImpl crashes the renderer process if it receives
// prefetch candidates that have a valid `target_browsing_context_name_hint`.
TEST_F(SpeculationHostImplTest,
ReportTargetBrowsingContextNameHintOnPrefetchCandidate) {
RenderFrameHostImpl* render_frame_host = GetRenderFrameHost();
mojo::Remote<blink::mojom::SpeculationHost> remote;
SpeculationHostImpl::Bind(render_frame_host,
remote.BindNewPipeAndPassReceiver());
// Set up the error handler for bad mojo messages.
std::string bad_message_error;
mojo::SetDefaultProcessErrorHandler(
base::BindLambdaForTesting([&](const std::string& error) {
EXPECT_FALSE(error.empty());
EXPECT_TRUE(bad_message_error.empty());
bad_message_error = error;
}));
// Create a prefetch candidate that has a valid target hint.
auto candidate = blink::mojom::SpeculationCandidate::New();
candidate->action = blink::mojom::SpeculationAction::kPrefetch;
candidate->url = GetSameOriginUrl("/empty.html");
candidate->referrer = blink::mojom::Referrer::New();
candidate->target_browsing_context_name_hint =
blink::mojom::SpeculationTargetHint::kBlank;
std::vector<blink::mojom::SpeculationCandidatePtr> candidates;
candidates.push_back(std::move(candidate));
remote->UpdateSpeculationCandidates(std::move(candidates));
remote.FlushForTesting();
EXPECT_EQ(bad_message_error, "SH_TARGET_HINT_ON_PREFETCH");
}
// Tests that SpeculationHostImpl crashes the renderer process if it receives
// non-prefetch candidates requiring "anonymous-client-ip-when-cross-origin".
TEST_F(SpeculationHostImplTest,
ReportInvalidRequiresAnonymousClientIpWhenCrossOrigin) {
RenderFrameHostImpl* render_frame_host = GetRenderFrameHost();
mojo::Remote<blink::mojom::SpeculationHost> remote;
SpeculationHostImpl::Bind(render_frame_host,
remote.BindNewPipeAndPassReceiver());
// Set up the error handler for bad mojo messages.
std::string bad_message_error;
mojo::SetDefaultProcessErrorHandler(
base::BindLambdaForTesting([&](const std::string& error) {
EXPECT_FALSE(error.empty());
EXPECT_TRUE(bad_message_error.empty());
bad_message_error = error;
}));
auto candidate =
CreatePrerenderCandidate(GetSameOriginUrl("/same-origin.html"));
candidate->requires_anonymous_client_ip_when_cross_origin = true;
std::vector<blink::mojom::SpeculationCandidatePtr> candidates;
candidates.push_back(std::move(candidate));
remote->UpdateSpeculationCandidates(std::move(candidates));
remote.FlushForTesting();
EXPECT_EQ("SH_INVALID_REQUIRES_ANONYMOUS_CLIENT_IP_WHEN_CROSS_ORIGIN",
bad_message_error);
}
class TestSpeculationHostDelegate : public SpeculationHostDelegate {
public:
TestSpeculationHostDelegate() = default;
~TestSpeculationHostDelegate() override = default;
// Disallows copy and move operations.
TestSpeculationHostDelegate(const TestSpeculationHostDelegate&) = delete;
TestSpeculationHostDelegate& operator=(const TestSpeculationHostDelegate&) =
delete;
// SpeculationRulesDelegate implementation.
void ProcessCandidates(
std::vector<blink::mojom::SpeculationCandidatePtr>& candidates) override {
candidates.clear();
}
};
class ScopedSpeculationHostImplContentBrowserClient
: public TestContentBrowserClient {
public:
ScopedSpeculationHostImplContentBrowserClient() {
old_browser_client_ = SetBrowserClientForTesting(this);
}
~ScopedSpeculationHostImplContentBrowserClient() override {
EXPECT_EQ(this, SetBrowserClientForTesting(old_browser_client_));
}
// ContentBrowserClient implementation.
std::unique_ptr<SpeculationHostDelegate> CreateSpeculationHostDelegate(
RenderFrameHost& render_frame_host) override {
return std::make_unique<TestSpeculationHostDelegate>();
}
private:
raw_ptr<ContentBrowserClient> old_browser_client_;
};
// Tests that SpeculationHostDelegate can take the process candidates away and
// SpeculationHostImpl cannot handle the processed ones.
TEST_F(SpeculationHostImplTest, AllCandidatesProcessedByDelegate) {
ScopedSpeculationHostImplContentBrowserClient test_browser_client;
RenderFrameHostImpl* render_frame_host = GetRenderFrameHost();
PrerenderHostRegistry* registry = GetPrerenderHostRegistry();
mojo::Remote<blink::mojom::SpeculationHost> remote;
SpeculationHostImpl::Bind(render_frame_host,
remote.BindNewPipeAndPassReceiver());
const GURL kPrerenderingUrl = GetSameOriginUrl("/empty.html");
std::vector<blink::mojom::SpeculationCandidatePtr> candidates;
candidates.push_back(CreatePrerenderCandidate(kPrerenderingUrl));
remote->UpdateSpeculationCandidates(std::move(candidates));
remote.FlushForTesting();
// Since SpeculationHostDelegate has removed all candidates,
// SpeculationHostImpl cannot start prerendering for the prerender candidate.
EXPECT_FALSE(registry->FindHostByUrlForTesting(kPrerenderingUrl));
}
class SpeculationHostImplLinkPreviewTest : public SpeculationHostImplTest {
public:
SpeculationHostImplLinkPreviewTest() {
feature_list_.InitAndEnableFeature(blink::features::kLinkPreview);
}
~SpeculationHostImplLinkPreviewTest() override = default;
private:
base::test::ScopedFeatureList feature_list_;
};
TEST_F(SpeculationHostImplLinkPreviewTest, BasicLinkPreview) {
ScopedSpeculationHostImplContentBrowserClient test_browser_client;
// Get the RenderFrameHost.
RenderFrameHostImpl* render_frame_host = GetRenderFrameHost();
mojo::Remote<blink::mojom::SpeculationHost> remote;
SpeculationHostImpl::Bind(render_frame_host,
remote.BindNewPipeAndPassReceiver());
StrictMock<test::MockLinkPreviewWebContentsDelegate> delegate;
WebContents::FromRenderFrameHost(render_frame_host)->SetDelegate(&delegate);
const GURL preview_url = GetSameOriginUrl("/empty.html");
// Expect the delegate to receive one `InitiatePreview` call for
// `preview_url`.
EXPECT_CALL(delegate, InitiatePreview(_, preview_url)).Times(Exactly(1));
remote->InitiatePreview(preview_url);
remote.FlushForTesting();
}
// Verify link preview works in fenced frame.
TEST_F(SpeculationHostImplLinkPreviewTest, FencedFrameLinkPreview) {
ScopedSpeculationHostImplContentBrowserClient test_browser_client;
// Add a fenced frame RenderFrameHost.
TestRenderFrameHost* fenced_frame_rfh =
static_cast<TestRenderFrameHost*>(GetRenderFrameHost())
->AppendFencedFrame();
mojo::Remote<blink::mojom::SpeculationHost> remote;
SpeculationHostImpl::Bind(fenced_frame_rfh,
remote.BindNewPipeAndPassReceiver());
StrictMock<test::MockLinkPreviewWebContentsDelegate> delegate;
WebContents::FromRenderFrameHost(fenced_frame_rfh)->SetDelegate(&delegate);
const GURL preview_url = GetSameOriginUrl("/empty.html");
// Expect the delegate to receive one `InitiatePreview` call for
// `preview_url`.
EXPECT_CALL(delegate, InitiatePreview(_, preview_url)).Times(Exactly(1));
remote->InitiatePreview(preview_url);
remote.FlushForTesting();
}
// Verify link preview is disabled after fenced frame disables untrusted network
// access.
TEST_F(SpeculationHostImplLinkPreviewTest,
FencedFrameNetworkCutoffDisablesLinkPreview) {
ScopedSpeculationHostImplContentBrowserClient test_browser_client;
// Add a fenced frame RenderFrameHost.
TestRenderFrameHost* fenced_frame_rfh =
static_cast<TestRenderFrameHost*>(GetRenderFrameHost())
->AppendFencedFrame();
mojo::Remote<blink::mojom::SpeculationHost> remote;
SpeculationHostImpl::Bind(fenced_frame_rfh,
remote.BindNewPipeAndPassReceiver());
// Disable fenced frame's network.
fenced_frame_rfh->frame_tree_node()
->GetFencedFrameProperties(
FencedFramePropertiesNodeSource::kFrameTreeRoot)
->MarkDisabledNetworkForCurrentAndDescendantFrameTrees();
StrictMock<test::MockLinkPreviewWebContentsDelegate> delegate;
WebContents::FromRenderFrameHost(fenced_frame_rfh)->SetDelegate(&delegate);
// Expect the delegate not to receive `InitiatePreview` call.
const GURL preview_url = GetSameOriginUrl("/empty.html");
EXPECT_CALL(delegate, InitiatePreview(_, preview_url)).Times(Exactly(0));
remote->InitiatePreview(preview_url);
remote.FlushForTesting();
}
} // namespace
} // namespace content