summaryrefslogtreecommitdiff
path: root/src/buildtool/serve_api/remote/configuration_client.cpp
blob: fdc9952be597ac0f8aa4e02ed36bb609fb9f405d (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
// Copyright 2023 Huawei Cloud Computing Technology Co., Ltd.
//
// 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 BOOTSTRAP_BUILD_TOOL

#include "src/buildtool/serve_api/remote/configuration_client.hpp"

#include <exception>
#include <optional>

#include "nlohmann/json.hpp"
#include "src/buildtool/common/remote/client_common.hpp"
#include "src/buildtool/logging/log_level.hpp"

ConfigurationClient::ConfigurationClient(
    ServerAddress address,
    gsl::not_null<RemoteContext const*> const& remote_context) noexcept
    : client_serve_address_{std::move(address)},
      remote_config_{*remote_context->exec_config} {
    stub_ = justbuild::just_serve::Configuration::NewStub(
        CreateChannelWithCredentials(client_serve_address_.host,
                                     client_serve_address_.port,
                                     remote_context->auth));
}

auto ConfigurationClient::CheckServeRemoteExecution() const noexcept -> bool {
    auto const client_remote_address = remote_config_.remote_address;
    if (!client_remote_address) {
        logger_.Emit(LogLevel::Error,
                     "Internal error: the remote execution endpoint should "
                     "have been set.");
        return false;
    }

    grpc::ClientContext context;
    justbuild::just_serve::RemoteExecutionEndpointRequest request{};
    justbuild::just_serve::RemoteExecutionEndpointResponse response{};
    grpc::Status status =
        stub_->RemoteExecutionEndpoint(&context, request, &response);

    if (not status.ok()) {
        LogStatus(&logger_, LogLevel::Error, status);
        return false;
    }

    try {
        auto client_msg = client_remote_address->ToJson().dump();
        std::string serve_msg{};

        if (response.address().empty()) {
            // just serve acts as just execute, so from the server's perspective
            // there is nothing to be checked and it's the client's job to
            // ensure that its remote execution and serve endpoints match
            //
            // NOTE: This check might make sense to be removed altogether in the
            // future, or updated to (at most) a warning.
            if (client_remote_address->ToJson() ==
                client_serve_address_.ToJson()) {
                return true;
            }
            serve_msg = client_serve_address_.ToJson().dump();
        }
        else {
            nlohmann::json serve_remote_endpoint{};
            try {
                serve_remote_endpoint =
                    nlohmann::json::parse(response.address());
            } catch (std::exception const& ex) {
                logger_.Emit(
                    LogLevel::Error,
                    "Parsing configured address from response failed with:\n{}",
                    ex.what());
            }
            if (serve_remote_endpoint == client_remote_address->ToJson()) {
                return true;
            }
            serve_msg = serve_remote_endpoint.dump();
        }
        // log any mismatch found
        logger_.Emit(
            LogLevel::Error,
            "Different execution endpoint detected!\nIn order to correctly use "
            "the serve service, its remote execution endpoint must be the same "
            "used by the client.\nserve remote endpoint:  {}\nclient remote "
            "endpoint: {}",
            serve_msg,
            client_msg);

    } catch (std::exception const& ex) {
        logger_.Emit(
            LogLevel::Error,
            "parsing response for remote endpoint request failed with:\n{}",
            ex.what());
    }
    return false;
}

auto ConfigurationClient::IsCompatible() const noexcept -> std::optional<bool> {
    grpc::ClientContext context;
    justbuild::just_serve::CompatibilityRequest request{};
    justbuild::just_serve::CompatibilityResponse response{};
    grpc::Status status = stub_->Compatibility(&context, request, &response);

    if (not status.ok()) {
        LogStatus(&logger_, LogLevel::Error, status);
        return std::nullopt;
    }
    return response.compatible();
}

#endif  // BOOTSTRAP_BUILD_TOOL