summaryrefslogtreecommitdiff
path: root/src/mongo/scripting/jsexception.h
blob: 0b7cdb6cb23bf8118a5b4d8db371192264c39671 (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
/**
 *    Copyright (C) 2018-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 <string>

#include "mongo/base/error_codes.h"
#include "mongo/base/error_extra_info.h"
#include "mongo/base/status.h"

namespace mongo {

/**
 * Represents information about a JavaScript exception. The "message" is stored as the Status's
 * reason(), so only the "stack" is stored here.
 *
 * This class wraps an existing error and serializes it in a lossless way, so any other metadata
 * about the JavaScript exception is also preserved.
 */
class JSExceptionInfo final : public ErrorExtraInfo {
public:
    static constexpr auto code = ErrorCodes::JSInterpreterFailureWithStack;

    void serialize(BSONObjBuilder*) const override;
    static std::shared_ptr<const ErrorExtraInfo> parse(const BSONObj&);

    explicit JSExceptionInfo(std::string stack_, Status originalError_)
        : stack(std::move(stack_)), originalError(std::move(originalError_)) {
        invariant(!stack.empty());
        invariant(!originalError.isOK());
    }

    const std::string stack;
    const Status originalError;
};

}  // namespace mongo