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
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
|
/*
* Copyright 2018 Google
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#ifndef FIRESTORE_CORE_SRC_FIREBASE_FIRESTORE_REMOTE_SERIALIZER_H_
#define FIRESTORE_CORE_SRC_FIREBASE_FIRESTORE_REMOTE_SERIALIZER_H_
#include <cstdint>
#include <cstdlib>
#include <memory>
#include <string>
#include <vector>
#include "Firestore/core/src/firebase/firestore/model/database_id.h"
#include "Firestore/core/src/firebase/firestore/model/document.h"
#include "Firestore/core/src/firebase/firestore/model/document_key.h"
#include "Firestore/core/src/firebase/firestore/model/field_value.h"
#include "Firestore/core/src/firebase/firestore/model/maybe_document.h"
#include "Firestore/core/src/firebase/firestore/nanopb/reader.h"
#include "Firestore/core/src/firebase/firestore/nanopb/writer.h"
#include "Firestore/core/src/firebase/firestore/util/hard_assert.h"
#include "Firestore/core/src/firebase/firestore/util/status.h"
#include "Firestore/core/src/firebase/firestore/util/statusor.h"
#include "absl/base/attributes.h"
#include "absl/strings/string_view.h"
namespace firebase {
namespace firestore {
namespace local {
class LocalSerializer;
}
namespace remote {
/**
* @brief Converts internal model objects to their equivalent protocol buffer
* form, and protocol buffer objects to their equivalent bytes.
*
* Methods starting with "Encode" convert from a model object to a protocol
* buffer (or directly to bytes in cases where the proto uses a 'oneof', due to
* limitations in nanopb), and methods starting with "Decode" convert from a
* protocol buffer to a model object (or from bytes directly to a model
* objects.)
*/
// TODO(rsgowman): Original docs also has this: "Throws an exception if a
// protocol buffer is missing a critical field or has a value we can't
// interpret." Adjust for C++.
class Serializer {
public:
/**
* @param database_id Must remain valid for the lifetime of this Serializer
* object.
*/
explicit Serializer(const firebase::firestore::model::DatabaseId& database_id)
: database_id_(database_id) {
}
/**
* @brief Converts the FieldValue model passed into bytes.
*
* @param field_value the model to convert.
* @param[out] out_bytes A buffer to place the output. The bytes will be
* appended to this vector.
* @return A Status, which if not ok(), indicates what went wrong. Note that
* errors during encoding generally indicate a serious/fatal error.
*/
// TODO(rsgowman): If we never support any output except to a vector, it may
// make sense to have Serializer own the vector and provide an accessor rather
// than asking the user to create it first.
util::Status EncodeFieldValue(
const firebase::firestore::model::FieldValue& field_value,
std::vector<uint8_t>* out_bytes);
/**
* @brief Converts from bytes to the model FieldValue format.
*
* @param bytes The bytes to convert. It's assumed that exactly all of the
* bytes will be used by this conversion.
* @return The model equivalent of the bytes or a Status indicating
* what went wrong.
*/
util::StatusOr<model::FieldValue> DecodeFieldValue(const uint8_t* bytes,
size_t length);
/**
* @brief Converts from bytes to the model FieldValue format.
*
* @param bytes The bytes to convert. It's assumed that exactly all of the
* bytes will be used by this conversion.
* @return The model equivalent of the bytes or a Status indicating
* what went wrong.
*/
util::StatusOr<model::FieldValue> DecodeFieldValue(
const std::vector<uint8_t>& bytes) {
return DecodeFieldValue(bytes.data(), bytes.size());
}
/**
* Encodes the given document key as a fully qualified name. This includes the
* databaseId associated with this Serializer and the key path.
*/
std::string EncodeKey(
const firebase::firestore::model::DocumentKey& key) const;
/**
* Decodes the given document key from a fully qualified name.
*/
firebase::firestore::model::DocumentKey DecodeKey(
absl::string_view name) const;
/**
* @brief Converts the Document (i.e. key/value) into bytes.
*
* @param[out] out_bytes A buffer to place the output. The bytes will be
* appended to this vector.
* @return A Status, which if not ok(), indicates what went wrong. Note that
* errors during encoding generally indicate a serious/fatal error.
*/
// TODO(rsgowman): Similar to above, if we never support any output except to
// a vector, it may make sense to have Serializer own the vector and provide
// an accessor rather than asking the user to create it first.
util::Status EncodeDocument(
const firebase::firestore::model::DocumentKey& key,
const firebase::firestore::model::ObjectValue& value,
std::vector<uint8_t>* out_bytes) const;
/**
* @brief Converts from bytes to the model Document format.
*
* @param bytes The bytes to convert. These bytes must represent a
* BatchGetDocumentsResponse. It's assumed that exactly all of the bytes will
* be used by this conversion.
* @return The model equivalent of the bytes or a Status indicating
* what went wrong.
*/
util::StatusOr<std::unique_ptr<model::MaybeDocument>> DecodeMaybeDocument(
const uint8_t* bytes, size_t length) const;
/**
* @brief Converts from bytes to the model Document format.
*
* @param bytes The bytes to convert. These bytes must represent a
* BatchGetDocumentsResponse. It's assumed that exactly all of the bytes will
* be used by this conversion.
* @return The model equivalent of the bytes or a Status indicating
* what went wrong.
*/
util::StatusOr<std::unique_ptr<model::MaybeDocument>> DecodeMaybeDocument(
const std::vector<uint8_t>& bytes) const {
return DecodeMaybeDocument(bytes.data(), bytes.size());
}
std::unique_ptr<model::Document> DecodeDocument(nanopb::Reader* reader) const;
static void EncodeObjectMap(nanopb::Writer* writer,
const model::ObjectValue::Map& object_value_map,
uint32_t map_tag,
uint32_t key_tag,
uint32_t value_tag);
static void EncodeVersion(nanopb::Writer* writer,
const model::SnapshotVersion& version);
private:
void EncodeDocument(nanopb::Writer* writer,
const model::DocumentKey& key,
const model::ObjectValue& object_value) const;
std::unique_ptr<model::MaybeDocument> DecodeBatchGetDocumentsResponse(
nanopb::Reader* reader) const;
const firebase::firestore::model::DatabaseId& database_id_;
};
} // namespace remote
} // namespace firestore
} // namespace firebase
#endif // FIRESTORE_CORE_SRC_FIREBASE_FIRESTORE_REMOTE_SERIALIZER_H_
|
