sync/engine/commit.cc

   1 // Copyright 2012 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #include "sync/engine/commit.h"
   6
   7 #include "base/trace_event/trace_event.h"
   8 #include "sync/engine/commit_contribution.h"
   9 #include "sync/engine/commit_processor.h"
  10 #include "sync/engine/commit_util.h"
  11 #include "sync/engine/syncer.h"
  12 #include "sync/engine/syncer_proto_util.h"
  13 #include "sync/internal_api/public/events/commit_request_event.h"
  14 #include "sync/internal_api/public/events/commit_response_event.h"
  15 #include "sync/sessions/sync_session.h"
  16
  17 namespace syncer {
  18
  19 Commit::Commit(
  20     const std::map<ModelType, CommitContribution*>& contributions,
  21     const sync_pb::ClientToServerMessage& message,
  22     ExtensionsActivity::Records extensions_activity_buffer)
  23   : contributions_(contributions),
  24     deleter_(&contributions_),
  25     message_(message),
  26     extensions_activity_buffer_(extensions_activity_buffer),
  27     cleaned_up_(false) {
  28 }
  29
  30 Commit::~Commit() {
  31   DCHECK(cleaned_up_);
  32 }
  33
  34 Commit* Commit::Init(
  35     ModelTypeSet requested_types,
  36     ModelTypeSet enabled_types,
  37     size_t max_entries,
  38     const std::string& account_name,
  39     const std::string& cache_guid,
  40     CommitProcessor* commit_processor,
  41     ExtensionsActivity* extensions_activity) {
  42   // Gather per-type contributions.
  43   ContributionMap contributions;
  44   commit_processor->GatherCommitContributions(
  45       requested_types,
  46       max_entries,
  47       &contributions);
  48
  49   // Give up if no one had anything to commit.
  50   if (contributions.empty())
  51     return NULL;
  52
  53   sync_pb::ClientToServerMessage message;
  54   message.set_message_contents(sync_pb::ClientToServerMessage::COMMIT);
  55   message.set_share(account_name);
  56
  57   sync_pb::CommitMessage* commit_message = message.mutable_commit();
  58   commit_message->set_cache_guid(cache_guid);
  59
  60   // Set extensions activity if bookmark commits are present.
  61   ExtensionsActivity::Records extensions_activity_buffer;
  62   ContributionMap::iterator it = contributions.find(syncer::BOOKMARKS);
  63   if (it != contributions.end() && it->second->GetNumEntries() != 0) {
  64     commit_util::AddExtensionsActivityToMessage(
  65         extensions_activity,
  66         &extensions_activity_buffer,
  67         commit_message);
  68   }
  69
  70   // Set the client config params.
  71   commit_util::AddClientConfigParamsToMessage(
  72       enabled_types,
  73       commit_message);
  74
  75   // Finally, serialize all our contributions.
  76   for (std::map<ModelType, CommitContribution*>::iterator it =
  77            contributions.begin(); it != contributions.end(); ++it) {
  78     it->second->AddToCommitMessage(&message);
  79   }
  80
  81   // If we made it this far, then we've successfully prepared a commit message.
  82   return new Commit(contributions, message, extensions_activity_buffer);
  83 }
  84
  85 SyncerError Commit::PostAndProcessResponse(
  86     sessions::NudgeTracker* nudge_tracker,
  87     sessions::SyncSession* session,
  88     sessions::StatusController* status,
  89     ExtensionsActivity* extensions_activity) {
  90   ModelTypeSet request_types;
  91   for (ContributionMap::const_iterator it = contributions_.begin();
  92        it != contributions_.end(); ++it) {
  93     request_types.Put(it->first);
  94   }
  95   session->mutable_status_controller()->set_commit_request_types(request_types);
  96
  97   if (session->context()->debug_info_getter()) {
  98     sync_pb::DebugInfo* debug_info = message_.mutable_debug_info();
  99     session->context()->debug_info_getter()->GetDebugInfo(debug_info);
 100   }
 101
 102   DVLOG(1) << "Sending commit message.";
 103
 104   CommitRequestEvent request_event(
 105       base::Time::Now(),
 106       message_.commit().entries_size(),
 107       request_types,
 108       message_);
 109   session->SendProtocolEvent(request_event);
 110
 111   TRACE_EVENT_BEGIN0("sync", "PostCommit");
 112   const SyncerError post_result = SyncerProtoUtil::PostClientToServerMessage(
 113       &message_, &response_, session, NULL);
 114   TRACE_EVENT_END0("sync", "PostCommit");
 115
 116   // TODO(rlarocque): Use result that includes errors captured later?
 117   CommitResponseEvent response_event(
 118       base::Time::Now(),
 119       post_result,
 120       response_);
 121   session->SendProtocolEvent(response_event);
 122
 123   if (post_result != SYNCER_OK) {
 124     LOG(WARNING) << "Post commit failed";
 125     return post_result;
 126   }
 127
 128   if (!response_.has_commit()) {
 129     LOG(WARNING) << "Commit response has no commit body!";
 130     return SERVER_RESPONSE_VALIDATION_FAILED;
 131   }
 132
 133   size_t message_entries = message_.commit().entries_size();
 134   size_t response_entries = response_.commit().entryresponse_size();
 135   if (message_entries != response_entries) {
 136     LOG(ERROR)
 137        << "Commit response has wrong number of entries! "
 138        << "Expected: " << message_entries << ", "
 139        << "Got: " << response_entries;
 140     return SERVER_RESPONSE_VALIDATION_FAILED;
 141   }
 142
 143   if (session->context()->debug_info_getter()) {
 144     // Clear debug info now that we have successfully sent it to the server.
 145     DVLOG(1) << "Clearing client debug info.";
 146     session->context()->debug_info_getter()->ClearDebugInfo();
 147   }
 148
 149   // Let the contributors process the responses to each of their requests.
 150   SyncerError processing_result = SYNCER_OK;
 151   for (std::map<ModelType, CommitContribution*>::iterator it =
 152        contributions_.begin(); it != contributions_.end(); ++it) {
 153     TRACE_EVENT1("sync", "ProcessCommitResponse",
 154                  "type", ModelTypeToString(it->first));
 155     SyncerError type_result =
 156         it->second->ProcessCommitResponse(response_, status);
 157     if (type_result == SERVER_RETURN_CONFLICT) {
 158       nudge_tracker->RecordCommitConflict(it->first);
 159     }
 160     if (processing_result == SYNCER_OK && type_result != SYNCER_OK) {
 161       processing_result = type_result;
 162     }
 163   }
 164
 165   // Handle bookmarks' special extensions activity stats.
 166   if (session->status_controller().
 167           model_neutral_state().num_successful_bookmark_commits == 0) {
 168     extensions_activity->PutRecords(extensions_activity_buffer_);
 169   }
 170
 171   return processing_result;
 172 }
 173
 174 void Commit::CleanUp() {
 175   for (ContributionMap::iterator it = contributions_.begin();
 176        it != contributions_.end(); ++it) {
 177     it->second->CleanUp();
 178   }
 179   cleaned_up_ = true;
 180 }
 181
 182 }  // namespace syncer