publication_protocol.hpp

/* -*- mode: c++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
 *
 * Copyright (C) 2025 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_PUBLICATION_PROTOCOL_HPP
#define ORES_DQ_MESSAGING_PUBLICATION_PROTOCOL_HPP
 
#include <span>
#include <iosfwd>
#include <vector>
#include <expected>
#include <boost/uuid/uuid.hpp>
#include "ores.comms/messaging/message_types.hpp"
#include "ores.comms/messaging/message_traits.hpp"
#include "ores.dq/domain/dataset.hpp"
#include "ores.dq/domain/publication.hpp"
#include "ores.dq/domain/publication_mode.hpp"
#include "ores.dq/domain/publication_result.hpp"
 
namespace ores::dq::messaging {
 
// ============================================================================
// Publication Messages
// ============================================================================
 
struct publish_datasets_request final {
    std::vector<boost::uuids::uuid> dataset_ids;
 
    domain::publication_mode mode = domain::publication_mode::upsert;
 
    std::string published_by;
 
    bool resolve_dependencies = true;
 
    bool atomic = true;
 
    std::vector<std::byte> serialize() const;
 
    static std::expected<publish_datasets_request,
                         ores::utility::serialization::error_code>
    deserialize(std::span<const std::byte> data);
};
 
std::ostream& operator<<(std::ostream& s, const publish_datasets_request& v);
 
struct publish_datasets_response final {
    std::vector<domain::publication_result> results;
 
    std::vector<std::byte> serialize() const;
 
    static std::expected<publish_datasets_response,
                         ores::utility::serialization::error_code>
    deserialize(std::span<const std::byte> data);
};
 
std::ostream& operator<<(std::ostream& s, const publish_datasets_response& v);
 
// ============================================================================
// Publication History Messages
// ============================================================================
 
struct get_publications_request final {
    boost::uuids::uuid dataset_id;
 
    std::uint32_t limit = 100;
 
    std::vector<std::byte> serialize() const;
 
    static std::expected<get_publications_request,
                         ores::utility::serialization::error_code>
    deserialize(std::span<const std::byte> data);
};
 
std::ostream& operator<<(std::ostream& s, const get_publications_request& v);
 
struct get_publications_response final {
    std::vector<domain::publication> publications;
 
    std::vector<std::byte> serialize() const;
 
    static std::expected<get_publications_response,
                         ores::utility::serialization::error_code>
    deserialize(std::span<const std::byte> data);
};
 
std::ostream& operator<<(std::ostream& s, const get_publications_response& v);
 
// ============================================================================
// Dependency Resolution Messages
// ============================================================================
 
struct resolve_dependencies_request final {
    std::vector<boost::uuids::uuid> dataset_ids;
 
    std::vector<std::byte> serialize() const;
 
    static std::expected<resolve_dependencies_request,
                         ores::utility::serialization::error_code>
    deserialize(std::span<const std::byte> data);
};
 
std::ostream& operator<<(std::ostream& s, const resolve_dependencies_request& v);
 
struct resolve_dependencies_response final {
    std::vector<domain::dataset> datasets;
 
    std::vector<boost::uuids::uuid> requested_ids;
 
    std::vector<std::byte> serialize() const;
 
    static std::expected<resolve_dependencies_response,
                         ores::utility::serialization::error_code>
    deserialize(std::span<const std::byte> data);
};
 
std::ostream& operator<<(std::ostream& s, const resolve_dependencies_response& v);
 
}
 
namespace ores::comms::messaging {
 
template<>
struct message_traits<dq::messaging::publish_datasets_request> {
    using request_type = dq::messaging::publish_datasets_request;
    using response_type = dq::messaging::publish_datasets_response;
    static constexpr message_type request_message_type =
        message_type::publish_datasets_request;
};
 
template<>
struct message_traits<dq::messaging::get_publications_request> {
    using request_type = dq::messaging::get_publications_request;
    using response_type = dq::messaging::get_publications_response;
    static constexpr message_type request_message_type =
        message_type::get_publications_request;
};
 
template<>
struct message_traits<dq::messaging::resolve_dependencies_request> {
    using request_type = dq::messaging::resolve_dependencies_request;
    using response_type = dq::messaging::resolve_dependencies_response;
    static constexpr message_type request_message_type =
        message_type::resolve_dependencies_request;
};
 
}
 
#endif