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 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925
|
// Copyright 2018 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/predictors/loading_predictor_tab_helper.h"
#include "base/memory/raw_ptr.h"
#include "base/run_loop.h"
#include "base/test/gmock_callback_support.h"
#include "base/test/metrics/histogram_tester.h"
#include "base/test/run_until.h"
#include "base/test/scoped_feature_list.h"
#include "chrome/browser/optimization_guide/mock_optimization_guide_keyed_service.h"
#include "chrome/browser/optimization_guide/optimization_guide_keyed_service.h"
#include "chrome/browser/optimization_guide/optimization_guide_keyed_service_factory.h"
#include "chrome/browser/predictors/loading_predictor.h"
#include "chrome/browser/predictors/loading_test_util.h"
#include "chrome/browser/predictors/predictors_enums.h"
#include "chrome/browser/predictors/predictors_features.h"
#include "chrome/browser/sessions/session_tab_helper_factory.h"
#include "chrome/test/base/chrome_render_view_host_test_harness.h"
#include "chrome/test/base/testing_profile.h"
#include "components/optimization_guide/core/optimization_guide_features.h"
#include "components/sessions/content/session_tab_helper.h"
#include "components/variations/scoped_variations_ids_provider.h"
#include "content/public/browser/navigation_handle.h"
#include "content/public/test/navigation_simulator.h"
#include "net/base/network_anonymization_key.h"
#include "services/network/public/mojom/fetch_api.mojom.h"
#include "testing/gtest/include/gtest/gtest.h"
#include "third_party/blink/public/common/features.h"
#include "third_party/blink/public/mojom/loader/resource_load_info.mojom.h"
using ::testing::_;
using ::testing::An;
using ::testing::ByRef;
using ::testing::DoAll;
using ::testing::Eq;
using ::testing::Invoke;
using ::testing::Mock;
using ::testing::NiceMock;
using ::testing::Return;
using ::testing::SaveArg;
using ::testing::StrictMock;
using ::testing::WithArg;
namespace predictors {
class MockLoadingDataCollector : public LoadingDataCollector {
public:
explicit MockLoadingDataCollector(const LoadingPredictorConfig& config);
MOCK_METHOD4(RecordStartNavigation,
void(NavigationId, ukm::SourceId, const GURL&, base::TimeTicks));
MOCK_METHOD3(RecordFinishNavigation, void(NavigationId, const GURL&, bool));
MOCK_METHOD2(RecordResourceLoadComplete,
void(NavigationId, const blink::mojom::ResourceLoadInfo&));
MOCK_METHOD1(RecordMainFrameLoadComplete, void(NavigationId));
MOCK_METHOD2(RecordPageDestroyed,
void(NavigationId,
const std::optional<OptimizationGuidePrediction>&));
};
MockLoadingDataCollector::MockLoadingDataCollector(
const LoadingPredictorConfig& config)
: LoadingDataCollector(nullptr, nullptr, config) {}
class LoadingPredictorTabHelperTest : public ChromeRenderViewHostTestHarness,
public testing::WithParamInterface<bool> {
public:
LoadingPredictorTabHelperTest() {
if (GetParam()) {
scoped_feature_list_.InitAndEnableFeature(
blink::features::kLCPPPrefetchSubresourceAsync);
}
}
void SetUp() override;
void TearDown() override;
SessionID GetTabID();
void NavigateAndCommitInFrame(const std::string& url,
content::RenderFrameHost* rfh);
void NavigateAndCommitInMainFrameAndVerifyMetrics(const std::string& url);
protected:
std::unique_ptr<LoadingPredictor> loading_predictor_;
// Owned by |loading_predictor_|.
raw_ptr<StrictMock<MockLoadingDataCollector>> mock_collector_;
// Owned elsewhere.
raw_ptr<NiceMock<MockOptimizationGuideKeyedService>, DanglingUntriaged>
mock_optimization_guide_keyed_service_;
// Owned by |web_contents()|.
raw_ptr<LoadingPredictorTabHelper, DanglingUntriaged> tab_helper_;
base::test::ScopedFeatureList scoped_feature_list_;
};
void LoadingPredictorTabHelperTest::SetUp() {
ChromeRenderViewHostTestHarness::SetUp();
CreateSessionServiceTabHelper(web_contents());
mock_optimization_guide_keyed_service_ =
static_cast<NiceMock<MockOptimizationGuideKeyedService>*>(
OptimizationGuideKeyedServiceFactory::GetInstance()
->SetTestingFactoryAndUse(
profile(),
base::BindRepeating([](content::BrowserContext* context)
-> std::unique_ptr<KeyedService> {
return std::make_unique<
NiceMock<MockOptimizationGuideKeyedService>>();
})));
LoadingPredictorTabHelper::CreateForWebContents(web_contents());
tab_helper_ = LoadingPredictorTabHelper::FromWebContents(web_contents());
LoadingPredictorConfig config;
PopulateTestConfig(&config);
loading_predictor_ = std::make_unique<LoadingPredictor>(config, profile());
auto mock_collector =
std::make_unique<StrictMock<MockLoadingDataCollector>>(config);
mock_collector_ = mock_collector.get();
// RecordPageDestroyed will be called at the end of all tests when a page
// is destroyed, so we add a default catch-all expectation here. Tests can
// override this with more specific expectations inside the test.
EXPECT_CALL(*mock_collector_, RecordPageDestroyed)
.Times(testing::AnyNumber());
loading_predictor_->set_mock_loading_data_collector(
std::move(mock_collector));
tab_helper_->SetLoadingPredictorForTesting(loading_predictor_->GetWeakPtr());
}
void LoadingPredictorTabHelperTest::TearDown() {
loading_predictor_->Shutdown();
ChromeRenderViewHostTestHarness::TearDown();
}
void LoadingPredictorTabHelperTest::
NavigateAndCommitInMainFrameAndVerifyMetrics(const std::string& url) {
ukm::SourceId ukm_source_id;
GURL main_frame_url;
GURL new_main_frame_url;
EXPECT_CALL(*mock_collector_, RecordStartNavigation(_, _, _, _))
.WillOnce(DoAll(SaveArg<1>(&ukm_source_id), SaveArg<2>(&main_frame_url)));
EXPECT_CALL(*mock_collector_,
RecordFinishNavigation(_, _,
/* is_error_page */ false))
.WillOnce(DoAll(SaveArg<1>(&new_main_frame_url)));
NavigateAndCommitInFrame(url, main_rfh());
EXPECT_EQ(ukm_source_id,
web_contents()->GetPrimaryMainFrame()->GetPageUkmSourceId());
GURL gurl(url);
EXPECT_EQ(gurl, main_frame_url);
EXPECT_EQ(gurl, new_main_frame_url);
}
SessionID LoadingPredictorTabHelperTest::GetTabID() {
return sessions::SessionTabHelper::IdForTab(web_contents());
}
void LoadingPredictorTabHelperTest::NavigateAndCommitInFrame(
const std::string& url,
content::RenderFrameHost* rfh) {
auto navigation =
content::NavigationSimulator::CreateRendererInitiated(GURL(url), rfh);
// These tests simulate loading events manually.
// TODO(crbug.com/40276923): Consider refactoring to rely on load
// events dispatched by NavigationSimulator.
navigation->SetKeepLoading(true);
navigation->Start();
EXPECT_TRUE(base::test::RunUntil(
[&]() { return tab_helper_->IsPrepareForPageloadCalledForTesting(); }));
navigation->Commit();
}
// Tests that a main frame navigation is correctly recorded by the
// LoadingDataCollector.
TEST_P(LoadingPredictorTabHelperTest, MainFrameNavigation) {
NavigateAndCommitInMainFrameAndVerifyMetrics("http://test.org");
}
// Tests that an old and new navigation ids are correctly set if a navigation
// has redirects.
TEST_P(LoadingPredictorTabHelperTest, MainFrameNavigationWithRedirects) {
GURL main_frame_url("http://test.org");
auto navigation = content::NavigationSimulator::CreateRendererInitiated(
main_frame_url, main_rfh());
// The problem here is that mock_collector_ is a strict mock, which expects
// a particular set of loading events and fails when extra is present.
// TOOO(https://crbug.com/1467792): Consider refactoring this to rely on
// loading events in NavigationSimulator.
navigation->SetKeepLoading(true);
ukm::SourceId ukm_source_id;
EXPECT_CALL(*mock_collector_, RecordStartNavigation(_, _, main_frame_url, _))
.WillOnce(SaveArg<1>(&ukm_source_id));
navigation->Start();
base::RunLoop().RunUntilIdle();
navigation->Redirect(GURL("http://test2.org"));
base::RunLoop().RunUntilIdle();
navigation->Redirect(GURL("http://test3.org"));
GURL expected_main_frame_url("http://test3.org");
EXPECT_CALL(*mock_collector_,
RecordFinishNavigation(_, expected_main_frame_url, _));
navigation->Commit();
EXPECT_EQ(web_contents()->GetPrimaryMainFrame()->GetPageUkmSourceId(),
ukm_source_id);
}
// Tests that a subframe navigation is not recorded.
TEST_P(LoadingPredictorTabHelperTest, SubframeNavigation) {
// We need to have a committed main frame navigation before navigating in sub
// frames.
NavigateAndCommitInMainFrameAndVerifyMetrics("http://test.org");
auto* subframe =
content::RenderFrameHostTester::For(main_rfh())->AppendChild("subframe");
// Subframe navigation shouldn't be recorded.
NavigateAndCommitInFrame("http://sub.test.org", subframe);
}
// Tests that a failed navigation is correctly recorded.
TEST_P(LoadingPredictorTabHelperTest, MainFrameNavigationFailed) {
GURL url("http://test.org");
auto navigation =
content::NavigationSimulator::CreateRendererInitiated(url, main_rfh());
navigation->SetKeepLoading(true);
// The problem here is that mock_collector_ is a strict mock, which expects
// a particular set of loading events and fails when extra is present.
// TOOO(https://crbug.com/1467792): Consider refactoring this to rely on
// loading events in NavigationSimulator.
ukm::SourceId ukm_source_id;
EXPECT_CALL(*mock_collector_, RecordStartNavigation(_, _, url, _))
.WillOnce(SaveArg<1>(&ukm_source_id));
navigation->Start();
EXPECT_CALL(*mock_collector_,
RecordFinishNavigation(_, url,
/* is_error_page */ true));
navigation->Fail(net::ERR_TIMED_OUT);
navigation->CommitErrorPage();
EXPECT_EQ(ukm_source_id,
web_contents()->GetPrimaryMainFrame()->GetPageUkmSourceId());
}
// Tests that a same document navigation is not recorded.
TEST_P(LoadingPredictorTabHelperTest, MainFrameNavigationSameDocument) {
NavigateAndCommitInMainFrameAndVerifyMetrics("http://test.org");
// Same document navigation shouldn't be recorded.
content::NavigationSimulator::CreateRendererInitiated(GURL("http://test.org"),
main_rfh())
->CommitSameDocument();
}
// Tests that document on load completed is recorded with correct navigation
// id.
TEST_P(LoadingPredictorTabHelperTest, DocumentOnLoadCompleted) {
NavigateAndCommitInMainFrameAndVerifyMetrics("http://test.org");
// Adding subframe navigation to ensure that the committed main frame url will
// be used.
auto* subframe =
content::RenderFrameHostTester::For(main_rfh())->AppendChild("subframe");
NavigateAndCommitInFrame("http://sub.test.org", subframe);
EXPECT_CALL(*mock_collector_, RecordMainFrameLoadComplete(_));
tab_helper_->DocumentOnLoadCompletedInPrimaryMainFrame();
}
// Tests that a resource load is correctly recorded.
TEST_P(LoadingPredictorTabHelperTest, ResourceLoadComplete) {
NavigateAndCommitInMainFrameAndVerifyMetrics("http://test.org");
auto resource_load_info = CreateResourceLoadInfo(
"http://test.org/script.js", network::mojom::RequestDestination::kScript);
EXPECT_CALL(*mock_collector_,
RecordResourceLoadComplete(_, Eq(ByRef(*resource_load_info))));
tab_helper_->ResourceLoadComplete(main_rfh(), content::GlobalRequestID(),
*resource_load_info);
}
// Tests that a resource loaded in a subframe is not recorded.
TEST_P(LoadingPredictorTabHelperTest, ResourceLoadCompleteInSubFrame) {
NavigateAndCommitInMainFrameAndVerifyMetrics("http://test.org");
auto* subframe =
content::RenderFrameHostTester::For(main_rfh())->AppendChild("subframe");
NavigateAndCommitInFrame("http://sub.test.org", subframe);
// Resource loaded in subframe shouldn't be recorded.
auto resource_load_info =
CreateResourceLoadInfo("http://sub.test.org/script.js",
network::mojom::RequestDestination::kScript,
/*always_access_network=*/false);
tab_helper_->ResourceLoadComplete(subframe, content::GlobalRequestID(),
*resource_load_info);
}
// Tests that a resource load from the memory cache is correctly recorded.
TEST_P(LoadingPredictorTabHelperTest, LoadResourceFromMemoryCache) {
NavigateAndCommitInMainFrameAndVerifyMetrics("http://test.org");
auto resource_load_info = CreateResourceLoadInfo(
"http://test.org/script.js", network::mojom::RequestDestination::kScript,
false);
resource_load_info->mime_type = "application/javascript";
resource_load_info->network_info->network_accessed = false;
EXPECT_CALL(*mock_collector_,
RecordResourceLoadComplete(_, Eq(ByRef(*resource_load_info))));
tab_helper_->DidLoadResourceFromMemoryCache(
main_rfh(), GURL("http://test.org/script.js"), "application/javascript",
network::mojom::RequestDestination::kScript);
}
INSTANTIATE_TEST_SUITE_P(LCPPPrefetchSubresourceAsyncFlag,
LoadingPredictorTabHelperTest,
testing::Bool());
class LoadingPredictorTabHelperOptimizationGuideDeciderTest
: public LoadingPredictorTabHelperTest {
public:
LoadingPredictorTabHelperOptimizationGuideDeciderTest() {
scoped_feature_list_.InitWithFeatures(
{features::kLoadingPredictorUseOptimizationGuide,
// Need to add otherwise GetForProfile() returns null.
optimization_guide::features::kOptimizationHints},
{
// Disabling prefetch here to test preconnect passthrough. Prefetch
// is tested in following test class.
features::kLoadingPredictorPrefetch,
// Disable local predictions to ensure that opt guide logic is
// consulted.
features::kLoadingPredictorUseLocalPredictions,
});
}
private:
base::test::ScopedFeatureList scoped_feature_list_;
};
// Tests that document on load completed is recorded with correct navigation
// id and that optimization guide is not consulted when from same-origin.
TEST_P(LoadingPredictorTabHelperOptimizationGuideDeciderTest,
DocumentOnLoadCompletedOptimizationGuideSameOrigin) {
NavigateAndCommitInMainFrameAndVerifyMetrics("http://test.org");
base::HistogramTester histogram_tester;
EXPECT_CALL(*mock_collector_, RecordPageDestroyed(_, Eq(std::nullopt)));
EXPECT_CALL(*mock_optimization_guide_keyed_service_,
CanApplyOptimization(
_, optimization_guide::proto::LOADING_PREDICTOR,
An<optimization_guide::OptimizationGuideDecisionCallback>()))
.Times(0);
NavigateAndCommitInMainFrameAndVerifyMetrics("http://test.org/otherpage");
EXPECT_CALL(*mock_collector_, RecordMainFrameLoadComplete(_));
tab_helper_->DocumentOnLoadCompletedInPrimaryMainFrame();
histogram_tester.ExpectTotalCount(
"LoadingPredictor.OptimizationHintsReceiveStatus", 0);
}
// Tests that document on load completed is recorded.
TEST_P(LoadingPredictorTabHelperOptimizationGuideDeciderTest,
DocumentOnLoadCompletedOptimizationGuide) {
base::HistogramTester histogram_tester;
optimization_guide::OptimizationMetadata optimization_metadata;
optimization_guide::proto::LoadingPredictorMetadata lp_metadata;
lp_metadata.add_subresources()->set_url("http://test.org/resource1");
lp_metadata.add_subresources()->set_url("http://other.org/resource2");
lp_metadata.add_subresources()->set_url("http://other.org/resource3");
optimization_metadata.set_loading_predictor_metadata(lp_metadata);
EXPECT_CALL(*mock_optimization_guide_keyed_service_,
CanApplyOptimization(
_, optimization_guide::proto::LOADING_PREDICTOR,
An<optimization_guide::OptimizationGuideDecisionCallback>()))
.WillOnce(base::test::RunOnceCallback<2>(
optimization_guide::OptimizationGuideDecision::kTrue,
ByRef(optimization_metadata)));
NavigateAndCommitInMainFrameAndVerifyMetrics("http://test.org");
EXPECT_CALL(*mock_collector_, RecordMainFrameLoadComplete(_));
tab_helper_->DocumentOnLoadCompletedInPrimaryMainFrame();
histogram_tester.ExpectUniqueSample(
"LoadingPredictor.OptimizationHintsReceiveStatus",
OptimizationHintsReceiveStatus::kBeforeNavigationFinish, 1);
}
// Tests that page destruction is recorded with the correct navigation id and
// optimization guide prediction.
TEST_P(LoadingPredictorTabHelperOptimizationGuideDeciderTest,
PageDestroyedOptimizationGuide) {
base::HistogramTester histogram_tester;
optimization_guide::OptimizationMetadata optimization_metadata;
optimization_guide::proto::LoadingPredictorMetadata lp_metadata;
lp_metadata.add_subresources()->set_url("http://test.org/resource1");
lp_metadata.add_subresources()->set_url("http://other.org/resource2");
lp_metadata.add_subresources()->set_url("http://other.org/resource3");
optimization_metadata.set_loading_predictor_metadata(lp_metadata);
EXPECT_CALL(*mock_optimization_guide_keyed_service_,
CanApplyOptimization(
_, optimization_guide::proto::LOADING_PREDICTOR,
An<optimization_guide::OptimizationGuideDecisionCallback>()))
.WillOnce(base::test::RunOnceCallback<2>(
optimization_guide::OptimizationGuideDecision::kTrue,
ByRef(optimization_metadata)));
NavigateAndCommitInMainFrameAndVerifyMetrics("http://test.org");
std::optional<OptimizationGuidePrediction> prediction =
OptimizationGuidePrediction();
prediction->decision = optimization_guide::OptimizationGuideDecision::kTrue;
net::SchemefulSite main_frame_site =
net::SchemefulSite(GURL("http://test.org"));
PreconnectPrediction preconnect_prediction = CreatePreconnectPrediction(
"", false,
{{url::Origin::Create(GURL("http://other.org")), 1,
net::NetworkAnonymizationKey::CreateSameSite(main_frame_site)}});
prediction->preconnect_prediction = preconnect_prediction;
prediction->predicted_subresources = {GURL("http://test.org/resource1"),
GURL("http://other.org/resource2"),
GURL("http://other.org/resource3")};
histogram_tester.ExpectUniqueSample(
"LoadingPredictor.OptimizationHintsReceiveStatus",
OptimizationHintsReceiveStatus::kBeforeNavigationFinish, 1);
// Called when the frame is destroyed by the test destructor.
EXPECT_CALL(*mock_collector_, RecordPageDestroyed(_, prediction));
}
// Tests that predictions are recorded correctly when they come after the
// navigation commits.
TEST_P(LoadingPredictorTabHelperOptimizationGuideDeciderTest,
PageDestroyedOptimizationGuidePredictionComesAfterCommit) {
base::HistogramTester histogram_tester;
optimization_guide::OptimizationMetadata optimization_metadata;
optimization_guide::proto::LoadingPredictorMetadata lp_metadata;
lp_metadata.add_subresources()->set_url("http://test.org/resource1");
lp_metadata.add_subresources()->set_url("http://other.org/resource2");
lp_metadata.add_subresources()->set_url("http://other.org/resource3");
optimization_metadata.set_loading_predictor_metadata(lp_metadata);
optimization_guide::OptimizationGuideDecisionCallback callback;
EXPECT_CALL(*mock_optimization_guide_keyed_service_,
CanApplyOptimization(
_, optimization_guide::proto::LOADING_PREDICTOR,
An<optimization_guide::OptimizationGuideDecisionCallback>()))
.WillOnce(WithArg<2>(
Invoke([&](optimization_guide::OptimizationGuideDecisionCallback
got_callback) -> void {
callback = std::move(got_callback);
})));
NavigateAndCommitInMainFrameAndVerifyMetrics("http://test.org");
// Invoke callback after commit.
std::move(callback).Run(optimization_guide::OptimizationGuideDecision::kTrue,
optimization_metadata);
// Optimization guide predictions came after commit.
histogram_tester.ExpectUniqueSample(
"LoadingPredictor.OptimizationHintsReceiveStatus",
OptimizationHintsReceiveStatus::kAfterNavigationFinish, 1);
std::optional<OptimizationGuidePrediction> prediction =
OptimizationGuidePrediction();
prediction->decision = optimization_guide::OptimizationGuideDecision::kTrue;
net::SchemefulSite main_frame_site =
net::SchemefulSite(GURL("http://test.org"));
PreconnectPrediction preconnect_prediction = CreatePreconnectPrediction(
"", false,
{{url::Origin::Create(GURL("http://other.org")), 1,
net::NetworkAnonymizationKey::CreateSameSite(main_frame_site)}});
prediction->preconnect_prediction = preconnect_prediction;
prediction->predicted_subresources = {GURL("http://test.org/resource1"),
GURL("http://other.org/resource2"),
GURL("http://other.org/resource3")};
// Called when the frame is destroyed by the test destructor.
EXPECT_CALL(*mock_collector_, RecordPageDestroyed(_, prediction));
}
// Tests that predictions are recorded correctly when they arrive after a
// redirect.
TEST_P(LoadingPredictorTabHelperOptimizationGuideDeciderTest,
PageDestroyedOptimizationGuidePredictionArrivedAfterRedirect) {
base::HistogramTester histogram_tester;
auto navigation = content::NavigationSimulator::CreateRendererInitiated(
GURL("http://test.org"), main_rfh());
// The problem here is that mock_collector_ is a strict mock, which expects
// a particular set of loading events and fails when extra is present.
// TOOO(ahemery): Consider refactoring this to rely on loading events
// in NavigationSimulator.
navigation->SetKeepLoading(true);
EXPECT_CALL(*mock_collector_, RecordStartNavigation(_, _, _, _));
optimization_guide::OptimizationMetadata optimization_metadata;
optimization_guide::proto::LoadingPredictorMetadata lp_metadata;
lp_metadata.add_subresources()->set_url("http://test.org/resource1");
lp_metadata.add_subresources()->set_url("http://other.org/resource2");
lp_metadata.add_subresources()->set_url("http://other.org/resource3");
optimization_metadata.set_loading_predictor_metadata(lp_metadata);
optimization_guide::OptimizationGuideDecisionCallback callback;
EXPECT_CALL(*mock_optimization_guide_keyed_service_,
CanApplyOptimization(
_, optimization_guide::proto::LOADING_PREDICTOR,
An<optimization_guide::OptimizationGuideDecisionCallback>()))
.Times(3)
.WillOnce(WithArg<2>(
Invoke([&](optimization_guide::OptimizationGuideDecisionCallback
got_callback) -> void {
callback = std::move(got_callback);
})))
.WillRepeatedly(Return());
navigation->Start();
base::RunLoop().RunUntilIdle();
navigation->Redirect(GURL("http://test2.org"));
base::RunLoop().RunUntilIdle();
navigation->Redirect(GURL("http://test3.org"));
std::move(callback).Run(optimization_guide::OptimizationGuideDecision::kTrue,
optimization_metadata);
EXPECT_CALL(*mock_collector_,
RecordFinishNavigation(_, _,
/* is_error_page */ false));
navigation->Commit();
histogram_tester.ExpectUniqueSample(
"LoadingPredictor.OptimizationHintsReceiveStatus",
OptimizationHintsReceiveStatus::kAfterRedirectOrNextNavigationStart, 1);
// Prediction decision should be unknown since what came in was for the wrong
// navigation ID.
std::optional<OptimizationGuidePrediction> optimization_guide_prediction =
OptimizationGuidePrediction();
optimization_guide_prediction->decision =
optimization_guide::OptimizationGuideDecision::kUnknown;
EXPECT_CALL(*mock_collector_,
RecordPageDestroyed(_, optimization_guide_prediction));
optimization_guide::OptimizationMetadata optimization_metadata_2;
EXPECT_CALL(*mock_optimization_guide_keyed_service_,
CanApplyOptimization(
_, optimization_guide::proto::LOADING_PREDICTOR,
An<optimization_guide::OptimizationGuideDecisionCallback>()))
.WillOnce(base::test::RunOnceCallback<2>(
optimization_guide::OptimizationGuideDecision::kFalse,
ByRef(optimization_metadata_2)));
NavigateAndCommitInMainFrameAndVerifyMetrics("http://test.org/next.html");
}
// Tests that page destruction is recorded with correct navigation id and
// optimization guide prediction when the prediction has not arrived.
TEST_P(LoadingPredictorTabHelperOptimizationGuideDeciderTest,
PageDestroyedOptimizationGuidePredictionHasNotArrived) {
base::HistogramTester histogram_tester;
EXPECT_CALL(*mock_optimization_guide_keyed_service_,
CanApplyOptimization(
_, optimization_guide::proto::LOADING_PREDICTOR,
An<optimization_guide::OptimizationGuideDecisionCallback>()));
NavigateAndCommitInMainFrameAndVerifyMetrics("http://test.org");
// Histogram should not be recorded since prediction did not come back.
histogram_tester.ExpectTotalCount(
"LoadingPredictor.OptimizationHintsReceiveStatus", 0);
std::optional<OptimizationGuidePrediction> prediction =
OptimizationGuidePrediction();
prediction->decision =
optimization_guide::OptimizationGuideDecision::kUnknown;
// Called when the frame is destroyed by the test destructor.
EXPECT_CALL(*mock_collector_, RecordPageDestroyed(_, prediction));
}
// Tests that page destroyed is recorded with correct navigation id and
// optimization guide prediction and does not crash if callback comes after
// everything has been recorded.
TEST_P(LoadingPredictorTabHelperOptimizationGuideDeciderTest,
PageDestroyedOptimizationGuidePredictionComesAfterPageDestroyed) {
base::HistogramTester histogram_tester;
optimization_guide::OptimizationMetadata optimization_metadata;
optimization_guide::proto::LoadingPredictorMetadata lp_metadata;
lp_metadata.add_subresources()->set_url("http://test.org/resource1");
lp_metadata.add_subresources()->set_url("http://other.org/resource2");
lp_metadata.add_subresources()->set_url("http://other.org/resource3");
optimization_metadata.set_loading_predictor_metadata(lp_metadata);
optimization_guide::OptimizationGuideDecisionCallback callback;
EXPECT_CALL(*mock_optimization_guide_keyed_service_,
CanApplyOptimization(
_, optimization_guide::proto::LOADING_PREDICTOR,
An<optimization_guide::OptimizationGuideDecisionCallback>()))
.WillOnce(WithArg<2>(
Invoke([&](optimization_guide::OptimizationGuideDecisionCallback
got_callback) -> void {
callback = std::move(got_callback);
})));
NavigateAndCommitInMainFrameAndVerifyMetrics("http://test.org");
std::optional<OptimizationGuidePrediction> prediction =
OptimizationGuidePrediction();
prediction->decision =
optimization_guide::OptimizationGuideDecision::kUnknown;
EXPECT_CALL(*mock_collector_, RecordPageDestroyed(_, prediction));
optimization_guide::OptimizationMetadata optimization_metadata_2;
EXPECT_CALL(*mock_optimization_guide_keyed_service_,
CanApplyOptimization(
_, optimization_guide::proto::LOADING_PREDICTOR,
An<optimization_guide::OptimizationGuideDecisionCallback>()))
.WillOnce(base::test::RunOnceCallback<2>(
optimization_guide::OptimizationGuideDecision::kFalse,
ByRef(optimization_metadata_2)));
NavigateAndCommitInMainFrameAndVerifyMetrics("http://site.net");
// Invoke callback after page destroyed.
std::move(callback).Run(optimization_guide::OptimizationGuideDecision::kTrue,
optimization_metadata);
// Optimization guide predictions came after commit.
histogram_tester.ExpectBucketCount(
"LoadingPredictor.OptimizationHintsReceiveStatus",
OptimizationHintsReceiveStatus::kAfterNavigationFinish, 1);
}
// Tests that page destruction is recorded with correct navigation and
// optimization guide prediction with no prediction..
TEST_P(LoadingPredictorTabHelperOptimizationGuideDeciderTest,
PageDestroyedOptimizationGuidePredictionArrivedNoPrediction) {
base::HistogramTester histogram_tester;
// The problem here is that mock_collector_ is a strict mock, which expects
// a particular set of loading events and fails when extra is present.
// TOOO(ahemery): Consider refactoring this to rely on loading events
// in NavigationSimulator.
optimization_guide::OptimizationMetadata optimization_metadata;
EXPECT_CALL(*mock_optimization_guide_keyed_service_,
CanApplyOptimization(
_, optimization_guide::proto::LOADING_PREDICTOR,
An<optimization_guide::OptimizationGuideDecisionCallback>()))
.WillOnce(base::test::RunOnceCallback<2>(
optimization_guide::OptimizationGuideDecision::kFalse,
ByRef(optimization_metadata)));
NavigateAndCommitInMainFrameAndVerifyMetrics("http://test.org");
// Histogram should still be recorded even though no predictions were
// returned.
histogram_tester.ExpectUniqueSample(
"LoadingPredictor.OptimizationHintsReceiveStatus",
OptimizationHintsReceiveStatus::kBeforeNavigationFinish, 1);
std::optional<OptimizationGuidePrediction> prediction =
OptimizationGuidePrediction();
prediction->decision = optimization_guide::OptimizationGuideDecision::kFalse;
// Called when the frame is destroyed by the test destructor.
EXPECT_CALL(*mock_collector_, RecordPageDestroyed(_, prediction));
}
// Tests that page destruction is recorded with correct navigation id and
// optimization guide prediction with no prediction..
TEST_P(
LoadingPredictorTabHelperOptimizationGuideDeciderTest,
PageDestroyedOptimizationGuidePredictionArrivedNoLoadingPredictorMetadata) {
base::HistogramTester histogram_tester;
// The problem here is that mock_collector_ is a strict mock, which expects
// a particular set of loading events and fails when extra is present.
// TOOO(ahemery): Consider refactoring this to rely on loading events
// in NavigationSimulator.
optimization_guide::OptimizationMetadata optimization_metadata;
EXPECT_CALL(*mock_optimization_guide_keyed_service_,
CanApplyOptimization(
_, optimization_guide::proto::LOADING_PREDICTOR,
An<optimization_guide::OptimizationGuideDecisionCallback>()))
.WillOnce(base::test::RunOnceCallback<2>(
optimization_guide::OptimizationGuideDecision::kTrue,
ByRef(optimization_metadata)));
NavigateAndCommitInMainFrameAndVerifyMetrics("http://test.org");
// Histogram should still be recorded even though no predictions were
// returned.
histogram_tester.ExpectUniqueSample(
"LoadingPredictor.OptimizationHintsReceiveStatus",
OptimizationHintsReceiveStatus::kBeforeNavigationFinish, 1);
// Decision should be unknown since we got invalid data.
std::optional<OptimizationGuidePrediction> optimization_guide_prediction =
OptimizationGuidePrediction();
optimization_guide_prediction->decision =
optimization_guide::OptimizationGuideDecision::kUnknown;
// Called when the frame is destroyed by the test destructor.
EXPECT_CALL(*mock_collector_,
RecordPageDestroyed(_, optimization_guide_prediction));
}
INSTANTIATE_TEST_SUITE_P(LCPPPrefetchSubresourceAsyncFlag,
LoadingPredictorTabHelperOptimizationGuideDeciderTest,
testing::Bool());
class LoadingPredictorTabHelperOptimizationGuideDeciderWithPrefetchTest
: public LoadingPredictorTabHelperOptimizationGuideDeciderTest {
public:
LoadingPredictorTabHelperOptimizationGuideDeciderWithPrefetchTest() {
scoped_feature_list_.InitWithFeatures(
{features::kLoadingPredictorUseOptimizationGuide,
features::kLoadingPredictorPrefetch,
// Need to add otherwise GetForProfile() returns null.
optimization_guide::features::kOptimizationHints},
{});
}
private:
base::test::ScopedFeatureList scoped_feature_list_;
variations::ScopedVariationsIdsProvider scoped_variations_ids_provider_{
variations::VariationsIdsProvider::Mode::kUseSignedInState};
};
// Tests that page destruction is recorded with correct navigation id and
// optimization guide prediction.
TEST_P(LoadingPredictorTabHelperOptimizationGuideDeciderWithPrefetchTest,
PageDestroyedOptimizationGuide) {
base::HistogramTester histogram_tester;
optimization_guide::OptimizationMetadata optimization_metadata;
optimization_guide::proto::LoadingPredictorMetadata lp_metadata;
lp_metadata.add_subresources()->set_url("http://test.org/resource1");
lp_metadata.add_subresources()->set_url("http://other.org/resource2");
lp_metadata.add_subresources()->set_url("http://other.org/resource3");
auto* preconnect_only_resource = lp_metadata.add_subresources();
preconnect_only_resource->set_url("http://preconnectonly.com/");
preconnect_only_resource->set_preconnect_only(true);
optimization_metadata.set_loading_predictor_metadata(lp_metadata);
EXPECT_CALL(*mock_optimization_guide_keyed_service_,
CanApplyOptimization(
_, optimization_guide::proto::LOADING_PREDICTOR,
An<optimization_guide::OptimizationGuideDecisionCallback>()))
.WillOnce(base::test::RunOnceCallback<2>(
optimization_guide::OptimizationGuideDecision::kTrue,
ByRef(optimization_metadata)));
NavigateAndCommitInMainFrameAndVerifyMetrics("http://test.org");
histogram_tester.ExpectUniqueSample(
"LoadingPredictor.OptimizationHintsReceiveStatus",
OptimizationHintsReceiveStatus::kBeforeNavigationFinish, 1);
std::optional<OptimizationGuidePrediction> prediction =
OptimizationGuidePrediction();
prediction->decision = optimization_guide::OptimizationGuideDecision::kTrue;
net::SchemefulSite main_frame_site =
net::SchemefulSite(GURL("http://test.org"));
auto network_anonymization_key =
net::NetworkAnonymizationKey::CreateSameSite(main_frame_site);
network::mojom::RequestDestination destination =
network::mojom::RequestDestination::kEmpty;
PreconnectPrediction preconnect_prediction = CreatePreconnectPrediction(
"", false,
{{url::Origin::Create(GURL("http://preconnectonly.com/")), 1,
network_anonymization_key}});
preconnect_prediction.prefetch_requests.emplace_back(
GURL("http://test.org/resource1"), destination);
preconnect_prediction.prefetch_requests.emplace_back(
GURL("http://other.org/resource1"), destination);
preconnect_prediction.prefetch_requests.emplace_back(
GURL("http://other.org/resource2"), destination);
prediction->preconnect_prediction = preconnect_prediction;
prediction->predicted_subresources = {
GURL("http://test.org/resource1"), GURL("http://other.org/resource2"),
GURL("http://other.org/resource3"), GURL("http://preconnectonly.com/")};
// Called when frame is destroyed by test destructor.
EXPECT_CALL(*mock_collector_, RecordPageDestroyed(_, prediction));
}
INSTANTIATE_TEST_SUITE_P(
LCPPPrefetchSubresourceAsyncFlag,
LoadingPredictorTabHelperOptimizationGuideDeciderWithPrefetchTest,
testing::Bool());
class TestLoadingDataCollector : public LoadingDataCollector {
public:
explicit TestLoadingDataCollector(const LoadingPredictorConfig& config);
void RecordStartNavigation(NavigationId navigation_id,
ukm::SourceId ukm_source_id,
const GURL& main_frame_url,
base::TimeTicks creation_time) override {}
void RecordFinishNavigation(NavigationId navigation_id,
const GURL& new_main_frame_url,
bool is_error_page) override {}
void RecordResourceLoadComplete(
NavigationId navigation_id,
const blink::mojom::ResourceLoadInfo& resource_load_info) override {
++count_resource_loads_completed_;
EXPECT_EQ(expected_request_priority_, resource_load_info.request_priority);
}
void RecordMainFrameLoadComplete(NavigationId navigation_id) override {}
void RecordPageDestroyed(NavigationId navigation_id,
const std::optional<OptimizationGuidePrediction>&
optimization_guide_prediction) override {}
void SetExpectedResourcePriority(net::RequestPriority request_priority) {
expected_request_priority_ = request_priority;
}
size_t count_resource_loads_completed() const {
return count_resource_loads_completed_;
}
private:
net::RequestPriority expected_request_priority_ = net::HIGHEST;
size_t count_resource_loads_completed_ = 0;
};
TestLoadingDataCollector::TestLoadingDataCollector(
const LoadingPredictorConfig& config)
: LoadingDataCollector(nullptr, nullptr, config) {}
class LoadingPredictorTabHelperTestCollectorTest
: public LoadingPredictorTabHelperTest {
public:
void SetUp() override;
protected:
raw_ptr<TestLoadingDataCollector> test_collector_;
};
void LoadingPredictorTabHelperTestCollectorTest::SetUp() {
ChromeRenderViewHostTestHarness::SetUp();
CreateSessionServiceTabHelper(web_contents());
LoadingPredictorTabHelper::CreateForWebContents(web_contents());
tab_helper_ = LoadingPredictorTabHelper::FromWebContents(web_contents());
LoadingPredictorConfig config;
PopulateTestConfig(&config);
loading_predictor_ = std::make_unique<LoadingPredictor>(config, profile());
auto test_collector = std::make_unique<TestLoadingDataCollector>(config);
test_collector_ = test_collector.get();
loading_predictor_->set_mock_loading_data_collector(
std::move(test_collector));
tab_helper_->SetLoadingPredictorForTesting(loading_predictor_->GetWeakPtr());
}
// Tests that a resource load is correctly recorded with the correct priority.
TEST_P(LoadingPredictorTabHelperTestCollectorTest, ResourceLoadComplete) {
NavigateAndCommitInFrame("http://test.org", main_rfh());
// Set expected priority to HIGHEST and load a HIGHEST priority resource.
test_collector_->SetExpectedResourcePriority(net::HIGHEST);
auto resource_load_info = CreateResourceLoadInfo(
"http://test.org/script.js", network::mojom::RequestDestination::kScript);
tab_helper_->ResourceLoadComplete(main_rfh(), content::GlobalRequestID(),
*resource_load_info);
EXPECT_EQ(1u, test_collector_->count_resource_loads_completed());
// Set expected priority to LOWEST and load a LOWEST priority resource.
test_collector_->SetExpectedResourcePriority(net::LOWEST);
resource_load_info = CreateLowPriorityResourceLoadInfo(
"http://test.org/script.js", network::mojom::RequestDestination::kScript);
tab_helper_->ResourceLoadComplete(main_rfh(), content::GlobalRequestID(),
*resource_load_info);
EXPECT_EQ(2u, test_collector_->count_resource_loads_completed());
}
INSTANTIATE_TEST_SUITE_P(LCPPPrefetchSubresourceAsyncFlag,
LoadingPredictorTabHelperTestCollectorTest,
testing::Bool());
class LoadingPredictorTabHelperTestCollectorFencedFramesTest
: public LoadingPredictorTabHelperTestCollectorTest {
public:
LoadingPredictorTabHelperTestCollectorFencedFramesTest() {
scoped_feature_list_.InitAndEnableFeatureWithParameters(
blink::features::kFencedFrames, {{"implementation_type", "mparch"}});
}
~LoadingPredictorTabHelperTestCollectorFencedFramesTest() override = default;
private:
base::test::ScopedFeatureList scoped_feature_list_;
};
TEST_P(LoadingPredictorTabHelperTestCollectorFencedFramesTest,
DoNotRecordResourceLoadComplete) {
NavigateAndCommitInFrame("http://test.org", main_rfh());
content::RenderFrameHost* fenced_frame_root =
content::RenderFrameHostTester::For(main_rfh())->AppendFencedFrame();
// Navigate a fenced frame.
GURL fenced_frame_url = GURL("https://fencedframe.com");
std::unique_ptr<content::NavigationSimulator> navigation_simulator =
content::NavigationSimulator::CreateRendererInitiated(fenced_frame_url,
fenced_frame_root);
navigation_simulator->Commit();
fenced_frame_root = navigation_simulator->GetFinalRenderFrameHost();
EXPECT_EQ(0u, test_collector_->count_resource_loads_completed());
// Load a sub resource on the main frame and record it.
auto resource_load_info = CreateResourceLoadInfo(
"http://test.org/script.js", network::mojom::RequestDestination::kScript);
tab_helper_->ResourceLoadComplete(main_rfh(), content::GlobalRequestID(),
*resource_load_info);
EXPECT_EQ(1u, test_collector_->count_resource_loads_completed());
// Load a sub resource on the fenced frame and do not record it.
tab_helper_->ResourceLoadComplete(
fenced_frame_root, content::GlobalRequestID(), *resource_load_info);
EXPECT_EQ(1u, test_collector_->count_resource_loads_completed());
}
INSTANTIATE_TEST_SUITE_P(LCPPPrefetchSubresourceAsyncFlag,
LoadingPredictorTabHelperTestCollectorFencedFramesTest,
testing::Bool());
} // namespace predictors
|