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
|
// Copyright 2012 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/engine_impl/commit.h"
#include <utility>
#include "base/feature_list.h"
#include "base/metrics/histogram_macros.h"
#include "base/rand_util.h"
#include "base/trace_event/trace_event.h"
#include "components/sync/base/data_type_histogram.h"
#include "components/sync/engine/net/http_bridge.h"
#include "components/sync/engine_impl/commit_processor.h"
#include "components/sync/engine_impl/commit_util.h"
#include "components/sync/engine_impl/cycle/sync_cycle.h"
#include "components/sync/engine_impl/events/commit_request_event.h"
#include "components/sync/engine_impl/events/commit_response_event.h"
#include "components/sync/engine_impl/syncer.h"
#include "components/sync/engine_impl/syncer_proto_util.h"
namespace syncer {
namespace {
// The number of random ASCII bytes we'll add to CommitMessage. We choose 256
// because it is not too large (to hurt performance and compression ratio), but
// it is not too small to easily be canceled out using statistical analysis.
const size_t kPaddingSize = 256;
}
Commit::Commit(ContributionMap contributions,
const sync_pb::ClientToServerMessage& message,
ExtensionsActivity::Records extensions_activity_buffer)
: contributions_(std::move(contributions)),
message_(message),
extensions_activity_buffer_(extensions_activity_buffer),
cleaned_up_(false) {}
Commit::~Commit() {
DCHECK(cleaned_up_);
}
Commit* Commit::Init(ModelTypeSet requested_types,
ModelTypeSet enabled_types,
size_t max_entries,
const std::string& account_name,
const std::string& cache_guid,
bool cookie_jar_mismatch,
bool cookie_jar_empty,
CommitProcessor* commit_processor,
ExtensionsActivity* extensions_activity) {
// Gather per-type contributions.
ContributionMap contributions;
commit_processor->GatherCommitContributions(requested_types, max_entries,
cookie_jar_mismatch,
cookie_jar_empty, &contributions);
// Give up if no one had anything to commit.
if (contributions.empty())
return nullptr;
sync_pb::ClientToServerMessage message;
message.set_message_contents(sync_pb::ClientToServerMessage::COMMIT);
message.set_share(account_name);
sync_pb::CommitMessage* commit_message = message.mutable_commit();
commit_message->set_cache_guid(cache_guid);
// Set padding to mitigate CRIME attack.
if (base::FeatureList::IsEnabled(syncer::kSyncClientToServerCompression)) {
commit_message->set_padding(base::RandBytesAsString(kPaddingSize));
}
// Set extensions activity if bookmark commits are present.
ExtensionsActivity::Records extensions_activity_buffer;
if (extensions_activity != nullptr) {
ContributionMap::const_iterator it = contributions.find(BOOKMARKS);
if (it != contributions.end() && it->second->GetNumEntries() != 0) {
commit_util::AddExtensionsActivityToMessage(
extensions_activity, &extensions_activity_buffer, commit_message);
}
}
// Set the client config params.
commit_util::AddClientConfigParamsToMessage(
enabled_types, cookie_jar_mismatch, commit_message);
int previous_message_size = message.ByteSize();
// Finally, serialize all our contributions.
for (const auto& contribution : contributions) {
contribution.second->AddToCommitMessage(&message);
int current_entry_size = message.ByteSize() - previous_message_size;
previous_message_size = message.ByteSize();
int local_integer_model_type = ModelTypeToHistogramInt(contribution.first);
if (current_entry_size > 0) {
SyncRecordDatatypeBin("DataUse.Sync.Upload.Bytes",
local_integer_model_type, current_entry_size);
}
UMA_HISTOGRAM_SPARSE_SLOWLY("DataUse.Sync.Upload.Count",
local_integer_model_type);
}
// If we made it this far, then we've successfully prepared a commit message.
return new Commit(std::move(contributions), message,
extensions_activity_buffer);
}
SyncerError Commit::PostAndProcessResponse(
NudgeTracker* nudge_tracker,
SyncCycle* cycle,
StatusController* status,
ExtensionsActivity* extensions_activity) {
ModelTypeSet request_types;
for (ContributionMap::const_iterator it = contributions_.begin();
it != contributions_.end(); ++it) {
request_types.Put(it->first);
}
cycle->mutable_status_controller()->set_commit_request_types(request_types);
if (cycle->context()->debug_info_getter()) {
sync_pb::DebugInfo* debug_info = message_.mutable_debug_info();
cycle->context()->debug_info_getter()->GetDebugInfo(debug_info);
}
DVLOG(1) << "Sending commit message.";
CommitRequestEvent request_event(base::Time::Now(),
message_.commit().entries_size(),
request_types, message_);
cycle->SendProtocolEvent(request_event);
TRACE_EVENT_BEGIN0("sync", "PostCommit");
const SyncerError post_result = SyncerProtoUtil::PostClientToServerMessage(
&message_, &response_, cycle, nullptr);
TRACE_EVENT_END0("sync", "PostCommit");
// TODO(rlarocque): Use result that includes errors captured later?
CommitResponseEvent response_event(base::Time::Now(), post_result, response_);
cycle->SendProtocolEvent(response_event);
if (post_result != SYNCER_OK) {
LOG(WARNING) << "Post commit failed";
return post_result;
}
if (!response_.has_commit()) {
LOG(WARNING) << "Commit response has no commit body!";
return SERVER_RESPONSE_VALIDATION_FAILED;
}
size_t message_entries = message_.commit().entries_size();
size_t response_entries = response_.commit().entryresponse_size();
if (message_entries != response_entries) {
LOG(ERROR) << "Commit response has wrong number of entries! "
<< "Expected: " << message_entries << ", "
<< "Got: " << response_entries;
return SERVER_RESPONSE_VALIDATION_FAILED;
}
if (cycle->context()->debug_info_getter()) {
// Clear debug info now that we have successfully sent it to the server.
DVLOG(1) << "Clearing client debug info.";
cycle->context()->debug_info_getter()->ClearDebugInfo();
}
// Let the contributors process the responses to each of their requests.
SyncerError processing_result = SYNCER_OK;
for (ContributionMap::const_iterator it = contributions_.begin();
it != contributions_.end(); ++it) {
TRACE_EVENT1("sync", "ProcessCommitResponse", "type",
ModelTypeToString(it->first));
SyncerError type_result =
it->second->ProcessCommitResponse(response_, status);
if (type_result == SERVER_RETURN_CONFLICT) {
nudge_tracker->RecordCommitConflict(it->first);
}
if (processing_result == SYNCER_OK && type_result != SYNCER_OK) {
processing_result = type_result;
}
}
// Handle bookmarks' special extensions activity stats.
if (extensions_activity != nullptr &&
cycle->status_controller()
.model_neutral_state()
.num_successful_bookmark_commits == 0) {
extensions_activity->PutRecords(extensions_activity_buffer_);
}
return processing_result;
}
void Commit::CleanUp() {
for (ContributionMap::const_iterator it = contributions_.begin();
it != contributions_.end(); ++it) {
it->second->CleanUp();
}
cleaned_up_ = true;
}
} // namespace syncer
|
