persistedoperations

Documentation

Index

• Variables
• type Config
  • func DefaultConfig() Config
• type ErrorMessage
• type ErrorPayload
• type GcpLoader
  • func NewGcpLoader(cfg LoaderConfig, log *slog.Logger) (*GcpLoader, error)
  • func (g *GcpLoader) Load(ctx context.Context) (map[string]PersistedOperation, error)
  • func (g *GcpLoader) Type() string
• type Handler
  • func NewPersistedOperations(log *slog.Logger, cfg Config, loader Loader) (*Handler, error)
  • func (p *Handler) Shutdown()
  • func (p *Handler) SwapHashForQuery(next http.Handler) http.Handler
  • func (p *Handler) Validate(validate func(operation string) gqlerror.List) []validation.Error
• type Loader
  • func NewLoaderFromConfig(cfg Config, log *slog.Logger) (Loader, error)
• type LoaderConfig
• type LocalLoader
  • func NewLocalDirLoader(cfg Config, log *slog.Logger) *LocalLoader
  • func (d *LocalLoader) Load(_ context.Context) (map[string]PersistedOperation, error)
  • func (d *LocalLoader) Type() string
• type MemoryLoader
  • func (d *MemoryLoader) Load(_ context.Context) (map[string]PersistedOperation, error)
  • func (d *MemoryLoader) Type() string
• type NoOpLoader
  • func NewNoOpLoader() (*NoOpLoader, error)
  • func (n *NoOpLoader) Load(_ context.Context) (map[string]PersistedOperation, error)
  • func (n *NoOpLoader) Type() string
• type PersistedOperation

Variables

var ErrNoHashFound = errors.New("no hash found")

var ErrNoLoaderSupplied = errors.New("no remoteLoader supplied")

var ErrPersistedOperationNotFound = errors.New("PersistedOperationNotFound")

var ErrPersistedQueryNotFound = errors.New("PersistedQueryNotFound")

var ErrReloadIntervalTooShort = errors.New("load interval cannot be less than 10 seconds")

Types

type Config

type Config struct {
	Enabled         bool         `yaml:"enabled"`
	RejectOnFailure bool         `yaml:"reject_on_failure"`
	Loader          LoaderConfig `yaml:"loader"`
}

func DefaultConfig

func DefaultConfig() Config

type ErrorMessage

type ErrorMessage struct {
	Message string `json:"message"`
}

type ErrorPayload

type ErrorPayload struct {
	Errors gqlerror.List `json:"errors"`
}

type GcpLoader

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

GcpStorageLoader loads persisted operations from a GCP Storage bucket. It matches files based on a `*.json` glob pattern and attempts to unmarshall them into a persisted operations map structure

func NewGcpLoader

func NewGcpLoader(cfg LoaderConfig, log *slog.Logger) (*GcpLoader, error)

func (*GcpLoader) Load

func (g *GcpLoader) Load(ctx context.Context) (map[string]PersistedOperation, error)

func (*GcpLoader) Type

func (g *GcpLoader) Type() string

type Handler

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

func NewPersistedOperations

func NewPersistedOperations(log *slog.Logger, cfg Config, loader Loader) (*Handler, error)

func (*Handler) Shutdown

func (p *Handler) Shutdown()

func (*Handler) SwapHashForQuery

func (p *Handler) SwapHashForQuery(next http.Handler) http.Handler

SwapHashForQuery runs of the persisted operations handler it uses the configuration supplied to decide its behavior

func (*Handler) Validate

func (p *Handler) Validate(validate func(operation string) gqlerror.List) []validation.Error

type Loader

type Loader interface {
	Load(ctx context.Context) (map[string]PersistedOperation, error)
	Type() string
}

func NewLoaderFromConfig

func NewLoaderFromConfig(cfg Config, log *slog.Logger) (Loader, error)

type LoaderConfig

type LoaderConfig struct {
	Type     string `yaml:"type"`
	Location string `yaml:"location"`
	// Configuration for auto-reloading persisted operations
	Reload struct {
		Enabled  bool          `yaml:"enabled"`
		Interval time.Duration `yaml:"interval"`
		Timeout  time.Duration `yaml:"timeout"`
	}
}

type LocalLoader

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

LocalLoader loads persisted operations from a filesystem directory It looks at all files in the directory, but doesn't traverse subdirectories If it finds a file with a `.json` extension it attempts to unmarshall it and use it as a source for persisted operations/ If it fails to load a file it moves on to the next file in the directory

func NewLocalDirLoader

func NewLocalDirLoader(cfg Config, log *slog.Logger) *LocalLoader

func (*LocalLoader) Load

func (d *LocalLoader) Load(_ context.Context) (map[string]PersistedOperation, error)

func (*LocalLoader) Type

func (d *LocalLoader) Type() string

type MemoryLoader

type MemoryLoader struct {
	Store map[string]PersistedOperation
}

MemoryLoader is a loader for testing purposes It allows the user to specify operations in memory

func (*MemoryLoader) Load

func (d *MemoryLoader) Load(_ context.Context) (map[string]PersistedOperation, error)

func (*MemoryLoader) Type

func (d *MemoryLoader) Type() string

type NoOpLoader

type NoOpLoader struct {
}

func NewNoOpLoader

func NewNoOpLoader() (*NoOpLoader, error)

func (*NoOpLoader) Load

func (n *NoOpLoader) Load(_ context.Context) (map[string]PersistedOperation, error)

func (*NoOpLoader) Type

func (n *NoOpLoader) Type() string

type PersistedOperation

type PersistedOperation struct {
	Operation string
	Name      string `json:"name,omitempty"`
}