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
|
// 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.
#include <string>
#include "chrome/browser/preloading/chrome_preloading.h"
#include "chrome/browser/preloading/prerender/prerender_manager.h"
#include "chrome/browser/preloading/prerender/prerender_utils.h"
#include "chrome/browser/search_engines/template_url_service_factory_test_util.h"
#include "chrome/test/base/chrome_render_view_host_test_harness.h"
#include "components/search_engines/template_url_service.h"
#include "content/public/browser/render_frame_host.h"
#include "content/public/browser/web_contents.h"
#include "content/public/test/preloading_test_util.h"
#include "content/public/test/prerender_test_util.h"
#include "content/public/test/web_contents_tester.h"
#include "net/test/embedded_test_server/embedded_test_server.h"
#include "testing/gtest/include/gtest/gtest.h"
namespace {
class PrerenderManagerTest : public ChromeRenderViewHostTestHarness {
public:
PrerenderManagerTest(const PrerenderManagerTest&) = delete;
PrerenderManagerTest& operator=(const PrerenderManagerTest&) = delete;
PrerenderManagerTest()
: ChromeRenderViewHostTestHarness(
content::BrowserTaskEnvironment::REAL_IO_THREAD),
prerender_helper_(
base::BindRepeating(&PrerenderManagerTest::GetActiveWebContents,
base::Unretained(this))) {}
void SetUp() override {
prerender_helper_.RegisterServerRequestMonitor(&test_server_);
ASSERT_TRUE(test_server_.Start());
ChromeRenderViewHostTestHarness::SetUp();
// Set up TemplateURLService for search prerendering.
TemplateURLServiceFactoryTestUtil factory_util(profile());
factory_util.VerifyLoad();
TemplateURLData template_url_data;
template_url_data.SetURL(GetUrl(search_site() + "?q={searchTerms}").spec());
factory_util.model()->SetUserSelectedDefaultSearchProvider(
factory_util.model()->Add(
std::make_unique<TemplateURL>(template_url_data)));
PrerenderManager::CreateForWebContents(GetActiveWebContents());
prerender_manager_ = PrerenderManager::FromWebContents(web_contents());
ASSERT_TRUE(prerender_manager_);
web_contents_delegate_ =
std::make_unique<content::test::ScopedPrerenderWebContentsDelegate>(
*web_contents());
}
content::WebContents* GetActiveWebContents() { return web_contents(); }
GURL GetSearchSuggestionUrl(const std::string& original_query,
const std::string& search_terms) {
return GetUrl(search_site() + "?q=" + search_terms +
"&oq=" + original_query);
}
GURL GetCanonicalSearchUrl(const GURL& search_suggestion_url) {
GURL canonical_search_url;
EXPECT_TRUE(HasCanonicalPreloadingOmniboxSearchURL(
search_suggestion_url, profile(), &canonical_search_url));
return canonical_search_url;
}
content::WebContentsTester* web_contents_tester() {
return content::WebContentsTester::For(web_contents());
}
protected:
GURL GetUrl(const std::string& path) { return test_server_.GetURL(path); }
PrerenderManager* prerender_manager() { return prerender_manager_; }
content::test::PrerenderTestHelper& prerender_helper() {
return prerender_helper_;
}
content::PreloadingFailureReason ToPreloadingFailureReason(
PrerenderPredictionStatus status) {
return static_cast<content::PreloadingFailureReason>(
static_cast<int>(status) +
static_cast<int>(content::PreloadingFailureReason::
kPreloadingFailureReasonContentEnd));
}
content::PreloadingAttempt* TriggerDirectUrlInputPrerender(
const GURL& prerendering_url) {
auto* preloading_data = content::PreloadingData::GetOrCreateForWebContents(
GetActiveWebContents());
content::PreloadingURLMatchCallback same_url_matcher =
content::PreloadingData::GetSameURLMatcher(prerendering_url);
content::PreloadingAttempt* preloading_attempt =
preloading_data->AddPreloadingAttempt(
chrome_preloading_predictor::kOmniboxDirectURLInput,
content::PreloadingType::kPrerender, same_url_matcher,
GetActiveWebContents()
->GetPrimaryMainFrame()
->GetPageUkmSourceId());
prerender_manager()->StartPrerenderDirectUrlInput(prerendering_url,
*preloading_attempt);
return preloading_attempt;
}
private:
static std::string search_site() { return "/title1.html"; }
content::test::PrerenderTestHelper prerender_helper_;
std::unique_ptr<content::test::ScopedPrerenderWebContentsDelegate>
web_contents_delegate_;
net::EmbeddedTestServer test_server_;
raw_ptr<PrerenderManager, DanglingUntriaged> prerender_manager_;
};
TEST_F(PrerenderManagerTest, StartCleanSearchSuggestionPrerender) {
GURL prerendering_url = GetSearchSuggestionUrl("pre", "prerender");
GURL canonical_url = GetCanonicalSearchUrl(prerendering_url);
content::test::PrerenderHostRegistryObserver registry_observer(
*GetActiveWebContents());
prerender_manager()->StartPrerenderSearchResult(
canonical_url, prerendering_url, /*attempt=*/nullptr);
registry_observer.WaitForTrigger(prerendering_url);
content::FrameTreeNodeId prerender_host_id =
prerender_helper().GetHostForUrl(prerendering_url);
EXPECT_TRUE(prerender_host_id);
}
// Tests that the old prerender will be destroyed when starting prerendering a
// different search result.
TEST_F(PrerenderManagerTest, StartNewSuggestionPrerender) {
GURL prerendering_url1 = GetSearchSuggestionUrl("pre", "prefetch");
GURL canonical_url1 = GetCanonicalSearchUrl(prerendering_url1);
content::test::PrerenderHostRegistryObserver registry_observer(
*GetActiveWebContents());
prerender_manager()->StartPrerenderSearchResult(
canonical_url1, prerendering_url1, /*attempt=*/nullptr);
registry_observer.WaitForTrigger(prerendering_url1);
content::FrameTreeNodeId prerender_host_id1 =
prerender_helper().GetHostForUrl(prerendering_url1);
ASSERT_TRUE(prerender_host_id1);
content::test::PrerenderHostObserver host_observer(*GetActiveWebContents(),
prerender_host_id1);
GURL prerendering_url2 = GetSearchSuggestionUrl("prer", "prerender");
GURL canonical_url2 = GetCanonicalSearchUrl(prerendering_url2);
prerender_manager()->StartPrerenderSearchResult(
canonical_url2, prerendering_url2, /*attempt=*/nullptr);
host_observer.WaitForDestroyed();
registry_observer.WaitForTrigger(prerendering_url2);
EXPECT_TRUE(prerender_manager()->HasSearchResultPagePrerendered());
EXPECT_EQ(canonical_url2,
prerender_manager()->GetPrerenderCanonicalSearchURLForTesting());
}
// Tests that the old prerender is not destroyed when starting prerendering the
// same search suggestion.
TEST_F(PrerenderManagerTest, StartSameSuggestionPrerender) {
GURL prerendering_url1 = GetSearchSuggestionUrl("pre", "prerender");
GURL canonical_url = GetCanonicalSearchUrl(prerendering_url1);
content::test::PrerenderHostRegistryObserver registry_observer(
*GetActiveWebContents());
prerender_manager()->StartPrerenderSearchResult(
canonical_url, prerendering_url1, /*attempt=*/nullptr);
registry_observer.WaitForTrigger(prerendering_url1);
content::FrameTreeNodeId prerender_host_id1 =
prerender_helper().GetHostForUrl(prerendering_url1);
EXPECT_TRUE(prerender_host_id1);
GURL prerendering_url2 = GetSearchSuggestionUrl("prer", "prerender");
prerender_manager()->StartPrerenderSearchResult(
canonical_url, prerendering_url2, /*attempt=*/nullptr);
EXPECT_TRUE(prerender_manager()->HasSearchResultPagePrerendered());
// The created prerender for `prerendering_url1` still exists, so the
// prerender_host_id should be the same.
content::FrameTreeNodeId prerender_host_id2 =
prerender_helper().GetHostForUrl(prerendering_url2);
EXPECT_EQ(prerender_host_id2, prerender_host_id1);
}
TEST_F(PrerenderManagerTest, StartCleanPrerenderDirectUrlInput) {
GURL prerendering_url = GetUrl("/foo");
content::test::PrerenderHostRegistryObserver registry_observer(
*GetActiveWebContents());
TriggerDirectUrlInputPrerender(prerendering_url);
registry_observer.WaitForTrigger(prerendering_url);
content::FrameTreeNodeId prerender_host_id =
prerender_helper().GetHostForUrl(prerendering_url);
EXPECT_TRUE(prerender_host_id);
}
// Test that the PreloadingTriggeringOutcome is set to kFailure when the DUI
// predictor suggests a different URL.
TEST_F(PrerenderManagerTest, StartNewPrerenderDirectUrlInput) {
GURL prerendering_url = GetUrl("/foo");
content::test::PrerenderHostRegistryObserver registry_observer(
*GetActiveWebContents());
content::PreloadingAttempt* preloading_attempt =
TriggerDirectUrlInputPrerender(prerendering_url);
registry_observer.WaitForTrigger(prerendering_url);
content::FrameTreeNodeId prerender_host_id =
prerender_helper().GetHostForUrl(prerendering_url);
EXPECT_TRUE(prerender_host_id);
content::test::PrerenderHostObserver host_observer(*GetActiveWebContents(),
prerender_host_id);
GURL prerendering_url2 = GetUrl("/bar");
TriggerDirectUrlInputPrerender(prerendering_url2);
host_observer.WaitForDestroyed();
registry_observer.WaitForTrigger(prerendering_url2);
EXPECT_EQ(ToPreloadingFailureReason(PrerenderPredictionStatus::kCancelled),
content::test::PreloadingAttemptAccessor(preloading_attempt)
.GetFailureReason());
}
// TODO(https://crbug.com/334988071): Add all embedder triggers and make it
// mandatory when adding new triggers to PrerenderManager.
enum TriggerType {
kDirectUrlInput = 0,
kSearchSuggestion = 1,
};
class PrerenderManagerBasicRequirementTest
: public testing::WithParamInterface<TriggerType>,
public PrerenderManagerTest {
public:
static std::string DescribeParams(
const testing::TestParamInfo<ParamType>& info) {
switch (info.param) {
case kDirectUrlInput:
return "DirectUrlInput";
case kSearchSuggestion:
return "SearchSuggestion";
}
}
content::FrameTreeNodeId StartPrerender() {
content::test::PrerenderHostRegistryObserver registry_observer(
*GetActiveWebContents());
GURL prerendering_url;
switch (GetParam()) {
case kDirectUrlInput:
prerendering_url = GetUrl("/foo");
TriggerDirectUrlInputPrerender(prerendering_url);
break;
case kSearchSuggestion:
prerendering_url = GetSearchSuggestionUrl("pre", "prerender");
GURL canonical_url = GetCanonicalSearchUrl(prerendering_url);
prerender_manager()->StartPrerenderSearchResult(
canonical_url, prerendering_url, /*attempt=*/nullptr);
break;
}
registry_observer.WaitForTrigger(prerendering_url);
return prerender_helper().GetHostForUrl(prerendering_url);
}
std::string GetMetricSuffix() {
switch (GetParam()) {
case kDirectUrlInput:
return prerender_utils::kDirectUrlInputMetricSuffix;
case kSearchSuggestion:
return prerender_utils::kDefaultSearchEngineMetricSuffix;
}
NOTREACHED();
}
// Navigates to another page that cannot be prerendered.
void NavigateAway() {
web_contents_tester()->NavigateAndCommit(GetUrl("/empty.html"));
}
};
INSTANTIATE_TEST_SUITE_P(
/* no prefix */,
PrerenderManagerBasicRequirementTest,
testing::Values(TriggerType::kDirectUrlInput,
TriggerType::kSearchSuggestion),
PrerenderManagerBasicRequirementTest::DescribeParams);
// Tests that the PrerenderHandle is destroyed when the primary page changed.
TEST_P(PrerenderManagerBasicRequirementTest, NavigateAway) {
base::HistogramTester histogram_tester;
content::FrameTreeNodeId prerender_host_id = StartPrerender();
ASSERT_TRUE(prerender_host_id);
content::test::PrerenderHostObserver host_observer(*GetActiveWebContents(),
prerender_host_id);
NavigateAway();
host_observer.WaitForDestroyed();
histogram_tester.ExpectUniqueSample(
"Prerender.Experimental.PrerenderHostFinalStatus.Embedder_" +
GetMetricSuffix(),
/*kTriggerDestroyed*/ 16, 1);
switch (GetParam()) {
case kSearchSuggestion:
EXPECT_FALSE(prerender_manager()->HasSearchResultPagePrerendered());
break;
default:
return;
}
}
// Test that a Searched related url is ignored by the prerender BookmarkBar
// trigger.
TEST_F(PrerenderManagerTest, DisallowSearchUrlBookmarkBar) {
base::HistogramTester histogram_tester;
GURL prerendering_url = GetSearchSuggestionUrl("prer", "prerender");
ASSERT_FALSE(prerender_manager()->StartPrerenderBookmark(prerendering_url));
histogram_tester.ExpectUniqueSample(
"Prerender.IsPrerenderingSRPUrl.Embedder_BookmarkBar", true, 1);
}
// Test that a Searched related url is ignored by the prerender NewTabPage
// trigger.
TEST_F(PrerenderManagerTest, DisallowSearchUrlNewTabPage) {
base::HistogramTester histogram_tester;
GURL prerendering_url = GetSearchSuggestionUrl("prer", "prerender");
ASSERT_FALSE(prerender_manager()->StartPrerenderNewTabPage(
prerendering_url, chrome_preloading_predictor::kTouchOnNewTabPage));
histogram_tester.ExpectUniqueSample(
"Prerender.IsPrerenderingSRPUrl.Embedder_NewTabPage", true, 1);
}
} // namespace
|