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
|
// Copyright 2016 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/desktop_session_duration/desktop_session_duration_tracker.h"
#include "base/test/metrics/histogram_tester.h"
#include "base/test/task_environment.h"
#include "base/threading/platform_thread.h"
#include "testing/gtest/include/gtest/gtest.h"
namespace metrics {
namespace {
const base::TimeDelta kZeroTime = base::Seconds(0);
const base::TimeDelta kInactivityTimeoutForTesting = base::Seconds(1);
// Mock class for |DesktopSessionDurationTracker| for testing.
class MockDesktopSessionDurationTracker : public DesktopSessionDurationTracker {
public:
MockDesktopSessionDurationTracker() = default;
MockDesktopSessionDurationTracker(const MockDesktopSessionDurationTracker&) =
delete;
MockDesktopSessionDurationTracker& operator=(
const MockDesktopSessionDurationTracker&) = delete;
bool is_timeout() const { return time_out_; }
using DesktopSessionDurationTracker::OnAudioStart;
using DesktopSessionDurationTracker::OnAudioEnd;
protected:
void OnTimerFired() override {
DesktopSessionDurationTracker::OnTimerFired();
time_out_ = true;
}
private:
bool time_out_ = false;
};
// Mock class for |DesktopSessionDurationTracker::Observer| for testing.
class MockDesktopSessionObserver
: public metrics::DesktopSessionDurationTracker::Observer {
public:
MockDesktopSessionObserver() = default;
MockDesktopSessionObserver(const MockDesktopSessionObserver&) = delete;
MockDesktopSessionObserver& operator=(const MockDesktopSessionObserver&) =
delete;
int session_started_count() const { return session_started_count_; }
int session_ended_count() const { return session_ended_count_; }
protected:
// metrics::DesktopSessionDurationTracker::Observer:
void OnSessionStarted(base::TimeTicks session_start) override {
session_started_count_ = true;
}
void OnSessionEnded(base::TimeDelta session_length,
base::TimeTicks session_end) override {
session_ended_count_ = true;
}
private:
int session_started_count_ = false;
int session_ended_count_ = false;
};
class DesktopSessionDurationTrackerTest : public testing::Test {
public:
DesktopSessionDurationTrackerTest() = default;
DesktopSessionDurationTrackerTest(const DesktopSessionDurationTrackerTest&) =
delete;
DesktopSessionDurationTrackerTest& operator=(
const DesktopSessionDurationTrackerTest&) = delete;
void SetUp() override {
metrics::DesktopSessionDurationTracker::Initialize();
instance_.SetInactivityTimeoutForTesting(kInactivityTimeoutForTesting);
}
void TearDown() override {
metrics::DesktopSessionDurationTracker::CleanupForTesting();
}
void ExpectTotalDuration(base::TimeDelta duration) {
histogram_tester_.ExpectTotalCount("Session.TotalDuration", 1);
base::Bucket bucket =
histogram_tester_.GetAllSamples("Session.TotalDuration")[0];
int max_expected_value = duration.InMilliseconds();
EXPECT_LE(bucket.min, max_expected_value);
}
base::HistogramTester histogram_tester_;
MockDesktopSessionDurationTracker instance_;
MockDesktopSessionObserver observer_;
private:
base::test::SingleThreadTaskEnvironment task_environment_;
};
} // namespace
TEST_F(DesktopSessionDurationTrackerTest, TestVisibility) {
// The browser becomes visible but it shouldn't start the session.
instance_.OnVisibilityChanged(true, kZeroTime);
EXPECT_FALSE(instance_.in_session());
EXPECT_TRUE(instance_.is_visible());
EXPECT_FALSE(instance_.is_audio_playing());
histogram_tester_.ExpectTotalCount("Session.TotalDuration", 0);
instance_.OnUserEvent();
EXPECT_TRUE(instance_.in_session());
EXPECT_TRUE(instance_.is_visible());
EXPECT_FALSE(instance_.is_audio_playing());
histogram_tester_.ExpectTotalCount("Session.TotalDuration", 0);
// Even if there is a recent user event visibility change should end the
// session.
instance_.OnUserEvent();
instance_.OnUserEvent();
instance_.OnVisibilityChanged(false, kZeroTime);
EXPECT_FALSE(instance_.in_session());
EXPECT_FALSE(instance_.is_visible());
EXPECT_FALSE(instance_.is_audio_playing());
histogram_tester_.ExpectTotalCount("Session.TotalDuration", 1);
// For the second time only visibility change should start the session.
instance_.OnVisibilityChanged(true, kZeroTime);
EXPECT_TRUE(instance_.in_session());
EXPECT_TRUE(instance_.is_visible());
EXPECT_FALSE(instance_.is_audio_playing());
histogram_tester_.ExpectTotalCount("Session.TotalDuration", 1);
instance_.OnVisibilityChanged(false, kZeroTime);
EXPECT_FALSE(instance_.in_session());
EXPECT_FALSE(instance_.is_visible());
EXPECT_FALSE(instance_.is_audio_playing());
histogram_tester_.ExpectTotalCount("Session.TotalDuration", 2);
}
TEST_F(DesktopSessionDurationTrackerTest, TestUserEvent) {
EXPECT_FALSE(instance_.in_session());
EXPECT_FALSE(instance_.is_visible());
EXPECT_FALSE(instance_.is_audio_playing());
histogram_tester_.ExpectTotalCount("Session.TotalDuration", 0);
// User event doesn't go through if nothing is visible.
instance_.OnUserEvent();
EXPECT_FALSE(instance_.in_session());
EXPECT_FALSE(instance_.is_visible());
EXPECT_FALSE(instance_.is_audio_playing());
histogram_tester_.ExpectTotalCount("Session.TotalDuration", 0);
instance_.OnVisibilityChanged(true, kZeroTime);
instance_.OnUserEvent();
EXPECT_TRUE(instance_.in_session());
EXPECT_TRUE(instance_.is_visible());
EXPECT_FALSE(instance_.is_audio_playing());
histogram_tester_.ExpectTotalCount("Session.TotalDuration", 0);
// Wait until the session expires.
while (!instance_.is_timeout()) {
base::RunLoop().RunUntilIdle();
}
EXPECT_FALSE(instance_.in_session());
EXPECT_TRUE(instance_.is_visible());
EXPECT_FALSE(instance_.is_audio_playing());
histogram_tester_.ExpectTotalCount("Session.TotalDuration", 1);
}
TEST_F(DesktopSessionDurationTrackerTest, TestAudioEvent) {
instance_.OnVisibilityChanged(true, kZeroTime);
instance_.OnAudioStart();
EXPECT_TRUE(instance_.in_session());
EXPECT_TRUE(instance_.is_visible());
EXPECT_TRUE(instance_.is_audio_playing());
histogram_tester_.ExpectTotalCount("Session.TotalDuration", 0);
instance_.OnVisibilityChanged(false, kZeroTime);
EXPECT_TRUE(instance_.in_session());
EXPECT_FALSE(instance_.is_visible());
EXPECT_TRUE(instance_.is_audio_playing());
histogram_tester_.ExpectTotalCount("Session.TotalDuration", 0);
instance_.OnAudioEnd();
EXPECT_TRUE(instance_.in_session());
EXPECT_FALSE(instance_.is_visible());
EXPECT_FALSE(instance_.is_audio_playing());
histogram_tester_.ExpectTotalCount("Session.TotalDuration", 0);
// Wait until the session expires.
while (!instance_.is_timeout()) {
base::RunLoop().RunUntilIdle();
}
EXPECT_FALSE(instance_.in_session());
EXPECT_FALSE(instance_.is_visible());
EXPECT_FALSE(instance_.is_audio_playing());
histogram_tester_.ExpectTotalCount("Session.TotalDuration", 1);
}
TEST_F(DesktopSessionDurationTrackerTest, TestInputTimeoutDiscount) {
instance_.OnVisibilityChanged(true, kZeroTime);
base::TimeTicks before_session_start = base::TimeTicks::Now();
instance_.OnUserEvent(); // This should start the session
histogram_tester_.ExpectTotalCount("Session.TotalDuration", 0);
// Wait until the session expires.
while (!instance_.is_timeout()) {
base::RunLoop().RunUntilIdle();
}
base::TimeTicks after_session_end = base::TimeTicks::Now();
ExpectTotalDuration(after_session_end - before_session_start -
kInactivityTimeoutForTesting);
}
TEST_F(DesktopSessionDurationTrackerTest, TestVisibilityTimeoutDiscount) {
instance_.OnVisibilityChanged(true, kZeroTime);
base::TimeTicks before_session_start = base::TimeTicks::Now();
instance_.OnUserEvent(); // This should start the session
histogram_tester_.ExpectTotalCount("Session.TotalDuration", 0);
// Sleep a little while.
base::TimeDelta kDelay = base::Seconds(2);
while (true) {
base::TimeDelta elapsed = base::TimeTicks::Now() - before_session_start;
if (elapsed >= kDelay)
break;
base::PlatformThread::Sleep(kDelay);
}
// End the session via visibility change.
instance_.OnVisibilityChanged(false, kDelay);
base::TimeTicks after_session_end = base::TimeTicks::Now();
ExpectTotalDuration(after_session_end - before_session_start - kDelay);
}
TEST_F(DesktopSessionDurationTrackerTest, TestObserver) {
instance_.AddObserver(&observer_);
EXPECT_FALSE(instance_.in_session());
EXPECT_FALSE(instance_.is_visible());
EXPECT_EQ(observer_.session_started_count(), 0);
EXPECT_EQ(observer_.session_ended_count(), 0);
histogram_tester_.ExpectTotalCount("Session.TotalDuration", 0);
instance_.OnVisibilityChanged(true, kZeroTime);
instance_.OnUserEvent();
EXPECT_TRUE(instance_.in_session());
EXPECT_TRUE(instance_.is_visible());
EXPECT_EQ(observer_.session_ended_count(), 0);
EXPECT_EQ(observer_.session_started_count(), 1);
histogram_tester_.ExpectTotalCount("Session.TotalDuration", 0);
// Wait until the session expires.
while (!instance_.is_timeout()) {
base::RunLoop().RunUntilIdle();
}
EXPECT_FALSE(instance_.in_session());
EXPECT_TRUE(instance_.is_visible());
EXPECT_EQ(observer_.session_started_count(), 1);
EXPECT_EQ(observer_.session_ended_count(), 1);
histogram_tester_.ExpectTotalCount("Session.TotalDuration", 1);
}
TEST_F(DesktopSessionDurationTrackerTest, TestNoDoubleEndSession) {
instance_.AddObserver(&observer_);
EXPECT_FALSE(instance_.in_session());
EXPECT_FALSE(instance_.is_visible());
EXPECT_EQ(observer_.session_started_count(), 0);
EXPECT_EQ(observer_.session_ended_count(), 0);
histogram_tester_.ExpectTotalCount("Session.TotalDuration", 0);
instance_.OnVisibilityChanged(true, kZeroTime);
instance_.OnUserEvent();
EXPECT_TRUE(instance_.in_session());
EXPECT_TRUE(instance_.is_visible());
EXPECT_EQ(observer_.session_ended_count(), 0);
EXPECT_EQ(observer_.session_started_count(), 1);
histogram_tester_.ExpectTotalCount("Session.TotalDuration", 0);
// Simulate Chrome being hidden. This should end the session.
instance_.OnVisibilityChanged(false, kZeroTime);
EXPECT_FALSE(instance_.in_session());
EXPECT_FALSE(instance_.is_visible());
EXPECT_EQ(observer_.session_ended_count(), 1);
EXPECT_EQ(observer_.session_started_count(), 1);
histogram_tester_.ExpectTotalCount("Session.TotalDuration", 1);
// When the timeout expires, observers shouldn't be notified again and the
// histogram shouldn't be recorded again.
base::PlatformThread::Sleep(kInactivityTimeoutForTesting * 2);
EXPECT_EQ(observer_.session_ended_count(), 1);
EXPECT_EQ(observer_.session_started_count(), 1);
histogram_tester_.ExpectTotalCount("Session.TotalDuration", 1);
}
} // namespace metrics
|
