| // 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/non_ui_data_type_controller.h" |
| |
| #include "base/logging.h" |
| #include "base/memory/weak_ptr.h" |
| #include "base/thread_task_runner_handle.h" |
| #include "components/sync_driver/generic_change_processor_factory.h" |
| #include "components/sync_driver/shared_change_processor_ref.h" |
| #include "components/sync_driver/sync_api_component_factory.h" |
| #include "components/sync_driver/sync_client.h" |
| #include "components/sync_driver/sync_service.h" |
| #include "sync/api/sync_error.h" |
| #include "sync/api/sync_merge_result.h" |
| #include "sync/api/syncable_service.h" |
| #include "sync/internal_api/public/base/model_type.h" |
| #include "sync/util/data_type_histogram.h" |
| |
| namespace sync_driver { |
| |
| SharedChangeProcessor* |
| NonUIDataTypeController::CreateSharedChangeProcessor() { |
| return new SharedChangeProcessor(); |
| } |
| |
| NonUIDataTypeController::NonUIDataTypeController( |
| const scoped_refptr<base::SingleThreadTaskRunner>& ui_thread, |
| const base::Closure& error_callback, |
| SyncClient* sync_client) |
| : DirectoryDataTypeController(ui_thread, error_callback), |
| sync_client_(sync_client), |
| state_(NOT_RUNNING), |
| ui_thread_(ui_thread) {} |
| |
| void NonUIDataTypeController::LoadModels( |
| const ModelLoadCallback& model_load_callback) { |
| DCHECK(ui_thread_->BelongsToCurrentThread()); |
| model_load_callback_ = model_load_callback; |
| if (state() != NOT_RUNNING) { |
| model_load_callback.Run(type(), |
| syncer::SyncError(FROM_HERE, |
| syncer::SyncError::DATATYPE_ERROR, |
| "Model already running", |
| type())); |
| return; |
| } |
| |
| state_ = MODEL_STARTING; |
| // Since we can't be called multiple times before Stop() is called, |
| // |shared_change_processor_| must be NULL here. |
| DCHECK(!shared_change_processor_.get()); |
| shared_change_processor_ = CreateSharedChangeProcessor(); |
| DCHECK(shared_change_processor_.get()); |
| if (!StartModels()) { |
| // If we are waiting for some external service to load before associating |
| // or we failed to start the models, we exit early. |
| DCHECK(state() == MODEL_STARTING || state() == NOT_RUNNING); |
| return; |
| } |
| |
| OnModelLoaded(); |
| } |
| |
| void NonUIDataTypeController::OnModelLoaded() { |
| DCHECK_EQ(state_, MODEL_STARTING); |
| state_ = MODEL_LOADED; |
| model_load_callback_.Run(type(), syncer::SyncError()); |
| } |
| |
| bool NonUIDataTypeController::StartModels() { |
| DCHECK_EQ(state_, MODEL_STARTING); |
| // By default, no additional services need to be started before we can proceed |
| // with model association. |
| return true; |
| } |
| |
| void NonUIDataTypeController::StopModels() { |
| DCHECK(ui_thread_->BelongsToCurrentThread()); |
| } |
| |
| void NonUIDataTypeController::StartAssociating( |
| const StartCallback& start_callback) { |
| DCHECK(ui_thread_->BelongsToCurrentThread()); |
| DCHECK(!start_callback.is_null()); |
| DCHECK_EQ(state_, MODEL_LOADED); |
| state_ = ASSOCIATING; |
| |
| // Store UserShare now while on UI thread to avoid potential race |
| // condition in StartAssociationWithSharedChangeProcessor. |
| DCHECK(sync_client_->GetSyncService()); |
| user_share_ = sync_client_->GetSyncService()->GetUserShare(); |
| |
| start_callback_ = start_callback; |
| if (!StartAssociationAsync()) { |
| syncer::SyncError error( |
| FROM_HERE, |
| syncer::SyncError::DATATYPE_ERROR, |
| "Failed to post StartAssociation", |
| type()); |
| syncer::SyncMergeResult local_merge_result(type()); |
| local_merge_result.set_error(error); |
| StartDoneImpl(ASSOCIATION_FAILED, |
| NOT_RUNNING, |
| local_merge_result, |
| syncer::SyncMergeResult(type())); |
| // StartDoneImpl should have called ClearSharedChangeProcessor(); |
| DCHECK(!shared_change_processor_.get()); |
| return; |
| } |
| } |
| |
| void NonUIDataTypeController::Stop() { |
| DCHECK(ui_thread_->BelongsToCurrentThread()); |
| |
| if (state() == NOT_RUNNING) |
| return; |
| |
| // Disconnect the change processor. At this point, the |
| // syncer::SyncableService can no longer interact with the Syncer, even if |
| // it hasn't finished MergeDataAndStartSyncing. |
| ClearSharedChangeProcessor(); |
| |
| // If we haven't finished starting, we need to abort the start. |
| switch (state()) { |
| case MODEL_STARTING: |
| state_ = STOPPING; |
| AbortModelLoad(); |
| return; // The datatype was never activated, we're done. |
| case ASSOCIATING: |
| state_ = STOPPING; |
| StopModels(); |
| // We continue on to deactivate the datatype and stop the local service. |
| break; |
| case MODEL_LOADED: |
| case DISABLED: |
| // If DTC is loaded or disabled, we never attempted or succeeded |
| // associating and never activated the datatype. We would have already |
| // stopped the local service in StartDoneImpl(..). |
| state_ = NOT_RUNNING; |
| StopModels(); |
| return; |
| default: |
| // Datatype was fully started. Need to deactivate and stop the local |
| // service. |
| DCHECK_EQ(state(), RUNNING); |
| state_ = STOPPING; |
| StopModels(); |
| break; |
| } |
| |
| // Stop the local service and release our references to it and the |
| // shared change processor (posts a task to the datatype's thread). |
| StopLocalServiceAsync(); |
| |
| state_ = NOT_RUNNING; |
| } |
| |
| std::string NonUIDataTypeController::name() const { |
| // For logging only. |
| return syncer::ModelTypeToString(type()); |
| } |
| |
| DataTypeController::State NonUIDataTypeController::state() const { |
| return state_; |
| } |
| |
| void NonUIDataTypeController::OnSingleDataTypeUnrecoverableError( |
| const syncer::SyncError& error) { |
| DCHECK(!ui_thread_->BelongsToCurrentThread()); |
| // TODO(tim): We double-upload some errors. See bug 383480. |
| if (!error_callback_.is_null()) |
| error_callback_.Run(); |
| ui_thread_->PostTask(error.location(), |
| base::Bind(&NonUIDataTypeController::DisableImpl, |
| this, |
| error)); |
| } |
| |
| NonUIDataTypeController::NonUIDataTypeController() |
| : DirectoryDataTypeController(base::ThreadTaskRunnerHandle::Get(), |
| base::Closure()), |
| sync_client_(NULL) {} |
| |
| NonUIDataTypeController::~NonUIDataTypeController() {} |
| |
| void NonUIDataTypeController::StartDone( |
| DataTypeController::ConfigureResult start_result, |
| const syncer::SyncMergeResult& local_merge_result, |
| const syncer::SyncMergeResult& syncer_merge_result) { |
| DCHECK(!ui_thread_->BelongsToCurrentThread()); |
| |
| DataTypeController::State new_state; |
| if (IsSuccessfulResult(start_result)) { |
| new_state = RUNNING; |
| } else { |
| new_state = (start_result == ASSOCIATION_FAILED ? DISABLED : NOT_RUNNING); |
| } |
| |
| ui_thread_->PostTask(FROM_HERE, |
| base::Bind(&NonUIDataTypeController::StartDoneImpl, |
| this, |
| start_result, |
| new_state, |
| local_merge_result, |
| syncer_merge_result)); |
| } |
| |
| void NonUIDataTypeController::StartDoneImpl( |
| DataTypeController::ConfigureResult start_result, |
| DataTypeController::State new_state, |
| const syncer::SyncMergeResult& local_merge_result, |
| const syncer::SyncMergeResult& syncer_merge_result) { |
| DCHECK(ui_thread_->BelongsToCurrentThread()); |
| |
| // If we failed to start up, and we haven't been stopped yet, we need to |
| // ensure we clean up the local service and shared change processor properly. |
| if (new_state != RUNNING && state() != NOT_RUNNING && state() != STOPPING) { |
| ClearSharedChangeProcessor(); |
| StopLocalServiceAsync(); |
| } |
| |
| // It's possible to have StartDoneImpl called first from the UI thread |
| // (due to Stop being called) and then posted from the non-UI thread. In |
| // this case, we drop the second call because we've already been stopped. |
| if (state_ == NOT_RUNNING) { |
| return; |
| } |
| |
| state_ = new_state; |
| if (state_ != RUNNING) { |
| // Start failed. |
| StopModels(); |
| RecordStartFailure(start_result); |
| } |
| |
| start_callback_.Run(start_result, local_merge_result, syncer_merge_result); |
| } |
| |
| void NonUIDataTypeController::RecordAssociationTime(base::TimeDelta time) { |
| DCHECK(!ui_thread_->BelongsToCurrentThread()); |
| #define PER_DATA_TYPE_MACRO(type_str) \ |
| UMA_HISTOGRAM_TIMES("Sync." type_str "AssociationTime", time); |
| SYNC_DATA_TYPE_HISTOGRAM(type()); |
| #undef PER_DATA_TYPE_MACRO |
| } |
| |
| void NonUIDataTypeController::RecordStartFailure(ConfigureResult result) { |
| DCHECK(ui_thread_->BelongsToCurrentThread()); |
| UMA_HISTOGRAM_ENUMERATION("Sync.DataTypeStartFailures", |
| ModelTypeToHistogramInt(type()), |
| syncer::MODEL_TYPE_COUNT); |
| #define PER_DATA_TYPE_MACRO(type_str) \ |
| UMA_HISTOGRAM_ENUMERATION("Sync." type_str "ConfigureFailure", result, \ |
| MAX_CONFIGURE_RESULT); |
| SYNC_DATA_TYPE_HISTOGRAM(type()); |
| #undef PER_DATA_TYPE_MACRO |
| } |
| |
| void NonUIDataTypeController::AbortModelLoad() { |
| state_ = NOT_RUNNING; |
| StopModels(); |
| } |
| |
| void NonUIDataTypeController::DisableImpl( |
| const syncer::SyncError& error) { |
| DCHECK(ui_thread_->BelongsToCurrentThread()); |
| UMA_HISTOGRAM_ENUMERATION("Sync.DataTypeRunFailures", |
| ModelTypeToHistogramInt(type()), |
| syncer::MODEL_TYPE_COUNT); |
| if (!model_load_callback_.is_null()) { |
| syncer::SyncMergeResult local_merge_result(type()); |
| local_merge_result.set_error(error); |
| model_load_callback_.Run(type(), error); |
| } |
| } |
| |
| bool NonUIDataTypeController::StartAssociationAsync() { |
| DCHECK(ui_thread_->BelongsToCurrentThread()); |
| DCHECK_EQ(state(), ASSOCIATING); |
| return PostTaskOnBackendThread( |
| FROM_HERE, |
| base::Bind( |
| &NonUIDataTypeController::StartAssociationWithSharedChangeProcessor, |
| this, |
| shared_change_processor_)); |
| } |
| |
| ChangeProcessor* NonUIDataTypeController::GetChangeProcessor() const { |
| DCHECK_EQ(state_, RUNNING); |
| return shared_change_processor_->generic_change_processor(); |
| } |
| |
| // This method can execute after we've already stopped (and possibly even |
| // destroyed) both the Syncer and the SyncableService. As a result, all actions |
| // must either have no side effects outside of the DTC or must be protected |
| // by |shared_change_processor|, which is guaranteed to have been Disconnected |
| // if the syncer shut down. |
| void NonUIDataTypeController:: |
| StartAssociationWithSharedChangeProcessor( |
| const scoped_refptr<SharedChangeProcessor>& shared_change_processor) { |
| DCHECK(!ui_thread_->BelongsToCurrentThread()); |
| DCHECK(shared_change_processor.get()); |
| DCHECK(user_share_); |
| syncer::SyncMergeResult local_merge_result(type()); |
| syncer::SyncMergeResult syncer_merge_result(type()); |
| base::WeakPtrFactory<syncer::SyncMergeResult> weak_ptr_factory( |
| &syncer_merge_result); |
| |
| // Connect |shared_change_processor| to the syncer and get the |
| // syncer::SyncableService associated with type(). |
| // Note that it's possible the shared_change_processor has already been |
| // disconnected at this point, so all our accesses to the syncer from this |
| // point on are through it. |
| GenericChangeProcessorFactory factory; |
| local_service_ = shared_change_processor->Connect( |
| sync_client_, &factory, user_share_, this, type(), |
| weak_ptr_factory.GetWeakPtr()); |
| if (!local_service_.get()) { |
| syncer::SyncError error(FROM_HERE, |
| syncer::SyncError::DATATYPE_ERROR, |
| "Failed to connect to syncer.", |
| type()); |
| local_merge_result.set_error(error); |
| StartDone(ASSOCIATION_FAILED, |
| local_merge_result, |
| syncer_merge_result); |
| return; |
| } |
| |
| if (!shared_change_processor->CryptoReadyIfNecessary()) { |
| syncer::SyncError error(FROM_HERE, |
| syncer::SyncError::CRYPTO_ERROR, |
| "", |
| type()); |
| local_merge_result.set_error(error); |
| StartDone(NEEDS_CRYPTO, |
| local_merge_result, |
| syncer_merge_result); |
| return; |
| } |
| |
| bool sync_has_nodes = false; |
| if (!shared_change_processor->SyncModelHasUserCreatedNodes(&sync_has_nodes)) { |
| syncer::SyncError error(FROM_HERE, |
| syncer::SyncError::UNRECOVERABLE_ERROR, |
| "Failed to load sync nodes", |
| type()); |
| local_merge_result.set_error(error); |
| StartDone(UNRECOVERABLE_ERROR, |
| local_merge_result, |
| syncer_merge_result); |
| return; |
| } |
| |
| // Scope for |initial_sync_data| which might be expensive, so we don't want |
| // to keep it in memory longer than necessary. |
| { |
| syncer::SyncDataList initial_sync_data; |
| |
| base::TimeTicks start_time = base::TimeTicks::Now(); |
| syncer::SyncError error = |
| shared_change_processor->GetAllSyncDataReturnError(type(), |
| &initial_sync_data); |
| if (error.IsSet()) { |
| local_merge_result.set_error(error); |
| StartDone(ASSOCIATION_FAILED, local_merge_result, syncer_merge_result); |
| return; |
| } |
| |
| std::string datatype_context; |
| if (shared_change_processor->GetDataTypeContext(&datatype_context)) { |
| local_service_->UpdateDataTypeContext( |
| type(), syncer::SyncChangeProcessor::NO_REFRESH, datatype_context); |
| } |
| |
| syncer_merge_result.set_num_items_before_association( |
| initial_sync_data.size()); |
| // Passes a reference to |shared_change_processor|. |
| local_merge_result = local_service_->MergeDataAndStartSyncing( |
| type(), initial_sync_data, |
| scoped_ptr<syncer::SyncChangeProcessor>( |
| new SharedChangeProcessorRef(shared_change_processor)), |
| scoped_ptr<syncer::SyncErrorFactory>( |
| new SharedChangeProcessorRef(shared_change_processor))); |
| RecordAssociationTime(base::TimeTicks::Now() - start_time); |
| if (local_merge_result.error().IsSet()) { |
| StartDone(ASSOCIATION_FAILED, local_merge_result, syncer_merge_result); |
| return; |
| } |
| } |
| |
| syncer_merge_result.set_num_items_after_association( |
| shared_change_processor->GetSyncCount()); |
| |
| StartDone(!sync_has_nodes ? OK_FIRST_RUN : OK, |
| local_merge_result, |
| syncer_merge_result); |
| } |
| |
| void NonUIDataTypeController::ClearSharedChangeProcessor() { |
| DCHECK(ui_thread_->BelongsToCurrentThread()); |
| // |shared_change_processor_| can already be NULL if Stop() is |
| // called after StartDoneImpl(_, DISABLED, _). |
| if (shared_change_processor_.get()) { |
| shared_change_processor_->Disconnect(); |
| shared_change_processor_ = NULL; |
| } |
| } |
| |
| void NonUIDataTypeController::StopLocalServiceAsync() { |
| DCHECK(ui_thread_->BelongsToCurrentThread()); |
| PostTaskOnBackendThread( |
| FROM_HERE, |
| base::Bind(&NonUIDataTypeController::StopLocalService, this)); |
| } |
| |
| void NonUIDataTypeController::StopLocalService() { |
| DCHECK(!ui_thread_->BelongsToCurrentThread()); |
| if (local_service_.get()) |
| local_service_->StopSyncing(type()); |
| local_service_.reset(); |
| } |
| |
| } // namespace sync_driver |