File: preview_page_load_metrics_observer.cc

package info (click to toggle)
chromium 138.0.7204.183-1~deb12u1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm-proposed-updates
  • size: 6,080,960 kB
  • sloc: cpp: 34,937,079; ansic: 7,176,967; javascript: 4,110,704; python: 1,419,954; asm: 946,768; xml: 739,971; pascal: 187,324; sh: 89,623; perl: 88,663; objc: 79,944; sql: 50,304; cs: 41,786; fortran: 24,137; makefile: 21,811; php: 13,980; tcl: 13,166; yacc: 8,925; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (212 lines) | stat: -rw-r--r-- 7,830 bytes parent folder | download | duplicates (5)
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
// Copyright 2023 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#include "chrome/browser/page_load_metrics/observers/preview_page_load_metrics_observer.h"

#include "base/metrics/histogram_functions.h"
#include "build/build_config.h"
#include "components/page_load_metrics/browser/page_load_metrics_observer_delegate.h"
#include "components/page_load_metrics/browser/page_load_metrics_util.h"
#include "content/public/browser/navigation_handle.h"

#if !BUILDFLAG(IS_ANDROID)
#include "chrome/browser/preloading/preview/preview_manager.h"
#endif

PreviewPageLoadMetricsObserver::ObservePolicy
PreviewPageLoadMetricsObserver::OnStart(
    content::NavigationHandle* navigation_handle,
    const GURL& currently_committed_url,
    bool started_in_foreground) {
  if (started_in_foreground) {
    last_time_shown_ = navigation_handle->NavigationStart();
  }
  currently_in_foreground_ = started_in_foreground;
  CheckPageTransitionType(navigation_handle);
  return CONTINUE_OBSERVING;
}

page_load_metrics::PageLoadMetricsObserver::ObservePolicy
PreviewPageLoadMetricsObserver::OnFencedFramesStart(
    content::NavigationHandle* navigation_handle,
    const GURL& currently_committed_url) {
  // Track only outermost pages.
  return STOP_OBSERVING;
}

page_load_metrics::PageLoadMetricsObserver::ObservePolicy
PreviewPageLoadMetricsObserver::OnPrerenderStart(
    content::NavigationHandle* navigation_handle,
    const GURL& currently_committed_url) {
  CheckPageTransitionType(navigation_handle);
  return CONTINUE_OBSERVING;
}

page_load_metrics::PageLoadMetricsObserver::ObservePolicy
PreviewPageLoadMetricsObserver::OnPreviewStart(
    content::NavigationHandle* navigation_handle,
    const GURL& currently_committed_url) {
  status_ = Status::kPreviewed;
  return CONTINUE_OBSERVING;
}

PreviewPageLoadMetricsObserver::ObservePolicy
PreviewPageLoadMetricsObserver::FlushMetricsOnAppEnterBackground(
    const page_load_metrics::mojom::PageLoadTiming& timing) {
  RecordMetrics();
  return STOP_OBSERVING;
}

PreviewPageLoadMetricsObserver::ObservePolicy
PreviewPageLoadMetricsObserver::OnHidden(
    const page_load_metrics::mojom::PageLoadTiming& timing) {
  if (currently_in_foreground_ && !last_time_shown_.is_null()) {
    total_foreground_duration_ += base::TimeTicks::Now() - last_time_shown_;
  }
  currently_in_foreground_ = false;
  return CONTINUE_OBSERVING;
}

PreviewPageLoadMetricsObserver::ObservePolicy
PreviewPageLoadMetricsObserver::OnShown() {
  currently_in_foreground_ = true;
  last_time_shown_ = base::TimeTicks::Now();
  return CONTINUE_OBSERVING;
}

void PreviewPageLoadMetricsObserver::OnComplete(
    const page_load_metrics::mojom::PageLoadTiming& timing) {
  RecordMetrics();
}

void PreviewPageLoadMetricsObserver::DidActivatePreviewedPage(
    base::TimeTicks activation_time) {
  status_ = Status::kPromoted;
}

PreviewPageLoadMetricsObserver::PageVisitType
PreviewPageLoadMetricsObserver::RecordPageVisitType() {
  CHECK_EQ(status_, Status::kNotPreviewed);

  PageVisitType type;
  const page_load_metrics::PageLoadMetricsObserverDelegate& delegate =
      GetDelegate();

  if (is_history_navigation_) {
    type = PageVisitType::kHistoryVisit;
  } else if (delegate.IsOriginVisit()) {
    if (is_first_navigation_) {
      // PageTransition::PAGE_TRANSITION_FIRST is set only for the first
      // navigation that is not triggered by any UI. So, this means the visit
      // is made via the open-in-new-tab feature.
      // PageTransition::PAGE_TRANSITION_LINK would not be set for the case.
      type = delegate.IsTerminalVisit() ? PageVisitType::kIndependentLinkVisit
                                        : PageVisitType::kOriginLinkVisit;
    } else {
      type = delegate.IsTerminalVisit() ? PageVisitType::kIndependentUIVisit
                                        : PageVisitType::kOriginUIVisit;
    }
  } else {
    type = delegate.IsTerminalVisit() ? PageVisitType::kTerminalVisit
                                      : PageVisitType::kPassingVisit;
  }
  base::UmaHistogramEnumeration("PageLoad.Experimental.PageVisitType2", type);
  return type;
}

void PreviewPageLoadMetricsObserver::RecordMetrics() {
  if (status_ != Status::kNotPreviewed) {
    base::UmaHistogramEnumeration("PageLoad.Experimental.PreviewFinalStatus",
                                  ConvertStatusToPreviewFinalStatus(status_));
    return;
  }

  CHECK_EQ(status_, Status::kNotPreviewed);
  PageVisitType page_visit_type = RecordPageVisitType();
  if (currently_in_foreground_ && !last_time_shown_.is_null()) {
    total_foreground_duration_ += base::TimeTicks::Now() - last_time_shown_;
  }
  PAGE_LOAD_LONG_HISTOGRAM(
      "PageLoad.Experimental.TotalForegroundDuration.AllVisit",
      total_foreground_duration_);
  switch (page_visit_type) {
    case PageVisitType::kObsoleteIndependentVisit:
    case PageVisitType::kObsoleteOriginVisit:
      NOTREACHED();
    case PageVisitType::kPassingVisit:
      PAGE_LOAD_LONG_HISTOGRAM(
          "PageLoad.Experimental.TotalForegroundDuration.PassingVisit",
          total_foreground_duration_);
      break;
    case PageVisitType::kTerminalVisit:
      PAGE_LOAD_LONG_HISTOGRAM(
          "PageLoad.Experimental.TotalForegroundDuration.TerminalVisit",
          total_foreground_duration_);
      break;
    case PageVisitType::kHistoryVisit:
      PAGE_LOAD_LONG_HISTOGRAM(
          "PageLoad.Experimental.TotalForegroundDuration.HistoryVisit",
          total_foreground_duration_);
      break;
    case PageVisitType::kIndependentLinkVisit:
      PAGE_LOAD_LONG_HISTOGRAM(
          "PageLoad.Experimental.TotalForegroundDuration.IndependentLinkVisit",
          total_foreground_duration_);
      break;
    case PageVisitType::kIndependentUIVisit:
      PAGE_LOAD_LONG_HISTOGRAM(
          "PageLoad.Experimental.TotalForegroundDuration.IndependentUIVisit",
          total_foreground_duration_);
      break;
    case PageVisitType::kOriginLinkVisit:
      PAGE_LOAD_LONG_HISTOGRAM(
          "PageLoad.Experimental.TotalForegroundDuration.OriginLinkVisit",
          total_foreground_duration_);
      break;
    case PageVisitType::kOriginUIVisit:
      PAGE_LOAD_LONG_HISTOGRAM(
          "PageLoad.Experimental.TotalForegroundDuration.OriginUIVisit",
          total_foreground_duration_);
      break;
  }

#if !BUILDFLAG(IS_ANDROID)
  // Note: PreviewManager is not implemented on Android yet.
  // PreviewManager is created when it is used. So, `usage` should be
  // `kNotUsed` if it doesn't exist.
  PreviewManager::Usage usage = PreviewManager::Usage::kNotUsed;
  PreviewManager* manager =
      PreviewManager::FromWebContents(GetDelegate().GetWebContents());
  if (manager) {
    usage = manager->usage();
  }
  // This metric indicates if the current page initiates the LinkPreview feature
  // and if the previewed page is promoted or not.
  base::UmaHistogramEnumeration("PageLoad.Clients.LinkPreview.Usage", usage);
#endif
}

void PreviewPageLoadMetricsObserver::CheckPageTransitionType(
    content::NavigationHandle* navigation_handle) {
  is_history_navigation_ =
      navigation_handle->GetPageTransition() & ui::PAGE_TRANSITION_FORWARD_BACK;
  if (ui::PageTransitionCoreTypeIs(navigation_handle->GetPageTransition(),
                                   ui::PAGE_TRANSITION_FIRST)) {
    is_first_navigation_ = true;
  }
}

PreviewPageLoadMetricsObserver::PreviewFinalStatus
PreviewPageLoadMetricsObserver::ConvertStatusToPreviewFinalStatus(
    PreviewPageLoadMetricsObserver::Status status) {
  switch (status) {
    case Status::kNotPreviewed:
      NOTREACHED();
    case Status::kPreviewed:
      return PreviewFinalStatus::kPreviewed;
    case Status::kPromoted:
      return PreviewFinalStatus::kPromoted;
  }
  NOTREACHED();
}