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
|
// 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_driver/model_association_manager.h"
#include <algorithm>
#include <functional>
#include "base/logging.h"
#include "base/message_loop/message_loop.h"
#include "base/metrics/histogram_macros.h"
#include "base/trace_event/trace_event.h"
#include "sync/internal_api/public/base/model_type.h"
using syncer::ModelTypeSet;
namespace sync_driver {
namespace {
static const syncer::ModelType kStartOrder[] = {
syncer::NIGORI, // Listed for completeness.
syncer::DEVICE_INFO, // Listed for completeness.
syncer::EXPERIMENTS, // Listed for completeness.
syncer::PROXY_TABS, // Listed for completeness.
// Kick off the association of the non-UI types first so they can associate
// in parallel with the UI types.
syncer::PASSWORDS,
syncer::AUTOFILL,
syncer::AUTOFILL_PROFILE,
syncer::AUTOFILL_WALLET_DATA,
syncer::AUTOFILL_WALLET_METADATA,
syncer::EXTENSION_SETTINGS,
syncer::APP_SETTINGS,
syncer::TYPED_URLS,
syncer::HISTORY_DELETE_DIRECTIVES,
syncer::SYNCED_NOTIFICATIONS,
syncer::SYNCED_NOTIFICATION_APP_INFO,
// UI thread data types.
syncer::BOOKMARKS,
syncer::SUPERVISED_USERS, // Syncing supervised users on initial login
// might block creating a new supervised user,
// so we want to do it early.
syncer::PREFERENCES,
syncer::PRIORITY_PREFERENCES,
syncer::EXTENSIONS,
syncer::APPS,
syncer::APP_LIST,
syncer::THEMES,
syncer::SEARCH_ENGINES,
syncer::SESSIONS,
syncer::APP_NOTIFICATIONS,
syncer::DICTIONARY,
syncer::FAVICON_IMAGES,
syncer::FAVICON_TRACKING,
syncer::SUPERVISED_USER_SETTINGS,
syncer::SUPERVISED_USER_SHARED_SETTINGS,
syncer::SUPERVISED_USER_WHITELISTS,
syncer::ARTICLES,
syncer::WIFI_CREDENTIALS,
};
static_assert(arraysize(kStartOrder) ==
syncer::MODEL_TYPE_COUNT - syncer::FIRST_REAL_MODEL_TYPE,
"kStartOrder must have MODEL_TYPE_COUNT - "
"FIRST_REAL_MODEL_TYPE elements");
// The amount of time we wait for association to finish. If some types haven't
// finished association by the time, DataTypeManager is notified of the
// unfinished types.
const int64 kAssociationTimeOutInSeconds = 600;
syncer::DataTypeAssociationStats BuildAssociationStatsFromMergeResults(
const syncer::SyncMergeResult& local_merge_result,
const syncer::SyncMergeResult& syncer_merge_result,
const base::TimeDelta& association_wait_time,
const base::TimeDelta& association_time) {
DCHECK_EQ(local_merge_result.model_type(), syncer_merge_result.model_type());
syncer::DataTypeAssociationStats stats;
stats.had_error = local_merge_result.error().IsSet() ||
syncer_merge_result.error().IsSet();
stats.num_local_items_before_association =
local_merge_result.num_items_before_association();
stats.num_sync_items_before_association =
syncer_merge_result.num_items_before_association();
stats.num_local_items_after_association =
local_merge_result.num_items_after_association();
stats.num_sync_items_after_association =
syncer_merge_result.num_items_after_association();
stats.num_local_items_added =
local_merge_result.num_items_added();
stats.num_local_items_deleted =
local_merge_result.num_items_deleted();
stats.num_local_items_modified =
local_merge_result.num_items_modified();
stats.local_version_pre_association =
local_merge_result.pre_association_version();
stats.num_sync_items_added =
syncer_merge_result.num_items_added();
stats.num_sync_items_deleted =
syncer_merge_result.num_items_deleted();
stats.num_sync_items_modified =
syncer_merge_result.num_items_modified();
stats.sync_version_pre_association =
syncer_merge_result.pre_association_version();
stats.association_wait_time = association_wait_time;
stats.association_time = association_time;
return stats;
}
} // namespace
ModelAssociationManager::ModelAssociationManager(
const DataTypeController::TypeMap* controllers,
ModelAssociationManagerDelegate* processor)
: state_(IDLE),
controllers_(controllers),
delegate_(processor),
configure_status_(DataTypeManager::UNKNOWN),
weak_ptr_factory_(this) {
// Ensure all data type controllers are stopped.
for (DataTypeController::TypeMap::const_iterator it = controllers_->begin();
it != controllers_->end(); ++it) {
DCHECK_EQ(DataTypeController::NOT_RUNNING, (*it).second->state());
}
}
ModelAssociationManager::~ModelAssociationManager() {
}
void ModelAssociationManager::Initialize(syncer::ModelTypeSet desired_types) {
// state_ can be INITIALIZED if types are reconfigured when
// data is being downloaded, so StartAssociationAsync() is never called for
// the first configuration.
DCHECK_NE(ASSOCIATING, state_);
// Only keep types that have controllers.
desired_types_.Clear();
for (syncer::ModelTypeSet::Iterator it = desired_types.First();
it.Good(); it.Inc()) {
if (controllers_->find(it.Get()) != controllers_->end())
desired_types_.Put(it.Get());
}
DVLOG(1) << "ModelAssociationManager: Initializing for "
<< syncer::ModelTypeSetToString(desired_types_);
state_ = INITIALIZED;
StopDisabledTypes();
LoadEnabledTypes();
}
void ModelAssociationManager::StopDatatype(
const syncer::SyncError& error,
DataTypeController* dtc) {
loaded_types_.Remove(dtc->type());
associated_types_.Remove(dtc->type());
associating_types_.Remove(dtc->type());
if (error.IsSet() || dtc->state() != DataTypeController::NOT_RUNNING) {
// If an error was set, the delegate must be informed of the error.
delegate_->OnSingleDataTypeWillStop(dtc->type(), error);
dtc->Stop();
}
}
void ModelAssociationManager::StopDisabledTypes() {
DVLOG(1) << "ModelAssociationManager: Stopping disabled types.";
for (DataTypeController::TypeMap::const_iterator it = controllers_->begin();
it != controllers_->end(); ++it) {
DataTypeController* dtc = (*it).second.get();
if (dtc->state() != DataTypeController::NOT_RUNNING &&
!desired_types_.Has(dtc->type())) {
DVLOG(1) << "ModelAssociationManager: stop " << dtc->name();
StopDatatype(syncer::SyncError(), dtc);
}
}
}
void ModelAssociationManager::LoadEnabledTypes() {
// Load in kStartOrder.
for (size_t i = 0; i < arraysize(kStartOrder); i++) {
syncer::ModelType type = kStartOrder[i];
if (!desired_types_.Has(type))
continue;
DCHECK(controllers_->find(type) != controllers_->end());
DataTypeController* dtc = controllers_->find(type)->second.get();
if (dtc->state() == DataTypeController::NOT_RUNNING) {
DCHECK(!loaded_types_.Has(dtc->type()));
DCHECK(!associated_types_.Has(dtc->type()));
dtc->LoadModels(base::Bind(&ModelAssociationManager::ModelLoadCallback,
weak_ptr_factory_.GetWeakPtr()));
}
}
}
void ModelAssociationManager::StartAssociationAsync(
const syncer::ModelTypeSet& types_to_associate) {
DCHECK_EQ(INITIALIZED, state_);
DVLOG(1) << "Starting association for "
<< syncer::ModelTypeSetToString(types_to_associate);
state_ = ASSOCIATING;
association_start_time_ = base::TimeTicks::Now();
requested_types_ = types_to_associate;
associating_types_ = types_to_associate;
associating_types_.RetainAll(desired_types_);
associating_types_.RemoveAll(associated_types_);
// Assume success.
configure_status_ = DataTypeManager::OK;
// Done if no types to associate.
if (associating_types_.Empty()) {
ModelAssociationDone(INITIALIZED);
return;
}
timer_.Start(FROM_HERE,
base::TimeDelta::FromSeconds(kAssociationTimeOutInSeconds),
base::Bind(&ModelAssociationManager::ModelAssociationDone,
weak_ptr_factory_.GetWeakPtr(),
INITIALIZED));
// Start association of types that are loaded in specified order.
for (size_t i = 0; i < arraysize(kStartOrder); i++) {
syncer::ModelType type = kStartOrder[i];
if (!associating_types_.Has(type) || !loaded_types_.Has(type))
continue;
DataTypeController* dtc = controllers_->find(type)->second.get();
DCHECK(DataTypeController::MODEL_LOADED == dtc->state() ||
DataTypeController::ASSOCIATING == dtc->state());
if (dtc->state() == DataTypeController::MODEL_LOADED) {
TRACE_EVENT_ASYNC_BEGIN1("sync", "ModelAssociation",
dtc,
"DataType",
ModelTypeToString(type));
dtc->StartAssociating(
base::Bind(&ModelAssociationManager::TypeStartCallback,
weak_ptr_factory_.GetWeakPtr(),
type, base::TimeTicks::Now()));
}
}
}
void ModelAssociationManager::Stop() {
// Ignore callbacks from controllers.
weak_ptr_factory_.InvalidateWeakPtrs();
// Stop started data types.
for (DataTypeController::TypeMap::const_iterator it = controllers_->begin();
it != controllers_->end(); ++it) {
DataTypeController* dtc = (*it).second.get();
if (dtc->state() != DataTypeController::NOT_RUNNING) {
StopDatatype(syncer::SyncError(), dtc);
DVLOG(1) << "ModelAssociationManager: Stopped " << dtc->name();
}
}
desired_types_.Clear();
loaded_types_.Clear();
associated_types_.Clear();
if (state_ == ASSOCIATING) {
if (configure_status_ == DataTypeManager::OK)
configure_status_ = DataTypeManager::ABORTED;
DVLOG(1) << "ModelAssociationManager: Calling OnModelAssociationDone";
ModelAssociationDone(IDLE);
} else {
DCHECK(associating_types_.Empty());
DCHECK(requested_types_.Empty());
state_ = IDLE;
}
}
void ModelAssociationManager::ModelLoadCallback(syncer::ModelType type,
syncer::SyncError error) {
DVLOG(1) << "ModelAssociationManager: ModelLoadCallback for "
<< syncer::ModelTypeToString(type);
if (error.IsSet()) {
syncer::SyncMergeResult local_merge_result(type);
local_merge_result.set_error(error);
TypeStartCallback(type,
base::TimeTicks::Now(),
DataTypeController::ASSOCIATION_FAILED,
local_merge_result,
syncer::SyncMergeResult(type));
return;
}
// This happens when slow loading type is disabled by new configuration.
if (!desired_types_.Has(type))
return;
DCHECK(!loaded_types_.Has(type));
loaded_types_.Put(type);
if (associating_types_.Has(type)) {
DataTypeController* dtc = controllers_->find(type)->second.get();
dtc->StartAssociating(
base::Bind(&ModelAssociationManager::TypeStartCallback,
weak_ptr_factory_.GetWeakPtr(),
type, base::TimeTicks::Now()));
}
}
void ModelAssociationManager::TypeStartCallback(
syncer::ModelType type,
base::TimeTicks type_start_time,
DataTypeController::ConfigureResult start_result,
const syncer::SyncMergeResult& local_merge_result,
const syncer::SyncMergeResult& syncer_merge_result) {
if (desired_types_.Has(type) &&
!DataTypeController::IsSuccessfulResult(start_result)) {
DVLOG(1) << "ModelAssociationManager: Type encountered an error.";
desired_types_.Remove(type);
DataTypeController* dtc = controllers_->find(type)->second.get();
StopDatatype(local_merge_result.error(), dtc);
// Update configuration result.
if (start_result == DataTypeController::UNRECOVERABLE_ERROR)
configure_status_ = DataTypeManager::UNRECOVERABLE_ERROR;
}
// This happens when a slow associating type is disabled or if a type
// disables itself after initial configuration.
if (!desired_types_.Has(type)) {
// It's possible all types failed to associate, in which case association
// is complete.
if (state_ == ASSOCIATING && associating_types_.Empty())
ModelAssociationDone(INITIALIZED);
return;
}
DCHECK(!associated_types_.Has(type));
DCHECK(DataTypeController::IsSuccessfulResult(start_result));
associated_types_.Put(type);
if (state_ != ASSOCIATING)
return;
TRACE_EVENT_ASYNC_END1("sync", "ModelAssociation",
controllers_->find(type)->second.get(),
"DataType",
ModelTypeToString(type));
// Track the merge results if we succeeded or an association failure
// occurred.
if (syncer::ProtocolTypes().Has(type)) {
base::TimeDelta association_wait_time =
std::max(base::TimeDelta(), type_start_time - association_start_time_);
base::TimeDelta association_time =
base::TimeTicks::Now() - type_start_time;;
syncer::DataTypeAssociationStats stats =
BuildAssociationStatsFromMergeResults(local_merge_result,
syncer_merge_result,
association_wait_time,
association_time);
delegate_->OnSingleDataTypeAssociationDone(type, stats);
}
associating_types_.Remove(type);
if (associating_types_.Empty())
ModelAssociationDone(INITIALIZED);
}
void ModelAssociationManager::ModelAssociationDone(State new_state) {
DCHECK_NE(IDLE, state_);
if (state_ == INITIALIZED) {
// No associations are currently happening. Just reset the state.
state_ = new_state;
return;
}
DVLOG(1) << "Model association complete for "
<< syncer::ModelTypeSetToString(requested_types_);
timer_.Stop();
// Treat any unfinished types as having errors.
desired_types_.RemoveAll(associating_types_);
for (DataTypeController::TypeMap::const_iterator it = controllers_->begin();
it != controllers_->end(); ++it) {
DataTypeController* dtc = (*it).second.get();
if (associating_types_.Has(dtc->type()) &&
dtc->state() != DataTypeController::NOT_RUNNING) {
UMA_HISTOGRAM_ENUMERATION("Sync.ConfigureFailed",
ModelTypeToHistogramInt(dtc->type()),
syncer::MODEL_TYPE_COUNT);
StopDatatype(syncer::SyncError(FROM_HERE,
syncer::SyncError::DATATYPE_ERROR,
"Association timed out.",
dtc->type()),
dtc);
}
}
DataTypeManager::ConfigureResult result(configure_status_,
requested_types_);
// Need to reset state before invoking delegate in order to avoid re-entrancy
// issues (delegate may trigger a reconfiguration).
associating_types_.Clear();
requested_types_.Clear();
state_ = new_state;
delegate_->OnModelAssociationDone(result);
}
base::OneShotTimer<ModelAssociationManager>*
ModelAssociationManager::GetTimerForTesting() {
return &timer_;
}
} // namespace sync_driver
|