blob: 8a00608f925bd143a18a35006565e753447bc870 [file] [log] [blame]
// 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/process_commit_response_command.h"
#include <cstddef>
#include <set>
#include <string>
#include <vector>
#include "base/basictypes.h"
#include "base/location.h"
#include "sync/engine/syncer_proto_util.h"
#include "sync/engine/syncer_util.h"
#include "sync/sessions/sync_session.h"
#include "sync/syncable/entry.h"
#include "sync/syncable/mutable_entry.h"
#include "sync/syncable/read_transaction.h"
#include "sync/syncable/syncable_proto_util.h"
#include "sync/syncable/syncable_util.h"
#include "sync/syncable/write_transaction.h"
#include "sync/util/time.h"
using std::set;
using std::string;
using std::vector;
using sync_pb::CommitResponse;
namespace syncer {
using sessions::OrderedCommitSet;
using sessions::StatusController;
using sessions::SyncSession;
using sessions::ConflictProgress;
using syncable::WriteTransaction;
using syncable::MutableEntry;
using syncable::Entry;
using syncable::BASE_VERSION;
using syncable::GET_BY_ID;
using syncable::ID;
using syncable::IS_DEL;
using syncable::IS_DIR;
using syncable::IS_UNAPPLIED_UPDATE;
using syncable::IS_UNSYNCED;
using syncable::PARENT_ID;
using syncable::SERVER_IS_DEL;
using syncable::SERVER_PARENT_ID;
using syncable::SERVER_VERSION;
using syncable::SYNCER;
using syncable::SYNCING;
const sessions::OrderedCommitSet& commit_set,
const sync_pb::ClientToServerMessage& commit_message,
const sync_pb::ClientToServerResponse& commit_response)
: commit_set_(commit_set),
commit_response_(commit_response) {
ProcessCommitResponseCommand::~ProcessCommitResponseCommand() {}
std::set<ModelSafeGroup> ProcessCommitResponseCommand::GetGroupsToChange(
const sessions::SyncSession& session) const {
std::set<ModelSafeGroup> groups_with_commits;
syncable::Directory* dir = session.context()->directory();
syncable::ReadTransaction trans(FROM_HERE, dir);
for (size_t i = 0; i < commit_set_.Size(); ++i) {
return groups_with_commits;
SyncerError ProcessCommitResponseCommand::ModelChangingExecuteImpl(
SyncSession* session) {
SyncerError result = ProcessCommitResponse(session);
ExtensionsActivityMonitor* monitor = session->context()->extensions_monitor();
// This is to be run on one model only: the bookmark model.
if (session->status_controller().HasBookmarkCommitActivity()) {
// If the commit failed, return the data to the ExtensionsActivityMonitor.
if (session->status_controller().
model_neutral_state().num_successful_bookmark_commits == 0) {
// Clear our cached data in either case.
return result;
SyncerError ProcessCommitResponseCommand::ProcessCommitResponse(
SyncSession* session) {
syncable::Directory* dir = session->context()->directory();
StatusController* status = session->mutable_status_controller();
const CommitResponse& cr = commit_response_.commit();
const sync_pb::CommitMessage& commit_message = commit_message_.commit();
int transient_error_commits = 0;
int conflicting_commits = 0;
int error_commits = 0;
int successes = 0;
set<syncable::Id> deleted_folders;
ConflictProgress* conflict_progress = status->mutable_conflict_progress();
OrderedCommitSet::Projection proj = status->commit_id_projection(
if (!proj.empty()) { // Scope for WriteTransaction.
WriteTransaction trans(FROM_HERE, SYNCER, dir);
for (size_t i = 0; i < proj.size(); i++) {
CommitResponse::ResponseType response_type = ProcessSingleCommitResponse(
switch (response_type) {
case CommitResponse::INVALID_MESSAGE:
case CommitResponse::CONFLICT:
case CommitResponse::SUCCESS:
// TODO(sync): worry about sync_rate_ rate calc?
if (commit_set_.GetModelTypeAt(proj[i]) == BOOKMARKS)
case CommitResponse::OVER_QUOTA:
// We handle over quota like a retry, which is same as transient.
case CommitResponse::RETRY:
case CommitResponse::TRANSIENT_ERROR:
LOG(FATAL) << "Bad return from ProcessSingleCommitResponse";
MarkDeletedChildrenSynced(dir, &deleted_folders);
int commit_count = static_cast<int>(proj.size());
if (commit_count == successes) {
return SYNCER_OK;
} else if (error_commits > 0) {
} else if (transient_error_commits > 0) {
} else if (conflicting_commits > 0) {
// This means that the server already has an item with this version, but
// we haven't seen that update yet.
// A well-behaved client should respond to this by proceeding to the
// download updates phase, fetching the conflicting items, then attempting
// to resolve the conflict. That's not what this client does.
// We don't currently have any code to support that exceptional control
// flow. We don't intend to add any because this response code will be
// deprecated soon. Instead, we handle this in the same way that we handle
// transient errors. We abort the current sync cycle, wait a little while,
// then try again. The retry sync cycle will attempt to download updates
// which should be sufficient to trigger client-side conflict resolution.
// Not treating this as an error would be dangerous. There's a risk that
// the commit loop would loop indefinitely. The loop won't exit until the
// number of unsynced items hits zero or an error is detected. If we're
// constantly receiving conflict responses and we don't treat them as
// errors, there would be no reason to leave that loop.
// TODO: Remove this option when the CONFLICT return value is fully
// deprecated.
} else {
LOG(FATAL) << "Inconsistent counts when processing commit response";
return SYNCER_OK;
void LogServerError(const sync_pb::CommitResponse_EntryResponse& res) {
if (res.has_error_message())
LOG(WARNING) << " " << res.error_message();
LOG(WARNING) << " No detailed error message returned from server";
syncable::WriteTransaction* trans,
const sync_pb::CommitResponse_EntryResponse& server_entry,
const sync_pb::SyncEntity& commit_request_entry,
const syncable::Id& pre_commit_id,
set<syncable::Id>* deleted_folders) {
MutableEntry local_entry(trans, GET_BY_ID, pre_commit_id);
bool syncing_was_set = local_entry.Get(SYNCING);
local_entry.Put(SYNCING, false);
CommitResponse::ResponseType response = (CommitResponse::ResponseType)
if (!CommitResponse::ResponseType_IsValid(response)) {
LOG(ERROR) << "Commit response has unknown response type! Possibly out "
"of date client?";
return CommitResponse::INVALID_MESSAGE;
if (CommitResponse::TRANSIENT_ERROR == response) {
DVLOG(1) << "Transient Error Committing: " << local_entry;
return CommitResponse::TRANSIENT_ERROR;
if (CommitResponse::INVALID_MESSAGE == response) {
LOG(ERROR) << "Error Commiting: " << local_entry;
return response;
if (CommitResponse::CONFLICT == response) {
DVLOG(1) << "Conflict Committing: " << local_entry;
return response;
if (CommitResponse::RETRY == response) {
DVLOG(1) << "Retry Committing: " << local_entry;
return response;
if (CommitResponse::OVER_QUOTA == response) {
LOG(WARNING) << "Hit deprecated OVER_QUOTA Committing: " << local_entry;
return response;
if (!server_entry.has_id_string()) {
LOG(ERROR) << "Commit response has no id";
return CommitResponse::INVALID_MESSAGE;
// Implied by the IsValid call above, but here for clarity.
DCHECK_EQ(CommitResponse::SUCCESS, response) << response;
// Check to see if we've been given the ID of an existing entry. If so treat
// it as an error response and retry later.
const syncable::Id& server_entry_id =
if (pre_commit_id != server_entry_id) {
Entry e(trans, GET_BY_ID, server_entry_id);
if (e.good()) {
LOG(ERROR) << "Got duplicate id when commiting id: " << pre_commit_id <<
". Treating as an error return";
return CommitResponse::INVALID_MESSAGE;
if (server_entry.version() == 0) {
LOG(WARNING) << "Server returned a zero version on a commit response.";
ProcessSuccessfulCommitResponse(commit_request_entry, server_entry,
pre_commit_id, &local_entry, syncing_was_set, deleted_folders);
return response;
const string& ProcessCommitResponseCommand::GetResultingPostCommitName(
const sync_pb::SyncEntity& committed_entry,
const sync_pb::CommitResponse_EntryResponse& entry_response) {
const string& response_name =
if (!response_name.empty())
return response_name;
return SyncerProtoUtil::NameFromSyncEntity(committed_entry);
bool ProcessCommitResponseCommand::UpdateVersionAfterCommit(
const sync_pb::SyncEntity& committed_entry,
const sync_pb::CommitResponse_EntryResponse& entry_response,
const syncable::Id& pre_commit_id,
syncable::MutableEntry* local_entry) {
int64 old_version = local_entry->Get(BASE_VERSION);
int64 new_version = entry_response.version();
bool bad_commit_version = false;
if (committed_entry.deleted() &&
!local_entry->Get(syncable::UNIQUE_CLIENT_TAG).empty()) {
// If the item was deleted, and it's undeletable (uses the client tag),
// change the version back to zero. We must set the version to zero so
// that the server knows to re-create the item if it gets committed
// later for undeletion.
new_version = 0;
} else if (!pre_commit_id.ServerKnows()) {
bad_commit_version = 0 == new_version;
} else {
bad_commit_version = old_version > new_version;
if (bad_commit_version) {
LOG(ERROR) << "Bad version in commit return for " << *local_entry
<< " new_id:" << SyncableIdFromProto(entry_response.id_string())
<< " new_version:" << entry_response.version();
return false;
// Update the base version and server version. The base version must change
// here, even if syncing_was_set is false; that's because local changes were
// on top of the successfully committed version.
local_entry->Put(BASE_VERSION, new_version);
DVLOG(1) << "Commit is changing base version of " << local_entry->Get(ID)
<< " to: " << new_version;
local_entry->Put(SERVER_VERSION, new_version);
return true;
bool ProcessCommitResponseCommand::ChangeIdAfterCommit(
const sync_pb::CommitResponse_EntryResponse& entry_response,
const syncable::Id& pre_commit_id,
syncable::MutableEntry* local_entry) {
syncable::WriteTransaction* trans = local_entry->write_transaction();
const syncable::Id& entry_response_id =
if (entry_response_id != pre_commit_id) {
if (pre_commit_id.ServerKnows()) {
// The server can sometimes generate a new ID on commit; for example,
// when committing an undeletion.
DVLOG(1) << " ID changed while committing an old entry. "
<< pre_commit_id << " became " << entry_response_id << ".";
MutableEntry same_id(trans, GET_BY_ID, entry_response_id);
// We should trap this before this function.
if (same_id.good()) {
LOG(ERROR) << "ID clash with id " << entry_response_id
<< " during commit " << same_id;
return false;
ChangeEntryIDAndUpdateChildren(trans, local_entry, entry_response_id);
DVLOG(1) << "Changing ID to " << entry_response_id;
return true;
void ProcessCommitResponseCommand::UpdateServerFieldsAfterCommit(
const sync_pb::SyncEntity& committed_entry,
const sync_pb::CommitResponse_EntryResponse& entry_response,
syncable::MutableEntry* local_entry) {
// We just committed an entry successfully, and now we want to make our view
// of the server state consistent with the server state. We must be careful;
// |entry_response| and |committed_entry| have some identically named
// fields. We only want to consider fields from |committed_entry| when there
// is not an overriding field in the |entry_response|. We do not want to
// update the server data from the local data in the entry -- it's possible
// that the local data changed during the commit, and even if not, the server
// has the last word on the values of several properties.
local_entry->Put(SERVER_IS_DEL, committed_entry.deleted());
if (committed_entry.deleted()) {
// Don't clobber any other fields of deleted objects.
(committed_entry.folder() ||
// TODO(nick): The server doesn't set entry_response.server_parent_id in
// practice; to update SERVER_PARENT_ID appropriately here we'd need to
// get the post-commit ID of the parent indicated by
// committed_entry.parent_id_string(). That should be inferrable from the
// information we have, but it's a bit convoluted to pull it out directly.
// Getting this right is important: SERVER_PARENT_ID gets fed back into
// old_parent_id during the next commit.
GetResultingPostCommitName(committed_entry, entry_response));
if (local_entry->Get(IS_UNAPPLIED_UPDATE)) {
// This shouldn't happen; an unapplied update shouldn't be committed, and
// if it were, the commit should have failed. But if it does happen: we've
// just overwritten the update info, so clear the flag.
local_entry->Put(IS_UNAPPLIED_UPDATE, false);
void ProcessCommitResponseCommand::OverrideClientFieldsAfterCommit(
const sync_pb::SyncEntity& committed_entry,
const sync_pb::CommitResponse_EntryResponse& entry_response,
syncable::MutableEntry* local_entry) {
if (committed_entry.deleted()) {
// If an entry's been deleted, nothing else matters.
// Update the name.
const string& server_name =
GetResultingPostCommitName(committed_entry, entry_response);
const string& old_name =
if (!server_name.empty() && old_name != server_name) {
DVLOG(1) << "During commit, server changed name: " << old_name
<< " to new name: " << server_name;
local_entry->Put(syncable::NON_UNIQUE_NAME, server_name);
// The server has the final say on positioning, so apply the absolute
// position that it returns.
if (entry_response.has_position_in_parent()) {
// The SERVER_ field should already have been written.
// We just committed successfully, so we assume that the position
// value we got applies to the PARENT_ID we submitted.
syncable::Id new_prev = local_entry->ComputePrevIdFromServerPosition(
if (!local_entry->PutPredecessor(new_prev)) {
// TODO(lipalani) : Propagate the error to caller.
void ProcessCommitResponseCommand::ProcessSuccessfulCommitResponse(
const sync_pb::SyncEntity& committed_entry,
const sync_pb::CommitResponse_EntryResponse& entry_response,
const syncable::Id& pre_commit_id, syncable::MutableEntry* local_entry,
bool syncing_was_set, set<syncable::Id>* deleted_folders) {
if (!UpdateVersionAfterCommit(committed_entry, entry_response, pre_commit_id,
local_entry)) {
LOG(ERROR) << "Bad version in commit return for " << *local_entry
<< " new_id:" << SyncableIdFromProto(entry_response.id_string())
<< " new_version:" << entry_response.version();
// If the server gave us a new ID, apply it.
if (!ChangeIdAfterCommit(entry_response, pre_commit_id, local_entry)) {
// Update our stored copy of the server state.
UpdateServerFieldsAfterCommit(committed_entry, entry_response, local_entry);
// If the item doesn't need to be committed again (an item might need to be
// committed again if it changed locally during the commit), we can remove
// it from the unsynced list. Also, we should change the locally-
// visible properties to apply any canonicalizations or fixups
// that the server introduced during the commit.
if (syncing_was_set) {
OverrideClientFieldsAfterCommit(committed_entry, entry_response,
local_entry->Put(IS_UNSYNCED, false);
// Make a note of any deleted folders, whose children would have
// been recursively deleted.
// TODO(nick): Here, commit_message.deleted() would be more correct than
// local_entry->Get(IS_DEL). For example, an item could be renamed, and then
// deleted during the commit of the rename. Unit test & fix.
if (local_entry->Get(IS_DIR) && local_entry->Get(IS_DEL)) {
} // namespace syncer