publish_bundle_protocol.hpp

/* -*- mode: c++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
 *
 * Copyright (C) 2026 Marco Craveiro <marco.craveiro@gmail.com>
 *
 * This program is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License as published by the Free Software
 * Foundation; either version 3 of the License, or (at your option) any later
 * version.
 *
 * 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 General Public License for more
 * details.
 *
 * You should have received a copy of the GNU General Public License along with
 * this program; if not, write to the Free Software Foundation, Inc., 51
 * Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 */
#ifndef ORES_DQ_MESSAGING_PUBLISH_BUNDLE_PROTOCOL_HPP
#define ORES_DQ_MESSAGING_PUBLISH_BUNDLE_PROTOCOL_HPP
 
#include <span>
#include <iosfwd>
#include <vector>
#include <expected>
#include "ores.comms/messaging/message_types.hpp"
#include "ores.comms/messaging/message_traits.hpp"
#include "ores.dq/domain/publication_mode.hpp"
 
namespace ores::dq::messaging {
 
struct bundle_dataset_result final {
    std::string dataset_code;
    std::string dataset_name;
    std::string status;  // "success", "failed", "skipped"
    std::uint64_t records_inserted = 0;
    std::uint64_t records_updated = 0;
    std::uint64_t records_skipped = 0;
    std::uint64_t records_deleted = 0;
    std::string error_message;
 
    std::vector<std::byte> serialize() const;
    static std::expected<bundle_dataset_result, ores::utility::serialization::error_code>
    deserialize(std::span<const std::byte>& data);
};
 
std::ostream& operator<<(std::ostream& s, const bundle_dataset_result& v);
 
struct publish_bundle_request final {
    std::string bundle_code;
 
    domain::publication_mode mode = domain::publication_mode::upsert;
 
    std::string published_by;
 
    bool atomic = true;
 
    std::vector<std::byte> serialize() const;
 
    static std::expected<publish_bundle_request,
                         ores::utility::serialization::error_code>
    deserialize(std::span<const std::byte> data);
};
 
std::ostream& operator<<(std::ostream& s, const publish_bundle_request& v);
 
struct publish_bundle_response final {
    bool success = false;
 
    std::string error_message;
 
    std::uint32_t datasets_processed = 0;
 
    std::uint32_t datasets_succeeded = 0;
 
    std::uint32_t datasets_failed = 0;
 
    std::uint32_t datasets_skipped = 0;
 
    std::uint64_t total_records_inserted = 0;
 
    std::uint64_t total_records_updated = 0;
 
    std::uint64_t total_records_skipped = 0;
 
    std::uint64_t total_records_deleted = 0;
 
    std::vector<bundle_dataset_result> dataset_results;
 
    std::vector<std::byte> serialize() const;
 
    static std::expected<publish_bundle_response,
                         ores::utility::serialization::error_code>
    deserialize(std::span<const std::byte> data);
};
 
std::ostream& operator<<(std::ostream& s, const publish_bundle_response& v);
 
}
 
namespace ores::comms::messaging {
 
template<>
struct message_traits<dq::messaging::publish_bundle_request> {
    using request_type = dq::messaging::publish_bundle_request;
    using response_type = dq::messaging::publish_bundle_response;
    static constexpr message_type request_message_type =
        message_type::publish_bundle_request;
};
 
}
 
#endif