// Copyright 2019 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/back_forward_cache/back_forward_cache_metrics.h" #include "base/functional/bind.h" #include "base/run_loop.h" #include "base/task/single_thread_task_runner.h" #include "base/test/bind.h" #include "base/test/metrics/histogram_tester.h" #include "base/test/scoped_feature_list.h" #include "build/build_config.h" #include "components/ukm/test_ukm_recorder.h" #include "content/browser/back_forward_cache/back_forward_cache_impl.h" #include "content/browser/renderer_host/navigation_controller_impl.h" #include "content/browser/web_contents/web_contents_impl.h" #include "content/common/content_navigation_policy.h" #include "content/public/browser/browser_thread.h" #include "content/public/browser/navigation_handle.h" #include "content/public/browser/web_contents.h" #include "content/public/browser/web_contents_observer.h" #include "content/public/test/back_forward_cache_util.h" #include "content/public/test/browser_test.h" #include "content/public/test/browser_test_utils.h" #include "content/public/test/content_browser_test.h" #include "content/public/test/content_browser_test_utils.h" #include "content/public/test/fenced_frame_test_util.h" #include "content/public/test/prerender_test_util.h" #include "content/public/test/test_navigation_observer.h" #include "content/shell/browser/shell.h" #include "content/test/content_browser_test_utils_internal.h" #include "mojo/public/cpp/test_support/test_utils.h" #include "net/dns/mock_host_resolver.h" #include "testing/gmock/include/gmock/gmock.h" #include "testing/gtest/include/gtest/gtest.h" #include "third_party/blink/public/common/features.h" #include "third_party/blink/public/mojom/frame/back_forward_cache_controller.mojom-test-utils.h" using base::Bucket; using testing::ElementsAre; namespace content { namespace { ukm::SourceId ToSourceId(int64_t navigation_id) { return ukm::ConvertToSourceId(navigation_id, ukm::SourceIdType::NAVIGATION_ID); } using UkmMetrics = ukm::TestUkmRecorder::HumanReadableUkmMetrics; using UkmEntry = ukm::TestUkmRecorder::HumanReadableUkmEntry; enum BackForwardCacheStatus { kDisabled = 0, kEnabled = 1 }; } // namespace class BackForwardCacheMetricsBrowserTestBase : public ContentBrowserTest, public WebContentsObserver { protected: void SetUpOnMainThread() override { host_resolver()->AddRule("*", "127.0.0.1"); content::SetupCrossSiteRedirector(embedded_test_server()); ASSERT_TRUE(embedded_test_server()->Start()); WebContentsObserver::Observe(shell()->web_contents()); } WebContentsImpl* web_contents() const { return static_cast(shell()->web_contents()); } void GiveItSomeTime() { base::RunLoop run_loop; base::SingleThreadTaskRunner::GetCurrentDefault()->PostDelayedTask( FROM_HERE, run_loop.QuitClosure(), base::Milliseconds(200)); run_loop.Run(); } RenderFrameHostImpl* current_frame_host() { return web_contents()->GetPrimaryFrameTree().root()->current_frame_host(); } void DidStartNavigation(NavigationHandle* navigation_handle) override { navigation_ids_.push_back(navigation_handle->GetNavigationId()); } std::vector navigation_ids_; }; class BackForwardCacheMetricsBrowserTest : public BackForwardCacheMetricsBrowserTestBase, public testing::WithParamInterface { public: BackForwardCacheMetricsBrowserTest() { if (GetParam() == BackForwardCacheStatus::kEnabled) { // Enable BackForwardCache. feature_list_.InitWithFeaturesAndParameters( {{features::kBackForwardCache, {}}, {kBackForwardCacheNoTimeEviction, {}}}, // Allow BackForwardCache for all devices regardless of their memory. {features::kBackForwardCacheMemoryControls}); DCHECK(IsBackForwardCacheEnabled()); } else { feature_list_.InitAndDisableFeature(features::kBackForwardCache); DCHECK(!IsBackForwardCacheEnabled()); } } static std::string DescribeParams( const testing::TestParamInfo& info) { return info.param ? "BFCacheEnabled" : "BFCacheDisabled"; } static constexpr char kNotRestoredReasonUMAName[] = "BackForwardCache.HistoryNavigationOutcome.NotRestoredReason"; private: base::test::ScopedFeatureList feature_list_; }; IN_PROC_BROWSER_TEST_P(BackForwardCacheMetricsBrowserTest, UKM) { ukm::TestAutoSetUkmRecorder recorder; const GURL url1(embedded_test_server()->GetURL( "a.com", "/frame_tree/page_with_one_frame.html")); const GURL url2(embedded_test_server()->GetURL("b.com", "/title1.html")); const char kChildFrameId[] = "child0"; EXPECT_TRUE(NavigateToURL(shell(), url2)); // The navigation entries are: // [*url2]. EXPECT_TRUE(NavigateToURL(shell(), url1)); // The navigation entries are: // [url2, *url1(subframe)]. EXPECT_TRUE( NavigateIframeToURL(shell()->web_contents(), kChildFrameId, url2)); // The navigation entries are: // [url2, url1(subframe), *url1(url2)]. EXPECT_TRUE(NavigateToURL(shell(), url2)); // The navigation entries are: // [url2, url1(subframe), url1(url2), *url2]. { // We are waiting for two navigations here: main frame and subframe. // However, when back/forward cache is enabled, back navigation to a page // with subframes will not trigger a subframe navigation (since the // subframe is cached with the page). TestNavigationObserver navigation_observer( shell()->web_contents(), 1 + (IsBackForwardCacheEnabled() ? 0 : 1)); shell()->GoBackOrForward(-1); navigation_observer.WaitForNavigationFinished(); } // The navigation entries are: // [url2, url1(subframe), *url1(url2), url2]. { TestNavigationObserver navigation_observer(shell()->web_contents()); shell()->GoBackOrForward(-1); navigation_observer.WaitForNavigationFinished(); } // The navigation entries are: // [url2, *url1(subframe), url1(url2), url2]. { TestNavigationObserver navigation_observer(shell()->web_contents()); shell()->GoBackOrForward(-1); navigation_observer.WaitForNavigationFinished(); } // The navigation entries are: // [*url2, url1(subframe), url1(url2), url2]. // There are five new navigations and four back navigations (3 if // back/forward cache is enabled, as the first subframe back navigation won't // happen). // Navigations 1, 2, 5 are main frame. Navigation 3 is an initial navigation // in the subframe, navigation 4 is a subframe navigation. ASSERT_EQ(navigation_ids_.size(), static_cast(8 + (IsBackForwardCacheEnabled() ? 0 : 1))); ukm::SourceId id1 = ToSourceId(navigation_ids_[0]); ukm::SourceId id2 = ToSourceId(navigation_ids_[1]); // ukm::SourceId id3 = ToSourceId(navigation_ids_[2]); // ukm::SourceId id4 = ToSourceId(navigation_ids_[3]); // ukm::SourceId id5 = ToSourceId(navigation_ids_[4]); ukm::SourceId id6 = ToSourceId(navigation_ids_[5]); // ukm::SourceId id7 = ToSourceId(navigation_ids_[6]); // ukm::SourceId id8 = ToSourceId(navigation_ids_[7]); ukm::SourceId id_last = ToSourceId(navigation_ids_[navigation_ids_.size() - 1]); std::string last_navigation_id = "LastCommittedCrossDocumentNavigationSourceIdForTheSameDocument"; // First back/forward navigation (#6) navigates back to navigation #3, but it // is the subframe navigation, so the corresponding main frame navigation is // #2. Navigation #7 loads the subframe for navigation #6. // Second back/forward navigation (#8) navigates back to navigation #2, // but it is subframe navigation and not reflected here. Third back/forward // navigation (#9) navigates back to navigation #1. EXPECT_THAT( recorder.GetEntries("HistoryNavigation", {last_navigation_id}), testing::ElementsAre(UkmEntry{id6, {{last_navigation_id, id2}}}, UkmEntry{id_last, {{last_navigation_id, id1}}})); } IN_PROC_BROWSER_TEST_P(BackForwardCacheMetricsBrowserTest, CloneAndGoBack) { ukm::TestAutoSetUkmRecorder recorder; const GURL url1(embedded_test_server()->GetURL("/title1.html")); const GURL url2(embedded_test_server()->GetURL("/title2.html")); EXPECT_TRUE(NavigateToURL(shell(), url1)); EXPECT_TRUE(NavigateToURL(shell(), url2)); // Clone the tab and load the page. std::unique_ptr new_tab = shell()->web_contents()->Clone(); WebContentsImpl* new_tab_impl = static_cast(new_tab.get()); WebContentsObserver::Observe(new_tab.get()); NavigationController& new_controller = new_tab_impl->GetController(); { TestNavigationObserver clone_observer(new_tab.get()); new_controller.LoadIfNecessary(); clone_observer.Wait(); } { TestNavigationObserver navigation_observer(new_tab.get()); new_controller.GoBack(); navigation_observer.WaitForNavigationFinished(); } { TestNavigationObserver navigation_observer(new_tab.get()); new_controller.GoForward(); navigation_observer.WaitForNavigationFinished(); } { TestNavigationObserver navigation_observer(new_tab.get()); new_controller.GoBack(); navigation_observer.WaitForNavigationFinished(); } ASSERT_EQ(navigation_ids_.size(), static_cast(6)); // ukm::SourceId id1 = ToSourceId(navigation_ids_[0]); // ukm::SourceId id2 = ToSourceId(navigation_ids_[1]); ukm::SourceId id3 = ToSourceId(navigation_ids_[2]); ukm::SourceId id4 = ToSourceId(navigation_ids_[3]); ukm::SourceId id5 = ToSourceId(navigation_ids_[4]); ukm::SourceId id6 = ToSourceId(navigation_ids_[5]); std::string last_navigation_id = "LastCommittedCrossDocumentNavigationSourceIdForTheSameDocument"; // First two new navigations happen in the original tab. // The third navigation reloads the tab for the cloned WebContents. // The fourth goes back, and records an empty entry because its // NavigationEntry was cloned and the metrics objects was empty. // The last two navigations records non-empty entries. EXPECT_THAT(recorder.GetEntries("HistoryNavigation", {last_navigation_id}), testing::ElementsAre(UkmEntry{id4, {}}, UkmEntry{id5, {{last_navigation_id, id3}}}, UkmEntry{id6, {{last_navigation_id, id4}}})); // Ensure that for the first navigation, we record "session restored" as one // of the NotRestoredReasons, which is added by the metrics recording code. std::string not_restored_reasons = "BackForwardCache.NotRestoredReasons"; std::vector recorded_not_restored_reasons = recorder.FilteredHumanReadableMetricForEntry("HistoryNavigation", not_restored_reasons); ASSERT_EQ(recorded_not_restored_reasons.size(), 3u); EXPECT_EQ(recorded_not_restored_reasons[0][not_restored_reasons], 1 << static_cast( BackForwardCacheMetrics::NotRestoredReason::kSessionRestored)); } IN_PROC_BROWSER_TEST_P(BackForwardCacheMetricsBrowserTest, FlushRecordsNotRestoredReasons) { if (!base::FeatureList::IsEnabled(features::kBackForwardCache)) { return; } ukm::TestAutoSetUkmRecorder recorder; base::HistogramTester histogram_tester; const GURL url1(embedded_test_server()->GetURL("/title1.html")); const GURL url2(embedded_test_server()->GetURL("/title2.html")); histogram_tester.ExpectBucketCount( kNotRestoredReasonUMAName, BackForwardCacheMetrics::NotRestoredReason::kCacheFlushed, 0); EXPECT_TRUE(NavigateToURL(shell(), url1)); EXPECT_TRUE(NavigateToURL(shell(), url2)); web_contents()->GetController().GetBackForwardCache().Flush(); TestNavigationObserver navigation_observer(shell()->web_contents()); shell()->GoBackOrForward(-1); navigation_observer.WaitForNavigationFinished(); // Ensure that the not restored reason is correctly collected for the flush. std::string not_restored_reasons = "BackForwardCache.NotRestoredReasons"; std::vector recorded_not_restored_reasons = recorder.FilteredHumanReadableMetricForEntry("HistoryNavigation", not_restored_reasons); EXPECT_EQ(recorded_not_restored_reasons[0][not_restored_reasons], 1 << static_cast( BackForwardCacheMetrics::NotRestoredReason::kCacheFlushed)); histogram_tester.ExpectBucketCount( kNotRestoredReasonUMAName, BackForwardCacheMetrics::NotRestoredReason::kCacheFlushed, 1); } IN_PROC_BROWSER_TEST_P(BackForwardCacheMetricsBrowserTest, WebViewFlushRecordsExtendedNotRestoredReasons) { if (!base::FeatureList::IsEnabled(features::kBackForwardCache)) { return; } ukm::TestAutoSetUkmRecorder recorder; using NotRestoredReason = BackForwardCacheMetrics::NotRestoredReason; const std::vector webview_flush_reasons = { NotRestoredReason::kWebViewSettingsChanged, NotRestoredReason::kWebViewJavaScriptObjectChanged, NotRestoredReason::kWebViewMessageListenerInjected, NotRestoredReason::kWebViewSafeBrowsingAllowlistChanged, NotRestoredReason::kWebViewDocumentStartJavascriptChanged, }; const int kExtendedReasonOffset = 64; for (NotRestoredReason reason : webview_flush_reasons) { const GURL url1(embedded_test_server()->GetURL("/title1.html")); const GURL url2(embedded_test_server()->GetURL("/title2.html")); base::HistogramTester histogram_tester; EXPECT_TRUE(NavigateToURL(shell(), url1)); EXPECT_TRUE(NavigateToURL(shell(), url2)); histogram_tester.ExpectBucketCount(kNotRestoredReasonUMAName, reason, 0); web_contents()->GetController().GetBackForwardCache().Flush(reason); TestNavigationObserver navigation_observer(shell()->web_contents()); shell()->GoBackOrForward(-1); navigation_observer.WaitForNavigationFinished(); // Ensure that the not restored reason is correctly collected for the flush. std::string not_restored_reasons2 = "BackForwardCache.NotRestoredReasons2"; std::vector recorded_not_restored_reasons = recorder.FilteredHumanReadableMetricForEntry("HistoryNavigation", not_restored_reasons2); EXPECT_EQ(recorded_not_restored_reasons.back()[not_restored_reasons2], 1 << (static_cast(reason) - kExtendedReasonOffset)); histogram_tester.ExpectBucketCount(kNotRestoredReasonUMAName, reason, 1); } } // Confirms that UKMs are not recorded on reloading. IN_PROC_BROWSER_TEST_P(BackForwardCacheMetricsBrowserTest, Reload) { ukm::TestAutoSetUkmRecorder recorder; const GURL url1(embedded_test_server()->GetURL("a.com", "/title1.html")); const GURL url2(embedded_test_server()->GetURL("b.com", "/title1.html")); EXPECT_TRUE(NavigateToURL(shell(), url1)); EXPECT_TRUE(NavigateToURL(shell(), url2)); ASSERT_TRUE(HistoryGoBack(web_contents())); web_contents()->GetController().Reload(ReloadType::NORMAL, false); EXPECT_TRUE(WaitForLoadStop(shell()->web_contents())); EXPECT_TRUE(NavigateToURL(shell(), url2)); ASSERT_TRUE(HistoryGoBack(web_contents())); ASSERT_EQ(navigation_ids_.size(), static_cast(6)); ukm::SourceId id1 = ToSourceId(navigation_ids_[0]); // ukm::SourceId id2 = ToSourceId(navigation_ids_[1]); ukm::SourceId id3 = ToSourceId(navigation_ids_[2]); ukm::SourceId id4 = ToSourceId(navigation_ids_[3]); // ukm::SourceId id5 = ToSourceId(navigation_ids_[4]); ukm::SourceId id6 = ToSourceId(navigation_ids_[5]); // The last navigation is for reloading, and the UKM is not recorded for this // navigation. This also checks relaoding makes a different navigation ID. std::string last_navigation_id = "LastCommittedCrossDocumentNavigationSourceIdForTheSameDocument"; EXPECT_THAT(recorder.GetEntries("HistoryNavigation", {last_navigation_id}), testing::ElementsAre(UkmEntry{id3, {{last_navigation_id, id1}}}, UkmEntry{id6, {{last_navigation_id, id4}}})); } IN_PROC_BROWSER_TEST_P(BackForwardCacheMetricsBrowserTest, SameDocumentNavigationAndGoBackImmediately) { ukm::TestAutoSetUkmRecorder recorder; const GURL url1(embedded_test_server()->GetURL("a.com", "/title1.html")); const GURL url1_foo( embedded_test_server()->GetURL("a.com", "/title1.html#foo")); EXPECT_TRUE(NavigateToURL(shell(), url1)); EXPECT_TRUE(NavigateToURL(shell(), url1_foo)); ASSERT_TRUE(HistoryGoBack(web_contents())); ASSERT_EQ(navigation_ids_.size(), static_cast(3)); std::string last_navigation_id = "LastCommittedCrossDocumentNavigationSourceIdForTheSameDocument"; // Ensure that UKMs are not recorded for the same-document history // navigations. EXPECT_THAT(recorder.GetEntries("HistoryNavigation", {last_navigation_id}), testing::ElementsAre()); } IN_PROC_BROWSER_TEST_P(BackForwardCacheMetricsBrowserTest, GoBackToSameDocumentNavigationEntry) { ukm::TestAutoSetUkmRecorder recorder; const GURL url1(embedded_test_server()->GetURL("a.com", "/title1.html")); const GURL url1_foo( embedded_test_server()->GetURL("a.com", "/title1.html#foo")); const GURL url2(embedded_test_server()->GetURL("b.com", "/title1.html")); EXPECT_TRUE(NavigateToURL(shell(), url1)); EXPECT_TRUE(NavigateToURL(shell(), url1_foo)); EXPECT_TRUE(NavigateToURL(shell(), url2)); ASSERT_TRUE(HistoryGoBack(web_contents())); ASSERT_EQ(navigation_ids_.size(), static_cast(4)); ukm::SourceId id1 = ToSourceId(navigation_ids_[0]); // ukm::SourceId id2 = ToSourceId(navigation_ids_[1]); // ukm::SourceId id3 = ToSourceId(navigation_ids_[2]); ukm::SourceId id4 = ToSourceId(navigation_ids_[3]); std::string last_navigation_id = "LastCommittedCrossDocumentNavigationSourceIdForTheSameDocument"; // The second navigation is a same-document navigation for the page loaded by // the first navigation. The third navigation is a regular navigation. The // fourth navigation goes back. // // The back/forward navigation (#4) goes back to the navigation entry created // by the same-document navigation (#2), so we expect the id corresponding to // the previous non-same-document navigation (#1). EXPECT_THAT(recorder.GetEntries("HistoryNavigation", {last_navigation_id}), testing::ElementsAre(UkmEntry{id4, {{last_navigation_id, id1}}})); } IN_PROC_BROWSER_TEST_P(BackForwardCacheMetricsBrowserTest, GoBackToSameDocumentNavigationEntry2) { ukm::TestAutoSetUkmRecorder recorder; const GURL url1(embedded_test_server()->GetURL("a.com", "/title1.html")); const GURL url1_foo( embedded_test_server()->GetURL("a.com", "/title1.html#foo")); const GURL url2(embedded_test_server()->GetURL("b.com", "/title1.html")); EXPECT_TRUE(NavigateToURL(shell(), url1)); EXPECT_TRUE(NavigateToURL(shell(), url1_foo)); EXPECT_TRUE(NavigateToURL(shell(), url2)); web_contents()->GetController().GoToOffset(-2); EXPECT_TRUE(WaitForLoadStop(shell()->web_contents())); ASSERT_EQ(navigation_ids_.size(), static_cast(4)); ukm::SourceId id1 = ToSourceId(navigation_ids_[0]); // ukm::SourceId id2 = ToSourceId(navigation_ids_[1]); // ukm::SourceId id3 = ToSourceId(navigation_ids_[2]); ukm::SourceId id4 = ToSourceId(navigation_ids_[3]); std::string last_navigation_id = "LastCommittedCrossDocumentNavigationSourceIdForTheSameDocument"; // The second navigation is a same-document navigation for the page loaded by // the first navigation. The third navigation is a regular navigation. The // fourth navigation goes back. // // The back/forward navigation (#4) goes back to navigation #1, skipping a // navigation entry generated by same-document navigation (#2). Ensure that // the recorded id belongs to the navigation #1, not #2. EXPECT_THAT(recorder.GetEntries("HistoryNavigation", {last_navigation_id}), testing::ElementsAre(UkmEntry{id4, {{last_navigation_id, id1}}})); } namespace { std::vector GetMetricsSourceIds( ukm::TestAutoSetUkmRecorder* recorder) { std::vector result; for (const auto& entry : recorder->GetEntries("HistoryNavigation", {})) { result.push_back(entry.source_id); } return result; } } // namespace IN_PROC_BROWSER_TEST_P(BackForwardCacheMetricsBrowserTest, Features_MainFrame) { ukm::TestAutoSetUkmRecorder recorder; const GURL url1(embedded_test_server()->GetURL( "/back_forward_cache/page_with_pageshow.html")); const GURL url2(embedded_test_server()->GetURL("/title1.html")); EXPECT_TRUE(NavigateToURL(shell(), url1)); EXPECT_TRUE(NavigateToURL(shell(), url2)); { TestNavigationObserver navigation_observer(shell()->web_contents()); shell()->GoBackOrForward(-1); navigation_observer.WaitForNavigationFinished(); } ASSERT_EQ(navigation_ids_.size(), static_cast(3)); // ukm::SourceId id1 = ToSourceId(navigation_ids_[0]); // ukm::SourceId id2 = ToSourceId(navigation_ids_[1]); ukm::SourceId id3 = ToSourceId(navigation_ids_[2]); EXPECT_THAT(GetMetricsSourceIds(&recorder), testing::ElementsAre(id3)); } IN_PROC_BROWSER_TEST_P(BackForwardCacheMetricsBrowserTest, Features_MainFrame_CrossOriginNavigation) { ukm::TestAutoSetUkmRecorder recorder; const GURL url1(embedded_test_server()->GetURL( "/back_forward_cache/page_with_pageshow.html")); const GURL url2(embedded_test_server()->GetURL("bar.com", "/title1.html")); EXPECT_TRUE(NavigateToURL(shell(), url1)); EXPECT_TRUE(NavigateToURL(shell(), url2)); { TestNavigationObserver navigation_observer(shell()->web_contents()); shell()->GoBackOrForward(-1); navigation_observer.WaitForNavigationFinished(); } ASSERT_EQ(navigation_ids_.size(), static_cast(3)); // ukm::SourceId id1 = ToSourceId(navigation_ids_[0]); // ukm::SourceId id2 = ToSourceId(navigation_ids_[1]); ukm::SourceId id3 = ToSourceId(navigation_ids_[2]); EXPECT_THAT(GetMetricsSourceIds(&recorder), testing::ElementsAre(id3)); } IN_PROC_BROWSER_TEST_P(BackForwardCacheMetricsBrowserTest, Features_SameOriginSubframes) { ukm::TestAutoSetUkmRecorder recorder; const GURL url1(embedded_test_server()->GetURL( "/back_forward_cache/page_with_same_origin_subframe_with_pageshow.html")); const GURL url2(embedded_test_server()->GetURL("b.com", "/title1.html")); EXPECT_TRUE(NavigateToURL(shell(), url1)); EXPECT_TRUE(NavigateToURL(shell(), url2)); { // We are waiting for two navigations here: main frame and subframe. // However, when back/forward cache is enabled, back navigation to a page // with subframes will not trigger a subframe navigation (since the // subframe is cached with the page). TestNavigationObserver navigation_observer( shell()->web_contents(), 1 + (IsBackForwardCacheEnabled() ? 0 : 1)); shell()->GoBackOrForward(-1); navigation_observer.WaitForNavigationFinished(); } ASSERT_EQ(navigation_ids_.size(), static_cast(4 + (IsBackForwardCacheEnabled() ? 0 : 1))); // ukm::SourceId id1 = ToSourceId(navigation_ids_[0]); // ukm::SourceId id2 = ToSourceId(navigation_ids_[1]); // ukm::SourceId id3 = ToSourceId(navigation_ids_[2]); ukm::SourceId id4 = ToSourceId(navigation_ids_[3]); EXPECT_THAT(GetMetricsSourceIds(&recorder), testing::ElementsAre(id4)); } IN_PROC_BROWSER_TEST_P(BackForwardCacheMetricsBrowserTest, Features_SameOriginSubframes_CrossOriginNavigation) { ukm::TestAutoSetUkmRecorder recorder; const GURL url1(embedded_test_server()->GetURL( "/back_forward_cache/page_with_same_origin_subframe_with_pageshow.html")); const GURL url2(embedded_test_server()->GetURL("bar.com", "/title1.html")); EXPECT_TRUE(NavigateToURL(shell(), url1)); EXPECT_TRUE(NavigateToURL(shell(), url2)); ASSERT_TRUE(HistoryGoBack(web_contents())); // When the page is restored from back/forward cache, there is one navigation // corresponding to the bfcache restore. Whereas, when the page is reloaded, // there are two navigations i.e., one loading the main frame and one loading // the subframe. ASSERT_EQ(navigation_ids_.size(), IsBackForwardCacheEnabled() ? 4u : 5u); // ukm::SourceId id1 = ToSourceId(navigation_ids_[0]); // ukm::SourceId id2 = ToSourceId(navigation_ids_[1]); // ukm::SourceId id3 = ToSourceId(navigation_ids_[2]); ukm::SourceId id4 = ToSourceId(navigation_ids_[3]); EXPECT_THAT(GetMetricsSourceIds(&recorder), testing::ElementsAre(id4)); } IN_PROC_BROWSER_TEST_P(BackForwardCacheMetricsBrowserTest, Features_CrossOriginSubframes) { ukm::TestAutoSetUkmRecorder recorder; const GURL url1(embedded_test_server()->GetURL( "/back_forward_cache/" "page_with_cross_origin_subframe_with_pageshow.html")); const GURL url2(embedded_test_server()->GetURL("b.com", "/title1.html")); EXPECT_TRUE(NavigateToURL(shell(), url1)); EXPECT_TRUE(NavigateToURL(shell(), url2)); { // We are waiting for two navigations here: main frame and subframe. // However, when back/forward cache is enabled, back navigation to a page // with subframes will not trigger a subframe navigation (since the // subframe is cached with the page). TestNavigationObserver navigation_observer( shell()->web_contents(), 1 + (IsBackForwardCacheEnabled() ? 0 : 1)); shell()->GoBackOrForward(-1); navigation_observer.WaitForNavigationFinished(); } ASSERT_EQ(navigation_ids_.size(), static_cast(4 + (IsBackForwardCacheEnabled() ? 0 : 1))); // ukm::SourceId id1 = ToSourceId(navigation_ids_[0]); // ukm::SourceId id2 = ToSourceId(navigation_ids_[1]); // ukm::SourceId id3 = ToSourceId(navigation_ids_[2]); ukm::SourceId id4 = ToSourceId(navigation_ids_[3]); EXPECT_THAT(GetMetricsSourceIds(&recorder), testing::ElementsAre(id4)); } class BackForwardCacheMetricsSameDocumentBrowserTest : public BackForwardCacheMetricsBrowserTest { public: BackForwardCacheMetricsSameDocumentBrowserTest() { scoped_feature_list_.InitAndEnableFeature( kResetBrowsingInstanceSwapResultOnSameDocument); } class BackForwardCacheWebContentsDelegate : public WebContentsDelegate { public: bool IsBackForwardCacheSupported(WebContents& web_contents) override { return true; } }; BackForwardCacheWebContentsDelegate web_contents_delegate_; private: base::test::ScopedFeatureList scoped_feature_list_; }; INSTANTIATE_TEST_SUITE_P(All, BackForwardCacheMetricsSameDocumentBrowserTest, testing::ValuesIn({BackForwardCacheStatus::kDisabled, BackForwardCacheStatus::kEnabled}), BackForwardCacheMetricsBrowserTest::DescribeParams); // Verifies that stale "no swap" reasons (e.g., from session restore) are // cleared during same-document navigations. This prevents a crash (DCHECK // failure) when the page is subsequently restored from BFCache. This test would // cause a crash at the last navigation if the feature is disabled. IN_PROC_BROWSER_TEST_P(BackForwardCacheMetricsSameDocumentBrowserTest, SessionRestoreAndSameDocumentNavigation) { if (!IsBackForwardCacheEnabled()) { return; } GURL url_a(embedded_test_server()->GetURL("a.com", "/title1.html")); GURL url_a_foo(embedded_test_server()->GetURL("a.com", "/title1.html#foo")); GURL url_b(embedded_test_server()->GetURL("b.com", "/title2.html")); // Setup history: A -> A#foo -> B EXPECT_TRUE(NavigateToURL(shell(), url_a)); EXPECT_TRUE(NavigateToURL(shell(), url_a_foo)); EXPECT_TRUE(NavigateToURL(shell(), url_b)); std::unique_ptr new_tab = shell()->web_contents()->Clone(); WebContentsImpl* new_tab_impl = static_cast(new_tab.get()); WebContentsObserver::Observe(new_tab.get()); NavigationControllerImpl& new_controller = new_tab_impl->GetController(); new_tab->SetDelegate(&web_contents_delegate_); // Load the duplicated tab (B is displayed) { TestNavigationObserver clone_observer(new_tab.get()); new_controller.LoadIfNecessary(); clone_observer.Wait(); } // Go back to A#foo { TestNavigationObserver observer(new_tab.get()); new_controller.GoBack(); observer.Wait(); } // Go back to A, which does not regard as a same-document navigation, and // records the not-restored reason. { TestNavigationObserver observer(new_tab.get()); new_controller.GoBack(); observer.Wait(); } // Go forward to A#foo, which is a same-document navigation, will clear the // not-restored reason. { TestNavigationObserver observer(new_tab.get()); new_controller.GoForward(); observer.Wait(); } // Go forward to B, which is restored from BFCache. { TestNavigationObserver observer(new_tab.get()); new_controller.GoForward(); observer.Wait(); } // Go back to A#foo, which is restored from BFCache. { TestNavigationObserver observer(new_tab.get()); new_controller.GoBack(); observer.Wait(); } } class RecordBackForwardCacheMetricsWithoutEnabling : public BackForwardCacheMetricsBrowserTestBase { public: RecordBackForwardCacheMetricsWithoutEnabling() { // Sets the allowed websites for testing. std::string allowed_websites = "https://a.allowed/back_forward_cache/, " "https://b.allowed/"; scoped_feature_list_.InitWithFeaturesAndParameters( {{kRecordBackForwardCacheMetricsWithoutEnabling, {{"allowed_websites", allowed_websites}}}}, // Disable BackForwardCacheMemoryControl to only allow URLs passed via // params for all devices irrespective of their memory. As when // DeviceHasEnoughMemoryForBackForwardCache() is false, we allow all // URLs as default. {features::kBackForwardCache, features::kBackForwardCacheMemoryControls}); } ~RecordBackForwardCacheMetricsWithoutEnabling() override = default; private: base::test::ScopedFeatureList scoped_feature_list_; }; IN_PROC_BROWSER_TEST_F(RecordBackForwardCacheMetricsWithoutEnabling, ReloadsAndHistoryNavigations) { base::HistogramTester histogram_tester; GURL url1(embedded_test_server()->GetURL( "a.allowed", "/back_forward_cache/allowed_path.html")); GURL url2(embedded_test_server()->GetURL( "b.disallowed", "/back_forward_cache/disallowed_path.html")); // 1) Navigate to url1. EXPECT_TRUE(NavigateToURL(shell(), url1)); // 2) Navigate to url2. EXPECT_TRUE(NavigateToURL(shell(), url2)); // 3) Go back to url1 and reload. ASSERT_TRUE(HistoryGoBack(web_contents())); web_contents()->GetController().Reload(content::ReloadType::NORMAL, false); EXPECT_TRUE(WaitForLoadStop(web_contents())); // 4) Go forward to url2 and reload. web_contents()->GetController().GoForward(); EXPECT_TRUE(WaitForLoadStop(web_contents())); web_contents()->GetController().Reload(content::ReloadType::NORMAL, false); EXPECT_TRUE(WaitForLoadStop(web_contents())); } IN_PROC_BROWSER_TEST_P(BackForwardCacheMetricsBrowserTest, RecordReloadsAfterHistoryNavigation) { if (!IsBackForwardCacheEnabled()) { return; } base::HistogramTester histogram_tester; GURL url1(embedded_test_server()->GetURL("a.com", "/title1.html")); GURL url2(embedded_test_server()->GetURL("b.com", "/title2.html")); GURL url3(embedded_test_server()->GetURL("c.com", "/title3.html")); // 1) Navigate to url1 and reload. EXPECT_TRUE(NavigateToURL(shell(), url1)); web_contents()->GetController().Reload(content::ReloadType::NORMAL, false); EXPECT_TRUE(WaitForLoadStop(web_contents())); // 2) Navigate to url2. EXPECT_TRUE(NavigateToURL(shell(), url2)); // 3) Go back to url1 and reload. ASSERT_TRUE(HistoryGoBack(web_contents())); web_contents()->GetController().Reload(content::ReloadType::NORMAL, false); EXPECT_TRUE(WaitForLoadStop(web_contents())); // 4) Go forward to url2 and reload twice. web_contents()->GetController().GoForward(); EXPECT_TRUE(WaitForLoadStop(web_contents())); web_contents()->GetController().Reload(content::ReloadType::NORMAL, false); EXPECT_TRUE(WaitForLoadStop(web_contents())); web_contents()->GetController().Reload(content::ReloadType::NORMAL, false); EXPECT_TRUE(WaitForLoadStop(web_contents())); // 5) Go back and navigate to url3. ASSERT_TRUE(HistoryGoBack(web_contents())); RenderFrameHostImpl* rfh_url1 = web_contents()->GetPrimaryFrameTree().root()->current_frame_host(); // Make url1 ineligible for caching so that when we navigate back it doesn't // fetch the RenderFrameHost from the back/forward cache. DisableBFCacheForRFHForTesting(rfh_url1); EXPECT_TRUE(NavigateToURL(shell(), url3)); // 6) Go back and reload. // Ensure that "not served" is recorded. ASSERT_TRUE(HistoryGoBack(web_contents())); web_contents()->GetController().Reload(content::ReloadType::NORMAL, false); EXPECT_TRUE(WaitForLoadStop(web_contents())); } IN_PROC_BROWSER_TEST_P(BackForwardCacheMetricsBrowserTest, RestoreNavigationToNextPaint) { if (!IsBackForwardCacheEnabled()) { return; } base::HistogramTester histogram_tester; const char kRestoreNavigationToNextPaintTimeHistogram[] = "BackForwardCache.Restore.NavigationToFirstPaint"; GURL url1(embedded_test_server()->GetURL("a.com", "/title1.html")); GURL url2(embedded_test_server()->GetURL("b.com", "/title2.html")); EXPECT_THAT(histogram_tester.GetAllSamples( kRestoreNavigationToNextPaintTimeHistogram), testing::IsEmpty()); // 1) Navigate to url1. EXPECT_TRUE(NavigateToURL(shell(), url1)); RenderFrameHostImpl* rfh_a = current_frame_host(); RenderFrameDeletedObserver delete_observer_rfh_a(rfh_a); // 2) Navigate to url2. EXPECT_TRUE(NavigateToURL(shell(), url2)); EXPECT_FALSE(delete_observer_rfh_a.deleted()); EXPECT_TRUE(rfh_a->IsInBackForwardCache()); // 3) Go back to url1 and check if the metrics are recorded. Make sure the // page is restored from cache. ASSERT_TRUE(HistoryGoBack(web_contents())); EXPECT_EQ(rfh_a, current_frame_host()); EXPECT_EQ(shell()->web_contents()->GetVisibility(), Visibility::VISIBLE); // Verify if the NavigationToFirstPaint metric was recorded on restore. do { FetchHistogramsFromChildProcesses(); GiveItSomeTime(); } while ( histogram_tester.GetAllSamples(kRestoreNavigationToNextPaintTimeHistogram) .empty()); } // Tests that non-history/reload navigations that potentially match an entry in // BFCache are logged in the relevant histogram. IN_PROC_BROWSER_TEST_P(BackForwardCacheMetricsBrowserTest, NewPageNavHasPotentialMatch) { if (!IsBackForwardCacheEnabled()) { return; } base::HistogramTester histogram_tester; const char kNewPageNavHasPotentialMatchHistogram[] = "BackForwardCache.NewPageNavHasPotentialMatch"; const char kNewPageNavHasPotentialMatchWithNoSubframesHistogram[] = "BackForwardCache.NewPageNavHasPotentialMatchWithNoSubframes"; const char kHistoryNavHasPotentialMatchHistogram[] = "BackForwardCache.HistoryNavHasPotentialMatch"; GURL url1(embedded_test_server()->GetURL("a.com", "/page_with_iframe.html")); GURL url2(embedded_test_server()->GetURL("b.com", "/title2.html")); // 1) Navigate to url1, which has a subframe. EXPECT_TRUE(NavigateToURL(shell(), url1)); RenderFrameHostImpl* rfh_a = current_frame_host(); // There should be no matching entry for `url1` in the back/forward cache. histogram_tester.ExpectBucketCount(kNewPageNavHasPotentialMatchHistogram, false, 1); histogram_tester.ExpectBucketCount(kNewPageNavHasPotentialMatchHistogram, true, 0); histogram_tester.ExpectBucketCount( kNewPageNavHasPotentialMatchWithNoSubframesHistogram, false, 1); histogram_tester.ExpectBucketCount( kNewPageNavHasPotentialMatchWithNoSubframesHistogram, true, 0); histogram_tester.ExpectBucketCount(kHistoryNavHasPotentialMatchHistogram, false, 0); histogram_tester.ExpectBucketCount(kHistoryNavHasPotentialMatchHistogram, true, 0); // 2) Navigate to url2. The `url1` page will be BFCached. EXPECT_TRUE(NavigateToURL(shell(), url2)); EXPECT_TRUE(rfh_a->IsInBackForwardCache()); // There should be no matching entry for `url2` in the back/forward cache. histogram_tester.ExpectBucketCount(kNewPageNavHasPotentialMatchHistogram, false, 2); histogram_tester.ExpectBucketCount(kNewPageNavHasPotentialMatchHistogram, true, 0); histogram_tester.ExpectBucketCount( kNewPageNavHasPotentialMatchWithNoSubframesHistogram, false, 2); histogram_tester.ExpectBucketCount( kNewPageNavHasPotentialMatchWithNoSubframesHistogram, true, 0); histogram_tester.ExpectBucketCount(kHistoryNavHasPotentialMatchHistogram, false, 0); histogram_tester.ExpectBucketCount(kHistoryNavHasPotentialMatchHistogram, true, 0); // 3) Navigate to url1 again as a new page. EXPECT_TRUE(NavigateToURL(shell(), url1)); // There is a matching entry for `url1` in the back/forward cache. Note that // because the entry has a subframe, it will be recorded as "no match" in the // "no subframes" histogram. histogram_tester.ExpectBucketCount(kNewPageNavHasPotentialMatchHistogram, false, 2); histogram_tester.ExpectBucketCount(kNewPageNavHasPotentialMatchHistogram, true, 1); histogram_tester.ExpectBucketCount( kNewPageNavHasPotentialMatchWithNoSubframesHistogram, false, 3); histogram_tester.ExpectBucketCount( kNewPageNavHasPotentialMatchWithNoSubframesHistogram, true, 0); histogram_tester.ExpectBucketCount(kHistoryNavHasPotentialMatchHistogram, false, 0); histogram_tester.ExpectBucketCount(kHistoryNavHasPotentialMatchHistogram, true, 0); // 4) Navigate back to url2, restoring it from back/forward cache. EXPECT_TRUE(HistoryGoBack(web_contents())); // As the navigation is a BFCache restore already, no entry is recorded in the // histogram. histogram_tester.ExpectBucketCount(kNewPageNavHasPotentialMatchHistogram, false, 2); histogram_tester.ExpectBucketCount(kNewPageNavHasPotentialMatchHistogram, true, 1); histogram_tester.ExpectBucketCount( kNewPageNavHasPotentialMatchWithNoSubframesHistogram, false, 3); histogram_tester.ExpectBucketCount( kNewPageNavHasPotentialMatchWithNoSubframesHistogram, true, 0); histogram_tester.ExpectBucketCount(kHistoryNavHasPotentialMatchHistogram, false, 0); histogram_tester.ExpectBucketCount(kHistoryNavHasPotentialMatchHistogram, true, 0); // Flush BFCached entries so that there are no BFCached pages. web_contents()->GetController().GetBackForwardCache().Flush(); // 5) Navigate back to url1 without restoring from back/forward cache. EXPECT_TRUE(HistoryGoBack(web_contents())); // The navigation has no matching BFCached entry, but it's also a history // navigation, so we will only record on the history histogram. histogram_tester.ExpectBucketCount(kNewPageNavHasPotentialMatchHistogram, false, 2); histogram_tester.ExpectBucketCount(kNewPageNavHasPotentialMatchHistogram, true, 1); histogram_tester.ExpectBucketCount( kNewPageNavHasPotentialMatchWithNoSubframesHistogram, false, 3); histogram_tester.ExpectBucketCount( kNewPageNavHasPotentialMatchWithNoSubframesHistogram, true, 0); histogram_tester.ExpectBucketCount(kHistoryNavHasPotentialMatchHistogram, false, 1); histogram_tester.ExpectBucketCount(kHistoryNavHasPotentialMatchHistogram, true, 0); // 5) Reload `url1`. web_contents()->GetController().Reload(ReloadType::NORMAL, false); EXPECT_TRUE(WaitForLoadStop(shell()->web_contents())); // The navigation has no matching BFCached entry, but it's also a reload, so // we don't record anything in the histograms. histogram_tester.ExpectBucketCount(kNewPageNavHasPotentialMatchHistogram, false, 2); histogram_tester.ExpectBucketCount(kNewPageNavHasPotentialMatchHistogram, true, 1); histogram_tester.ExpectBucketCount( kNewPageNavHasPotentialMatchWithNoSubframesHistogram, false, 3); histogram_tester.ExpectBucketCount( kNewPageNavHasPotentialMatchWithNoSubframesHistogram, true, 0); histogram_tester.ExpectBucketCount(kHistoryNavHasPotentialMatchHistogram, false, 1); histogram_tester.ExpectBucketCount(kHistoryNavHasPotentialMatchHistogram, true, 0); } class BackForwardCacheMetricsPrerenderingBrowserTest : public BackForwardCacheMetricsBrowserTest { public: BackForwardCacheMetricsPrerenderingBrowserTest() : prerender_helper_(base::BindRepeating( &BackForwardCacheMetricsPrerenderingBrowserTest::web_contents, base::Unretained(this))) {} ~BackForwardCacheMetricsPrerenderingBrowserTest() override = default; test::PrerenderTestHelper* prerender_helper() { return &prerender_helper_; } WebContents* web_contents() { return shell()->web_contents(); } private: test::PrerenderTestHelper prerender_helper_; }; // Tests that activating a prerender works correctly when navigated // back. IN_PROC_BROWSER_TEST_P(BackForwardCacheMetricsPrerenderingBrowserTest, MainFrameNavigation) { ukm::TestAutoSetUkmRecorder recorder; const GURL url1(embedded_test_server()->GetURL( "/back_forward_cache/page_with_pageshow.html")); const GURL prerender_url(embedded_test_server()->GetURL("/title1.html")); const GURL url2(embedded_test_server()->GetURL("/title2.html")); EXPECT_TRUE(NavigateToURL(shell(), url1)); // Loads a page in the prerender. PrerenderHostId host_id = prerender_helper()->AddPrerender(prerender_url); test::PrerenderHostObserver host_observer(*web_contents(), host_id); RenderFrameHost* prerender_rfh = prerender_helper()->GetPrerenderedMainFrameHost(host_id); EXPECT_TRUE(WaitForRenderFrameReady(prerender_rfh)); // Activates the page from the prerendering. prerender_helper()->NavigatePrimaryPage(prerender_url); // Makes sure that the page is activated from the prerendering. EXPECT_TRUE(host_observer.was_activated()); EXPECT_TRUE(WaitForRenderFrameReady(web_contents()->GetPrimaryMainFrame())); EXPECT_TRUE(NavigateToURL(shell(), url2)); { TestNavigationObserver navigation_observer(shell()->web_contents()); shell()->GoBackOrForward(-1); navigation_observer.WaitForNavigationFinished(); } // The navigations observed should be: // 1) url1 // 2) prerender_url (prerender) // 3) prerender_url (activate prerender) // 4) url2 // 5) prerender_url (back navigation) ASSERT_EQ(navigation_ids_.size(), static_cast(5)); ukm::SourceId id5 = ToSourceId(navigation_ids_[4]); // We should only record metrics for the last navigation. EXPECT_THAT(GetMetricsSourceIds(&recorder), testing::ElementsAre(id5)); } class BackForwardCacheMetricsFencedFrameBrowserTest : public BackForwardCacheMetricsBrowserTest { public: BackForwardCacheMetricsFencedFrameBrowserTest() = default; ~BackForwardCacheMetricsFencedFrameBrowserTest() override = default; test::FencedFrameTestHelper& fenced_frame_test_helper() { return fenced_frame_test_helper_; } private: test::FencedFrameTestHelper fenced_frame_test_helper_; }; // Tests that fenced frame navigation doesn't have BackForwardCacheMetrics. IN_PROC_BROWSER_TEST_P(BackForwardCacheMetricsFencedFrameBrowserTest, FenceFrameNavigation) { ukm::TestAutoSetUkmRecorder recorder; const GURL url1(embedded_test_server()->GetURL("/title1.html")); const GURL fenced_frame_url1( embedded_test_server()->GetURL("/fenced_frames/title1.html")); const GURL url2(embedded_test_server()->GetURL("/title2.html")); EXPECT_TRUE(NavigateToURL(shell(), url1)); auto* fenced_frame = fenced_frame_test_helper().CreateFencedFrame( web_contents()->GetPrimaryMainFrame(), fenced_frame_url1); NavigationEntryImpl* fenced_frame_entry = FrameTreeNode::From(fenced_frame) ->frame_tree() .controller() .GetLastCommittedEntry(); EXPECT_EQ(fenced_frame_entry->back_forward_cache_metrics(), nullptr); EXPECT_TRUE(NavigateToURL(shell(), url2)); // Navigate back to `url1`. ASSERT_TRUE(HistoryGoBack(shell()->web_contents())); // The navigations observed should be: // 1) url1 // 2) fenced_frame_url1 // 3) url2 // 4) url1 (back navigation) ASSERT_EQ(navigation_ids_.size(), static_cast(4)); ukm::SourceId id4 = ToSourceId(navigation_ids_[3]); // We should only record metrics for the last navigation. EXPECT_THAT(GetMetricsSourceIds(&recorder), testing::ElementsAre(id4)); } INSTANTIATE_TEST_SUITE_P(All, BackForwardCacheMetricsBrowserTest, testing::ValuesIn({BackForwardCacheStatus::kDisabled, BackForwardCacheStatus::kEnabled}), BackForwardCacheMetricsBrowserTest::DescribeParams); INSTANTIATE_TEST_SUITE_P(All, BackForwardCacheMetricsPrerenderingBrowserTest, testing::ValuesIn({BackForwardCacheStatus::kDisabled, BackForwardCacheStatus::kEnabled}), BackForwardCacheMetricsBrowserTest::DescribeParams); INSTANTIATE_TEST_SUITE_P(All, BackForwardCacheMetricsFencedFrameBrowserTest, testing::ValuesIn({BackForwardCacheStatus::kDisabled, BackForwardCacheStatus::kEnabled}), BackForwardCacheMetricsBrowserTest::DescribeParams); } // namespace content