[Sync] Remove UIDataTypeController

components/sync/driver/ui_data_type_controller.cc

Index: components/sync/driver/ui_data_type_controller.cc
diff --git a/components/sync/driver/ui_data_type_controller.cc b/components/sync/driver/ui_data_type_controller.cc
deleted file mode 100644
index 1290a052fbb103b64a09320793383d130149433e..0000000000000000000000000000000000000000
--- a/components/sync/driver/ui_data_type_controller.cc
+++ /dev/null
@@ -1,364 +0,0 @@
-// 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/ui_data_type_controller.h"
-
-#include <utility>
-
-#include "base/location.h"
-#include "base/logging.h"
-#include "base/memory/ptr_util.h"
-#include "base/profiler/scoped_tracker.h"
-#include "base/threading/thread_task_runner_handle.h"
-#include "components/sync/base/data_type_histogram.h"
-#include "components/sync/base/model_type.h"
-#include "components/sync/driver/generic_change_processor_factory.h"
-#include "components/sync/driver/shared_change_processor_ref.h"
-#include "components/sync/driver/sync_client.h"
-#include "components/sync/driver/sync_service.h"
-#include "components/sync/model/data_type_error_handler_impl.h"
-#include "components/sync/model/sync_error.h"
-#include "components/sync/model/sync_merge_result.h"
-#include "components/sync/model/syncable_service.h"
-
-namespace syncer {
-
-UIDataTypeController::UIDataTypeController()
-    : DirectoryDataTypeController(UNSPECIFIED, base::Closure(), nullptr),
-      state_(NOT_RUNNING) {}
-
-UIDataTypeController::UIDataTypeController(ModelType type,
-                                           const base::Closure& dump_stack,
-                                           SyncClient* sync_client)
-    : DirectoryDataTypeController(type, dump_stack, sync_client),
-      state_(NOT_RUNNING),
-      processor_factory_(new GenericChangeProcessorFactory()) {
-  DCHECK(IsRealDataType(type));
-}
-
-void UIDataTypeController::SetGenericChangeProcessorFactoryForTest(
-    std::unique_ptr<GenericChangeProcessorFactory> factory) {
-  DCHECK_EQ(state_, NOT_RUNNING);
-  processor_factory_ = std::move(factory);
-}
-
-UIDataTypeController::~UIDataTypeController() {}
-
-void UIDataTypeController::LoadModels(
-    const ModelLoadCallback& model_load_callback) {
-  DCHECK(CalledOnValidThread());
-  DCHECK(IsRealDataType(type()));
-  model_load_callback_ = model_load_callback;
-  if (state_ != NOT_RUNNING) {
-    model_load_callback.Run(type(),
-                            SyncError(FROM_HERE, SyncError::DATATYPE_ERROR,
-                                      "Model already loaded", type()));
-    return;
-  }
-  // 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_ = new SharedChangeProcessor(type());
-
-  state_ = MODEL_STARTING;
-  if (!StartModels()) {
-    // If we are waiting for some external service to load before associating
-    // or we failed to start the models, we exit early. state_ will control
-    // what we perform next.
-    DCHECK(state_ == NOT_RUNNING || state_ == MODEL_STARTING);
-    return;
-  }
-
-  state_ = MODEL_LOADED;
-  model_load_callback_.Run(type(), SyncError());
-}
-
-void UIDataTypeController::OnModelLoaded() {
-  DCHECK(CalledOnValidThread());
-  DCHECK_EQ(state_, MODEL_STARTING);
-
-  state_ = MODEL_LOADED;
-  model_load_callback_.Run(type(), SyncError());
-}
-
-void UIDataTypeController::StartAssociating(
-    const StartCallback& start_callback) {
-  DCHECK(CalledOnValidThread());
-  DCHECK(!start_callback.is_null());
-  DCHECK_EQ(state_, MODEL_LOADED);
-
-  start_callback_ = start_callback;
-  state_ = ASSOCIATING;
-  base::ThreadTaskRunnerHandle::Get()->PostTask(
-      FROM_HERE,
-      base::Bind(&UIDataTypeController::Associate, base::AsWeakPtr(this)));
-}
-
-bool UIDataTypeController::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 UIDataTypeController::Associate() {
-  DCHECK(CalledOnValidThread());
-  if (state_ != ASSOCIATING) {
-    // Stop() must have been called while Associate() task have been waiting.
-    DCHECK_EQ(state_, NOT_RUNNING);
-    return;
-  }
-
-  SyncMergeResult local_merge_result(type());
-  SyncMergeResult syncer_merge_result(type());
-  base::WeakPtrFactory<SyncMergeResult> weak_ptr_factory(&syncer_merge_result);
-
-  // TODO(robliao): Remove ScopedTracker below once https://crbug.com/471403 is

[maxbogue, 2016/11/18 19:31:03]

worth noting that https://crbug.com/471403 is not fixed; do we care about
removing these?

[pavely, 2016/11/19 01:11:42]

The bug tracks the effort to investigate jankiness of model association. There
was no activity on the bug for more than an year. I'd say if that investigation
resumes we'll instrument next target.

-  // fixed.
-  tracked_objects::ScopedTracker tracking_profile1(
-      FROM_HERE_WITH_EXPLICIT_FUNCTION(
-          "471403 UIDataTypeController::Associate1"));
-
-  // Connect |shared_change_processor_| to the syncer and get the
-  // SyncableService associated with type().
-  DCHECK(sync_client_->GetSyncService());
-  local_service_ = shared_change_processor_->Connect(
-      sync_client_, processor_factory_.get(),
-      sync_client_->GetSyncService()->GetUserShare(), CreateErrorHandler(),
-      weak_ptr_factory.GetWeakPtr());
-  if (!local_service_.get()) {
-    SyncError error(FROM_HERE, 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;
-  }
-
-  // TODO(robliao): Remove ScopedTracker below once https://crbug.com/471403 is
-  // fixed.
-  tracked_objects::ScopedTracker tracking_profile2(
-      FROM_HERE_WITH_EXPLICIT_FUNCTION(
-          "471403 UIDataTypeController::Associate2"));
-  if (!shared_change_processor_->CryptoReadyIfNecessary()) {
-    SyncError error(FROM_HERE, SyncError::CRYPTO_ERROR, "", type());
-    local_merge_result.set_error(error);
-    StartDone(NEEDS_CRYPTO, local_merge_result, syncer_merge_result);
-    return;
-  }
-
-  // TODO(robliao): Remove ScopedTracker below once https://crbug.com/471403 is
-  // fixed.
-  tracked_objects::ScopedTracker tracking_profile3(
-      FROM_HERE_WITH_EXPLICIT_FUNCTION(
-          "471403 UIDataTypeController::Associate3"));
-  bool sync_has_nodes = false;
-  if (!shared_change_processor_->SyncModelHasUserCreatedNodes(
-          &sync_has_nodes)) {
-    SyncError error(FROM_HERE, 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.
-  {
-    SyncDataList initial_sync_data;
-
-    // TODO(robliao): Remove ScopedTracker below once https://crbug.com/471403
-    // is fixed.
-    tracked_objects::ScopedTracker tracking_profile4(
-        FROM_HERE_WITH_EXPLICIT_FUNCTION(
-            "471403 UIDataTypeController::Associate4"));
-    base::TimeTicks start_time = base::TimeTicks::Now();
-    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;
-    }
-
-    // TODO(robliao): Remove ScopedTracker below once https://crbug.com/471403
-    // is fixed.
-    tracked_objects::ScopedTracker tracking_profile5(
-        FROM_HERE_WITH_EXPLICIT_FUNCTION(
-            "471403 UIDataTypeController::Associate5"));
-    std::string datatype_context;
-    if (shared_change_processor_->GetDataTypeContext(&datatype_context)) {
-      local_service_->UpdateDataTypeContext(
-          type(), SyncChangeProcessor::NO_REFRESH, datatype_context);
-    }
-
-    // TODO(robliao): Remove ScopedTracker below once https://crbug.com/471403
-    // is fixed.
-    tracked_objects::ScopedTracker tracking_profile6(
-        FROM_HERE_WITH_EXPLICIT_FUNCTION(
-            "471403 UIDataTypeController::Associate6"));
-    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,
-        std::unique_ptr<SyncChangeProcessor>(
-            new SharedChangeProcessorRef(shared_change_processor_)),
-        std::unique_ptr<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;
-    }
-  }
-
-  // TODO(robliao): Remove ScopedTracker below once https://crbug.com/471403 is
-  // fixed.
-  tracked_objects::ScopedTracker tracking_profile7(
-      FROM_HERE_WITH_EXPLICIT_FUNCTION(
-          "471403 UIDataTypeController::Associate7"));
-  syncer_merge_result.set_num_items_after_association(
-      shared_change_processor_->GetSyncCount());
-
-  state_ = RUNNING;
-  StartDone(sync_has_nodes ? OK : OK_FIRST_RUN, local_merge_result,
-            syncer_merge_result);
-}
-
-ChangeProcessor* UIDataTypeController::GetChangeProcessor() const {
-  DCHECK_EQ(state_, RUNNING);
-  return shared_change_processor_->generic_change_processor();
-}
-
-void UIDataTypeController::AbortModelLoad() {
-  DCHECK(CalledOnValidThread());
-  state_ = NOT_RUNNING;
-
-  if (shared_change_processor_.get()) {
-    shared_change_processor_ = nullptr;
-  }
-
-  // We don't want to continue loading models (e.g OnModelLoaded should never be
-  // called after we've decided to abort).
-  StopModels();
-}
-
-void UIDataTypeController::StartDone(
-    ConfigureResult start_result,
-    const SyncMergeResult& local_merge_result,
-    const SyncMergeResult& syncer_merge_result) {
-  DCHECK(CalledOnValidThread());
-
-  // TODO(robliao): Remove ScopedTracker below once https://crbug.com/471403 is
-  // fixed.
-  tracked_objects::ScopedTracker tracking_profile(
-      FROM_HERE_WITH_EXPLICIT_FUNCTION(
-          "471403 UIDataTypeController::StartDone"));
-
-  if (!IsSuccessfulResult(start_result)) {
-    StopModels();
-    if (start_result == ASSOCIATION_FAILED) {
-      state_ = DISABLED;
-    } else {
-      state_ = NOT_RUNNING;
-    }
-    RecordStartFailure(start_result);
-
-    if (shared_change_processor_.get()) {
-      shared_change_processor_->Disconnect();
-      shared_change_processor_ = nullptr;
-    }
-  }
-
-  start_callback_.Run(start_result, local_merge_result, syncer_merge_result);
-}
-
-void UIDataTypeController::Stop() {
-  DCHECK(CalledOnValidThread());
-  DCHECK(IsRealDataType(type()));
-
-  if (state_ == NOT_RUNNING)
-    return;
-
-  State prev_state = state_;
-  state_ = STOPPING;
-
-  if (shared_change_processor_.get()) {
-    shared_change_processor_->Disconnect();
-    shared_change_processor_ = nullptr;
-  }
-
-  // If Stop() is called while Start() is waiting for the datatype model to
-  // load, abort the start.
-  if (prev_state == MODEL_STARTING) {
-    AbortModelLoad();
-    // We can just return here since we haven't performed association if we're
-    // still in MODEL_STARTING.
-    return;
-  }
-
-  StopModels();
-
-  if (local_service_.get()) {
-    local_service_->StopSyncing(type());
-  }
-
-  state_ = NOT_RUNNING;
-}
-
-void UIDataTypeController::StopModels() {
-  // Do nothing by default.
-}
-
-ModelSafeGroup UIDataTypeController::model_safe_group() const {
-  DCHECK(IsRealDataType(type()));
-  return GROUP_UI;
-}
-
-std::string UIDataTypeController::name() const {
-  // For logging only.
-  return ModelTypeToString(type());
-}
-
-DataTypeController::State UIDataTypeController::state() const {
-  return state_;
-}
-
-std::unique_ptr<DataTypeErrorHandler>
-UIDataTypeController::CreateErrorHandler() {
-  DCHECK(CalledOnValidThread());
-  return base::MakeUnique<DataTypeErrorHandlerImpl>(
-      base::ThreadTaskRunnerHandle::Get(), dump_stack_,
-      base::Bind(&UIDataTypeController::OnUnrecoverableError,
-                 base::AsWeakPtr(this)));
-}
-
-void UIDataTypeController::OnUnrecoverableError(const SyncError& error) {
-  DCHECK(CalledOnValidThread());
-  DCHECK_EQ(type(), error.model_type());
-  if (!model_load_callback_.is_null()) {
-    model_load_callback_.Run(type(), error);
-  }
-}
-
-void UIDataTypeController::RecordAssociationTime(base::TimeDelta time) {
-  DCHECK(CalledOnValidThread());
-#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 UIDataTypeController::RecordStartFailure(ConfigureResult result) {
-  DCHECK(CalledOnValidThread());
-  UMA_HISTOGRAM_ENUMERATION("Sync.DataTypeStartFailures",
-                            ModelTypeToHistogramInt(type()), 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
-}
-
-}  // namespace syncer