control_timeline_document_session_executor.hpp

Go to the documentation of this file.

#pragma once
 
#include <pulp/inspect/control_execution.hpp>
 
#include <pulp/timeline/transaction.hpp>
 
#include <cstdint>
#include <functional>
#include <optional>
#include <string>
#include <string_view>
 
namespace pulp::inspect {

enum class ControlTimelineDocumentSessionAction : std::uint8_t {
    Open,
    Apply,
    Diff,
    Undo,
    Redo,
};

std::string_view
control_timeline_document_session_action_name(ControlTimelineDocumentSessionAction action) noexcept;

std::optional<ControlTimelineDocumentSessionAction>
control_timeline_document_session_action_by_name(std::string_view name) noexcept;

struct ControlTimelineDocumentSessionRequest {
    ControlTimelineDocumentSessionAction action = ControlTimelineDocumentSessionAction::Diff;
    std::string project;
    std::string session_id;
    std::string commands_json;
    std::string writer_profile;
    std::string idempotency_key;
    std::optional<std::uint64_t> expected_revision;
};

struct ControlTimelineDocumentSessionOutcome {
    bool accepted = false;
    std::string session_id;
    std::uint64_t revision = 0;
    bool applied = false;
    bool replayed = false;
    std::string diff_json;
    std::optional<pulp::timeline::ConflictCode> conflict;
    std::string refusal_json;
    std::string explanation;
};

struct ControlTimelineDocumentSessionSource {
    ControlRegistrationId registration_id;
    std::string instance_id;
    std::string publication_id;
    std::function<ControlTimelineDocumentSessionOutcome(
        const ControlTimelineDocumentSessionRequest&)>
        invoke;
};
 
using ControlTimelineDocumentSessionSourceResolver =
    std::function<std::optional<ControlTimelineDocumentSessionSource>(const ControlAdmissionPlan&)>;

ControlResultCode
control_timeline_conflict_result_code(pulp::timeline::ConflictCode conflict) noexcept;

ControlRetryClassification
control_timeline_conflict_retry(pulp::timeline::ConflictCode conflict) noexcept;

std::optional<std::string>
control_timeline_admissible_writer_profile(std::string_view requested) noexcept;

ControlOperationExecutor make_control_timeline_document_session_executor(
    ControlTimelineDocumentSessionSourceResolver resolve_source);
 
} // namespace pulp::inspect