JobStore.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
 
// Where job records live (spec 2026-10-08, phase S2).
//
// The JobScheduler keeps the *live* state of a job — its place in the queue,
// its cancel token, its progress counters — in memory, because none of that
// means anything once the process is gone. What it hands to an IJobStore is
// the job's *record* at each state transition (submitted, started, finished),
// so a store backed by a database sees a handful of writes per job, never a
// stream of progress ticks.
//
// `ruxd --local` uses InMemoryJobStore. The multi-user server (phase S3)
// backs the same interface with its Postgres `jobs` table.
//
// Records are grouped by *queue*: one queue per project (a ruxd case). Job
// ids are GUIDs, unique across queues, but every lookup names the queue too,
// so one case can never read another case's job by guessing its id.
 
#include "reusex/pipeline/job_types.hpp"
 
#include <cstddef>
#include <memory>
#include <optional>
#include <string>
#include <string_view>
#include <vector>
 
namespace reusex::pipeline {

class IJobStore {
    public:
  virtual ~IJobStore() = default;

  virtual void save(std::string_view queue, const JobRecord &record) = 0;

  virtual std::optional<JobRecord> find(std::string_view queue,
                                        std::string_view id) const = 0;

  virtual std::vector<JobRecord> list(std::string_view queue) const = 0;

  virtual void forget(std::string_view queue) = 0;
};

class InMemoryJobStore final : public IJobStore {
    public:
  explicit InMemoryJobStore(std::size_t max_terminal_jobs = 256);
  ~InMemoryJobStore() override;
 
  void save(std::string_view queue, const JobRecord &record) override;
  std::optional<JobRecord> find(std::string_view queue,
                                std::string_view id) const override;
  std::vector<JobRecord> list(std::string_view queue) const override;
  void forget(std::string_view queue) override;
 
    private:
  class Impl;
  std::unique_ptr<Impl> impl_;
};
 
} // namespace reusex::pipeline