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
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
|
// 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/sync/model_impl/processor_entity_tracker.h"
#include <utility>
#include "base/memory/ptr_util.h"
#include "components/sync/base/model_type.h"
#include "components/sync/base/time.h"
#include "components/sync/engine/non_blocking_sync_common.h"
#include "components/sync/protocol/sync.pb.h"
#include "testing/gtest/include/gtest/gtest.h"
namespace syncer {
namespace {
const char kKey[] = "key";
const char kHash[] = "hash";
const char kId[] = "id";
const char kName[] = "name";
const char kValue1[] = "value1";
const char kValue2[] = "value2";
const char kValue3[] = "value3";
sync_pb::EntitySpecifics GenerateSpecifics(const std::string& name,
const std::string& value) {
sync_pb::EntitySpecifics specifics;
specifics.mutable_preference()->set_name(name);
specifics.mutable_preference()->set_value(value);
return specifics;
}
std::unique_ptr<EntityData> GenerateEntityData(const std::string& hash,
const std::string& name,
const std::string& value) {
std::unique_ptr<EntityData> entity_data(new EntityData());
entity_data->client_tag_hash = hash;
entity_data->specifics = GenerateSpecifics(name, value);
entity_data->non_unique_name = name;
return entity_data;
}
UpdateResponseData GenerateUpdate(const ProcessorEntityTracker& entity,
const std::string& hash,
const std::string& id,
const std::string& name,
const std::string& value,
const base::Time& mtime,
int64_t version) {
std::unique_ptr<EntityData> data = GenerateEntityData(hash, name, value);
data->id = id;
data->modification_time = mtime;
UpdateResponseData update;
update.entity = data->PassToPtr();
update.response_version = version;
return update;
}
UpdateResponseData GenerateTombstone(const ProcessorEntityTracker& entity,
const std::string& hash,
const std::string& id,
const std::string& name,
const base::Time& mtime,
int64_t version) {
std::unique_ptr<EntityData> data = base::MakeUnique<EntityData>();
data->client_tag_hash = hash;
data->non_unique_name = name;
data->id = id;
data->modification_time = mtime;
UpdateResponseData update;
update.entity = data->PassToPtr();
update.response_version = version;
return update;
}
CommitResponseData GenerateAckData(const CommitRequestData& request,
const std::string id,
int64_t version) {
CommitResponseData response;
response.id = id;
response.client_tag_hash = request.entity->client_tag_hash;
response.sequence_number = request.sequence_number;
response.response_version = version;
response.specifics_hash = request.specifics_hash;
return response;
}
} // namespace
// Some simple sanity tests for the ProcessorEntityTracker.
//
// A lot of the more complicated sync logic is implemented in the
// SharedModelTypeProcessor that owns the ProcessorEntityTracker. We can't unit
// test it here.
//
// Instead, we focus on simple tests to make sure that variables are getting
// properly intialized and flags properly set. Anything more complicated would
// be a redundant and incomplete version of the SharedModelTypeProcessor tests.
class ProcessorEntityTrackerTest : public ::testing::Test {
public:
ProcessorEntityTrackerTest()
: ctime_(base::Time::Now() - base::TimeDelta::FromSeconds(1)) {}
std::unique_ptr<ProcessorEntityTracker> CreateNew() {
return ProcessorEntityTracker::CreateNew(kKey, kHash, "", ctime_);
}
std::unique_ptr<ProcessorEntityTracker> CreateSynced() {
std::unique_ptr<ProcessorEntityTracker> entity = CreateNew();
entity->RecordAcceptedUpdate(
GenerateUpdate(*entity, kHash, kId, kName, kValue1, ctime_, 1));
DCHECK(!entity->IsUnsynced());
return entity;
}
const base::Time ctime_;
};
// Test the state of the default new tracker.
TEST_F(ProcessorEntityTrackerTest, DefaultTracker) {
std::unique_ptr<ProcessorEntityTracker> entity = CreateNew();
EXPECT_EQ(kKey, entity->storage_key());
EXPECT_EQ(kHash, entity->metadata().client_tag_hash());
EXPECT_EQ("", entity->metadata().server_id());
EXPECT_FALSE(entity->metadata().is_deleted());
EXPECT_EQ(0, entity->metadata().sequence_number());
EXPECT_EQ(0, entity->metadata().acked_sequence_number());
EXPECT_EQ(kUncommittedVersion, entity->metadata().server_version());
EXPECT_EQ(TimeToProtoTime(ctime_), entity->metadata().creation_time());
EXPECT_EQ(0, entity->metadata().modification_time());
EXPECT_TRUE(entity->metadata().specifics_hash().empty());
EXPECT_TRUE(entity->metadata().base_specifics_hash().empty());
EXPECT_FALSE(entity->IsUnsynced());
EXPECT_FALSE(entity->RequiresCommitRequest());
EXPECT_FALSE(entity->RequiresCommitData());
EXPECT_FALSE(entity->CanClearMetadata());
EXPECT_FALSE(entity->UpdateIsReflection(1));
EXPECT_FALSE(entity->HasCommitData());
}
// Test creating and commiting a new local item.
TEST_F(ProcessorEntityTrackerTest, NewLocalItem) {
std::unique_ptr<ProcessorEntityTracker> entity = CreateNew();
entity->MakeLocalChange(GenerateEntityData(kHash, kName, kValue1));
EXPECT_EQ("", entity->metadata().server_id());
EXPECT_FALSE(entity->metadata().is_deleted());
EXPECT_EQ(1, entity->metadata().sequence_number());
EXPECT_EQ(0, entity->metadata().acked_sequence_number());
EXPECT_EQ(kUncommittedVersion, entity->metadata().server_version());
EXPECT_NE(0, entity->metadata().modification_time());
EXPECT_FALSE(entity->metadata().specifics_hash().empty());
EXPECT_TRUE(entity->metadata().base_specifics_hash().empty());
EXPECT_TRUE(entity->IsUnsynced());
EXPECT_TRUE(entity->RequiresCommitRequest());
EXPECT_FALSE(entity->RequiresCommitData());
EXPECT_FALSE(entity->CanClearMetadata());
EXPECT_FALSE(entity->UpdateIsReflection(1));
EXPECT_TRUE(entity->HasCommitData());
EXPECT_EQ(kValue1, entity->commit_data()->specifics.preference().value());
// Generate a commit request. The metadata should not change.
const sync_pb::EntityMetadata metadata_v1 = entity->metadata();
CommitRequestData request;
entity->InitializeCommitRequestData(&request);
EXPECT_EQ(metadata_v1.SerializeAsString(),
entity->metadata().SerializeAsString());
EXPECT_TRUE(entity->IsUnsynced());
EXPECT_FALSE(entity->RequiresCommitRequest());
EXPECT_FALSE(entity->RequiresCommitData());
EXPECT_FALSE(entity->CanClearMetadata());
EXPECT_FALSE(entity->UpdateIsReflection(1));
EXPECT_TRUE(entity->HasCommitData());
const EntityData& data = request.entity.value();
EXPECT_EQ("", data.id);
EXPECT_EQ(kHash, data.client_tag_hash);
EXPECT_EQ(kName, data.non_unique_name);
EXPECT_EQ(kValue1, data.specifics.preference().value());
EXPECT_EQ(TimeToProtoTime(ctime_), TimeToProtoTime(data.creation_time));
EXPECT_EQ(entity->metadata().modification_time(),
TimeToProtoTime(data.modification_time));
EXPECT_FALSE(data.is_deleted());
EXPECT_EQ(1, request.sequence_number);
EXPECT_EQ(kUncommittedVersion, request.base_version);
EXPECT_EQ(entity->metadata().specifics_hash(), request.specifics_hash);
// Ack the commit.
entity->ReceiveCommitResponse(GenerateAckData(request, kId, 1));
EXPECT_EQ(kId, entity->metadata().server_id());
EXPECT_FALSE(entity->metadata().is_deleted());
EXPECT_EQ(1, entity->metadata().sequence_number());
EXPECT_EQ(1, entity->metadata().acked_sequence_number());
EXPECT_EQ(1, entity->metadata().server_version());
EXPECT_EQ(metadata_v1.creation_time(), entity->metadata().creation_time());
EXPECT_EQ(metadata_v1.modification_time(),
entity->metadata().modification_time());
EXPECT_FALSE(entity->metadata().specifics_hash().empty());
EXPECT_TRUE(entity->metadata().base_specifics_hash().empty());
EXPECT_FALSE(entity->IsUnsynced());
EXPECT_FALSE(entity->RequiresCommitRequest());
EXPECT_FALSE(entity->RequiresCommitData());
EXPECT_FALSE(entity->CanClearMetadata());
EXPECT_TRUE(entity->UpdateIsReflection(1));
EXPECT_FALSE(entity->HasCommitData());
}
// Test state for a newly synced server item.
TEST_F(ProcessorEntityTrackerTest, NewServerItem) {
std::unique_ptr<ProcessorEntityTracker> entity = CreateNew();
const base::Time mtime = base::Time::Now();
entity->RecordAcceptedUpdate(
GenerateUpdate(*entity, kHash, kId, kName, kValue1, mtime, 10));
EXPECT_EQ(kId, entity->metadata().server_id());
EXPECT_FALSE(entity->metadata().is_deleted());
EXPECT_EQ(0, entity->metadata().sequence_number());
EXPECT_EQ(0, entity->metadata().acked_sequence_number());
EXPECT_EQ(10, entity->metadata().server_version());
EXPECT_EQ(TimeToProtoTime(mtime), entity->metadata().modification_time());
EXPECT_FALSE(entity->metadata().specifics_hash().empty());
EXPECT_TRUE(entity->metadata().base_specifics_hash().empty());
EXPECT_FALSE(entity->IsUnsynced());
EXPECT_FALSE(entity->RequiresCommitRequest());
EXPECT_FALSE(entity->RequiresCommitData());
EXPECT_FALSE(entity->CanClearMetadata());
EXPECT_TRUE(entity->UpdateIsReflection(9));
EXPECT_TRUE(entity->UpdateIsReflection(10));
EXPECT_FALSE(entity->UpdateIsReflection(11));
EXPECT_FALSE(entity->HasCommitData());
}
// Test state for a tombstone received for a previously unknown item.
TEST_F(ProcessorEntityTrackerTest, NewServerTombstone) {
std::unique_ptr<ProcessorEntityTracker> entity = CreateNew();
const base::Time mtime = base::Time::Now();
entity->RecordAcceptedUpdate(
GenerateTombstone(*entity, kHash, kId, kName, mtime, 1));
EXPECT_EQ(kId, entity->metadata().server_id());
EXPECT_TRUE(entity->metadata().is_deleted());
EXPECT_EQ(0, entity->metadata().sequence_number());
EXPECT_EQ(0, entity->metadata().acked_sequence_number());
EXPECT_EQ(1, entity->metadata().server_version());
EXPECT_EQ(TimeToProtoTime(mtime), entity->metadata().modification_time());
EXPECT_TRUE(entity->metadata().specifics_hash().empty());
EXPECT_TRUE(entity->metadata().base_specifics_hash().empty());
EXPECT_FALSE(entity->IsUnsynced());
EXPECT_FALSE(entity->RequiresCommitRequest());
EXPECT_FALSE(entity->RequiresCommitData());
EXPECT_TRUE(entity->CanClearMetadata());
EXPECT_TRUE(entity->UpdateIsReflection(1));
EXPECT_FALSE(entity->UpdateIsReflection(2));
EXPECT_FALSE(entity->HasCommitData());
}
// Apply a deletion update to a synced item.
TEST_F(ProcessorEntityTrackerTest, ServerTombstone) {
// Start with a non-deleted state with version 1.
std::unique_ptr<ProcessorEntityTracker> entity = CreateSynced();
// A deletion update one version later.
const base::Time mtime = base::Time::Now();
entity->RecordAcceptedUpdate(
GenerateTombstone(*entity, kHash, kId, kName, mtime, 2));
EXPECT_TRUE(entity->metadata().is_deleted());
EXPECT_EQ(0, entity->metadata().sequence_number());
EXPECT_EQ(0, entity->metadata().acked_sequence_number());
EXPECT_EQ(2, entity->metadata().server_version());
EXPECT_EQ(TimeToProtoTime(mtime), entity->metadata().modification_time());
EXPECT_TRUE(entity->metadata().specifics_hash().empty());
EXPECT_TRUE(entity->metadata().base_specifics_hash().empty());
EXPECT_FALSE(entity->IsUnsynced());
EXPECT_FALSE(entity->RequiresCommitRequest());
EXPECT_FALSE(entity->RequiresCommitData());
EXPECT_TRUE(entity->CanClearMetadata());
EXPECT_TRUE(entity->UpdateIsReflection(2));
EXPECT_FALSE(entity->UpdateIsReflection(3));
EXPECT_FALSE(entity->HasCommitData());
}
// Test a local change of a synced item.
TEST_F(ProcessorEntityTrackerTest, LocalChange) {
std::unique_ptr<ProcessorEntityTracker> entity = CreateSynced();
const int64_t mtime_v0 = entity->metadata().modification_time();
const std::string specifics_hash_v0 = entity->metadata().specifics_hash();
// Make a local change with different specifics.
entity->MakeLocalChange(GenerateEntityData(kHash, kName, kValue2));
const int64_t mtime_v1 = entity->metadata().modification_time();
const std::string specifics_hash_v1 = entity->metadata().specifics_hash();
EXPECT_FALSE(entity->metadata().is_deleted());
EXPECT_EQ(1, entity->metadata().sequence_number());
EXPECT_EQ(0, entity->metadata().acked_sequence_number());
EXPECT_EQ(1, entity->metadata().server_version());
EXPECT_LT(mtime_v0, mtime_v1);
EXPECT_NE(specifics_hash_v0, specifics_hash_v1);
EXPECT_EQ(specifics_hash_v0, entity->metadata().base_specifics_hash());
EXPECT_TRUE(entity->IsUnsynced());
EXPECT_TRUE(entity->RequiresCommitRequest());
EXPECT_FALSE(entity->RequiresCommitData());
EXPECT_FALSE(entity->CanClearMetadata());
EXPECT_TRUE(entity->HasCommitData());
// Make a commit.
CommitRequestData request;
entity->InitializeCommitRequestData(&request);
EXPECT_EQ(kId, request.entity->id);
EXPECT_FALSE(entity->RequiresCommitRequest());
// Ack the commit.
entity->ReceiveCommitResponse(GenerateAckData(request, kId, 2));
EXPECT_EQ(1, entity->metadata().sequence_number());
EXPECT_EQ(1, entity->metadata().acked_sequence_number());
EXPECT_EQ(2, entity->metadata().server_version());
EXPECT_EQ(mtime_v1, entity->metadata().modification_time());
EXPECT_EQ(specifics_hash_v1, entity->metadata().specifics_hash());
EXPECT_EQ("", entity->metadata().base_specifics_hash());
EXPECT_FALSE(entity->IsUnsynced());
EXPECT_FALSE(entity->RequiresCommitRequest());
EXPECT_FALSE(entity->RequiresCommitData());
EXPECT_FALSE(entity->CanClearMetadata());
EXPECT_FALSE(entity->HasCommitData());
}
// Test a local deletion of a synced item.
TEST_F(ProcessorEntityTrackerTest, LocalDeletion) {
std::unique_ptr<ProcessorEntityTracker> entity = CreateSynced();
const int64_t mtime = entity->metadata().modification_time();
const std::string specifics_hash = entity->metadata().specifics_hash();
// Make a local delete.
entity->Delete();
EXPECT_TRUE(entity->metadata().is_deleted());
EXPECT_EQ(1, entity->metadata().sequence_number());
EXPECT_EQ(0, entity->metadata().acked_sequence_number());
EXPECT_EQ(1, entity->metadata().server_version());
EXPECT_LT(mtime, entity->metadata().modification_time());
EXPECT_TRUE(entity->metadata().specifics_hash().empty());
EXPECT_EQ(specifics_hash, entity->metadata().base_specifics_hash());
EXPECT_TRUE(entity->IsUnsynced());
EXPECT_TRUE(entity->RequiresCommitRequest());
EXPECT_FALSE(entity->RequiresCommitData());
EXPECT_FALSE(entity->CanClearMetadata());
EXPECT_FALSE(entity->HasCommitData());
// Generate a commit request. The metadata should not change.
const sync_pb::EntityMetadata metadata_v1 = entity->metadata();
CommitRequestData request;
entity->InitializeCommitRequestData(&request);
EXPECT_EQ(metadata_v1.SerializeAsString(),
entity->metadata().SerializeAsString());
EXPECT_TRUE(entity->IsUnsynced());
EXPECT_FALSE(entity->RequiresCommitRequest());
EXPECT_FALSE(entity->RequiresCommitData());
EXPECT_FALSE(entity->CanClearMetadata());
EXPECT_FALSE(entity->HasCommitData());
const EntityData& data = request.entity.value();
EXPECT_EQ(kId, data.id);
EXPECT_EQ(kHash, data.client_tag_hash);
EXPECT_EQ("", data.non_unique_name);
EXPECT_EQ(TimeToProtoTime(ctime_), TimeToProtoTime(data.creation_time));
EXPECT_EQ(entity->metadata().modification_time(),
TimeToProtoTime(data.modification_time));
EXPECT_TRUE(data.is_deleted());
EXPECT_EQ(1, request.sequence_number);
EXPECT_EQ(1, request.base_version);
EXPECT_EQ(entity->metadata().specifics_hash(), request.specifics_hash);
// Ack the deletion.
entity->ReceiveCommitResponse(GenerateAckData(request, kId, 2));
EXPECT_TRUE(entity->metadata().is_deleted());
EXPECT_EQ(1, entity->metadata().sequence_number());
EXPECT_EQ(1, entity->metadata().acked_sequence_number());
EXPECT_EQ(2, entity->metadata().server_version());
EXPECT_EQ(metadata_v1.modification_time(),
entity->metadata().modification_time());
EXPECT_TRUE(entity->metadata().specifics_hash().empty());
EXPECT_TRUE(entity->metadata().base_specifics_hash().empty());
EXPECT_FALSE(entity->IsUnsynced());
EXPECT_FALSE(entity->RequiresCommitRequest());
EXPECT_FALSE(entity->RequiresCommitData());
EXPECT_TRUE(entity->CanClearMetadata());
EXPECT_FALSE(entity->HasCommitData());
}
// Test that hashes and sequence numbers are handled correctly for the "commit
// commit, ack ack" case.
TEST_F(ProcessorEntityTrackerTest, LocalChangesInterleaved) {
std::unique_ptr<ProcessorEntityTracker> entity = CreateSynced();
const std::string specifics_hash_v0 = entity->metadata().specifics_hash();
// Make the first change.
entity->MakeLocalChange(GenerateEntityData(kHash, kName, kValue2));
const std::string specifics_hash_v1 = entity->metadata().specifics_hash();
EXPECT_EQ(1, entity->metadata().sequence_number());
EXPECT_EQ(0, entity->metadata().acked_sequence_number());
EXPECT_NE(specifics_hash_v0, specifics_hash_v1);
EXPECT_EQ(specifics_hash_v0, entity->metadata().base_specifics_hash());
// Request the first commit.
CommitRequestData request_v1;
entity->InitializeCommitRequestData(&request_v1);
// Make the second change.
entity->MakeLocalChange(GenerateEntityData(kHash, kName, kValue3));
const std::string specifics_hash_v2 = entity->metadata().specifics_hash();
EXPECT_EQ(2, entity->metadata().sequence_number());
EXPECT_EQ(0, entity->metadata().acked_sequence_number());
EXPECT_NE(specifics_hash_v1, specifics_hash_v2);
EXPECT_EQ(specifics_hash_v0, entity->metadata().base_specifics_hash());
// Request the second commit.
CommitRequestData request_v2;
entity->InitializeCommitRequestData(&request_v2);
EXPECT_TRUE(entity->IsUnsynced());
EXPECT_FALSE(entity->RequiresCommitRequest());
EXPECT_FALSE(entity->RequiresCommitData());
EXPECT_FALSE(entity->CanClearMetadata());
EXPECT_TRUE(entity->HasCommitData());
// Ack the first commit.
entity->ReceiveCommitResponse(GenerateAckData(request_v1, kId, 2));
EXPECT_EQ(2, entity->metadata().sequence_number());
EXPECT_EQ(1, entity->metadata().acked_sequence_number());
EXPECT_EQ(2, entity->metadata().server_version());
EXPECT_EQ(specifics_hash_v2, entity->metadata().specifics_hash());
EXPECT_EQ(specifics_hash_v1, entity->metadata().base_specifics_hash());
EXPECT_TRUE(entity->IsUnsynced());
EXPECT_FALSE(entity->RequiresCommitRequest());
EXPECT_FALSE(entity->RequiresCommitData());
EXPECT_FALSE(entity->CanClearMetadata());
EXPECT_TRUE(entity->HasCommitData());
// Ack the second commit.
entity->ReceiveCommitResponse(GenerateAckData(request_v2, kId, 3));
EXPECT_EQ(2, entity->metadata().sequence_number());
EXPECT_EQ(2, entity->metadata().acked_sequence_number());
EXPECT_EQ(3, entity->metadata().server_version());
EXPECT_EQ(specifics_hash_v2, entity->metadata().specifics_hash());
EXPECT_EQ("", entity->metadata().base_specifics_hash());
EXPECT_FALSE(entity->IsUnsynced());
EXPECT_FALSE(entity->RequiresCommitRequest());
EXPECT_FALSE(entity->RequiresCommitData());
EXPECT_FALSE(entity->CanClearMetadata());
EXPECT_FALSE(entity->HasCommitData());
}
} // namespace syncer
|
