job_types.hpp

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2026 Povl Filip Sonne-Frederiksen
//
// SPDX-License-Identifier: GPL-3.0-or-later
 
#pragma once
 
// The vocabulary shared by every job runner: a job's record, its status, the
// events it raises, and the writer lease that makes a running stage exclusive
// with other writers of the same project. Split out of JobRunner.hpp so the
// JobScheduler and the job stores can use it without the runner.
 
#include "reusex/core/stages.hpp"
#include "reusex/pipeline/stages.hpp"
 
#include <cstddef>
#include <cstdint>
#include <functional>
#include <mutex>
#include <optional>
#include <string>
#include <string_view>
#include <vector>
 
namespace reusex::pipeline {

enum class JobStatus {
  queued,
  running,
  succeeded,
  failed,
  cancelled,
};

std::string_view to_string(JobStatus status);

std::optional<JobStatus> parse_job_status(std::string_view name);

bool is_terminal(JobStatus status);

std::string iso8601_utc_now();

struct JobRecord {
  std::string id; 
  JobStage stage = JobStage::clouds;
  JobStatus status = JobStatus::queued;
  std::string parameters;   
  std::string error;        
  std::string submitted_at; 
  std::string started_at;   
  std::string finished_at;  
  std::string submitted_by;
  bool cancel_requested = false;

  core::Stage progress_stage = core::Stage::idle;
  size_t progress_current = 0;
  size_t progress_total = 0; 

  std::string result_summary;
  std::vector<StageArtifact> result_outputs;
};

struct JobEvent {
  uint64_t sequence = 0;
 
  enum class Type {
    submitted, 
    started,   
    progress,  
    finished,  
  };
 
  Type type = Type::submitted;
  std::string timestamp; 
  JobRecord job;
};

std::string_view to_string(JobEvent::Type type);

using JobListener = std::function<void(const JobEvent &)>;

using WriterLease = std::unique_lock<std::timed_mutex>;
 
} // namespace reusex::pipeline