File: preview_page_load_metrics_observer.h

package info (click to toggle)
chromium 139.0.7258.127-1
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 6,122,068 kB
  • sloc: cpp: 35,100,771; ansic: 7,163,530; javascript: 4,103,002; python: 1,436,920; asm: 946,517; xml: 746,709; pascal: 187,653; perl: 88,691; sh: 88,436; objc: 79,953; sql: 51,488; cs: 44,583; fortran: 24,137; makefile: 22,147; tcl: 15,277; php: 13,980; yacc: 8,984; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (94 lines) | stat: -rw-r--r-- 3,975 bytes parent folder | download | duplicates (6)
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
// 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.

#ifndef CHROME_BROWSER_PAGE_LOAD_METRICS_OBSERVERS_PREVIEW_PAGE_LOAD_METRICS_OBSERVER_H_
#define CHROME_BROWSER_PAGE_LOAD_METRICS_OBSERVERS_PREVIEW_PAGE_LOAD_METRICS_OBSERVER_H_

#include "base/time/time.h"
#include "components/page_load_metrics/browser/page_load_metrics_observer.h"

// Records Link-Preview project related metrics to evaluate the project impact.
// So, it collects data from all kind of navigations regardless of the
// Link-Preview feature existence to analyse users' activity trend.
// As a starting point, this class experimentally records page visit types and
// total foreground time duration for each visit type to analyze a.k.a unwanted
// navigations.
class PreviewPageLoadMetricsObserver
    : public page_load_metrics::PageLoadMetricsObserver {
 public:
  // These values are persisted to logs. Entries should not be renumbered and
  // numeric values should never be reused.
  // As we don't identify client redirect cases, kPassingVisit may be
  // overestimated a little.
  enum class PageVisitType {
    kObsoleteIndependentVisit = 0,
    kObsoleteOriginVisit = 1,
    kPassingVisit = 2,
    kTerminalVisit = 3,
    kHistoryVisit = 4,
    kIndependentLinkVisit = 5,
    kIndependentUIVisit = 6,
    kOriginLinkVisit = 7,
    kOriginUIVisit = 8,
    kMaxValue = kOriginUIVisit,
  };
  // These values are persisted to logs. Entries should not be renumbered and
  // numeric values should never be reused.
  enum class PreviewFinalStatus {
    // Preview started, but the page wasn't promoted in any way
    kPreviewed = 0,
    // Preview started, and the page was promoted into a new tab
    kPromoted = 1,
    // TODO(b:292184832): Will define another entry for the promotion to the
    // current tab
    kMaxValue = kPromoted,
  };

  PreviewPageLoadMetricsObserver() = default;
  PreviewPageLoadMetricsObserver(const PreviewPageLoadMetricsObserver&) =
      delete;
  PreviewPageLoadMetricsObserver& operator=(
      const PreviewPageLoadMetricsObserver&) = delete;
  ~PreviewPageLoadMetricsObserver() override = default;

  // page_load_metrics::PageLoadMetricsObserver implementation:
  ObservePolicy OnStart(content::NavigationHandle* navigation_handle,
                        const GURL& currently_committed_url,
                        bool started_in_foreground) override;
  ObservePolicy OnFencedFramesStart(
      content::NavigationHandle* navigation_handle,
      const GURL& currently_committed_url) override;
  ObservePolicy OnPrerenderStart(content::NavigationHandle* navigation_handle,
                                 const GURL& currently_committed_url) override;
  ObservePolicy OnPreviewStart(content::NavigationHandle* navigation_handle,
                               const GURL& currently_committed_url) override;
  ObservePolicy FlushMetricsOnAppEnterBackground(
      const page_load_metrics::mojom::PageLoadTiming& timing) override;
  ObservePolicy OnHidden(
      const page_load_metrics::mojom::PageLoadTiming& timing) override;
  ObservePolicy OnShown() override;
  void OnComplete(
      const page_load_metrics::mojom::PageLoadTiming& timing) override;
  void DidActivatePreviewedPage(base::TimeTicks activation_time) override;

 private:
  enum class Status {
    kNotPreviewed,
    kPreviewed,
    kPromoted,
  };
  PageVisitType RecordPageVisitType();
  void RecordMetrics();
  void CheckPageTransitionType(content::NavigationHandle* navigation_handle);
  PreviewFinalStatus ConvertStatusToPreviewFinalStatus(Status state);

  bool currently_in_foreground_ = false;
  bool is_history_navigation_ = false;
  bool is_first_navigation_ = false;
  base::TimeTicks last_time_shown_;
  base::TimeDelta total_foreground_duration_;
  Status status_ = Status::kNotPreviewed;
};

#endif  // CHROME_BROWSER_PAGE_LOAD_METRICS_OBSERVERS_PREVIEW_PAGE_LOAD_METRICS_OBSERVER_H_