job_repository.h

Go to the documentation of this file.

// BSD 3-Clause License
// Copyright (c) 2021-2025, 🍀☀🌕🌥 🌊
// See the LICENSE file in the project root for full license information.
 
#pragma once
 
#include "kcenon/pacs/client/job_types.h"
 
#include <kcenon/common/patterns/result.h>
 
#include <memory>
#include <optional>
#include <string>
#include <string_view>
#include <vector>
 
#ifdef PACS_WITH_DATABASE_SYSTEM
 
#include "kcenon/pacs/storage/base_repository.h"
 
namespace kcenon::pacs::storage {
 
struct job_query_options {
    std::optional<client::job_status> status;  
    std::optional<client::job_type> type;      
    std::optional<std::string> node_id;  
    std::optional<std::string> created_by;  
    size_t limit{100};                         
    size_t offset{0};                 
    bool order_by_priority{true};     
};
 
class job_repository
    : public base_repository<client::job_record, std::string> {
public:
    explicit job_repository(std::shared_ptr<pacs_database_adapter> db);
    ~job_repository() override = default;
 
    job_repository(const job_repository&) = delete;
    auto operator=(const job_repository&) -> job_repository& = delete;
    job_repository(job_repository&&) noexcept = default;
    auto operator=(job_repository&&) noexcept -> job_repository& = default;
 
    // =========================================================================
    // Domain-Specific Operations
    // =========================================================================
 
    [[nodiscard]] auto find_by_pk(int64_t pk) -> result_type;
 
    [[nodiscard]] auto find_jobs(const job_query_options& options = {})
        -> list_result_type;
 
    [[nodiscard]] auto find_by_status(client::job_status status,
                                      size_t limit = 100) -> list_result_type;
 
    [[nodiscard]] auto find_pending_jobs(size_t limit = 10) -> list_result_type;
 
    [[nodiscard]] auto find_by_node(std::string_view node_id)
        -> list_result_type;
 
    [[nodiscard]] auto cleanup_old_jobs(std::chrono::hours max_age)
        -> Result<size_t>;
 
    // =========================================================================
    // Status Updates
    // =========================================================================
 
    [[nodiscard]] auto update_status(std::string_view job_id,
                                     client::job_status status,
                                     std::string_view error_message = "",
                                     std::string_view error_details = "")
        -> VoidResult;
 
    [[nodiscard]] auto update_progress(std::string_view job_id,
                                       const client::job_progress& progress)
        -> VoidResult;
 
    [[nodiscard]] auto mark_started(std::string_view job_id) -> VoidResult;
 
    [[nodiscard]] auto mark_completed(std::string_view job_id) -> VoidResult;
 
    [[nodiscard]] auto mark_failed(std::string_view job_id,
                                   std::string_view error_message,
                                   std::string_view error_details = "")
        -> VoidResult;
 
    [[nodiscard]] auto increment_retry(std::string_view job_id) -> VoidResult;
 
    // =========================================================================
    // Statistics
    // =========================================================================
 
    [[nodiscard]] auto count_by_status(client::job_status status)
        -> Result<size_t>;
 
    [[nodiscard]] auto count_completed_today() -> Result<size_t>;
 
    [[nodiscard]] auto count_failed_today() -> Result<size_t>;
 
protected:
    // =========================================================================
    // base_repository overrides
    // =========================================================================
 
    [[nodiscard]] auto map_row_to_entity(const database_row& row) const
        -> client::job_record override;
 
    [[nodiscard]] auto entity_to_row(const client::job_record& entity) const
        -> std::map<std::string, database_value> override;
 
    [[nodiscard]] auto get_pk(const client::job_record& entity) const
        -> std::string override;
 
    [[nodiscard]] auto has_pk(const client::job_record& entity) const
        -> bool override;
 
    [[nodiscard]] auto select_columns() const
        -> std::vector<std::string> override;
 
private:
    [[nodiscard]] auto parse_timestamp(const std::string& str) const
        -> std::chrono::system_clock::time_point;
 
    [[nodiscard]] auto format_timestamp(
        std::chrono::system_clock::time_point tp) const -> std::string;
 
    [[nodiscard]] auto format_optional_timestamp(
        const std::optional<std::chrono::system_clock::time_point>& tp) const
        -> std::string;
 
    [[nodiscard]] static auto serialize_instance_uids(
        const std::vector<std::string>& uids) -> std::string;
 
    [[nodiscard]] static auto deserialize_instance_uids(std::string_view json)
        -> std::vector<std::string>;
 
    [[nodiscard]] static auto serialize_metadata(
        const std::unordered_map<std::string, std::string>& metadata)
        -> std::string;
 
    [[nodiscard]] static auto deserialize_metadata(std::string_view json)
        -> std::unordered_map<std::string, std::string>;
};
 
}  // namespace kcenon::pacs::storage
 
#else  // !PACS_WITH_DATABASE_SYSTEM
 
// Legacy interface for builds without database_system
struct sqlite3;
 
namespace kcenon::pacs::storage {
 
template <typename T>
using Result = kcenon::common::Result<T>;
 
using VoidResult = kcenon::common::VoidResult;
 
struct job_query_options {
    std::optional<client::job_status> status;  
    std::optional<client::job_type> type;      
    std::optional<std::string> node_id;  
    std::optional<std::string> created_by;  
    size_t limit{100};                         
    size_t offset{0};                 
    bool order_by_priority{true};     
};
 
class job_repository {
public:
    explicit job_repository(sqlite3* db);
    ~job_repository();
 
    job_repository(const job_repository&) = delete;
    auto operator=(const job_repository&) -> job_repository& = delete;
    job_repository(job_repository&&) noexcept;
    auto operator=(job_repository&&) noexcept -> job_repository&;
 
    [[nodiscard]] auto save(const client::job_record& job) -> VoidResult;
    [[nodiscard]] auto find_by_id(std::string_view job_id) const
        -> std::optional<client::job_record>;
    [[nodiscard]] auto find_by_pk(int64_t pk) const
        -> std::optional<client::job_record>;
    [[nodiscard]] auto find_jobs(const job_query_options& options = {}) const
        -> std::vector<client::job_record>;
    [[nodiscard]] auto find_by_status(client::job_status status,
                                      size_t limit = 100) const
        -> std::vector<client::job_record>;
    [[nodiscard]] auto find_pending_jobs(size_t limit = 10) const
        -> std::vector<client::job_record>;
    [[nodiscard]] auto find_by_node(std::string_view node_id) const
        -> std::vector<client::job_record>;
    [[nodiscard]] auto remove(std::string_view job_id) -> VoidResult;
    [[nodiscard]] auto cleanup_old_jobs(std::chrono::hours max_age)
        -> Result<size_t>;
    [[nodiscard]] auto exists(std::string_view job_id) const -> bool;
 
    [[nodiscard]] auto update_status(std::string_view job_id,
                                     client::job_status status,
                                     std::string_view error_message = "",
                                     std::string_view error_details = "")
        -> VoidResult;
    [[nodiscard]] auto update_progress(std::string_view job_id,
                                       const client::job_progress& progress)
        -> VoidResult;
    [[nodiscard]] auto mark_started(std::string_view job_id) -> VoidResult;
    [[nodiscard]] auto mark_completed(std::string_view job_id) -> VoidResult;
    [[nodiscard]] auto mark_failed(std::string_view job_id,
                                   std::string_view error_message,
                                   std::string_view error_details = "")
        -> VoidResult;
    [[nodiscard]] auto increment_retry(std::string_view job_id) -> VoidResult;
 
    [[nodiscard]] auto count() const -> size_t;
    [[nodiscard]] auto count_by_status(client::job_status status) const
        -> size_t;
    [[nodiscard]] auto count_completed_today() const -> size_t;
    [[nodiscard]] auto count_failed_today() const -> size_t;
 
    [[nodiscard]] auto is_valid() const noexcept -> bool;
 
private:
    [[nodiscard]] auto parse_row(void* stmt) const -> client::job_record;
 
    [[nodiscard]] static auto serialize_instance_uids(
        const std::vector<std::string>& uids) -> std::string;
 
    [[nodiscard]] static auto deserialize_instance_uids(std::string_view json)
        -> std::vector<std::string>;
 
    [[nodiscard]] static auto serialize_metadata(
        const std::unordered_map<std::string, std::string>& metadata)
        -> std::string;
 
    [[nodiscard]] static auto deserialize_metadata(std::string_view json)
        -> std::unordered_map<std::string, std::string>;
 
    sqlite3* db_{nullptr};
};
 
}  // namespace kcenon::pacs::storage
 
#endif  // PACS_WITH_DATABASE_SYSTEM