state

Documentation

Overview

Package state provides functionality for storing and retrieving runner state across different environments (local filesystem, Kubernetes, etc.)

Index

• Constants
• func DeleteSavedRunConfig(ctx context.Context, name string) error
• func LoadRunConfig[T any](ctx context.Context, name string, readJSONFunc ReadJSONFunc[T]) (T, error)
• func LoadRunConfigJSON(ctx context.Context, name string) (io.ReadCloser, error)
• func LoadRunConfigOfType[T any](ctx context.Context, name string) (*T, error)
• func LoadRunConfigWithFunc(ctx context.Context, name string, readFunc RunConfigReadJSONFunc) (interface{}, error)
• func ReadJSON(r io.Reader, target interface{}) error
• func ReadRunConfigJSON[T any](r io.Reader) (*T, error)
• func SaveRunConfig[T RunConfigPersister](ctx context.Context, config T) error
• type KubernetesStore
  • func (*KubernetesStore) Delete(_ context.Context, _ string) error
  • func (*KubernetesStore) Exists(_ context.Context, _ string) (bool, error)
  • func (*KubernetesStore) GetReader(_ context.Context, _ string) (io.ReadCloser, error)
  • func (*KubernetesStore) GetWriter(_ context.Context, _ string) (io.WriteCloser, error)
  • func (*KubernetesStore) List(_ context.Context) ([]string, error)
• type LocalStore
  • func NewLocalStore(appName string, storeName string) (*LocalStore, error)
  • func (s *LocalStore) Delete(_ context.Context, name string) error
  • func (s *LocalStore) Exists(_ context.Context, name string) (bool, error)
  • func (s *LocalStore) GetReader(_ context.Context, name string) (io.ReadCloser, error)
  • func (s *LocalStore) GetWriter(_ context.Context, name string) (io.WriteCloser, error)
  • func (s *LocalStore) List(_ context.Context) ([]string, error)
• type ReadJSONFunc
• type RunConfigPersister
• type RunConfigReadJSONFunc
• type Store
  • func NewGroupConfigStore(appName string) (Store, error)
  • func NewGroupConfigStoreWithDetector(appName string) (Store, error)
  • func NewKubernetesStore() Store
  • func NewRunConfigStore(appName string) (Store, error)
  • func NewRunConfigStoreWithDetector(appName string) (Store, error)

Constants

const (
	// RunConfigsDir is the directory name for storing run configurations
	RunConfigsDir = "runconfigs"

	// GroupConfigsDir is the directory name for storing group configurations
	GroupConfigsDir = "groups"
)

const (
	// DefaultAppName is the default application name used for XDG paths
	DefaultAppName = "toolhive"

	// FileExtension is the file extension for stored configurations
	FileExtension = ".json"
)

Functions

func DeleteSavedRunConfig

func DeleteSavedRunConfig(ctx context.Context, name string) error

DeleteSavedRunConfig deletes a saved run configuration

func LoadRunConfig

func LoadRunConfig[T any](ctx context.Context, name string, readJSONFunc ReadJSONFunc[T]) (T, error)

LoadRunConfig loads a run configuration from the state store using the provided reader function

func LoadRunConfigJSON

func LoadRunConfigJSON(ctx context.Context, name string) (io.ReadCloser, error)

LoadRunConfigJSON loads a run configuration from the state store and returns the raw reader

func LoadRunConfigOfType

func LoadRunConfigOfType[T any](ctx context.Context, name string) (*T, error)

LoadRunConfigOfType loads a run configuration of a specific type T from the state store

func LoadRunConfigWithFunc

func LoadRunConfigWithFunc(ctx context.Context, name string, readFunc RunConfigReadJSONFunc) (interface{}, error)

LoadRunConfigWithFunc loads a run configuration using a provided read function

func ReadJSON

func ReadJSON(r io.Reader, target interface{}) error

ReadJSON deserializes JSON from the provided reader into a generic interface This function is moved from the runner package to avoid circular dependencies

func ReadRunConfigJSON

func ReadRunConfigJSON[T any](r io.Reader) (*T, error)

ReadRunConfigJSON deserializes a run configuration from JSON read from the provided reader This is a generic JSON deserializer for any type that can be unmarshalled from JSON

func SaveRunConfig

func SaveRunConfig[T RunConfigPersister](ctx context.Context, config T) error

SaveRunConfig saves a run configuration to the state store

Types

type KubernetesStore

type KubernetesStore struct{}

KubernetesStore is a no-op implementation of Store for Kubernetes environments. In Kubernetes, workload state is managed by the cluster, not by local files.

func (*KubernetesStore) Delete

func (*KubernetesStore) Delete(_ context.Context, _ string) error

Delete is a no-op for Kubernetes stores.

func (*KubernetesStore) Exists

func (*KubernetesStore) Exists(_ context.Context, _ string) (bool, error)

Exists always returns false for Kubernetes stores since state is not persisted locally.

func (*KubernetesStore) GetReader

func (*KubernetesStore) GetReader(_ context.Context, _ string) (io.ReadCloser, error)

GetReader returns a no-op reader for Kubernetes stores.

func (*KubernetesStore) GetWriter

func (*KubernetesStore) GetWriter(_ context.Context, _ string) (io.WriteCloser, error)

GetWriter returns a no-op writer for Kubernetes stores.

func (*KubernetesStore) List

func (*KubernetesStore) List(_ context.Context) ([]string, error)

List always returns an empty slice for Kubernetes stores.

type LocalStore

type LocalStore struct {
	// contains filtered or unexported fields
}

LocalStore implements the Store interface using the local filesystem following the XDG Base Directory Specification

func NewLocalStore

func NewLocalStore(appName string, storeName string) (*LocalStore, error)

NewLocalStore creates a new LocalStore with the given application name and store type If appName is empty, DefaultAppName will be used

func (*LocalStore) Delete

func (s *LocalStore) Delete(_ context.Context, name string) error

Delete removes the data for the given name

func (*LocalStore) Exists

func (s *LocalStore) Exists(_ context.Context, name string) (bool, error)

Exists checks if data exists for the given name

func (*LocalStore) GetReader

func (s *LocalStore) GetReader(_ context.Context, name string) (io.ReadCloser, error)

GetReader returns a reader for the state data

func (*LocalStore) GetWriter

func (s *LocalStore) GetWriter(_ context.Context, name string) (io.WriteCloser, error)

GetWriter returns a writer for the state data

func (*LocalStore) List

func (s *LocalStore) List(_ context.Context) ([]string, error)

List returns all available state names

type ReadJSONFunc

type ReadJSONFunc[T any] func(r io.Reader) (T, error)

ReadJSONFunc defines a function type for reading JSON into an object

type RunConfigPersister

type RunConfigPersister interface {
	// WriteJSON serializes the object to JSON and writes it to the provided writer
	WriteJSON(w io.Writer) error
	// GetBaseName returns the base name used for persistence
	GetBaseName() string
}

RunConfigPersister defines an interface for objects that can be persisted and loaded as JSON

type RunConfigReadJSONFunc

type RunConfigReadJSONFunc func(r io.Reader) (interface{}, error)

RunConfigReadJSONFunc defines the function signature for reading a RunConfig from JSON This allows us to accept the runner.ReadJSON function without creating a circular dependency

type Store

type Store interface {
	// GetReader returns a reader for the state data
	// This is useful for streaming large state data
	GetReader(ctx context.Context, name string) (io.ReadCloser, error)

	// GetWriter returns a writer for the state data
	// This is useful for streaming large state data
	GetWriter(ctx context.Context, name string) (io.WriteCloser, error)

	// Delete removes the data for the given name
	Delete(ctx context.Context, name string) error

	// List returns all available state names
	List(ctx context.Context) ([]string, error)

	// Exists checks if data exists for the given name
	Exists(ctx context.Context, name string) (bool, error)
}

Store defines the interface for runner state storage operations

func NewGroupConfigStore

func NewGroupConfigStore(appName string) (Store, error)

NewGroupConfigStore creates a store for group configurations

func NewGroupConfigStoreWithDetector

func NewGroupConfigStoreWithDetector(appName string) (Store, error)

NewGroupConfigStoreWithDetector creates a store

func NewKubernetesStore

func NewKubernetesStore() Store

NewKubernetesStore creates a new no-op store for Kubernetes environments.

func NewRunConfigStore

func NewRunConfigStore(appName string) (Store, error)

NewRunConfigStore creates a store for run configuration state

func NewRunConfigStoreWithDetector

func NewRunConfigStoreWithDetector(appName string) (Store, error)

NewRunConfigStoreWithDetector creates a store