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
|
// Copyright 2014 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "components/metrics/metrics_log_manager.h"
#include <stddef.h>
#include <string>
#include <utility>
#include <vector>
#include "base/memory/ptr_util.h"
#include "components/metrics/metrics_log.h"
#include "components/metrics/metrics_pref_names.h"
#include "components/metrics/persisted_logs_metrics_impl.h"
#include "components/metrics/test_metrics_service_client.h"
#include "components/prefs/pref_registry_simple.h"
#include "components/prefs/testing_pref_service.h"
#include "testing/gtest/include/gtest/gtest.h"
namespace metrics {
namespace {
// Dummy serializer that just stores logs in memory.
class TestLogPrefService : public TestingPrefServiceSimple {
public:
TestLogPrefService() {
registry()->RegisterListPref(prefs::kMetricsInitialLogs);
registry()->RegisterListPref(prefs::kMetricsOngoingLogs);
}
// Returns the number of logs of the given type.
size_t TypeCount(MetricsLog::LogType log_type) {
int list_length = 0;
if (log_type == MetricsLog::INITIAL_STABILITY_LOG)
list_length = GetList(prefs::kMetricsInitialLogs)->GetSize();
else
list_length = GetList(prefs::kMetricsOngoingLogs)->GetSize();
return list_length;
}
};
} // namespace
TEST(MetricsLogManagerTest, StandardFlow) {
TestMetricsServiceClient client;
TestLogPrefService pref_service;
MetricsLogManager log_manager(&pref_service, 0);
// Make sure a new manager has a clean slate.
EXPECT_EQ(NULL, log_manager.current_log());
EXPECT_FALSE(log_manager.has_staged_log());
EXPECT_FALSE(log_manager.has_unsent_logs());
// Check that the normal flow works.
MetricsLog* initial_log = new MetricsLog(
"id", 0, MetricsLog::INITIAL_STABILITY_LOG, &client, &pref_service);
log_manager.BeginLoggingWithLog(base::WrapUnique(initial_log));
EXPECT_EQ(initial_log, log_manager.current_log());
EXPECT_FALSE(log_manager.has_staged_log());
log_manager.FinishCurrentLog();
EXPECT_EQ(NULL, log_manager.current_log());
EXPECT_TRUE(log_manager.has_unsent_logs());
EXPECT_FALSE(log_manager.has_staged_log());
MetricsLog* second_log =
new MetricsLog("id", 0, MetricsLog::ONGOING_LOG, &client, &pref_service);
log_manager.BeginLoggingWithLog(base::WrapUnique(second_log));
EXPECT_EQ(second_log, log_manager.current_log());
log_manager.StageNextLogForUpload();
EXPECT_TRUE(log_manager.has_staged_log());
EXPECT_FALSE(log_manager.staged_log().empty());
log_manager.DiscardStagedLog();
EXPECT_EQ(second_log, log_manager.current_log());
EXPECT_FALSE(log_manager.has_staged_log());
EXPECT_FALSE(log_manager.has_unsent_logs());
EXPECT_FALSE(log_manager.has_unsent_logs());
}
TEST(MetricsLogManagerTest, AbandonedLog) {
TestMetricsServiceClient client;
TestLogPrefService pref_service;
MetricsLogManager log_manager(&pref_service, 0);
MetricsLog* dummy_log = new MetricsLog(
"id", 0, MetricsLog::INITIAL_STABILITY_LOG, &client, &pref_service);
log_manager.BeginLoggingWithLog(base::WrapUnique(dummy_log));
EXPECT_EQ(dummy_log, log_manager.current_log());
log_manager.DiscardCurrentLog();
EXPECT_EQ(NULL, log_manager.current_log());
EXPECT_FALSE(log_manager.has_staged_log());
}
TEST(MetricsLogManagerTest, InterjectedLog) {
TestMetricsServiceClient client;
TestLogPrefService pref_service;
MetricsLogManager log_manager(&pref_service, 0);
MetricsLog* ongoing_log =
new MetricsLog("id", 0, MetricsLog::ONGOING_LOG, &client, &pref_service);
MetricsLog* temp_log = new MetricsLog(
"id", 0, MetricsLog::INITIAL_STABILITY_LOG, &client, &pref_service);
log_manager.BeginLoggingWithLog(base::WrapUnique(ongoing_log));
EXPECT_EQ(ongoing_log, log_manager.current_log());
log_manager.PauseCurrentLog();
EXPECT_EQ(NULL, log_manager.current_log());
log_manager.BeginLoggingWithLog(base::WrapUnique(temp_log));
EXPECT_EQ(temp_log, log_manager.current_log());
log_manager.FinishCurrentLog();
EXPECT_EQ(NULL, log_manager.current_log());
log_manager.ResumePausedLog();
EXPECT_EQ(ongoing_log, log_manager.current_log());
EXPECT_FALSE(log_manager.has_staged_log());
log_manager.StageNextLogForUpload();
log_manager.DiscardStagedLog();
EXPECT_FALSE(log_manager.has_unsent_logs());
}
TEST(MetricsLogManagerTest, InterjectedLogPreservesType) {
TestMetricsServiceClient client;
TestLogPrefService pref_service;
MetricsLogManager log_manager(&pref_service, 0);
log_manager.LoadPersistedUnsentLogs();
log_manager.BeginLoggingWithLog(base::MakeUnique<MetricsLog>(
"id", 0, MetricsLog::ONGOING_LOG, &client, &pref_service));
log_manager.PauseCurrentLog();
log_manager.BeginLoggingWithLog(base::MakeUnique<MetricsLog>(
"id", 0, MetricsLog::INITIAL_STABILITY_LOG, &client, &pref_service));
log_manager.FinishCurrentLog();
log_manager.ResumePausedLog();
log_manager.StageNextLogForUpload();
log_manager.DiscardStagedLog();
// Verify that the remaining log (which is the original ongoing log) still
// has the right type.
log_manager.FinishCurrentLog();
log_manager.PersistUnsentLogs();
EXPECT_EQ(0U, pref_service.TypeCount(MetricsLog::INITIAL_STABILITY_LOG));
EXPECT_EQ(1U, pref_service.TypeCount(MetricsLog::ONGOING_LOG));
}
TEST(MetricsLogManagerTest, StoreAndLoad) {
TestMetricsServiceClient client;
TestLogPrefService pref_service;
// Set up some in-progress logging in a scoped log manager simulating the
// leadup to quitting, then persist as would be done on quit.
{
MetricsLogManager log_manager(&pref_service, 0);
log_manager.LoadPersistedUnsentLogs();
// Simulate a log having already been unsent from a previous session.
{
std::string log("proto");
PersistedLogs ongoing_logs(std::unique_ptr<PersistedLogsMetricsImpl>(
new PersistedLogsMetricsImpl()),
&pref_service, prefs::kMetricsOngoingLogs,
1, 1, 0);
ongoing_logs.StoreLog(log);
ongoing_logs.SerializeLogs();
}
EXPECT_EQ(1U, pref_service.TypeCount(MetricsLog::ONGOING_LOG));
EXPECT_FALSE(log_manager.has_unsent_logs());
log_manager.LoadPersistedUnsentLogs();
EXPECT_TRUE(log_manager.has_unsent_logs());
log_manager.BeginLoggingWithLog(base::MakeUnique<MetricsLog>(
"id", 0, MetricsLog::INITIAL_STABILITY_LOG, &client, &pref_service));
log_manager.FinishCurrentLog();
log_manager.BeginLoggingWithLog(base::MakeUnique<MetricsLog>(
"id", 0, MetricsLog::ONGOING_LOG, &client, &pref_service));
log_manager.StageNextLogForUpload();
log_manager.FinishCurrentLog();
// Nothing should be written out until PersistUnsentLogs is called.
EXPECT_EQ(0U, pref_service.TypeCount(MetricsLog::INITIAL_STABILITY_LOG));
EXPECT_EQ(1U, pref_service.TypeCount(MetricsLog::ONGOING_LOG));
log_manager.PersistUnsentLogs();
EXPECT_EQ(1U, pref_service.TypeCount(MetricsLog::INITIAL_STABILITY_LOG));
EXPECT_EQ(2U, pref_service.TypeCount(MetricsLog::ONGOING_LOG));
}
// Now simulate the relaunch, ensure that the log manager restores
// everything correctly, and verify that once the are handled they are not
// re-persisted.
{
MetricsLogManager log_manager(&pref_service, 0);
log_manager.LoadPersistedUnsentLogs();
EXPECT_TRUE(log_manager.has_unsent_logs());
log_manager.StageNextLogForUpload();
log_manager.DiscardStagedLog();
// The initial log should be sent first; update the persisted storage to
// verify.
log_manager.PersistUnsentLogs();
EXPECT_EQ(0U, pref_service.TypeCount(MetricsLog::INITIAL_STABILITY_LOG));
EXPECT_EQ(2U, pref_service.TypeCount(MetricsLog::ONGOING_LOG));
// Handle the first ongoing log.
log_manager.StageNextLogForUpload();
log_manager.DiscardStagedLog();
EXPECT_TRUE(log_manager.has_unsent_logs());
// Handle the last log.
log_manager.StageNextLogForUpload();
log_manager.DiscardStagedLog();
EXPECT_FALSE(log_manager.has_unsent_logs());
// Nothing should have changed "on disk" since PersistUnsentLogs hasn't been
// called again.
EXPECT_EQ(2U, pref_service.TypeCount(MetricsLog::ONGOING_LOG));
// Persist, and make sure nothing is left.
log_manager.PersistUnsentLogs();
EXPECT_EQ(0U, pref_service.TypeCount(MetricsLog::INITIAL_STABILITY_LOG));
EXPECT_EQ(0U, pref_service.TypeCount(MetricsLog::ONGOING_LOG));
}
}
TEST(MetricsLogManagerTest, StoreStagedLogTypes) {
TestMetricsServiceClient client;
// Ensure that types are preserved when storing staged logs.
{
TestLogPrefService pref_service;
MetricsLogManager log_manager(&pref_service, 0);
log_manager.LoadPersistedUnsentLogs();
log_manager.BeginLoggingWithLog(base::MakeUnique<MetricsLog>(
"id", 0, MetricsLog::ONGOING_LOG, &client, &pref_service));
log_manager.FinishCurrentLog();
log_manager.StageNextLogForUpload();
log_manager.PersistUnsentLogs();
EXPECT_EQ(0U, pref_service.TypeCount(MetricsLog::INITIAL_STABILITY_LOG));
EXPECT_EQ(1U, pref_service.TypeCount(MetricsLog::ONGOING_LOG));
}
{
TestLogPrefService pref_service;
MetricsLogManager log_manager(&pref_service, 0);
log_manager.LoadPersistedUnsentLogs();
log_manager.BeginLoggingWithLog(base::MakeUnique<MetricsLog>(
"id", 0, MetricsLog::INITIAL_STABILITY_LOG, &client, &pref_service));
log_manager.FinishCurrentLog();
log_manager.StageNextLogForUpload();
log_manager.PersistUnsentLogs();
EXPECT_EQ(1U, pref_service.TypeCount(MetricsLog::INITIAL_STABILITY_LOG));
EXPECT_EQ(0U, pref_service.TypeCount(MetricsLog::ONGOING_LOG));
}
}
TEST(MetricsLogManagerTest, LargeLogDiscarding) {
TestMetricsServiceClient client;
TestLogPrefService pref_service;
// Set the size threshold very low, to verify that it's honored.
MetricsLogManager log_manager(&pref_service, 1);
log_manager.LoadPersistedUnsentLogs();
log_manager.BeginLoggingWithLog(base::MakeUnique<MetricsLog>(
"id", 0, MetricsLog::INITIAL_STABILITY_LOG, &client, &pref_service));
log_manager.FinishCurrentLog();
log_manager.BeginLoggingWithLog(base::MakeUnique<MetricsLog>(
"id", 0, MetricsLog::ONGOING_LOG, &client, &pref_service));
log_manager.FinishCurrentLog();
// Only the ongoing log should be written out, due to the threshold.
log_manager.PersistUnsentLogs();
EXPECT_EQ(1U, pref_service.TypeCount(MetricsLog::INITIAL_STABILITY_LOG));
EXPECT_EQ(0U, pref_service.TypeCount(MetricsLog::ONGOING_LOG));
}
TEST(MetricsLogManagerTest, DiscardOrder) {
// Ensure that the correct log is discarded if new logs are pushed while
// a log is staged.
TestMetricsServiceClient client;
{
TestLogPrefService pref_service;
MetricsLogManager log_manager(&pref_service, 0);
log_manager.LoadPersistedUnsentLogs();
log_manager.BeginLoggingWithLog(base::MakeUnique<MetricsLog>(
"id", 0, MetricsLog::INITIAL_STABILITY_LOG, &client, &pref_service));
log_manager.FinishCurrentLog();
log_manager.BeginLoggingWithLog(base::MakeUnique<MetricsLog>(
"id", 0, MetricsLog::ONGOING_LOG, &client, &pref_service));
log_manager.StageNextLogForUpload();
log_manager.FinishCurrentLog();
log_manager.DiscardStagedLog();
log_manager.PersistUnsentLogs();
EXPECT_EQ(0U, pref_service.TypeCount(MetricsLog::INITIAL_STABILITY_LOG));
EXPECT_EQ(1U, pref_service.TypeCount(MetricsLog::ONGOING_LOG));
}
}
} // namespace metrics
|
