redis_chunk_store.h

Go to the documentation of this file.

/*
 * Copyright 2026 The A11 Authors
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
 
#ifndef A11_STORES_REDIS_CHUNK_STORE_H_
#define A11_STORES_REDIS_CHUNK_STORE_H_
 
#include <cstddef>
#include <cstdint>
#include <memory>
#include <optional>
#include <string>
#include <vector>
 
#include <absl/status/status.h>
#include <absl/status/statusor.h>
#include <absl/time/time.h>
 
#include "a11/concurrency/future.h"
#include "a11/data/types.h"
#include "a11/stores/chunk_store.h"
#include "redis/client.h"
 
namespace a11::stores {
 
struct RedisChunkStoreOptions {
  std::string key_prefix = "a11:";
 
  size_t inline_data_threshold = 256 * 1024;
 
  absl::Status Validate() const;
  static absl::StatusOr<RedisChunkStoreOptions> FromEnvironment();
 
  friend bool operator==(const RedisChunkStoreOptions&,
                         const RedisChunkStoreOptions&) = default;
};
 
struct RedisChunkStoreKeys {
  std::string metadata;        
  std::string stream;          
  std::string sequence_index;  
  std::string arrival_index;   
  std::string blobs;           
  std::string events;  
 
  [[nodiscard]] std::vector<std::string> ScriptKeys() const;
 
  friend bool operator==(const RedisChunkStoreKeys&,
                         const RedisChunkStoreKeys&) = default;
};
 
struct RedisChunkStoreMetadata {
  std::string id;                      
  bool closed = false;                 
  std::optional<absl::Status> status;  
  std::optional<std::uint32_t>
      final_seq;    
  size_t size = 0;  
  std::uint64_t total_chunks_put = 0;    
  std::uint64_t next_cursor = 0;         
  std::optional<std::uint32_t> max_seq;  
  std::uint64_t revision = 0;            
};
 
class RedisChunkStore final : public ChunkStore {
 private:
  struct ConstructorToken {};
 
 public:
  static absl::StatusOr<std::shared_ptr<RedisChunkStore>> Create(
      std::string node_id, std::shared_ptr<redis::Client> client,
      RedisChunkStoreOptions options);
 
  static absl::StatusOr<std::shared_ptr<RedisChunkStore>> Create(
      std::string node_id, std::shared_ptr<redis::Client> client);
 
  static absl::StatusOr<std::shared_ptr<RedisChunkStore>> Create(
      std::string node_id);
 
  ~RedisChunkStore() override = default;
 
  using ChunkStore::CloseWritesWithStatus;
  using ChunkStore::Get;
  using ChunkStore::GetByArrivalOrder;
  using ChunkStore::Next;
 
  a11::Future<data::NodeFragment> Get(std::uint32_t seq,
                                      absl::Time deadline) override;
  a11::Future<data::NodeFragment> GetByArrivalOrder(
      std::uint64_t arrival_order, absl::Time deadline) override;
  a11::Future<std::vector<std::optional<data::NodeFragment>>> Next(
      absl::Time deadline, size_t limit) override;
  a11::Future<std::uint32_t> Put(data::NodeFragment fragment) override;
  a11::Future<std::vector<std::uint32_t>> PutMany(
      std::vector<data::NodeFragment> fragments) override;
  a11::Future<data::NodeFragment> ClearData(std::uint32_t seq) override;
  a11::Future<std::uint32_t> GetSeqForArrivalOrder(
      std::uint64_t arrival_order) override;
  a11::Future<std::optional<std::uint32_t>> GetFinalSeq() override;
  a11::Future<absl::Status> CloseWritesWithStatus(
      absl::Status status, bool return_status_if_already_closed) override;
  a11::Future<size_t> Size() override;
  absl::StatusOr<std::string> GetId() const override;
 
  a11::Task Initialize();
 
  a11::Future<RedisChunkStoreMetadata> GetMetadata();
 
  [[nodiscard]] std::shared_ptr<redis::Client> client() const {
    return client_;
  }
 
  [[nodiscard]] const RedisChunkStoreOptions& options() const {
    return options_;
  }
 
  [[nodiscard]] const RedisChunkStoreKeys& keys() const { return keys_; }
 
  RedisChunkStore(ConstructorToken, std::string node_id,
                  std::shared_ptr<redis::Client> client,
                  RedisChunkStoreOptions options, RedisChunkStoreKeys keys)
      : node_id_(std::move(node_id)),
        client_(std::move(client)),
        options_(std::move(options)),
        keys_(std::move(keys)) {}
 
 private:
  enum class ReadKind { kSequence, kArrivalOrder };
 
  a11::Future<data::NodeFragment> Read(ReadKind kind, std::uint64_t value,
                                       absl::Time deadline);
 
  const std::string node_id_;
  const std::shared_ptr<redis::Client> client_;
  const RedisChunkStoreOptions options_;
  const RedisChunkStoreKeys keys_;
};
 
}  // namespace a11::stores
 
#endif  // A11_STORES_REDIS_CHUNK_STORE_H_