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
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
|
// Copyright 2019 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "components/guest_os/guest_os_engagement_metrics.h"
#include <string>
#include <utility>
#include "base/logging.h"
#include "base/metrics/histogram_functions.h"
#include "base/system/sys_info.h"
#include "base/time/default_clock.h"
#include "base/time/default_tick_clock.h"
#include "base/trace_event/trace_event.h"
#include "chromeos/ash/components/dbus/session_manager/session_manager_client.h"
#include "chromeos/dbus/power_manager/idle.pb.h"
#include "components/exo/wm_helper.h"
#include "components/guest_os/guest_os_prefs.h"
#include "components/prefs/pref_service.h"
#include "components/session_manager/core/session_manager.h"
namespace guest_os {
namespace {
constexpr base::TimeDelta kUpdateEngagementTimePeriod = base::Minutes(1);
constexpr base::TimeDelta kSaveEngagementTimeToPrefsPeriod = base::Minutes(30);
int GetDayId(const base::Clock* clock) {
return clock->Now().LocalMidnight().since_origin().InDays();
}
} // namespace
GuestOsEngagementMetrics::GuestOsEngagementMetrics(
PrefService* pref_service,
WindowMatcher window_matcher,
const std::string& pref_prefix,
const std::string& uma_name)
: GuestOsEngagementMetrics(pref_service,
window_matcher,
pref_prefix,
uma_name,
base::DefaultClock::GetInstance(),
base::DefaultTickClock::GetInstance()) {}
// Private, for testing use only
GuestOsEngagementMetrics::GuestOsEngagementMetrics(
PrefService* pref_service,
WindowMatcher window_matcher,
const std::string& pref_prefix,
const std::string& uma_name,
const base::Clock* clock,
const base::TickClock* tick_clock)
: pref_service_(pref_service),
window_matcher_(window_matcher),
pref_prefix_(pref_prefix),
uma_name_(uma_name),
clock_(clock),
tick_clock_(tick_clock),
last_update_ticks_(tick_clock_->NowTicks()) {
// WMHelper, SessionManager and PowerManagerClient may not exist in tests.
if (exo::WMHelper::HasInstance())
exo::WMHelper::GetInstance()->AddActivationObserver(this);
if (session_manager::SessionManager::Get()) {
session_active_ =
(session_manager::SessionManager::Get()->session_state() ==
session_manager::SessionState::ACTIVE);
session_manager::SessionManager::Get()->AddObserver(this);
}
if (chromeos::PowerManagerClient::Get())
chromeos::PowerManagerClient::Get()->AddObserver(this);
DCHECK(pref_service_);
RestoreEngagementTimeFromPrefs();
update_engagement_time_timer_.Start(
FROM_HERE, kUpdateEngagementTimePeriod, this,
&GuestOsEngagementMetrics::UpdateEngagementTime);
save_engagement_time_to_prefs_timer_.Start(
FROM_HERE, kSaveEngagementTimeToPrefsPeriod, this,
&GuestOsEngagementMetrics::SaveEngagementTimeToPrefs);
}
GuestOsEngagementMetrics::~GuestOsEngagementMetrics() {
save_engagement_time_to_prefs_timer_.Stop();
update_engagement_time_timer_.Stop();
UpdateEngagementTime();
SaveEngagementTimeToPrefs();
// Observers for WMHelper, SessionManager and PowerManagerClient may not
// have been added in tests.
if (chromeos::PowerManagerClient::Get())
chromeos::PowerManagerClient::Get()->RemoveObserver(this);
if (session_manager::SessionManager::Get())
session_manager::SessionManager::Get()->RemoveObserver(this);
// If WMHelper is already destroyed, do nothing.
// TODO(crbug.com/748380): Fix shutdown order.
if (exo::WMHelper::HasInstance())
exo::WMHelper::GetInstance()->RemoveActivationObserver(this);
}
void GuestOsEngagementMetrics::SetBackgroundActive(bool background_active) {
if (background_active_ == background_active)
return;
UpdateEngagementTime();
background_active_ = background_active;
}
void GuestOsEngagementMetrics::OnWindowActivated(
wm::ActivationChangeObserver::ActivationReason reason,
aura::Window* gained_active,
aura::Window* lost_active) {
UpdateEngagementTime();
matched_window_active_ = gained_active && window_matcher_.Run(gained_active);
}
void GuestOsEngagementMetrics::OnSessionStateChanged() {
TRACE_EVENT0("login", "GuestOsEngagementMetrics::OnSessionStateChanged");
UpdateEngagementTime();
session_active_ = session_manager::SessionManager::Get()->session_state() ==
session_manager::SessionState::ACTIVE;
}
void GuestOsEngagementMetrics::ScreenIdleStateChanged(
const power_manager::ScreenIdleState& proto) {
UpdateEngagementTime();
screen_dimmed_ = proto.dimmed();
}
void GuestOsEngagementMetrics::RestoreEngagementTimeFromPrefs() {
// Restore accumulated results only if they were recorded on the same OS
// version.
if (pref_service_->GetString(pref_prefix_ +
prefs::kEngagementTimeOsVersion) ==
base::SysInfo::OperatingSystemVersion()) {
day_id_ =
pref_service_->GetInteger(pref_prefix_ + prefs::kEngagementTimeDayId);
engagement_time_total_ =
pref_service_->GetTimeDelta(pref_prefix_ + prefs::kEngagementTimeTotal);
engagement_time_foreground_ = pref_service_->GetTimeDelta(
pref_prefix_ + prefs::kEngagementTimeForeground);
engagement_time_background_ = pref_service_->GetTimeDelta(
pref_prefix_ + prefs::kEngagementTimeBackground);
} else {
ResetEngagementTimePrefs();
}
RecordEngagementTimeToUmaIfNeeded();
}
void GuestOsEngagementMetrics::SaveEngagementTimeToPrefs() {
DCHECK(pref_service_);
pref_service_->SetString(pref_prefix_ + prefs::kEngagementTimeOsVersion,
base::SysInfo::OperatingSystemVersion());
pref_service_->SetInteger(pref_prefix_ + prefs::kEngagementTimeDayId,
day_id_);
pref_service_->SetTimeDelta(pref_prefix_ + prefs::kEngagementTimeTotal,
engagement_time_total_);
pref_service_->SetTimeDelta(pref_prefix_ + prefs::kEngagementTimeForeground,
engagement_time_foreground_);
pref_service_->SetTimeDelta(pref_prefix_ + prefs::kEngagementTimeBackground,
engagement_time_background_);
}
void GuestOsEngagementMetrics::UpdateEngagementTime() {
VLOG(2) << "last state: screen_dimmed=" << screen_dimmed_
<< " session_active=" << session_active_
<< " background_active=" << background_active_
<< " matched_window_active=" << matched_window_active_;
base::TimeTicks now = tick_clock_->NowTicks();
base::TimeDelta elapsed = now - last_update_ticks_;
if (ShouldAccumulateEngagementTotalTime()) {
VLOG(2) << "accumulate to total time " << elapsed;
engagement_time_total_ += elapsed;
if (ShouldAccumulateEngagementForegroundTime()) {
VLOG(2) << "accumulate to foreground time " << elapsed;
engagement_time_foreground_ += elapsed;
} else if (ShouldAccumulateEngagementBackgroundTime()) {
VLOG(2) << "accumulate to background time " << elapsed;
engagement_time_background_ += elapsed;
}
}
last_update_ticks_ = now;
RecordEngagementTimeToUmaIfNeeded();
}
void GuestOsEngagementMetrics::RecordEngagementTimeToUmaIfNeeded() {
if (!ShouldRecordEngagementTimeToUma())
return;
VLOG(2) << "day changed, recording engagement time to UMA";
UmaHistogramCustomTimes(uma_name_ + ".EngagementTime.Total",
engagement_time_total_, base::Seconds(1),
base::Days(1) + kUpdateEngagementTimePeriod, 50);
UmaHistogramCustomTimes(
uma_name_ + ".EngagementTime." + uma_name_ + "Total",
engagement_time_foreground_ + engagement_time_background_,
base::Seconds(1), base::Days(1) + kUpdateEngagementTimePeriod, 50);
UmaHistogramCustomTimes(uma_name_ + ".EngagementTime.Foreground",
engagement_time_foreground_, base::Seconds(1),
base::Days(1) + kUpdateEngagementTimePeriod, 50);
UmaHistogramCustomTimes(uma_name_ + ".EngagementTime.Background",
engagement_time_background_, base::Seconds(1),
base::Days(1) + kUpdateEngagementTimePeriod, 50);
ResetEngagementTimePrefs();
}
void GuestOsEngagementMetrics::ResetEngagementTimePrefs() {
day_id_ = GetDayId(clock_);
engagement_time_total_ = base::TimeDelta();
engagement_time_foreground_ = base::TimeDelta();
engagement_time_background_ = base::TimeDelta();
SaveEngagementTimeToPrefs();
}
bool GuestOsEngagementMetrics::ShouldAccumulateEngagementTotalTime() const {
return session_active_ && !screen_dimmed_;
}
bool GuestOsEngagementMetrics::ShouldAccumulateEngagementForegroundTime()
const {
return matched_window_active_;
}
bool GuestOsEngagementMetrics::ShouldAccumulateEngagementBackgroundTime()
const {
return background_active_;
}
bool GuestOsEngagementMetrics::ShouldRecordEngagementTimeToUma() const {
return day_id_ != GetDayId(clock_);
}
std::unique_ptr<GuestOsEngagementMetrics>
GuestOsEngagementMetrics::GetEngagementMetricsForTesting(
PrefService* pref_service,
WindowMatcher window_matcher,
const std::string& pref_prefix,
const std::string& uma_name,
const base::Clock* clock,
const base::TickClock* tick_clock) {
GuestOsEngagementMetrics* metrics = new GuestOsEngagementMetrics(
pref_service, window_matcher, pref_prefix, uma_name, clock, tick_clock);
// WrapUnique is needed because the constructor is private.
return base::WrapUnique(metrics);
}
} // namespace guest_os
|
