summaryrefslogtreecommitdiff
path: root/src/mongo/rpc/metadata/sharding_metadata.cpp
blob: e33a4e075bda73d2668a7a6c100fc58a55c5cc01 (plain)
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
/**
 *    Copyright (C) 2015 MongoDB Inc.
 *
 *    This program is free software: you can redistribute it and/or  modify
 *    it under the terms of the GNU Affero General Public License, version 3,
 *    as published by the Free Software Foundation.
 *
 *    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
 *    GNU Affero General Public License for more details.
 *
 *    You should have received a copy of the GNU Affero General Public License
 *    along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 *    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 GNU Affero General 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.
 */

#include "mongo/platform/basic.h"

#include "mongo/rpc/metadata/sharding_metadata.h"

#include <utility>

#include "mongo/bson/util/bson_extract.h"
#include "mongo/db/jsobj.h"
#include "mongo/util/mongoutils/str.h"

namespace mongo {
namespace rpc {

namespace {

    const char kGLEStatsFieldName[] = "$gleStats";
    const char kGLEStatsLastOpTimeFieldName[] = "lastOpTime";
    const char kGLEStatsElectionIdFieldName[] = "electionId";

}  // namespace

    StatusWith<ShardingMetadata> ShardingMetadata::readFromMetadata(const BSONObj& metadataObj) {
        BSONElement smElem;
        auto smExtractStatus = bsonExtractTypedField(metadataObj,
                                                     kGLEStatsFieldName,
                                                     mongo::Object,
                                                     &smElem);
        if (!smExtractStatus.isOK()) {
            return smExtractStatus;
        }

        if (smElem.embeddedObject().nFields() != 2) {
            return Status(ErrorCodes::InvalidOptions,
                          str::stream() << "The $gleStats object can only have 2 fields, but got "
                                        << smElem.embeddedObject().toString());
        }

        BSONElement lastOpTimeElem;
        auto lastOpTimeExtractStatus = bsonExtractTypedField(smElem.embeddedObject(),
                                                             kGLEStatsLastOpTimeFieldName,
                                                             mongo::bsonTimestamp,
                                                             &lastOpTimeElem);
        if (!lastOpTimeExtractStatus.isOK()) {
            return lastOpTimeExtractStatus;
        }

        BSONElement lastElectionIdElem;
        auto lastElectionIdExtractStatus = bsonExtractTypedField(smElem.embeddedObject(),
                                                                 kGLEStatsElectionIdFieldName,
                                                                 mongo::jstOID,
                                                                 &lastElectionIdElem);
        if (!lastElectionIdExtractStatus.isOK()) {
            return lastElectionIdExtractStatus;
        }

        return ShardingMetadata(lastOpTimeElem.timestamp(), lastElectionIdElem.OID());
    }

    Status ShardingMetadata::writeToMetadata(BSONObjBuilder* metadataBob) const {
        BSONObjBuilder subobj(metadataBob->subobjStart(kGLEStatsFieldName));
        subobj.append(kGLEStatsLastOpTimeFieldName, getLastOpTime());
        subobj.append(kGLEStatsElectionIdFieldName, getLastElectionId());
        return Status::OK();
    }

    Status ShardingMetadata::downconvert(const BSONObj& commandReply,
                                         const BSONObj& replyMetadata,
                                         BSONObjBuilder* legacyCommandReplyBob) {

        legacyCommandReplyBob->appendElements(commandReply);

        auto swShardingMetadata = readFromMetadata(replyMetadata);
        if (swShardingMetadata.isOK()) {
            // We can reuse the same logic to write the sharding metadata out to the legacy
            // command as the element has the same format whether it is there or on the metadata
            // object.
            swShardingMetadata.getValue().writeToMetadata(legacyCommandReplyBob);
        }
        else if (swShardingMetadata.getStatus() == ErrorCodes::NoSuchKey) {
            // It is valid to not have a $gleStats field.
        }
        else {
            return swShardingMetadata.getStatus();
        }
        return Status::OK();
    }

    Status ShardingMetadata::upconvert(const BSONObj& legacyCommand,
                                       BSONObjBuilder* commandBob,
                                       BSONObjBuilder* metadataBob) {
        // We can reuse the same logic to read the sharding metadata out from the legacy command
        // as it has the same format whether it is there or on the metadata object.
        auto swShardingMetadata = readFromMetadata(legacyCommand);
        if (swShardingMetadata.isOK()) {
            swShardingMetadata.getValue().writeToMetadata(metadataBob);

            // Write out the command excluding the $gleStats subobject.
            for (const auto& elem : legacyCommand) {
                if (elem.fieldNameStringData() != StringData(kGLEStatsFieldName)) {
                    commandBob->append(elem);
                }
            }
        } else if (swShardingMetadata.getStatus() == ErrorCodes::NoSuchKey) {
            // it is valid to not have a $gleStats field
            commandBob->appendElements(legacyCommand);
        }
        else {
            return swShardingMetadata.getStatus();
        }
        return Status::OK();
    }

    ShardingMetadata::ShardingMetadata(Timestamp lastOpTime, OID lastElectionId)
        : _lastOpTime(std::move(lastOpTime))
        , _lastElectionId(std::move(lastElectionId))
    {}

    const Timestamp& ShardingMetadata::getLastOpTime() const {
        return _lastOpTime;
    }

    const OID& ShardingMetadata::getLastElectionId() const {
        return _lastElectionId;
    }

}  // namespace rpc
}  // namespace mongo