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
|
// 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 "sync/internal_api/public/model_type_entity.h"
#include "base/base64.h"
#include "base/sha1.h"
#include "base/time/time.h"
#include "sync/internal_api/public/non_blocking_sync_common.h"
#include "sync/syncable/syncable_util.h"
#include "sync/util/time.h"
namespace syncer_v2 {
scoped_ptr<ModelTypeEntity> ModelTypeEntity::CreateNew(
const std::string& client_tag,
const std::string& client_tag_hash,
const std::string& id,
base::Time creation_time) {
// Initialize metadata
sync_pb::EntityMetadata metadata;
metadata.set_client_tag_hash(client_tag_hash);
if (!id.empty())
metadata.set_server_id(id);
metadata.set_sequence_number(0);
metadata.set_acked_sequence_number(0);
metadata.set_server_version(kUncommittedVersion);
metadata.set_creation_time(syncer::TimeToProtoTime(creation_time));
return scoped_ptr<ModelTypeEntity>(
new ModelTypeEntity(client_tag, &metadata));
}
ModelTypeEntity::ModelTypeEntity(const std::string& client_key,
sync_pb::EntityMetadata* metadata)
: client_key_(client_key), commit_requested_sequence_number_(0) {
DCHECK(metadata);
DCHECK(metadata->has_client_tag_hash());
metadata_.Swap(metadata);
}
ModelTypeEntity::~ModelTypeEntity() {}
void ModelTypeEntity::CacheCommitData(EntityData* data) {
commit_data_ = data->Pass();
}
bool ModelTypeEntity::HasCommitData() const {
return !commit_data_->client_tag_hash.empty();
}
bool ModelTypeEntity::IsUnsynced() const {
return metadata_.sequence_number() > metadata_.acked_sequence_number();
}
bool ModelTypeEntity::RequiresCommitRequest() const {
return metadata_.sequence_number() > commit_requested_sequence_number_;
}
bool ModelTypeEntity::UpdateIsReflection(int64 update_version) const {
return metadata_.server_version() >= update_version;
}
bool ModelTypeEntity::UpdateIsInConflict(int64 update_version) const {
return IsUnsynced() && !UpdateIsReflection(update_version);
}
void ModelTypeEntity::ApplyUpdateFromServer(
const UpdateResponseData& response_data) {
DCHECK(metadata_.has_client_tag_hash());
DCHECK(!metadata_.client_tag_hash().empty());
DCHECK(metadata_.has_creation_time());
DCHECK(metadata_.has_sequence_number());
// TODO(stanisc): crbug/561829: Filter out update if specifics hash hasn't
// changed.
// TODO(stanisc): crbug/521867: Understand and verify the conflict resolution
// logic here.
// There was a conflict and the server just won it.
// This implicitly acks all outstanding commits because a received update
// will clobber any pending commits on the sync thread.
metadata_.set_acked_sequence_number(metadata_.sequence_number());
commit_requested_sequence_number_ = metadata_.sequence_number();
metadata_.set_server_version(response_data.response_version);
metadata_.set_modification_time(
syncer::TimeToProtoTime(response_data.entity->modification_time));
UpdateSpecificsHash(response_data.entity->specifics);
encryption_key_name_ = response_data.encryption_key_name;
}
void ModelTypeEntity::MakeLocalChange(const std::string& non_unique_name,
const sync_pb::EntitySpecifics& specifics,
base::Time modification_time) {
DCHECK(metadata_.has_client_tag_hash());
DCHECK(!metadata_.client_tag_hash().empty());
DCHECK(metadata_.has_creation_time());
metadata_.set_modification_time(syncer::TimeToProtoTime(modification_time));
metadata_.set_is_deleted(false);
IncrementSequenceNumber();
UpdateSpecificsHash(specifics);
// Build and cache commit data.
// TODO(stanisc): Consider moving this out to make caching the data
// optional.
EntityData data;
data.client_tag_hash = metadata_.client_tag_hash();
data.id = metadata_.server_id();
data.non_unique_name = non_unique_name;
data.creation_time = syncer::ProtoTimeToTime(metadata_.creation_time());
data.modification_time = modification_time;
// TODO(stanisc): Consider taking over specifics value without copying.
data.specifics.CopyFrom(specifics);
CacheCommitData(&data);
}
void ModelTypeEntity::UpdateDesiredEncryptionKey(const std::string& name) {
if (encryption_key_name_ == name)
return;
DVLOG(2) << metadata_.server_id()
<< ": Encryption triggered commit: " << encryption_key_name_
<< " -> " << name;
// Schedule commit with the expectation that the worker will re-encrypt with
// the latest encryption key as it does.
IncrementSequenceNumber();
}
void ModelTypeEntity::Delete() {
IncrementSequenceNumber();
metadata_.set_is_deleted(true);
metadata_.clear_specifics_hash();
EntityData data;
data.client_tag_hash = metadata_.client_tag_hash();
data.id = metadata_.server_id();
data.creation_time = syncer::ProtoTimeToTime(metadata_.creation_time());
CacheCommitData(&data);
}
void ModelTypeEntity::InitializeCommitRequestData(
CommitRequestData* request) const {
DCHECK(HasCommitData());
DCHECK_EQ(commit_data_->client_tag_hash, metadata_.client_tag_hash());
request->sequence_number = metadata_.sequence_number();
request->base_version = metadata_.server_version();
request->entity = commit_data_;
}
void ModelTypeEntity::SetCommitRequestInProgress() {
commit_requested_sequence_number_ = metadata_.sequence_number();
}
void ModelTypeEntity::ReceiveCommitResponse(
const std::string& id,
int64 sequence_number,
int64 response_version,
const std::string& encryption_key_name) {
// The server can assign us a new ID in a commit response.
metadata_.set_server_id(id);
metadata_.set_acked_sequence_number(sequence_number);
metadata_.set_server_version(response_version);
encryption_key_name_ = encryption_key_name;
}
void ModelTypeEntity::ClearTransientSyncState() {
// If we have any unacknowledged commit requests outstanding, they've been
// dropped and we should forget about them.
commit_requested_sequence_number_ = metadata_.acked_sequence_number();
}
void ModelTypeEntity::ClearSyncState() {
// TODO(stanisc): crbug/561830: Need to review this entire method. It looks
// like the tests expect this to reset some metadata state but not the data.
// We should be able to reimplement this once we have the code fore
// fetching the data from the service.
metadata_.set_server_version(kUncommittedVersion);
// TODO(stanisc): Why is this 1 and not 0? This leaves the item unsynced.
metadata_.set_sequence_number(1);
metadata_.set_acked_sequence_number(0);
metadata_.clear_server_id();
commit_requested_sequence_number_ = 0;
}
void ModelTypeEntity::IncrementSequenceNumber() {
DCHECK(metadata_.has_sequence_number());
metadata_.set_sequence_number(metadata_.sequence_number() + 1);
}
// Update hash string for EntitySpecifics.
void ModelTypeEntity::UpdateSpecificsHash(
const sync_pb::EntitySpecifics& specifics) {
if (specifics.ByteSize() > 0) {
std::string hash_input;
specifics.AppendToString(&hash_input);
base::Base64Encode(base::SHA1HashString(hash_input),
metadata_.mutable_specifics_hash());
} else {
metadata_.clear_specifics_hash();
}
}
} // namespace syncer_v2
|
