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
|
// Copyright 2015 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "chrome/browser/ui/search_engines/search_engine_tab_helper.h"
#include <utility>
#include "base/functional/bind.h"
#include "base/memory/raw_ptr.h"
#include "base/run_loop.h"
#include "base/strings/stringprintf.h"
#include "chrome/browser/profiles/profile.h"
#include "chrome/browser/search_engines/template_url_service_factory.h"
#include "chrome/browser/ui/browser.h"
#include "chrome/browser/ui/tabs/tab_enums.h"
#include "chrome/browser/ui/tabs/tab_strip_model.h"
#include "chrome/test/base/in_process_browser_test.h"
#include "chrome/test/base/ui_test_utils.h"
#include "components/search_engines/template_url.h"
#include "components/search_engines/template_url_service.h"
#include "content/public/browser/navigation_handle.h"
#include "content/public/browser/web_contents.h"
#include "content/public/test/browser_test.h"
#include "content/public/test/browser_test_utils.h"
#include "content/public/test/prerender_test_util.h"
#include "content/public/test/test_navigation_observer.h"
#include "net/dns/mock_host_resolver.h"
#include "net/test/embedded_test_server/embedded_test_server.h"
#include "net/test/embedded_test_server/http_request.h"
#include "net/test/embedded_test_server/http_response.h"
using net::test_server::BasicHttpResponse;
using net::test_server::HttpRequest;
using net::test_server::HttpResponse;
namespace {
std::unique_ptr<HttpResponse> HandleRequest(const std::string& match_path,
const std::string& osdd_xml_url,
const HttpRequest& request) {
if (!match_path.empty() && request.GetURL().path() != match_path) {
return nullptr;
}
std::string html = base::StringPrintf(
"<html>"
"<head>"
" <link rel='search' type='application/opensearchdescription+xml'"
" href='%s'"
" title='ExampleSearch'>"
"</head>"
"</html>",
osdd_xml_url.c_str());
std::unique_ptr<BasicHttpResponse> http_response(new BasicHttpResponse());
http_response->set_code(net::HTTP_OK);
http_response->set_content(html);
http_response->set_content_type("text/html");
return std::move(http_response);
}
class TemplateURLServiceObserver {
public:
TemplateURLServiceObserver(TemplateURLService* service, base::RunLoop* loop)
: runner_(loop) {
DCHECK(loop);
template_url_subscription_ =
service->RegisterOnLoadedCallback(base::BindOnce(
&TemplateURLServiceObserver::StopLoop, base::Unretained(this)));
service->Load();
}
TemplateURLServiceObserver(const TemplateURLServiceObserver&) = delete;
TemplateURLServiceObserver& operator=(const TemplateURLServiceObserver&) =
delete;
~TemplateURLServiceObserver() = default;
private:
void StopLoop() { runner_->Quit(); }
raw_ptr<base::RunLoop> runner_;
base::CallbackListSubscription template_url_subscription_;
};
testing::AssertionResult VerifyTemplateURLServiceLoad(
TemplateURLService* service) {
if (service->loaded()) {
return testing::AssertionSuccess();
}
base::RunLoop runner;
TemplateURLServiceObserver observer(service, &runner);
runner.Run();
if (service->loaded()) {
return testing::AssertionSuccess();
}
return testing::AssertionFailure() << "TemplateURLService isn't loaded";
}
} // namespace
class SearchEngineTabHelperBrowserTest : public InProcessBrowserTest {
public:
SearchEngineTabHelperBrowserTest() = default;
SearchEngineTabHelperBrowserTest(const SearchEngineTabHelperBrowserTest&) =
delete;
SearchEngineTabHelperBrowserTest& operator=(
const SearchEngineTabHelperBrowserTest&) = delete;
~SearchEngineTabHelperBrowserTest() override = default;
private:
// Starts a test server that serves a page pointing to a opensearch descriptor
// from a file:// url.
bool StartTestServer() {
GURL file_url = ui_test_utils::GetTestUrl(
base::FilePath(),
base::FilePath().AppendASCII("simple_open_search.xml"));
embedded_test_server()->RegisterRequestHandler(
base::BindRepeating(&HandleRequest, std::string(), file_url.spec()));
return embedded_test_server()->Start();
}
void SetUpOnMainThread() override { ASSERT_TRUE(StartTestServer()); }
};
IN_PROC_BROWSER_TEST_F(SearchEngineTabHelperBrowserTest,
IgnoreSearchDescriptionsFromFileURLs) {
TemplateURLService* url_service =
TemplateURLServiceFactory::GetForProfile(browser()->profile());
ASSERT_TRUE(url_service);
EXPECT_TRUE(VerifyTemplateURLServiceLoad(url_service));
TemplateURLService::TemplateURLVector template_urls =
url_service->GetTemplateURLs();
// Navigate to a page with a search descriptor. Path doesn't matter as the
// test server always serves the same HTML.
GURL url(embedded_test_server()->GetURL("/"));
ASSERT_TRUE(ui_test_utils::NavigateToURL(browser(), url));
// No new search engines should be added.
EXPECT_EQ(template_urls, url_service->GetTemplateURLs());
}
class TestSearchEngineTabHelper : public SearchEngineTabHelper {
public:
static void CreateForWebContents(content::WebContents* contents) {
if (FromWebContents(contents)) {
return;
}
contents->SetUserData(
UserDataKey(), std::make_unique<TestSearchEngineTabHelper>(contents));
}
explicit TestSearchEngineTabHelper(content::WebContents* web_contents)
: SearchEngineTabHelper(web_contents) {}
~TestSearchEngineTabHelper() override = default;
std::u16string GenerateKeywordFromNavigationEntry(
content::NavigationEntry* entry) override {
std::u16string keyword =
SearchEngineTabHelper::GenerateKeywordFromNavigationEntry(entry);
if (!keyword.empty()) {
return keyword;
}
const std::u16string kTestKeyword(u"TestKeyword");
return kTestKeyword;
}
};
class SearchEngineTabHelperPrerenderingBrowserTest
: public InProcessBrowserTest,
public testing::WithParamInterface<std::string> {
public:
SearchEngineTabHelperPrerenderingBrowserTest()
: osdd_seeding_path_("/"),
osdd_path_("/osdd/keyword.xml"),
prerender_helper_(base::BindRepeating(
&SearchEngineTabHelperPrerenderingBrowserTest::GetWebContents,
base::Unretained(this))) {}
~SearchEngineTabHelperPrerenderingBrowserTest() override = default;
void SetUp() override {
prerender_helper_.RegisterServerRequestMonitor(embedded_test_server());
InProcessBrowserTest::SetUp();
}
void SetUpOnMainThread() override {
// Note that the URL's path length should not be larger than 1.
// See SearchEngineTabHelper::GenerateKeywordFromNavigationEntry().
embedded_test_server()->RegisterRequestHandler(
base::BindRepeating(&HandleRequest, osdd_seeding_path_, osdd_path_));
ASSERT_TRUE(test_server_handle_ =
embedded_test_server()->StartAndReturnHandle());
}
content::WebContents* GetWebContents() {
return browser()->tab_strip_model()->GetActiveWebContents();
}
content::test::PrerenderTestHelper* prerender_helper() {
return &prerender_helper_;
}
const std::string& osdd_seeding_path() { return osdd_seeding_path_; }
const std::string& osdd_path() { return osdd_path_; }
// Adds a tab with TestSearchEngineTabHelper which is a customized
// SearchEngineTabHelper.
void GetNewTabWithTestSearchEngineTabHelper() {
content::WebContents* preexisting_tab =
browser()->tab_strip_model()->GetActiveWebContents();
std::unique_ptr<content::WebContents> owned_web_contents =
content::WebContents::Create(
content::WebContents::CreateParams(browser()->profile()));
ASSERT_TRUE(owned_web_contents.get());
TestSearchEngineTabHelper::CreateForWebContents(owned_web_contents.get());
ASSERT_FALSE(owned_web_contents.get()->IsLoading());
browser()->tab_strip_model()->AppendWebContents(
std::move(owned_web_contents), true);
if (preexisting_tab) {
browser()->tab_strip_model()->CloseWebContentsAt(
0, TabCloseTypes::CLOSE_NONE);
}
}
protected:
const std::string& GetTargetHint() { return GetParam(); }
private:
const std::string osdd_seeding_path_;
const std::string osdd_path_;
content::test::PrerenderTestHelper prerender_helper_;
net::test_server::EmbeddedTestServerHandle test_server_handle_;
};
INSTANTIATE_TEST_SUITE_P(All,
SearchEngineTabHelperPrerenderingBrowserTest,
testing::Values("_self", "_blank"),
[](const testing::TestParamInfo<std::string>& info) {
return info.param;
});
IN_PROC_BROWSER_TEST_P(SearchEngineTabHelperPrerenderingBrowserTest,
GenerateKeywordInPrerendering) {
GetNewTabWithTestSearchEngineTabHelper();
TemplateURLService* url_service =
TemplateURLServiceFactory::GetForProfile(browser()->profile());
ASSERT_TRUE(url_service);
EXPECT_TRUE(VerifyTemplateURLServiceLoad(url_service));
TemplateURLService::TemplateURLVector template_urls =
url_service->GetTemplateURLs();
GURL url = embedded_test_server()->GetURL("/empty.html");
ASSERT_TRUE(ui_test_utils::NavigateToURL(browser(), url));
// Loads a page in the prerender.
auto prerender_url = embedded_test_server()->GetURL("/form_search.html");
content::FrameTreeNodeId host_id = prerender_helper()->AddPrerender(
prerender_url, /*eagerness=*/std::nullopt, GetTargetHint());
auto* prerender_web_contents =
content::WebContents::FromFrameTreeNodeId(host_id);
content::test::PrerenderHostObserver host_observer(*prerender_web_contents,
host_id);
content::RenderFrameHost* render_frame_host =
content::test::PrerenderTestHelper::GetPrerenderedMainFrameHost(
*prerender_web_contents, host_id);
EXPECT_EQ(nullptr, content::EvalJs(render_frame_host, "submit_form();"));
// Since navigation from a prerendering page is disallowed, prerendering is
// canceled.
host_observer.WaitForDestroyed();
// TemplateURLVector's not changed with the prerendering.
EXPECT_EQ(template_urls, url_service->GetTemplateURLs());
// Navigates the primary page to the URL.
prerender_helper()->NavigatePrimaryPage(prerender_url);
// Makes sure that the page is not from the prerendering.
EXPECT_FALSE(host_observer.was_activated());
// Submits a search query.
content::TestNavigationObserver observer(GetWebContents());
EXPECT_EQ(nullptr, content::EvalJs(GetWebContents()->GetPrimaryMainFrame(),
"submit_form();"));
observer.Wait();
// A new template url is added on the primary page.
EXPECT_NE(template_urls, url_service->GetTemplateURLs());
}
IN_PROC_BROWSER_TEST_P(SearchEngineTabHelperPrerenderingBrowserTest,
DeferOSDDRegistrationInPrerendering) {
// Navigate to a prerendering initiator page.
GURL url = embedded_test_server()->GetURL("/empty.html");
ASSERT_TRUE(ui_test_utils::NavigateToURL(browser(), url));
// Prerender a page that contains a opensearch descriptor.
auto prerender_url = embedded_test_server()->GetURL(osdd_seeding_path());
content::FrameTreeNodeId host_id = prerender_helper()->AddPrerender(
prerender_url, /*eagerness=*/std::nullopt, GetTargetHint());
auto* prerender_web_contents =
content::WebContents::FromFrameTreeNodeId(host_id);
content::test::PrerenderHostObserver host_observer(*prerender_web_contents,
host_id);
// No request for the osdd url was made.
// Note: We may want to wait a certain event here to ensure there are no
// registrations under goting. Otherwise, this may pass even if the request
// isn't deferred.
auto osdd_url = embedded_test_server()->GetURL(osdd_path());
EXPECT_EQ(0, prerender_helper()->GetRequestCount(osdd_url));
// Activate the prerendered page.
if (GetTargetHint() == "_blank") {
content::test::PrerenderTestHelper::OpenNewWindowWithoutOpener(
*GetWebContents(), prerender_url);
} else {
prerender_helper()->NavigatePrimaryPage(prerender_url);
}
host_observer.WaitForActivation();
// Makes sure that the page is from the prerendering.
EXPECT_TRUE(host_observer.was_activated());
// A request for the osdd url was made after the activation.
prerender_helper()->WaitForRequest(osdd_url, 1);
}
|
