FYI: Remove PerModelSafeGroupState + move ConflictResolution

sync/engine/update_applicator.cc

 // Copyright (c) 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 "sync/engine/update_applicator.h"
 
 #include <vector>
 
 #include "base/logging.h"
 #include "sync/engine/syncer_util.h"
-#include "sync/sessions/session_state.h"
 #include "sync/syncable/entry.h"
 #include "sync/syncable/mutable_entry.h"
 #include "sync/syncable/syncable_id.h"
 #include "sync/syncable/write_transaction.h"
 
 using std::vector;
 
 namespace syncer {
 
-UpdateApplicator::UpdateApplicator(ConflictResolver* resolver,
-                                   Cryptographer* cryptographer,
-                                   const UpdateIterator& begin,
-                                   const UpdateIterator& end,
+using syncable::ID;
+
+UpdateApplicator::UpdateApplicator(Cryptographer* cryptographer,
                                    const ModelSafeRoutingInfo& routes,
                                    ModelSafeGroup group_filter)
-    : resolver_(resolver),
-      cryptographer_(cryptographer),
-      begin_(begin),
-      end_(end),
-      pointer_(begin),
+    : cryptographer_(cryptographer),
       group_filter_(group_filter),
-      progress_(false),
-      routing_info_(routes),
-      application_results_(end - begin) {
-  size_t item_count = end - begin;
-  DVLOG(1) << "UpdateApplicator created for " << item_count << " items.";
+      routing_info_(routes) {
 }
 
 UpdateApplicator::~UpdateApplicator() {
 }
 
-// Returns true if there's more to do.
-bool UpdateApplicator::AttemptOneApplication(
-    syncable::WriteTransaction* trans) {
-  // If there are no updates left to consider, we're done.
-  if (end_ == begin_)
-    return false;
-  if (pointer_ == end_) {
-    if (!progress_)
-      return false;
+// Attempt to apply all updates, using multiple passes if necessary.
+//
+// Some updates must be applied in order.  For example, children must be created
+// after their parent folder is created.  This function runs an O(n^2) algorithm
+// that will keep trying until there is nothing left to apply, or it stops
+// making progress, which would indicate that the hierarchy is invalid.
+//
+// The update applicator also has to deal with simple conflicts, which occur
+// when an item is modified on both the server and the local model, and
+// encryption conflicts.  There's not much we can do about them here, so we
+// don't bother re-processing them on subsequent passes.
+void UpdateApplicator::AttemptApplications(
+    syncable::WriteTransaction* trans,
+    std::vector<int64> to_apply,
+    std::set<syncable::Id>* simple_conflict_ids) {
 
-    DVLOG(1) << "UpdateApplicator doing additional pass.";
-    pointer_ = begin_;
-    progress_ = false;
+  // This function may be called more than once.  If that happens, we will
+  // re-visit old encryption and hierarchy conflicts.  We clear those counts
+  // in advance to avoid double-counting them.
+  encryption_conflicts_ = 0;
+  hierarchy_conflicts_ = 0;
 
-    // Clear the tracked failures to avoid double-counting.
-    application_results_.ClearConflicts();
+  DVLOG(1) << "UpdateApplicator running over " << to_apply.size() << " items.";
+  while (!to_apply.empty()) {
+    std::vector<int64> to_reapply;
+
+    for (UpdateIterator i = to_apply.begin(); i != to_apply.end(); ++i) {
+      syncable::Entry read_entry(trans, syncable::GET_BY_HANDLE, *i);
+      if (SkipUpdate(read_entry)) {
+        continue;
+      }
+
+      syncable::MutableEntry entry(trans, syncable::GET_BY_HANDLE, *i);
+      UpdateAttemptResponse result = AttemptToUpdateEntry(
+          trans, &entry, cryptographer_);
+
+      switch (result) {
+        case SUCCESS:
+          updates_applied_++;
+          break;
+        case CONFLICT_SIMPLE:
+          simple_conflict_ids->insert(entry.Get(ID));
+          break;
+        case CONFLICT_ENCRYPTION:
+          encryption_conflicts_++;
+          break;
+        case CONFLICT_HIERARCHY:
+          // It may be a real hierarchy conflict, but odds are we just tried to
+          // apply it in the wrong order.
+          to_reapply.push_back(*i);
+          break;
+        default:
+          NOTREACHED();
+          break;
+      }
+    }
+
+    if (to_reapply.size() == to_apply.size()) {
+      // We made no progress.  Must be stubborn hierarchy conflicts.
+      hierarchy_conflicts_ = to_apply.size();
+      break;
+    }
+
+    to_apply = to_reapply;
   }
-
-  syncable::Entry read_only(trans, syncable::GET_BY_HANDLE, *pointer_);
-  if (SkipUpdate(read_only)) {
-    Advance();
-    return true;
-  }
-
-  syncable::MutableEntry entry(trans, syncable::GET_BY_HANDLE, *pointer_);
-  UpdateAttemptResponse updateResponse = AttemptToUpdateEntry(
-      trans, &entry, resolver_, cryptographer_);
-  switch (updateResponse) {
-    case SUCCESS:
-      Advance();
-      progress_ = true;
-      application_results_.AddSuccess(entry.Get(syncable::ID));
-      break;
-    case CONFLICT_SIMPLE:
-      pointer_++;
-      application_results_.AddSimpleConflict(entry.Get(syncable::ID));
-      break;
-    case CONFLICT_ENCRYPTION:
-      pointer_++;
-      application_results_.AddEncryptionConflict(entry.Get(syncable::ID));
-      break;
-    case CONFLICT_HIERARCHY:
-      pointer_++;
-      application_results_.AddHierarchyConflict(entry.Get(syncable::ID));
-      break;
-    default:
-      NOTREACHED();
-      break;
-  }
-  DVLOG(1) << "Apply Status for " << entry.Get(syncable::META_HANDLE)
-           << " is " << updateResponse;
-
-  return true;
-}
-
-void UpdateApplicator::Advance() {
-  --end_;
-  *pointer_ = *end_;
 }
 
 bool UpdateApplicator::SkipUpdate(const syncable::Entry& entry) {
   ModelType type = entry.GetServerModelType();
   ModelSafeGroup g = GetGroupForModelType(type, routing_info_);
   // The set of updates passed to the UpdateApplicator should already
   // be group-filtered.
   if (g != group_filter_) {
     NOTREACHED();
     return true;
   }
   if (g == GROUP_PASSIVE &&
       !routing_info_.count(type) &&
       type != UNSPECIFIED &&
       type != TOP_LEVEL_FOLDER) {
     DVLOG(1) << "Skipping update application, type not permitted.";
     return true;
   }
   return false;
 }
 
-bool UpdateApplicator::AllUpdatesApplied() const {
-  return application_results_.no_conflicts() && begin_ == end_;
-}
+void UpdateApplicator::SaveStats(sessions::StatusController* status) {
+  status->increment_num_encryption_conflicts_by(encryption_conflicts_);
+  status->increment_num_hierarchy_conflicts_by(hierarchy_conflicts_);
+  status->increment_num_updates_applied_by(updates_applied_);
 
-void UpdateApplicator::SaveProgressIntoSessionState(
-    sessions::ConflictProgress* conflict_progress,
-    sessions::UpdateProgress* update_progress) {
-  DCHECK(begin_ == end_ || ((pointer_ == end_) && !progress_))
-      << "SaveProgress called before updates exhausted.";
-
-  application_results_.SaveProgress(conflict_progress, update_progress);
-}
-
-UpdateApplicator::ResultTracker::ResultTracker(size_t num_results) {
-  successful_ids_.reserve(num_results);
-}
-
-UpdateApplicator::ResultTracker::~ResultTracker() {
-}
-
-void UpdateApplicator::ResultTracker::AddSimpleConflict(syncable::Id id) {
-  conflicting_ids_.push_back(id);
-}
-
-void UpdateApplicator::ResultTracker::AddEncryptionConflict(syncable::Id id) {
-  encryption_conflict_ids_.push_back(id);
-}
-
-void UpdateApplicator::ResultTracker::AddHierarchyConflict(syncable::Id id) {
-  hierarchy_conflict_ids_.push_back(id);
-}
-
-void UpdateApplicator::ResultTracker::AddSuccess(syncable::Id id) {
-  successful_ids_.push_back(id);
-}
-
-void UpdateApplicator::ResultTracker::SaveProgress(
-    sessions::ConflictProgress* conflict_progress,
-    sessions::UpdateProgress* update_progress) {
-  vector<syncable::Id>::const_iterator i;
-  for (i = conflicting_ids_.begin(); i != conflicting_ids_.end(); ++i) {
-    conflict_progress->AddSimpleConflictingItemById(*i);
-    update_progress->AddAppliedUpdate(CONFLICT_SIMPLE, *i);
-  }
-  for (i = encryption_conflict_ids_.begin();
-       i != encryption_conflict_ids_.end(); ++i) {
-    conflict_progress->AddEncryptionConflictingItemById(*i);
-    update_progress->AddAppliedUpdate(CONFLICT_ENCRYPTION, *i);
-  }
-  for (i = hierarchy_conflict_ids_.begin();
-       i != hierarchy_conflict_ids_.end(); ++i) {
-    conflict_progress->AddHierarchyConflictingItemById(*i);
-    update_progress->AddAppliedUpdate(CONFLICT_HIERARCHY, *i);
-  }
-  for (i = successful_ids_.begin(); i != successful_ids_.end(); ++i) {
-    conflict_progress->EraseSimpleConflictingItemById(*i);
-    update_progress->AddAppliedUpdate(SUCCESS, *i);
-  }
-}
-
-void UpdateApplicator::ResultTracker::ClearConflicts() {
-  conflicting_ids_.clear();
-  encryption_conflict_ids_.clear();
-  hierarchy_conflict_ids_.clear();
-}
-
-bool UpdateApplicator::ResultTracker::no_conflicts() const {
-  return conflicting_ids_.empty();
 }
 
 }  // namespace syncer