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
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
|
// Copyright 2020 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/ash/child_accounts/family_user_session_metrics.h"
#include <memory>
#include "base/logging.h"
#include "base/test/metrics/histogram_tester.h"
#include "base/test/metrics/user_action_tester.h"
#include "base/test/task_environment.h"
#include "base/time/time.h"
#include "chrome/common/pref_names.h"
#include "chromeos/dbus/power/fake_power_manager_client.h"
#include "chromeos/dbus/power_manager/idle.pb.h"
#include "chromeos/dbus/power_manager/suspend.pb.h"
#include "components/prefs/testing_pref_service.h"
#include "components/session_manager/core/session_manager.h"
#include "components/session_manager/session_manager_types.h"
#include "testing/gtest/include/gtest/gtest.h"
namespace ash {
namespace {
constexpr base::TimeDelta kTenMinutes = base::Minutes(10);
constexpr base::TimeDelta kOneHour = base::Hours(1);
constexpr base::TimeDelta kOneDay = base::Days(1);
void SetScreenOff(bool is_screen_off) {
power_manager::ScreenIdleState screen_idle_state;
screen_idle_state.set_off(is_screen_off);
chromeos::FakePowerManagerClient::Get()->SendScreenIdleStateChanged(
screen_idle_state);
}
void SetSuspendImminent() {
chromeos::FakePowerManagerClient::Get()->SendSuspendImminent(
power_manager::SuspendImminent_Reason_OTHER);
}
void CancelSuspend() {
chromeos::FakePowerManagerClient::Get()->SendSuspendDone();
}
} // namespace
class FamilyUserSessionMetricsTest : public testing::Test {
protected:
FamilyUserSessionMetricsTest() = default;
~FamilyUserSessionMetricsTest() override = default;
void SetUp() override {
chromeos::PowerManagerClient::InitializeFake();
InitiateFamilyUserSessionMetrics();
FamilyUserSessionMetrics::RegisterProfilePrefs(pref_service_.registry());
}
void TearDown() override {
DestructFamilyUserSessionMetrics();
chromeos::PowerManagerClient::Shutdown();
}
void DestructFamilyUserSessionMetrics() {
family_user_session_metrics_.reset();
}
void InitiateFamilyUserSessionMetrics() {
family_user_session_metrics_ =
std::make_unique<FamilyUserSessionMetrics>(&pref_service_);
}
void SetupTaskRunnerWithTime(const std::string& start_time_str) {
base::Time start_time;
EXPECT_TRUE(base::Time::FromString(start_time_str.c_str(), &start_time));
base::TimeDelta forward_by = start_time - base::Time::Now();
EXPECT_LT(base::TimeDelta(), forward_by);
task_environment_.FastForwardBy(forward_by);
}
void SetSessionState(session_manager::SessionState state) {
session_manager_.SetSessionState(state);
}
void SetActiveSessionStartTime(base::Time time) {
family_user_session_metrics_->SetActiveSessionStartForTesting(time);
}
session_manager::SessionState GetSessionState() {
return session_manager_.session_state();
}
void OnNewDay() { family_user_session_metrics_->OnNewDay(); }
PrefService* pref_service() { return &pref_service_; }
base::test::TaskEnvironment task_environment_{
base::test::TaskEnvironment::TimeSource::MOCK_TIME};
private:
session_manager::SessionManager session_manager_;
TestingPrefServiceSimple pref_service_;
std::unique_ptr<FamilyUserSessionMetrics> family_user_session_metrics_;
};
TEST_F(FamilyUserSessionMetricsTest, SessionStateChange) {
base::HistogramTester histogram_tester;
base::UserActionTester user_action_tester;
// Should see 0 in user session metrics at first.
EXPECT_EQ(0,
user_action_tester.GetActionCount(
FamilyUserSessionMetrics::kSessionEngagementStartActionName));
SetupTaskRunnerWithTime("1 Jan 2020 23:00");
SetSessionState(session_manager::SessionState::ACTIVE);
task_environment_.FastForwardBy(kTenMinutes);
// Session locked at 23:10:00.
SetSessionState(session_manager::SessionState::LOCKED);
task_environment_.FastForwardBy(kOneHour);
// Session activated at 00:10:00 on 2 Jan 2020.
SetSessionState(session_manager::SessionState::ACTIVE);
OnNewDay();
task_environment_.FastForwardBy(kOneHour);
// Session locked at 01:10:00 on 2 Jan 2020.
SetSessionState(session_manager::SessionState::LOCKED);
// Engagement start metric result:
EXPECT_EQ(2,
user_action_tester.GetActionCount(
FamilyUserSessionMetrics::kSessionEngagementStartActionName));
for (int i = 0; i <= 23; i++) {
if (i == 0 || i == 1 || i == 23) {
histogram_tester.ExpectBucketCount(
FamilyUserSessionMetrics::kSessionEngagementWeekdayHistogramName, i,
1);
histogram_tester.ExpectBucketCount(
FamilyUserSessionMetrics::kSessionEngagementTotalHistogramName, i, 1);
} else {
histogram_tester.ExpectBucketCount(
FamilyUserSessionMetrics::kSessionEngagementWeekdayHistogramName, i,
0);
histogram_tester.ExpectBucketCount(
FamilyUserSessionMetrics::kSessionEngagementTotalHistogramName, i, 0);
}
}
histogram_tester.ExpectTotalCount(
FamilyUserSessionMetrics::kSessionEngagementTotalHistogramName, 3);
// Duration metric result:
histogram_tester.ExpectUniqueTimeSample(
FamilyUserSessionMetrics::kSessionEngagementDurationHistogramName,
kTenMinutes, 1);
EXPECT_EQ(kOneHour, pref_service()->GetTimeDelta(
prefs::kFamilyUserMetricsSessionEngagementDuration));
}
TEST_F(FamilyUserSessionMetricsTest, ScreenStateChange) {
base::HistogramTester histogram_tester;
base::UserActionTester user_action_tester;
SetupTaskRunnerWithTime("3 Jan 2020 23:10");
SetSessionState(session_manager::SessionState::ACTIVE);
task_environment_.FastForwardBy(kOneHour);
// Test screen off after midnight at 0:10:00 on 4 Jan 2020.
SetScreenOff(true);
OnNewDay();
// Engagement start metric result:
EXPECT_EQ(1,
user_action_tester.GetActionCount(
FamilyUserSessionMetrics::kSessionEngagementStartActionName));
// Engagement Hour metric result:
histogram_tester.ExpectUniqueSample(
FamilyUserSessionMetrics::kSessionEngagementWeekdayHistogramName, 23, 1);
histogram_tester.ExpectUniqueSample(
FamilyUserSessionMetrics::kSessionEngagementWeekendHistogramName, 0, 1);
histogram_tester.ExpectTotalCount(
FamilyUserSessionMetrics::kSessionEngagementTotalHistogramName, 2);
// Duration metric result:
histogram_tester.ExpectUniqueTimeSample(
FamilyUserSessionMetrics::kSessionEngagementDurationHistogramName,
kOneHour, 1);
EXPECT_EQ(base::TimeDelta(),
pref_service()->GetTimeDelta(
prefs::kFamilyUserMetricsSessionEngagementDuration));
// Test screen on on 4 Jan 2020 0:10:00.
SetScreenOff(false);
task_environment_.FastForwardBy(base::Hours(25));
// Test screen off on 5 Jan 2020 1:10:00.
SetScreenOff(true);
OnNewDay();
// Engagement start metric result:
EXPECT_EQ(2,
user_action_tester.GetActionCount(
FamilyUserSessionMetrics::kSessionEngagementStartActionName));
// Engagement Hour metric result:
histogram_tester.ExpectUniqueSample(
FamilyUserSessionMetrics::kSessionEngagementWeekdayHistogramName, 23, 1);
for (int i = 0; i <= 23; i++) {
if (i == 0) {
histogram_tester.ExpectBucketCount(
FamilyUserSessionMetrics::kSessionEngagementWeekendHistogramName, i,
3);
histogram_tester.ExpectBucketCount(
FamilyUserSessionMetrics::kSessionEngagementTotalHistogramName, i, 3);
} else if (i == 1) {
histogram_tester.ExpectBucketCount(
FamilyUserSessionMetrics::kSessionEngagementWeekendHistogramName, i,
2);
histogram_tester.ExpectBucketCount(
FamilyUserSessionMetrics::kSessionEngagementTotalHistogramName, i, 2);
} else if (i == 23) {
histogram_tester.ExpectBucketCount(
FamilyUserSessionMetrics::kSessionEngagementWeekendHistogramName, i,
1);
histogram_tester.ExpectBucketCount(
FamilyUserSessionMetrics::kSessionEngagementTotalHistogramName, i, 2);
} else {
histogram_tester.ExpectBucketCount(
FamilyUserSessionMetrics::kSessionEngagementWeekendHistogramName, i,
1);
}
}
histogram_tester.ExpectTotalCount(
FamilyUserSessionMetrics::kSessionEngagementTotalHistogramName, 28);
// Duration metric result:
histogram_tester.ExpectTimeBucketCount(
FamilyUserSessionMetrics::kSessionEngagementDurationHistogramName,
kOneHour, 1);
histogram_tester.ExpectTimeBucketCount(
FamilyUserSessionMetrics::kSessionEngagementDurationHistogramName,
kOneDay, 1);
histogram_tester.ExpectTotalCount(
FamilyUserSessionMetrics::kSessionEngagementDurationHistogramName, 2);
EXPECT_EQ(base::TimeDelta(),
pref_service()->GetTimeDelta(
prefs::kFamilyUserMetricsSessionEngagementDuration));
}
TEST_F(FamilyUserSessionMetricsTest, SuspendStateChange) {
base::HistogramTester histogram_tester;
base::UserActionTester user_action_tester;
SetupTaskRunnerWithTime("4 Jan 2020 6:00");
SetSessionState(session_manager::SessionState::ACTIVE);
task_environment_.FastForwardBy(kTenMinutes);
// Test suspend at 6:10:00.
SetSuspendImminent();
task_environment_.FastForwardBy(kTenMinutes);
// Test cancel at 6:20:00.
CancelSuspend();
task_environment_.FastForwardBy(kTenMinutes);
// Test suspend at 6:30:00.
SetSuspendImminent();
task_environment_.FastForwardBy(kTenMinutes);
// Session locked at 6:40:00.
SetSessionState(session_manager::SessionState::LOCKED);
// Engagement start metric result:
EXPECT_EQ(2,
user_action_tester.GetActionCount(
FamilyUserSessionMetrics::kSessionEngagementStartActionName));
// Engagement Hour metric result:
histogram_tester.ExpectUniqueSample(
FamilyUserSessionMetrics::kSessionEngagementWeekendHistogramName, 6, 2);
histogram_tester.ExpectTotalCount(
FamilyUserSessionMetrics::kSessionEngagementTotalHistogramName, 2);
// Duration metric result:
histogram_tester.ExpectTotalCount(
FamilyUserSessionMetrics::kSessionEngagementDurationHistogramName, 0);
EXPECT_EQ(base::Minutes(20),
pref_service()->GetTimeDelta(
prefs::kFamilyUserMetricsSessionEngagementDuration));
}
TEST_F(FamilyUserSessionMetricsTest, ClockBackward) {
base::HistogramTester histogram_tester;
base::UserActionTester user_action_tester;
SetupTaskRunnerWithTime("1 Jan 2020 10:00");
SetSessionState(session_manager::SessionState::ACTIVE);
base::Time mock_session_start;
ASSERT_TRUE(base::Time::FromString("1 Jan 2020 11:00", &mock_session_start));
// Set session start prefs to 11:00:00. Mock a state that start time > end
// time.
SetActiveSessionStartTime(mock_session_start);
// Session locked at 10:00:00.
SetSessionState(session_manager::SessionState::LOCKED);
// Engagement start metric result:
EXPECT_EQ(1,
user_action_tester.GetActionCount(
FamilyUserSessionMetrics::kSessionEngagementStartActionName));
// Engagement Hour metric result:
// Engagement hour and duration data will be ignored if start time > end time.
histogram_tester.ExpectTotalCount(
FamilyUserSessionMetrics::kSessionEngagementWeekdayHistogramName, 0);
histogram_tester.ExpectTotalCount(
FamilyUserSessionMetrics::kSessionEngagementTotalHistogramName, 0);
// Duration metric result:
histogram_tester.ExpectTotalCount(
FamilyUserSessionMetrics::kSessionEngagementDurationHistogramName, 0);
EXPECT_EQ(base::TimeDelta(),
pref_service()->GetTimeDelta(
prefs::kFamilyUserMetricsSessionEngagementDuration));
}
// Tests destroying FamilyUserSessionMetrics without invoking
// OnUsageTimeStateChange(). It may happens during shutdown of device.
TEST_F(FamilyUserSessionMetricsTest,
DestructionAndCreationOfFamilyUserSessionMetrics) {
base::HistogramTester histogram_tester;
base::UserActionTester user_action_tester;
SetupTaskRunnerWithTime("1 Jan 2020 10:00");
SetSessionState(session_manager::SessionState::ACTIVE);
task_environment_.FastForwardBy(kTenMinutes);
DestructFamilyUserSessionMetrics();
SetSessionState(session_manager::SessionState::UNKNOWN);
// Engagement start metric result:
EXPECT_EQ(1,
user_action_tester.GetActionCount(
FamilyUserSessionMetrics::kSessionEngagementStartActionName));
// Engagement Hour metric result:
histogram_tester.ExpectUniqueSample(
FamilyUserSessionMetrics::kSessionEngagementWeekdayHistogramName, 10, 1);
// Duration metric result:
histogram_tester.ExpectTotalCount(
prefs::kFamilyUserMetricsSessionEngagementDuration, 0);
EXPECT_EQ(kTenMinutes,
pref_service()->GetTimeDelta(
prefs::kFamilyUserMetricsSessionEngagementDuration));
// Test restart.
InitiateFamilyUserSessionMetrics();
EXPECT_NE(session_manager::SessionState::ACTIVE, GetSessionState());
SetSessionState(session_manager::SessionState::ACTIVE);
// Engagement start metric result:
EXPECT_EQ(2,
user_action_tester.GetActionCount(
FamilyUserSessionMetrics::kSessionEngagementStartActionName));
task_environment_.FastForwardBy(kTenMinutes);
SetSessionState(session_manager::SessionState::LOCKED);
// Engagement Hour metric result:
histogram_tester.ExpectUniqueSample(
FamilyUserSessionMetrics::kSessionEngagementWeekdayHistogramName, 10, 2);
histogram_tester.ExpectTotalCount(
FamilyUserSessionMetrics::kSessionEngagementTotalHistogramName, 2);
// Duration metric result:
histogram_tester.ExpectTotalCount(
prefs::kFamilyUserMetricsSessionEngagementDuration, 0);
EXPECT_EQ(base::Minutes(20),
pref_service()->GetTimeDelta(
prefs::kFamilyUserMetricsSessionEngagementDuration));
}
} // namespace ash
|
