1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
|
// Copyright 2012 The Chromium Authors
// 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/data_type.h"
#include "components/sync/engine/cycle/sync_cycle.h"
#include "components/sync/engine/syncer_error.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`.
DataTypeSet 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 the result of processing. 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,
DataTypeSet* 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);
// Handles the server response and returns whether there was any error.
static SyncerError HandleClientToServerMessageResponse(
const sync_pb::ClientToServerResponse& response,
SyncCycle* cycle,
DataTypeSet* partial_failure_data_types);
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_
|
