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
192
193
194
195
196
197
198
|
/**
* Copyright (C) 2023-present MongoDB, Inc.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the Server Side Public License, version 1,
* as published by MongoDB, Inc.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* Server Side Public License for more details.
*
* You should have received a copy of the Server Side Public License
* along with this program. If not, see
* <http://www.mongodb.com/licensing/server-side-public-license>.
*
* As a special exception, the copyright holders give permission to link the
* code of portions of this program with the OpenSSL library under certain
* conditions as described in each individual source file and distribute
* linked combinations including the program with the OpenSSL library. You
* must comply with the Server Side Public License in all respects for
* all of the code used other than as permitted herein. If you modify file(s)
* with this exception, you may extend this exception to your version of the
* file(s), but you are not obligated to do so. If you do not wish to do so,
* delete this exception statement from your version. If you delete this
* exception statement from all source files in the program, then also delete
* it in the license file.
*/
#pragma once
#include <boost/optional.hpp>
#include "mongo/util/static_immortal.h"
#include "mongo/util/str.h"
namespace mongo {
/**
* SerializationContext is a run-time routing mechansim that effectively stores context state
* consumed by NamespaceStringUtil and DatabaseNameUtil serializer and deserializer wrapper
* functions in order to modify serialization/deserialization behavior based on caller context. This
* is mainly used by the IDL generator, and allows us to pass this context through the nested types
* to ensure it is available to the NamespacedStringUtil and DatabaseNameUtil serializers and
* deserializers at any nested level. However, it can also be used wherever code paths converge
* such that hardcoding the specific serializer or deserializer doesn't make sense.
*
* The mechanism by which the IDL generated code passes these flags to its nested structs depends on
* how the object is being constructed. If parse() is called, the SerializationContext are stored
* on the IDLParserContext to propagate to all nested structs, while direct construction requires
* the SerializationContext to be passed in as constructor params.
*
*/
struct SerializationContext {
/*
* Source is used by the caller to set the caller context, and specifies to the serializer or
* deserializer in what context it is being called. The NamespaceStringUtil and
* DatabaseNameUtil serializers and deserializers can be called from anywhere in the code, so
* we need to pass this flag in if the serialzation or deserialization behavior depends on
* where it is being called. Use default if serialization and deserialization should only
* depened on the state of the feature flags.
*/
enum class Source { Default, Command, Storage };
/**
* The CallerType enum is currently only applicable to source = Command, and is used in
* combination with this source; it will otherwise be ignored. This is used to provide the
* serializers and deserializers with additional context specific to commands and allows us to
* for example handle serialization for a request differently than serialization for a reply.
*/
enum class CallerType { None, Request, Reply };
/**
* Prefix is used to track whether or not upstream is sending us and thus expecting a prefixed
* tenant ID in the reply. This field in the request can either be true, false, or not present,
* the latter represented by the default state.
*/
enum class Prefix { Default, IncludePrefix, ExcludePrefix };
SerializationContext(Source source = Source::Default,
CallerType callerType = CallerType::None,
Prefix prefixState = Prefix::Default,
bool nonPrefixedTenantId = false)
: _source(source),
_callerType(callerType),
_prefixState(prefixState),
_nonPrefixedTenantId(nonPrefixedTenantId) {}
/**
* Gets a copy of a commonly used immutable value for use in constructing a mutable
* SerializationContext object
*/
static const SerializationContext& stateCommandReply() {
static StaticImmortal<SerializationContext> stateCommandReply{Source::Command,
CallerType::Reply};
return *stateCommandReply;
}
static SerializationContext stateCommandReply(const SerializationContext& requestCtxt) {
return SerializationContext(Source::Command,
CallerType::Reply,
requestCtxt._prefixState,
requestCtxt._nonPrefixedTenantId);
}
static const SerializationContext& stateCommandRequest() {
static StaticImmortal<SerializationContext> stateCommandRequest{Source::Command,
CallerType::Request};
return *stateCommandRequest;
}
static const SerializationContext& stateStorageRequest() {
static StaticImmortal<SerializationContext> stateStorageRequest{Source::Storage,
CallerType::Request};
return *stateStorageRequest;
}
static const SerializationContext& stateDefault() {
static StaticImmortal<SerializationContext> stateDefault{};
return *stateDefault;
}
/**
* Setters for flags that may not be known during construction time, used by producers
*/
void setTenantIdSource(bool nonPrefixedTenantId) {
_nonPrefixedTenantId = nonPrefixedTenantId;
}
void setPrefixState(bool prefixState) {
_prefixState = prefixState ? Prefix::IncludePrefix : Prefix::ExcludePrefix;
}
/**
* Getters for the flags, used by the consumers
*/
const Source& getSource() const {
return _source;
}
const Prefix& getPrefix() const {
return _prefixState;
}
const CallerType& getCallerType() const {
return _callerType;
}
bool receivedNonPrefixedTenantId() const {
return _nonPrefixedTenantId;
}
std::string toString() const {
auto stream = str::stream();
stream << "Source: "
<< (_source == Source::Command
? "Command"
: (_source == Source::Storage ? "Storage" : "Default"));
stream << ", CallerType: "
<< (_callerType == CallerType::Request
? "Request"
: (_callerType == CallerType::Reply ? "Reply" : "None"));
stream << ", PrefixState: "
<< (_prefixState == Prefix::IncludePrefix
? "Include"
: (_prefixState == Prefix::ExcludePrefix ? "Exclude" : "Missing"));
stream << ", non-prefixed tid: " << (_nonPrefixedTenantId ? "true" : "false");
return stream;
}
friend bool operator==(const SerializationContext& lhs, const SerializationContext& rhs) {
return (lhs._prefixState == rhs._prefixState) && (lhs._callerType == rhs._callerType) &&
(lhs._source == rhs._source);
}
friend bool operator!=(const SerializationContext& lhs, const SerializationContext& rhs) {
return !(lhs == rhs);
}
private:
Source _source;
CallerType _callerType;
Prefix _prefixState;
/**
* This flag is set/produced at command parsing before the deserializer is called, and
* consumed by the serializer. It indicates whether the tenantId was sourced from the
* $tenant field or security token (ie. true), or if it was sourced from parsing the db
* string prefix (ie. false). This is important as the serializer uses this flag to
* determine whether the reponse should contain a prefixed tenantId when serializing for
* commands.
*/
bool _nonPrefixedTenantId;
};
inline std::ostream& operator<<(std::ostream& os, const SerializationContext& sc) {
return os << sc.toString();
}
} // namespace mongo
|
