File: cros_pre_consent_metrics_manager.cc

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 (165 lines) | stat: -rw-r--r-- 5,732 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
// 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.

#include "chrome/browser/metrics/cros_pre_consent_metrics_manager.h"

#include <optional>

#include "ash/constants/ash_features.h"
#include "base/check.h"
#include "base/feature_list.h"
#include "base/files/file_util.h"
#include "base/functional/bind.h"
#include "base/location.h"
#include "base/memory/ptr_util.h"
#include "base/task/sequenced_task_runner.h"
#include "base/task/task_traits.h"
#include "base/task/thread_pool.h"
#include "chrome/browser/ash/login/startup_utils.h"
#include "chrome/browser/ash/policy/core/browser_policy_connector_ash.h"
#include "chrome/browser/ash/policy/core/device_cloud_policy_store_ash.h"
#include "chrome/browser/ash/settings/device_settings_service.h"
#include "chrome/browser/browser_process.h"
#include "chrome/browser/browser_process_platform_part_ash.h"
#include "chrome/browser/metrics/metrics_reporting_state.h"
#include "components/metrics/metrics_pref_names.h"
#include "components/metrics/metrics_service_client.h"
#include "components/metrics_services_manager/metrics_services_manager.h"
#include "components/prefs/pref_registry_simple.h"
#include "components/prefs/pref_service.h"

namespace metrics {

// Singleton pointer to the instance of CrOSPreConsentMetricsManager.
static CrOSPreConsentMetricsManager* g_instance = nullptr;

// Path for pre_consent_complete file. This file is created when the pre-consent
// is considered completed depending on the type of user.
//
// See class comment on CrOSPreConsentMetricsManager for details on when this
// file is written.
const char kCrOSPreConsentCompletePath[] =
    "/home/chronos/.pre_consent_complete";

// The upload interval for metrics during pre-consent metrics.
const base::TimeDelta kPreConsentUploadInterval = base::Seconds(120);

// Writes the .pre_consent_complete file in chronos home. This signifies that
// the primary user has been set and their consent for metrics has been set.
void WritePreConsentCompleteFile(std::optional<base::FilePath> test_path) {
  base::FilePath path = base::FilePath(kCrOSPreConsentCompletePath);
  if (test_path.has_value()) {
    path = std::move(test_path).value();
  }
  base::WriteFile(path, "");
}

// static
std::unique_ptr<CrOSPreConsentMetricsManager>
CrOSPreConsentMetricsManager::MaybeCreate() {
  // If this path exists then this object doesn't need to be created.
  if (!ash::features::IsOobePreConsentMetricsEnabled() ||
      base::PathExists(base::FilePath(kCrOSPreConsentCompletePath))) {
    return nullptr;
  }

  // Handle when a ChromeOS device upgrades to the version this functionality
  // was added that has completed OOBE.
  if (ash::StartupUtils::IsDeviceRegistered()) {
    base::ThreadPool::PostTask(
        FROM_HERE, base::MayBlock(),
        base::BindOnce(&WritePreConsentCompleteFile,
                       base::FilePath(kCrOSPreConsentCompletePath)));
    return nullptr;
  }

  return base::WrapUnique(new CrOSPreConsentMetricsManager());
}

CrOSPreConsentMetricsManager::~CrOSPreConsentMetricsManager() {
  g_instance = nullptr;
}

void CrOSPreConsentMetricsManager::Enable() {
  if (is_enabled_) {
    return;
  }

  is_enabled_ = true;
  VLOG(1) << "Pre-consent metrics enabled";

  // Force enable metrics. This will enable metrics and populate all appropriate
  // preferences.
  ChangeMetricsReportingState(
      is_enabled_,
      ChangeMetricsReportingStateCalledFrom::kCrosMetricsPreConsent);

  // Propagate the change to metrics services. This will create the Client ID
  // that will be used if the user consents to metrics. If pre-consent is being
  // disabled do not update the permissions as it should not be changed.
  g_browser_process->GetMetricsServicesManager()->UpdateUploadPermissions();

  // Register CrOSPreConsentMetricsManager as the observer for policy change to
  // get notified when device is enrolled.
  cloud_policy_store_observation_.Observe(g_browser_process->platform_part()
                                              ->browser_policy_connector_ash()
                                              ->GetDeviceCloudPolicyManager()
                                              ->device_store());
}

void CrOSPreConsentMetricsManager::Disable() {
  if (!is_enabled_) {
    return;
  }

  is_enabled_ = false;
  VLOG(1) << "Pre-consent metrics disabled";

  task_runner_->PostTask(FROM_HERE,
                         base::BindOnce(&WritePreConsentCompleteFile,
                                        completed_path_for_testing_));
}

std::optional<base::TimeDelta> CrOSPreConsentMetricsManager::GetUploadInterval()
    const {
  if (is_enabled_) {
    return kPreConsentUploadInterval;
  }
  return std::nullopt;
}

void CrOSPreConsentMetricsManager::SetCompletedPathForTesting(
    const base::FilePath& path) {
  completed_path_for_testing_ = path;
}

void CrOSPreConsentMetricsManager::PostToIOTaskRunnerForTesting(
    base::Location here,
    base::OnceClosure callback) {
  task_runner_->PostTask(here, std::move(callback));
}

// static
CrOSPreConsentMetricsManager* CrOSPreConsentMetricsManager::Get() {
  return g_instance;
}

CrOSPreConsentMetricsManager::CrOSPreConsentMetricsManager()
    : task_runner_(
          base::ThreadPool::CreateSequencedTaskRunner(base::MayBlock())) {
  CHECK(g_instance == nullptr) << "CrOSPreConsentMetricsManager already exists";
  g_instance = this;
}

void CrOSPreConsentMetricsManager::OnStoreError(
    policy::CloudPolicyStore* store) {}

void CrOSPreConsentMetricsManager::OnStoreLoaded(
    policy::CloudPolicyStore* store) {
  cloud_policy_store_observation_.Reset();

  Disable();
}

}  // namespace metrics