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
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
content / browser / renderer_host / back_forward_cache_metrics_browsertest.cc [blame]
// 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/renderer_host/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/renderer_host/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 "services/device/public/cpp/test/scoped_geolocation_overrider.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/common/scheduler/web_scheduler_tracked_feature.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);
}
// Some features are present in almost all page loads (especially the ones
// which are related to the document finishing loading).
// We ignore them to make tests easier to read and write.
blink::scheduler::WebSchedulerTrackedFeatures GetFeaturesToIgnore() {
return {blink::scheduler::WebSchedulerTrackedFeature::kDocumentLoaded,
blink::scheduler::WebSchedulerTrackedFeature::
kOutstandingNetworkRequestFetch,
blink::scheduler::WebSchedulerTrackedFeature::
kOutstandingNetworkRequestXHR,
blink::scheduler::WebSchedulerTrackedFeature::
kOutstandingNetworkRequestOthers};
}
using UkmMetrics = ukm::TestUkmRecorder::HumanReadableUkmMetrics;
using UkmEntry = ukm::TestUkmRecorder::HumanReadableUkmEntry;
enum BackForwardCacheStatus { kDisabled = 0, kEnabled = 1 };
} // namespace
class BackForwardCacheMetricsBrowserTestBase : public ContentBrowserTest,
public WebContentsObserver {
public:
BackForwardCacheMetricsBrowserTestBase() {
geolocation_override_ =
std::make_unique<device::ScopedGeolocationOverrider>(1.0, 1.0);
}
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<WebContentsImpl*>(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());
}
void NavigateAndWaitForDisablingFeature(
const GURL& url,
blink::scheduler::WebSchedulerTrackedFeature feature) {
class BfcacheDisabledByFeatureWaiter
: public blink::mojom::
BackForwardCacheControllerHostInterceptorForTesting {
public:
explicit BfcacheDisabledByFeatureWaiter(
RenderFrameHostImpl* render_frame_host,
blink::scheduler::WebSchedulerTrackedFeature expected_feature)
: render_frame_host_(render_frame_host),
swapped_impl_(
render_frame_host
->back_forward_cache_controller_host_receiver_for_testing(),
this),
expected_feature_(expected_feature) {}
void Wait() { run_loop_.Run(); }
// BackForwardCacheControllerHostInterceptorForTesting overrides:
blink::mojom::BackForwardCacheControllerHost* GetForwardingInterface()
override {
return swapped_impl_.old_impl();
}
// BackForwardCacheControllerHost overrides:
void DidChangeBackForwardCacheDisablingFeatures(
RenderFrameHostImpl::BackForwardCacheBlockingDetails details)
override {
GetForwardingInterface()->DidChangeBackForwardCacheDisablingFeatures(
std::move(details));
if (render_frame_host_->GetBackForwardCacheDisablingFeatures().Has(
expected_feature_)) {
run_loop_.Quit();
}
}
private:
base::RunLoop run_loop_;
const raw_ptr<RenderFrameHostImpl> render_frame_host_;
mojo::test::ScopedSwapImplForTesting<
blink::mojom::BackForwardCacheControllerHost>
swapped_impl_;
const blink::scheduler::WebSchedulerTrackedFeature expected_feature_;
};
{
BfcacheDisabledByFeatureWaiter waiter(current_frame_host(), feature);
EXPECT_TRUE(NavigateToURL(shell(), url));
waiter.Wait();
}
EXPECT_EQ(base::Difference(
current_frame_host()->GetBackForwardCacheDisablingFeatures(),
GetFeaturesToIgnore()),
blink::scheduler::WebSchedulerTrackedFeatures({feature}));
// Close the web contents to ensure that no new notifications arrive to the
// function local callback above after this function has returned.
web_contents()->Close();
}
std::vector<int64_t> navigation_ids_;
private:
std::unique_ptr<device::ScopedGeolocationOverrider> geolocation_override_;
};
class BackForwardCacheMetricsBrowserTest
: public BackForwardCacheMetricsBrowserTestBase,
public testing::WithParamInterface<BackForwardCacheStatus> {
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<ParamType>& 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<size_t>(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<WebContents> new_tab = shell()->web_contents()->Clone();
WebContentsImpl* new_tab_impl = static_cast<WebContentsImpl*>(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<size_t>(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<ukm::TestAutoSetUkmRecorder::HumanReadableUkmMetrics>
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<int>(
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<ukm::TestAutoSetUkmRecorder::HumanReadableUkmMetrics>
recorded_not_restored_reasons =
recorder.FilteredHumanReadableMetricForEntry("HistoryNavigation",
not_restored_reasons);
EXPECT_EQ(recorded_not_restored_reasons[0][not_restored_reasons],
1 << static_cast<int>(
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<NotRestoredReason> 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<ukm::TestAutoSetUkmRecorder::HumanReadableUkmMetrics>
recorded_not_restored_reasons =
recorder.FilteredHumanReadableMetricForEntry("HistoryNavigation",
not_restored_reasons2);
EXPECT_EQ(recorded_not_restored_reasons.back()[not_restored_reasons2],
1 << (static_cast<int>(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<size_t>(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<size_t>(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<size_t>(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<size_t>(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<ukm::SourceId> GetMetricsSourceIds(
ukm::TestAutoSetUkmRecorder* recorder) {
std::vector<ukm::SourceId> 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<size_t>(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<size_t>(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<size_t>(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<size_t>(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));
}
// TODO(crbug.com/40290702): Shared workers are not available on Android.
#if BUILDFLAG(IS_ANDROID)
#define MAYBE_SharedWorker DISABLED_SharedWorker
#else
#define MAYBE_SharedWorker SharedWorker
#endif
IN_PROC_BROWSER_TEST_P(BackForwardCacheMetricsBrowserTest, MAYBE_SharedWorker) {
const GURL url(embedded_test_server()->GetURL(
"/back_forward_cache/page_with_shared_worker.html"));
NavigateAndWaitForDisablingFeature(
url, blink::scheduler::WebSchedulerTrackedFeature::kSharedWorker);
}
IN_PROC_BROWSER_TEST_P(BackForwardCacheMetricsBrowserTest, Geolocation) {
const GURL url1(embedded_test_server()->GetURL("/title1.html"));
EXPECT_TRUE(NavigateToURL(shell(), url1));
RenderFrameHostImpl* main_frame = static_cast<RenderFrameHostImpl*>(
shell()->web_contents()->GetPrimaryMainFrame());
EXPECT_EQ("success", EvalJs(main_frame, R"(
new Promise(resolve => {
navigator.geolocation.getCurrentPosition(
resolve.bind(this, "success"),
resolve.bind(this, "failure"))
});
)"));
}
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.
FrameTreeNodeId 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<size_t>(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<size_t>(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