123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112 |
- // Copyright 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.
- #ifndef COMPONENTS_SYNC_ENGINE_SYNCER_PROTO_UTIL_H_
- #define COMPONENTS_SYNC_ENGINE_SYNCER_PROTO_UTIL_H_
- #include <string>
- #include "base/gtest_prod_util.h"
- #include "base/time/time.h"
- #include "components/sync/base/model_type.h"
- #include "components/sync/base/syncer_error.h"
- #include "components/sync/engine/cycle/sync_cycle.h"
- namespace sync_pb {
- class ClientToServerMessage;
- class ClientToServerResponse;
- class ClientToServerResponse_Error;
- class SyncEntity;
- } // namespace sync_pb
- namespace syncer {
- class ServerConnectionManager;
- struct SyncProtocolError;
- // Returns the types to migrate from the data in |response|.
- ModelTypeSet GetTypesToMigrate(const sync_pb::ClientToServerResponse& response);
- // Builds a SyncProtocolError from the data in |error|.
- SyncProtocolError ConvertErrorPBToSyncProtocolError(
- const sync_pb::ClientToServerResponse_Error& error);
- class SyncerProtoUtil {
- public:
- SyncerProtoUtil(const SyncerProtoUtil&) = delete;
- SyncerProtoUtil& operator=(const SyncerProtoUtil&) = delete;
- // Adds all fields that must be sent on every request, which includes store
- // birthday, protocol version, client chips, api keys, etc. |msg| must be not
- // null. Must be called before calling PostClientToServerMessage().
- static void AddRequiredFieldsToClientToServerMessage(
- const SyncCycle* cycle,
- sync_pb::ClientToServerMessage* msg);
- // Posts the given message and fills the buffer with the returned value.
- // Returns true on success. Also handles store birthday verification: will
- // produce a SyncError if the birthday is incorrect. Before calling this
- // method, AddRequiredFieldsToClientToServerMessage() must be called.
- static SyncerError PostClientToServerMessage(
- const sync_pb::ClientToServerMessage& msg,
- sync_pb::ClientToServerResponse* response,
- SyncCycle* cycle,
- ModelTypeSet* partial_failure_data_types);
- // Specifies where entity's position should be updated from the data in
- // GetUpdates message.
- static bool ShouldMaintainPosition(const sync_pb::SyncEntity& sync_entity);
- // Specifies where entity's parent ID should be updated from the data in
- // GetUpdates message.
- static bool ShouldMaintainHierarchy(const sync_pb::SyncEntity& sync_entity);
- // Get a debug string representation of the client to server response.
- static std::string ClientToServerResponseDebugString(
- const sync_pb::ClientToServerResponse& response);
- // Get update contents as a string. Intended for logging, and intended
- // to have a smaller footprint than the protobuf's built-in pretty printer.
- static std::string SyncEntityDebugString(const sync_pb::SyncEntity& entry);
- // Set the protocol version field in the outgoing message.
- static void SetProtocolVersion(sync_pb::ClientToServerMessage* msg);
- private:
- SyncerProtoUtil() = default;
- // Helper functions for PostClientToServerMessage.
- // Analyzes error fields and store birthday in response message, compares
- // store birthday with the one in the sync cycle and returns corresponding
- // SyncProtocolError. If needed updates store birthday in the cycle context.
- // This function makes it easier to test error handling.
- static SyncProtocolError GetProtocolErrorFromResponse(
- const sync_pb::ClientToServerResponse& response,
- SyncCycleContext* context);
- // Returns true if sync is disabled by admin for a dasher account.
- static bool IsSyncDisabledByAdmin(
- const sync_pb::ClientToServerResponse& response);
- // Post the message using the scm, and do some processing on the returned
- // headers. Decode the server response.
- static bool PostAndProcessHeaders(ServerConnectionManager* scm,
- const sync_pb::ClientToServerMessage& msg,
- sync_pb::ClientToServerResponse* response);
- static base::TimeDelta GetThrottleDelay(
- const sync_pb::ClientToServerResponse& response);
- friend class LoopbackServerTest;
- friend class SyncerProtoUtilTest;
- FRIEND_TEST_ALL_PREFIXES(SyncerProtoUtilTest, AddRequestBirthday);
- FRIEND_TEST_ALL_PREFIXES(SyncerProtoUtilTest, PostAndProcessHeaders);
- FRIEND_TEST_ALL_PREFIXES(SyncerProtoUtilTest, HandleThrottlingNoDatatypes);
- FRIEND_TEST_ALL_PREFIXES(SyncerProtoUtilTest, HandleThrottlingWithDatatypes);
- };
- } // namespace syncer
- #endif // COMPONENTS_SYNC_ENGINE_SYNCER_PROTO_UTIL_H_
|