File: tab_group_sync_metrics_logger_impl.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 (113 lines) | stat: -rw-r--r-- 4,434 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
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
// Copyright 2024 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef COMPONENTS_SAVED_TAB_GROUPS_INTERNAL_TAB_GROUP_SYNC_METRICS_LOGGER_IMPL_H_
#define COMPONENTS_SAVED_TAB_GROUPS_INTERNAL_TAB_GROUP_SYNC_METRICS_LOGGER_IMPL_H_

#include <deque>
#include <map>
#include <optional>
#include <string>

#include "base/functional/callback.h"
#include "base/memory/raw_ptr.h"
#include "base/task/delayed_task_handle.h"
#include "base/time/default_clock.h"
#include "components/saved_tab_groups/public/tab_group_sync_metrics_logger.h"
#include "components/saved_tab_groups/public/types.h"
#include "components/signin/public/base/consent_level.h"
#include "components/sync_device_info/device_info.h"
#include "components/sync_device_info/device_info_tracker.h"

namespace tab_groups {
class SavedTabGroup;
class SavedTabGroupTab;

// LINT.IfChange(DeviceType)
// Represents device types which can be a local device or a remote device.
// If it is a local device, only `kLocal` will be captured.
// If it is a remote device, the OS and form factor will be captured.
// Used for metrics only. Used in relation to a cache guid attribution which
// is mapped to a device type for metrics purposes. These values are persisted
// to logs. Entries should not be renumbered and numeric values should never be
// reused.
enum class DeviceType {
  kUnknown = 0,
  kLocal = 1,  // Local device on which the metrics is recorded.
  kWindows = 2,
  kMac = 3,
  kLinux = 4,
  kChromeOS = 5,
  kAndroidPhone = 6,
  kAndroidTablet = 7,
  kIOSPhone = 8,
  kIOSTablet = 9,
  kMaxValue = kIOSTablet
};
// LINT.ThenChange(//tools/metrics/histograms/metadata/tab/enums.xml:DeviceType)

// Class to record histograms for events related to tab group sync,
// capturing information about the originating device type and form factor.
class TabGroupSyncMetricsLoggerImpl : public TabGroupSyncMetricsLogger {
 public:
  explicit TabGroupSyncMetricsLoggerImpl(
      syncer::DeviceInfoTracker* device_info_tracker);
  ~TabGroupSyncMetricsLoggerImpl() override;

  // TabGroupSyncMetricsLogger overrides.
  void LogEvent(const EventDetails& event_details,
                const SavedTabGroup* group,
                const SavedTabGroupTab* tab) override;
  void RecordMetricsOnStartup(
      const std::vector<SavedTabGroup>& saved_tab_groups,
      const std::vector<bool>& is_remote) override;
  void RecordTabGroupDeletionsOnStartup(size_t group_count) override;
  void RecordMetricsOnSignin(const std::vector<SavedTabGroup>& saved_tab_groups,
                             signin::ConsentLevel consent_level) override;
  void RecordSavedTabGroupNavigation(const LocalTabID& id,
                                     const GURL& url,
                                     SavedTabGroupType type,
                                     bool is_post,
                                     bool was_redirected,
                                     ukm::SourceId source_id) override;

  // Returns the DeviceType based on the sync cache guid which can resolve to a
  // local device or a remote device with a specific OS and form factor. The
  // passed `cache_guid` argument can be a creator cache guid or last updater
  // cache guid, which is then used in conjunction with tab group metrics.
  DeviceType GetDeviceTypeFromCacheGuid(
      const std::optional<std::string>& cache_guid) const;

  // Returns the DeviceType based on the OS and form factor.
  DeviceType GetDeviceTypeFromDeviceInfo(
      const syncer::DeviceInfo& device_info) const;

  void SetClockForTesting(base::Clock* clock);

 private:
  // For resolving device information.
  raw_ptr<syncer::DeviceInfoTracker> device_info_tracker_;

  // Called to clean entries in `recent_navigations_` that are too old.
  void PruneRecentNavigationsThatAreTooOld();

  // Object representing recent main frame navigations.
  struct RecentNavigation {
    GURL url;
    base::Time timestamp;

    RecentNavigation(const GURL url, base::Time timestamp)
        : url(url), timestamp(timestamp) {}
  };

  using RecentNavigationMap =
      std::map<LocalTabID, std::unique_ptr<std::deque<RecentNavigation>>>;
  RecentNavigationMap recent_navigations_;

  raw_ptr<base::Clock> clock_ = base::DefaultClock::GetInstance();
};

}  // namespace tab_groups

#endif  // COMPONENTS_SAVED_TAB_GROUPS_INTERNAL_TAB_GROUP_SYNC_METRICS_LOGGER_IMPL_H_