-
Notifications
You must be signed in to change notification settings - Fork 6.6k
/
page_load_tracker.cc
1411 lines (1247 loc) · 53.8 KB
/
page_load_tracker.cc
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
// Copyright 2016 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "components/page_load_metrics/browser/page_load_tracker.h"
#include <algorithm>
#include <memory>
#include <ostream>
#include <string>
#include <utility>
#include "base/check_op.h"
#include "base/metrics/histogram_functions.h"
#include "base/metrics/histogram_macros.h"
#include "base/notreached.h"
#include "base/strings/stringprintf.h"
#include "base/time/default_tick_clock.h"
#include "base/trace_event/trace_event.h"
#include "components/page_load_metrics/browser/page_load_metrics_embedder_interface.h"
#include "components/page_load_metrics/browser/page_load_metrics_forward_observer.h"
#include "components/page_load_metrics/browser/page_load_metrics_memory_tracker.h"
#include "components/page_load_metrics/browser/page_load_metrics_observer.h"
#include "components/page_load_metrics/browser/page_load_metrics_util.h"
#include "components/page_load_metrics/common/page_load_timing.h"
#include "content/public/browser/navigation_details.h"
#include "content/public/browser/navigation_handle.h"
#include "content/public/browser/render_frame_host.h"
#include "content/public/browser/render_process_host.h"
#include "content/public/browser/web_contents.h"
#include "content/public/browser/web_contents_observer.h"
#include "services/metrics/public/cpp/ukm_source_id.h"
namespace page_load_metrics {
namespace internal {
const char kErrorEvents[] = "PageLoad.Internal.ErrorCode";
const char kPageLoadPrerender2Event[] = "PageLoad.Internal.Prerender2.Event";
const char kPageLoadPrerender2VisibilityAtActivation[] =
"PageLoad.Internal.Prerender2.VisibilityAtActivation";
const char kPageLoadTrackerPageType[] = "PageLoad.Internal.PageType";
const char kImageLoadStartLessThanDocumentTTFB[] =
"PageLoad.PaintTiming.NavigationToLargestContentfulPaint."
"ImageLoadStartLessThanDocumentTTFB";
const char kImageLoadEndLessThanLoadStart[] =
"PageLoad.PaintTiming.NavigationToLargestContentfulPaint."
"ImageLoadEndLessThanLoadStart";
const char kImageLCPLessThanLoadEnd[] =
"PageLoad.PaintTiming.NavigationToLargestContentfulPaint."
"ImageLCPLessThanLoadEnd";
const char kImageLoadStartLessThanDocumentTtfbCause[] =
"PageLoad.PaintTiming.NavigationToLargestContentfulPaint."
"ImageLoadStartLessThanDocumentTtfbCauses";
} // namespace internal
void RecordInternalError(InternalErrorLoadEvent event) {
base::UmaHistogramEnumeration(internal::kErrorEvents, event, ERR_LAST_ENTRY);
}
void RecordPageType(internal::PageLoadTrackerPageType type) {
base::UmaHistogramEnumeration(internal::kPageLoadTrackerPageType, type);
}
void RecordImageLoadStartLessThanDocumentTtfbCause(
page_load_metrics::internal::ImageLoadStartLessThanDocumentTtfbCause
sample) {
base::UmaHistogramEnumeration(
internal::kImageLoadStartLessThanDocumentTtfbCause, sample);
}
void RecordLargestContentfulPaintImageLoadTiming(
const page_load_metrics::mojom::LargestContentfulPaintTiming&
largest_contentful_paint,
base::TimeDelta document_ttfb) {
if (largest_contentful_paint.largest_image_load_start.has_value()) {
UMA_HISTOGRAM_BOOLEAN(
internal::kImageLoadStartLessThanDocumentTTFB,
largest_contentful_paint.largest_image_load_start < document_ttfb);
}
if (largest_contentful_paint.largest_image_load_start.has_value() &&
largest_contentful_paint.largest_image_load_end.has_value()) {
UMA_HISTOGRAM_BOOLEAN(
internal::kImageLoadEndLessThanLoadStart,
largest_contentful_paint.largest_image_load_end <
largest_contentful_paint.largest_image_load_start);
}
if (largest_contentful_paint.largest_image_load_end.has_value() &&
largest_contentful_paint.largest_image_paint.has_value()) {
UMA_HISTOGRAM_BOOLEAN(internal::kImageLCPLessThanLoadEnd,
largest_contentful_paint.largest_image_paint <
largest_contentful_paint.largest_image_load_end);
}
// If the images load_start is less than document_ttfb, then something may be
// wrong with the metric. Attempt to diagnose the cause and record it to UMA,
// or report 'Unknown' if no cause is identified. This code may be removed
// when https://crbug.com/1431906 is resolved.
if (largest_contentful_paint.largest_image_load_start.has_value() &&
largest_contentful_paint.largest_image_load_start < document_ttfb) {
if (largest_contentful_paint.is_loaded_from_memory_cache &&
largest_contentful_paint.is_preloaded_with_early_hints) {
RecordImageLoadStartLessThanDocumentTtfbCause(
internal::ImageLoadStartLessThanDocumentTtfbCause::
kLoadedFromMemoryCacheAndPreloadedWithEarlyHints);
} else if (largest_contentful_paint.is_loaded_from_memory_cache) {
RecordImageLoadStartLessThanDocumentTtfbCause(
internal::ImageLoadStartLessThanDocumentTtfbCause::
kLoadedFromMemoryCache);
} else if (largest_contentful_paint.is_preloaded_with_early_hints) {
RecordImageLoadStartLessThanDocumentTtfbCause(
internal::ImageLoadStartLessThanDocumentTtfbCause::
kPreloadedWithEarlyHints);
} else {
RecordImageLoadStartLessThanDocumentTtfbCause(
internal::ImageLoadStartLessThanDocumentTtfbCause::kUnknown);
}
}
}
// TODO(csharrison): Add a case for client side redirects, which is what JS
// initiated window.location / window.history navigations get set to.
PageEndReason EndReasonForPageTransition(ui::PageTransition transition) {
if (transition & ui::PAGE_TRANSITION_CLIENT_REDIRECT) {
return END_CLIENT_REDIRECT;
}
// Check for forward/back navigations first since there are forward/back
// navigations that haved PAGE_TRANSITION_RELOAD but are not user reloads
// (pull-to-refresh or preview opt-out).
if (transition & ui::PAGE_TRANSITION_FORWARD_BACK)
return END_FORWARD_BACK;
if (ui::PageTransitionCoreTypeIs(transition, ui::PAGE_TRANSITION_RELOAD))
return END_RELOAD;
if (ui::PageTransitionIsNewNavigation(transition))
return END_NEW_NAVIGATION;
NOTREACHED()
<< "EndReasonForPageTransition received unexpected ui::PageTransition: "
<< transition;
return END_OTHER;
}
bool IsNavigationUserInitiated(content::NavigationHandle* handle) {
// TODO(crbug.com/617904): Browser initiated navigations should have
// HasUserGesture() set to true. In the meantime, we consider all
// browser-initiated navigations to be user initiated.
//
// TODO(crbug.com/637345): Some browser-initiated navigations incorrectly
// report that they are renderer-initiated. We will currently report that
// these navigations are not user initiated, when in fact they are user
// initiated.
return handle->HasUserGesture() || !handle->IsRendererInitiated();
}
namespace {
void DispatchEventsAfterBackForwardCacheRestore(
PageLoadMetricsObserverInterface* observer,
const std::vector<mojo::StructPtr<mojom::BackForwardCacheTiming>>&
last_timings,
const std::vector<mojo::StructPtr<mojom::BackForwardCacheTiming>>&
new_timings) {
if (new_timings.size() < last_timings.size()) {
mojo::ReportBadMessage(base::StringPrintf(
"`new_timings.size()` (%zu) must be equal to or greater than "
"`last_timings.size()` (%zu) but is not",
new_timings.size(), last_timings.size()));
return;
}
for (size_t i = 0; i < new_timings.size(); i++) {
auto first_paint =
new_timings[i]->first_paint_after_back_forward_cache_restore;
if (!first_paint.is_zero() &&
(i >= last_timings.size() ||
last_timings[i]
->first_paint_after_back_forward_cache_restore.is_zero())) {
observer->OnFirstPaintAfterBackForwardCacheRestoreInPage(*new_timings[i],
i);
}
auto request_animation_frames =
new_timings[i]
->request_animation_frames_after_back_forward_cache_restore;
if (request_animation_frames.size() == 3 &&
(i >= last_timings.size() ||
last_timings[i]
->request_animation_frames_after_back_forward_cache_restore
.empty())) {
observer->OnRequestAnimationFramesAfterBackForwardCacheRestoreInPage(
*new_timings[i], i);
}
auto first_input_delay =
new_timings[i]->first_input_delay_after_back_forward_cache_restore;
if (first_input_delay.has_value() &&
(i >= last_timings.size() ||
!last_timings[i]
->first_input_delay_after_back_forward_cache_restore
.has_value())) {
observer->OnFirstInputAfterBackForwardCacheRestoreInPage(*new_timings[i],
i);
}
}
}
void DispatchObserverTimingCallbacks(PageLoadMetricsObserverInterface* observer,
const mojom::PageLoadTiming& last_timing,
const mojom::PageLoadTiming& new_timing) {
if (!last_timing.Equals(new_timing))
observer->OnTimingUpdate(nullptr, new_timing);
if (new_timing.document_timing->dom_content_loaded_event_start &&
!last_timing.document_timing->dom_content_loaded_event_start) {
observer->OnDomContentLoadedEventStart(new_timing);
}
if (new_timing.document_timing->load_event_start &&
!last_timing.document_timing->load_event_start) {
observer->OnLoadEventStart(new_timing);
}
if (new_timing.interactive_timing->first_input_delay &&
!last_timing.interactive_timing->first_input_delay) {
observer->OnFirstInputInPage(new_timing);
}
if (new_timing.paint_timing->first_paint &&
!last_timing.paint_timing->first_paint) {
observer->OnFirstPaintInPage(new_timing);
}
DispatchEventsAfterBackForwardCacheRestore(
observer, last_timing.back_forward_cache_timings,
new_timing.back_forward_cache_timings);
if (new_timing.paint_timing->first_image_paint &&
!last_timing.paint_timing->first_image_paint) {
observer->OnFirstImagePaintInPage(new_timing);
}
if (new_timing.paint_timing->first_contentful_paint &&
!last_timing.paint_timing->first_contentful_paint) {
observer->OnFirstContentfulPaintInPage(new_timing);
}
if (new_timing.paint_timing->first_meaningful_paint &&
!last_timing.paint_timing->first_meaningful_paint) {
observer->OnFirstMeaningfulPaintInMainFrameDocument(new_timing);
}
if (new_timing.parse_timing->parse_start &&
!last_timing.parse_timing->parse_start) {
observer->OnParseStart(new_timing);
}
if (new_timing.parse_timing->parse_stop &&
!last_timing.parse_timing->parse_stop) {
observer->OnParseStop(new_timing);
}
}
internal::PageLoadTrackerPageType CalculatePageType(
const content::NavigationHandle* navigation_handle) {
if (navigation_handle->IsInPrerenderedMainFrame()) {
return internal::PageLoadTrackerPageType::kPrerenderPage;
} else if (navigation_handle->GetNavigatingFrameType() ==
content::FrameType::kFencedFrameRoot) {
return internal::PageLoadTrackerPageType::kFencedFramesPage;
}
return internal::PageLoadTrackerPageType::kPrimaryPage;
}
} // namespace
PageLoadTracker::PageLoadTracker(
bool in_foreground,
PageLoadMetricsEmbedderInterface* embedder_interface,
const GURL& currently_committed_url,
bool is_first_navigation_in_web_contents,
content::NavigationHandle* navigation_handle,
UserInitiatedInfo user_initiated_info,
ukm::SourceId source_id,
base::WeakPtr<PageLoadTracker> parent_tracker)
: did_stop_tracking_(false),
navigation_start_(navigation_handle->NavigationStart()),
url_(navigation_handle->GetURL()),
start_url_(navigation_handle->GetURL()),
visibility_tracker_(base::DefaultTickClock::GetInstance(), in_foreground),
did_commit_(false),
page_end_reason_(END_NONE),
page_end_user_initiated_info_(UserInitiatedInfo::NotUserInitiated()),
started_in_foreground_(in_foreground),
last_dispatched_merged_page_timing_(CreatePageLoadTiming()),
user_initiated_info_(user_initiated_info),
embedder_interface_(embedder_interface),
metrics_update_dispatcher_(this, navigation_handle, embedder_interface),
source_id_(source_id),
web_contents_(navigation_handle->GetWebContents()),
is_first_navigation_in_web_contents_(is_first_navigation_in_web_contents),
page_type_(CalculatePageType(navigation_handle)),
parent_tracker_(std::move(parent_tracker)) {
DCHECK(!navigation_handle->HasCommitted());
embedder_interface_->RegisterObservers(this);
switch (page_type_) {
case internal::PageLoadTrackerPageType::kPrimaryPage:
DCHECK_NE(ukm::kInvalidSourceId, source_id_);
InvokeAndPruneObservers(
"PageLoadMetricsObserver::OnStart",
base::BindRepeating(
[](content::NavigationHandle* navigation_handle,
const GURL& currently_committed_url,
bool started_in_foreground,
PageLoadMetricsObserverInterface* observer) {
return observer->OnStart(navigation_handle,
currently_committed_url,
started_in_foreground);
},
navigation_handle, currently_committed_url,
started_in_foreground_),
/*permit_forwarding=*/false);
break;
case internal::PageLoadTrackerPageType::kPrerenderPage:
DCHECK(!started_in_foreground_);
DCHECK_EQ(ukm::kInvalidSourceId, source_id_);
prerendering_state_ = PrerenderingState::kInPrerendering;
InvokeAndPruneObservers(
"PageLoadMetricsObserver::OnPrerenderStart",
base::BindRepeating(
[](content::NavigationHandle* navigation_handle,
const GURL& currently_committed_url,
PageLoadMetricsObserverInterface* observer) {
return observer->OnPrerenderStart(navigation_handle,
currently_committed_url);
},
navigation_handle, currently_committed_url),
/*permit_forwarding=*/false);
base::UmaHistogramEnumeration(
internal::kPageLoadPrerender2Event,
internal::PageLoadPrerenderEvent::kNavigationInPrerenderedMainFrame);
break;
case internal::PageLoadTrackerPageType::kFencedFramesPage:
DCHECK_NE(ukm::kInvalidSourceId, source_id_);
InvokeAndPruneObservers(
"PageLoadMetricsObserver::OnFencedFramesStart",
base::BindRepeating(
[](content::NavigationHandle* navigation_handle,
const GURL& currently_committed_url,
PageLoadMetricsObserverInterface* observer) {
return observer->OnFencedFramesStart(navigation_handle,
currently_committed_url);
},
navigation_handle, currently_committed_url),
/*permit_forwarding=*/true);
break;
}
RecordPageType(page_type_);
}
PageLoadTracker::~PageLoadTracker() {
if (did_stop_tracking_)
return;
metrics_update_dispatcher_.ShutDown();
if (page_end_time_.is_null()) {
// page_end_time_ can be unset in some cases, such as when a navigation is
// aborted by a navigation that started before it. In these cases, set the
// end time to the current time.
RecordInternalError(ERR_NO_PAGE_LOAD_END_TIME);
NotifyPageEnd(END_OTHER, UserInitiatedInfo::NotUserInitiated(),
base::TimeTicks::Now(), true);
}
if (!did_commit_) {
if (!failed_provisional_load_info_)
RecordInternalError(ERR_NO_COMMIT_OR_FAILED_PROVISIONAL_LOAD);
} else if (page_load_metrics::IsEmpty(metrics_update_dispatcher_.timing())) {
RecordInternalError(ERR_NO_IPCS_RECEIVED);
}
for (const auto& observer : observers_) {
if (failed_provisional_load_info_) {
observer->OnFailedProvisionalLoad(*failed_provisional_load_info_);
} else {
DCHECK(did_commit_);
observer->OnComplete(metrics_update_dispatcher_.timing());
}
}
}
void PageLoadTracker::PageHidden() {
// Only log the first time we background in a given page load.
if (!first_background_time_.has_value() ||
(!back_forward_cache_restores_.empty() &&
!back_forward_cache_restores_.back()
.first_background_time.has_value())) {
// The possible visibility state transitions and events are:
//
// A. navigation_start (fg) -> first background (bg)
// -> first foreground (fg)
// B. navigation_start (bg) -> first foreground (fg)
// -> first background (bg)
// C. navigation_start (bg) -> activation_start (fg)
// -> first background (bg) -> first foreground (fg)
//
// where fg = foreground, bg = background. A and B are non prerendered and C
// is prerendered.
//
// PageShown and PgaeHidden are not called for navigation_start and
// actiivation_start; called when the visibility is changed after
// navigation_start (resp. activation_start) for non prerendered (resp.
// prerendered) pages.
//
// Here we check that the first background follows some event in foreground.
if (!first_background_time_.has_value()) {
if (prerendering_state_ == PrerenderingState::kNoPrerendering) {
DCHECK_EQ(!started_in_foreground_, first_foreground_time_.has_value());
} else {
DCHECK(!first_foreground_time_.has_value());
}
}
base::TimeTicks background_time = base::TimeTicks::Now();
ClampBrowserTimestampIfInterProcessTimeTickSkew(&background_time);
DCHECK_GE(background_time, navigation_start_);
if (!first_background_time_.has_value())
first_background_time_ = background_time;
if (!back_forward_cache_restores_.empty() &&
!back_forward_cache_restores_.back()
.first_background_time.has_value()) {
back_forward_cache_restores_.back().first_background_time =
background_time -
back_forward_cache_restores_.back().navigation_start_time;
}
}
visibility_tracker_.OnHidden();
InvokeAndPruneObservers("PageLoadMetricsObserver::OnHidden",
base::BindRepeating(
[](const mojom::PageLoadTiming* timing,
PageLoadMetricsObserverInterface* observer) {
return observer->OnHidden(*timing);
},
&metrics_update_dispatcher_.timing()),
/*permit_forwarding=*/false);
}
void PageLoadTracker::PageShown() {
// Only log the first time we foreground in a given page load.
if (!first_foreground_time_.has_value()) {
// See comment about visibility state transitions in PageHidden.
//
// Here we check that the first foreground follows some event in background.
if (prerendering_state_ == PrerenderingState::kNoPrerendering) {
DCHECK_EQ(started_in_foreground_, first_background_time_.has_value());
} else {
DCHECK(first_background_time_.has_value());
}
base::TimeTicks foreground_time = base::TimeTicks::Now();
ClampBrowserTimestampIfInterProcessTimeTickSkew(&foreground_time);
DCHECK_GE(foreground_time, navigation_start_);
first_foreground_time_ = foreground_time;
}
visibility_tracker_.OnShown();
InvokeAndPruneObservers(
"PageLoadMetricsObserver::OnShown",
base::BindRepeating([](PageLoadMetricsObserverInterface* observer) {
return observer->OnShown();
}),
/*permit_forwarding=*/false);
}
void PageLoadTracker::RenderFrameDeleted(content::RenderFrameHost* rfh) {
if (parent_tracker_) {
// Notify the parent of a deletion of RenderFrameHost of a subframe.
parent_tracker_->RenderFrameDeleted(rfh);
}
for (const auto& observer : observers_) {
observer->OnRenderFrameDeleted(rfh);
}
}
void PageLoadTracker::FrameTreeNodeDeleted(int frame_tree_node_id) {
if (parent_tracker_) {
// Notify the parent of a deletion of FrameTreeNode of a subframe.
//
// Note that deletion of main frames are forwarded by
// MetrcisWebContentsObserver.
parent_tracker_->FrameTreeNodeDeleted(frame_tree_node_id);
}
metrics_update_dispatcher_.OnSubFrameDeleted(frame_tree_node_id);
largest_contentful_paint_handler_.OnSubFrameDeleted(frame_tree_node_id);
for (const auto& observer : observers_) {
observer->OnSubFrameDeleted(frame_tree_node_id);
}
}
void PageLoadTracker::WillProcessNavigationResponse(
content::NavigationHandle* navigation_handle) {
DCHECK(!navigation_request_id_.has_value());
navigation_request_id_ = navigation_handle->GetGlobalRequestID();
}
void PageLoadTracker::Commit(content::NavigationHandle* navigation_handle) {
// We don't deliver OnCommit() for activation. Prerendered pages will see
// DidActivatePrerenderedPage() instead.
// Event records below are also not needed as we did them for the initial
// navigation on starting prerendering.
DCHECK(!navigation_handle->IsPrerenderedPageActivation());
if (parent_tracker_) {
// Notify the parent of the inner main frame navigation as a sub-frame
// navigation.
parent_tracker_->DidFinishSubFrameNavigation(navigation_handle);
} else if (navigation_handle->IsPrerenderedPageActivation()) {
NOTREACHED();
// We don't deliver OnCommit() for activation. Prerendered pages will see
// DidActivatePrerenderedPage() instead.
// Event records below are also not needed as we did them for the initial
// navigation on starting prerendering.
return;
}
did_commit_ = true;
url_ = navigation_handle->GetURL();
// Some transitions (like CLIENT_REDIRECT) are only known at commit time.
user_initiated_info_.user_gesture = navigation_handle->HasUserGesture();
if (navigation_handle->IsInMainFrame()) {
largest_contentful_paint_handler_.RecordMainFrameTreeNodeId(
navigation_handle->GetFrameTreeNodeId());
experimental_largest_contentful_paint_handler_.RecordMainFrameTreeNodeId(
navigation_handle->GetFrameTreeNodeId());
}
InvokeAndPruneObservers(
"PageLoadMetricsObserver::ShouldObserveMimeType",
base::BindRepeating(
[](const std::string& mime_type,
PageLoadMetricsObserverInterface* observer) {
return observer->ShouldObserveMimeType(mime_type);
},
// Query with the outermost page's MIME type so that we can ask each
// observer with information for the page they are interested in.
navigation_handle->GetRenderFrameHost()
->GetOutermostMainFrameOrEmbedder()
->GetPage()
.GetContentsMimeType()),
/*permit_forwarding=*/false);
InvokeAndPruneObservers("PageLoadMetricsObserver::OnCommit",
base::BindRepeating(
[](content::NavigationHandle* navigation_handle,
PageLoadMetricsObserverInterface* observer) {
return observer->OnCommit(navigation_handle);
},
navigation_handle),
/*permit_forwarding=*/false);
}
void PageLoadTracker::DidActivatePrerenderedPage(
content::NavigationHandle* navigation_handle) {
DCHECK_EQ(prerendering_state_, PrerenderingState::kInPrerendering);
prerendering_state_ = PrerenderingState::kActivatedNoActivationStart;
source_id_ = ukm::ConvertToSourceId(navigation_handle->GetNavigationId(),
ukm::SourceIdType::NAVIGATION_ID);
switch (GetWebContents()->GetVisibility()) {
case content::Visibility::HIDDEN:
visibility_at_activation_ = PageVisibility::kBackground;
base::UmaHistogramEnumeration(
internal::kPageLoadPrerender2VisibilityAtActivation,
internal::VisibilityAtActivation::kHidden);
break;
case content::Visibility::OCCLUDED:
visibility_at_activation_ = PageVisibility::kBackground;
base::UmaHistogramEnumeration(
internal::kPageLoadPrerender2VisibilityAtActivation,
internal::VisibilityAtActivation::kOccluded);
break;
case content::Visibility::VISIBLE:
visibility_at_activation_ = PageVisibility::kForeground;
base::UmaHistogramEnumeration(
internal::kPageLoadPrerender2VisibilityAtActivation,
internal::VisibilityAtActivation::kVisible);
break;
}
for (const auto& observer : observers_)
observer->DidActivatePrerenderedPage(navigation_handle);
base::UmaHistogramEnumeration(
internal::kPageLoadPrerender2Event,
internal::PageLoadPrerenderEvent::kPrerenderActivationNavigation);
}
void PageLoadTracker::DidCommitSameDocumentNavigation(
content::NavigationHandle* navigation_handle) {
if (parent_tracker_) {
// Notify the parent of the inner main frame navigation as a sub-frame
// navigation.
parent_tracker_->DidFinishSubFrameNavigation(navigation_handle);
}
for (const auto& observer : observers_) {
observer->OnCommitSameDocumentNavigation(navigation_handle);
}
}
void PageLoadTracker::DidInternalNavigationAbort(
content::NavigationHandle* navigation_handle) {
if (parent_tracker_) {
// Notify the parent of the inner main frame navigation as a sub-frame
// navigation.
parent_tracker_->DidFinishSubFrameNavigation(navigation_handle);
}
for (const auto& observer : observers_) {
observer->OnDidInternalNavigationAbort(navigation_handle);
}
}
void PageLoadTracker::ReadyToCommitNavigation(
content::NavigationHandle* navigation_handle) {
// Don't notify the parent as inner main frame's events are converted to
// sub-frames events for the parent, but this event is only for the main
// frame.
for (const auto& observer : observers_) {
observer->ReadyToCommitNextNavigation(navigation_handle);
}
}
void PageLoadTracker::DidFinishSubFrameNavigation(
content::NavigationHandle* navigation_handle) {
if (parent_tracker_) {
// Notify the parent of inner frame navigations.
parent_tracker_->DidFinishSubFrameNavigation(navigation_handle);
}
metrics_update_dispatcher_.DidFinishSubFrameNavigation(navigation_handle);
largest_contentful_paint_handler_.OnDidFinishSubFrameNavigation(
navigation_handle, navigation_start_);
experimental_largest_contentful_paint_handler_.OnDidFinishSubFrameNavigation(
navigation_handle, navigation_start_);
for (const auto& observer : observers_) {
observer->OnDidFinishSubFrameNavigation(navigation_handle);
}
}
void PageLoadTracker::FailedProvisionalLoad(
content::NavigationHandle* navigation_handle,
base::TimeTicks failed_load_time) {
DCHECK(!failed_provisional_load_info_);
if (parent_tracker_) {
// Notify the parent of the inner main frame navigation as a sub-frame
// navigation.
parent_tracker_->DidFinishSubFrameNavigation(navigation_handle);
}
failed_provisional_load_info_ = std::make_unique<FailedProvisionalLoadInfo>(
failed_load_time - navigation_handle->NavigationStart(),
navigation_handle->GetNetErrorCode());
}
void PageLoadTracker::Redirect(content::NavigationHandle* navigation_handle) {
url_ = navigation_handle->GetURL();
InvokeAndPruneObservers("PageLoadMetricsObserver::Redirect",
base::BindRepeating(
[](content::NavigationHandle* navigation_handle,
PageLoadMetricsObserverInterface* observer) {
return observer->OnRedirect(navigation_handle);
},
navigation_handle),
/*permit_forwarding=*/false);
}
void PageLoadTracker::OnInputEvent(const blink::WebInputEvent& event) {
for (const auto& observer : observers_) {
observer->OnUserInput(event, metrics_update_dispatcher_.timing());
}
}
void PageLoadTracker::FlushMetricsOnAppEnterBackground() {
metrics_update_dispatcher()->FlushPendingTimingUpdates();
InvokeAndPruneObservers(
"PageLoadMetricsObserver::FlushMetricsOnAppEnterBackground",
base::BindRepeating(
[](const mojom::PageLoadTiming* timing,
PageLoadMetricsObserverInterface* observer) {
return observer->FlushMetricsOnAppEnterBackground(*timing);
},
&metrics_update_dispatcher_.timing()),
/*permit_forwarding=*/false);
}
void PageLoadTracker::OnLoadedResource(
const ExtraRequestCompleteInfo& extra_request_complete_info) {
// The main_frame_receive_headers_start_ should be only set once during a
// page load. A new page load would have a new PageLoadTracker object.
if (extra_request_complete_info.request_destination ==
network::mojom::RequestDestination::kDocument &&
!main_frame_receive_headers_start_.has_value()) {
main_frame_receive_headers_start_ =
extra_request_complete_info.load_timing_info->receive_headers_start;
}
for (const auto& observer : observers_) {
observer->OnLoadedResource(extra_request_complete_info);
}
}
void PageLoadTracker::FrameReceivedUserActivation(
content::RenderFrameHost* rfh) {
for (const auto& observer : observers_) {
observer->FrameReceivedUserActivation(rfh);
}
}
void PageLoadTracker::FrameDisplayStateChanged(
content::RenderFrameHost* render_frame_host,
bool is_display_none) {
for (const auto& observer : observers_) {
observer->FrameDisplayStateChanged(render_frame_host, is_display_none);
}
}
void PageLoadTracker::FrameSizeChanged(
content::RenderFrameHost* render_frame_host,
const gfx::Size& frame_size) {
for (const auto& observer : observers_) {
observer->FrameSizeChanged(render_frame_host, frame_size);
}
}
void PageLoadTracker::OnCookiesRead(const GURL& url,
const GURL& first_party_url,
const net::CookieList& cookie_list,
bool blocked_by_policy) {
for (const auto& observer : observers_) {
observer->OnCookiesRead(url, first_party_url, cookie_list,
blocked_by_policy);
}
}
void PageLoadTracker::OnCookieChange(const GURL& url,
const GURL& first_party_url,
const net::CanonicalCookie& cookie,
bool blocked_by_policy) {
for (const auto& observer : observers_) {
observer->OnCookieChange(url, first_party_url, cookie, blocked_by_policy);
}
}
void PageLoadTracker::OnStorageAccessed(const GURL& url,
const GURL& first_party_url,
bool blocked_by_policy,
StorageType access_type) {
for (const auto& observer : observers_) {
observer->OnStorageAccessed(url, first_party_url, blocked_by_policy,
access_type);
}
}
void PageLoadTracker::StopTracking() {
did_stop_tracking_ = true;
observers_map_.clear();
observers_.clear();
}
void PageLoadTracker::AddObserver(
std::unique_ptr<PageLoadMetricsObserverInterface> observer) {
observer->SetDelegate(this);
if (observer->GetObserverName()) {
DCHECK(observers_map_.find(observer->GetObserverName()) ==
observers_map_.end())
<< "We expect that observer's class and name is unique in trackers. "
"Note that observer's class can be non-unique in test, e.g. "
"PageLoadMetricsTestWaiter. In that case, use a unique name in "
"the test. See also constructor of PageLoadMetricsTestWaiter.";
observers_map_.emplace(observer->GetObserverName(), observer.get());
}
observers_.push_back(std::move(observer));
}
base::WeakPtr<PageLoadMetricsObserverInterface> PageLoadTracker::FindObserver(
const char* name) {
auto it = observers_map_.find(name);
if (it != observers_map_.end())
return it->second->GetWeakPtr();
return nullptr;
}
void PageLoadTracker::ClampBrowserTimestampIfInterProcessTimeTickSkew(
base::TimeTicks* event_time) {
DCHECK(event_time != nullptr);
// Windows 10 GCE bot non-deterministically failed because TimeTicks::Now()
// called in the browser process e.g. commit_time was less than
// navigation_start_ that was populated in the renderer process because the
// clock was not system-wide monotonic.
// Note that navigation_start_ can also be set in the browser process in
// some cases and in those cases event_time should never be <
// navigation_start_. If it is due to a code error and it gets clamped in this
// function, on high resolution systems it should lead to a dcheck failure.
// TODO(shivanisha): Currently IsHighResolution is the best way to check
// if the clock is system-wide monotonic. However IsHighResolution
// does a broader check to see if the clock in use is high resolution
// which also implies it is system-wide monotonic (on Windows).
if (base::TimeTicks::IsHighResolution()) {
DCHECK(event_time->is_null() || *event_time >= navigation_start_);
return;
}
if (!event_time->is_null() && *event_time < navigation_start_) {
RecordInternalError(ERR_INTER_PROCESS_TIME_TICK_SKEW);
*event_time = navigation_start_;
}
}
bool PageLoadTracker::HasMatchingNavigationRequestID(
const content::GlobalRequestID& request_id) const {
DCHECK(request_id != content::GlobalRequestID());
return navigation_request_id_.has_value() &&
navigation_request_id_.value() == request_id;
}
void PageLoadTracker::NotifyPageEnd(PageEndReason page_end_reason,
UserInitiatedInfo user_initiated_info,
base::TimeTicks timestamp,
bool is_certainly_browser_timestamp) {
DCHECK_NE(page_end_reason, END_NONE);
// Use UpdatePageEnd to update an already notified PageLoadTracker.
if (page_end_reason_ != END_NONE)
return;
UpdatePageEndInternal(page_end_reason, user_initiated_info, timestamp,
is_certainly_browser_timestamp);
}
void PageLoadTracker::UpdatePageEnd(PageEndReason page_end_reason,
UserInitiatedInfo user_initiated_info,
base::TimeTicks timestamp,
bool is_certainly_browser_timestamp) {
DCHECK_NE(page_end_reason, END_NONE);
DCHECK_NE(page_end_reason, END_OTHER);
DCHECK_EQ(page_end_reason_, END_OTHER);
DCHECK(!page_end_time_.is_null());
if (page_end_time_.is_null() || page_end_reason_ != END_OTHER)
return;
// For some aborts (e.g. navigations), the initiated timestamp can be earlier
// than the timestamp that aborted the load. Taking the minimum gives the
// closest user initiated time known.
UpdatePageEndInternal(page_end_reason, user_initiated_info,
std::min(page_end_time_, timestamp),
is_certainly_browser_timestamp);
}
bool PageLoadTracker::IsLikelyProvisionalAbort(
base::TimeTicks abort_cause_time) const {
// Note that |abort_cause_time - page_end_time_| can be negative.
return page_end_reason_ == END_OTHER &&
(abort_cause_time - page_end_time_).InMilliseconds() < 100;
}
void PageLoadTracker::UpdatePageEndInternal(
PageEndReason page_end_reason,
UserInitiatedInfo user_initiated_info,
base::TimeTicks timestamp,
bool is_certainly_browser_timestamp) {
// When a provisional navigation commits, that navigation's start time is
// interpreted as the abort time for other provisional loads in the tab.
// However, this only makes sense if the committed load started after the
// aborted provisional loads started. Thus we ignore cases where the committed
// load started before the aborted provisional load, as this would result in
// recording a negative time-to-abort. The real issue here is that we have to
// infer the cause of aborts. It would be better if the navigation code could
// instead report the actual cause of an aborted navigation. See crbug/571647
// for details.
if (timestamp < navigation_start_) {
RecordInternalError(ERR_END_BEFORE_NAVIGATION_START);
page_end_reason_ = END_NONE;
page_end_time_ = base::TimeTicks();
return;
}
page_end_reason_ = page_end_reason;
page_end_time_ = timestamp;
// A client redirect can never be user initiated. Due to the way Blink
// implements user gesture tracking, where all events that occur within a few
// seconds after a user interaction are considered to be triggered by user
// activation (based on the HTML spec:
// https://html.spec.whatwg.org/multipage/interaction.html#tracking-user-activation),
// these navs may sometimes be reported as user initiated by Blink. Thus, we
// explicitly filter these types of aborts out when deciding if the abort was
// user initiated.
if (page_end_reason != END_CLIENT_REDIRECT)
page_end_user_initiated_info_ = user_initiated_info;
if (is_certainly_browser_timestamp) {
ClampBrowserTimestampIfInterProcessTimeTickSkew(&page_end_time_);
}
}
void PageLoadTracker::MediaStartedPlaying(
const content::WebContentsObserver::MediaPlayerInfo& video_type,
content::RenderFrameHost* render_frame_host) {
for (const auto& observer : observers_)
observer->MediaStartedPlaying(video_type, render_frame_host);
}
bool PageLoadTracker::IsPageMainFrame(content::RenderFrameHost* rfh) const {
DCHECK(page_main_frame_);
return rfh == page_main_frame_;
}
void PageLoadTracker::OnTimingChanged() {
DCHECK(!last_dispatched_merged_page_timing_->Equals(
metrics_update_dispatcher_.timing()));
const mojom::PageLoadTiming& new_timing = metrics_update_dispatcher_.timing();
if (new_timing.activation_start &&
!last_dispatched_merged_page_timing_->activation_start) {
DCHECK(prerendering_state_ ==
PrerenderingState::kActivatedNoActivationStart);
prerendering_state_ = PrerenderingState::kActivated;
activation_start_ = new_timing.activation_start;
}
const mojom::PaintTimingPtr& paint_timing =
metrics_update_dispatcher_.timing().paint_timing;
// Record UMA if the LCP candidate changes.
// TODO(crbug.com/1431906): This is to track irregularities in the LCP timing
// values in the UKM recording. We would remove this code once we have
// identified all of the conditions where these irregularities happen.
bool largest_contentful_image_changed =
!largest_contentful_paint_handler_.GetImageContentfulPaintTimingInfo()
.Time()
.has_value() ||
(paint_timing->largest_contentful_paint->largest_image_paint
.has_value() &&
paint_timing->largest_contentful_paint->largest_image_paint.value() !=
largest_contentful_paint_handler_.GetImageContentfulPaintTimingInfo()
.Time()
.value());
if (largest_contentful_image_changed) {
if (main_frame_receive_headers_start_.has_value() &&
!GetNavigationStart().is_null()) {
RecordLargestContentfulPaintImageLoadTiming(
*paint_timing->largest_contentful_paint,
main_frame_receive_headers_start_.value() - GetNavigationStart());
}
}
largest_contentful_paint_handler_.RecordMainFrameTiming(
*paint_timing->largest_contentful_paint,
paint_timing->first_input_or_scroll_notified_timestamp);
experimental_largest_contentful_paint_handler_.RecordMainFrameTiming(
*paint_timing->experimental_largest_contentful_paint,
paint_timing->first_input_or_scroll_notified_timestamp);
for (const auto& observer : observers_) {
DispatchObserverTimingCallbacks(
observer.get(), *last_dispatched_merged_page_timing_, new_timing);
}
last_dispatched_merged_page_timing_ =
metrics_update_dispatcher_.timing().Clone();
}
void PageLoadTracker::OnPageInputTimingChanged(uint64_t num_interactions,
uint64_t num_input_events) {
for (const auto& observer : observers_) {
observer->OnPageInputTimingUpdate(num_interactions, num_input_events);
}
}
void PageLoadTracker::OnSubFrameTimingChanged(
content::RenderFrameHost* rfh,
const mojom::PageLoadTiming& timing) {
DCHECK(rfh->GetParentOrOuterDocument());
const mojom::PaintTimingPtr& paint_timing = timing.paint_timing;
largest_contentful_paint_handler_.RecordSubFrameTiming(
*paint_timing->largest_contentful_paint,
paint_timing->first_input_or_scroll_notified_timestamp, rfh, url_);
experimental_largest_contentful_paint_handler_.RecordSubFrameTiming(
*paint_timing->experimental_largest_contentful_paint,
paint_timing->first_input_or_scroll_notified_timestamp, rfh, url_);
for (const auto& observer : observers_) {
observer->OnTimingUpdate(rfh, timing);
}
}
void PageLoadTracker::OnSubFrameInputTimingChanged(
content::RenderFrameHost* rfh,
const mojom::InputTiming& input_timing_delta) {
DCHECK(rfh->GetParentOrOuterDocument());
for (const auto& observer : observers_) {
observer->OnInputTimingUpdate(rfh, input_timing_delta);
}