storage

Documentation

Overview

Package storage provides dynamically configured file storage backends.

Index

• Constants
• Variables
• func Active(ctx context.Context) (Driver, Backend, error)
• func MockStorage(put func(context.Context, string, io.Reader, int64, string) error, ...) func()
• func PublishCacheInvalidation(ctx context.Context)
• func ResetCache()
• func SaveActiveConfig(ctx context.Context, cfg Config) error
• func ValidateConfig(cfg Config) error
• type Backend
  • func NewBackend(ctx context.Context, cfg Config, driver Driver) (Backend, error)
• type Config
  • func DefaultConfig() Config
  • func LoadConfig(ctx context.Context) (Config, error)
  • func MaskSecrets(cfg Config) Config
  • func MergeMaskedSecrets(next, current Config) Config
• type Driver
• type LocalConfig
• type Object
• type ObjectConfig
• type PutResult
• type WebDAVConfig

Constants

const ConfigInvalidationChannel = "storage:config_invalidation"

ConfigInvalidationChannel is the Redis pub/sub channel used to evict storage caches cluster-wide.

Variables

var (
	// IsEnabledFunc preserves the legacy S3 test hook while tests migrate to backend injection.
	IsEnabledFunc = func() bool { return false }
)

Functions

func Active

func Active(ctx context.Context) (Driver, Backend, error)

Active returns the configured active driver and backend, using an in-memory cache with 5s TTL.

func MockStorage

func MockStorage(
	put func(context.Context, string, io.Reader, int64, string) error,
	get func(context.Context, string) (*Object, error),
	deleteObject func(context.Context, string) error,
) func()

MockStorage replaces object operations for package tests and returns a restore function.

func PublishCacheInvalidation

func PublishCacheInvalidation(ctx context.Context)

PublishCacheInvalidation broadcasts cache eviction to all nodes in the cluster via Redis.

func ResetCache

func ResetCache()

ResetCache clears the local cache for storage configuration and client singletons.

func SaveActiveConfig

func SaveActiveConfig(ctx context.Context, cfg Config) error

SaveActiveConfig persists the active storage configuration.

func ValidateConfig

func ValidateConfig(cfg Config) error

ValidateConfig validates the selected backend configuration.

Types

type Backend

type Backend interface {
	Put(ctx context.Context, key string, body io.Reader, size int64, contentType string) (PutResult, error)
	Get(ctx context.Context, key string) (*Object, error)
	Delete(ctx context.Context, key string) error
	Test(ctx context.Context) error
}

Backend defines storage operations used by the upload domain.

func NewBackend

func NewBackend(ctx context.Context, cfg Config, driver Driver) (Backend, error)

NewBackend constructs a concrete backend from configuration.

type Config

type Config struct {
	Driver Driver       `json:"driver"`
	Local  LocalConfig  `json:"local"`
	S3     ObjectConfig `json:"s3"`
	R2     ObjectConfig `json:"r2"`
	MinIO  ObjectConfig `json:"minio"`
	OSS    ObjectConfig `json:"oss"`
	WebDAV WebDAVConfig `json:"webdav"`
}

Config contains all storage backends and the currently active driver.

func DefaultConfig

func DefaultConfig() Config

DefaultConfig returns the local-storage default configuration.

func LoadConfig

func LoadConfig(ctx context.Context) (Config, error)

LoadConfig loads the active storage configuration.

func MaskSecrets

func MaskSecrets(cfg Config) Config

MaskSecrets replaces stored credentials with placeholders for API responses.

func MergeMaskedSecrets

func MergeMaskedSecrets(next, current Config) Config

MergeMaskedSecrets restores unchanged secrets from the current configuration.

type Driver

type Driver string

Driver identifies a supported storage backend.

const (
	// DriverLocal stores files on the local filesystem.
	DriverLocal Driver = "local"
	// DriverS3 stores files in an S3-compatible object store.
	DriverS3 Driver = "s3"
	// DriverR2 stores files in Cloudflare R2.
	DriverR2 Driver = "r2"
	// DriverMinIO stores files in MinIO.
	DriverMinIO Driver = "minio"
	// DriverOSS stores files in Aliyun OSS.
	DriverOSS Driver = "oss"
	// DriverWebDAV stores files through WebDAV.
	DriverWebDAV Driver = "webdav"

	// ConfigMask replaces secrets returned to the frontend.
	ConfigMask = "******"
)

type LocalConfig

type LocalConfig struct {
	Root string `json:"root"`
}

LocalConfig configures local filesystem storage.

type Object

type Object struct {
	CachePath     string
	Body          io.ReadCloser
	ContentLength int64
	ContentType   string
}

Object describes a readable stored object.

type ObjectConfig

type ObjectConfig struct {
	Endpoint        string `json:"endpoint"`
	Region          string `json:"region"`
	Bucket          string `json:"bucket"`
	AccessKeyID     string `json:"access_key_id"`
	SecretAccessKey string `json:"secret_access_key"`
	AccountID       string `json:"account_id,omitempty"`
	PathStyle       bool   `json:"path_style"`
	KeyPrefix       string `json:"key_prefix"`
	CDNURL          string `json:"cdn_url"`
}

ObjectConfig configures S3-compatible or OSS object storage.

type PutResult

type PutResult struct {
	Key    string
	Bucket string
}

PutResult describes the result of a successful Put operation.

type WebDAVConfig

type WebDAVConfig struct {
	Endpoint string `json:"endpoint"`
	Username string `json:"username"`
	Password string `json:"password"`
	BasePath string `json:"base_path"`
}

WebDAVConfig configures WebDAV storage.