File: tab_creation_metrics_controller.h

package info (click to toggle)
chromium 140.0.7339.127-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 6,192,880 kB
  • sloc: cpp: 35,093,808; ansic: 7,161,670; javascript: 4,199,694; python: 1,441,797; asm: 949,904; xml: 747,503; pascal: 187,748; perl: 88,691; sh: 88,248; objc: 79,953; sql: 52,714; cs: 44,599; fortran: 24,137; makefile: 22,114; tcl: 15,277; php: 13,980; yacc: 9,000; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (86 lines) | stat: -rw-r--r-- 3,125 bytes parent folder | download | duplicates (4)
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
// Copyright 2025 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_UI_TABS_TAB_CREATION_METRICS_CONTROLLER_H_
#define CHROME_BROWSER_UI_TABS_TAB_CREATION_METRICS_CONTROLLER_H_

#include "base/memory/raw_ptr.h"
#include "base/memory/weak_ptr.h"
#include "base/time/time.h"

namespace tab_groups {
class TabGroupId;
}

namespace tabs {
class TabInterface;

// Enumerates different types of grouping transition a tab undergoes during a
// specific observation window. Each value includes the initial tab grouping
// state and the ending tab grouping state.
// LINT.IfChange(TabGroupingTransitionType)
enum TabGroupingTransitionType {
  // Used when the transition type is not set.
  kUninitialized = 0,

  // The tab was not in a group at the start and remains ungrouped.
  kUngroupedToUngrouped = 1,

  // The tab was not in a group at the start and joined a group.
  kUngroupedToGrouped = 2,

  // The tab was in a group at the start and became ungrouped.
  kGroupedToUngrouped = 3,

  // The tab was in a group at the start and remains in the same group.
  kGroupedToInPreviousGroup = 4,

  // The tab was in a group at the start but joined a different group.
  kGroupedToOutsidePreviousGroup = 5,

  kMaxValue = kGroupedToOutsidePreviousGroup,
};
// LINT.ThenChange(/tools/metrics/histograms/metadata/tab/enums.xml:TabGroupingTransitionType)

// Per-tab metrics helper that records how a tab's grouping state changes
// shortly after creation.
//
// When constructed, the controller gets the last active tab group if any, and
// schedules a one-time delayed task on |task_runner_| to log how the tab's
// grouping state changed between creation and the end of the delay (10
// seconds).
class TabCreationMetricsController {
 public:
  static constexpr base::TimeDelta kDelay = base::Seconds(10);

  // Global test hook for setting task runner for the scheduled task. Must be
  // called before TabCreationMetricsController is created. To reset to the
  // current default task runner, pass nullptr to SetTaskRunnerForTesting().
  static void SetTaskRunnerForTesting(
      const scoped_refptr<base::SequencedTaskRunner>& task_runner);

  explicit TabCreationMetricsController(TabInterface* tab);
  ~TabCreationMetricsController();

  TabCreationMetricsController(const TabCreationMetricsController&) = delete;
  TabCreationMetricsController& operator=(const TabCreationMetricsController&) =
      delete;

 private:
  // Posts a delayed task to record the tab's grouping state changes 10 seconds
  // after creation. The histogram will include the tab's initial grouping state
  // and and the ending grouping state.
  void ScheduleRecordTabGroupingTransition();

  void RecordTabGroupingTransition(
      std::optional<tab_groups::TabGroupId> last_active_group_id);

  raw_ptr<TabInterface> tab_;
  scoped_refptr<base::SequencedTaskRunner> task_runner_;

  base::WeakPtrFactory<TabCreationMetricsController> weak_factory_{this};
};
}  // namespace tabs

#endif  // CHROME_BROWSER_UI_TABS_TAB_CREATION_METRICS_CONTROLLER_H_